blob: 3d1cf76b0c72a56179500bad45b401a7584ab179 [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,
Eric Laurent0d13fea2022-11-04 17:12:08 +0100140 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700141 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,
jiabinc658e452022-10-21 20:52:21 +0000147 bool *isSpatialized,
148 bool *isBitPerfect) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200149 // indicates to the audio policy manager that the output starts being used by corresponding
150 // stream.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700151 virtual status_t startOutput(audio_port_handle_t portId) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200152 // indicates to the audio policy manager that the output stops being used by corresponding
153 // stream.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700154 virtual status_t stopOutput(audio_port_handle_t portId) = 0;
jiabinbce0c1d2020-10-05 11:20:18 -0700155 // releases the output, return true if the output descriptor is reopened.
156 virtual bool releaseOutput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700157
158 // request an input appropriate for record from the supplied device with supplied parameters.
Eric Laurentcaf7f482014-11-25 17:50:47 -0800159 virtual status_t getInputForAttr(const audio_attributes_t *attr,
160 audio_io_handle_t *input,
Mikhail Naganov2996f672019-04-18 12:29:59 -0700161 audio_unique_id_t riid,
Eric Laurentcaf7f482014-11-25 17:50:47 -0800162 audio_session_t session,
Eric Laurent0d13fea2022-11-04 17:12:08 +0100163 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700164 audio_config_base_t *config,
Jean-Michel Trivi97bb33f2014-12-12 16:23:43 -0800165 audio_input_flags_t flags,
Eric Laurent9ae8c592017-06-22 17:17:09 -0700166 audio_port_handle_t *selectedDeviceId,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800167 input_type_t *inputType,
168 audio_port_handle_t *portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700169 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800170 virtual status_t startInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700171 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700172 virtual status_t stopInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700173 // releases the input.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700174 virtual void releaseInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700175
176 //
177 // volume control functions
178 //
179
180 // initialises stream volume conversion parameters by specifying volume index range.
Eric Laurent3b73df72014-03-11 09:06:29 -0700181 virtual void initStreamVolume(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700182 int indexMin,
183 int indexMax) = 0;
184
185 // sets the new stream volume at a level corresponding to the supplied index for the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700186 // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700187 // setting volume for all devices
Eric Laurent3b73df72014-03-11 09:06:29 -0700188 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700189 int index,
190 audio_devices_t device) = 0;
191
192 // retrieve current volume index for the specified stream and the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700193 // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700194 // querying the volume of the active device.
Eric Laurent3b73df72014-03-11 09:06:29 -0700195 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700196 int *index,
197 audio_devices_t device) = 0;
198
François Gaffiecfe17322018-11-07 13:41:29 +0100199 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
200 int index,
201 audio_devices_t device) = 0;
202 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
203 int &index,
204 audio_devices_t device) = 0;
205
206 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr,
207 int &index) = 0;
208
209 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr,
210 int &index) = 0;
211
Eric Laurente552edb2014-03-10 17:42:56 -0700212 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800213 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700214
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800215 // retrieves the list of enabled output devices for the given audio attributes
216 virtual status_t getDevicesForAttributes(const audio_attributes_t &attr,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800217 AudioDeviceTypeAddrVector *devices,
218 bool forVolume) = 0;
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800219
Eric Laurente552edb2014-03-10 17:42:56 -0700220 // Audio effect management
221 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
222 virtual status_t registerEffect(const effect_descriptor_t *desc,
223 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800224 product_strategy_t strategy,
Eric Laurente552edb2014-03-10 17:42:56 -0700225 int session,
226 int id) = 0;
227 virtual status_t unregisterEffect(int id) = 0;
228 virtual status_t setEffectEnabled(int id, bool enabled) = 0;
Eric Laurent6c796322019-04-09 14:13:17 -0700229 virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700230
Eric Laurent3b73df72014-03-11 09:06:29 -0700231 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
232 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
233 uint32_t inPastMs = 0) const = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700234 virtual bool isSourceActive(audio_source_t source) const = 0;
235
236 //dump state
237 virtual status_t dump(int fd) = 0;
238
Kevin Rocardb99cc752019-03-21 20:52:24 -0700239 virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100240 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo) = 0;
Michael Chana94fbb22018-04-24 14:31:19 +1000241 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
242 const audio_attributes_t& attributes) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700243
244 virtual status_t listAudioPorts(audio_port_role_t role,
245 audio_port_type_t type,
246 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800247 struct audio_port_v7 *ports,
Eric Laurent6a94d692014-05-20 11:18:06 -0700248 unsigned int *generation) = 0;
Mikhail Naganov5edc5ed2023-03-23 14:52:15 -0700249 virtual status_t listDeclaredDevicePorts(media::AudioPortRole role,
250 std::vector<media::AudioPortFw>* result) = 0;
jiabin19cdba52020-11-24 11:28:58 -0800251 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700252 virtual status_t createAudioPatch(const struct audio_patch *patch,
253 audio_patch_handle_t *handle,
254 uid_t uid) = 0;
255 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
256 uid_t uid) = 0;
257 virtual status_t listAudioPatches(unsigned int *num_patches,
258 struct audio_patch *patches,
259 unsigned int *generation) = 0;
260 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700261 virtual void releaseResourcesForUid(uid_t uid) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700262
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700263 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
264 audio_io_handle_t *ioHandle,
265 audio_devices_t *device) = 0;
266
267 virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800268
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700269 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800270 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
Eric Laurent554a2772015-04-10 11:29:24 -0700271
jiabin6a02d532020-08-07 11:56:38 -0700272 virtual status_t setUidDeviceAffinities(uid_t uid, const AudioDeviceTypeAddrVector& devices)
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800273 = 0;
274 virtual status_t removeUidDeviceAffinities(uid_t uid) = 0;
275
Oscar Azucena90e77632019-11-27 17:12:28 -0800276 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700277 const AudioDeviceTypeAddrVector& devices) = 0;
Oscar Azucena90e77632019-11-27 17:12:28 -0800278 virtual status_t removeUserIdDeviceAffinities(int userId) = 0;
279
Eric Laurent554a2772015-04-10 11:29:24 -0700280 virtual status_t startAudioSource(const struct audio_port_config *source,
281 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700282 audio_port_handle_t *portId,
Eric Laurentd60560a2015-04-10 11:31:20 -0700283 uid_t uid) = 0;
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700284 virtual status_t stopAudioSource(audio_port_handle_t portId) = 0;
Andy Hung2ddee192015-12-18 17:34:44 -0800285
286 virtual status_t setMasterMono(bool mono) = 0;
287 virtual status_t getMasterMono(bool *mono) = 0;
Eric Laurentac9cef52017-06-09 15:46:26 -0700288
289 virtual float getStreamVolumeDB(
290 audio_stream_type_t stream, int index, audio_devices_t device) = 0;
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800291
jiabin81772902018-04-02 17:52:27 -0700292 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
293 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100294 bool *surroundFormatsEnabled) = 0;
295
296 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
297 audio_format_t *surroundFormats) = 0;
298
jiabin81772902018-04-02 17:52:27 -0700299 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0;
300
jiabin6012f912018-11-02 17:06:30 -0700301 virtual bool isHapticPlaybackSupported() = 0;
302
Carter Hsu325a8eb2022-01-19 19:56:51 +0800303 virtual bool isUltrasoundSupported() = 0;
304
Atneya Nair698f5ef2022-12-15 16:15:09 -0800305 virtual bool isHotwordStreamSupported(bool lookbackAudio) = 0;
306
Pattydd807582021-11-04 21:01:03 +0800307 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
308 audio_devices_t device, std::vector<audio_format_t> *formats) = 0;
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800309
Eric Laurent5ada82e2019-08-29 17:53:54 -0700310 virtual void setAppState(audio_port_handle_t portId, app_state_t state) = 0;
François Gaffied0ba9ed2018-11-05 11:50:42 +0100311
312 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0;
313
Francois Gaffie11b65922020-09-24 16:59:08 +0200314 virtual status_t getProductStrategyFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200315 const audio_attributes_t &aa, product_strategy_t &productStrategy,
Francois Gaffie11b65922020-09-24 16:59:08 +0200316 bool fallbackOnDefault) = 0;
François Gaffie4b2018b2018-11-07 11:18:59 +0100317
318 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0;
319
Francois Gaffie11b65922020-09-24 16:59:08 +0200320 virtual status_t getVolumeGroupFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200321 const audio_attributes_t &aa, volume_group_t &volumeGroup, bool fallbackOnDefault) = 0;
Eric Laurent8340e672019-11-06 11:01:08 -0800322
323 virtual bool isCallScreenModeSupported() = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700324
jiabin0a488932020-08-07 17:32:40 -0700325 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
326 device_role_t role,
327 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700328
jiabin0a488932020-08-07 17:32:40 -0700329 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
Paul Wang5d7cdb52022-11-22 09:45:06 +0000330 device_role_t role,
331 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700332
Paul Wang5d7cdb52022-11-22 09:45:06 +0000333 virtual status_t clearDevicesRoleForStrategy(product_strategy_t strategy,
334 device_role_t role) = 0;
jiabin0a488932020-08-07 17:32:40 -0700335
336 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
337 device_role_t role,
338 AudioDeviceTypeAddrVector &devices) = 0;
Jiabin Huang3b98d322020-09-03 17:54:16 +0000339
340 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
341 device_role_t role,
342 const AudioDeviceTypeAddrVector &devices) = 0;
343
344 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
345 device_role_t role,
346 const AudioDeviceTypeAddrVector &devices) = 0;
347
348 virtual status_t removeDevicesRoleForCapturePreset(
349 audio_source_t audioSource, device_role_t role,
350 const AudioDeviceTypeAddrVector& devices) = 0;
351
352 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
353 device_role_t role) = 0;
354
355 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
356 device_role_t role,
357 AudioDeviceTypeAddrVector &devices) = 0;
Eric Laurent81dd0f52021-07-05 11:54:40 +0200358
359 /**
360 * Queries if some kind of spatialization will be performed if the audio playback context
361 * described by the provided arguments is present.
362 * The context is made of:
363 * - The audio attributes describing the playback use case.
364 * - The audio configuration describing the audio format, channels, sampling rate ...
365 * - The devices describing the sink audio device selected for playback.
366 * All arguments are optional and only the specified arguments are used to match against
367 * supported criteria. For instance, supplying no argument will tell if spatialization is
368 * supported or not in general.
369 * @param attr audio attributes describing the playback use case
370 * @param config audio configuration describing the audio format, channels, sampling rate...
371 * @param devices the sink audio device selected for playback
372 * @return true if spatialization is enabled for this context,
373 * false otherwise
374 */
375 virtual bool canBeSpatialized(const audio_attributes_t *attr,
376 const audio_config_t *config,
377 const AudioDeviceTypeAddrVector &devices) const = 0;
378
379 /**
380 * Opens a specialized spatializer output if supported by the platform.
381 * If several spatializer output profiles exist, the one supporting the sink device
382 * corresponding to the provided audio attributes will be selected.
383 * Only one spatializer output stream can be opened at a time and an error is returned
384 * if one already exists.
385 * @param config audio format, channel mask and sampling rate to be used as the mixer
386 * configuration for the spatializer mixer created.
387 * @param attr audio attributes describing the playback use case that will drive the
388 * sink device selection
389 * @param output the IO handle of the output opened
390 * @return NO_ERROR if an output was opened, INVALID_OPERATION or BAD_VALUE otherwise
391 */
392 virtual status_t getSpatializerOutput(const audio_config_base_t *config,
393 const audio_attributes_t *attr,
394 audio_io_handle_t *output) = 0;
395
396 /**
397 * Closes a previously opened specialized spatializer output.
398 * @param output the IO handle of the output to close.
399 * @return NO_ERROR if an output was closed, INVALID_OPERATION or BAD_VALUE otherwise
400 */
401 virtual status_t releaseSpatializerOutput(audio_io_handle_t output) = 0;
jiabin2b9d5a12021-12-10 01:06:29 +0000402
403 /**
404 * Query how the direct playback is currently supported on the device.
405 * @param attr audio attributes describing the playback use case
406 * @param config audio configuration for the playback
407 * @param directMode out: a set of flags describing how the direct playback is currently
408 * supported on the device
409 * @return NO_ERROR in case of success, DEAD_OBJECT, NO_INIT, BAD_VALUE, PERMISSION_DENIED
410 * in case of error.
411 */
412 virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
413 const audio_config_t *config) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700414
Dorin Drimusf2196d82022-01-03 12:11:18 +0100415 // retrieves the list of available direct audio profiles for the given audio attributes
416 virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
417 AudioProfileVector& audioProfiles) = 0;
jiabina84c3d32022-12-02 18:59:55 +0000418
419 virtual status_t getSupportedMixerAttributes(
420 audio_port_handle_t portId, std::vector<audio_mixer_attributes_t>& mixerAttrs) = 0;
421 virtual status_t setPreferredMixerAttributes(
422 const audio_attributes_t* attr,
423 audio_port_handle_t portId,
424 uid_t uid,
425 const audio_mixer_attributes_t* mixerAttributes) = 0;
426 virtual status_t getPreferredMixerAttributes(const audio_attributes_t* attr,
427 audio_port_handle_t portId,
428 audio_mixer_attributes_t* mixerAttributes) = 0;
429 virtual status_t clearPreferredMixerAttributes(const audio_attributes_t* attr,
430 audio_port_handle_t portId,
431 uid_t uid) = 0;
Dorin Drimusf2196d82022-01-03 12:11:18 +0100432};
Eric Laurente552edb2014-03-10 17:42:56 -0700433
434// Audio Policy client Interface
435class AudioPolicyClientInterface
436{
437public:
438 virtual ~AudioPolicyClientInterface() {}
439
440 //
441 // Audio HW module functions
442 //
443
444 // loads a HW module.
445 virtual audio_module_handle_t loadHwModule(const char *name) = 0;
446
447 //
448 // Audio output Control functions
449 //
450
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200451 // opens an audio output with the requested parameters. The parameter values can indicate to
452 // use the default values in case the audio policy manager has no specific requirements for the
453 // output being opened.
454 // When the function returns, the parameter values reflect the actual values used by the audio
455 // hardware output stream.
456 // The audio policy manager can check if the proposed parameters are suitable or not and act
457 // accordingly.
Eric Laurentcf2c0212014-07-25 16:20:43 -0700458 virtual status_t openOutput(audio_module_handle_t module,
459 audio_io_handle_t *output,
Eric Laurentf1f22e72021-07-13 14:04:14 +0200460 audio_config_t *halConfig,
461 audio_config_base_t *mixerConfig,
jiabin43810402019-10-24 14:58:31 -0700462 const sp<DeviceDescriptorBase>& device,
Eric Laurentcf2c0212014-07-25 16:20:43 -0700463 uint32_t *latencyMs,
464 audio_output_flags_t flags) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200465 // creates a special output that is duplicated to the two outputs passed as arguments.
466 // The duplication is performed by a special mixer thread in the AudioFlinger.
467 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
468 audio_io_handle_t output2) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700469 // closes the output stream
470 virtual status_t closeOutput(audio_io_handle_t output) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200471 // suspends the output. When an output is suspended, the corresponding audio hardware output
472 // stream is placed in standby and the AudioTracks attached to the mixer thread are still
473 // processed but the output mix is discarded.
Eric Laurente552edb2014-03-10 17:42:56 -0700474 virtual status_t suspendOutput(audio_io_handle_t output) = 0;
475 // restores a suspended output.
476 virtual status_t restoreOutput(audio_io_handle_t output) = 0;
477
478 //
479 // Audio input Control functions
480 //
481
482 // opens an audio input
Eric Laurentcf2c0212014-07-25 16:20:43 -0700483 virtual status_t openInput(audio_module_handle_t module,
484 audio_io_handle_t *input,
485 audio_config_t *config,
486 audio_devices_t *device,
487 const String8& address,
488 audio_source_t source,
489 audio_input_flags_t flags) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700490 // closes an audio input
491 virtual status_t closeInput(audio_io_handle_t input) = 0;
492 //
493 // misc control functions
494 //
495
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200496 // set a stream volume for a particular output. For the same user setting, a given stream type
497 // can have different volumes
Eric Laurente552edb2014-03-10 17:42:56 -0700498 // for each output (destination device) it is attached to.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200499 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume,
500 audio_io_handle_t output, int delayMs = 0) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700501
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200502 // function enabling to send proprietary informations directly from audio policy manager to
503 // audio hardware interface.
504 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs,
505 int delayMs = 0) = 0;
506 // function enabling to receive proprietary informations directly from audio hardware interface
507 // to audio policy manager.
Eric Laurente552edb2014-03-10 17:42:56 -0700508 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
509
Eric Laurente552edb2014-03-10 17:42:56 -0700510 // set down link audio volume.
511 virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
512
513 // move effect to the specified output
Glenn Kastend848eb42016-03-08 13:42:11 -0800514 virtual status_t moveEffects(audio_session_t session,
Eric Laurente552edb2014-03-10 17:42:56 -0700515 audio_io_handle_t srcOutput,
516 audio_io_handle_t dstOutput) = 0;
517
Eric Laurentb20cf7d2019-04-05 19:37:34 -0700518 virtual void setEffectSuspended(int effectId,
519 audio_session_t sessionId,
520 bool suspended) = 0;
521
Eric Laurent951f4552014-05-20 10:48:17 -0700522 /* Create a patch between several source and sink ports */
523 virtual status_t createAudioPatch(const struct audio_patch *patch,
524 audio_patch_handle_t *handle,
525 int delayMs) = 0;
526
527 /* Release a patch */
528 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
529 int delayMs) = 0;
530
Eric Laurente1715a42014-05-20 11:30:42 -0700531 /* Set audio port configuration */
532 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
533
Eric Laurentb52c1522014-05-20 11:27:36 -0700534 virtual void onAudioPortListUpdate() = 0;
535
536 virtual void onAudioPatchListUpdate() = 0;
Eric Laurentde3f8392014-07-27 18:38:22 -0700537
François Gaffiecfe17322018-11-07 13:41:29 +0100538 virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0;
539
Glenn Kastenf0c6d7d2016-02-26 10:44:04 -0800540 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0;
Jean-Michel Trivide801052015-04-14 19:10:14 -0700541
542 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
Jean-Michel Trivi2f4fe9f2015-12-04 16:20:59 -0800543
Jean-Michel Triviac4e4292016-12-22 11:39:31 -0800544 virtual void onRecordingConfigurationUpdate(int event,
Eric Laurenta9f86652018-11-28 17:23:11 -0800545 const record_client_info_t *clientInfo,
546 const audio_config_base_t *clientConfig,
547 std::vector<effect_descriptor_t> clientEffects,
548 const audio_config_base_t *deviceConfig,
549 std::vector<effect_descriptor_t> effects,
550 audio_patch_handle_t patchHandle,
551 audio_source_t source) = 0;
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700552
Jean-Michel Trivi9a6b9ad2020-10-22 16:46:43 -0700553 virtual void onRoutingUpdated() = 0;
554
Jean-Michel Trivi78f2b302022-04-15 18:18:41 +0000555 // Used to notify AudioService that an error was encountering when reading
556 // the volume ranges, and that they should be re-initialized
557 virtual void onVolumeRangeInitRequest() = 0;
558
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700559 // Used to notify the sound trigger module that an audio capture is about to
560 // take place. This should typically result in any active recognition
561 // sessions to be preempted on modules that do not support sound trigger
562 // recognition concurrently with audio capture.
563 virtual void setSoundTriggerCaptureState(bool active) = 0;
jiabinb4fed192020-09-22 14:45:40 -0700564
565 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
jiabin10a03f12021-05-07 23:46:28 +0000566
567 virtual status_t updateSecondaryOutputs(
568 const TrackSecondaryOutputsMap& trackSecondaryOutputs) = 0;
Mikhail Naganov516d3982022-02-01 23:53:59 +0000569
570 virtual status_t setDeviceConnectedState(const struct audio_port_v7 *port, bool connected) = 0;
jiabinc44b3462022-12-08 12:52:31 -0800571
572 virtual status_t invalidateTracks(const std::vector<audio_port_handle_t>& portIds) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700573};
574
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530575 // These are the signatures of createAudioPolicyManager/destroyAudioPolicyManager
576 // methods respectively, expected by AudioPolicyService, needs to be exposed by
577 // libaudiopolicymanagercustom.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200578 using CreateAudioPolicyManagerInstance =
579 AudioPolicyInterface* (*)(AudioPolicyClientInterface*);
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530580 using DestroyAudioPolicyManagerInstance = void (*)(AudioPolicyInterface*);
Eric Laurente552edb2014-03-10 17:42:56 -0700581
Mikhail Naganov1b2a7942017-12-08 10:18:09 -0800582} // namespace android
Eric Laurente552edb2014-03-10 17:42:56 -0700583
Eric Laurentdce54a12014-03-10 12:19:46 -0700584#endif // ANDROID_AUDIOPOLICY_INTERFACE_H