AudioPolicyInterface.h revision fb66dd9f95a1168698f072c4e5c2a2cf8c49a80f 
1/*
2 * Copyright (C) 2009 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_AUDIOPOLICY_INTERFACE_H
18#define ANDROID_AUDIOPOLICY_INTERFACE_H
19
20#include <media/AudioSystem.h>
21#include <media/AudioPolicy.h>
22#include <utils/String8.h>
23
24#include <hardware/audio_policy.h>
25
26namespace android {
27
28// ----------------------------------------------------------------------------
29
30// The AudioPolicyInterface and AudioPolicyClientInterface classes define the communication interfaces
31// between the platform specific audio policy manager and Android generic audio policy manager.
32// The platform specific audio policy manager must implement methods of the AudioPolicyInterface class.
33// This implementation makes use of the AudioPolicyClientInterface to control the activity and
34// configuration of audio input and output streams.
35//
36// The platform specific audio policy manager is in charge of the audio routing and volume control
37// policies for a given platform.
38// The main roles of this module are:
39//   - keep track of current system state (removable device connections, phone state, user requests...).
40//   System state changes and user actions are notified to audio policy manager with methods of the AudioPolicyInterface.
41//   - process getOutput() queries received when AudioTrack objects are created: Those queries
42//   return a handler on an output that has been selected, configured and opened by the audio policy manager and that
43//   must be used by the AudioTrack when registering to the AudioFlinger with the createTrack() method.
44//   When the AudioTrack object is released, a putOutput() query is received and the audio policy manager can decide
45//   to close or reconfigure the output depending on other streams using this output and current system state.
46//   - similarly process getInput() and putInput() queries received from AudioRecord objects and configure audio inputs.
47//   - process volume control requests: the stream volume is converted from an index value (received from UI) to a float value
48//   applicable to each output as a function of platform specific settings and current output route (destination device). It
49//   also make sure that streams are not muted if not allowed (e.g. camera shutter sound in some countries).
50//
51// The platform specific audio policy manager is provided as a shared library by platform vendors (as for libaudio.so)
52// and is linked with libaudioflinger.so
53
54
55//    Audio Policy Manager Interface
56class AudioPolicyInterface
57{
58
59public:
60    typedef enum {
61        API_INPUT_INVALID = -1,
62        API_INPUT_LEGACY  = 0,// e.g. audio recording from a microphone
63        API_INPUT_MIX_CAPTURE,// used for "remote submix", capture of the media to play it remotely
64        API_INPUT_MIX_EXT_POLICY_REROUTE,// used for platform audio rerouting, where mixes are
65                                         // handled by external and dynamically installed
66                                         // policies which reroute audio mixes
67        API_INPUT_TELEPHONY_RX, // used for capture from telephony RX path
68    } input_type_t;
69
70   enum {
71        API_INPUT_CONCURRENCY_NONE = 0,
72        API_INPUT_CONCURRENCY_CALL = (1 << 0),      // Concurrency with a call
73        API_INPUT_CONCURRENCY_CAPTURE = (1 << 1),   // Concurrency with another capture
74   };
75
76   typedef uint32_t concurrency_type__mask_t;
77
78public:
79    virtual ~AudioPolicyInterface() {}
80    //
81    // configuration functions
82    //
83
84    // indicate a change in device connection status
85    virtual status_t setDeviceConnectionState(audio_devices_t device,
86                                              audio_policy_dev_state_t state,
87                                              const char *device_address,
88                                              const char *device_name) = 0;
89    // retrieve a device connection status
90    virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
91                                                                          const char *device_address) = 0;
92    // indicate a change in phone state. Valid phones states are defined by audio_mode_t
93    virtual void setPhoneState(audio_mode_t state) = 0;
94    // force using a specific device category for the specified usage
95    virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0;
96    // retrieve current device category forced for a given usage
97    virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0;
98    // set a system property (e.g. camera sound always audible)
99    virtual void setSystemProperty(const char* property, const char* value) = 0;
100    // check proper initialization
101    virtual status_t initCheck() = 0;
102
103    //
104    // Audio routing query functions
105    //
106
107    // request an output appropriate for playback of the supplied stream type and parameters
108    virtual audio_io_handle_t getOutput(audio_stream_type_t stream,
109                                        uint32_t samplingRate,
110                                        audio_format_t format,
111                                        audio_channel_mask_t channelMask,
112                                        audio_output_flags_t flags,
113                                        const audio_offload_info_t *offloadInfo) = 0;
114    virtual status_t getOutputForAttr(const audio_attributes_t *attr,
115                                        audio_io_handle_t *output,
116                                        audio_session_t session,
117                                        audio_stream_type_t *stream,
118                                        uid_t uid,
119                                        uint32_t samplingRate,
120                                        audio_format_t format,
121                                        audio_channel_mask_t channelMask,
122                                        audio_output_flags_t flags,
123                                        int selectedDeviceId,
124                                        const audio_offload_info_t *offloadInfo) = 0;
125    // indicates to the audio policy manager that the output starts being used by corresponding stream.
126    virtual status_t startOutput(audio_io_handle_t output,
127                                 audio_stream_type_t stream,
128                                 audio_session_t session) = 0;
129    // indicates to the audio policy manager that the output stops being used by corresponding stream.
130    virtual status_t stopOutput(audio_io_handle_t output,
131                                audio_stream_type_t stream,
132                                audio_session_t session) = 0;
133    // releases the output.
134    virtual void releaseOutput(audio_io_handle_t output,
135                               audio_stream_type_t stream,
136                               audio_session_t session) = 0;
137
138    // request an input appropriate for record from the supplied device with supplied parameters.
139    virtual status_t getInputForAttr(const audio_attributes_t *attr,
140                                     audio_io_handle_t *input,
141                                     audio_session_t session,
142                                     uid_t uid,
143                                     uint32_t samplingRate,
144                                     audio_format_t format,
145                                     audio_channel_mask_t channelMask,
146                                     audio_input_flags_t flags,
147                                     audio_port_handle_t selectedDeviceId,
148                                     input_type_t *inputType) = 0;
149    // indicates to the audio policy manager that the input starts being used.
150    virtual status_t startInput(audio_io_handle_t input,
151                                audio_session_t session,
152                                concurrency_type__mask_t *concurrency) = 0;
153    // indicates to the audio policy manager that the input stops being used.
154    virtual status_t stopInput(audio_io_handle_t input,
155                               audio_session_t session) = 0;
156    // releases the input.
157    virtual void releaseInput(audio_io_handle_t input,
158                              audio_session_t session) = 0;
159
160    //
161    // volume control functions
162    //
163
164    // initialises stream volume conversion parameters by specifying volume index range.
165    virtual void initStreamVolume(audio_stream_type_t stream,
166                                      int indexMin,
167                                      int indexMax) = 0;
168
169    // sets the new stream volume at a level corresponding to the supplied index for the
170    // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT means
171    // setting volume for all devices
172    virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
173                                          int index,
174                                          audio_devices_t device) = 0;
175
176    // retrieve current volume index for the specified stream and the
177    // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT means
178    // querying the volume of the active device.
179    virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
180                                          int *index,
181                                          audio_devices_t device) = 0;
182
183    // return the strategy corresponding to a given stream type
184    virtual uint32_t getStrategyForStream(audio_stream_type_t stream) = 0;
185
186    // return the enabled output devices for the given stream type
187    virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream) = 0;
188
189    // Audio effect management
190    virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
191    virtual status_t registerEffect(const effect_descriptor_t *desc,
192                                    audio_io_handle_t io,
193                                    uint32_t strategy,
194                                    int session,
195                                    int id) = 0;
196    virtual status_t unregisterEffect(int id) = 0;
197    virtual status_t setEffectEnabled(int id, bool enabled) = 0;
198
199    virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
200    virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
201                                        uint32_t inPastMs = 0) const = 0;
202    virtual bool isSourceActive(audio_source_t source) const = 0;
203
204    //dump state
205    virtual status_t    dump(int fd) = 0;
206
207    virtual bool isOffloadSupported(const audio_offload_info_t& offloadInfo) = 0;
208
209    virtual status_t listAudioPorts(audio_port_role_t role,
210                                    audio_port_type_t type,
211                                    unsigned int *num_ports,
212                                    struct audio_port *ports,
213                                    unsigned int *generation) = 0;
214    virtual status_t getAudioPort(struct audio_port *port) = 0;
215    virtual status_t createAudioPatch(const struct audio_patch *patch,
216                                       audio_patch_handle_t *handle,
217                                       uid_t uid) = 0;
218    virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
219                                          uid_t uid) = 0;
220    virtual status_t listAudioPatches(unsigned int *num_patches,
221                                      struct audio_patch *patches,
222                                      unsigned int *generation) = 0;
223    virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
224    virtual void releaseResourcesForUid(uid_t uid) = 0;
225
226    virtual status_t acquireSoundTriggerSession(audio_session_t *session,
227                                           audio_io_handle_t *ioHandle,
228                                           audio_devices_t *device) = 0;
229
230    virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
231
232    virtual status_t registerPolicyMixes(Vector<AudioMix> mixes) = 0;
233    virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
234
235    virtual status_t startAudioSource(const struct audio_port_config *source,
236                                      const audio_attributes_t *attributes,
237                                      audio_io_handle_t *handle,
238                                      uid_t uid) = 0;
239    virtual status_t stopAudioSource(audio_io_handle_t handle) = 0;
240
241    virtual status_t setMasterMono(bool mono) = 0;
242    virtual status_t getMasterMono(bool *mono) = 0;
243};
244
245
246// Audio Policy client Interface
247class AudioPolicyClientInterface
248{
249public:
250    virtual ~AudioPolicyClientInterface() {}
251
252    //
253    // Audio HW module functions
254    //
255
256    // loads a HW module.
257    virtual audio_module_handle_t loadHwModule(const char *name) = 0;
258
259    //
260    // Audio output Control functions
261    //
262
263    // opens an audio output with the requested parameters. The parameter values can indicate to use the default values
264    // in case the audio policy manager has no specific requirements for the output being opened.
265    // When the function returns, the parameter values reflect the actual values used by the audio hardware output stream.
266    // The audio policy manager can check if the proposed parameters are suitable or not and act accordingly.
267    virtual status_t openOutput(audio_module_handle_t module,
268                                audio_io_handle_t *output,
269                                audio_config_t *config,
270                                audio_devices_t *devices,
271                                const String8& address,
272                                uint32_t *latencyMs,
273                                audio_output_flags_t flags) = 0;
274    // creates a special output that is duplicated to the two outputs passed as arguments. The duplication is performed by
275    // a special mixer thread in the AudioFlinger.
276    virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, audio_io_handle_t output2) = 0;
277    // closes the output stream
278    virtual status_t closeOutput(audio_io_handle_t output) = 0;
279    // suspends the output. When an output is suspended, the corresponding audio hardware output stream is placed in
280    // standby and the AudioTracks attached to the mixer thread are still processed but the output mix is discarded.
281    virtual status_t suspendOutput(audio_io_handle_t output) = 0;
282    // restores a suspended output.
283    virtual status_t restoreOutput(audio_io_handle_t output) = 0;
284
285    //
286    // Audio input Control functions
287    //
288
289    // opens an audio input
290    virtual status_t openInput(audio_module_handle_t module,
291                               audio_io_handle_t *input,
292                               audio_config_t *config,
293                               audio_devices_t *device,
294                               const String8& address,
295                               audio_source_t source,
296                               audio_input_flags_t flags) = 0;
297    // closes an audio input
298    virtual status_t closeInput(audio_io_handle_t input) = 0;
299    //
300    // misc control functions
301    //
302
303    // set a stream volume for a particular output. For the same user setting, a given stream type can have different volumes
304    // for each output (destination device) it is attached to.
305    virtual status_t setStreamVolume(audio_stream_type_t stream, float volume, audio_io_handle_t output, int delayMs = 0) = 0;
306
307    // invalidate a stream type, causing a reroute to an unspecified new output
308    virtual status_t invalidateStream(audio_stream_type_t stream) = 0;
309
310    // function enabling to send proprietary informations directly from audio policy manager to audio hardware interface.
311    virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs, int delayMs = 0) = 0;
312    // function enabling to receive proprietary informations directly from audio hardware interface to audio policy manager.
313    virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
314
315    // request the playback of a tone on the specified stream: used for instance to replace notification sounds when playing
316    // over a telephony device during a phone call.
317    virtual status_t startTone(audio_policy_tone_t tone, audio_stream_type_t stream) = 0;
318    virtual status_t stopTone() = 0;
319
320    // set down link audio volume.
321    virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
322
323    // move effect to the specified output
324    virtual status_t moveEffects(int session,
325                                     audio_io_handle_t srcOutput,
326                                     audio_io_handle_t dstOutput) = 0;
327
328    /* Create a patch between several source and sink ports */
329    virtual status_t createAudioPatch(const struct audio_patch *patch,
330                                       audio_patch_handle_t *handle,
331                                       int delayMs) = 0;
332
333    /* Release a patch */
334    virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
335                                       int delayMs) = 0;
336
337    /* Set audio port configuration */
338    virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
339
340    virtual void onAudioPortListUpdate() = 0;
341
342    virtual void onAudioPatchListUpdate() = 0;
343
344    virtual audio_unique_id_t newAudioUniqueId() = 0;
345
346    virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
347
348    virtual void onRecordingConfigurationUpdate(int event, audio_session_t session,
349                    audio_source_t source) = 0;
350};
351
352extern "C" AudioPolicyInterface* createAudioPolicyManager(AudioPolicyClientInterface *clientInterface);
353extern "C" void destroyAudioPolicyManager(AudioPolicyInterface *interface);
354
355
356}; // namespace android
357
358#endif // ANDROID_AUDIOPOLICY_INTERFACE_H
359