blob: f3365eba1fb3a76a137dbb86ec1da3cdcaefd94b [file] [log] [blame]
Phil Burk5ed503c2017-02-01 09:38:15 -08001/*
2 * Copyright 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef UTILITY_AAUDIO_UTILITIES_H
18#define UTILITY_AAUDIO_UTILITIES_H
19
Andy Hung47c5e532017-06-26 18:28:00 -070020#include <algorithm>
21#include <functional>
Phil Burk5ed503c2017-02-01 09:38:15 -080022#include <stdint.h>
23#include <sys/types.h>
Tom Cherry7ae78252020-04-13 15:20:50 -070024#include <unistd.h>
Phil Burk5ed503c2017-02-01 09:38:15 -080025
26#include <utils/Errors.h>
Kevin Rocard6d7582e2018-01-11 19:28:14 -080027#include <system/audio.h>
Phil Burk5ed503c2017-02-01 09:38:15 -080028
Phil Burka4eb0d82017-04-12 15:44:06 -070029#include "aaudio/AAudio.h"
Phil Burk5ed503c2017-02-01 09:38:15 -080030
31/**
32 * Convert an AAudio result into the closest matching Android status.
33 */
34android::status_t AAudioConvert_aaudioToAndroidStatus(aaudio_result_t result);
35
36/**
37 * Convert an Android status into the closest matching AAudio result.
38 */
39aaudio_result_t AAudioConvert_androidToAAudioResult(android::status_t status);
40
Phil Burke572f462017-04-20 13:03:19 -070041/**
Phil Burk4e1af9f2018-01-03 15:54:35 -080042 * Convert an aaudio_session_id_t to a value that is safe to pass to AudioFlinger.
43 * @param sessionId
44 * @return safe value
45 */
46audio_session_t AAudioConvert_aaudioToAndroidSessionId(aaudio_session_id_t sessionId);
47
48/**
Phil Burk5ed503c2017-02-01 09:38:15 -080049 * Calculate the number of bytes and prevent numeric overflow.
Phil Burk7f680132018-03-12 14:48:06 -070050 * The *sizeInBytes will be set to zero if there is an error.
51 *
Phil Burk5ed503c2017-02-01 09:38:15 -080052 * @param numFrames frame count
53 * @param bytesPerFrame size of a frame in bytes
Phil Burk7f680132018-03-12 14:48:06 -070054 * @param sizeInBytes pointer to a variable to receive total size in bytes
Phil Burk5ed503c2017-02-01 09:38:15 -080055 * @return AAUDIO_OK or negative error, eg. AAUDIO_ERROR_OUT_OF_RANGE
56 */
Phil Burk3316d5e2017-02-15 11:23:01 -080057int32_t AAudioConvert_framesToBytes(int32_t numFrames,
Phil Burk7f680132018-03-12 14:48:06 -070058 int32_t bytesPerFrame,
59 int32_t *sizeInBytes);
Phil Burk5ed503c2017-02-01 09:38:15 -080060
Phil Burk9dca9822017-05-26 14:27:43 -070061audio_format_t AAudioConvert_aaudioToAndroidDataFormat(aaudio_format_t aaudio_format);
Phil Burk5ed503c2017-02-01 09:38:15 -080062
Phil Burk9dca9822017-05-26 14:27:43 -070063aaudio_format_t AAudioConvert_androidToAAudioDataFormat(audio_format_t format);
Phil Burk5ed503c2017-02-01 09:38:15 -080064
Robert Wu310037a2022-09-06 21:48:18 +000065aaudio_format_t AAudioConvert_androidToNearestAAudioDataFormat(audio_format_t format);
Phil Burkd4ccc622017-12-20 15:32:44 -080066
67/**
68 * Note that this function does not validate the passed in value.
69 * That is done somewhere else.
70 * @return internal value
71 */
72
73audio_usage_t AAudioConvert_usageToInternal(aaudio_usage_t usage);
74
75/**
76 * Note that this function does not validate the passed in value.
77 * That is done somewhere else.
78 * @return internal value
79 */
80audio_content_type_t AAudioConvert_contentTypeToInternal(aaudio_content_type_t contentType);
81
82/**
83 * Note that this function does not validate the passed in value.
84 * That is done somewhere else.
85 * @return internal audio source
86 */
87audio_source_t AAudioConvert_inputPresetToAudioSource(aaudio_input_preset_t preset);
88
Kevin Rocard68646ba2019-03-20 13:26:49 -070089/**
90 * Note that this function does not validate the passed in value.
91 * That is done somewhere else.
92 * @return internal audio flags mask
93 */
94audio_flags_mask_t AAudioConvert_allowCapturePolicyToAudioFlagsMask(
Jean-Michel Trivi656bfdc2021-09-20 18:42:37 -070095 aaudio_allowed_capture_policy_t policy,
96 aaudio_spatialization_behavior_t spatializationBehavior,
97 bool isContentSpatialized);
Kevin Rocard68646ba2019-03-20 13:26:49 -070098
Eric Laurentd17c8502019-10-24 15:58:35 -070099audio_flags_mask_t AAudioConvert_privacySensitiveToAudioFlagsMask(
100 bool privacySensitive);
101
jiabina9094092021-06-28 20:36:45 +0000102audio_channel_mask_t AAudioConvert_aaudioToAndroidChannelLayoutMask(
103 aaudio_channel_mask_t channelMask, bool isInput);
104
105aaudio_channel_mask_t AAudioConvert_androidToAAudioChannelLayoutMask(
106 audio_channel_mask_t channelMask, bool isInput);
107
108aaudio_channel_mask_t AAudioConvert_androidToAAudioChannelIndexMask(
109 audio_channel_mask_t channelMask);
110
111audio_channel_mask_t AAudioConvert_aaudioToAndroidChannelIndexMask(
112 aaudio_channel_mask_t channelMask);
113
114aaudio_channel_mask_t AAudioConvert_androidToAAudioChannelMask(
115 audio_channel_mask_t channelMask, bool isInput, bool indexMaskRequired);
116
117audio_channel_mask_t AAudioConvert_aaudioToAndroidChannelMask(
118 aaudio_channel_mask_t channelMask, bool isInput);
119
120bool AAudio_isChannelIndexMask(aaudio_channel_mask_t channelMask);
121
122int32_t AAudioConvert_channelMaskToCount(aaudio_channel_mask_t channelMask);
123
124aaudio_channel_mask_t AAudioConvert_channelCountToMask(int32_t channelCount);
125
126audio_channel_mask_t AAudio_getChannelMaskForOpen(
127 aaudio_channel_mask_t channelMask, int32_t samplesPerFrame, bool isInput);
128
Phil Burkc8f69a02017-05-11 15:53:06 -0700129// Note that this code may be replaced by Settings or by some other system configuration tool.
130
Phil Burkb31b66f2019-09-30 09:33:41 -0700131/**
Phil Burkfd34a932017-07-19 07:03:52 -0700132 * Read a system property that specifies the number of extra microseconds that a thread
133 * should sleep when waiting for another thread to service a FIFO. This is used
134 * to avoid the waking thread from being overly optimistic about the other threads
135 * wakeup timing. This value should be set high enough to cover typical scheduling jitter
136 * for a real-time thread.
137 *
138 * @return number of microseconds to delay the wakeup.
139 */
140int32_t AAudioProperty_getWakeupDelayMicros();
Phil Burkfd34a932017-07-19 07:03:52 -0700141#define AAUDIO_PROP_WAKEUP_DELAY_USEC "aaudio.wakeup_delay_usec"
142
143/**
144 * Read a system property that specifies the minimum sleep time when polling the FIFO.
145 *
146 * @return minimum number of microseconds to sleep.
147 */
148int32_t AAudioProperty_getMinimumSleepMicros();
Phil Burkfd34a932017-07-19 07:03:52 -0700149#define AAUDIO_PROP_MINIMUM_SLEEP_USEC "aaudio.minimum_sleep_usec"
150
151/**
Phil Burkb31b66f2019-09-30 09:33:41 -0700152 * Read a system property that specifies an offset that will be added to MMAP timestamps.
153 * This can be used to correct bias in the timestamp.
154 * It can also be used to analyze the time distribution of the timestamp
155 * by progressively modifying the offset and listening for glitches.
156 *
157 * @return number of microseconds to offset the time part of an MMAP timestamp
158 */
159int32_t AAudioProperty_getInputMMapOffsetMicros();
160#define AAUDIO_PROP_INPUT_MMAP_OFFSET_USEC "aaudio.in_mmap_offset_usec"
161
162int32_t AAudioProperty_getOutputMMapOffsetMicros();
163#define AAUDIO_PROP_OUTPUT_MMAP_OFFSET_USEC "aaudio.out_mmap_offset_usec"
Phil Burk5cc83c32017-11-28 15:43:18 -0800164
Phil Burkef34be52019-09-26 13:45:25 -0700165// These are powers of two that can be combined as a bit mask.
166// AAUDIO_LOG_CLOCK_MODEL_HISTOGRAM must be enabled before the stream is opened.
167#define AAUDIO_LOG_CLOCK_MODEL_HISTOGRAM 1
168#define AAUDIO_LOG_RESERVED_2 2
169#define AAUDIO_LOG_RESERVED_4 4
170#define AAUDIO_LOG_RESERVED_8 8
171
172/**
173 * Use a mask to enable various logs in AAudio.
174 * @return mask that enables various AAudio logs, such as AAUDIO_LOG_CLOCK_MODEL_HISTOGRAM
175 */
176int32_t AAudioProperty_getLogMask();
177#define AAUDIO_PROP_LOG_MASK "aaudio.log_mask"
178
Phil Burk5cc83c32017-11-28 15:43:18 -0800179/**
180 * Is flush allowed for the given state?
181 * @param state
182 * @return AAUDIO_OK if allowed or an error
183 */
184aaudio_result_t AAudio_isFlushAllowed(aaudio_stream_state_t state);
185
Andy Hung47c5e532017-06-26 18:28:00 -0700186/**
187 * Try a function f until it returns true.
188 *
189 * The function is always called at least once.
190 *
191 * @param f the function to evaluate, which returns a bool.
192 * @param times the number of times to evaluate f.
193 * @param sleepMs the sleep time per check of f, if greater than 0.
194 * @return true if f() eventually returns true.
195 */
196static inline bool AAudio_tryUntilTrue(
jiabind5bd06a2021-04-27 22:04:08 +0000197 const std::function<bool()>& f, int times, int sleepMs) {
Andy Hung47c5e532017-06-26 18:28:00 -0700198 static const useconds_t US_PER_MS = 1000;
199
200 sleepMs = std::max(sleepMs, 0);
201 for (;;) {
202 if (f()) return true;
203 if (times <= 1) return false;
204 --times;
205 usleep(sleepMs * US_PER_MS);
206 }
207}
208
Phil Burk97350f92017-07-21 15:59:44 -0700209
210/**
211 * Simple double buffer for a structure that can be written occasionally and read occasionally.
212 * This allows a SINGLE writer with multiple readers.
213 *
214 * It is OK if the FIFO overflows and we lose old values.
215 * It is also OK if we read an old value.
216 * Thread may return a non-atomic result if the other thread is rapidly writing
217 * new values on another core.
218 */
219template <class T>
220class SimpleDoubleBuffer {
221public:
222 SimpleDoubleBuffer()
Phil Burkbcc36742017-08-31 17:24:51 -0700223 : mValues() {}
Phil Burk97350f92017-07-21 15:59:44 -0700224
225 __attribute__((no_sanitize("integer")))
226 void write(T value) {
227 int index = mCounter.load() & 1;
228 mValues[index] = value;
229 mCounter++; // Increment AFTER updating storage, OK if it wraps.
230 }
231
Phil Burkbcc36742017-08-31 17:24:51 -0700232 /**
233 * This should only be called by the same thread that calls write() or when
234 * no other thread is calling write.
235 */
236 void clear() {
237 mCounter.store(0);
238 }
239
Phil Burk97350f92017-07-21 15:59:44 -0700240 T read() const {
241 T result;
242 int before;
243 int after;
244 int timeout = 3;
245 do {
246 // Check to see if a write occurred while were reading.
247 before = mCounter.load();
248 int index = (before & 1) ^ 1;
249 result = mValues[index];
250 after = mCounter.load();
Phil Burkbcc36742017-08-31 17:24:51 -0700251 } while ((after != before) && (after > 0) && (--timeout > 0));
Phil Burk97350f92017-07-21 15:59:44 -0700252 return result;
253 }
254
255 /**
256 * @return true if at least one value has been written
257 */
258 bool isValid() const {
259 return mCounter.load() > 0;
260 }
261
262private:
263 T mValues[2];
Phil Burkbcc36742017-08-31 17:24:51 -0700264 std::atomic<int> mCounter{0};
Phil Burk97350f92017-07-21 15:59:44 -0700265};
266
267class Timestamp {
268public:
jiabind5bd06a2021-04-27 22:04:08 +0000269 Timestamp() = default;
Phil Burk97350f92017-07-21 15:59:44 -0700270 Timestamp(int64_t position, int64_t nanoseconds)
271 : mPosition(position)
272 , mNanoseconds(nanoseconds) {}
273
274 int64_t getPosition() const { return mPosition; }
275
276 int64_t getNanoseconds() const { return mNanoseconds; }
277
278private:
279 // These cannot be const because we need to implement the copy assignment operator.
jiabind5bd06a2021-04-27 22:04:08 +0000280 int64_t mPosition{0};
281 int64_t mNanoseconds{0};
Phil Burk97350f92017-07-21 15:59:44 -0700282};
283
Phil Burkbcc36742017-08-31 17:24:51 -0700284
285/**
286 * Pass a request to another thread.
287 * This is used when one thread, A, wants another thread, B, to do something.
288 * A naive approach would be for A to set a flag and for B to clear it when done.
289 * But that creates a race condition. This technique avoids the race condition.
290 *
291 * Assumes only one requester and one acknowledger.
292 */
293class AtomicRequestor {
294public:
Phil Burk2d5ba532017-09-06 14:36:11 -0700295
296 __attribute__((no_sanitize("integer")))
Phil Burkbcc36742017-08-31 17:24:51 -0700297 void request() {
Phil Burkbcc36742017-08-31 17:24:51 -0700298 mRequested++;
299 }
300
Phil Burk2d5ba532017-09-06 14:36:11 -0700301 __attribute__((no_sanitize("integer")))
Phil Burkbcc36742017-08-31 17:24:51 -0700302 bool isRequested() {
Phil Burk2d5ba532017-09-06 14:36:11 -0700303 return (mRequested.load() - mAcknowledged.load()) > 0;
Phil Burkbcc36742017-08-31 17:24:51 -0700304 }
305
Phil Burk2d5ba532017-09-06 14:36:11 -0700306 __attribute__((no_sanitize("integer")))
Phil Burkbcc36742017-08-31 17:24:51 -0700307 void acknowledge() {
308 mAcknowledged++;
309 }
310
311private:
312 std::atomic<int> mRequested{0};
313 std::atomic<int> mAcknowledged{0};
314};
jiabina9094092021-06-28 20:36:45 +0000315
316enum {
317 /**
318 * Audio channel index mask, only used internally.
319 */
320 AAUDIO_CHANNEL_BIT_INDEX = 0x80000000,
321 AAUDIO_CHANNEL_INDEX_MASK_1 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 1) - 1,
322 AAUDIO_CHANNEL_INDEX_MASK_2 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 2) - 1,
323 AAUDIO_CHANNEL_INDEX_MASK_3 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 3) - 1,
324 AAUDIO_CHANNEL_INDEX_MASK_4 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 4) - 1,
325 AAUDIO_CHANNEL_INDEX_MASK_5 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 5) - 1,
326 AAUDIO_CHANNEL_INDEX_MASK_6 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 6) - 1,
327 AAUDIO_CHANNEL_INDEX_MASK_7 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 7) - 1,
328 AAUDIO_CHANNEL_INDEX_MASK_8 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 8) - 1,
329 AAUDIO_CHANNEL_INDEX_MASK_9 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 9) - 1,
330 AAUDIO_CHANNEL_INDEX_MASK_10 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 10) - 1,
331 AAUDIO_CHANNEL_INDEX_MASK_11 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 11) - 1,
332 AAUDIO_CHANNEL_INDEX_MASK_12 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 12) - 1,
333 AAUDIO_CHANNEL_INDEX_MASK_13 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 13) - 1,
334 AAUDIO_CHANNEL_INDEX_MASK_14 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 14) - 1,
335 AAUDIO_CHANNEL_INDEX_MASK_15 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 15) - 1,
336 AAUDIO_CHANNEL_INDEX_MASK_16 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 16) - 1,
337 AAUDIO_CHANNEL_INDEX_MASK_17 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 17) - 1,
338 AAUDIO_CHANNEL_INDEX_MASK_18 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 18) - 1,
339 AAUDIO_CHANNEL_INDEX_MASK_19 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 19) - 1,
340 AAUDIO_CHANNEL_INDEX_MASK_20 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 20) - 1,
341 AAUDIO_CHANNEL_INDEX_MASK_21 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 21) - 1,
342 AAUDIO_CHANNEL_INDEX_MASK_22 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 22) - 1,
343 AAUDIO_CHANNEL_INDEX_MASK_23 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 23) - 1,
344 AAUDIO_CHANNEL_INDEX_MASK_24 = AAUDIO_CHANNEL_BIT_INDEX | (1 << 24) - 1,
345};
346
Phil Burk5ed503c2017-02-01 09:38:15 -0800347#endif //UTILITY_AAUDIO_UTILITIES_H