1 /*
2 * Copyright (C) 2018 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 ANDROID_AUDIO_BASE_UTILS_H
18 #define ANDROID_AUDIO_BASE_UTILS_H
19
20 #include "audio-base.h"
21 #include "audio-hal-enums.h"
22 #include "audio_common-base.h"
23
24 //TODO: b/193496180 use spatializer flag at audio HAL when available
25 #define AUDIO_OUTPUT_FLAG_SPATIALIZER ((audio_output_flags_t)0x40000)
26
27 /** Define helper values to iterate over enum, extend them or checking value validity.
28 * Those values are compatible with the corresponding enum values.
29 * They are not macro like similar values in audio.h to avoid conflicting
30 * with the libhardware_legacy audio.h.
31 */
32 enum {
33 AUDIO_STREAM_MIN = AUDIO_STREAM_VOICE_CALL,
34 /** Number of audio streams available to vendors. */
35 AUDIO_STREAM_PUBLIC_CNT = AUDIO_STREAM_ASSISTANT + 1,
36
37 #ifndef AUDIO_NO_SYSTEM_DECLARATIONS
38 /** Total number of streams handled by the policy. */
39 AUDIO_STREAM_FOR_POLICY_CNT= AUDIO_STREAM_REROUTING + 1,
40 #endif
41
42 /** Total number of streams. */
43 AUDIO_STREAM_CNT = AUDIO_STREAM_CALL_ASSISTANT + 1,
44
45 AUDIO_SOURCE_MAX = AUDIO_SOURCE_VOICE_PERFORMANCE,
46 AUDIO_SOURCE_CNT = AUDIO_SOURCE_MAX + 1,
47
48 AUDIO_MICROPHONE_CHANNEL_MAPPING_CNT = AUDIO_MICROPHONE_CHANNEL_MAPPING_PROCESSED + 1,
49 AUDIO_MICROPHONE_LOCATION_CNT = AUDIO_MICROPHONE_LOCATION_PERIPHERAL + 1,
50 AUDIO_MICROPHONE_DIRECTIONALITY_CNT = AUDIO_MICROPHONE_DIRECTIONALITY_SUPER_CARDIOID + 1,
51
52 /** For retrocompatibility AUDIO_MODE_* and AUDIO_STREAM_* must be signed. */
53 AUDIO_DETAIL_NEGATIVE_VALUE = -1,
54 };
55
56 // TODO: remove audio device combination as it is not allowed to use as bit mask since R.
57 enum {
58 AUDIO_DEVICE_OUT_ALL = AUDIO_DEVICE_OUT_EARPIECE |
59 AUDIO_DEVICE_OUT_SPEAKER |
60 AUDIO_DEVICE_OUT_WIRED_HEADSET |
61 AUDIO_DEVICE_OUT_WIRED_HEADPHONE |
62 AUDIO_DEVICE_OUT_BLUETOOTH_SCO |
63 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
64 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT |
65 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP |
66 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
67 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER |
68 AUDIO_DEVICE_OUT_HDMI |
69 AUDIO_DEVICE_OUT_ANLG_DOCK_HEADSET |
70 AUDIO_DEVICE_OUT_DGTL_DOCK_HEADSET |
71 AUDIO_DEVICE_OUT_USB_ACCESSORY |
72 AUDIO_DEVICE_OUT_USB_DEVICE |
73 AUDIO_DEVICE_OUT_REMOTE_SUBMIX |
74 AUDIO_DEVICE_OUT_TELEPHONY_TX |
75 AUDIO_DEVICE_OUT_LINE |
76 AUDIO_DEVICE_OUT_HDMI_ARC |
77 // AUDIO_DEVICE_OUT_HDMI_EARC | not a bitfield
78 AUDIO_DEVICE_OUT_SPDIF |
79 AUDIO_DEVICE_OUT_FM |
80 AUDIO_DEVICE_OUT_AUX_LINE |
81 AUDIO_DEVICE_OUT_SPEAKER_SAFE |
82 AUDIO_DEVICE_OUT_IP |
83 AUDIO_DEVICE_OUT_BUS |
84 AUDIO_DEVICE_OUT_PROXY |
85 AUDIO_DEVICE_OUT_USB_HEADSET |
86 AUDIO_DEVICE_OUT_HEARING_AID |
87 AUDIO_DEVICE_OUT_ECHO_CANCELLER |
88 AUDIO_DEVICE_OUT_DEFAULT,
89
90 AUDIO_DEVICE_OUT_ALL_A2DP = AUDIO_DEVICE_OUT_BLUETOOTH_A2DP |
91 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
92 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER,
93
94 AUDIO_DEVICE_OUT_ALL_SCO = AUDIO_DEVICE_OUT_BLUETOOTH_SCO |
95 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
96 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT,
97
98 AUDIO_DEVICE_OUT_ALL_USB = AUDIO_DEVICE_OUT_USB_ACCESSORY |
99 AUDIO_DEVICE_OUT_USB_DEVICE |
100 AUDIO_DEVICE_OUT_USB_HEADSET,
101
102 AUDIO_DEVICE_IN_ALL = AUDIO_DEVICE_IN_COMMUNICATION |
103 AUDIO_DEVICE_IN_AMBIENT |
104 AUDIO_DEVICE_IN_BUILTIN_MIC |
105 AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET |
106 AUDIO_DEVICE_IN_WIRED_HEADSET |
107 AUDIO_DEVICE_IN_HDMI |
108 AUDIO_DEVICE_IN_TELEPHONY_RX |
109 AUDIO_DEVICE_IN_BACK_MIC |
110 AUDIO_DEVICE_IN_REMOTE_SUBMIX |
111 AUDIO_DEVICE_IN_ANLG_DOCK_HEADSET |
112 AUDIO_DEVICE_IN_DGTL_DOCK_HEADSET |
113 AUDIO_DEVICE_IN_USB_ACCESSORY |
114 AUDIO_DEVICE_IN_USB_DEVICE |
115 AUDIO_DEVICE_IN_FM_TUNER |
116 AUDIO_DEVICE_IN_TV_TUNER |
117 AUDIO_DEVICE_IN_LINE |
118 AUDIO_DEVICE_IN_SPDIF |
119 AUDIO_DEVICE_IN_BLUETOOTH_A2DP |
120 AUDIO_DEVICE_IN_LOOPBACK |
121 AUDIO_DEVICE_IN_IP |
122 AUDIO_DEVICE_IN_BUS |
123 AUDIO_DEVICE_IN_PROXY |
124 AUDIO_DEVICE_IN_USB_HEADSET |
125 AUDIO_DEVICE_IN_BLUETOOTH_BLE |
126 AUDIO_DEVICE_IN_HDMI_ARC |
127 // AUDIO_DEVICE_IN_HDMI_EARC | // not a bitfield
128 AUDIO_DEVICE_IN_ECHO_REFERENCE |
129 AUDIO_DEVICE_IN_DEFAULT,
130
131 AUDIO_DEVICE_IN_ALL_SCO = AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET,
132
133 AUDIO_DEVICE_IN_ALL_USB = AUDIO_DEVICE_IN_USB_ACCESSORY |
134 AUDIO_DEVICE_IN_USB_DEVICE |
135 AUDIO_DEVICE_IN_USB_HEADSET,
136
137 AUDIO_USAGE_MAX = AUDIO_USAGE_CALL_ASSISTANT,
138 AUDIO_USAGE_CNT = AUDIO_USAGE_CALL_ASSISTANT + 1,
139 }; // enum
140
141 // Microphone Field Dimension Constants
142 #define MIC_FIELD_DIMENSION_WIDE (-1.0f)
143 #define MIC_FIELD_DIMENSION_NORMAL (0.0f)
144 #define MIC_FIELD_DIMENSION_NARROW (1.0f)
145 #define MIC_FIELD_DIMENSION_DEFAULT MIC_FIELD_DIMENSION_NORMAL
146
147 #ifdef __cplusplus
148 #define CONST_ARRAY inline constexpr
149 #else
150 #define CONST_ARRAY const
151 #endif
152
153 // Keep the device arrays in order from low to high as they may be needed to do binary search.
154 // inline constexpr
155 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_OUT_ALL_ARRAY[] = {
156 AUDIO_DEVICE_OUT_EARPIECE, // 0x00000001u
157 AUDIO_DEVICE_OUT_SPEAKER, // 0x00000002u
158 AUDIO_DEVICE_OUT_WIRED_HEADSET, // 0x00000004u
159 AUDIO_DEVICE_OUT_WIRED_HEADPHONE, // 0x00000008u
160 AUDIO_DEVICE_OUT_BLUETOOTH_SCO, // 0x00000010u
161 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET, // 0x00000020u
162 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT, // 0x00000040u
163 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP, // 0x00000080u
164 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES, // 0x00000100u
165 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER, // 0x00000200u
166 AUDIO_DEVICE_OUT_HDMI, // 0x00000400u, OUT_AUX_DIGITAL
167 AUDIO_DEVICE_OUT_ANLG_DOCK_HEADSET, // 0x00000800u
168 AUDIO_DEVICE_OUT_DGTL_DOCK_HEADSET, // 0x00001000u
169 AUDIO_DEVICE_OUT_USB_ACCESSORY, // 0x00002000u
170 AUDIO_DEVICE_OUT_USB_DEVICE, // 0x00004000u
171 AUDIO_DEVICE_OUT_REMOTE_SUBMIX, // 0x00008000u
172 AUDIO_DEVICE_OUT_TELEPHONY_TX, // 0x00010000u
173 AUDIO_DEVICE_OUT_LINE, // 0x00020000u
174 AUDIO_DEVICE_OUT_HDMI_ARC, // 0x00040000u
175 AUDIO_DEVICE_OUT_HDMI_EARC, // 0x00040001u,
176 AUDIO_DEVICE_OUT_SPDIF, // 0x00080000u
177 AUDIO_DEVICE_OUT_FM, // 0x00100000u
178 AUDIO_DEVICE_OUT_AUX_LINE, // 0x00200000u
179 AUDIO_DEVICE_OUT_SPEAKER_SAFE, // 0x00400000u
180 AUDIO_DEVICE_OUT_IP, // 0x00800000u
181 AUDIO_DEVICE_OUT_BUS, // 0x01000000u
182 AUDIO_DEVICE_OUT_PROXY, // 0x02000000u
183 AUDIO_DEVICE_OUT_USB_HEADSET, // 0x04000000u
184 AUDIO_DEVICE_OUT_HEARING_AID, // 0x08000000u
185 AUDIO_DEVICE_OUT_ECHO_CANCELLER, // 0x10000000u
186 AUDIO_DEVICE_OUT_BLE_HEADSET, // 0x20000000u
187 AUDIO_DEVICE_OUT_BLE_SPEAKER, // 0x20000001u
188 AUDIO_DEVICE_OUT_DEFAULT, // 0x40000000u, BIT_DEFAULT
189 };
190
191 // inline constexpr
192 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_OUT_ALL_A2DP_ARRAY[] = {
193 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP, // 0x00000080u,
194 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES, // 0x00000100u,
195 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER, // 0x00000200u,
196 };
197
198 // inline constexpr
199 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_OUT_ALL_SCO_ARRAY[] = {
200 AUDIO_DEVICE_OUT_BLUETOOTH_SCO, // 0x00000010u,
201 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET, // 0x00000020u,
202 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT, // 0x00000040u,
203 };
204
205 // inline constexpr
206 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_OUT_ALL_USB_ARRAY[] = {
207 AUDIO_DEVICE_OUT_USB_ACCESSORY, // 0x00002000u
208 AUDIO_DEVICE_OUT_USB_DEVICE, // 0x00004000u
209 AUDIO_DEVICE_OUT_USB_HEADSET, // 0x04000000u
210 };
211
212 // Digital out device array should contain all usb out devices
213 // inline constexpr
214 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_OUT_ALL_DIGITAL_ARRAY[] = {
215 AUDIO_DEVICE_OUT_HDMI, // 0x00000400u, OUT_AUX_DIGITAL
216 AUDIO_DEVICE_OUT_USB_ACCESSORY, // 0x00002000u
217 AUDIO_DEVICE_OUT_USB_DEVICE, // 0x00004000u
218 AUDIO_DEVICE_OUT_HDMI_ARC, // 0x00040000u
219 AUDIO_DEVICE_OUT_HDMI_EARC, // 0x00040001u
220 AUDIO_DEVICE_OUT_SPDIF, // 0x00080000u
221 AUDIO_DEVICE_OUT_IP, // 0x00800000u
222 AUDIO_DEVICE_OUT_BUS, // 0x01000000u
223 AUDIO_DEVICE_OUT_USB_HEADSET, // 0x04000000u
224 };
225
226 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_OUT_ALL_BLE_ARRAY[] = {
227 AUDIO_DEVICE_OUT_BLE_HEADSET, // 0x20000000u
228 AUDIO_DEVICE_OUT_BLE_SPEAKER, // 0x20000001u
229 };
230
231 // inline constexpr
232 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_IN_ALL_ARRAY[] = {
233 AUDIO_DEVICE_IN_COMMUNICATION, // 0x80000001u
234 AUDIO_DEVICE_IN_AMBIENT, // 0x80000002u
235 AUDIO_DEVICE_IN_BUILTIN_MIC, // 0x80000004u
236 AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET, // 0x80000008u
237 AUDIO_DEVICE_IN_WIRED_HEADSET, // 0x80000010u
238 AUDIO_DEVICE_IN_HDMI, // 0x80000020u, IN_AUX_DIGITAL
239 AUDIO_DEVICE_IN_TELEPHONY_RX, // 0x80000040u, IN_VOICE_CALL
240 AUDIO_DEVICE_IN_BACK_MIC, // 0x80000080u
241 AUDIO_DEVICE_IN_REMOTE_SUBMIX, // 0x80000100u
242 AUDIO_DEVICE_IN_ANLG_DOCK_HEADSET, // 0x80000200u
243 AUDIO_DEVICE_IN_DGTL_DOCK_HEADSET, // 0x80000400u
244 AUDIO_DEVICE_IN_USB_ACCESSORY, // 0x80000800u
245 AUDIO_DEVICE_IN_USB_DEVICE, // 0x80001000u
246 AUDIO_DEVICE_IN_FM_TUNER, // 0x80002000u
247 AUDIO_DEVICE_IN_TV_TUNER, // 0x80004000u
248 AUDIO_DEVICE_IN_LINE, // 0x80008000u
249 AUDIO_DEVICE_IN_SPDIF, // 0x80010000u
250 AUDIO_DEVICE_IN_BLUETOOTH_A2DP, // 0x80020000u
251 AUDIO_DEVICE_IN_LOOPBACK, // 0x80040000u
252 AUDIO_DEVICE_IN_IP, // 0x80080000u
253 AUDIO_DEVICE_IN_BUS, // 0x80100000u
254 AUDIO_DEVICE_IN_PROXY, // 0x81000000u
255 AUDIO_DEVICE_IN_USB_HEADSET, // 0x82000000u
256 AUDIO_DEVICE_IN_BLUETOOTH_BLE, // 0x84000000u
257 AUDIO_DEVICE_IN_HDMI_ARC, // 0x88000000u
258 AUDIO_DEVICE_IN_HDMI_EARC, // 0x88000001u
259 AUDIO_DEVICE_IN_ECHO_REFERENCE, // 0x90000000u
260 AUDIO_DEVICE_IN_BLE_HEADSET, // 0xA0000000u
261 AUDIO_DEVICE_IN_DEFAULT, // 0xC0000000u
262 };
263
264 // inline constexpr
265 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_IN_ALL_SCO_ARRAY[] = {
266 AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET, // 0x80000008u
267 };
268
269 // inline constexpr
270 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_IN_ALL_USB_ARRAY[] = {
271 AUDIO_DEVICE_IN_USB_ACCESSORY, // 0x80000800u
272 AUDIO_DEVICE_IN_USB_DEVICE, // 0x80001000u
273 AUDIO_DEVICE_IN_USB_HEADSET, // 0x82000000u
274 };
275
276 // Digital in device array should contain all usb in devices
277 // inline constexpr
278 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_IN_ALL_DIGITAL_ARRAY[] = {
279 AUDIO_DEVICE_IN_HDMI, // 0x80000020u, IN_AUX_DIGITAL
280 AUDIO_DEVICE_IN_USB_ACCESSORY, // 0x80000800u
281 AUDIO_DEVICE_IN_USB_DEVICE, // 0x80001000u
282 AUDIO_DEVICE_IN_SPDIF, // 0x80010000u
283 AUDIO_DEVICE_IN_IP, // 0x80080000u
284 AUDIO_DEVICE_IN_BUS, // 0x80100000u
285 AUDIO_DEVICE_IN_USB_HEADSET, // 0x82000000u
286 AUDIO_DEVICE_IN_HDMI_ARC, // 0x88000000u
287 AUDIO_DEVICE_IN_HDMI_EARC, // 0x88000001u
288 };
289
290 static CONST_ARRAY audio_devices_t AUDIO_DEVICE_IN_ALL_BLE_ARRAY[] = {
291 AUDIO_DEVICE_IN_BLE_HEADSET, // 0xA0000000u
292 };
293
294
295 static CONST_ARRAY audio_encapsulation_type_t AUDIO_ENCAPSULATION_TYPE_ALL_ARRAY[] = {
296 AUDIO_ENCAPSULATION_TYPE_IEC61937,
297 };
298
299
300 #ifndef AUDIO_ARRAY_SIZE
301 // std::size()
302 #define AUDIO_ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
303 #endif
304
305 // inline constexpr
306 static const uint32_t AUDIO_DEVICE_OUT_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_OUT_ALL_ARRAY);
307 static const uint32_t AUDIO_DEVICE_OUT_A2DP_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_OUT_ALL_A2DP_ARRAY);
308 static const uint32_t AUDIO_DEVICE_OUT_SCO_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_OUT_ALL_SCO_ARRAY);
309 static const uint32_t AUDIO_DEVICE_OUT_USB_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_OUT_ALL_USB_ARRAY);
310 static const uint32_t AUDIO_DEVICE_OUT_DIGITAL_CNT = AUDIO_ARRAY_SIZE(
311 AUDIO_DEVICE_OUT_ALL_DIGITAL_ARRAY);
312 static const uint32_t AUDIO_DEVICE_OUT_BLE_CNT = AUDIO_ARRAY_SIZE(
313 AUDIO_DEVICE_OUT_ALL_BLE_ARRAY);
314
315 static const uint32_t AUDIO_DEVICE_IN_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_IN_ALL_ARRAY);
316 static const uint32_t AUDIO_DEVICE_IN_SCO_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_IN_ALL_SCO_ARRAY);
317 static const uint32_t AUDIO_DEVICE_IN_USB_CNT = AUDIO_ARRAY_SIZE(AUDIO_DEVICE_IN_ALL_USB_ARRAY);
318 static const uint32_t AUDIO_DEVICE_IN_DIGITAL_CNT = AUDIO_ARRAY_SIZE(
319 AUDIO_DEVICE_IN_ALL_DIGITAL_ARRAY);
320 static const uint32_t AUDIO_DEVICE_IN_BLE_CNT = AUDIO_ARRAY_SIZE(
321 AUDIO_DEVICE_IN_ALL_BLE_ARRAY);
322
323 static const uint32_t AUDIO_ENCAPSULATION_MODE_ALL_POSITION_BITS =
324 (1 << AUDIO_ENCAPSULATION_MODE_NONE) |
325 (1 << AUDIO_ENCAPSULATION_MODE_ELEMENTARY_STREAM) |
326 (1 << AUDIO_ENCAPSULATION_MODE_HANDLE);
327 static const uint32_t AUDIO_ENCAPSULATION_METADATA_TYPE_ALL_POSITION_BITS =
328 (1 << AUDIO_ENCAPSULATION_METADATA_TYPE_NONE) |
329 (1 << AUDIO_ENCAPSULATION_METADATA_TYPE_FRAMEWORK_TUNER) |
330 (1 << AUDIO_ENCAPSULATION_METADATA_TYPE_DVB_AD_DESCRIPTOR);
331
332 static const uint32_t AUDIO_ENCAPSULATION_TYPE_CNT = AUDIO_ARRAY_SIZE(
333 AUDIO_ENCAPSULATION_TYPE_ALL_ARRAY);
334
335 #if AUDIO_ARRAYS_STATIC_CHECK
336
337 template<typename T, size_t N>
isSorted(const T (& a)[N])338 constexpr bool isSorted(const T(&a)[N]) {
339 for (size_t i = 1; i < N; ++i) {
340 if (a[i - 1] > a[i]) {
341 return false;
342 }
343 }
344 return true;
345 }
346
347 static_assert(isSorted(AUDIO_DEVICE_OUT_ALL_ARRAY),
348 "AUDIO_DEVICE_OUT_ALL_ARRAY must be sorted");
349 static_assert(isSorted(AUDIO_DEVICE_OUT_ALL_A2DP_ARRAY),
350 "AUDIO_DEVICE_OUT_ALL_A2DP_ARRAY must be sorted");
351 static_assert(isSorted(AUDIO_DEVICE_OUT_ALL_SCO_ARRAY),
352 "AUDIO_DEVICE_OUT_ALL_SCO_ARRAY must be sorted");
353 static_assert(isSorted(AUDIO_DEVICE_OUT_ALL_USB_ARRAY),
354 "AUDIO_DEVICE_OUT_ALL_USB_ARRAY must be sorted");
355 static_assert(isSorted(AUDIO_DEVICE_OUT_ALL_DIGITAL_ARRAY),
356 "AUDIO_DEVICE_OUT_ALL_DIGITAL_ARRAY must be sorted");
357 static_assert(isSorted(AUDIO_DEVICE_OUT_ALL_BLE_ARRAY),
358 "AUDIO_DEVICE_OUT_ALL_BLE_ARRAY must be sorted");
359 static_assert(isSorted(AUDIO_DEVICE_IN_ALL_ARRAY),
360 "AUDIO_DEVICE_IN_ALL_ARRAY must be sorted");
361 static_assert(isSorted(AUDIO_DEVICE_IN_ALL_SCO_ARRAY),
362 "AUDIO_DEVICE_IN_ALL_SCO_ARRAY must be sorted");
363 static_assert(isSorted(AUDIO_DEVICE_IN_ALL_USB_ARRAY),
364 "AUDIO_DEVICE_IN_ALL_USB_ARRAY must be sorted");
365 static_assert(isSorted(AUDIO_DEVICE_IN_ALL_DIGITAL_ARRAY),
366 "AUDIO_DEVICE_IN_ALL_DIGITAL_ARRAY must be sorted");
367 static_assert(isSorted(AUDIO_DEVICE_IN_ALL_BLE_ARRAY),
368 "AUDIO_DEVICE_IN_ALL_BLE_ARRAY must be sorted");
369
370 static_assert(AUDIO_DEVICE_OUT_CNT == std::size(AUDIO_DEVICE_OUT_ALL_ARRAY));
371 static_assert(AUDIO_DEVICE_OUT_A2DP_CNT == std::size(AUDIO_DEVICE_OUT_ALL_A2DP_ARRAY));
372 static_assert(AUDIO_DEVICE_OUT_SCO_CNT == std::size(AUDIO_DEVICE_OUT_ALL_SCO_ARRAY));
373 static_assert(AUDIO_DEVICE_OUT_USB_CNT == std::size(AUDIO_DEVICE_OUT_ALL_USB_ARRAY));
374 static_assert(AUDIO_DEVICE_OUT_DIGITAL_CNT == std::size(AUDIO_DEVICE_OUT_ALL_DIGITAL_ARRAY));
375 static_assert(AUDIO_DEVICE_OUT_BLE_CNT == std::size(AUDIO_DEVICE_OUT_ALL_BLE_ARRAY));
376 static_assert(AUDIO_DEVICE_IN_CNT == std::size(AUDIO_DEVICE_IN_ALL_ARRAY));
377 static_assert(AUDIO_DEVICE_IN_SCO_CNT == std::size(AUDIO_DEVICE_IN_ALL_SCO_ARRAY));
378 static_assert(AUDIO_DEVICE_IN_USB_CNT == std::size(AUDIO_DEVICE_IN_ALL_USB_ARRAY));
379 static_assert(AUDIO_DEVICE_IN_DIGITAL_CNT == std::size(AUDIO_DEVICE_IN_ALL_DIGITAL_ARRAY));
380 static_assert(AUDIO_DEVICE_IN_BLE_CNT == std::size(AUDIO_DEVICE_IN_ALL_BLE_ARRAY));
381 static_assert(AUDIO_ENCAPSULATION_TYPE_CNT == std::size(AUDIO_ENCAPSULATION_TYPE_ALL_ARRAY));
382
383 #if __has_builtin(__builtin_popcount)
384 // Replace with constexpr std::popcount with C++20
385
386 // Check common channel masks have counts we expect.
387 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_MONO) == 1);
388 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_STEREO) == 2);
389 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_2POINT1) == 3);
390 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_TRI) == 3);
391 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_TRI_BACK) == 3);
392 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_QUAD) == 4);
393 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_3POINT1) == 4);
394 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_2POINT0POINT2) == 4);
395 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_QUAD) == 4);
396 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_QUAD_SIDE) == 4);
397 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_SURROUND) == 4);
398 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_PENTA) == 5);
399 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_2POINT1POINT2) == 5);
400 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_3POINT0POINT2) == 5);
401 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_5POINT1) == 6);
402 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_3POINT1POINT2) == 6);
403 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_6POINT1) == 7);
404 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_7POINT1) == 8);
405 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_5POINT1POINT2) == 8);
406 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_5POINT1POINT4) == 10);
407 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_7POINT1POINT2) == 10);
408 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_7POINT1POINT4) == 12);
409 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_13POINT_360RA) == 13);
410 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_22POINT2) == 24);
411
412 // Check common channel masks which are a subset of another.
413 // (by subset, all the channel positions are contained in the other mask).
414
415 // Validate that channel positions in (a) are a subset of (b).
416 #define CHANNEL_CHECK_SUBSET_OF(a, b) \
417 static_assert(__builtin_popcount((a)^(b)) == __builtin_popcount(b) - __builtin_popcount(a))
418
419 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_MONO, AUDIO_CHANNEL_OUT_STEREO);
420 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_STEREO, AUDIO_CHANNEL_OUT_2POINT1);
421 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_STEREO, AUDIO_CHANNEL_OUT_QUAD);
422 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_QUAD, AUDIO_CHANNEL_OUT_PENTA);
423 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_2POINT1, AUDIO_CHANNEL_OUT_5POINT1);
424 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_5POINT1, AUDIO_CHANNEL_OUT_5POINT1POINT2);
425 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_5POINT1, AUDIO_CHANNEL_OUT_5POINT1POINT4);
426 // Note AUDIO_CHANNEL_OUT_5POINT1POINT2 is not subset of AUDIO_CHANNEL_OUT_5POINT1POINT4
427 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_5POINT1POINT2, AUDIO_CHANNEL_OUT_7POINT1POINT2);
428 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_7POINT1, AUDIO_CHANNEL_OUT_7POINT1POINT2);
429 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_7POINT1, AUDIO_CHANNEL_OUT_7POINT1POINT4);
430 // Note AUDIO_CHANNEL_OUT_7POINT1POINT2 is not subset of AUDIO_CHANNEL_OUT_7POINT1POINT4
431 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_5POINT1POINT4, AUDIO_CHANNEL_OUT_7POINT1POINT4);
432 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_13POINT_360RA, AUDIO_CHANNEL_OUT_22POINT2);
433 CHANNEL_CHECK_SUBSET_OF(AUDIO_CHANNEL_OUT_7POINT1POINT4, AUDIO_CHANNEL_OUT_22POINT2);
434
435 #undef CHANNEL_CHECK_SUBSET_OF
436
437 // Extra channel mask check
438 static_assert(__builtin_popcount(AUDIO_CHANNEL_OUT_13POINT_360RA
439 ^ AUDIO_CHANNEL_OUT_7POINT1POINT4) == 7); // bfl, bfr, bfc + tfc replace lfe + bl + br
440
441 #endif // __has_builtin(__builtin_popcount)
442
443 #endif // AUDIO_ARRAYS_STATIC_CHECK
444
445 #endif // ANDROID_AUDIO_BASE_UTILS_H
446