AudioSystemLegacy.h revision 4a0748be283a8c9efa02243c3e1716c49443a87c 
1/*
2 * Copyright (C) 2008 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_AUDIOSYSTEM_LEGACY_H_
18#define ANDROID_AUDIOSYSTEM_LEGACY_H_
19
20#include <utils/Errors.h>
21#include <media/AudioParameter.h>
22
23#include <system/audio.h>
24#include <hardware/audio_policy.h>
25
26namespace android_audio_legacy {
27
28using android::status_t;
29using android::AudioParameter;
30
31enum {
32    OK                  = android::OK,
33    NO_ERROR            = android::NO_ERROR,
34
35    UNKNOWN_ERROR       = android::UNKNOWN_ERROR,
36
37    NO_MEMORY           = android::NO_MEMORY,
38    INVALID_OPERATION   = android::INVALID_OPERATION,
39    BAD_VALUE           = android::BAD_VALUE,
40    BAD_TYPE            = android::BAD_TYPE,
41    NAME_NOT_FOUND      = android::NAME_NOT_FOUND,
42    PERMISSION_DENIED   = android::PERMISSION_DENIED,
43    NO_INIT             = android::NO_INIT,
44    ALREADY_EXISTS      = android::ALREADY_EXISTS,
45    DEAD_OBJECT         = android::DEAD_OBJECT,
46    FAILED_TRANSACTION  = android::FAILED_TRANSACTION,
47    JPARKS_BROKE_IT     = android::JPARKS_BROKE_IT,
48    BAD_INDEX           = android::BAD_INDEX,
49    NOT_ENOUGH_DATA     = android::NOT_ENOUGH_DATA,
50    WOULD_BLOCK         = android::WOULD_BLOCK,
51    TIMED_OUT           = android::TIMED_OUT,
52    UNKNOWN_TRANSACTION = android::UNKNOWN_TRANSACTION,
53};
54
55enum audio_source {
56    AUDIO_SOURCE_DEFAULT = 0,
57    AUDIO_SOURCE_MIC = 1,
58    AUDIO_SOURCE_VOICE_UPLINK = 2,
59    AUDIO_SOURCE_VOICE_DOWNLINK = 3,
60    AUDIO_SOURCE_VOICE_CALL = 4,
61    AUDIO_SOURCE_CAMCORDER = 5,
62    AUDIO_SOURCE_VOICE_RECOGNITION = 6,
63    AUDIO_SOURCE_VOICE_COMMUNICATION = 7,
64    AUDIO_SOURCE_MAX = AUDIO_SOURCE_VOICE_COMMUNICATION,
65
66    AUDIO_SOURCE_LIST_END  // must be last - used to validate audio source type
67};
68
69class AudioSystem {
70public:
71#if 1
72    enum stream_type {
73        DEFAULT          =-1,
74        VOICE_CALL       = 0,
75        SYSTEM           = 1,
76        RING             = 2,
77        MUSIC            = 3,
78        ALARM            = 4,
79        NOTIFICATION     = 5,
80        BLUETOOTH_SCO    = 6,
81        ENFORCED_AUDIBLE = 7, // Sounds that cannot be muted by user and must be routed to speaker
82        DTMF             = 8,
83        TTS              = 9,
84        NUM_STREAM_TYPES
85    };
86
87    // Audio sub formats (see AudioSystem::audio_format).
88    enum pcm_sub_format {
89        PCM_SUB_16_BIT          = 0x1, // must be 1 for backward compatibility
90        PCM_SUB_8_BIT           = 0x2, // must be 2 for backward compatibility
91    };
92
93    enum audio_sessions {
94        SESSION_OUTPUT_STAGE = AUDIO_SESSION_OUTPUT_STAGE,
95        SESSION_OUTPUT_MIX = AUDIO_SESSION_OUTPUT_MIX,
96    };
97
98    // MP3 sub format field definition : can use 11 LSBs in the same way as MP3 frame header to specify
99    // bit rate, stereo mode, version...
100    enum mp3_sub_format {
101        //TODO
102    };
103
104    // AMR NB/WB sub format field definition: specify frame block interleaving, bandwidth efficient or octet aligned,
105    // encoding mode for recording...
106    enum amr_sub_format {
107        //TODO
108    };
109
110    // AAC sub format field definition: specify profile or bitrate for recording...
111    enum aac_sub_format {
112        //TODO
113    };
114
115    // VORBIS sub format field definition: specify quality for recording...
116    enum vorbis_sub_format {
117        //TODO
118    };
119
120    // Audio format consists in a main format field (upper 8 bits) and a sub format field (lower 24 bits).
121    // The main format indicates the main codec type. The sub format field indicates options and parameters
122    // for each format. The sub format is mainly used for record to indicate for instance the requested bitrate
123    // or profile. It can also be used for certain formats to give informations not present in the encoded
124    // audio stream (e.g. octet alignement for AMR).
125    enum audio_format {
126        INVALID_FORMAT      = -1,
127        FORMAT_DEFAULT      = 0,
128        PCM                 = 0x00000000, // must be 0 for backward compatibility
129        MP3                 = 0x01000000,
130        AMR_NB              = 0x02000000,
131        AMR_WB              = 0x03000000,
132        AAC                 = 0x04000000,
133        HE_AAC_V1           = 0x05000000,
134        HE_AAC_V2           = 0x06000000,
135        VORBIS              = 0x07000000,
136        MAIN_FORMAT_MASK    = 0xFF000000,
137        SUB_FORMAT_MASK     = 0x00FFFFFF,
138        // Aliases
139        PCM_16_BIT          = (PCM|PCM_SUB_16_BIT),
140        PCM_8_BIT          = (PCM|PCM_SUB_8_BIT)
141    };
142
143
144    // Channel mask definitions must be kept in sync with JAVA values in /media/java/android/media/AudioFormat.java
145    enum audio_channels {
146        // output channels
147        CHANNEL_OUT_FRONT_LEFT = 0x4,
148        CHANNEL_OUT_FRONT_RIGHT = 0x8,
149        CHANNEL_OUT_FRONT_CENTER = 0x10,
150        CHANNEL_OUT_LOW_FREQUENCY = 0x20,
151        CHANNEL_OUT_BACK_LEFT = 0x40,
152        CHANNEL_OUT_BACK_RIGHT = 0x80,
153        CHANNEL_OUT_FRONT_LEFT_OF_CENTER = 0x100,
154        CHANNEL_OUT_FRONT_RIGHT_OF_CENTER = 0x200,
155        CHANNEL_OUT_BACK_CENTER = 0x400,
156        CHANNEL_OUT_MONO = CHANNEL_OUT_FRONT_LEFT,
157        CHANNEL_OUT_STEREO = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT),
158        CHANNEL_OUT_QUAD = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
159                CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT),
160        CHANNEL_OUT_SURROUND = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
161                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_BACK_CENTER),
162        CHANNEL_OUT_5POINT1 = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
163                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT),
164        CHANNEL_OUT_7POINT1 = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
165                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |
166                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER),
167        CHANNEL_OUT_ALL = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
168                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |
169                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER | CHANNEL_OUT_BACK_CENTER),
170
171        // input channels
172        CHANNEL_IN_LEFT = 0x4,
173        CHANNEL_IN_RIGHT = 0x8,
174        CHANNEL_IN_FRONT = 0x10,
175        CHANNEL_IN_BACK = 0x20,
176        CHANNEL_IN_LEFT_PROCESSED = 0x40,
177        CHANNEL_IN_RIGHT_PROCESSED = 0x80,
178        CHANNEL_IN_FRONT_PROCESSED = 0x100,
179        CHANNEL_IN_BACK_PROCESSED = 0x200,
180        CHANNEL_IN_PRESSURE = 0x400,
181        CHANNEL_IN_X_AXIS = 0x800,
182        CHANNEL_IN_Y_AXIS = 0x1000,
183        CHANNEL_IN_Z_AXIS = 0x2000,
184        CHANNEL_IN_VOICE_UPLINK = 0x4000,
185        CHANNEL_IN_VOICE_DNLINK = 0x8000,
186        CHANNEL_IN_MONO = CHANNEL_IN_FRONT,
187        CHANNEL_IN_STEREO = (CHANNEL_IN_LEFT | CHANNEL_IN_RIGHT),
188        CHANNEL_IN_ALL = (CHANNEL_IN_LEFT | CHANNEL_IN_RIGHT | CHANNEL_IN_FRONT | CHANNEL_IN_BACK|
189                CHANNEL_IN_LEFT_PROCESSED | CHANNEL_IN_RIGHT_PROCESSED | CHANNEL_IN_FRONT_PROCESSED | CHANNEL_IN_BACK_PROCESSED|
190                CHANNEL_IN_PRESSURE | CHANNEL_IN_X_AXIS | CHANNEL_IN_Y_AXIS | CHANNEL_IN_Z_AXIS |
191                CHANNEL_IN_VOICE_UPLINK | CHANNEL_IN_VOICE_DNLINK)
192    };
193
194    enum audio_mode {
195        MODE_INVALID = -2,
196        MODE_CURRENT = -1,
197        MODE_NORMAL = 0,
198        MODE_RINGTONE,
199        MODE_IN_CALL,
200        MODE_IN_COMMUNICATION,
201        NUM_MODES  // not a valid entry, denotes end-of-list
202    };
203
204    enum audio_in_acoustics {
205        AGC_ENABLE    = 0x0001,
206        AGC_DISABLE   = 0,
207        NS_ENABLE     = 0x0002,
208        NS_DISABLE    = 0,
209        TX_IIR_ENABLE = 0x0004,
210        TX_DISABLE    = 0
211    };
212
213    enum audio_devices {
214        // output devices
215        DEVICE_OUT_EARPIECE = 0x1,
216        DEVICE_OUT_SPEAKER = 0x2,
217        DEVICE_OUT_WIRED_HEADSET = 0x4,
218        DEVICE_OUT_WIRED_HEADPHONE = 0x8,
219        DEVICE_OUT_BLUETOOTH_SCO = 0x10,
220        DEVICE_OUT_BLUETOOTH_SCO_HEADSET = 0x20,
221        DEVICE_OUT_BLUETOOTH_SCO_CARKIT = 0x40,
222        DEVICE_OUT_BLUETOOTH_A2DP = 0x80,
223        DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = 0x100,
224        DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = 0x200,
225        DEVICE_OUT_AUX_DIGITAL = 0x400,
226        DEVICE_OUT_ANLG_DOCK_HEADSET = 0x800,
227        DEVICE_OUT_DGTL_DOCK_HEADSET = 0x1000,
228        DEVICE_OUT_DEFAULT = 0x8000,
229        DEVICE_OUT_ALL = (DEVICE_OUT_EARPIECE | DEVICE_OUT_SPEAKER | DEVICE_OUT_WIRED_HEADSET |
230                DEVICE_OUT_WIRED_HEADPHONE | DEVICE_OUT_BLUETOOTH_SCO | DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
231                DEVICE_OUT_BLUETOOTH_SCO_CARKIT | DEVICE_OUT_BLUETOOTH_A2DP | DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
232                DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER | DEVICE_OUT_AUX_DIGITAL |
233                DEVICE_OUT_ANLG_DOCK_HEADSET | DEVICE_OUT_DGTL_DOCK_HEADSET |
234                DEVICE_OUT_DEFAULT),
235        DEVICE_OUT_ALL_A2DP = (DEVICE_OUT_BLUETOOTH_A2DP | DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
236                DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER),
237
238        // input devices
239        DEVICE_IN_COMMUNICATION = 0x10000,
240        DEVICE_IN_AMBIENT = 0x20000,
241        DEVICE_IN_BUILTIN_MIC = 0x40000,
242        DEVICE_IN_BLUETOOTH_SCO_HEADSET = 0x80000,
243        DEVICE_IN_WIRED_HEADSET = 0x100000,
244        DEVICE_IN_AUX_DIGITAL = 0x200000,
245        DEVICE_IN_VOICE_CALL = 0x400000,
246        DEVICE_IN_BACK_MIC = 0x800000,
247        DEVICE_IN_DEFAULT = 0x80000000,
248
249        DEVICE_IN_ALL = (DEVICE_IN_COMMUNICATION | DEVICE_IN_AMBIENT | DEVICE_IN_BUILTIN_MIC |
250                DEVICE_IN_BLUETOOTH_SCO_HEADSET | DEVICE_IN_WIRED_HEADSET | DEVICE_IN_AUX_DIGITAL |
251                DEVICE_IN_VOICE_CALL | DEVICE_IN_BACK_MIC | DEVICE_IN_DEFAULT)
252    };
253
254    // request to open a direct output with getOutput() (by opposition to sharing an output with other AudioTracks)
255    enum output_flags {
256        OUTPUT_FLAG_INDIRECT = 0x0,
257        OUTPUT_FLAG_DIRECT = 0x1
258    };
259
260    // device categories used for setForceUse()
261    enum forced_config {
262        FORCE_NONE,
263        FORCE_SPEAKER,
264        FORCE_HEADPHONES,
265        FORCE_BT_SCO,
266        FORCE_BT_A2DP,
267        FORCE_WIRED_ACCESSORY,
268        FORCE_BT_CAR_DOCK,
269        FORCE_BT_DESK_DOCK,
270        FORCE_ANALOG_DOCK,
271        FORCE_DIGITAL_DOCK,
272        NUM_FORCE_CONFIG,
273        FORCE_DEFAULT = FORCE_NONE
274    };
275
276    // usages used for setForceUse()
277    enum force_use {
278        FOR_COMMUNICATION,
279        FOR_MEDIA,
280        FOR_RECORD,
281        FOR_DOCK,
282        NUM_FORCE_USE
283    };
284
285    //
286    // AudioPolicyService interface
287    //
288
289    // device connection states used for setDeviceConnectionState()
290    enum device_connection_state {
291        DEVICE_STATE_UNAVAILABLE,
292        DEVICE_STATE_AVAILABLE,
293        NUM_DEVICE_STATES
294    };
295
296#endif
297
298    static uint32_t popCount(uint32_t u) {
299        return popcount(u);
300    }
301
302#if 1
303    static bool isOutputDevice(audio_devices device) {
304        return audio_is_output_device((audio_devices_t)device);
305    }
306    static bool isInputDevice(audio_devices device) {
307        return audio_is_input_device((audio_devices_t)device);
308    }
309    static bool isA2dpDevice(audio_devices device) {
310        return audio_is_a2dp_device((audio_devices_t)device);
311    }
312    static bool isBluetoothScoDevice(audio_devices device) {
313        return audio_is_bluetooth_sco_device((audio_devices_t)device);
314    }
315    static bool isLowVisibility(stream_type stream) {
316        return audio_is_low_visibility((audio_stream_type_t)stream);
317    }
318    static bool isValidFormat(uint32_t format) {
319        return audio_is_valid_format(format);
320    }
321    static bool isLinearPCM(uint32_t format) {
322        return audio_is_linear_pcm(format);
323    }
324    static bool isOutputChannel(uint32_t channel) {
325        return audio_is_output_channel(channel);
326    }
327    static bool isInputChannel(uint32_t channel) {
328        return audio_is_input_channel(channel);
329    }
330
331#endif
332};
333
334};  // namespace android
335
336#endif // ANDROID_AUDIOSYSTEM_LEGACY_H_
337