blob: 134d06842d708658b767ac885e69364928771cb8 [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
jiabinc0048632023-04-27 22:04:31 +000020#include <android/media/DeviceConnectedState.h>
jiabin10a03f12021-05-07 23:46:28 +000021#include <media/AudioCommonTypes.h>
Mikhail Naganov5478fc12021-07-08 16:13:29 -070022#include <media/AudioContainers.h>
jiabin05b5edd2019-11-04 14:10:42 -080023#include <media/AudioDeviceTypeAddr.h>
Eric Laurente552edb2014-03-10 17:42:56 -070024#include <media/AudioSystem.h>
Eric Laurentbaac1832014-12-01 17:52:59 -080025#include <media/AudioPolicy.h>
jiabin43810402019-10-24 14:58:31 -070026#include <media/DeviceDescriptorBase.h>
Svet Ganov3e5f14f2021-05-13 22:51:08 +000027#include <android/content/AttributionSourceState.h>
Eric Laurente552edb2014-03-10 17:42:56 -070028#include <utils/String8.h>
29
Eric Laurent3b73df72014-03-11 09:06:29 -070030namespace android {
Eric Laurente552edb2014-03-10 17:42:56 -070031
Svet Ganov3e5f14f2021-05-13 22:51:08 +000032using content::AttributionSourceState;
33
Eric Laurente552edb2014-03-10 17:42:56 -070034// ----------------------------------------------------------------------------
35
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020036// The AudioPolicyInterface and AudioPolicyClientInterface classes define the communication
37// interfaces between the platform specific audio policy manager and Android generic audio policy
38// manager.
39// The platform specific audio policy manager must implement methods of the AudioPolicyInterface
40// class.
Eric Laurente552edb2014-03-10 17:42:56 -070041// This implementation makes use of the AudioPolicyClientInterface to control the activity and
42// configuration of audio input and output streams.
43//
44// The platform specific audio policy manager is in charge of the audio routing and volume control
45// policies for a given platform.
46// The main roles of this module are:
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020047// - keep track of current system state (removable device connections, phone state,
48// user requests...).
49// System state changes and user actions are notified to audio policy manager with methods of the
50// AudioPolicyInterface.
Eric Laurente552edb2014-03-10 17:42:56 -070051// - process getOutput() queries received when AudioTrack objects are created: Those queries
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020052// return a handler on an output that has been selected, configured and opened by the audio
53// policy manager and that must be used by the AudioTrack when registering to the AudioFlinger
54// with the createTrack() method.
55// When the AudioTrack object is released, a putOutput() query is received and the audio policy
56// manager can decide to close or reconfigure the output depending on other streams using this
57// output and current system state.
58// - similarly process getInput() and putInput() queries received from AudioRecord objects and
59// configure audio inputs.
60// - process volume control requests: the stream volume is converted from an index value
61// (received from UI) to a float value applicable to each output as a function of platform
62// specificsettings and current output route (destination device). It also make sure that streams
63// are not muted if not allowed (e.g. camera shutter sound in some countries).
Eric Laurente552edb2014-03-10 17:42:56 -070064//
Eric Laurent0eb2f4a2021-10-05 13:57:18 +020065// The platform specific audio policy manager is provided as a shared library by platform vendors
66// (as for libaudio.so) and is linked with libaudioflinger.so
67//
68// NOTE: by convention, the implementation of the AudioPolicyInterface in AudioPolicyManager does
69// not have to perform any nullptr check on input arguments: The caller of this API is
70// AudioPolicyService running in the same process and in charge of validating arguments received
71// from incoming binder calls before calling AudioPolicyManager.
Eric Laurente552edb2014-03-10 17:42:56 -070072
73// Audio Policy Manager Interface
74class AudioPolicyInterface
75{
76
77public:
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080078 typedef enum {
79 API_INPUT_INVALID = -1,
80 API_INPUT_LEGACY = 0,// e.g. audio recording from a microphone
Kevin Rocard25f9b052019-02-27 15:08:54 -080081 API_INPUT_MIX_CAPTURE,// used for "remote submix" legacy mode (no DAP),
82 // capture of the media to play it remotely
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080083 API_INPUT_MIX_EXT_POLICY_REROUTE,// used for platform audio rerouting, where mixes are
84 // handled by external and dynamically installed
85 // policies which reroute audio mixes
Kevin Rocard25f9b052019-02-27 15:08:54 -080086 API_INPUT_MIX_PUBLIC_CAPTURE_PLAYBACK, // used for playback capture with a MediaProjection
Eric Laurent82db2692015-08-07 13:59:42 -070087 API_INPUT_TELEPHONY_RX, // used for capture from telephony RX path
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080088 } input_type_t;
89
Eric Laurent8a1095a2019-11-08 14:44:16 -080090 typedef enum {
91 API_OUTPUT_INVALID = -1,
92 API_OUTPUT_LEGACY = 0,// e.g. audio playing to speaker
93 API_OUT_MIX_PLAYBACK, // used for "remote submix" playback of audio from remote source
94 // to local capture
95 API_OUTPUT_TELEPHONY_TX, // used for playback to telephony TX path
96 } output_type_t;
97
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -080098public:
Eric Laurente552edb2014-03-10 17:42:56 -070099 virtual ~AudioPolicyInterface() {}
100 //
101 // configuration functions
102 //
103
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000104 // Informs APM that new HAL modules are available. This typically happens
105 // due to registration of an audio HAL service.
106 virtual void onNewAudioModulesAvailable() = 0;
107
Eric Laurente552edb2014-03-10 17:42:56 -0700108 // indicate a change in device connection status
Nathalie Le Clair88fa2752021-11-23 13:03:41 +0100109 virtual status_t setDeviceConnectionState(audio_policy_dev_state_t state,
110 const android::media::audio::common::AudioPort& port,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800111 audio_format_t encodedFormat) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700112 // retrieve a device connection status
Eric Laurent3b73df72014-03-11 09:06:29 -0700113 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200114 const char *device_address) = 0;
Pavlin Radoslavovf862bc62016-12-26 18:57:22 -0800115 // indicate a change in device configuration
116 virtual status_t handleDeviceConfigChange(audio_devices_t device,
117 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800118 const char *device_name,
119 audio_format_t encodedFormat) = 0;
Eric Laurent3b73df72014-03-11 09:06:29 -0700120 // indicate a change in phone state. Valid phones states are defined by audio_mode_t
121 virtual void setPhoneState(audio_mode_t state) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700122 // force using a specific device category for the specified usage
Eric Laurent3b73df72014-03-11 09:06:29 -0700123 virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700124 // retrieve current device category forced for a given usage
Eric Laurent3b73df72014-03-11 09:06:29 -0700125 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700126 // set a system property (e.g. camera sound always audible)
127 virtual void setSystemProperty(const char* property, const char* value) = 0;
128 // check proper initialization
129 virtual status_t initCheck() = 0;
130
131 //
132 // Audio routing query functions
133 //
134
135 // request an output appropriate for playback of the supplied stream type and parameters
Eric Laurentf4e63452017-11-06 19:31:46 +0000136 virtual audio_io_handle_t getOutput(audio_stream_type_t stream) = 0;
Eric Laurente83b55d2014-11-14 10:06:21 -0800137 virtual status_t getOutputForAttr(const audio_attributes_t *attr,
jiabinf1c73972022-04-14 16:28:52 -0700138 audio_io_handle_t *output,
139 audio_session_t session,
140 audio_stream_type_t *stream,
Eric Laurent0d13fea2022-11-04 17:12:08 +0100141 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700142 audio_config_t *config,
143 audio_output_flags_t *flags,
144 audio_port_handle_t *selectedDeviceId,
145 audio_port_handle_t *portId,
146 std::vector<audio_io_handle_t> *secondaryOutputs,
147 output_type_t *outputType,
jiabinc658e452022-10-21 20:52:21 +0000148 bool *isSpatialized,
149 bool *isBitPerfect) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200150 // indicates to the audio policy manager that the output starts being used by corresponding
151 // stream.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700152 virtual status_t startOutput(audio_port_handle_t portId) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200153 // indicates to the audio policy manager that the output stops being used by corresponding
154 // stream.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700155 virtual status_t stopOutput(audio_port_handle_t portId) = 0;
jiabinbce0c1d2020-10-05 11:20:18 -0700156 // releases the output, return true if the output descriptor is reopened.
157 virtual bool releaseOutput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700158
159 // request an input appropriate for record from the supplied device with supplied parameters.
Eric Laurentcaf7f482014-11-25 17:50:47 -0800160 virtual status_t getInputForAttr(const audio_attributes_t *attr,
161 audio_io_handle_t *input,
Mikhail Naganov2996f672019-04-18 12:29:59 -0700162 audio_unique_id_t riid,
Eric Laurentcaf7f482014-11-25 17:50:47 -0800163 audio_session_t session,
Eric Laurent0d13fea2022-11-04 17:12:08 +0100164 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700165 audio_config_base_t *config,
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -0800166 audio_input_flags_t flags,
Eric Laurent9ae8c592017-06-22 17:17:09 -0700167 audio_port_handle_t *selectedDeviceId,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800168 input_type_t *inputType,
169 audio_port_handle_t *portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700170 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800171 virtual status_t startInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700172 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700173 virtual status_t stopInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700174 // releases the input.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700175 virtual void releaseInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700176
177 //
178 // volume control functions
179 //
180
181 // initialises stream volume conversion parameters by specifying volume index range.
Eric Laurent3b73df72014-03-11 09:06:29 -0700182 virtual void initStreamVolume(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700183 int indexMin,
184 int indexMax) = 0;
185
186 // sets the new stream volume at a level corresponding to the supplied index for the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700187 // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700188 // setting volume for all devices
Eric Laurent3b73df72014-03-11 09:06:29 -0700189 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700190 int index,
191 audio_devices_t device) = 0;
192
193 // retrieve current volume index for the specified stream and the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700194 // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700195 // querying the volume of the active device.
Eric Laurent3b73df72014-03-11 09:06:29 -0700196 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700197 int *index,
198 audio_devices_t device) = 0;
199
François Gaffiecfe17322018-11-07 13:41:29 +0100200 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
201 int index,
202 audio_devices_t device) = 0;
203 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
204 int &index,
205 audio_devices_t device) = 0;
206
207 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr,
208 int &index) = 0;
209
210 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr,
211 int &index) = 0;
212
Eric Laurente552edb2014-03-10 17:42:56 -0700213 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800214 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700215
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800216 // retrieves the list of enabled output devices for the given audio attributes
217 virtual status_t getDevicesForAttributes(const audio_attributes_t &attr,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800218 AudioDeviceTypeAddrVector *devices,
219 bool forVolume) = 0;
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800220
Eric Laurente552edb2014-03-10 17:42:56 -0700221 // Audio effect management
222 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
223 virtual status_t registerEffect(const effect_descriptor_t *desc,
224 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800225 product_strategy_t strategy,
Eric Laurente552edb2014-03-10 17:42:56 -0700226 int session,
227 int id) = 0;
228 virtual status_t unregisterEffect(int id) = 0;
229 virtual status_t setEffectEnabled(int id, bool enabled) = 0;
Eric Laurent6c796322019-04-09 14:13:17 -0700230 virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700231
Eric Laurent3b73df72014-03-11 09:06:29 -0700232 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
233 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
234 uint32_t inPastMs = 0) const = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700235 virtual bool isSourceActive(audio_source_t source) const = 0;
236
237 //dump state
238 virtual status_t dump(int fd) = 0;
239
Kevin Rocardb99cc752019-03-21 20:52:24 -0700240 virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100241 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo) = 0;
Michael Chana94fbb22018-04-24 14:31:19 +1000242 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
243 const audio_attributes_t& attributes) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700244
245 virtual status_t listAudioPorts(audio_port_role_t role,
246 audio_port_type_t type,
247 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800248 struct audio_port_v7 *ports,
Eric Laurent6a94d692014-05-20 11:18:06 -0700249 unsigned int *generation) = 0;
Mikhail Naganov5edc5ed2023-03-23 14:52:15 -0700250 virtual status_t listDeclaredDevicePorts(media::AudioPortRole role,
251 std::vector<media::AudioPortFw>* result) = 0;
jiabin19cdba52020-11-24 11:28:58 -0800252 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700253 virtual status_t createAudioPatch(const struct audio_patch *patch,
254 audio_patch_handle_t *handle,
255 uid_t uid) = 0;
256 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
257 uid_t uid) = 0;
258 virtual status_t listAudioPatches(unsigned int *num_patches,
259 struct audio_patch *patches,
260 unsigned int *generation) = 0;
261 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700262 virtual void releaseResourcesForUid(uid_t uid) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700263
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700264 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
265 audio_io_handle_t *ioHandle,
266 audio_devices_t *device) = 0;
267
268 virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800269
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700270 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800271 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
Eric Laurent554a2772015-04-10 11:29:24 -0700272
jiabin6a02d532020-08-07 11:56:38 -0700273 virtual status_t setUidDeviceAffinities(uid_t uid, const AudioDeviceTypeAddrVector& devices)
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800274 = 0;
275 virtual status_t removeUidDeviceAffinities(uid_t uid) = 0;
276
Oscar Azucena90e77632019-11-27 17:12:28 -0800277 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700278 const AudioDeviceTypeAddrVector& devices) = 0;
Oscar Azucena90e77632019-11-27 17:12:28 -0800279 virtual status_t removeUserIdDeviceAffinities(int userId) = 0;
280
Eric Laurent554a2772015-04-10 11:29:24 -0700281 virtual status_t startAudioSource(const struct audio_port_config *source,
282 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700283 audio_port_handle_t *portId,
Eric Laurentd60560a2015-04-10 11:31:20 -0700284 uid_t uid) = 0;
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700285 virtual status_t stopAudioSource(audio_port_handle_t portId) = 0;
Andy Hung2ddee192015-12-18 17:34:44 -0800286
287 virtual status_t setMasterMono(bool mono) = 0;
288 virtual status_t getMasterMono(bool *mono) = 0;
Eric Laurentac9cef52017-06-09 15:46:26 -0700289
290 virtual float getStreamVolumeDB(
291 audio_stream_type_t stream, int index, audio_devices_t device) = 0;
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800292
jiabin81772902018-04-02 17:52:27 -0700293 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
294 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100295 bool *surroundFormatsEnabled) = 0;
296
297 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
298 audio_format_t *surroundFormats) = 0;
299
jiabin81772902018-04-02 17:52:27 -0700300 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0;
301
jiabin6012f912018-11-02 17:06:30 -0700302 virtual bool isHapticPlaybackSupported() = 0;
303
Carter Hsu325a8eb2022-01-19 19:56:51 +0800304 virtual bool isUltrasoundSupported() = 0;
305
Atneya Nair698f5ef2022-12-15 16:15:09 -0800306 virtual bool isHotwordStreamSupported(bool lookbackAudio) = 0;
307
Pattydd807582021-11-04 21:01:03 +0800308 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
309 audio_devices_t device, std::vector<audio_format_t> *formats) = 0;
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800310
Eric Laurent5ada82e2019-08-29 17:53:54 -0700311 virtual void setAppState(audio_port_handle_t portId, app_state_t state) = 0;
François Gaffied0ba9ed2018-11-05 11:50:42 +0100312
313 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0;
314
Francois Gaffie11b65922020-09-24 16:59:08 +0200315 virtual status_t getProductStrategyFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200316 const audio_attributes_t &aa, product_strategy_t &productStrategy,
Francois Gaffie11b65922020-09-24 16:59:08 +0200317 bool fallbackOnDefault) = 0;
François Gaffie4b2018b2018-11-07 11:18:59 +0100318
319 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0;
320
Francois Gaffie11b65922020-09-24 16:59:08 +0200321 virtual status_t getVolumeGroupFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200322 const audio_attributes_t &aa, volume_group_t &volumeGroup, bool fallbackOnDefault) = 0;
Eric Laurent8340e672019-11-06 11:01:08 -0800323
324 virtual bool isCallScreenModeSupported() = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700325
jiabin0a488932020-08-07 17:32:40 -0700326 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
327 device_role_t role,
328 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700329
jiabin0a488932020-08-07 17:32:40 -0700330 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
Paul Wang5d7cdb52022-11-22 09:45:06 +0000331 device_role_t role,
332 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700333
Paul Wang5d7cdb52022-11-22 09:45:06 +0000334 virtual status_t clearDevicesRoleForStrategy(product_strategy_t strategy,
335 device_role_t role) = 0;
jiabin0a488932020-08-07 17:32:40 -0700336
337 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
338 device_role_t role,
339 AudioDeviceTypeAddrVector &devices) = 0;
Jiabin Huang3b98d322020-09-03 17:54:16 +0000340
341 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
342 device_role_t role,
343 const AudioDeviceTypeAddrVector &devices) = 0;
344
345 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
346 device_role_t role,
347 const AudioDeviceTypeAddrVector &devices) = 0;
348
349 virtual status_t removeDevicesRoleForCapturePreset(
350 audio_source_t audioSource, device_role_t role,
351 const AudioDeviceTypeAddrVector& devices) = 0;
352
353 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
354 device_role_t role) = 0;
355
356 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
357 device_role_t role,
358 AudioDeviceTypeAddrVector &devices) = 0;
Eric Laurent81dd0f52021-07-05 11:54:40 +0200359
360 /**
361 * Queries if some kind of spatialization will be performed if the audio playback context
362 * described by the provided arguments is present.
363 * The context is made of:
364 * - The audio attributes describing the playback use case.
365 * - The audio configuration describing the audio format, channels, sampling rate ...
366 * - The devices describing the sink audio device selected for playback.
367 * All arguments are optional and only the specified arguments are used to match against
368 * supported criteria. For instance, supplying no argument will tell if spatialization is
369 * supported or not in general.
370 * @param attr audio attributes describing the playback use case
371 * @param config audio configuration describing the audio format, channels, sampling rate...
372 * @param devices the sink audio device selected for playback
373 * @return true if spatialization is enabled for this context,
374 * false otherwise
375 */
376 virtual bool canBeSpatialized(const audio_attributes_t *attr,
377 const audio_config_t *config,
378 const AudioDeviceTypeAddrVector &devices) const = 0;
379
380 /**
381 * Opens a specialized spatializer output if supported by the platform.
382 * If several spatializer output profiles exist, the one supporting the sink device
383 * corresponding to the provided audio attributes will be selected.
384 * Only one spatializer output stream can be opened at a time and an error is returned
385 * if one already exists.
386 * @param config audio format, channel mask and sampling rate to be used as the mixer
387 * configuration for the spatializer mixer created.
388 * @param attr audio attributes describing the playback use case that will drive the
389 * sink device selection
390 * @param output the IO handle of the output opened
391 * @return NO_ERROR if an output was opened, INVALID_OPERATION or BAD_VALUE otherwise
392 */
393 virtual status_t getSpatializerOutput(const audio_config_base_t *config,
394 const audio_attributes_t *attr,
395 audio_io_handle_t *output) = 0;
396
397 /**
398 * Closes a previously opened specialized spatializer output.
399 * @param output the IO handle of the output to close.
400 * @return NO_ERROR if an output was closed, INVALID_OPERATION or BAD_VALUE otherwise
401 */
402 virtual status_t releaseSpatializerOutput(audio_io_handle_t output) = 0;
jiabin2b9d5a12021-12-10 01:06:29 +0000403
404 /**
405 * Query how the direct playback is currently supported on the device.
406 * @param attr audio attributes describing the playback use case
407 * @param config audio configuration for the playback
408 * @param directMode out: a set of flags describing how the direct playback is currently
409 * supported on the device
410 * @return NO_ERROR in case of success, DEAD_OBJECT, NO_INIT, BAD_VALUE, PERMISSION_DENIED
411 * in case of error.
412 */
413 virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
414 const audio_config_t *config) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700415
Dorin Drimusf2196d82022-01-03 12:11:18 +0100416 // retrieves the list of available direct audio profiles for the given audio attributes
417 virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
418 AudioProfileVector& audioProfiles) = 0;
jiabina84c3d32022-12-02 18:59:55 +0000419
420 virtual status_t getSupportedMixerAttributes(
421 audio_port_handle_t portId, std::vector<audio_mixer_attributes_t>& mixerAttrs) = 0;
422 virtual status_t setPreferredMixerAttributes(
423 const audio_attributes_t* attr,
424 audio_port_handle_t portId,
425 uid_t uid,
426 const audio_mixer_attributes_t* mixerAttributes) = 0;
427 virtual status_t getPreferredMixerAttributes(const audio_attributes_t* attr,
428 audio_port_handle_t portId,
429 audio_mixer_attributes_t* mixerAttributes) = 0;
430 virtual status_t clearPreferredMixerAttributes(const audio_attributes_t* attr,
431 audio_port_handle_t portId,
432 uid_t uid) = 0;
Dorin Drimusf2196d82022-01-03 12:11:18 +0100433};
Eric Laurente552edb2014-03-10 17:42:56 -0700434
435// Audio Policy client Interface
436class AudioPolicyClientInterface
437{
438public:
439 virtual ~AudioPolicyClientInterface() {}
440
441 //
442 // Audio HW module functions
443 //
444
445 // loads a HW module.
446 virtual audio_module_handle_t loadHwModule(const char *name) = 0;
447
448 //
449 // Audio output Control functions
450 //
451
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200452 // opens an audio output with the requested parameters. The parameter values can indicate to
453 // use the default values in case the audio policy manager has no specific requirements for the
454 // output being opened.
455 // When the function returns, the parameter values reflect the actual values used by the audio
456 // hardware output stream.
457 // The audio policy manager can check if the proposed parameters are suitable or not and act
458 // accordingly.
Eric Laurentcf2c0212014-07-25 16:20:43 -0700459 virtual status_t openOutput(audio_module_handle_t module,
460 audio_io_handle_t *output,
Eric Laurentf1f22e72021-07-13 14:04:14 +0200461 audio_config_t *halConfig,
462 audio_config_base_t *mixerConfig,
jiabin43810402019-10-24 14:58:31 -0700463 const sp<DeviceDescriptorBase>& device,
Eric Laurentcf2c0212014-07-25 16:20:43 -0700464 uint32_t *latencyMs,
465 audio_output_flags_t flags) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200466 // creates a special output that is duplicated to the two outputs passed as arguments.
467 // The duplication is performed by a special mixer thread in the AudioFlinger.
468 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
469 audio_io_handle_t output2) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700470 // closes the output stream
471 virtual status_t closeOutput(audio_io_handle_t output) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200472 // suspends the output. When an output is suspended, the corresponding audio hardware output
473 // stream is placed in standby and the AudioTracks attached to the mixer thread are still
474 // processed but the output mix is discarded.
Eric Laurente552edb2014-03-10 17:42:56 -0700475 virtual status_t suspendOutput(audio_io_handle_t output) = 0;
476 // restores a suspended output.
477 virtual status_t restoreOutput(audio_io_handle_t output) = 0;
478
479 //
480 // Audio input Control functions
481 //
482
483 // opens an audio input
Eric Laurentcf2c0212014-07-25 16:20:43 -0700484 virtual status_t openInput(audio_module_handle_t module,
485 audio_io_handle_t *input,
486 audio_config_t *config,
487 audio_devices_t *device,
488 const String8& address,
489 audio_source_t source,
490 audio_input_flags_t flags) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700491 // closes an audio input
492 virtual status_t closeInput(audio_io_handle_t input) = 0;
493 //
494 // misc control functions
495 //
496
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200497 // set a stream volume for a particular output. For the same user setting, a given stream type
498 // can have different volumes
Eric Laurente552edb2014-03-10 17:42:56 -0700499 // for each output (destination device) it is attached to.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200500 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume,
501 audio_io_handle_t output, int delayMs = 0) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700502
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200503 // function enabling to send proprietary informations directly from audio policy manager to
504 // audio hardware interface.
505 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs,
506 int delayMs = 0) = 0;
507 // function enabling to receive proprietary informations directly from audio hardware interface
508 // to audio policy manager.
Eric Laurente552edb2014-03-10 17:42:56 -0700509 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
510
Eric Laurente552edb2014-03-10 17:42:56 -0700511 // set down link audio volume.
512 virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
513
514 // move effect to the specified output
Glenn Kastend848eb42016-03-08 13:42:11 -0800515 virtual status_t moveEffects(audio_session_t session,
Eric Laurente552edb2014-03-10 17:42:56 -0700516 audio_io_handle_t srcOutput,
517 audio_io_handle_t dstOutput) = 0;
518
Eric Laurentb20cf7d2019-04-05 19:37:34 -0700519 virtual void setEffectSuspended(int effectId,
520 audio_session_t sessionId,
521 bool suspended) = 0;
522
Eric Laurent951f4552014-05-20 10:48:17 -0700523 /* Create a patch between several source and sink ports */
524 virtual status_t createAudioPatch(const struct audio_patch *patch,
525 audio_patch_handle_t *handle,
526 int delayMs) = 0;
527
528 /* Release a patch */
529 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
530 int delayMs) = 0;
531
Eric Laurente1715a42014-05-20 11:30:42 -0700532 /* Set audio port configuration */
533 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
534
Eric Laurentb52c1522014-05-20 11:27:36 -0700535 virtual void onAudioPortListUpdate() = 0;
536
537 virtual void onAudioPatchListUpdate() = 0;
Eric Laurentde3f8392014-07-27 18:38:22 -0700538
François Gaffiecfe17322018-11-07 13:41:29 +0100539 virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0;
540
Glenn Kastenf0c6d7d2016-02-26 10:44:04 -0800541 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0;
Jean-Michel Trivide801052015-04-14 19:10:14 -0700542
543 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
Jean-Michel Trivi2f4fe9f2015-12-04 16:20:59 -0800544
Jean-Michel Triviac4e4292016-12-22 11:39:31 -0800545 virtual void onRecordingConfigurationUpdate(int event,
Eric Laurenta9f86652018-11-28 17:23:11 -0800546 const record_client_info_t *clientInfo,
547 const audio_config_base_t *clientConfig,
548 std::vector<effect_descriptor_t> clientEffects,
549 const audio_config_base_t *deviceConfig,
550 std::vector<effect_descriptor_t> effects,
551 audio_patch_handle_t patchHandle,
552 audio_source_t source) = 0;
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700553
Jean-Michel Trivi9a6b9ad2020-10-22 16:46:43 -0700554 virtual void onRoutingUpdated() = 0;
555
Jean-Michel Trivi78f2b302022-04-15 18:18:41 +0000556 // Used to notify AudioService that an error was encountering when reading
557 // the volume ranges, and that they should be re-initialized
558 virtual void onVolumeRangeInitRequest() = 0;
559
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700560 // Used to notify the sound trigger module that an audio capture is about to
561 // take place. This should typically result in any active recognition
562 // sessions to be preempted on modules that do not support sound trigger
563 // recognition concurrently with audio capture.
564 virtual void setSoundTriggerCaptureState(bool active) = 0;
jiabinb4fed192020-09-22 14:45:40 -0700565
566 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
jiabin10a03f12021-05-07 23:46:28 +0000567
568 virtual status_t updateSecondaryOutputs(
569 const TrackSecondaryOutputsMap& trackSecondaryOutputs) = 0;
Mikhail Naganov516d3982022-02-01 23:53:59 +0000570
jiabinc0048632023-04-27 22:04:31 +0000571 virtual status_t setDeviceConnectedState(const struct audio_port_v7 *port,
572 media::DeviceConnectedState state) = 0;
jiabinc44b3462022-12-08 12:52:31 -0800573
574 virtual status_t invalidateTracks(const std::vector<audio_port_handle_t>& portIds) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700575};
576
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530577 // These are the signatures of createAudioPolicyManager/destroyAudioPolicyManager
578 // methods respectively, expected by AudioPolicyService, needs to be exposed by
579 // libaudiopolicymanagercustom.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200580 using CreateAudioPolicyManagerInstance =
581 AudioPolicyInterface* (*)(AudioPolicyClientInterface*);
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530582 using DestroyAudioPolicyManagerInstance = void (*)(AudioPolicyInterface*);
Eric Laurente552edb2014-03-10 17:42:56 -0700583
Mikhail Naganov1b2a7942017-12-08 10:18:09 -0800584} // namespace android
Eric Laurente552edb2014-03-10 17:42:56 -0700585
Eric Laurentdce54a12014-03-10 12:19:46 -0700586#endif // ANDROID_AUDIOPOLICY_INTERFACE_H