AudioPolicyInterface.h revision 554a277d4e42a3d3df3d90ba0e7dfa2d31690e32 
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    } input_type_t;
68
69public:
70    virtual ~AudioPolicyInterface() {}
71    //
72    // configuration functions
73    //
74
75    // indicate a change in device connection status
76    virtual status_t setDeviceConnectionState(audio_devices_t device,
77                                              audio_policy_dev_state_t state,
78                                              const char *device_address,
79                                              const char *device_name) = 0;
80    // retrieve a device connection status
81    virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
82                                                                          const char *device_address) = 0;
83    // indicate a change in phone state. Valid phones states are defined by audio_mode_t
84    virtual void setPhoneState(audio_mode_t state) = 0;
85    // force using a specific device category for the specified usage
86    virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0;
87    // retrieve current device category forced for a given usage
88    virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0;
89    // set a system property (e.g. camera sound always audible)
90    virtual void setSystemProperty(const char* property, const char* value) = 0;
91    // check proper initialization
92    virtual status_t initCheck() = 0;
93
94    //
95    // Audio routing query functions
96    //
97
98    // request an output appropriate for playback of the supplied stream type and parameters
99    virtual audio_io_handle_t getOutput(audio_stream_type_t stream,
100                                        uint32_t samplingRate,
101                                        audio_format_t format,
102                                        audio_channel_mask_t channelMask,
103                                        audio_output_flags_t flags,
104                                        const audio_offload_info_t *offloadInfo) = 0;
105    virtual status_t getOutputForAttr(const audio_attributes_t *attr,
106                                        audio_io_handle_t *output,
107                                        audio_session_t session,
108                                        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                                        int selectedDeviceId,
114                                        const audio_offload_info_t *offloadInfo) = 0;
115    // indicates to the audio policy manager that the output starts being used by corresponding stream.
116    virtual status_t startOutput(audio_io_handle_t output,
117                                 audio_stream_type_t stream,
118                                 audio_session_t session) = 0;
119    // indicates to the audio policy manager that the output stops being used by corresponding stream.
120    virtual status_t stopOutput(audio_io_handle_t output,
121                                audio_stream_type_t stream,
122                                audio_session_t session) = 0;
123    // releases the output.
124    virtual void releaseOutput(audio_io_handle_t output,
125                               audio_stream_type_t stream,
126                               audio_session_t session) = 0;
127
128    // request an input appropriate for record from the supplied device with supplied parameters.
129    virtual status_t getInputForAttr(const audio_attributes_t *attr,
130                                     audio_io_handle_t *input,
131                                     audio_session_t session,
132                                     uint32_t samplingRate,
133                                     audio_format_t format,
134                                     audio_channel_mask_t channelMask,
135                                     audio_input_flags_t flags,
136                                     input_type_t *inputType) = 0;
137    // indicates to the audio policy manager that the input starts being used.
138    virtual status_t startInput(audio_io_handle_t input,
139                                audio_session_t session) = 0;
140    // indicates to the audio policy manager that the input stops being used.
141    virtual status_t stopInput(audio_io_handle_t input,
142                               audio_session_t session) = 0;
143    // releases the input.
144    virtual void releaseInput(audio_io_handle_t input,
145                              audio_session_t session) = 0;
146
147    //
148    // volume control functions
149    //
150
151    // initialises stream volume conversion parameters by specifying volume index range.
152    virtual void initStreamVolume(audio_stream_type_t stream,
153                                      int indexMin,
154                                      int indexMax) = 0;
155
156    // sets the new stream volume at a level corresponding to the supplied index for the
157    // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT means
158    // setting volume for all devices
159    virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
160                                          int index,
161                                          audio_devices_t device) = 0;
162
163    // retrieve current volume index for the specified stream and the
164    // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT means
165    // querying the volume of the active device.
166    virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
167                                          int *index,
168                                          audio_devices_t device) = 0;
169
170    // return the strategy corresponding to a given stream type
171    virtual uint32_t getStrategyForStream(audio_stream_type_t stream) = 0;
172
173    // return the enabled output devices for the given stream type
174    virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream) = 0;
175
176    // Audio effect management
177    virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
178    virtual status_t registerEffect(const effect_descriptor_t *desc,
179                                    audio_io_handle_t io,
180                                    uint32_t strategy,
181                                    int session,
182                                    int id) = 0;
183    virtual status_t unregisterEffect(int id) = 0;
184    virtual status_t setEffectEnabled(int id, bool enabled) = 0;
185
186    virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
187    virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
188                                        uint32_t inPastMs = 0) const = 0;
189    virtual bool isSourceActive(audio_source_t source) const = 0;
190
191    //dump state
192    virtual status_t    dump(int fd) = 0;
193
194    virtual bool isOffloadSupported(const audio_offload_info_t& offloadInfo) = 0;
195
196    virtual status_t listAudioPorts(audio_port_role_t role,
197                                    audio_port_type_t type,
198                                    unsigned int *num_ports,
199                                    struct audio_port *ports,
200                                    unsigned int *generation) = 0;
201    virtual status_t getAudioPort(struct audio_port *port) = 0;
202    virtual status_t createAudioPatch(const struct audio_patch *patch,
203                                       audio_patch_handle_t *handle,
204                                       uid_t uid) = 0;
205    virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
206                                          uid_t uid) = 0;
207    virtual status_t listAudioPatches(unsigned int *num_patches,
208                                      struct audio_patch *patches,
209                                      unsigned int *generation) = 0;
210    virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
211    virtual void clearAudioPatches(uid_t uid) = 0;
212
213    virtual status_t acquireSoundTriggerSession(audio_session_t *session,
214                                           audio_io_handle_t *ioHandle,
215                                           audio_devices_t *device) = 0;
216
217    virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
218
219    virtual status_t registerPolicyMixes(Vector<AudioMix> mixes) = 0;
220    virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
221
222    virtual status_t startAudioSource(const struct audio_port_config *source,
223                                      const audio_attributes_t *attributes,
224                                      audio_io_handle_t *handle) = 0;
225    virtual status_t stopAudioSource(audio_io_handle_t handle) = 0;
226};
227
228
229// Audio Policy client Interface
230class AudioPolicyClientInterface
231{
232public:
233    virtual ~AudioPolicyClientInterface() {}
234
235    //
236    // Audio HW module functions
237    //
238
239    // loads a HW module.
240    virtual audio_module_handle_t loadHwModule(const char *name) = 0;
241
242    //
243    // Audio output Control functions
244    //
245
246    // opens an audio output with the requested parameters. The parameter values can indicate to use the default values
247    // in case the audio policy manager has no specific requirements for the output being opened.
248    // When the function returns, the parameter values reflect the actual values used by the audio hardware output stream.
249    // The audio policy manager can check if the proposed parameters are suitable or not and act accordingly.
250    virtual status_t openOutput(audio_module_handle_t module,
251                                audio_io_handle_t *output,
252                                audio_config_t *config,
253                                audio_devices_t *devices,
254                                const String8& address,
255                                uint32_t *latencyMs,
256                                audio_output_flags_t flags) = 0;
257    // creates a special output that is duplicated to the two outputs passed as arguments. The duplication is performed by
258    // a special mixer thread in the AudioFlinger.
259    virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, audio_io_handle_t output2) = 0;
260    // closes the output stream
261    virtual status_t closeOutput(audio_io_handle_t output) = 0;
262    // suspends the output. When an output is suspended, the corresponding audio hardware output stream is placed in
263    // standby and the AudioTracks attached to the mixer thread are still processed but the output mix is discarded.
264    virtual status_t suspendOutput(audio_io_handle_t output) = 0;
265    // restores a suspended output.
266    virtual status_t restoreOutput(audio_io_handle_t output) = 0;
267
268    //
269    // Audio input Control functions
270    //
271
272    // opens an audio input
273    virtual status_t openInput(audio_module_handle_t module,
274                               audio_io_handle_t *input,
275                               audio_config_t *config,
276                               audio_devices_t *device,
277                               const String8& address,
278                               audio_source_t source,
279                               audio_input_flags_t flags) = 0;
280    // closes an audio input
281    virtual status_t closeInput(audio_io_handle_t input) = 0;
282    //
283    // misc control functions
284    //
285
286    // set a stream volume for a particular output. For the same user setting, a given stream type can have different volumes
287    // for each output (destination device) it is attached to.
288    virtual status_t setStreamVolume(audio_stream_type_t stream, float volume, audio_io_handle_t output, int delayMs = 0) = 0;
289
290    // invalidate a stream type, causing a reroute to an unspecified new output
291    virtual status_t invalidateStream(audio_stream_type_t stream) = 0;
292
293    // function enabling to send proprietary informations directly from audio policy manager to audio hardware interface.
294    virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs, int delayMs = 0) = 0;
295    // function enabling to receive proprietary informations directly from audio hardware interface to audio policy manager.
296    virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
297
298    // request the playback of a tone on the specified stream: used for instance to replace notification sounds when playing
299    // over a telephony device during a phone call.
300    virtual status_t startTone(audio_policy_tone_t tone, audio_stream_type_t stream) = 0;
301    virtual status_t stopTone() = 0;
302
303    // set down link audio volume.
304    virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
305
306    // move effect to the specified output
307    virtual status_t moveEffects(int session,
308                                     audio_io_handle_t srcOutput,
309                                     audio_io_handle_t dstOutput) = 0;
310
311    /* Create a patch between several source and sink ports */
312    virtual status_t createAudioPatch(const struct audio_patch *patch,
313                                       audio_patch_handle_t *handle,
314                                       int delayMs) = 0;
315
316    /* Release a patch */
317    virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
318                                       int delayMs) = 0;
319
320    /* Set audio port configuration */
321    virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
322
323    virtual void onAudioPortListUpdate() = 0;
324
325    virtual void onAudioPatchListUpdate() = 0;
326
327    virtual audio_unique_id_t newAudioUniqueId() = 0;
328
329    virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
330};
331
332extern "C" AudioPolicyInterface* createAudioPolicyManager(AudioPolicyClientInterface *clientInterface);
333extern "C" void destroyAudioPolicyManager(AudioPolicyInterface *interface);
334
335
336}; // namespace android
337
338#endif // ANDROID_AUDIOPOLICY_INTERFACE_H
339