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 <android/media/DeviceConnectedState.h>
21 #include <android/media/TrackInternalMuteInfo.h>
22 #include <media/AudioCommonTypes.h>
23 #include <media/AudioContainers.h>
24 #include <media/AudioDeviceTypeAddr.h>
25 #include <media/AudioSystem.h>
26 #include <media/AudioPolicy.h>
27 #include <media/DeviceDescriptorBase.h>
28 #include <android/content/AttributionSourceState.h>
29 #include <utils/String8.h>
30 
31 namespace android {
32 
33 using content::AttributionSourceState;
34 
35 // ----------------------------------------------------------------------------
36 
37 // The AudioPolicyInterface and AudioPolicyClientInterface classes define the communication
38 // interfaces between the platform specific audio policy manager and Android generic audio policy
39 // manager.
40 // The platform specific audio policy manager must implement methods of the AudioPolicyInterface
41 // class.
42 // This implementation makes use of the AudioPolicyClientInterface to control the activity and
43 // configuration of audio input and output streams.
44 //
45 // The platform specific audio policy manager is in charge of the audio routing and volume control
46 // policies for a given platform.
47 // The main roles of this module are:
48 //   - keep track of current system state (removable device connections, phone state,
49 //   user requests...).
50 //   System state changes and user actions are notified to audio policy manager with methods of the
51 //   AudioPolicyInterface.
52 //   - process getOutput() queries received when AudioTrack objects are created: Those queries
53 //   return a handler on an output that has been selected, configured and opened by the audio
54 //   policy manager and that must be used by the AudioTrack when registering to the AudioFlinger
55 //   with the createTrack() method.
56 //   When the AudioTrack object is released, a putOutput() query is received and the audio policy
57 //   manager can decide to close or reconfigure the output depending on other streams using this
58 //   output and current system state.
59 //   - similarly process getInput() and putInput() queries received from AudioRecord objects and
60 //   configure audio inputs.
61 //   - process volume control requests: the stream volume is converted from an index value
62 //   (received from UI) to a float value applicable to each output as a function of platform
63 //   specificsettings and current output route (destination device). It also make sure that streams
64 //   are not muted if not allowed (e.g. camera shutter sound in some countries).
65 //
66 // The platform specific audio policy manager is provided as a shared library by platform vendors
67 // (as for libaudio.so) and is linked with libaudioflinger.so
68 //
69 // NOTE: by convention, the implementation of the AudioPolicyInterface in AudioPolicyManager does
70 // not have to perform any nullptr check on input arguments: The caller of this API is
71 // AudioPolicyService running in the same process and in charge of validating arguments received
72 // from incoming binder calls before calling AudioPolicyManager.
73 
74 //    Audio Policy Manager Interface
75 class AudioPolicyInterface
76 {
77 
78 public:
79     typedef enum {
80         API_INPUT_INVALID = -1,
81         API_INPUT_LEGACY  = 0,// e.g. audio recording from a microphone
82         API_INPUT_MIX_CAPTURE,// used for "remote submix" legacy mode (no DAP),
83                               // capture of the media to play it remotely
84         API_INPUT_MIX_EXT_POLICY_REROUTE,// used for platform audio rerouting, where mixes are
85                                          // handled by external and dynamically installed
86                                          // policies which reroute audio mixes
87         API_INPUT_MIX_PUBLIC_CAPTURE_PLAYBACK,  // used for playback capture with a MediaProjection
88         API_INPUT_TELEPHONY_RX, // used for capture from telephony RX path
89     } input_type_t;
90 
91     typedef enum {
92         API_OUTPUT_INVALID = -1,
93         API_OUTPUT_LEGACY  = 0,// e.g. audio playing to speaker
94         API_OUT_MIX_PLAYBACK,  // used for "remote submix" playback of audio from remote source
95                                // to local capture
96         API_OUTPUT_TELEPHONY_TX, // used for playback to telephony TX path
97     } output_type_t;
98 
99 public:
~AudioPolicyInterface()100     virtual ~AudioPolicyInterface() {}
101     //
102     // configuration functions
103     //
104 
105     // Informs APM that new HAL modules are available. This typically happens
106     // due to registration of an audio HAL service.
107     virtual void onNewAudioModulesAvailable() = 0;
108 
109     // indicate a change in device connection status
110     virtual status_t setDeviceConnectionState(audio_policy_dev_state_t state,
111                                               const android::media::audio::common::AudioPort& port,
112                                               audio_format_t encodedFormat) = 0;
113     // retrieve a device connection status
114     virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
115                                                               const char *device_address) = 0;
116     // indicate a change in device configuration
117     virtual status_t handleDeviceConfigChange(audio_devices_t device,
118                                               const char *device_address,
119                                               const char *device_name,
120                                               audio_format_t encodedFormat) = 0;
121     // indicate a change in phone state. Valid phones states are defined by audio_mode_t
122     virtual void setPhoneState(audio_mode_t state) = 0;
123     // force using a specific device category for the specified usage
124     virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0;
125     // retrieve current device category forced for a given usage
126     virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0;
127     // set a system property (e.g. camera sound always audible)
128     virtual void setSystemProperty(const char* property, const char* value) = 0;
129     // check proper initialization
130     virtual status_t initCheck() = 0;
131 
132     //
133     // Audio routing query functions
134     //
135 
136     // request an output appropriate for playback of the supplied stream type and parameters
137     virtual audio_io_handle_t getOutput(audio_stream_type_t stream) = 0;
138     virtual status_t getOutputForAttr(const audio_attributes_t *attr,
139                                       audio_io_handle_t *output,
140                                       audio_session_t session,
141                                       audio_stream_type_t *stream,
142                                       const AttributionSourceState& attributionSource,
143                                       audio_config_t *config,
144                                       audio_output_flags_t *flags,
145                                       audio_port_handle_t *selectedDeviceId,
146                                       audio_port_handle_t *portId,
147                                       std::vector<audio_io_handle_t> *secondaryOutputs,
148                                       output_type_t *outputType,
149                                       bool *isSpatialized,
150                                       bool *isBitPerfect) = 0;
151     // indicates to the audio policy manager that the output starts being used by corresponding
152     // stream.
153     virtual status_t startOutput(audio_port_handle_t portId) = 0;
154     // indicates to the audio policy manager that the output stops being used by corresponding
155     // stream.
156     virtual status_t stopOutput(audio_port_handle_t portId) = 0;
157     // releases the output, return true if the output descriptor is reopened.
158     virtual bool releaseOutput(audio_port_handle_t portId) = 0;
159 
160     // request an input appropriate for record from the supplied device with supplied parameters.
161     virtual status_t getInputForAttr(const audio_attributes_t *attr,
162                                      audio_io_handle_t *input,
163                                      audio_unique_id_t riid,
164                                      audio_session_t session,
165                                      const AttributionSourceState& attributionSource,
166                                      audio_config_base_t *config,
167                                      audio_input_flags_t flags,
168                                      audio_port_handle_t *selectedDeviceId,
169                                      input_type_t *inputType,
170                                      audio_port_handle_t *portId,
171                                      uint32_t *virtualDeviceId) = 0;
172     // indicates to the audio policy manager that the input starts being used.
173     virtual status_t startInput(audio_port_handle_t portId) = 0;
174     // indicates to the audio policy manager that the input stops being used.
175     virtual status_t stopInput(audio_port_handle_t portId) = 0;
176     // releases the input.
177     virtual void releaseInput(audio_port_handle_t portId) = 0;
178 
179     //
180     // volume control functions
181     //
182 
183     // notifies the audio policy manager that the absolute volume mode is enabled/disabled on
184     // the passed device. Also specifies the stream that is controlling the absolute volume.
185     virtual status_t setDeviceAbsoluteVolumeEnabled(audio_devices_t device,
186                                                     const char *address,
187                                                     bool enabled,
188                                                     audio_stream_type_t streamToDriveAbs) = 0;
189     // initialises stream volume conversion parameters by specifying volume index range.
190     virtual void initStreamVolume(audio_stream_type_t stream,
191                                   int indexMin,
192                                   int indexMax) = 0;
193 
194     // sets the new stream volume at a level corresponding to the supplied index for the
195     // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
196     // setting volume for all devices
197     virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
198                                           int index,
199                                           audio_devices_t device) = 0;
200 
201     // retrieve current volume index for the specified stream and the
202     // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
203     // querying the volume of the active device.
204     virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
205                                           int *index,
206                                           audio_devices_t device) = 0;
207 
208     virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
209                                                  int index,
210                                                  audio_devices_t device) = 0;
211     virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
212                                                  int &index,
213                                                  audio_devices_t device) = 0;
214 
215     virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr,
216                                                     int &index) = 0;
217 
218     virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr,
219                                                     int &index) = 0;
220 
221     // return the strategy corresponding to a given stream type
222     virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream) = 0;
223 
224     // retrieves the list of enabled output devices for the given audio attributes
225     virtual status_t getDevicesForAttributes(const audio_attributes_t &attr,
226                                              AudioDeviceTypeAddrVector *devices,
227                                              bool forVolume) = 0;
228 
229     // Audio effect management
230     virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
231     virtual status_t registerEffect(const effect_descriptor_t *desc,
232                                     audio_io_handle_t io,
233                                     product_strategy_t strategy,
234                                     int session,
235                                     int id) = 0;
236     virtual status_t unregisterEffect(int id) = 0;
237     virtual status_t setEffectEnabled(int id, bool enabled) = 0;
238     virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0;
239 
240     virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
241     virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
242                                         uint32_t inPastMs = 0) const = 0;
243     virtual bool isSourceActive(audio_source_t source) const = 0;
244 
245     //dump state
246     virtual status_t    dump(int fd) = 0;
247 
248     virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0;
249     virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo) = 0;
250     virtual bool isDirectOutputSupported(const audio_config_base_t& config,
251                                          const audio_attributes_t& attributes) = 0;
252 
253     virtual status_t listAudioPorts(audio_port_role_t role,
254                                     audio_port_type_t type,
255                                     unsigned int *num_ports,
256                                     struct audio_port_v7 *ports,
257                                     unsigned int *generation) = 0;
258     virtual status_t listDeclaredDevicePorts(media::AudioPortRole role,
259                                              std::vector<media::AudioPortFw>* result) = 0;
260     virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
261     virtual status_t createAudioPatch(const struct audio_patch *patch,
262                                        audio_patch_handle_t *handle,
263                                        uid_t uid) = 0;
264     virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
265                                           uid_t uid) = 0;
266     virtual status_t listAudioPatches(unsigned int *num_patches,
267                                       struct audio_patch *patches,
268                                       unsigned int *generation) = 0;
269     virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
270     virtual void releaseResourcesForUid(uid_t uid) = 0;
271 
272     virtual status_t acquireSoundTriggerSession(audio_session_t *session,
273                                            audio_io_handle_t *ioHandle,
274                                            audio_devices_t *device) = 0;
275 
276     virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
277 
278     virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0;
279     virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
280     virtual status_t getRegisteredPolicyMixes(std::vector<AudioMix>& mixes) = 0;
281 
282     virtual status_t updatePolicyMix(
283         const AudioMix& mix,
284         const std::vector<AudioMixMatchCriterion>& updatedCriteria) = 0;
285 
286     virtual status_t setUidDeviceAffinities(uid_t uid, const AudioDeviceTypeAddrVector& devices)
287             = 0;
288     virtual status_t removeUidDeviceAffinities(uid_t uid) = 0;
289 
290     virtual status_t setUserIdDeviceAffinities(int userId,
291             const AudioDeviceTypeAddrVector& devices) = 0;
292     virtual status_t removeUserIdDeviceAffinities(int userId) = 0;
293 
294     virtual status_t startAudioSource(const struct audio_port_config *source,
295                                       const audio_attributes_t *attributes,
296                                       audio_port_handle_t *portId,
297                                       uid_t uid) = 0;
298     virtual status_t stopAudioSource(audio_port_handle_t portId) = 0;
299 
300     virtual status_t setMasterMono(bool mono) = 0;
301     virtual status_t getMasterMono(bool *mono) = 0;
302 
303     virtual float    getStreamVolumeDB(
304                 audio_stream_type_t stream, int index, audio_devices_t device) = 0;
305 
306     virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
307                                         audio_format_t *surroundFormats,
308                                         bool *surroundFormatsEnabled) = 0;
309 
310     virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
311                                                 audio_format_t *surroundFormats) = 0;
312 
313     virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0;
314 
315     virtual bool     isHapticPlaybackSupported() = 0;
316 
317     virtual bool     isUltrasoundSupported() = 0;
318 
319     virtual bool     isHotwordStreamSupported(bool lookbackAudio) = 0;
320 
321     virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
322                 audio_devices_t device, std::vector<audio_format_t> *formats) = 0;
323 
324     virtual void     setAppState(audio_port_handle_t portId, app_state_t state) = 0;
325 
326     virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0;
327 
328     virtual status_t getProductStrategyFromAudioAttributes(
329             const audio_attributes_t &aa, product_strategy_t &productStrategy,
330             bool fallbackOnDefault) = 0;
331 
332     virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0;
333 
334     virtual status_t getVolumeGroupFromAudioAttributes(
335             const audio_attributes_t &aa, volume_group_t &volumeGroup, bool fallbackOnDefault) = 0;
336 
337     virtual bool     isCallScreenModeSupported() = 0;
338 
339     virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
340                                                device_role_t role,
341                                                const AudioDeviceTypeAddrVector &devices) = 0;
342 
343     virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
344                                                   device_role_t role,
345                                                   const AudioDeviceTypeAddrVector &devices) = 0;
346 
347     virtual status_t clearDevicesRoleForStrategy(product_strategy_t strategy,
348                                                      device_role_t role) = 0;
349 
350     virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
351                                                   device_role_t role,
352                                                   AudioDeviceTypeAddrVector &devices) = 0;
353 
354     virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
355                                                     device_role_t role,
356                                                     const AudioDeviceTypeAddrVector &devices) = 0;
357 
358     virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
359                                                     device_role_t role,
360                                                     const AudioDeviceTypeAddrVector &devices) = 0;
361 
362     virtual status_t removeDevicesRoleForCapturePreset(
363             audio_source_t audioSource, device_role_t role,
364             const AudioDeviceTypeAddrVector& devices) = 0;
365 
366     virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
367                                                       device_role_t role) = 0;
368 
369     virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
370                                                        device_role_t role,
371                                                        AudioDeviceTypeAddrVector &devices) = 0;
372 
373     /**
374      * Queries if some kind of spatialization will be performed if the audio playback context
375      * described by the provided arguments is present.
376      * The context is made of:
377      * - The audio attributes describing the playback use case.
378      * - The audio configuration describing the audio format, channels, sampling rate ...
379      * - The devices describing the sink audio device selected for playback.
380      * All arguments are optional and only the specified arguments are used to match against
381      * supported criteria. For instance, supplying no argument will tell if spatialization is
382      * supported or not in general.
383      * @param attr audio attributes describing the playback use case
384      * @param config audio configuration describing the audio format, channels, sampling rate...
385      * @param devices the sink audio device selected for playback
386      * @return true if spatialization is enabled for this context,
387      *        false otherwise
388      */
389      virtual bool canBeSpatialized(const audio_attributes_t *attr,
390                                   const audio_config_t *config,
391                                   const AudioDeviceTypeAddrVector &devices) const = 0;
392 
393     /**
394      * Opens a specialized spatializer output if supported by the platform.
395      * If several spatializer output profiles exist, the one supporting the sink device
396      * corresponding to the provided audio attributes will be selected.
397      * Only one spatializer output stream can be opened at a time and an error is returned
398      * if one already exists.
399      * @param config audio format, channel mask and sampling rate to be used as the mixer
400      *        configuration for the spatializer mixer created.
401      * @param attr audio attributes describing the playback use case that will drive the
402      *        sink device selection
403      * @param output the IO handle of the output opened
404      * @return NO_ERROR if an output was opened, INVALID_OPERATION or BAD_VALUE otherwise
405      */
406     virtual status_t getSpatializerOutput(const audio_config_base_t *config,
407                                             const audio_attributes_t *attr,
408                                             audio_io_handle_t *output) = 0;
409 
410     /**
411      * Closes a previously opened specialized spatializer output.
412      * @param output the IO handle of the output to close.
413      * @return NO_ERROR if an output was closed, INVALID_OPERATION or BAD_VALUE otherwise
414      */
415     virtual status_t releaseSpatializerOutput(audio_io_handle_t output) = 0;
416 
417     /**
418      * Query how the direct playback is currently supported on the device.
419      * @param attr audio attributes describing the playback use case
420      * @param config audio configuration for the playback
421      * @param directMode out: a set of flags describing how the direct playback is currently
422      *        supported on the device
423      * @return NO_ERROR in case of success, DEAD_OBJECT, NO_INIT, BAD_VALUE, PERMISSION_DENIED
424      *         in case of error.
425      */
426     virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
427                                                          const audio_config_t *config) = 0;
428 
429     // retrieves the list of available direct audio profiles for the given audio attributes
430     virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
431                                                     AudioProfileVector& audioProfiles) = 0;
432 
433     virtual status_t getSupportedMixerAttributes(
434             audio_port_handle_t portId, std::vector<audio_mixer_attributes_t>& mixerAttrs) = 0;
435     virtual status_t setPreferredMixerAttributes(
436             const audio_attributes_t* attr,
437             audio_port_handle_t portId,
438             uid_t uid,
439             const audio_mixer_attributes_t* mixerAttributes) = 0;
440     virtual status_t getPreferredMixerAttributes(const audio_attributes_t* attr,
441                                                  audio_port_handle_t portId,
442                                                  audio_mixer_attributes_t* mixerAttributes) = 0;
443     virtual status_t clearPreferredMixerAttributes(const audio_attributes_t* attr,
444                                                    audio_port_handle_t portId,
445                                                    uid_t uid) = 0;
446 };
447 
448 // Audio Policy client Interface
449 class AudioPolicyClientInterface
450 {
451 public:
~AudioPolicyClientInterface()452     virtual ~AudioPolicyClientInterface() {}
453 
454     virtual status_t getAudioPolicyConfig(media::AudioPolicyConfig *config) = 0;
455 
456     //
457     // Audio HW module functions
458     //
459 
460     // loads a HW module.
461     virtual audio_module_handle_t loadHwModule(const char *name) = 0;
462 
463     //
464     // Audio output Control functions
465     //
466 
467     // opens an audio output with the requested parameters. The parameter values can indicate to
468     // use the default values in case the audio policy manager has no specific requirements for the
469     // output being opened.
470     // When the function returns, the parameter values reflect the actual values used by the audio
471     // hardware output stream.
472     // The audio policy manager can check if the proposed parameters are suitable or not and act
473     // accordingly.
474     virtual status_t openOutput(audio_module_handle_t module,
475                                 audio_io_handle_t *output,
476                                 audio_config_t *halConfig,
477                                 audio_config_base_t *mixerConfig,
478                                 const sp<DeviceDescriptorBase>& device,
479                                 uint32_t *latencyMs,
480                                 audio_output_flags_t flags) = 0;
481     // creates a special output that is duplicated to the two outputs passed as arguments.
482     // The duplication is performed by a special mixer thread in the AudioFlinger.
483     virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
484                                                   audio_io_handle_t output2) = 0;
485     // closes the output stream
486     virtual status_t closeOutput(audio_io_handle_t output) = 0;
487     // suspends the output. When an output is suspended, the corresponding audio hardware output
488     // stream is placed in standby and the AudioTracks attached to the mixer thread are still
489     // processed but the output mix is discarded.
490     virtual status_t suspendOutput(audio_io_handle_t output) = 0;
491     // restores a suspended output.
492     virtual status_t restoreOutput(audio_io_handle_t output) = 0;
493 
494     //
495     // Audio input Control functions
496     //
497 
498     // opens an audio input
499     virtual status_t openInput(audio_module_handle_t module,
500                                audio_io_handle_t *input,
501                                audio_config_t *config,
502                                audio_devices_t *device,
503                                const String8& address,
504                                audio_source_t source,
505                                audio_input_flags_t flags) = 0;
506     // closes an audio input
507     virtual status_t closeInput(audio_io_handle_t input) = 0;
508     //
509     // misc control functions
510     //
511 
512     // set a stream volume for a particular output. For the same user setting, a given stream type
513     // can have different volumes
514     // for each output (destination device) it is attached to.
515     virtual status_t setStreamVolume(audio_stream_type_t stream, float volume,
516                                      audio_io_handle_t output, int delayMs = 0) = 0;
517 
518     // function enabling to send proprietary informations directly from audio policy manager to
519     // audio hardware interface.
520     virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs,
521                                int delayMs = 0) = 0;
522     // function enabling to receive proprietary informations directly from audio hardware interface
523     // to audio policy manager.
524     virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
525 
526     // set down link audio volume.
527     virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
528 
529     // move effect to the specified output
530     virtual status_t moveEffects(audio_session_t session,
531                                      audio_io_handle_t srcOutput,
532                                      audio_io_handle_t dstOutput) = 0;
533 
534     virtual void setEffectSuspended(int effectId,
535                                     audio_session_t sessionId,
536                                     bool suspended) = 0;
537 
538     /* Create a patch between several source and sink ports */
539     virtual status_t createAudioPatch(const struct audio_patch *patch,
540                                        audio_patch_handle_t *handle,
541                                        int delayMs) = 0;
542 
543     /* Release a patch */
544     virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
545                                        int delayMs) = 0;
546 
547     /* Set audio port configuration */
548     virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
549 
550     virtual void onAudioPortListUpdate() = 0;
551 
552     virtual void onAudioPatchListUpdate() = 0;
553 
554     virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0;
555 
556     virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0;
557 
558     virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
559 
560     virtual void onRecordingConfigurationUpdate(int event,
561                                                 const record_client_info_t *clientInfo,
562                                                 const audio_config_base_t *clientConfig,
563                                                 std::vector<effect_descriptor_t> clientEffects,
564                                                 const audio_config_base_t *deviceConfig,
565                                                 std::vector<effect_descriptor_t> effects,
566                                                 audio_patch_handle_t patchHandle,
567                                                 audio_source_t source) = 0;
568 
569     virtual void onRoutingUpdated() = 0;
570 
571     // Used to notify AudioService that an error was encountering when reading
572     // the volume ranges, and that they should be re-initialized
573     virtual void onVolumeRangeInitRequest() = 0;
574 
575     // Used to notify the sound trigger module that an audio capture is about to
576     // take place. This should typically result in any active recognition
577     // sessions to be preempted on modules that do not support sound trigger
578     // recognition concurrently with audio capture.
579     virtual void setSoundTriggerCaptureState(bool active) = 0;
580 
581     virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
582 
583     virtual status_t updateSecondaryOutputs(
584             const TrackSecondaryOutputsMap& trackSecondaryOutputs) = 0;
585 
586     virtual status_t setDeviceConnectedState(const struct audio_port_v7 *port,
587                                              media::DeviceConnectedState state) = 0;
588 
589     virtual status_t invalidateTracks(const std::vector<audio_port_handle_t>& portIds) = 0;
590 
591     // Get the attributes of the mix port when connecting to the given device port.
592     virtual status_t getAudioMixPort(const struct audio_port_v7 *devicePort,
593                                      struct audio_port_v7 *mixPort) = 0;
594 
595     virtual status_t setTracksInternalMute(
596             const std::vector<media::TrackInternalMuteInfo>& tracksInternalMute) = 0;
597 };
598 
599     // These are the signatures of createAudioPolicyManager/destroyAudioPolicyManager
600     // methods respectively, expected by AudioPolicyService, needs to be exposed by
601     // libaudiopolicymanagercustom.
602     using CreateAudioPolicyManagerInstance =
603             AudioPolicyInterface* (*)(AudioPolicyClientInterface*);
604     using DestroyAudioPolicyManagerInstance = void (*)(AudioPolicyInterface*);
605 
606 } // namespace android
607 
608 #endif // ANDROID_AUDIOPOLICY_INTERFACE_H
609