blob: c4c27e86944010390b9c1b8d77b138b8007daa96 [file] [log] [blame]
Eric Laurente552edb2014-03-10 17:42:56 -07001/*
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
Eric Laurentdce54a12014-03-10 12:19:46 -070017#ifndef ANDROID_AUDIOPOLICY_INTERFACE_H
18#define ANDROID_AUDIOPOLICY_INTERFACE_H
Eric Laurente552edb2014-03-10 17:42:56 -070019
jiabin10a03f12021-05-07 23:46:28 +000020#include <media/AudioCommonTypes.h>
Mikhail Naganov5478fc12021-07-08 16:13:29 -070021#include <media/AudioContainers.h>
jiabin05b5edd2019-11-04 14:10:42 -080022#include <media/AudioDeviceTypeAddr.h>
Eric Laurente552edb2014-03-10 17:42:56 -070023#include <media/AudioSystem.h>
Eric Laurentbaac1832014-12-01 17:52:59 -080024#include <media/AudioPolicy.h>
jiabin43810402019-10-24 14:58:31 -070025#include <media/DeviceDescriptorBase.h>
Svet Ganov3e5f14f2021-05-13 22:51:08 +000026#include <android/content/AttributionSourceState.h>
Eric Laurente552edb2014-03-10 17:42:56 -070027#include <utils/String8.h>
28
Eric Laurent3b73df72014-03-11 09:06:29 -070029namespace android {
Eric Laurente552edb2014-03-10 17:42:56 -070030
Svet Ganov3e5f14f2021-05-13 22:51:08 +000031using content::AttributionSourceState;
32
Eric Laurente552edb2014-03-10 17:42:56 -070033// ----------------------------------------------------------------------------
34
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020035// The AudioPolicyInterface and AudioPolicyClientInterface classes define the communication
36// interfaces between the platform specific audio policy manager and Android generic audio policy
37// manager.
38// The platform specific audio policy manager must implement methods of the AudioPolicyInterface
39// class.
Eric Laurente552edb2014-03-10 17:42:56 -070040// This implementation makes use of the AudioPolicyClientInterface to control the activity and
41// configuration of audio input and output streams.
42//
43// The platform specific audio policy manager is in charge of the audio routing and volume control
44// policies for a given platform.
45// The main roles of this module are:
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020046// - keep track of current system state (removable device connections, phone state,
47// user requests...).
48// System state changes and user actions are notified to audio policy manager with methods of the
49// AudioPolicyInterface.
Eric Laurente552edb2014-03-10 17:42:56 -070050// - process getOutput() queries received when AudioTrack objects are created: Those queries
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020051// return a handler on an output that has been selected, configured and opened by the audio
52// policy manager and that must be used by the AudioTrack when registering to the AudioFlinger
53// with the createTrack() method.
54// When the AudioTrack object is released, a putOutput() query is received and the audio policy
55// manager can decide to close or reconfigure the output depending on other streams using this
56// output and current system state.
57// - similarly process getInput() and putInput() queries received from AudioRecord objects and
58// configure audio inputs.
59// - process volume control requests: the stream volume is converted from an index value
60// (received from UI) to a float value applicable to each output as a function of platform
61// specificsettings and current output route (destination device). It also make sure that streams
62// are not muted if not allowed (e.g. camera shutter sound in some countries).
Eric Laurente552edb2014-03-10 17:42:56 -070063//
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020064// The platform specific audio policy manager is provided as a shared library by platform vendors
65// (as for libaudio.so) and is linked with libaudioflinger.so
66//
67// NOTE: by convention, the implementation of the AudioPolicyInterface in AudioPolicyManager does
68// not have to perform any nullptr check on input arguments: The caller of this API is
69// AudioPolicyService running in the same process and in charge of validating arguments received
70// from incoming binder calls before calling AudioPolicyManager.
Eric Laurente552edb2014-03-10 17:42:56 -070071
72// Audio Policy Manager Interface
73class AudioPolicyInterface
74{
75
76public:
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080077 typedef enum {
78 API_INPUT_INVALID = -1,
79 API_INPUT_LEGACY = 0,// e.g. audio recording from a microphone
Kevin Rocard25f9b052019-02-27 15:08:54 -080080 API_INPUT_MIX_CAPTURE,// used for "remote submix" legacy mode (no DAP),
81 // capture of the media to play it remotely
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080082 API_INPUT_MIX_EXT_POLICY_REROUTE,// used for platform audio rerouting, where mixes are
83 // handled by external and dynamically installed
84 // policies which reroute audio mixes
Kevin Rocard25f9b052019-02-27 15:08:54 -080085 API_INPUT_MIX_PUBLIC_CAPTURE_PLAYBACK, // used for playback capture with a MediaProjection
Eric Laurent82db2692015-08-07 13:59:42 -070086 API_INPUT_TELEPHONY_RX, // used for capture from telephony RX path
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080087 } input_type_t;
88
Eric Laurent8a1095a2019-11-08 14:44:16 -080089 typedef enum {
90 API_OUTPUT_INVALID = -1,
91 API_OUTPUT_LEGACY = 0,// e.g. audio playing to speaker
92 API_OUT_MIX_PLAYBACK, // used for "remote submix" playback of audio from remote source
93 // to local capture
94 API_OUTPUT_TELEPHONY_TX, // used for playback to telephony TX path
95 } output_type_t;
96
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080097public:
Eric Laurente552edb2014-03-10 17:42:56 -070098 virtual ~AudioPolicyInterface() {}
99 //
100 // configuration functions
101 //
102
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000103 // Informs APM that new HAL modules are available. This typically happens
104 // due to registration of an audio HAL service.
105 virtual void onNewAudioModulesAvailable() = 0;
106
Eric Laurente552edb2014-03-10 17:42:56 -0700107 // indicate a change in device connection status
Nathalie Le Clair88fa2752021-11-23 13:03:41 +0100108 virtual status_t setDeviceConnectionState(audio_policy_dev_state_t state,
109 const android::media::audio::common::AudioPort& port,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800110 audio_format_t encodedFormat) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700111 // retrieve a device connection status
Eric Laurent3b73df72014-03-11 09:06:29 -0700112 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200113 const char *device_address) = 0;
Pavlin Radoslavovf862bc62016-12-26 18:57:22 -0800114 // indicate a change in device configuration
115 virtual status_t handleDeviceConfigChange(audio_devices_t device,
116 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800117 const char *device_name,
118 audio_format_t encodedFormat) = 0;
Eric Laurent3b73df72014-03-11 09:06:29 -0700119 // indicate a change in phone state. Valid phones states are defined by audio_mode_t
120 virtual void setPhoneState(audio_mode_t state) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700121 // force using a specific device category for the specified usage
Eric Laurent3b73df72014-03-11 09:06:29 -0700122 virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700123 // retrieve current device category forced for a given usage
Eric Laurent3b73df72014-03-11 09:06:29 -0700124 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700125 // set a system property (e.g. camera sound always audible)
126 virtual void setSystemProperty(const char* property, const char* value) = 0;
127 // check proper initialization
128 virtual status_t initCheck() = 0;
129
130 //
131 // Audio routing query functions
132 //
133
134 // request an output appropriate for playback of the supplied stream type and parameters
Eric Laurentf4e63452017-11-06 19:31:46 +0000135 virtual audio_io_handle_t getOutput(audio_stream_type_t stream) = 0;
Eric Laurente83b55d2014-11-14 10:06:21 -0800136 virtual status_t getOutputForAttr(const audio_attributes_t *attr,
jiabinf1c73972022-04-14 16:28:52 -0700137 audio_io_handle_t *output,
138 audio_session_t session,
139 audio_stream_type_t *stream,
140 const AttributionSourceState& attributionSouce,
141 audio_config_t *config,
142 audio_output_flags_t *flags,
143 audio_port_handle_t *selectedDeviceId,
144 audio_port_handle_t *portId,
145 std::vector<audio_io_handle_t> *secondaryOutputs,
146 output_type_t *outputType,
147 bool *isSpatialized) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200148 // indicates to the audio policy manager that the output starts being used by corresponding
149 // stream.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700150 virtual status_t startOutput(audio_port_handle_t portId) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200151 // indicates to the audio policy manager that the output stops being used by corresponding
152 // stream.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700153 virtual status_t stopOutput(audio_port_handle_t portId) = 0;
jiabinbce0c1d2020-10-05 11:20:18 -0700154 // releases the output, return true if the output descriptor is reopened.
155 virtual bool releaseOutput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700156
157 // request an input appropriate for record from the supplied device with supplied parameters.
Eric Laurentcaf7f482014-11-25 17:50:47 -0800158 virtual status_t getInputForAttr(const audio_attributes_t *attr,
159 audio_io_handle_t *input,
Mikhail Naganov2996f672019-04-18 12:29:59 -0700160 audio_unique_id_t riid,
Eric Laurentcaf7f482014-11-25 17:50:47 -0800161 audio_session_t session,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000162 const AttributionSourceState& attributionSouce,
jiabinf1c73972022-04-14 16:28:52 -0700163 audio_config_base_t *config,
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -0800164 audio_input_flags_t flags,
Eric Laurent9ae8c592017-06-22 17:17:09 -0700165 audio_port_handle_t *selectedDeviceId,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800166 input_type_t *inputType,
167 audio_port_handle_t *portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700168 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800169 virtual status_t startInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700170 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700171 virtual status_t stopInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700172 // releases the input.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700173 virtual void releaseInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700174
175 //
176 // volume control functions
177 //
178
179 // initialises stream volume conversion parameters by specifying volume index range.
Eric Laurent3b73df72014-03-11 09:06:29 -0700180 virtual void initStreamVolume(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700181 int indexMin,
182 int indexMax) = 0;
183
184 // sets the new stream volume at a level corresponding to the supplied index for the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700185 // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700186 // setting volume for all devices
Eric Laurent3b73df72014-03-11 09:06:29 -0700187 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700188 int index,
189 audio_devices_t device) = 0;
190
191 // retrieve current volume index for the specified stream and the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700192 // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700193 // querying the volume of the active device.
Eric Laurent3b73df72014-03-11 09:06:29 -0700194 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700195 int *index,
196 audio_devices_t device) = 0;
197
François Gaffiecfe17322018-11-07 13:41:29 +0100198 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
199 int index,
200 audio_devices_t device) = 0;
201 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
202 int &index,
203 audio_devices_t device) = 0;
204
205 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr,
206 int &index) = 0;
207
208 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr,
209 int &index) = 0;
210
Eric Laurente552edb2014-03-10 17:42:56 -0700211 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800212 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700213
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800214 // retrieves the list of enabled output devices for the given audio attributes
215 virtual status_t getDevicesForAttributes(const audio_attributes_t &attr,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800216 AudioDeviceTypeAddrVector *devices,
217 bool forVolume) = 0;
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800218
Eric Laurente552edb2014-03-10 17:42:56 -0700219 // Audio effect management
220 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
221 virtual status_t registerEffect(const effect_descriptor_t *desc,
222 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800223 product_strategy_t strategy,
Eric Laurente552edb2014-03-10 17:42:56 -0700224 int session,
225 int id) = 0;
226 virtual status_t unregisterEffect(int id) = 0;
227 virtual status_t setEffectEnabled(int id, bool enabled) = 0;
Eric Laurent6c796322019-04-09 14:13:17 -0700228 virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700229
Eric Laurent3b73df72014-03-11 09:06:29 -0700230 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
231 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
232 uint32_t inPastMs = 0) const = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700233 virtual bool isSourceActive(audio_source_t source) const = 0;
234
235 //dump state
236 virtual status_t dump(int fd) = 0;
237
Kevin Rocardb99cc752019-03-21 20:52:24 -0700238 virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100239 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo) = 0;
Michael Chana94fbb22018-04-24 14:31:19 +1000240 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
241 const audio_attributes_t& attributes) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700242
243 virtual status_t listAudioPorts(audio_port_role_t role,
244 audio_port_type_t type,
245 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800246 struct audio_port_v7 *ports,
Eric Laurent6a94d692014-05-20 11:18:06 -0700247 unsigned int *generation) = 0;
jiabin19cdba52020-11-24 11:28:58 -0800248 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700249 virtual status_t createAudioPatch(const struct audio_patch *patch,
250 audio_patch_handle_t *handle,
251 uid_t uid) = 0;
252 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
253 uid_t uid) = 0;
254 virtual status_t listAudioPatches(unsigned int *num_patches,
255 struct audio_patch *patches,
256 unsigned int *generation) = 0;
257 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700258 virtual void releaseResourcesForUid(uid_t uid) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700259
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700260 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
261 audio_io_handle_t *ioHandle,
262 audio_devices_t *device) = 0;
263
264 virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800265
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700266 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800267 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
Eric Laurent554a2772015-04-10 11:29:24 -0700268
jiabin6a02d532020-08-07 11:56:38 -0700269 virtual status_t setUidDeviceAffinities(uid_t uid, const AudioDeviceTypeAddrVector& devices)
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800270 = 0;
271 virtual status_t removeUidDeviceAffinities(uid_t uid) = 0;
272
Oscar Azucena90e77632019-11-27 17:12:28 -0800273 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700274 const AudioDeviceTypeAddrVector& devices) = 0;
Oscar Azucena90e77632019-11-27 17:12:28 -0800275 virtual status_t removeUserIdDeviceAffinities(int userId) = 0;
276
Eric Laurent554a2772015-04-10 11:29:24 -0700277 virtual status_t startAudioSource(const struct audio_port_config *source,
278 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700279 audio_port_handle_t *portId,
Eric Laurentd60560a2015-04-10 11:31:20 -0700280 uid_t uid) = 0;
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700281 virtual status_t stopAudioSource(audio_port_handle_t portId) = 0;
Andy Hung2ddee192015-12-18 17:34:44 -0800282
283 virtual status_t setMasterMono(bool mono) = 0;
284 virtual status_t getMasterMono(bool *mono) = 0;
Eric Laurentac9cef52017-06-09 15:46:26 -0700285
286 virtual float getStreamVolumeDB(
287 audio_stream_type_t stream, int index, audio_devices_t device) = 0;
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800288
jiabin81772902018-04-02 17:52:27 -0700289 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
290 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100291 bool *surroundFormatsEnabled) = 0;
292
293 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
294 audio_format_t *surroundFormats) = 0;
295
jiabin81772902018-04-02 17:52:27 -0700296 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0;
297
jiabin6012f912018-11-02 17:06:30 -0700298 virtual bool isHapticPlaybackSupported() = 0;
299
Carter Hsu325a8eb2022-01-19 19:56:51 +0800300 virtual bool isUltrasoundSupported() = 0;
301
Pattydd807582021-11-04 21:01:03 +0800302 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
303 audio_devices_t device, std::vector<audio_format_t> *formats) = 0;
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800304
Eric Laurent5ada82e2019-08-29 17:53:54 -0700305 virtual void setAppState(audio_port_handle_t portId, app_state_t state) = 0;
François Gaffied0ba9ed2018-11-05 11:50:42 +0100306
307 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0;
308
Francois Gaffie11b65922020-09-24 16:59:08 +0200309 virtual status_t getProductStrategyFromAudioAttributes(
310 const AudioAttributes &aa, product_strategy_t &productStrategy,
311 bool fallbackOnDefault) = 0;
François Gaffie4b2018b2018-11-07 11:18:59 +0100312
313 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0;
314
Francois Gaffie11b65922020-09-24 16:59:08 +0200315 virtual status_t getVolumeGroupFromAudioAttributes(
316 const AudioAttributes &aa, volume_group_t &volumeGroup, bool fallbackOnDefault) = 0;
Eric Laurent8340e672019-11-06 11:01:08 -0800317
318 virtual bool isCallScreenModeSupported() = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700319
jiabin0a488932020-08-07 17:32:40 -0700320 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
321 device_role_t role,
322 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700323
jiabin0a488932020-08-07 17:32:40 -0700324 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
325 device_role_t role) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700326
jiabin0a488932020-08-07 17:32:40 -0700327
328 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
329 device_role_t role,
330 AudioDeviceTypeAddrVector &devices) = 0;
Jiabin Huang3b98d322020-09-03 17:54:16 +0000331
332 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
333 device_role_t role,
334 const AudioDeviceTypeAddrVector &devices) = 0;
335
336 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
337 device_role_t role,
338 const AudioDeviceTypeAddrVector &devices) = 0;
339
340 virtual status_t removeDevicesRoleForCapturePreset(
341 audio_source_t audioSource, device_role_t role,
342 const AudioDeviceTypeAddrVector& devices) = 0;
343
344 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
345 device_role_t role) = 0;
346
347 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
348 device_role_t role,
349 AudioDeviceTypeAddrVector &devices) = 0;
Eric Laurent81dd0f52021-07-05 11:54:40 +0200350
351 /**
352 * Queries if some kind of spatialization will be performed if the audio playback context
353 * described by the provided arguments is present.
354 * The context is made of:
355 * - The audio attributes describing the playback use case.
356 * - The audio configuration describing the audio format, channels, sampling rate ...
357 * - The devices describing the sink audio device selected for playback.
358 * All arguments are optional and only the specified arguments are used to match against
359 * supported criteria. For instance, supplying no argument will tell if spatialization is
360 * supported or not in general.
361 * @param attr audio attributes describing the playback use case
362 * @param config audio configuration describing the audio format, channels, sampling rate...
363 * @param devices the sink audio device selected for playback
364 * @return true if spatialization is enabled for this context,
365 * false otherwise
366 */
367 virtual bool canBeSpatialized(const audio_attributes_t *attr,
368 const audio_config_t *config,
369 const AudioDeviceTypeAddrVector &devices) const = 0;
370
371 /**
372 * Opens a specialized spatializer output if supported by the platform.
373 * If several spatializer output profiles exist, the one supporting the sink device
374 * corresponding to the provided audio attributes will be selected.
375 * Only one spatializer output stream can be opened at a time and an error is returned
376 * if one already exists.
377 * @param config audio format, channel mask and sampling rate to be used as the mixer
378 * configuration for the spatializer mixer created.
379 * @param attr audio attributes describing the playback use case that will drive the
380 * sink device selection
381 * @param output the IO handle of the output opened
382 * @return NO_ERROR if an output was opened, INVALID_OPERATION or BAD_VALUE otherwise
383 */
384 virtual status_t getSpatializerOutput(const audio_config_base_t *config,
385 const audio_attributes_t *attr,
386 audio_io_handle_t *output) = 0;
387
388 /**
389 * Closes a previously opened specialized spatializer output.
390 * @param output the IO handle of the output to close.
391 * @return NO_ERROR if an output was closed, INVALID_OPERATION or BAD_VALUE otherwise
392 */
393 virtual status_t releaseSpatializerOutput(audio_io_handle_t output) = 0;
jiabin2b9d5a12021-12-10 01:06:29 +0000394
395 /**
396 * Query how the direct playback is currently supported on the device.
397 * @param attr audio attributes describing the playback use case
398 * @param config audio configuration for the playback
399 * @param directMode out: a set of flags describing how the direct playback is currently
400 * supported on the device
401 * @return NO_ERROR in case of success, DEAD_OBJECT, NO_INIT, BAD_VALUE, PERMISSION_DENIED
402 * in case of error.
403 */
404 virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
405 const audio_config_t *config) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700406
Dorin Drimusf2196d82022-01-03 12:11:18 +0100407 // retrieves the list of available direct audio profiles for the given audio attributes
408 virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
409 AudioProfileVector& audioProfiles) = 0;
410};
Eric Laurente552edb2014-03-10 17:42:56 -0700411
412// Audio Policy client Interface
413class AudioPolicyClientInterface
414{
415public:
416 virtual ~AudioPolicyClientInterface() {}
417
418 //
419 // Audio HW module functions
420 //
421
422 // loads a HW module.
423 virtual audio_module_handle_t loadHwModule(const char *name) = 0;
424
425 //
426 // Audio output Control functions
427 //
428
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200429 // opens an audio output with the requested parameters. The parameter values can indicate to
430 // use the default values in case the audio policy manager has no specific requirements for the
431 // output being opened.
432 // When the function returns, the parameter values reflect the actual values used by the audio
433 // hardware output stream.
434 // The audio policy manager can check if the proposed parameters are suitable or not and act
435 // accordingly.
Eric Laurentcf2c0212014-07-25 16:20:43 -0700436 virtual status_t openOutput(audio_module_handle_t module,
437 audio_io_handle_t *output,
Eric Laurentf1f22e72021-07-13 14:04:14 +0200438 audio_config_t *halConfig,
439 audio_config_base_t *mixerConfig,
jiabin43810402019-10-24 14:58:31 -0700440 const sp<DeviceDescriptorBase>& device,
Eric Laurentcf2c0212014-07-25 16:20:43 -0700441 uint32_t *latencyMs,
442 audio_output_flags_t flags) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200443 // creates a special output that is duplicated to the two outputs passed as arguments.
444 // The duplication is performed by a special mixer thread in the AudioFlinger.
445 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
446 audio_io_handle_t output2) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700447 // closes the output stream
448 virtual status_t closeOutput(audio_io_handle_t output) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200449 // suspends the output. When an output is suspended, the corresponding audio hardware output
450 // stream is placed in standby and the AudioTracks attached to the mixer thread are still
451 // processed but the output mix is discarded.
Eric Laurente552edb2014-03-10 17:42:56 -0700452 virtual status_t suspendOutput(audio_io_handle_t output) = 0;
453 // restores a suspended output.
454 virtual status_t restoreOutput(audio_io_handle_t output) = 0;
455
456 //
457 // Audio input Control functions
458 //
459
460 // opens an audio input
Eric Laurentcf2c0212014-07-25 16:20:43 -0700461 virtual status_t openInput(audio_module_handle_t module,
462 audio_io_handle_t *input,
463 audio_config_t *config,
464 audio_devices_t *device,
465 const String8& address,
466 audio_source_t source,
467 audio_input_flags_t flags) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700468 // closes an audio input
469 virtual status_t closeInput(audio_io_handle_t input) = 0;
470 //
471 // misc control functions
472 //
473
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200474 // set a stream volume for a particular output. For the same user setting, a given stream type
475 // can have different volumes
Eric Laurente552edb2014-03-10 17:42:56 -0700476 // for each output (destination device) it is attached to.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200477 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume,
478 audio_io_handle_t output, int delayMs = 0) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700479
480 // invalidate a stream type, causing a reroute to an unspecified new output
Eric Laurent3b73df72014-03-11 09:06:29 -0700481 virtual status_t invalidateStream(audio_stream_type_t stream) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700482
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200483 // function enabling to send proprietary informations directly from audio policy manager to
484 // audio hardware interface.
485 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs,
486 int delayMs = 0) = 0;
487 // function enabling to receive proprietary informations directly from audio hardware interface
488 // to audio policy manager.
Eric Laurente552edb2014-03-10 17:42:56 -0700489 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
490
Eric Laurente552edb2014-03-10 17:42:56 -0700491 // set down link audio volume.
492 virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
493
494 // move effect to the specified output
Glenn Kastend848eb42016-03-08 13:42:11 -0800495 virtual status_t moveEffects(audio_session_t session,
Eric Laurente552edb2014-03-10 17:42:56 -0700496 audio_io_handle_t srcOutput,
497 audio_io_handle_t dstOutput) = 0;
498
Eric Laurentb20cf7d2019-04-05 19:37:34 -0700499 virtual void setEffectSuspended(int effectId,
500 audio_session_t sessionId,
501 bool suspended) = 0;
502
Eric Laurent951f4552014-05-20 10:48:17 -0700503 /* Create a patch between several source and sink ports */
504 virtual status_t createAudioPatch(const struct audio_patch *patch,
505 audio_patch_handle_t *handle,
506 int delayMs) = 0;
507
508 /* Release a patch */
509 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
510 int delayMs) = 0;
511
Eric Laurente1715a42014-05-20 11:30:42 -0700512 /* Set audio port configuration */
513 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
514
Eric Laurentb52c1522014-05-20 11:27:36 -0700515 virtual void onAudioPortListUpdate() = 0;
516
517 virtual void onAudioPatchListUpdate() = 0;
Eric Laurentde3f8392014-07-27 18:38:22 -0700518
François Gaffiecfe17322018-11-07 13:41:29 +0100519 virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0;
520
Glenn Kastenf0c6d7d2016-02-26 10:44:04 -0800521 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0;
Jean-Michel Trivide801052015-04-14 19:10:14 -0700522
523 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
Jean-Michel Trivi2f4fe9f2015-12-04 16:20:59 -0800524
Jean-Michel Triviac4e4292016-12-22 11:39:31 -0800525 virtual void onRecordingConfigurationUpdate(int event,
Eric Laurenta9f86652018-11-28 17:23:11 -0800526 const record_client_info_t *clientInfo,
527 const audio_config_base_t *clientConfig,
528 std::vector<effect_descriptor_t> clientEffects,
529 const audio_config_base_t *deviceConfig,
530 std::vector<effect_descriptor_t> effects,
531 audio_patch_handle_t patchHandle,
532 audio_source_t source) = 0;
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700533
Jean-Michel Trivi9a6b9ad2020-10-22 16:46:43 -0700534 virtual void onRoutingUpdated() = 0;
535
Jean-Michel Trivi78f2b302022-04-15 18:18:41 +0000536 // Used to notify AudioService that an error was encountering when reading
537 // the volume ranges, and that they should be re-initialized
538 virtual void onVolumeRangeInitRequest() = 0;
539
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700540 // Used to notify the sound trigger module that an audio capture is about to
541 // take place. This should typically result in any active recognition
542 // sessions to be preempted on modules that do not support sound trigger
543 // recognition concurrently with audio capture.
544 virtual void setSoundTriggerCaptureState(bool active) = 0;
jiabinb4fed192020-09-22 14:45:40 -0700545
546 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
jiabin10a03f12021-05-07 23:46:28 +0000547
548 virtual status_t updateSecondaryOutputs(
549 const TrackSecondaryOutputsMap& trackSecondaryOutputs) = 0;
Mikhail Naganov516d3982022-02-01 23:53:59 +0000550
551 virtual status_t setDeviceConnectedState(const struct audio_port_v7 *port, bool connected) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700552};
553
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530554 // These are the signatures of createAudioPolicyManager/destroyAudioPolicyManager
555 // methods respectively, expected by AudioPolicyService, needs to be exposed by
556 // libaudiopolicymanagercustom.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200557 using CreateAudioPolicyManagerInstance =
558 AudioPolicyInterface* (*)(AudioPolicyClientInterface*);
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530559 using DestroyAudioPolicyManagerInstance = void (*)(AudioPolicyInterface*);
Eric Laurente552edb2014-03-10 17:42:56 -0700560
Mikhail Naganov1b2a7942017-12-08 10:18:09 -0800561} // namespace android
Eric Laurente552edb2014-03-10 17:42:56 -0700562
Eric Laurentdce54a12014-03-10 12:19:46 -0700563#endif // ANDROID_AUDIOPOLICY_INTERFACE_H