Gitiles
Code Review Sign In
gerrit.aospa.co / AOSPA / android_system_core / e8e4be57aa45f621d231a40801a4dea877be09d5 / . / include / system / audio.h
blob: 8f2ac0c013fc6463fa1992992cbc13ebbdcdd47e [file] [log] [blame]
Dima Zavine8e4be52011-05-12 10:25:33 -0700[diff] [blame^]1/*
2 * Copyright (C) 2011 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
18#ifndef ANDROID_AUDIO_CORE_H
19#define ANDROID_AUDIO_CORE_H
20
21#include <stdbool.h>
22#include <stdint.h>
23#include <sys/cdefs.h>
24#include <sys/types.h>
25
26#include <cutils/bitops.h>
27
28__BEGIN_DECLS
29
30/* The enums were moved here mostly from
31 * frameworks/base/include/media/AudioSystem.h
32 */
33
34typedef int audio_io_handle_t;
35
36/* Audio stream types */
37typedef enum {
38 AUDIO_STREAM_DEFAULT = -1,
39 AUDIO_STREAM_VOICE_CALL = 0,
40 AUDIO_STREAM_SYSTEM = 1,
41 AUDIO_STREAM_RING = 2,
42 AUDIO_STREAM_MUSIC = 3,
43 AUDIO_STREAM_ALARM = 4,
44 AUDIO_STREAM_NOTIFICATION = 5,
45 AUDIO_STREAM_BLUETOOTH_SCO = 6,
46 AUDIO_STREAM_ENFORCED_AUDIBLE = 7, /* Sounds that cannot be muted by user and must be routed to speaker */
47 AUDIO_STREAM_DTMF = 8,
48 AUDIO_STREAM_TTS = 9,
49
50 AUDIO_STREAM_CNT,
51 AUDIO_STREAM_MAX = AUDIO_STREAM_CNT - 1,
52} audio_stream_type_t;
53
54/* Do not change these values without updating their counterparts
55 * in media/java/android/media/MediaRecorder.java!
56 */
57typedef enum {
58 AUDIO_SOURCE_DEFAULT = 0,
59 AUDIO_SOURCE_MIC = 1,
60 AUDIO_SOURCE_VOICE_UPLINK = 2,
61 AUDIO_SOURCE_VOICE_DOWNLINK = 3,
62 AUDIO_SOURCE_VOICE_CALL = 4,
63 AUDIO_SOURCE_CAMCORDER = 5,
64 AUDIO_SOURCE_VOICE_RECOGNITION = 6,
65 AUDIO_SOURCE_VOICE_COMMUNICATION = 7,
66
67 AUDIO_SOURCE_CNT,
68 AUDIO_SOURCE_MAX = AUDIO_SOURCE_CNT - 1,
69} audio_source_t;
70
71/* special audio session values
72 * (XXX: should this be living in the audio effects land?)
73 */
74typedef enum {
75 /* session for effects attached to a particular output stream
76 * (value must be less than 0)
77 */
78 AUDIO_SESSION_OUTPUT_STAGE = -1,
79
80 /* session for effects applied to output mix. These effects can
81 * be moved by audio policy manager to another output stream
82 * (value must be 0)
83 */
84 AUDIO_SESSION_OUTPUT_MIX = 0,
85} audio_session_t;
86
87/* Audio sub formats (see enum audio_format). */
88
89/* PCM sub formats */
90typedef enum {
91 AUDIO_FORMAT_PCM_SUB_16_BIT = 0x1, /* DO NOT CHANGE */
92 AUDIO_FORMAT_PCM_SUB_8_BIT = 0x2, /* DO NOT CHANGE */
93} audio_format_pcm_sub_fmt_t;
94
95/* MP3 sub format field definition : can use 11 LSBs in the same way as MP3
96 * frame header to specify bit rate, stereo mode, version...
97 */
98typedef enum {
99 AUDIO_FORMAT_MP3_SUB_NONE = 0x0,
100} audio_format_mp3_sub_fmt_t;
101
102/* AMR NB/WB sub format field definition: specify frame block interleaving,
103 * bandwidth efficient or octet aligned, encoding mode for recording...
104 */
105typedef enum {
106 AUDIO_FORMAT_AMR_SUB_NONE = 0x0,
107} audio_format_amr_sub_fmt_t;
108
109/* AAC sub format field definition: specify profile or bitrate for recording... */
110typedef enum {
111 AUDIO_FORMAT_AAC_SUB_NONE = 0x0,
112} audio_format_aac_sub_fmt_t;
113
114/* VORBIS sub format field definition: specify quality for recording... */
115typedef enum {
116 AUDIO_FORMAT_VORBIS_SUB_NONE = 0x0,
117} audio_format_vorbis_sub_fmt_t;
118
119/* Audio format consists in a main format field (upper 8 bits) and a sub format
120 * field (lower 24 bits).
121 *
122 * The main format indicates the main codec type. The sub format field
123 * indicates options and parameters for each format. The sub format is mainly
124 * used for record to indicate for instance the requested bitrate or profile.
125 * It can also be used for certain formats to give informations not present in
126 * the encoded audio stream (e.g. octet alignement for AMR).
127 */
128typedef enum {
129 AUDIO_FORMAT_INVALID = 0xFFFFFFFFUL,
130 AUDIO_FORMAT_DEFAULT = 0,
131 AUDIO_FORMAT_PCM = 0x00000000UL, /* DO NOT CHANGE */
132 AUDIO_FORMAT_MP3 = 0x01000000UL,
133 AUDIO_FORMAT_AMR_NB = 0x02000000UL,
134 AUDIO_FORMAT_AMR_WB = 0x03000000UL,
135 AUDIO_FORMAT_AAC = 0x04000000UL,
136 AUDIO_FORMAT_HE_AAC_V1 = 0x05000000UL,
137 AUDIO_FORMAT_HE_AAC_V2 = 0x06000000UL,
138 AUDIO_FORMAT_VORBIS = 0x07000000UL,
139 AUDIO_FORMAT_MAIN_MASK = 0xFF000000UL,
140 AUDIO_FORMAT_SUB_MASK = 0x00FFFFFFUL,
141
142 /* Aliases */
143 AUDIO_FORMAT_PCM_16_BIT = (AUDIO_FORMAT_PCM |
144 AUDIO_FORMAT_PCM_SUB_16_BIT),
145 AUDIO_FORMAT_PCM_8_BIT = (AUDIO_FORMAT_PCM |
146 AUDIO_FORMAT_PCM_SUB_8_BIT),
147} audio_format_t;
148
149/* Channel mask definitions must be kept in sync with JAVA values in
150 * frameworks/base/media/java/android/media/AudioFormat.java */
151typedef enum {
152 /* output channels */
153 AUDIO_CHANNEL_OUT_FRONT_LEFT = 0x4,
154 AUDIO_CHANNEL_OUT_FRONT_RIGHT = 0x8,
155 AUDIO_CHANNEL_OUT_FRONT_CENTER = 0x10,
156 AUDIO_CHANNEL_OUT_LOW_FREQUENCY = 0x20,
157 AUDIO_CHANNEL_OUT_BACK_LEFT = 0x40,
158 AUDIO_CHANNEL_OUT_BACK_RIGHT = 0x80,
159 AUDIO_CHANNEL_OUT_FRONT_LEFT_OF_CENTER = 0x100,
160 AUDIO_CHANNEL_OUT_FRONT_RIGHT_OF_CENTER = 0x200,
161 AUDIO_CHANNEL_OUT_BACK_CENTER = 0x400,
162
163 AUDIO_CHANNEL_OUT_MONO = AUDIO_CHANNEL_OUT_FRONT_LEFT,
164 AUDIO_CHANNEL_OUT_STEREO = (AUDIO_CHANNEL_OUT_FRONT_LEFT |
165 AUDIO_CHANNEL_OUT_FRONT_RIGHT),
166 AUDIO_CHANNEL_OUT_QUAD = (AUDIO_CHANNEL_OUT_FRONT_LEFT |
167 AUDIO_CHANNEL_OUT_FRONT_RIGHT |
168 AUDIO_CHANNEL_OUT_BACK_LEFT |
169 AUDIO_CHANNEL_OUT_BACK_RIGHT),
170 AUDIO_CHANNEL_OUT_SURROUND = (AUDIO_CHANNEL_OUT_FRONT_LEFT |
171 AUDIO_CHANNEL_OUT_FRONT_RIGHT |
172 AUDIO_CHANNEL_OUT_FRONT_CENTER |
173 AUDIO_CHANNEL_OUT_BACK_CENTER),
174 AUDIO_CHANNEL_OUT_5POINT1 = (AUDIO_CHANNEL_OUT_FRONT_LEFT |
175 AUDIO_CHANNEL_OUT_FRONT_RIGHT |
176 AUDIO_CHANNEL_OUT_FRONT_CENTER |
177 AUDIO_CHANNEL_OUT_LOW_FREQUENCY |
178 AUDIO_CHANNEL_OUT_BACK_LEFT |
179 AUDIO_CHANNEL_OUT_BACK_RIGHT),
180 AUDIO_CHANNEL_OUT_7POINT1 = (AUDIO_CHANNEL_OUT_FRONT_LEFT |
181 AUDIO_CHANNEL_OUT_FRONT_RIGHT |
182 AUDIO_CHANNEL_OUT_FRONT_CENTER |
183 AUDIO_CHANNEL_OUT_LOW_FREQUENCY |
184 AUDIO_CHANNEL_OUT_BACK_LEFT |
185 AUDIO_CHANNEL_OUT_BACK_RIGHT |
186 AUDIO_CHANNEL_OUT_FRONT_LEFT_OF_CENTER |
187 AUDIO_CHANNEL_OUT_FRONT_RIGHT_OF_CENTER),
188 AUDIO_CHANNEL_OUT_ALL = (AUDIO_CHANNEL_OUT_FRONT_LEFT |
189 AUDIO_CHANNEL_OUT_FRONT_RIGHT |
190 AUDIO_CHANNEL_OUT_FRONT_CENTER |
191 AUDIO_CHANNEL_OUT_LOW_FREQUENCY |
192 AUDIO_CHANNEL_OUT_BACK_LEFT |
193 AUDIO_CHANNEL_OUT_BACK_RIGHT |
194 AUDIO_CHANNEL_OUT_FRONT_LEFT_OF_CENTER |
195 AUDIO_CHANNEL_OUT_FRONT_RIGHT_OF_CENTER |
196 AUDIO_CHANNEL_OUT_BACK_CENTER),
197
198 /* input channels */
199 AUDIO_CHANNEL_IN_LEFT = 0x4,
200 AUDIO_CHANNEL_IN_RIGHT = 0x8,
201 AUDIO_CHANNEL_IN_FRONT = 0x10,
202 AUDIO_CHANNEL_IN_BACK = 0x20,
203 AUDIO_CHANNEL_IN_LEFT_PROCESSED = 0x40,
204 AUDIO_CHANNEL_IN_RIGHT_PROCESSED = 0x80,
205 AUDIO_CHANNEL_IN_FRONT_PROCESSED = 0x100,
206 AUDIO_CHANNEL_IN_BACK_PROCESSED = 0x200,
207 AUDIO_CHANNEL_IN_PRESSURE = 0x400,
208 AUDIO_CHANNEL_IN_X_AXIS = 0x800,
209 AUDIO_CHANNEL_IN_Y_AXIS = 0x1000,
210 AUDIO_CHANNEL_IN_Z_AXIS = 0x2000,
211 AUDIO_CHANNEL_IN_VOICE_UPLINK = 0x4000,
212 AUDIO_CHANNEL_IN_VOICE_DNLINK = 0x8000,
213
214 AUDIO_CHANNEL_IN_MONO = AUDIO_CHANNEL_IN_FRONT,
215 AUDIO_CHANNEL_IN_STEREO = (AUDIO_CHANNEL_IN_LEFT | AUDIO_CHANNEL_IN_RIGHT),
216 AUDIO_CHANNEL_IN_ALL = (AUDIO_CHANNEL_IN_LEFT |
217 AUDIO_CHANNEL_IN_RIGHT |
218 AUDIO_CHANNEL_IN_FRONT |
219 AUDIO_CHANNEL_IN_BACK|
220 AUDIO_CHANNEL_IN_LEFT_PROCESSED |
221 AUDIO_CHANNEL_IN_RIGHT_PROCESSED |
222 AUDIO_CHANNEL_IN_FRONT_PROCESSED |
223 AUDIO_CHANNEL_IN_BACK_PROCESSED|
224 AUDIO_CHANNEL_IN_PRESSURE |
225 AUDIO_CHANNEL_IN_X_AXIS |
226 AUDIO_CHANNEL_IN_Y_AXIS |
227 AUDIO_CHANNEL_IN_Z_AXIS |
228 AUDIO_CHANNEL_IN_VOICE_UPLINK |
229 AUDIO_CHANNEL_IN_VOICE_DNLINK),
230} audio_channels_t;
231
232typedef enum {
233 AUDIO_MODE_INVALID = -2,
234 AUDIO_MODE_CURRENT = -1,
235 AUDIO_MODE_NORMAL = 0,
236 AUDIO_MODE_RINGTONE = 1,
237 AUDIO_MODE_IN_CALL = 2,
238 AUDIO_MODE_IN_COMMUNICATION = 3,
239
240 AUDIO_MODE_CNT,
241 AUDIO_MODE_MAX = AUDIO_MODE_CNT - 1,
242} audio_mode_t;
243
244typedef enum {
245 AUDIO_IN_ACOUSTICS_AGC_ENABLE = 0x0001,
246 AUDIO_IN_ACOUSTICS_AGC_DISABLE = 0,
247 AUDIO_IN_ACOUSTICS_NS_ENABLE = 0x0002,
248 AUDIO_IN_ACOUSTICS_NS_DISABLE = 0,
249 AUDIO_IN_ACOUSTICS_TX_IIR_ENABLE = 0x0004,
250 AUDIO_IN_ACOUSTICS_TX_DISABLE = 0,
251} audio_in_acoustics_t;
252
253typedef enum {
254 /* output devices */
255 AUDIO_DEVICE_OUT_EARPIECE = 0x1,
256 AUDIO_DEVICE_OUT_SPEAKER = 0x2,
257 AUDIO_DEVICE_OUT_WIRED_HEADSET = 0x4,
258 AUDIO_DEVICE_OUT_WIRED_HEADPHONE = 0x8,
259 AUDIO_DEVICE_OUT_BLUETOOTH_SCO = 0x10,
260 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET = 0x20,
261 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT = 0x40,
262 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP = 0x80,
263 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = 0x100,
264 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = 0x200,
265 AUDIO_DEVICE_OUT_AUX_DIGITAL = 0x400,
266 AUDIO_DEVICE_OUT_ANLG_DOCK_HEADSET = 0x800,
267 AUDIO_DEVICE_OUT_DGTL_DOCK_HEADSET = 0x1000,
268 AUDIO_DEVICE_OUT_DEFAULT = 0x8000,
269 AUDIO_DEVICE_OUT_ALL = (AUDIO_DEVICE_OUT_EARPIECE |
270 AUDIO_DEVICE_OUT_SPEAKER |
271 AUDIO_DEVICE_OUT_WIRED_HEADSET |
272 AUDIO_DEVICE_OUT_WIRED_HEADPHONE |
273 AUDIO_DEVICE_OUT_BLUETOOTH_SCO |
274 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
275 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT |
276 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP |
277 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
278 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER |
279 AUDIO_DEVICE_OUT_AUX_DIGITAL |
280 AUDIO_DEVICE_OUT_ANLG_DOCK_HEADSET |
281 AUDIO_DEVICE_OUT_DGTL_DOCK_HEADSET |
282 AUDIO_DEVICE_OUT_DEFAULT),
283 AUDIO_DEVICE_OUT_ALL_A2DP = (AUDIO_DEVICE_OUT_BLUETOOTH_A2DP |
284 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
285 AUDIO_DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER),
286 AUDIO_DEVICE_OUT_ALL_SCO = (AUDIO_DEVICE_OUT_BLUETOOTH_SCO |
287 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
288 AUDIO_DEVICE_OUT_BLUETOOTH_SCO_CARKIT),
289
290 /* input devices */
291 AUDIO_DEVICE_IN_COMMUNICATION = 0x10000,
292 AUDIO_DEVICE_IN_AMBIENT = 0x20000,
293 AUDIO_DEVICE_IN_BUILTIN_MIC = 0x40000,
294 AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET = 0x80000,
295 AUDIO_DEVICE_IN_WIRED_HEADSET = 0x100000,
296 AUDIO_DEVICE_IN_AUX_DIGITAL = 0x200000,
297 AUDIO_DEVICE_IN_VOICE_CALL = 0x400000,
298 AUDIO_DEVICE_IN_BACK_MIC = 0x800000,
299 AUDIO_DEVICE_IN_DEFAULT = 0x80000000,
300
301 AUDIO_DEVICE_IN_ALL = (AUDIO_DEVICE_IN_COMMUNICATION |
302 AUDIO_DEVICE_IN_AMBIENT |
303 AUDIO_DEVICE_IN_BUILTIN_MIC |
304 AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET |
305 AUDIO_DEVICE_IN_WIRED_HEADSET |
306 AUDIO_DEVICE_IN_AUX_DIGITAL |
307 AUDIO_DEVICE_IN_VOICE_CALL |
308 AUDIO_DEVICE_IN_BACK_MIC |
309 AUDIO_DEVICE_IN_DEFAULT),
310 AUDIO_DEVICE_IN_ALL_SCO = AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET,
311} audio_devices_t;
312
313static inline bool audio_is_output_device(audio_devices_t device)
314{
315 if ((popcount(device) == 1) && ((device & ~AUDIO_DEVICE_OUT_ALL) == 0))
316 return true;
317 else
318 return false;
319}
320
321static inline bool audio_is_input_device(audio_devices_t device)
322{
323 if ((popcount(device) == 1) && ((device & ~AUDIO_DEVICE_IN_ALL) == 0))
324 return true;
325 else
326 return false;
327}
328
329static inline bool audio_is_a2dp_device(audio_devices_t device)
330{
331 if ((popcount(device) == 1) && (device & AUDIO_DEVICE_OUT_ALL_A2DP))
332 return true;
333 else
334 return false;
335}
336
337static inline bool audio_is_bluetooth_sco_device(audio_devices_t device)
338{
339 if ((popcount(device) == 1) && (device & (AUDIO_DEVICE_OUT_ALL_SCO |
340 AUDIO_DEVICE_IN_BLUETOOTH_SCO_HEADSET)))
341 return true;
342 else
343 return false;
344}
345
346static inline bool audio_is_input_channel(uint32_t channel)
347{
348 if ((channel & ~AUDIO_CHANNEL_IN_ALL) == 0)
349 return true;
350 else
351 return false;
352}
353
354static inline bool audio_is_output_channel(uint32_t channel)
355{
356 if ((channel & ~AUDIO_CHANNEL_OUT_ALL) == 0)
357 return true;
358 else
359 return false;
360}
361
362static inline bool audio_is_valid_format(uint32_t format)
363{
364 switch (format & AUDIO_FORMAT_MAIN_MASK) {
365 case AUDIO_FORMAT_PCM:
366 case AUDIO_FORMAT_MP3:
367 case AUDIO_FORMAT_AMR_NB:
368 case AUDIO_FORMAT_AMR_WB:
369 case AUDIO_FORMAT_AAC:
370 case AUDIO_FORMAT_HE_AAC_V1:
371 case AUDIO_FORMAT_HE_AAC_V2:
372 case AUDIO_FORMAT_VORBIS:
373 return true;
374 default:
375 return false;
376 }
377}
378
379static inline bool audio_is_linear_pcm(uint32_t format)
380{
381 switch (format) {
382 case AUDIO_FORMAT_PCM_16_BIT:
383 case AUDIO_FORMAT_PCM_8_BIT:
384 return true;
385 default:
386 return false;
387 }
388}
389
390
391__END_DECLS
392
393#endif // ANDROID_AUDIO_CORE_H