AudioSystem.h revision 05bca2fde53bfe3063d2a0a877f2b6bfdd6052cf 
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_H_
18#define ANDROID_AUDIOSYSTEM_H_
19
20#include <utils/RefBase.h>
21#include <utils/threads.h>
22#include <media/IAudioFlinger.h>
23
24namespace android {
25
26typedef void (*audio_error_callback)(status_t err);
27typedef int audio_io_handle_t;
28
29class IAudioPolicyService;
30class String8;
31
32class AudioSystem
33{
34public:
35
36    enum stream_type {
37        DEFAULT          =-1,
38        VOICE_CALL       = 0,
39        SYSTEM           = 1,
40        RING             = 2,
41        MUSIC            = 3,
42        ALARM            = 4,
43        NOTIFICATION     = 5,
44        BLUETOOTH_SCO    = 6,
45        ENFORCED_AUDIBLE = 7, // Sounds that cannot be muted by user and must be routed to speaker
46        DTMF             = 8,
47        TTS              = 9,
48        NUM_STREAM_TYPES
49    };
50
51    // Audio sub formats (see AudioSystem::audio_format).
52    enum pcm_sub_format {
53        PCM_SUB_16_BIT          = 0x1, // must be 1 for backward compatibility
54        PCM_SUB_8_BIT           = 0x2, // must be 2 for backward compatibility
55    };
56
57    // MP3 sub format field definition : can use 11 LSBs in the same way as MP3 frame header to specify
58    // bit rate, stereo mode, version...
59    enum mp3_sub_format {
60        //TODO
61    };
62
63    // AMR NB/WB sub format field definition: specify frame block interleaving, bandwidth efficient or octet aligned,
64    // encoding mode for recording...
65    enum amr_sub_format {
66        //TODO
67    };
68
69    // AAC sub format field definition: specify profile or bitrate for recording...
70    enum aac_sub_format {
71        //TODO
72    };
73
74    // VORBIS sub format field definition: specify quality for recording...
75    enum vorbis_sub_format {
76        //TODO
77    };
78
79    // Audio format consists in a main format field (upper 8 bits) and a sub format field (lower 24 bits).
80    // The main format indicates the main codec type. The sub format field indicates options and parameters
81    // for each format. The sub format is mainly used for record to indicate for instance the requested bitrate
82    // or profile. It can also be used for certain formats to give informations not present in the encoded
83    // audio stream (e.g. octet alignement for AMR).
84    enum audio_format {
85        INVALID_FORMAT      = -1,
86        FORMAT_DEFAULT      = 0,
87        PCM                 = 0x00000000, // must be 0 for backward compatibility
88        MP3                 = 0x01000000,
89        AMR_NB              = 0x02000000,
90        AMR_WB              = 0x03000000,
91        AAC                 = 0x04000000,
92        HE_AAC_V1           = 0x05000000,
93        HE_AAC_V2           = 0x06000000,
94        VORBIS              = 0x07000000,
95        MAIN_FORMAT_MASK    = 0xFF000000,
96        SUB_FORMAT_MASK     = 0x00FFFFFF,
97        // Aliases
98        PCM_16_BIT          = (PCM|PCM_SUB_16_BIT),
99        PCM_8_BIT          = (PCM|PCM_SUB_8_BIT)
100    };
101
102
103    // Channel mask definitions must be kept in sync with JAVA values in /media/java/android/media/AudioFormat.java
104    enum audio_channels {
105        // output channels
106        CHANNEL_OUT_FRONT_LEFT = 0x4,
107        CHANNEL_OUT_FRONT_RIGHT = 0x8,
108        CHANNEL_OUT_FRONT_CENTER = 0x10,
109        CHANNEL_OUT_LOW_FREQUENCY = 0x20,
110        CHANNEL_OUT_BACK_LEFT = 0x40,
111        CHANNEL_OUT_BACK_RIGHT = 0x80,
112        CHANNEL_OUT_FRONT_LEFT_OF_CENTER = 0x100,
113        CHANNEL_OUT_FRONT_RIGHT_OF_CENTER = 0x200,
114        CHANNEL_OUT_BACK_CENTER = 0x400,
115        CHANNEL_OUT_MONO = CHANNEL_OUT_FRONT_LEFT,
116        CHANNEL_OUT_STEREO = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT),
117        CHANNEL_OUT_QUAD = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
118                CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT),
119        CHANNEL_OUT_SURROUND = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
120                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_BACK_CENTER),
121        CHANNEL_OUT_5POINT1 = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
122                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT),
123        CHANNEL_OUT_7POINT1 = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
124                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |
125                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER),
126        CHANNEL_OUT_ALL = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |
127                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |
128                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER | CHANNEL_OUT_BACK_CENTER),
129
130        // input channels
131        CHANNEL_IN_LEFT = 0x4,
132        CHANNEL_IN_RIGHT = 0x8,
133        CHANNEL_IN_FRONT = 0x10,
134        CHANNEL_IN_BACK = 0x20,
135        CHANNEL_IN_LEFT_PROCESSED = 0x40,
136        CHANNEL_IN_RIGHT_PROCESSED = 0x80,
137        CHANNEL_IN_FRONT_PROCESSED = 0x100,
138        CHANNEL_IN_BACK_PROCESSED = 0x200,
139        CHANNEL_IN_PRESSURE = 0x400,
140        CHANNEL_IN_X_AXIS = 0x800,
141        CHANNEL_IN_Y_AXIS = 0x1000,
142        CHANNEL_IN_Z_AXIS = 0x2000,
143        CHANNEL_IN_VOICE_UPLINK = 0x4000,
144        CHANNEL_IN_VOICE_DNLINK = 0x8000,
145        CHANNEL_IN_MONO = CHANNEL_IN_FRONT,
146        CHANNEL_IN_STEREO = (CHANNEL_IN_LEFT | CHANNEL_IN_RIGHT),
147        CHANNEL_IN_ALL = (CHANNEL_IN_LEFT | CHANNEL_IN_RIGHT | CHANNEL_IN_FRONT | CHANNEL_IN_BACK|
148                CHANNEL_IN_LEFT_PROCESSED | CHANNEL_IN_RIGHT_PROCESSED | CHANNEL_IN_FRONT_PROCESSED | CHANNEL_IN_BACK_PROCESSED|
149                CHANNEL_IN_PRESSURE | CHANNEL_IN_X_AXIS | CHANNEL_IN_Y_AXIS | CHANNEL_IN_Z_AXIS |
150                CHANNEL_IN_VOICE_UPLINK | CHANNEL_IN_VOICE_DNLINK)
151    };
152
153    enum audio_mode {
154        MODE_INVALID = -2,
155        MODE_CURRENT = -1,
156        MODE_NORMAL = 0,
157        MODE_RINGTONE,
158        MODE_IN_CALL,
159        NUM_MODES  // not a valid entry, denotes end-of-list
160    };
161
162    enum audio_in_acoustics {
163        AGC_ENABLE    = 0x0001,
164        AGC_DISABLE   = 0,
165        NS_ENABLE     = 0x0002,
166        NS_DISABLE    = 0,
167        TX_IIR_ENABLE = 0x0004,
168        TX_DISABLE    = 0
169    };
170
171    /* These are static methods to control the system-wide AudioFlinger
172     * only privileged processes can have access to them
173     */
174
175    // mute/unmute microphone
176    static status_t muteMicrophone(bool state);
177    static status_t isMicrophoneMuted(bool *state);
178
179    // set/get master volume
180    static status_t setMasterVolume(float value);
181    static status_t getMasterVolume(float* volume);
182    // mute/unmute audio outputs
183    static status_t setMasterMute(bool mute);
184    static status_t getMasterMute(bool* mute);
185
186    // set/get stream volume on specified output
187    static status_t setStreamVolume(int stream, float value, int output);
188    static status_t getStreamVolume(int stream, float* volume, int output);
189
190    // mute/unmute stream
191    static status_t setStreamMute(int stream, bool mute);
192    static status_t getStreamMute(int stream, bool* mute);
193
194    // set audio mode in audio hardware (see AudioSystem::audio_mode)
195    static status_t setMode(int mode);
196
197    // returns true in *state if tracks are active on the specified stream
198    static status_t isStreamActive(int stream, bool *state);
199
200    // set/get audio hardware parameters. The function accepts a list of parameters
201    // key value pairs in the form: key1=value1;key2=value2;...
202    // Some keys are reserved for standard parameters (See AudioParameter class).
203    static status_t setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs);
204    static String8  getParameters(audio_io_handle_t ioHandle, const String8& keys);
205
206    static void setErrorCallback(audio_error_callback cb);
207
208    // helper function to obtain AudioFlinger service handle
209    static const sp<IAudioFlinger>& get_audio_flinger();
210
211    static float linearToLog(int volume);
212    static int logToLinear(float volume);
213
214    static status_t getOutputSamplingRate(int* samplingRate, int stream = DEFAULT);
215    static status_t getOutputFrameCount(int* frameCount, int stream = DEFAULT);
216    static status_t getOutputLatency(uint32_t* latency, int stream = DEFAULT);
217
218    static bool routedToA2dpOutput(int streamType);
219
220    static status_t getInputBufferSize(uint32_t sampleRate, int format, int channelCount,
221        size_t* buffSize);
222
223    static status_t setVoiceVolume(float volume);
224
225    // return the number of audio frames written by AudioFlinger to audio HAL and
226    // audio dsp to DAC since the output on which the specificed stream is playing
227    // has exited standby.
228    // returned status (from utils/Errors.h) can be:
229    // - NO_ERROR: successful operation, halFrames and dspFrames point to valid data
230    // - INVALID_OPERATION: Not supported on current hardware platform
231    // - BAD_VALUE: invalid parameter
232    // NOTE: this feature is not supported on all hardware platforms and it is
233    // necessary to check returned status before using the returned values.
234    static status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, int stream = DEFAULT);
235
236    static unsigned int  getInputFramesLost(audio_io_handle_t ioHandle);
237    //
238    // AudioPolicyService interface
239    //
240
241    enum audio_devices {
242        // output devices
243        DEVICE_OUT_EARPIECE = 0x1,
244        DEVICE_OUT_SPEAKER = 0x2,
245        DEVICE_OUT_WIRED_HEADSET = 0x4,
246        DEVICE_OUT_WIRED_HEADPHONE = 0x8,
247        DEVICE_OUT_BLUETOOTH_SCO = 0x10,
248        DEVICE_OUT_BLUETOOTH_SCO_HEADSET = 0x20,
249        DEVICE_OUT_BLUETOOTH_SCO_CARKIT = 0x40,
250        DEVICE_OUT_BLUETOOTH_A2DP = 0x80,
251        DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = 0x100,
252        DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = 0x200,
253        DEVICE_OUT_AUX_DIGITAL = 0x400,
254        DEVICE_OUT_DEFAULT = 0x8000,
255        DEVICE_OUT_ALL = (DEVICE_OUT_EARPIECE | DEVICE_OUT_SPEAKER | DEVICE_OUT_WIRED_HEADSET |
256                DEVICE_OUT_WIRED_HEADPHONE | DEVICE_OUT_BLUETOOTH_SCO | DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
257                DEVICE_OUT_BLUETOOTH_SCO_CARKIT | DEVICE_OUT_BLUETOOTH_A2DP | DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
258                DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER | DEVICE_OUT_AUX_DIGITAL | DEVICE_OUT_DEFAULT),
259        DEVICE_OUT_ALL_A2DP = (DEVICE_OUT_BLUETOOTH_A2DP | DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
260                DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER),
261
262        // input devices
263        DEVICE_IN_COMMUNICATION = 0x10000,
264        DEVICE_IN_AMBIENT = 0x20000,
265        DEVICE_IN_BUILTIN_MIC = 0x40000,
266        DEVICE_IN_BLUETOOTH_SCO_HEADSET = 0x80000,
267        DEVICE_IN_WIRED_HEADSET = 0x100000,
268        DEVICE_IN_AUX_DIGITAL = 0x200000,
269        DEVICE_IN_VOICE_CALL = 0x400000,
270        DEVICE_IN_BACK_MIC = 0x800000,
271        DEVICE_IN_DEFAULT = 0x80000000,
272
273        DEVICE_IN_ALL = (DEVICE_IN_COMMUNICATION | DEVICE_IN_AMBIENT | DEVICE_IN_BUILTIN_MIC |
274                DEVICE_IN_BLUETOOTH_SCO_HEADSET | DEVICE_IN_WIRED_HEADSET | DEVICE_IN_AUX_DIGITAL |
275                DEVICE_IN_VOICE_CALL | DEVICE_IN_BACK_MIC | DEVICE_IN_DEFAULT)
276    };
277
278    // device connection states used for setDeviceConnectionState()
279    enum device_connection_state {
280        DEVICE_STATE_UNAVAILABLE,
281        DEVICE_STATE_AVAILABLE,
282        NUM_DEVICE_STATES
283    };
284
285    // request to open a direct output with getOutput() (by opposition to sharing an output with other AudioTracks)
286    enum output_flags {
287        OUTPUT_FLAG_INDIRECT = 0x0,
288        OUTPUT_FLAG_DIRECT = 0x1
289    };
290
291    // device categories used for setForceUse()
292    enum forced_config {
293        FORCE_NONE,
294        FORCE_SPEAKER,
295        FORCE_HEADPHONES,
296        FORCE_BT_SCO,
297        FORCE_BT_A2DP,
298        FORCE_WIRED_ACCESSORY,
299        FORCE_BT_CAR_DOCK,
300        FORCE_BT_DESK_DOCK,
301        NUM_FORCE_CONFIG,
302        FORCE_DEFAULT = FORCE_NONE
303    };
304
305    // usages used for setForceUse()
306    enum force_use {
307        FOR_COMMUNICATION,
308        FOR_MEDIA,
309        FOR_RECORD,
310        FOR_DOCK,
311        NUM_FORCE_USE
312    };
313
314    // types of io configuration change events received with ioConfigChanged()
315    enum io_config_event {
316        OUTPUT_OPENED,
317        OUTPUT_CLOSED,
318        OUTPUT_CONFIG_CHANGED,
319        INPUT_OPENED,
320        INPUT_CLOSED,
321        INPUT_CONFIG_CHANGED,
322        STREAM_CONFIG_CHANGED,
323        NUM_CONFIG_EVENTS
324    };
325
326    // audio output descritor used to cache output configurations in client process to avoid frequent calls
327    // through IAudioFlinger
328    class OutputDescriptor {
329    public:
330        OutputDescriptor()
331        : samplingRate(0), format(0), channels(0), frameCount(0), latency(0)  {}
332
333        uint32_t samplingRate;
334        int32_t format;
335        int32_t channels;
336        size_t frameCount;
337        uint32_t latency;
338    };
339
340    //
341    // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions)
342    //
343    static status_t setDeviceConnectionState(audio_devices device, device_connection_state state, const char *device_address);
344    static device_connection_state getDeviceConnectionState(audio_devices device, const char *device_address);
345    static status_t setPhoneState(int state);
346    static status_t setRingerMode(uint32_t mode, uint32_t mask);
347    static status_t setForceUse(force_use usage, forced_config config);
348    static forced_config getForceUse(force_use usage);
349    static audio_io_handle_t getOutput(stream_type stream,
350                                        uint32_t samplingRate = 0,
351                                        uint32_t format = FORMAT_DEFAULT,
352                                        uint32_t channels = CHANNEL_OUT_STEREO,
353                                        output_flags flags = OUTPUT_FLAG_INDIRECT);
354    static status_t startOutput(audio_io_handle_t output, AudioSystem::stream_type stream);
355    static status_t stopOutput(audio_io_handle_t output, AudioSystem::stream_type stream);
356    static void releaseOutput(audio_io_handle_t output);
357    static audio_io_handle_t getInput(int inputSource,
358                                    uint32_t samplingRate = 0,
359                                    uint32_t format = FORMAT_DEFAULT,
360                                    uint32_t channels = CHANNEL_IN_MONO,
361                                    audio_in_acoustics acoustics = (audio_in_acoustics)0);
362    static status_t startInput(audio_io_handle_t input);
363    static status_t stopInput(audio_io_handle_t input);
364    static void releaseInput(audio_io_handle_t input);
365    static status_t initStreamVolume(stream_type stream,
366                                      int indexMin,
367                                      int indexMax);
368    static status_t setStreamVolumeIndex(stream_type stream, int index);
369    static status_t getStreamVolumeIndex(stream_type stream, int *index);
370
371    static const sp<IAudioPolicyService>& get_audio_policy_service();
372
373    // ----------------------------------------------------------------------------
374
375    static uint32_t popCount(uint32_t u);
376    static bool isOutputDevice(audio_devices device);
377    static bool isInputDevice(audio_devices device);
378    static bool isA2dpDevice(audio_devices device);
379    static bool isBluetoothScoDevice(audio_devices device);
380    static bool isLowVisibility(stream_type stream);
381    static bool isOutputChannel(uint32_t channel);
382    static bool isInputChannel(uint32_t channel);
383    static bool isValidFormat(uint32_t format);
384    static bool isLinearPCM(uint32_t format);
385
386private:
387
388    class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient
389    {
390    public:
391        AudioFlingerClient() {
392        }
393
394        // DeathRecipient
395        virtual void binderDied(const wp<IBinder>& who);
396
397        // IAudioFlingerClient
398
399        // indicate a change in the configuration of an output or input: keeps the cached
400        // values for output/input parameters upto date in client process
401        virtual void ioConfigChanged(int event, int ioHandle, void *param2);
402    };
403
404    class AudioPolicyServiceClient: public IBinder::DeathRecipient
405    {
406    public:
407        AudioPolicyServiceClient() {
408        }
409
410        // DeathRecipient
411        virtual void binderDied(const wp<IBinder>& who);
412    };
413
414    static sp<AudioFlingerClient> gAudioFlingerClient;
415    static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient;
416    friend class AudioFlingerClient;
417    friend class AudioPolicyServiceClient;
418
419    static Mutex gLock;
420    static sp<IAudioFlinger> gAudioFlinger;
421    static audio_error_callback gAudioErrorCallback;
422
423    static size_t gInBuffSize;
424    // previous parameters for recording buffer size queries
425    static uint32_t gPrevInSamplingRate;
426    static int gPrevInFormat;
427    static int gPrevInChannelCount;
428
429    static sp<IAudioPolicyService> gAudioPolicyService;
430
431    // mapping between stream types and outputs
432    static DefaultKeyedVector<int, audio_io_handle_t> gStreamOutputMap;
433    // list of output descritor containing cached parameters (sampling rate, framecount, channel count...)
434    static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs;
435};
436
437class AudioParameter {
438
439public:
440    AudioParameter() {}
441    AudioParameter(const String8& keyValuePairs);
442    virtual ~AudioParameter();
443
444    // reserved parameter keys for changeing standard parameters with setParameters() function.
445    // Using these keys is mandatory for AudioFlinger to properly monitor audio output/input
446    // configuration changes and act accordingly.
447    //  keyRouting: to change audio routing, value is an int in AudioSystem::audio_devices
448    //  keySamplingRate: to change sampling rate routing, value is an int
449    //  keyFormat: to change audio format, value is an int in AudioSystem::audio_format
450    //  keyChannels: to change audio channel configuration, value is an int in AudioSystem::audio_channels
451    //  keyFrameCount: to change audio output frame count, value is an int
452    static const char *keyRouting;
453    static const char *keySamplingRate;
454    static const char *keyFormat;
455    static const char *keyChannels;
456    static const char *keyFrameCount;
457
458    String8 toString();
459
460    status_t add(const String8& key, const String8& value);
461    status_t addInt(const String8& key, const int value);
462    status_t addFloat(const String8& key, const float value);
463
464    status_t remove(const String8& key);
465
466    status_t get(const String8& key, String8& value);
467    status_t getInt(const String8& key, int& value);
468    status_t getFloat(const String8& key, float& value);
469    status_t getAt(size_t index, String8& key, String8& value);
470
471    size_t size() { return mParameters.size(); }
472
473private:
474    String8 mKeyValuePairs;
475    KeyedVector <String8, String8> mParameters;
476};
477
478};  // namespace android
479
480#endif  /*ANDROID_AUDIOSYSTEM_H_*/
481