AudioSystem.h revision 203b1a18a806e2c56c701aac49cda963bccfad5b 
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 <hardware/audio_effect.h>
21#include <media/IAudioFlingerClient.h>
22#include <system/audio.h>
23#include <system/audio_policy.h>
24#include <utils/Errors.h>
25#include <utils/Mutex.h>
26
27namespace android {
28
29typedef void (*audio_error_callback)(status_t err);
30
31class IAudioFlinger;
32class IAudioPolicyService;
33class String8;
34
35class AudioSystem
36{
37public:
38
39    /* These are static methods to control the system-wide AudioFlinger
40     * only privileged processes can have access to them
41     */
42
43    // mute/unmute microphone
44    static status_t muteMicrophone(bool state);
45    static status_t isMicrophoneMuted(bool *state);
46
47    // set/get master volume
48    static status_t setMasterVolume(float value);
49    static status_t getMasterVolume(float* volume);
50
51    // mute/unmute audio outputs
52    static status_t setMasterMute(bool mute);
53    static status_t getMasterMute(bool* mute);
54
55    // set/get stream volume on specified output
56    static status_t setStreamVolume(audio_stream_type_t stream, float value,
57                                    audio_io_handle_t output);
58    static status_t getStreamVolume(audio_stream_type_t stream, float* volume,
59                                    audio_io_handle_t output);
60
61    // mute/unmute stream
62    static status_t setStreamMute(audio_stream_type_t stream, bool mute);
63    static status_t getStreamMute(audio_stream_type_t stream, bool* mute);
64
65    // set audio mode in audio hardware
66    static status_t setMode(audio_mode_t mode);
67
68    // returns true in *state if tracks are active on the specified stream or have been active
69    // in the past inPastMs milliseconds
70    static status_t isStreamActive(audio_stream_type_t stream, bool *state, uint32_t inPastMs);
71    // returns true in *state if tracks are active for what qualifies as remote playback
72    // on the specified stream or have been active in the past inPastMs milliseconds. Remote
73    // playback isn't mutually exclusive with local playback.
74    static status_t isStreamActiveRemotely(audio_stream_type_t stream, bool *state,
75            uint32_t inPastMs);
76    // returns true in *state if a recorder is currently recording with the specified source
77    static status_t isSourceActive(audio_source_t source, bool *state);
78
79    // set/get audio hardware parameters. The function accepts a list of parameters
80    // key value pairs in the form: key1=value1;key2=value2;...
81    // Some keys are reserved for standard parameters (See AudioParameter class).
82    // The versions with audio_io_handle_t are intended for internal media framework use only.
83    static status_t setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs);
84    static String8  getParameters(audio_io_handle_t ioHandle, const String8& keys);
85    // The versions without audio_io_handle_t are intended for JNI.
86    static status_t setParameters(const String8& keyValuePairs);
87    static String8  getParameters(const String8& keys);
88
89    static void setErrorCallback(audio_error_callback cb);
90
91    // helper function to obtain AudioFlinger service handle
92    static const sp<IAudioFlinger>& get_audio_flinger();
93
94    static float linearToLog(int volume);
95    static int logToLinear(float volume);
96
97    // Returned samplingRate and frameCount output values are guaranteed
98    // to be non-zero if status == NO_ERROR
99    static status_t getOutputSamplingRate(uint32_t* samplingRate,
100            audio_stream_type_t stream);
101    static status_t getOutputFrameCount(size_t* frameCount,
102            audio_stream_type_t stream);
103    static status_t getOutputLatency(uint32_t* latency,
104            audio_stream_type_t stream);
105    static status_t getSamplingRate(audio_io_handle_t output,
106                                          audio_stream_type_t streamType,
107                                          uint32_t* samplingRate);
108    // returns the number of frames per audio HAL write buffer. Corresponds to
109    // audio_stream->get_buffer_size()/audio_stream_frame_size()
110    static status_t getFrameCount(audio_io_handle_t output,
111                                  audio_stream_type_t stream,
112                                  size_t* frameCount);
113    // returns the audio output stream latency in ms. Corresponds to
114    // audio_stream_out->get_latency()
115    static status_t getLatency(audio_io_handle_t output,
116                               uint32_t* latency);
117
118    static bool routedToA2dpOutput(audio_stream_type_t streamType);
119
120    // return status NO_ERROR implies *buffSize > 0
121    static status_t getInputBufferSize(uint32_t sampleRate, audio_format_t format,
122        audio_channel_mask_t channelMask, size_t* buffSize);
123
124    static status_t setVoiceVolume(float volume);
125
126    // return the number of audio frames written by AudioFlinger to audio HAL and
127    // audio dsp to DAC since the specified output I/O handle has exited standby.
128    // returned status (from utils/Errors.h) can be:
129    // - NO_ERROR: successful operation, halFrames and dspFrames point to valid data
130    // - INVALID_OPERATION: Not supported on current hardware platform
131    // - BAD_VALUE: invalid parameter
132    // NOTE: this feature is not supported on all hardware platforms and it is
133    // necessary to check returned status before using the returned values.
134    static status_t getRenderPosition(audio_io_handle_t output,
135                                      uint32_t *halFrames,
136                                      uint32_t *dspFrames);
137
138    // return the number of input frames lost by HAL implementation, or 0 if the handle is invalid
139    static uint32_t getInputFramesLost(audio_io_handle_t ioHandle);
140
141    // Allocate a new audio session ID and return that new ID.
142    // If unable to contact AudioFlinger, returns AUDIO_SESSION_ALLOCATE instead.
143    // FIXME If AudioFlinger were to ever exhaust the session ID namespace,
144    //       this method could fail by returning either AUDIO_SESSION_ALLOCATE
145    //       or an unspecified existing session ID.
146    static int newAudioSessionId();
147
148    static void acquireAudioSessionId(int audioSession, pid_t pid);
149    static void releaseAudioSessionId(int audioSession, pid_t pid);
150
151    // types of io configuration change events received with ioConfigChanged()
152    enum io_config_event {
153        OUTPUT_OPENED,
154        OUTPUT_CLOSED,
155        OUTPUT_CONFIG_CHANGED,
156        INPUT_OPENED,
157        INPUT_CLOSED,
158        INPUT_CONFIG_CHANGED,
159        STREAM_CONFIG_CHANGED,
160        NUM_CONFIG_EVENTS
161    };
162
163    // audio output descriptor used to cache output configurations in client process to avoid
164    // frequent calls through IAudioFlinger
165    class OutputDescriptor {
166    public:
167        OutputDescriptor()
168        : samplingRate(0), format(AUDIO_FORMAT_DEFAULT), channelMask(0), frameCount(0), latency(0)
169            {}
170
171        uint32_t samplingRate;
172        audio_format_t format;
173        audio_channel_mask_t channelMask;
174        size_t frameCount;
175        uint32_t latency;
176    };
177
178    // Events used to synchronize actions between audio sessions.
179    // For instance SYNC_EVENT_PRESENTATION_COMPLETE can be used to delay recording start until
180    // playback is complete on another audio session.
181    // See definitions in MediaSyncEvent.java
182    enum sync_event_t {
183        SYNC_EVENT_SAME = -1,             // used internally to indicate restart with same event
184        SYNC_EVENT_NONE = 0,
185        SYNC_EVENT_PRESENTATION_COMPLETE,
186
187        //
188        // Define new events here: SYNC_EVENT_START, SYNC_EVENT_STOP, SYNC_EVENT_TIME ...
189        //
190        SYNC_EVENT_CNT,
191    };
192
193    // Timeout for synchronous record start. Prevents from blocking the record thread forever
194    // if the trigger event is not fired.
195    static const uint32_t kSyncRecordStartTimeOutMs = 30000;
196
197    //
198    // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions)
199    //
200    static status_t setDeviceConnectionState(audio_devices_t device, audio_policy_dev_state_t state,
201                                                const char *device_address);
202    static audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
203                                                                const char *device_address);
204    static status_t setPhoneState(audio_mode_t state);
205    static status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config);
206    static audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
207
208    // Client must successfully hand off the handle reference to AudioFlinger via createTrack(),
209    // or release it with releaseOutput().
210    static audio_io_handle_t getOutput(audio_stream_type_t stream,
211                                        uint32_t samplingRate = 0,
212                                        audio_format_t format = AUDIO_FORMAT_DEFAULT,
213                                        audio_channel_mask_t channelMask = AUDIO_CHANNEL_OUT_STEREO,
214                                        audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
215                                        const audio_offload_info_t *offloadInfo = NULL);
216
217    static status_t startOutput(audio_io_handle_t output,
218                                audio_stream_type_t stream,
219                                int session);
220    static status_t stopOutput(audio_io_handle_t output,
221                               audio_stream_type_t stream,
222                               int session);
223    static void releaseOutput(audio_io_handle_t output);
224
225    // Client must successfully hand off the handle reference to AudioFlinger via openRecord(),
226    // or release it with releaseInput().
227    static audio_io_handle_t getInput(audio_source_t inputSource,
228                                    uint32_t samplingRate,
229                                    audio_format_t format,
230                                    audio_channel_mask_t channelMask,
231                                    int sessionId);
232
233    static status_t startInput(audio_io_handle_t input);
234    static status_t stopInput(audio_io_handle_t input);
235    static void releaseInput(audio_io_handle_t input);
236    static status_t initStreamVolume(audio_stream_type_t stream,
237                                      int indexMin,
238                                      int indexMax);
239    static status_t setStreamVolumeIndex(audio_stream_type_t stream,
240                                         int index,
241                                         audio_devices_t device);
242    static status_t getStreamVolumeIndex(audio_stream_type_t stream,
243                                         int *index,
244                                         audio_devices_t device);
245
246    static uint32_t getStrategyForStream(audio_stream_type_t stream);
247    static audio_devices_t getDevicesForStream(audio_stream_type_t stream);
248
249    static audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc);
250    static status_t registerEffect(const effect_descriptor_t *desc,
251                                    audio_io_handle_t io,
252                                    uint32_t strategy,
253                                    int session,
254                                    int id);
255    static status_t unregisterEffect(int id);
256    static status_t setEffectEnabled(int id, bool enabled);
257
258    // clear stream to output mapping cache (gStreamOutputMap)
259    // and output configuration cache (gOutputs)
260    static void clearAudioConfigCache();
261
262    static const sp<IAudioPolicyService>& get_audio_policy_service();
263
264    // helpers for android.media.AudioManager.getProperty(), see description there for meaning
265    static uint32_t getPrimaryOutputSamplingRate();
266    static size_t getPrimaryOutputFrameCount();
267
268    static status_t setLowRamDevice(bool isLowRamDevice);
269
270    // Check if hw offload is possible for given format, stream type, sample rate,
271    // bit rate, duration, video and streaming or offload property is enabled
272    static bool isOffloadSupported(const audio_offload_info_t& info);
273
274    // check presence of audio flinger service.
275    // returns NO_ERROR if binding to service succeeds, DEAD_OBJECT otherwise
276    static status_t checkAudioFlinger();
277
278    /* List available audio ports and their attributes */
279    static status_t listAudioPorts(audio_port_role_t role,
280                                   audio_port_type_t type,
281                                   unsigned int *num_ports,
282                                   struct audio_port *ports,
283                                   unsigned int *generation);
284
285    /* Get attributes for a given audio port */
286    static status_t getAudioPort(struct audio_port *port);
287
288    /* Create an audio patch between several source and sink ports */
289    static status_t createAudioPatch(const struct audio_patch *patch,
290                                       audio_patch_handle_t *handle);
291
292    /* Release an audio patch */
293    static status_t releaseAudioPatch(audio_patch_handle_t handle);
294
295    /* List existing audio patches */
296    static status_t listAudioPatches(unsigned int *num_patches,
297                                      struct audio_patch *patches,
298                                      unsigned int *generation);
299    /* Set audio port configuration */
300    static status_t setAudioPortConfig(const struct audio_port_config *config);
301
302    // ----------------------------------------------------------------------------
303
304private:
305
306    class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient
307    {
308    public:
309        AudioFlingerClient() {
310        }
311
312        // DeathRecipient
313        virtual void binderDied(const wp<IBinder>& who);
314
315        // IAudioFlingerClient
316
317        // indicate a change in the configuration of an output or input: keeps the cached
318        // values for output/input parameters up-to-date in client process
319        virtual void ioConfigChanged(int event, audio_io_handle_t ioHandle, const void *param2);
320    };
321
322    class AudioPolicyServiceClient: public IBinder::DeathRecipient
323    {
324    public:
325        AudioPolicyServiceClient() {
326        }
327
328        // DeathRecipient
329        virtual void binderDied(const wp<IBinder>& who);
330    };
331
332    static sp<AudioFlingerClient> gAudioFlingerClient;
333    static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient;
334    friend class AudioFlingerClient;
335    friend class AudioPolicyServiceClient;
336
337    static Mutex gLock;
338    static sp<IAudioFlinger> gAudioFlinger;
339    static audio_error_callback gAudioErrorCallback;
340
341    static size_t gInBuffSize;
342    // previous parameters for recording buffer size queries
343    static uint32_t gPrevInSamplingRate;
344    static audio_format_t gPrevInFormat;
345    static audio_channel_mask_t gPrevInChannelMask;
346
347    static sp<IAudioPolicyService> gAudioPolicyService;
348
349    // list of output descriptors containing cached parameters
350    // (sampling rate, framecount, channel count...)
351    static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs;
352};
353
354};  // namespace android
355
356#endif  /*ANDROID_AUDIOSYSTEM_H_*/
357