blob: 8f17ffc1b6f2bb2c73e7b5faf6e0bed00812b5e4 [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,
Marvin Ramine5a122d2023-12-07 13:57:59 +0100169 audio_port_handle_t *portId,
170 uint32_t *virtualDeviceId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700171 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800172 virtual status_t startInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700173 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700174 virtual status_t stopInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700175 // releases the input.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700176 virtual void releaseInput(audio_port_handle_t portId) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700177
178 //
179 // volume control functions
180 //
181
182 // initialises stream volume conversion parameters by specifying volume index range.
Eric Laurent3b73df72014-03-11 09:06:29 -0700183 virtual void initStreamVolume(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700184 int indexMin,
185 int indexMax) = 0;
186
187 // sets the new stream volume at a level corresponding to the supplied index for the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700188 // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700189 // setting volume for all devices
Eric Laurent3b73df72014-03-11 09:06:29 -0700190 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700191 int index,
192 audio_devices_t device) = 0;
193
194 // retrieve current volume index for the specified stream and the
Eric Laurent5a2b6292016-04-14 18:05:57 -0700195 // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means
Eric Laurente552edb2014-03-10 17:42:56 -0700196 // querying the volume of the active device.
Eric Laurent3b73df72014-03-11 09:06:29 -0700197 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
Eric Laurente552edb2014-03-10 17:42:56 -0700198 int *index,
199 audio_devices_t device) = 0;
200
François Gaffiecfe17322018-11-07 13:41:29 +0100201 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
202 int index,
203 audio_devices_t device) = 0;
204 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
205 int &index,
206 audio_devices_t device) = 0;
207
208 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr,
209 int &index) = 0;
210
211 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr,
212 int &index) = 0;
213
Eric Laurente552edb2014-03-10 17:42:56 -0700214 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800215 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700216
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800217 // retrieves the list of enabled output devices for the given audio attributes
218 virtual status_t getDevicesForAttributes(const audio_attributes_t &attr,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800219 AudioDeviceTypeAddrVector *devices,
220 bool forVolume) = 0;
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800221
Eric Laurente552edb2014-03-10 17:42:56 -0700222 // Audio effect management
223 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0;
224 virtual status_t registerEffect(const effect_descriptor_t *desc,
225 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800226 product_strategy_t strategy,
Eric Laurente552edb2014-03-10 17:42:56 -0700227 int session,
228 int id) = 0;
229 virtual status_t unregisterEffect(int id) = 0;
230 virtual status_t setEffectEnabled(int id, bool enabled) = 0;
Eric Laurent6c796322019-04-09 14:13:17 -0700231 virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700232
Eric Laurent3b73df72014-03-11 09:06:29 -0700233 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0;
234 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
235 uint32_t inPastMs = 0) const = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700236 virtual bool isSourceActive(audio_source_t source) const = 0;
237
238 //dump state
239 virtual status_t dump(int fd) = 0;
240
Kevin Rocardb99cc752019-03-21 20:52:24 -0700241 virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100242 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo) = 0;
Michael Chana94fbb22018-04-24 14:31:19 +1000243 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
244 const audio_attributes_t& attributes) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700245
246 virtual status_t listAudioPorts(audio_port_role_t role,
247 audio_port_type_t type,
248 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800249 struct audio_port_v7 *ports,
Eric Laurent6a94d692014-05-20 11:18:06 -0700250 unsigned int *generation) = 0;
Mikhail Naganov5edc5ed2023-03-23 14:52:15 -0700251 virtual status_t listDeclaredDevicePorts(media::AudioPortRole role,
252 std::vector<media::AudioPortFw>* result) = 0;
jiabin19cdba52020-11-24 11:28:58 -0800253 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700254 virtual status_t createAudioPatch(const struct audio_patch *patch,
255 audio_patch_handle_t *handle,
256 uid_t uid) = 0;
257 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
258 uid_t uid) = 0;
259 virtual status_t listAudioPatches(unsigned int *num_patches,
260 struct audio_patch *patches,
261 unsigned int *generation) = 0;
262 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0;
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700263 virtual void releaseResourcesForUid(uid_t uid) = 0;
Eric Laurent6a94d692014-05-20 11:18:06 -0700264
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700265 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
266 audio_io_handle_t *ioHandle,
267 audio_devices_t *device) = 0;
268
269 virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800270
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700271 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0;
Eric Laurentbaac1832014-12-01 17:52:59 -0800272 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0;
Marvin Raminbdefaf02023-11-01 09:10:32 +0100273 virtual status_t getRegisteredPolicyMixes(std::vector<AudioMix>& mixes) = 0;
Eric Laurent554a2772015-04-10 11:29:24 -0700274
Jan Sebechlebsky0af8e872023-08-11 14:45:08 +0200275 virtual status_t updatePolicyMix(
276 const AudioMix& mix,
277 const std::vector<AudioMixMatchCriterion>& updatedCriteria) = 0;
278
jiabin6a02d532020-08-07 11:56:38 -0700279 virtual status_t setUidDeviceAffinities(uid_t uid, const AudioDeviceTypeAddrVector& devices)
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800280 = 0;
281 virtual status_t removeUidDeviceAffinities(uid_t uid) = 0;
282
Oscar Azucena90e77632019-11-27 17:12:28 -0800283 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700284 const AudioDeviceTypeAddrVector& devices) = 0;
Oscar Azucena90e77632019-11-27 17:12:28 -0800285 virtual status_t removeUserIdDeviceAffinities(int userId) = 0;
286
Eric Laurent554a2772015-04-10 11:29:24 -0700287 virtual status_t startAudioSource(const struct audio_port_config *source,
288 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700289 audio_port_handle_t *portId,
Eric Laurent541a2002024-01-15 18:11:42 +0100290 uid_t uid,
291 bool internal = false) = 0;
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700292 virtual status_t stopAudioSource(audio_port_handle_t portId) = 0;
Andy Hung2ddee192015-12-18 17:34:44 -0800293
294 virtual status_t setMasterMono(bool mono) = 0;
295 virtual status_t getMasterMono(bool *mono) = 0;
Eric Laurentac9cef52017-06-09 15:46:26 -0700296
297 virtual float getStreamVolumeDB(
298 audio_stream_type_t stream, int index, audio_devices_t device) = 0;
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800299
jiabin81772902018-04-02 17:52:27 -0700300 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
301 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100302 bool *surroundFormatsEnabled) = 0;
303
304 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
305 audio_format_t *surroundFormats) = 0;
306
jiabin81772902018-04-02 17:52:27 -0700307 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0;
308
jiabin6012f912018-11-02 17:06:30 -0700309 virtual bool isHapticPlaybackSupported() = 0;
310
Carter Hsu325a8eb2022-01-19 19:56:51 +0800311 virtual bool isUltrasoundSupported() = 0;
312
Atneya Nair698f5ef2022-12-15 16:15:09 -0800313 virtual bool isHotwordStreamSupported(bool lookbackAudio) = 0;
314
Pattydd807582021-11-04 21:01:03 +0800315 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
316 audio_devices_t device, std::vector<audio_format_t> *formats) = 0;
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800317
Eric Laurent5ada82e2019-08-29 17:53:54 -0700318 virtual void setAppState(audio_port_handle_t portId, app_state_t state) = 0;
François Gaffied0ba9ed2018-11-05 11:50:42 +0100319
320 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0;
321
Francois Gaffie11b65922020-09-24 16:59:08 +0200322 virtual status_t getProductStrategyFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200323 const audio_attributes_t &aa, product_strategy_t &productStrategy,
Francois Gaffie11b65922020-09-24 16:59:08 +0200324 bool fallbackOnDefault) = 0;
François Gaffie4b2018b2018-11-07 11:18:59 +0100325
326 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0;
327
Francois Gaffie11b65922020-09-24 16:59:08 +0200328 virtual status_t getVolumeGroupFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200329 const audio_attributes_t &aa, volume_group_t &volumeGroup, bool fallbackOnDefault) = 0;
Eric Laurent8340e672019-11-06 11:01:08 -0800330
331 virtual bool isCallScreenModeSupported() = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700332
jiabin0a488932020-08-07 17:32:40 -0700333 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
334 device_role_t role,
335 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700336
jiabin0a488932020-08-07 17:32:40 -0700337 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
Paul Wang5d7cdb52022-11-22 09:45:06 +0000338 device_role_t role,
339 const AudioDeviceTypeAddrVector &devices) = 0;
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700340
Paul Wang5d7cdb52022-11-22 09:45:06 +0000341 virtual status_t clearDevicesRoleForStrategy(product_strategy_t strategy,
342 device_role_t role) = 0;
jiabin0a488932020-08-07 17:32:40 -0700343
344 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
345 device_role_t role,
346 AudioDeviceTypeAddrVector &devices) = 0;
Jiabin Huang3b98d322020-09-03 17:54:16 +0000347
348 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
349 device_role_t role,
350 const AudioDeviceTypeAddrVector &devices) = 0;
351
352 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
353 device_role_t role,
354 const AudioDeviceTypeAddrVector &devices) = 0;
355
356 virtual status_t removeDevicesRoleForCapturePreset(
357 audio_source_t audioSource, device_role_t role,
358 const AudioDeviceTypeAddrVector& devices) = 0;
359
360 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
361 device_role_t role) = 0;
362
363 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
364 device_role_t role,
365 AudioDeviceTypeAddrVector &devices) = 0;
Eric Laurent81dd0f52021-07-05 11:54:40 +0200366
367 /**
368 * Queries if some kind of spatialization will be performed if the audio playback context
369 * described by the provided arguments is present.
370 * The context is made of:
371 * - The audio attributes describing the playback use case.
372 * - The audio configuration describing the audio format, channels, sampling rate ...
373 * - The devices describing the sink audio device selected for playback.
374 * All arguments are optional and only the specified arguments are used to match against
375 * supported criteria. For instance, supplying no argument will tell if spatialization is
376 * supported or not in general.
377 * @param attr audio attributes describing the playback use case
378 * @param config audio configuration describing the audio format, channels, sampling rate...
379 * @param devices the sink audio device selected for playback
380 * @return true if spatialization is enabled for this context,
381 * false otherwise
382 */
383 virtual bool canBeSpatialized(const audio_attributes_t *attr,
384 const audio_config_t *config,
385 const AudioDeviceTypeAddrVector &devices) const = 0;
386
387 /**
388 * Opens a specialized spatializer output if supported by the platform.
389 * If several spatializer output profiles exist, the one supporting the sink device
390 * corresponding to the provided audio attributes will be selected.
391 * Only one spatializer output stream can be opened at a time and an error is returned
392 * if one already exists.
393 * @param config audio format, channel mask and sampling rate to be used as the mixer
394 * configuration for the spatializer mixer created.
395 * @param attr audio attributes describing the playback use case that will drive the
396 * sink device selection
397 * @param output the IO handle of the output opened
398 * @return NO_ERROR if an output was opened, INVALID_OPERATION or BAD_VALUE otherwise
399 */
400 virtual status_t getSpatializerOutput(const audio_config_base_t *config,
401 const audio_attributes_t *attr,
402 audio_io_handle_t *output) = 0;
403
404 /**
405 * Closes a previously opened specialized spatializer output.
406 * @param output the IO handle of the output to close.
407 * @return NO_ERROR if an output was closed, INVALID_OPERATION or BAD_VALUE otherwise
408 */
409 virtual status_t releaseSpatializerOutput(audio_io_handle_t output) = 0;
jiabin2b9d5a12021-12-10 01:06:29 +0000410
411 /**
412 * Query how the direct playback is currently supported on the device.
413 * @param attr audio attributes describing the playback use case
414 * @param config audio configuration for the playback
415 * @param directMode out: a set of flags describing how the direct playback is currently
416 * supported on the device
417 * @return NO_ERROR in case of success, DEAD_OBJECT, NO_INIT, BAD_VALUE, PERMISSION_DENIED
418 * in case of error.
419 */
420 virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
421 const audio_config_t *config) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700422
Dorin Drimusf2196d82022-01-03 12:11:18 +0100423 // retrieves the list of available direct audio profiles for the given audio attributes
424 virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
425 AudioProfileVector& audioProfiles) = 0;
jiabina84c3d32022-12-02 18:59:55 +0000426
427 virtual status_t getSupportedMixerAttributes(
428 audio_port_handle_t portId, std::vector<audio_mixer_attributes_t>& mixerAttrs) = 0;
429 virtual status_t setPreferredMixerAttributes(
430 const audio_attributes_t* attr,
431 audio_port_handle_t portId,
432 uid_t uid,
433 const audio_mixer_attributes_t* mixerAttributes) = 0;
434 virtual status_t getPreferredMixerAttributes(const audio_attributes_t* attr,
435 audio_port_handle_t portId,
436 audio_mixer_attributes_t* mixerAttributes) = 0;
437 virtual status_t clearPreferredMixerAttributes(const audio_attributes_t* attr,
438 audio_port_handle_t portId,
439 uid_t uid) = 0;
Dorin Drimusf2196d82022-01-03 12:11:18 +0100440};
Eric Laurente552edb2014-03-10 17:42:56 -0700441
442// Audio Policy client Interface
443class AudioPolicyClientInterface
444{
445public:
446 virtual ~AudioPolicyClientInterface() {}
447
Mikhail Naganovffd97712023-05-03 17:45:36 -0700448 virtual status_t getAudioPolicyConfig(media::AudioPolicyConfig *config) = 0;
449
Eric Laurente552edb2014-03-10 17:42:56 -0700450 //
451 // Audio HW module functions
452 //
453
454 // loads a HW module.
455 virtual audio_module_handle_t loadHwModule(const char *name) = 0;
456
457 //
458 // Audio output Control functions
459 //
460
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200461 // opens an audio output with the requested parameters. The parameter values can indicate to
462 // use the default values in case the audio policy manager has no specific requirements for the
463 // output being opened.
464 // When the function returns, the parameter values reflect the actual values used by the audio
465 // hardware output stream.
466 // The audio policy manager can check if the proposed parameters are suitable or not and act
467 // accordingly.
Eric Laurentcf2c0212014-07-25 16:20:43 -0700468 virtual status_t openOutput(audio_module_handle_t module,
469 audio_io_handle_t *output,
Eric Laurentf1f22e72021-07-13 14:04:14 +0200470 audio_config_t *halConfig,
471 audio_config_base_t *mixerConfig,
jiabin43810402019-10-24 14:58:31 -0700472 const sp<DeviceDescriptorBase>& device,
Eric Laurentcf2c0212014-07-25 16:20:43 -0700473 uint32_t *latencyMs,
474 audio_output_flags_t flags) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200475 // creates a special output that is duplicated to the two outputs passed as arguments.
476 // The duplication is performed by a special mixer thread in the AudioFlinger.
477 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
478 audio_io_handle_t output2) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700479 // closes the output stream
480 virtual status_t closeOutput(audio_io_handle_t output) = 0;
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200481 // suspends the output. When an output is suspended, the corresponding audio hardware output
482 // stream is placed in standby and the AudioTracks attached to the mixer thread are still
483 // processed but the output mix is discarded.
Eric Laurente552edb2014-03-10 17:42:56 -0700484 virtual status_t suspendOutput(audio_io_handle_t output) = 0;
485 // restores a suspended output.
486 virtual status_t restoreOutput(audio_io_handle_t output) = 0;
487
488 //
489 // Audio input Control functions
490 //
491
492 // opens an audio input
Eric Laurentcf2c0212014-07-25 16:20:43 -0700493 virtual status_t openInput(audio_module_handle_t module,
494 audio_io_handle_t *input,
495 audio_config_t *config,
496 audio_devices_t *device,
497 const String8& address,
498 audio_source_t source,
499 audio_input_flags_t flags) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700500 // closes an audio input
501 virtual status_t closeInput(audio_io_handle_t input) = 0;
502 //
503 // misc control functions
504 //
505
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200506 // set a stream volume for a particular output. For the same user setting, a given stream type
507 // can have different volumes
Eric Laurente552edb2014-03-10 17:42:56 -0700508 // for each output (destination device) it is attached to.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200509 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume,
510 audio_io_handle_t output, int delayMs = 0) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700511
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200512 // function enabling to send proprietary informations directly from audio policy manager to
513 // audio hardware interface.
514 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs,
515 int delayMs = 0) = 0;
516 // function enabling to receive proprietary informations directly from audio hardware interface
517 // to audio policy manager.
Eric Laurente552edb2014-03-10 17:42:56 -0700518 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0;
519
Eric Laurente552edb2014-03-10 17:42:56 -0700520 // set down link audio volume.
521 virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0;
522
523 // move effect to the specified output
Glenn Kastend848eb42016-03-08 13:42:11 -0800524 virtual status_t moveEffects(audio_session_t session,
Eric Laurente552edb2014-03-10 17:42:56 -0700525 audio_io_handle_t srcOutput,
526 audio_io_handle_t dstOutput) = 0;
527
Eric Laurentb20cf7d2019-04-05 19:37:34 -0700528 virtual void setEffectSuspended(int effectId,
529 audio_session_t sessionId,
530 bool suspended) = 0;
531
Eric Laurent951f4552014-05-20 10:48:17 -0700532 /* Create a patch between several source and sink ports */
533 virtual status_t createAudioPatch(const struct audio_patch *patch,
534 audio_patch_handle_t *handle,
535 int delayMs) = 0;
536
537 /* Release a patch */
538 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
539 int delayMs) = 0;
540
Eric Laurente1715a42014-05-20 11:30:42 -0700541 /* Set audio port configuration */
542 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0;
543
Eric Laurentb52c1522014-05-20 11:27:36 -0700544 virtual void onAudioPortListUpdate() = 0;
545
546 virtual void onAudioPatchListUpdate() = 0;
Eric Laurentde3f8392014-07-27 18:38:22 -0700547
François Gaffiecfe17322018-11-07 13:41:29 +0100548 virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0;
549
Glenn Kastenf0c6d7d2016-02-26 10:44:04 -0800550 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0;
Jean-Michel Trivide801052015-04-14 19:10:14 -0700551
552 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0;
Jean-Michel Trivi2f4fe9f2015-12-04 16:20:59 -0800553
Jean-Michel Triviac4e4292016-12-22 11:39:31 -0800554 virtual void onRecordingConfigurationUpdate(int event,
Eric Laurenta9f86652018-11-28 17:23:11 -0800555 const record_client_info_t *clientInfo,
556 const audio_config_base_t *clientConfig,
557 std::vector<effect_descriptor_t> clientEffects,
558 const audio_config_base_t *deviceConfig,
559 std::vector<effect_descriptor_t> effects,
560 audio_patch_handle_t patchHandle,
561 audio_source_t source) = 0;
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700562
Jean-Michel Trivi9a6b9ad2020-10-22 16:46:43 -0700563 virtual void onRoutingUpdated() = 0;
564
Jean-Michel Trivi78f2b302022-04-15 18:18:41 +0000565 // Used to notify AudioService that an error was encountering when reading
566 // the volume ranges, and that they should be re-initialized
567 virtual void onVolumeRangeInitRequest() = 0;
568
Ytai Ben-Tsvi74cd6b02019-10-25 10:06:40 -0700569 // Used to notify the sound trigger module that an audio capture is about to
570 // take place. This should typically result in any active recognition
571 // sessions to be preempted on modules that do not support sound trigger
572 // recognition concurrently with audio capture.
573 virtual void setSoundTriggerCaptureState(bool active) = 0;
jiabinb4fed192020-09-22 14:45:40 -0700574
575 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0;
jiabin10a03f12021-05-07 23:46:28 +0000576
577 virtual status_t updateSecondaryOutputs(
578 const TrackSecondaryOutputsMap& trackSecondaryOutputs) = 0;
Mikhail Naganov516d3982022-02-01 23:53:59 +0000579
jiabinc0048632023-04-27 22:04:31 +0000580 virtual status_t setDeviceConnectedState(const struct audio_port_v7 *port,
581 media::DeviceConnectedState state) = 0;
jiabinc44b3462022-12-08 12:52:31 -0800582
583 virtual status_t invalidateTracks(const std::vector<audio_port_handle_t>& portIds) = 0;
jiabin12537fc2023-10-12 17:56:08 +0000584
585 // Get the attributes of the mix port when connecting to the given device port.
586 virtual status_t getAudioMixPort(const struct audio_port_v7 *devicePort,
587 struct audio_port_v7 *mixPort) = 0;
Eric Laurente552edb2014-03-10 17:42:56 -0700588};
589
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530590 // These are the signatures of createAudioPolicyManager/destroyAudioPolicyManager
591 // methods respectively, expected by AudioPolicyService, needs to be exposed by
592 // libaudiopolicymanagercustom.
Eric Laurent0eb2f4a2021-10-05 13:57:18 +0200593 using CreateAudioPolicyManagerInstance =
594 AudioPolicyInterface* (*)(AudioPolicyClientInterface*);
Jaideep Sharmaba9053b2021-01-25 21:24:26 +0530595 using DestroyAudioPolicyManagerInstance = void (*)(AudioPolicyInterface*);
Eric Laurente552edb2014-03-10 17:42:56 -0700596
Mikhail Naganov1b2a7942017-12-08 10:18:09 -0800597} // namespace android
Eric Laurente552edb2014-03-10 17:42:56 -0700598
Eric Laurentdce54a12014-03-10 12:19:46 -0700599#endif // ANDROID_AUDIOPOLICY_INTERFACE_H