blob: 74460c7543970142c90b8e65bf871345c8466b0b [file] [log] [blame]
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001/*
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
François Gaffiead3183e2015-03-18 16:55:35 +010017#pragma once
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080018
Mikhail Naganov2773dd72017-12-08 10:12:11 -080019#include <atomic>
Mikhail Naganov37977152018-07-11 15:54:44 -070020#include <functional>
Mikhail Naganovbcbcb1b2017-12-13 13:03:35 -080021#include <memory>
jiabin81772902018-04-02 17:52:27 -070022#include <unordered_set>
Mikhail Naganov2773dd72017-12-08 10:12:11 -080023
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080024#include <stdint.h>
25#include <sys/types.h>
26#include <cutils/config_utils.h>
27#include <cutils/misc.h>
28#include <utils/Timers.h>
29#include <utils/Errors.h>
30#include <utils/KeyedVector.h>
31#include <utils/SortedVector.h>
Andy Hung2ddee192015-12-18 17:34:44 -080032#include <media/AudioParameter.h>
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080033#include <media/AudioPolicy.h>
jiabin811797a2019-09-10 14:29:14 -070034#include <media/AudioProfile.h>
Mikhail Naganov15be9d22017-11-08 14:18:13 +110035#include <media/PatchBuilder.h>
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080036#include "AudioPolicyInterface.h"
37
Nathalie Le Clair88fa2752021-11-23 13:03:41 +010038#include <android/media/audio/common/AudioPort.h>
François Gaffie2110e042015-03-24 08:41:51 +010039#include <AudioPolicyManagerObserver.h>
Mikhail Naganovad3f8a12017-12-12 13:24:23 -080040#include <AudioPolicyConfig.h>
jiabine1284852019-09-11 10:15:46 -070041#include <PolicyAudioPort.h>
François Gaffie98cc1912015-03-18 17:52:40 +010042#include <AudioPatch.h>
François Gaffie98cc1912015-03-18 17:52:40 +010043#include <DeviceDescriptor.h>
44#include <IOProfile.h>
45#include <HwModule.h>
46#include <AudioInputDescriptor.h>
47#include <AudioOutputDescriptor.h>
François Gaffie036e1e92015-03-19 10:16:24 +010048#include <AudioPolicyMix.h>
François Gaffie45ed3b02015-03-19 10:35:14 +010049#include <EffectDescriptor.h>
François Gaffiedf372692015-03-19 10:43:27 +010050#include <SoundTriggerSession.h>
Mikhail Naganov47835552019-05-14 10:32:51 -070051#include "EngineLibrary.h"
Eric Laurentf5aa58d2019-02-22 18:20:11 -080052#include "TypeConverter.h"
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080053
54namespace android {
55
Svet Ganov3e5f14f2021-05-13 22:51:08 +000056using content::AttributionSourceState;
57
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080058// ----------------------------------------------------------------------------
59
60// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB
Eric Laurentffbc80f2015-03-18 18:30:19 -070061#define SONIFICATION_HEADSET_VOLUME_FACTOR_DB (-6)
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080062// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB
Eric Laurentffbc80f2015-03-18 18:30:19 -070063#define SONIFICATION_HEADSET_VOLUME_MIN_DB (-36)
Jean-Michel Trivi00a20962016-05-25 19:11:01 -070064// Max volume difference on A2DP between playing media and STRATEGY_SONIFICATION streams: 12dB
65#define SONIFICATION_A2DP_MAX_MEDIA_DIFF_DB (12)
Eric Laurentffbc80f2015-03-18 18:30:19 -070066
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080067// Time in milliseconds during which we consider that music is still active after a music
68// track was stopped - see computeVolume()
69#define SONIFICATION_HEADSET_MUSIC_DELAY 5000
François Gaffie2110e042015-03-24 08:41:51 +010070
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080071// Time in milliseconds during witch some streams are muted while the audio path
72// is switched
73#define MUTE_TIME_MS 2000
74
Eric Laurentac3a6902018-05-11 16:39:10 -070075// multiplication factor applied to output latency when calculating a safe mute delay when
76// invalidating tracks
77#define LATENCY_MUTE_FACTOR 4
78
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080079#define NUM_TEST_OUTPUTS 5
80
81#define NUM_VOL_CURVE_KNEES 2
82
83// Default minimum length allowed for offloading a compressed track
84// Can be overridden by the audio.offload.min.duration.secs property
85#define OFFLOAD_DEFAULT_MIN_DURATION_SECS 60
86
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080087// ----------------------------------------------------------------------------
88// AudioPolicyManager implements audio policy manager behavior common to all platforms.
89// ----------------------------------------------------------------------------
90
François Gaffie2110e042015-03-24 08:41:51 +010091class AudioPolicyManager : public AudioPolicyInterface, public AudioPolicyManagerObserver
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080092{
93
94public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -070095 explicit AudioPolicyManager(AudioPolicyClientInterface *clientInterface);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080096 virtual ~AudioPolicyManager();
97
98 // AudioPolicyInterface
Nathalie Le Clair88fa2752021-11-23 13:03:41 +010099 virtual status_t setDeviceConnectionState(audio_policy_dev_state_t state,
100 const android::media::audio::common::AudioPort& port, audio_format_t encodedFormat);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800101 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
102 const char *device_address);
Pavlin Radoslavovf862bc62016-12-26 18:57:22 -0800103 virtual status_t handleDeviceConfigChange(audio_devices_t device,
104 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800105 const char *device_name,
106 audio_format_t encodedFormat);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800107 virtual void setPhoneState(audio_mode_t state);
108 virtual void setForceUse(audio_policy_force_use_t usage,
109 audio_policy_forced_cfg_t config);
110 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
François Gaffie2110e042015-03-24 08:41:51 +0100111
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800112 virtual void setSystemProperty(const char* property, const char* value);
113 virtual status_t initCheck();
Eric Laurentf4e63452017-11-06 19:31:46 +0000114 virtual audio_io_handle_t getOutput(audio_stream_type_t stream);
Kevin Rocard153f92d2018-12-18 18:33:28 -0800115 status_t getOutputForAttr(const audio_attributes_t *attr,
116 audio_io_handle_t *output,
117 audio_session_t session,
118 audio_stream_type_t *stream,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000119 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700120 audio_config_t *config,
Kevin Rocard153f92d2018-12-18 18:33:28 -0800121 audio_output_flags_t *flags,
122 audio_port_handle_t *selectedDeviceId,
123 audio_port_handle_t *portId,
Eric Laurent8a1095a2019-11-08 14:44:16 -0800124 std::vector<audio_io_handle_t> *secondaryOutputs,
Eric Laurentb0a7bc92022-04-05 15:06:08 +0200125 output_type_t *outputType,
126 bool *isSpatialized) override;
Eric Laurent8fc147b2018-07-22 19:13:55 -0700127 virtual status_t startOutput(audio_port_handle_t portId);
128 virtual status_t stopOutput(audio_port_handle_t portId);
jiabinbce0c1d2020-10-05 11:20:18 -0700129 virtual bool releaseOutput(audio_port_handle_t portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800130 virtual status_t getInputForAttr(const audio_attributes_t *attr,
131 audio_io_handle_t *input,
Mikhail Naganov2996f672019-04-18 12:29:59 -0700132 audio_unique_id_t riid,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800133 audio_session_t session,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000134 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700135 audio_config_base_t *config,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800136 audio_input_flags_t flags,
Eric Laurent2ac76942017-06-22 17:17:09 -0700137 audio_port_handle_t *selectedDeviceId,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800138 input_type_t *inputType,
139 audio_port_handle_t *portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800140
141 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800142 virtual status_t startInput(audio_port_handle_t portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800143
144 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700145 virtual status_t stopInput(audio_port_handle_t portId);
146 virtual void releaseInput(audio_port_handle_t portId);
Eric Laurent0dd51852019-04-19 18:18:58 -0700147 virtual void checkCloseInputs();
François Gaffie251c7f02018-11-07 10:41:08 +0100148 /**
149 * @brief initStreamVolume: even if the engine volume files provides min and max, keep this
150 * api for compatibility reason.
151 * AudioServer will get the min and max and may overwrite them if:
152 * -using property (highest priority)
153 * -not defined (-1 by convention), case when still using apm volume tables XML files
154 * @param stream to be considered
155 * @param indexMin to set
156 * @param indexMax to set
157 */
158 virtual void initStreamVolume(audio_stream_type_t stream, int indexMin, int indexMax);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800159 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
160 int index,
161 audio_devices_t device);
162 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
163 int *index,
164 audio_devices_t device);
165
François Gaffiecfe17322018-11-07 13:41:29 +0100166 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
167 int index,
168 audio_devices_t device);
169 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
170 int &index,
171 audio_devices_t device);
172 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr, int &index);
173
174 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr, int &index);
175
François Gaffieaaac0fd2018-11-22 17:56:39 +0100176 status_t setVolumeCurveIndex(int index,
François Gaffiecfe17322018-11-07 13:41:29 +0100177 audio_devices_t device,
178 IVolumeCurves &volumeCurves);
179
180 status_t getVolumeIndex(const IVolumeCurves &curves, int &index,
jiabin9a3361e2019-10-01 09:38:30 -0700181 const DeviceTypeSet& deviceTypes) const;
François Gaffiecfe17322018-11-07 13:41:29 +0100182
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800183 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800184 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream)
François Gaffiec005e562018-11-06 15:04:49 +0100185 {
186 return streamToStrategy(stream);
187 }
188 product_strategy_t streamToStrategy(audio_stream_type_t stream) const
189 {
190 auto attributes = mEngine->getAttributesForStreamType(stream);
191 return mEngine->getProductStrategyForAttributes(attributes);
192 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800193
Andy Hung6d23c0f2022-02-16 09:37:15 -0800194 /**
195 * Returns a vector of devices associated with attributes.
196 *
197 * An AudioTrack opened with specified attributes should play on the returned devices.
198 * If forVolume is set to true, the caller is AudioService, determining the proper
199 * device volume to adjust.
200 *
201 * Devices are determined in the following precedence:
202 * 1) Devices associated with a dynamic policy matching the attributes. This is often
203 * a remote submix from MIX_ROUTE_FLAG_LOOP_BACK. Secondary mixes from a
204 * dynamic policy are not included.
205 *
206 * If no such dynamic policy then
207 * 2) Devices containing an active client using setPreferredDevice
208 * with same strategy as the attributes.
209 * (from the default Engine::getOutputDevicesForAttributes() implementation).
210 *
211 * If no corresponding active client with setPreferredDevice then
212 * 3) Devices associated with the strategy determined by the attributes
213 * (from the default Engine::getOutputDevicesForAttributes() implementation).
214 *
215 * @param attributes to be considered
216 * @param devices an AudioDeviceTypeAddrVector container passed in that
217 * will be filled on success.
218 * @param forVolume true if the devices are to be associated with current device volume.
219 * @return NO_ERROR on success.
220 */
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800221 virtual status_t getDevicesForAttributes(
222 const audio_attributes_t &attributes,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800223 AudioDeviceTypeAddrVector *devices,
224 bool forVolume);
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800225
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800226 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc = NULL);
227 virtual status_t registerEffect(const effect_descriptor_t *desc,
228 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800229 product_strategy_t strategy,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800230 int session,
231 int id);
Eric Laurentc241b0d2018-11-28 09:08:49 -0800232 virtual status_t unregisterEffect(int id);
233 virtual status_t setEffectEnabled(int id, bool enabled);
Eric Laurent6c796322019-04-09 14:13:17 -0700234 status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) override;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800235
Eric Laurentc75307b2015-03-17 15:29:32 -0700236 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800237 // return whether a stream is playing remotely, override to change the definition of
238 // local/remote playback, used for instance by notification manager to not make
239 // media players lose audio focus when not playing locally
240 // For the base implementation, "remotely" means playing during screen mirroring which
241 // uses an output for playback with a non-empty, non "0" address.
Eric Laurentc75307b2015-03-17 15:29:32 -0700242 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
243 uint32_t inPastMs = 0) const;
244
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800245 virtual bool isSourceActive(audio_source_t source) const;
246
Mikhail Naganov100f0122018-11-29 11:22:16 -0800247 // helpers for dump(int fd)
248 void dumpManualSurroundFormats(String8 *dst) const;
249 void dump(String8 *dst) const;
Andy Hungc29d82b2018-10-05 12:23:17 -0700250
251 status_t dump(int fd) override;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800252
Kevin Rocardb99cc752019-03-21 20:52:24 -0700253 status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t capturePolicy) override;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100254 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800255
Michael Chana94fbb22018-04-24 14:31:19 +1000256 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
257 const audio_attributes_t& attributes);
258
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800259 virtual status_t listAudioPorts(audio_port_role_t role,
260 audio_port_type_t type,
261 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800262 struct audio_port_v7 *ports,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800263 unsigned int *generation);
jiabin19cdba52020-11-24 11:28:58 -0800264 virtual status_t getAudioPort(struct audio_port_v7 *port);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800265 virtual status_t createAudioPatch(const struct audio_patch *patch,
266 audio_patch_handle_t *handle,
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200267 uid_t uid);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800268 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
269 uid_t uid);
270 virtual status_t listAudioPatches(unsigned int *num_patches,
271 struct audio_patch *patches,
272 unsigned int *generation);
273 virtual status_t setAudioPortConfig(const struct audio_port_config *config);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800274
Eric Laurentd60560a2015-04-10 11:31:20 -0700275 virtual void releaseResourcesForUid(uid_t uid);
276
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800277 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
278 audio_io_handle_t *ioHandle,
279 audio_devices_t *device);
280
François Gaffiedf372692015-03-19 10:43:27 +0100281 virtual status_t releaseSoundTriggerSession(audio_session_t session)
282 {
283 return mSoundTriggerSessions.releaseSession(session);
284 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800285
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700286 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800287 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes);
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800288 virtual status_t setUidDeviceAffinities(uid_t uid,
jiabin6a02d532020-08-07 11:56:38 -0700289 const AudioDeviceTypeAddrVector& devices);
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800290 virtual status_t removeUidDeviceAffinities(uid_t uid);
Oscar Azucena90e77632019-11-27 17:12:28 -0800291 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700292 const AudioDeviceTypeAddrVector& devices);
Oscar Azucena90e77632019-11-27 17:12:28 -0800293 virtual status_t removeUserIdDeviceAffinities(int userId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800294
jiabin0a488932020-08-07 17:32:40 -0700295 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
296 device_role_t role,
297 const AudioDeviceTypeAddrVector &devices);
298
299 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
300 device_role_t role);
301
302
303 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
304 device_role_t role,
305 AudioDeviceTypeAddrVector &devices);
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700306
Jiabin Huang3b98d322020-09-03 17:54:16 +0000307 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
308 device_role_t role,
309 const AudioDeviceTypeAddrVector &devices);
310
311 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
312 device_role_t role,
313 const AudioDeviceTypeAddrVector &devices);
314
315 virtual status_t removeDevicesRoleForCapturePreset(
316 audio_source_t audioSource, device_role_t role,
317 const AudioDeviceTypeAddrVector& devices);
318
319 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
320 device_role_t role);
321
322 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
323 device_role_t role,
324 AudioDeviceTypeAddrVector &devices);
325
Eric Laurent554a2772015-04-10 11:29:24 -0700326 virtual status_t startAudioSource(const struct audio_port_config *source,
327 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700328 audio_port_handle_t *portId,
Eric Laurentd60560a2015-04-10 11:31:20 -0700329 uid_t uid);
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700330 virtual status_t stopAudioSource(audio_port_handle_t portId);
Eric Laurent554a2772015-04-10 11:29:24 -0700331
Andy Hung2ddee192015-12-18 17:34:44 -0800332 virtual status_t setMasterMono(bool mono);
333 virtual status_t getMasterMono(bool *mono);
Eric Laurentac9cef52017-06-09 15:46:26 -0700334 virtual float getStreamVolumeDB(
335 audio_stream_type_t stream, int index, audio_devices_t device);
Andy Hung2ddee192015-12-18 17:34:44 -0800336
jiabin81772902018-04-02 17:52:27 -0700337 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
338 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100339 bool *surroundFormatsEnabled);
340 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
341 audio_format_t *surroundFormats);
jiabin81772902018-04-02 17:52:27 -0700342 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled);
343
Pattydd807582021-11-04 21:01:03 +0800344 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
345 audio_devices_t device, std::vector<audio_format_t> *formats);
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800346
Eric Laurent5ada82e2019-08-29 17:53:54 -0700347 virtual void setAppState(audio_port_handle_t portId, app_state_t state);
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800348
jiabin6012f912018-11-02 17:06:30 -0700349 virtual bool isHapticPlaybackSupported();
350
Carter Hsu325a8eb2022-01-19 19:56:51 +0800351 virtual bool isUltrasoundSupported();
352
François Gaffied0ba9ed2018-11-05 11:50:42 +0100353 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies)
354 {
355 return mEngine->listAudioProductStrategies(strategies);
356 }
357
Francois Gaffie11b65922020-09-24 16:59:08 +0200358 virtual status_t getProductStrategyFromAudioAttributes(
359 const AudioAttributes &aa, product_strategy_t &productStrategy,
360 bool fallbackOnDefault)
François Gaffied0ba9ed2018-11-05 11:50:42 +0100361 {
Francois Gaffie11b65922020-09-24 16:59:08 +0200362 productStrategy = mEngine->getProductStrategyForAttributes(
363 aa.getAttributes(), fallbackOnDefault);
364 return (fallbackOnDefault && productStrategy == PRODUCT_STRATEGY_NONE) ?
365 BAD_VALUE : NO_ERROR;
François Gaffie4b2018b2018-11-07 11:18:59 +0100366 }
367
368 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups)
369 {
370 return mEngine->listAudioVolumeGroups(groups);
371 }
372
Francois Gaffie11b65922020-09-24 16:59:08 +0200373 virtual status_t getVolumeGroupFromAudioAttributes(
374 const AudioAttributes &aa, volume_group_t &volumeGroup, bool fallbackOnDefault)
François Gaffie4b2018b2018-11-07 11:18:59 +0100375 {
Francois Gaffie11b65922020-09-24 16:59:08 +0200376 volumeGroup = mEngine->getVolumeGroupForAttributes(
377 aa.getAttributes(), fallbackOnDefault);
378 return (fallbackOnDefault && volumeGroup == VOLUME_GROUP_NONE) ?
379 BAD_VALUE : NO_ERROR;
François Gaffied0ba9ed2018-11-05 11:50:42 +0100380 }
381
Eric Laurentfa0f6742021-08-17 18:39:44 +0200382 virtual bool canBeSpatialized(const audio_attributes_t *attr,
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200383 const audio_config_t *config,
Eric Laurentb4f42a92022-01-17 17:37:31 +0100384 const AudioDeviceTypeAddrVector &devices) const {
385 return canBeSpatializedInt(attr, config, devices);
386 }
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200387
Eric Laurentfa0f6742021-08-17 18:39:44 +0200388 virtual status_t getSpatializerOutput(const audio_config_base_t *config,
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200389 const audio_attributes_t *attr,
390 audio_io_handle_t *output);
391
Eric Laurentfa0f6742021-08-17 18:39:44 +0200392 virtual status_t releaseSpatializerOutput(audio_io_handle_t output);
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200393
jiabin2b9d5a12021-12-10 01:06:29 +0000394 virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
395 const audio_config_t *config);
396
Dorin Drimusf2196d82022-01-03 12:11:18 +0100397 virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
398 AudioProfileVector& audioProfiles);
399
Eric Laurent8340e672019-11-06 11:01:08 -0800400 bool isCallScreenModeSupported() override;
401
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000402 void onNewAudioModulesAvailable() override;
403
Eric Laurentcaafba42019-07-13 10:12:45 -0700404 status_t initialize();
405
Paul McLeanaa981192015-03-21 09:55:15 -0700406protected:
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800407 // A constructor that allows more fine-grained control over initialization process,
408 // used in automatic tests.
409 AudioPolicyManager(AudioPolicyClientInterface *clientInterface, bool forTesting);
410
411 // These methods should be used when finer control over APM initialization
412 // is needed, e.g. in tests. Must be used in conjunction with the constructor
413 // that only performs fields initialization. The public constructor comprises
414 // these steps in the following sequence:
415 // - field initializing constructor;
416 // - loadConfig;
417 // - initialize.
418 AudioPolicyConfig& getConfig() { return mConfig; }
419 void loadConfig();
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800420
François Gaffie2110e042015-03-24 08:41:51 +0100421 // From AudioPolicyManagerObserver
422 virtual const AudioPatchCollection &getAudioPatches() const
423 {
424 return mAudioPatches;
425 }
426 virtual const SoundTriggerSessionCollection &getSoundTriggerSessionCollection() const
427 {
428 return mSoundTriggerSessions;
429 }
430 virtual const AudioPolicyMixCollection &getAudioPolicyMixCollection() const
431 {
432 return mPolicyMixes;
433 }
Eric Laurentc75307b2015-03-17 15:29:32 -0700434 virtual const SwAudioOutputCollection &getOutputs() const
François Gaffie2110e042015-03-24 08:41:51 +0100435 {
436 return mOutputs;
437 }
438 virtual const AudioInputCollection &getInputs() const
439 {
440 return mInputs;
441 }
Eric Laurentaf377772019-03-29 14:50:21 -0700442 virtual const DeviceVector getAvailableOutputDevices() const
François Gaffie2110e042015-03-24 08:41:51 +0100443 {
Kevin Rocarde0d004f2019-10-10 10:06:18 +0000444 return mAvailableOutputDevices.filterForEngine();
François Gaffie2110e042015-03-24 08:41:51 +0100445 }
Eric Laurentaf377772019-03-29 14:50:21 -0700446 virtual const DeviceVector getAvailableInputDevices() const
François Gaffie2110e042015-03-24 08:41:51 +0100447 {
Francois Gaffie698d3532019-04-10 15:20:05 +0200448 // legacy and non-legacy remote-submix are managed by the engine, do not filter
449 return mAvailableInputDevices;
François Gaffie2110e042015-03-24 08:41:51 +0100450 }
François Gaffie2110e042015-03-24 08:41:51 +0100451 virtual const sp<DeviceDescriptor> &getDefaultOutputDevice() const
452 {
453 return mDefaultOutputDevice;
454 }
Mikhail Naganovd4120142017-12-06 15:49:22 -0800455
François Gaffieaaac0fd2018-11-22 17:56:39 +0100456 std::vector<volume_group_t> getVolumeGroups() const
457 {
458 return mEngine->getVolumeGroups();
459 }
460
461 VolumeSource toVolumeSource(volume_group_t volumeGroup) const
462 {
463 return static_cast<VolumeSource>(volumeGroup);
464 }
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100465 /**
466 * @brief toVolumeSource converts an audio attributes into a volume source
467 * (either a legacy stream or a volume group). If fallback on default is allowed, and if
468 * the audio attributes do not follow any specific product strategy's rule, it will be
469 * associated to default volume source, e.g. music. Thus, any of call of volume API
470 * using this translation function may affect the default volume source.
471 * If fallback is not allowed and no matching rule is identified for the given attributes,
472 * the volume source will be undefined, thus, no volume will be altered/modified.
473 * @param attributes to be considered
474 * @param fallbackOnDefault
475 * @return volume source associated with given attributes, otherwise either music if
476 * fallbackOnDefault is set or none.
477 */
478 VolumeSource toVolumeSource(
479 const audio_attributes_t &attributes, bool fallbackOnDefault = true) const
François Gaffieaaac0fd2018-11-22 17:56:39 +0100480 {
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100481 return toVolumeSource(mEngine->getVolumeGroupForAttributes(
482 attributes, fallbackOnDefault));
François Gaffieaaac0fd2018-11-22 17:56:39 +0100483 }
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100484 VolumeSource toVolumeSource(
485 audio_stream_type_t stream, bool fallbackOnDefault = true) const
François Gaffieaaac0fd2018-11-22 17:56:39 +0100486 {
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100487 return toVolumeSource(mEngine->getVolumeGroupForStreamType(
488 stream, fallbackOnDefault));
François Gaffieaaac0fd2018-11-22 17:56:39 +0100489 }
490 IVolumeCurves &getVolumeCurves(VolumeSource volumeSource)
491 {
492 auto *curves = mEngine->getVolumeCurvesForVolumeGroup(
493 static_cast<volume_group_t>(volumeSource));
494 ALOG_ASSERT(curves != nullptr, "No curves for volume source %d", volumeSource);
495 return *curves;
496 }
Eric Laurentf5aa58d2019-02-22 18:20:11 -0800497 IVolumeCurves &getVolumeCurves(const audio_attributes_t &attr)
498 {
499 auto *curves = mEngine->getVolumeCurvesForAttributes(attr);
500 ALOG_ASSERT(curves != nullptr, "No curves for attributes %s", toString(attr).c_str());
501 return *curves;
502 }
503 IVolumeCurves &getVolumeCurves(audio_stream_type_t stream)
504 {
505 auto *curves = mEngine->getVolumeCurvesForStreamType(stream);
506 ALOG_ASSERT(curves != nullptr, "No curves for stream %s", toString(stream).c_str());
507 return *curves;
508 }
509
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700510 void addOutput(audio_io_handle_t output, const sp<SwAudioOutputDescriptor>& outputDesc);
François Gaffie53615e22015-03-19 09:24:12 +0100511 void removeOutput(audio_io_handle_t output);
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700512 void addInput(audio_io_handle_t input, const sp<AudioInputDescriptor>& inputDesc);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800513
Francois Gaffie3523ab32021-06-22 13:24:34 +0200514 /**
515 * @brief setOutputDevices change the route of the specified output.
516 * @param outputDesc to be considered
517 * @param device to be considered to route the output
518 * @param force if true, force the routing even if no change.
519 * @param delayMs if specified, delay to apply for mute/volume op when changing device
520 * @param patchHandle if specified, the patch handle this output is connected through.
521 * @param requiresMuteCheck if specified, for e.g. when another output is on a shared device
522 * and currently active, allow to have proper drain and avoid pops
523 * @param requiresVolumeCheck true if called requires to reapply volume if the routing did
524 * not change (but the output is still routed).
525 * @return the number of ms we have slept to allow new routing to take effect in certain
526 * cases.
527 */
François Gaffie11d30102018-11-02 16:09:09 +0100528 uint32_t setOutputDevices(const sp<SwAudioOutputDescriptor>& outputDesc,
529 const DeviceVector &device,
530 bool force = false,
531 int delayMs = 0,
532 audio_patch_handle_t *patchHandle = NULL,
Francois Gaffie3523ab32021-06-22 13:24:34 +0200533 bool requiresMuteCheck = true,
534 bool requiresVolumeCheck = false);
Eric Laurentc75307b2015-03-17 15:29:32 -0700535 status_t resetOutputDevice(const sp<AudioOutputDescriptor>& outputDesc,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800536 int delayMs = 0,
537 audio_patch_handle_t *patchHandle = NULL);
538 status_t setInputDevice(audio_io_handle_t input,
François Gaffie11d30102018-11-02 16:09:09 +0100539 const sp<DeviceDescriptor> &device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800540 bool force = false,
541 audio_patch_handle_t *patchHandle = NULL);
542 status_t resetInputDevice(audio_io_handle_t input,
543 audio_patch_handle_t *patchHandle = NULL);
544
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800545 // compute the actual volume for a given stream according to the requested index and a particular
546 // device
François Gaffieaaac0fd2018-11-22 17:56:39 +0100547 virtual float computeVolume(IVolumeCurves &curves,
548 VolumeSource volumeSource,
Eric Laurentc75307b2015-03-17 15:29:32 -0700549 int index,
jiabin9a3361e2019-10-01 09:38:30 -0700550 const DeviceTypeSet& deviceTypes);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800551
Eric Laurent3839bc02018-07-10 18:33:34 -0700552 // rescale volume index from srcStream within range of dstStream
553 int rescaleVolumeIndex(int srcIndex,
Francois Gaffie2ffdfce2019-03-12 11:26:42 +0100554 VolumeSource fromVolumeSource,
555 VolumeSource toVolumeSource);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800556 // check that volume change is permitted, compute and send new volume to audio hardware
François Gaffieaaac0fd2018-11-22 17:56:39 +0100557 virtual status_t checkAndSetVolume(IVolumeCurves &curves,
558 VolumeSource volumeSource, int index,
Eric Laurentc75307b2015-03-17 15:29:32 -0700559 const sp<AudioOutputDescriptor>& outputDesc,
jiabin9a3361e2019-10-01 09:38:30 -0700560 DeviceTypeSet deviceTypes,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800561 int delayMs = 0, bool force = false);
562
563 // apply all stream volumes to the specified output and device
Eric Laurentc75307b2015-03-17 15:29:32 -0700564 void applyStreamVolumes(const sp<AudioOutputDescriptor>& outputDesc,
jiabin9a3361e2019-10-01 09:38:30 -0700565 const DeviceTypeSet& deviceTypes,
566 int delayMs = 0, bool force = false);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800567
François Gaffiec005e562018-11-06 15:04:49 +0100568 /**
569 * @brief setStrategyMute Mute or unmute all active clients on the considered output
570 * following the given strategy.
571 * @param strategy to be considered
572 * @param on true for mute, false for unmute
573 * @param outputDesc to be considered
574 * @param delayMs
575 * @param device
576 */
577 void setStrategyMute(product_strategy_t strategy,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800578 bool on,
Eric Laurentc75307b2015-03-17 15:29:32 -0700579 const sp<AudioOutputDescriptor>& outputDesc,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800580 int delayMs = 0,
jiabin9a3361e2019-10-01 09:38:30 -0700581 DeviceTypeSet deviceTypes = DeviceTypeSet());
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800582
François Gaffieaaac0fd2018-11-22 17:56:39 +0100583 /**
584 * @brief setVolumeSourceMute Mute or unmute the volume source on the specified output
585 * @param volumeSource to be muted/unmute (may host legacy streams or by extension set of
586 * audio attributes)
587 * @param on true to mute, false to umute
588 * @param outputDesc on which the client following the volume group shall be muted/umuted
589 * @param delayMs
590 * @param device
François Gaffieaaac0fd2018-11-22 17:56:39 +0100591 */
592 void setVolumeSourceMute(VolumeSource volumeSource,
593 bool on,
594 const sp<AudioOutputDescriptor>& outputDesc,
595 int delayMs = 0,
jiabin9a3361e2019-10-01 09:38:30 -0700596 DeviceTypeSet deviceTypes = DeviceTypeSet());
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800597
Jean-Michel Trivi887a9ed2015-03-31 18:02:24 -0700598 audio_mode_t getPhoneState();
599
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800600 // true if device is in a telephony or VoIP call
Eric Laurent96d1dda2022-03-14 17:14:19 +0100601 virtual bool isInCall() const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800602 // true if given state represents a device in a telephony or VoIP call
Eric Laurent96d1dda2022-03-14 17:14:19 +0100603 virtual bool isStateInCall(int state) const;
Eric Laurent74b71512019-11-06 17:21:57 -0800604 // true if playback to call TX or capture from call RX is possible
605 bool isCallAudioAccessible();
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800606
607 // when a device is connected, checks if an open output can be routed
608 // to this device. If none is open, tries to open one of the available outputs.
609 // Returns an output suitable to this device or 0.
610 // when a device is disconnected, checks if an output is not used any more and
611 // returns its handle if any.
612 // transfers the audio tracks and effects from one output thread to another accordingly.
François Gaffie11d30102018-11-02 16:09:09 +0100613 status_t checkOutputsForDevice(const sp<DeviceDescriptor>& device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800614 audio_policy_dev_state_t state,
François Gaffie11d30102018-11-02 16:09:09 +0100615 SortedVector<audio_io_handle_t>& outputs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800616
François Gaffie11d30102018-11-02 16:09:09 +0100617 status_t checkInputsForDevice(const sp<DeviceDescriptor>& device,
Eric Laurent0dd51852019-04-19 18:18:58 -0700618 audio_policy_dev_state_t state);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800619
620 // close an output and its companion duplicating output.
621 void closeOutput(audio_io_handle_t output);
622
623 // close an input.
624 void closeInput(audio_io_handle_t input);
625
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700626 // runs all the checks required for accommodating changes in devices and outputs
Mikhail Naganov37977152018-07-11 15:54:44 -0700627 // if 'onOutputsChecked' callback is provided, it is executed after the outputs
628 // check via 'checkOutputForAllStrategies'. If the callback returns 'true',
629 // A2DP suspend status is rechecked.
Mikhail Naganov15be9d22017-11-08 14:18:13 +1100630 void checkForDeviceAndOutputChanges(std::function<bool()> onOutputsChecked = nullptr);
Mikhail Naganov37977152018-07-11 15:54:44 -0700631
François Gaffiec005e562018-11-06 15:04:49 +0100632 /**
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700633 * @brief updates routing for all outputs (including call if call in progress).
634 * @param delayMs delay for unmuting if required
635 */
636 void updateCallAndOutputRouting(bool forceVolumeReeval = true, uint32_t delayMs = 0);
637
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200638 bool isCallRxAudioSource(const sp<SourceClientDescriptor> &source) {
Francois Gaffie601801d2021-06-22 13:27:39 +0200639 return mCallRxSourceClient != nullptr && source == mCallRxSourceClient;
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200640 }
641
642 void connectTelephonyRxAudioSource();
643
Francois Gaffie601801d2021-06-22 13:27:39 +0200644 void disconnectTelephonyAudioSource(sp<SourceClientDescriptor> &clientDesc);
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200645
646 void connectTelephonyTxAudioSource(const sp<DeviceDescriptor> &srcdevice,
647 const sp<DeviceDescriptor> &sinkDevice,
648 uint32_t delayMs);
649
Francois Gaffie601801d2021-06-22 13:27:39 +0200650 bool isTelephonyRxOrTx(const sp<SwAudioOutputDescriptor>& desc) const {
651 return (mCallRxSourceClient != nullptr && mCallRxSourceClient->belongsToOutput(desc))
652 || (mCallTxSourceClient != nullptr
653 && mCallTxSourceClient->belongsToOutput(desc));
654 }
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200655
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700656 /**
Eric Laurent2517af32020-11-25 15:31:27 +0100657 * @brief updates routing for all inputs.
658 */
659 void updateInputRouting();
660
661 /**
François Gaffiec005e562018-11-06 15:04:49 +0100662 * @brief checkOutputForAttributes checks and if necessary changes outputs used for the
663 * given audio attributes.
664 * must be called every time a condition that affects the output choice for a given
665 * attributes changes: connected device, phone state, force use...
666 * Must be called before updateDevicesAndOutputs()
667 * @param attr to be considered
668 */
669 void checkOutputForAttributes(const audio_attributes_t &attr);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800670
Francois Gaffieff1eb522020-05-06 18:37:04 +0200671 /**
672 * @brief checkAudioSourceForAttributes checks if any AudioSource following the same routing
673 * as the given audio attributes is not routed and try to connect it.
674 * It must be called once checkOutputForAttributes has been called for orphans AudioSource,
675 * aka AudioSource not attached to any Audio Output (e.g. AudioSource connected to direct
676 * Output which has been disconnected (and output closed) due to sink device unavailable).
677 * @param attr to be considered
678 */
679 void checkAudioSourceForAttributes(const audio_attributes_t &attr);
680
François Gaffiec005e562018-11-06 15:04:49 +0100681 bool followsSameRouting(const audio_attributes_t &lAttr,
682 const audio_attributes_t &rAttr) const;
683
684 /**
685 * @brief checkOutputForAllStrategies Same as @see checkOutputForAttributes()
686 * but for a all product strategies in order of priority
687 */
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800688 void checkOutputForAllStrategies();
689
Kevin Rocard153f92d2018-12-18 18:33:28 -0800690 // Same as checkOutputForStrategy but for secondary outputs. Make sure if a secondary
691 // output condition changes, the track is properly rerouted
692 void checkSecondaryOutputs();
693
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800694 // manages A2DP output suspend/restore according to phone state and BT SCO usage
695 void checkA2dpSuspend();
696
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800697 // selects the most appropriate device on output for current state
698 // must be called every time a condition that affects the device choice for a given output is
699 // changed: connected device, phone state, force use, output start, output stop..
700 // see getDeviceForStrategy() for the use of fromCache parameter
François Gaffie11d30102018-11-02 16:09:09 +0100701 DeviceVector getNewOutputDevices(const sp<SwAudioOutputDescriptor>& outputDesc,
702 bool fromCache);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800703
François Gaffiec005e562018-11-06 15:04:49 +0100704 /**
705 * @brief updateDevicesAndOutputs: updates cache of devices of the engine
706 * must be called every time a condition that affects the device choice is changed:
707 * connected device, phone state, force use...
708 * cached values are used by getOutputDevicesForStream()/getDevicesForAttributes if
709 * parameter fromCache is true.
710 * Must be called after checkOutputForAllStrategies()
711 */
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800712 void updateDevicesAndOutputs();
713
714 // selects the most appropriate device on input for current state
François Gaffie11d30102018-11-02 16:09:09 +0100715 sp<DeviceDescriptor> getNewInputDevice(const sp<AudioInputDescriptor>& inputDesc);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800716
François Gaffie45ed3b02015-03-19 10:35:14 +0100717 virtual uint32_t getMaxEffectsCpuLoad()
718 {
719 return mEffects.getMaxEffectsCpuLoad();
720 }
721
722 virtual uint32_t getMaxEffectsMemory()
723 {
724 return mEffects.getMaxEffectsMemory();
725 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800726
François Gaffie11d30102018-11-02 16:09:09 +0100727 SortedVector<audio_io_handle_t> getOutputsForDevices(
728 const DeviceVector &devices, const SwAudioOutputCollection& openOutputs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800729
François Gaffiec005e562018-11-06 15:04:49 +0100730 /**
731 * @brief checkDeviceMuteStrategies mute/unmute strategies
732 * using an incompatible device combination.
733 * if muting, wait for the audio in pcm buffer to be drained before proceeding
734 * if unmuting, unmute only after the specified delay
735 * @param outputDesc
736 * @param prevDevice
737 * @param delayMs
738 * @return the number of ms waited
739 */
740 virtual uint32_t checkDeviceMuteStrategies(const sp<AudioOutputDescriptor>& outputDesc,
741 const DeviceVector &prevDevices,
742 uint32_t delayMs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800743
744 audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
jiabin40573322018-11-08 12:08:02 -0800745 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
746 audio_format_t format = AUDIO_FORMAT_INVALID,
747 audio_channel_mask_t channelMask = AUDIO_CHANNEL_NONE,
jiabinebb6af42020-06-09 17:31:17 -0700748 uint32_t samplingRate = 0,
749 audio_session_t sessionId = AUDIO_SESSION_NONE);
Andy Hungf129b032015-04-07 13:45:50 -0700750 // samplingRate, format, channelMask are in/out and so may be modified
François Gaffie11d30102018-11-02 16:09:09 +0100751 sp<IOProfile> getInputProfile(const sp<DeviceDescriptor> & device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800752 uint32_t& samplingRate,
Andy Hungf129b032015-04-07 13:45:50 -0700753 audio_format_t& format,
754 audio_channel_mask_t& channelMask,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800755 audio_input_flags_t flags);
François Gaffie11d30102018-11-02 16:09:09 +0100756 /**
757 * @brief getProfileForOutput
758 * @param devices vector of descriptors, may be empty if ignoring the device is required
759 * @param samplingRate
760 * @param format
761 * @param channelMask
762 * @param flags
763 * @param directOnly
764 * @return IOProfile to be used if found, nullptr otherwise
765 */
766 sp<IOProfile> getProfileForOutput(const DeviceVector &devices,
Michael Chana94fbb22018-04-24 14:31:19 +1000767 uint32_t samplingRate,
768 audio_format_t format,
769 audio_channel_mask_t channelMask,
770 audio_output_flags_t flags,
771 bool directOnly);
Dorin Drimusecc9f422022-03-09 17:57:40 +0100772 /**
773 * Same as getProfileForOutput, but it looks for an MSD profile
774 */
775 sp<IOProfile> getMsdProfileForOutput(const DeviceVector &devices,
776 uint32_t samplingRate,
777 audio_format_t format,
778 audio_channel_mask_t channelMask,
779 audio_output_flags_t flags,
780 bool directOnly);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800781
Eric Laurent36829f92017-04-07 19:04:42 -0700782 audio_io_handle_t selectOutputForMusicEffects();
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800783
François Gaffie53615e22015-03-19 09:24:12 +0100784 virtual status_t addAudioPatch(audio_patch_handle_t handle, const sp<AudioPatch>& patch)
785 {
786 return mAudioPatches.addAudioPatch(handle, patch);
787 }
788 virtual status_t removeAudioPatch(audio_patch_handle_t handle)
789 {
790 return mAudioPatches.removeAudioPatch(handle);
791 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800792
François Gaffie9eb18552018-11-05 10:33:26 +0100793 bool isPrimaryModule(const sp<HwModule> &module) const
794 {
795 if (module == 0 || !hasPrimaryOutput()) {
796 return false;
797 }
798 return module->getHandle() == mPrimaryOutput->getModuleHandle();
799 }
François Gaffie11d30102018-11-02 16:09:09 +0100800 DeviceVector availablePrimaryOutputDevices() const
François Gaffie53615e22015-03-19 09:24:12 +0100801 {
Eric Laurent87ffa392015-05-22 10:32:38 -0700802 if (!hasPrimaryOutput()) {
François Gaffie11d30102018-11-02 16:09:09 +0100803 return DeviceVector();
Eric Laurent87ffa392015-05-22 10:32:38 -0700804 }
Francois Gaffie716e1432019-01-14 16:58:59 +0100805 return mAvailableOutputDevices.filter(mPrimaryOutput->supportedDevices());
François Gaffie53615e22015-03-19 09:24:12 +0100806 }
François Gaffie11d30102018-11-02 16:09:09 +0100807 DeviceVector availablePrimaryModuleInputDevices() const
François Gaffie53615e22015-03-19 09:24:12 +0100808 {
Eric Laurent87ffa392015-05-22 10:32:38 -0700809 if (!hasPrimaryOutput()) {
François Gaffie11d30102018-11-02 16:09:09 +0100810 return DeviceVector();
Eric Laurent87ffa392015-05-22 10:32:38 -0700811 }
François Gaffie11d30102018-11-02 16:09:09 +0100812 return mAvailableInputDevices.getDevicesFromHwModule(
Mikhail Naganov93661932018-07-26 14:37:41 -0700813 mPrimaryOutput->getModuleHandle());
François Gaffie53615e22015-03-19 09:24:12 +0100814 }
François Gaffieaca677c2018-05-03 10:47:50 +0200815 /**
816 * @brief getFirstDeviceId of the Device Vector
817 * @return if the collection is not empty, it returns the first device Id,
818 * otherwise AUDIO_PORT_HANDLE_NONE
819 */
820 audio_port_handle_t getFirstDeviceId(const DeviceVector &devices) const
821 {
822 return (devices.size() > 0) ? devices.itemAt(0)->getId() : AUDIO_PORT_HANDLE_NONE;
823 }
824 String8 getFirstDeviceAddress(const DeviceVector &devices) const
825 {
jiabince9f20e2019-09-12 16:29:15 -0700826 return (devices.size() > 0) ?
827 String8(devices.itemAt(0)->address().c_str()) : String8("");
François Gaffieaca677c2018-05-03 10:47:50 +0200828 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800829
Francois Gaffie19fd6c52021-02-04 17:02:59 +0100830 status_t updateCallRouting(
831 bool fromCache, uint32_t delayMs = 0, uint32_t *waitMs = nullptr);
832 status_t updateCallRoutingInternal(
833 const DeviceVector &rxDevices, uint32_t delayMs, uint32_t *waitMs);
François Gaffie11d30102018-11-02 16:09:09 +0100834 sp<AudioPatch> createTelephonyPatch(bool isRx, const sp<DeviceDescriptor> &device,
835 uint32_t delayMs);
Francois Gaffie19fd6c52021-02-04 17:02:59 +0100836 /**
837 * @brief selectBestRxSinkDevicesForCall: if the primary module host both Telephony Rx/Tx
838 * devices, and it declares also supporting a HW bridge between the Telephony Rx and the
839 * given sink device for Voice Call audio attributes, select this device in prio.
840 * Otherwise, getNewOutputDevices() is called on the primary output to select sink device.
841 * @param fromCache true to prevent engine reconsidering all product strategies and retrieve
842 * from engine cache.
843 * @return vector of devices, empty if none is found.
844 */
845 DeviceVector selectBestRxSinkDevicesForCall(bool fromCache);
Mikhail Naganov100f0122018-11-29 11:22:16 -0800846 bool isDeviceOfModule(const sp<DeviceDescriptor>& devDesc, const char *moduleId) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800847
Eric Laurent97ac8712018-07-27 18:59:02 -0700848 status_t startSource(const sp<SwAudioOutputDescriptor>& outputDesc,
849 const sp<TrackClientDescriptor>& client,
Eric Laurentc75307b2015-03-17 15:29:32 -0700850 uint32_t *delayMs);
Eric Laurent97ac8712018-07-27 18:59:02 -0700851 status_t stopSource(const sp<SwAudioOutputDescriptor>& outputDesc,
852 const sp<TrackClientDescriptor>& client);
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700853
854 void clearAudioPatches(uid_t uid);
855 void clearSessionRoutes(uid_t uid);
François Gaffiec005e562018-11-06 15:04:49 +0100856
857 /**
858 * @brief checkStrategyRoute: when an output is beeing rerouted, reconsider each output
859 * that may host a strategy playing on the considered output.
860 * @param ps product strategy that initiated the rerouting
861 * @param ouptutToSkip output that initiated the rerouting
862 */
863 void checkStrategyRoute(product_strategy_t ps, audio_io_handle_t ouptutToSkip);
Eric Laurentc75307b2015-03-17 15:29:32 -0700864
Eric Laurent87ffa392015-05-22 10:32:38 -0700865 status_t hasPrimaryOutput() const { return mPrimaryOutput != 0; }
866
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700867 status_t connectAudioSource(const sp<SourceClientDescriptor>& sourceDesc);
868 status_t disconnectAudioSource(const sp<SourceClientDescriptor>& sourceDesc);
Eric Laurentd60560a2015-04-10 11:31:20 -0700869
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200870 status_t connectAudioSourceToSink(const sp<SourceClientDescriptor>& sourceDesc,
871 const sp<DeviceDescriptor> &sinkDevice,
872 const struct audio_patch *patch,
873 audio_patch_handle_t &handle,
874 uid_t uid, uint32_t delayMs);
875
François Gaffiec005e562018-11-06 15:04:49 +0100876 sp<SourceClientDescriptor> getSourceForAttributesOnOutput(audio_io_handle_t output,
877 const audio_attributes_t &attr);
Francois Gaffieff1eb522020-05-06 18:37:04 +0200878 void clearAudioSourcesForOutput(audio_io_handle_t output);
Eric Laurentd60560a2015-04-10 11:31:20 -0700879
880 void cleanUpForDevice(const sp<DeviceDescriptor>& deviceDesc);
881
882 void clearAudioSources(uid_t uid);
883
Eric Laurent794fde22016-03-11 09:50:45 -0800884 static bool streamsMatchForvolume(audio_stream_type_t stream1,
885 audio_stream_type_t stream2);
Eric Laurent28d09f02016-03-08 10:43:05 -0800886
Eric Laurent8f42ea12018-08-08 09:08:25 -0700887 void closeActiveClients(const sp<AudioInputDescriptor>& input);
888 void closeClient(audio_port_handle_t portId);
Eric Laurent8fc147b2018-07-22 19:13:55 -0700889
Eric Laurent96d1dda2022-03-14 17:14:19 +0100890 /**
891 * @brief isAnyDeviceTypeActive: returns true if at least one active client is routed to
892 * one of the specified devices
893 * @param deviceTypes list of devices to consider
894 */
895 bool isAnyDeviceTypeActive(const DeviceTypeSet& deviceTypes) const;
896 /**
897 * @brief isLeUnicastActive: returns true if a call is active or at least one active client
898 * is routed to a LE unicast device
899 */
900 bool isLeUnicastActive() const;
901
902 void checkLeBroadcastRoutes(bool wasUnicastActive,
903 sp<SwAudioOutputDescriptor> ignoredOutput, uint32_t delayMs);
904
Andy Hung4ef19fa2018-05-15 19:35:29 -0700905 const uid_t mUidCached; // AID_AUDIOSERVER
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800906 AudioPolicyClientInterface *mpClientInterface; // audio policy client interface
Eric Laurentc75307b2015-03-17 15:29:32 -0700907 sp<SwAudioOutputDescriptor> mPrimaryOutput; // primary output descriptor
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800908 // list of descriptors for outputs currently opened
Eric Laurentc75307b2015-03-17 15:29:32 -0700909
Eric Laurentfa0f6742021-08-17 18:39:44 +0200910 sp<SwAudioOutputDescriptor> mSpatializerOutput;
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200911
Eric Laurentc75307b2015-03-17 15:29:32 -0700912 SwAudioOutputCollection mOutputs;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800913 // copy of mOutputs before setDeviceConnectionState() opens new outputs
914 // reset to mOutputs when updateDevicesAndOutputs() is called.
Eric Laurentc75307b2015-03-17 15:29:32 -0700915 SwAudioOutputCollection mPreviousOutputs;
François Gaffie53615e22015-03-19 09:24:12 +0100916 AudioInputCollection mInputs; // list of input descriptors
Eric Laurentc75307b2015-03-17 15:29:32 -0700917
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000918 DeviceVector mOutputDevicesAll; // all output devices from the config
919 DeviceVector mInputDevicesAll; // all input devices from the config
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800920 DeviceVector mAvailableOutputDevices; // all available output devices
921 DeviceVector mAvailableInputDevices; // all available input devices
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800922
François Gaffiedfd74092015-03-19 12:10:59 +0100923 bool mLimitRingtoneVolume; // limit ringtone volume to music volume if headset connected
François Gaffie11d30102018-11-02 16:09:09 +0100924
François Gaffiedfd74092015-03-19 12:10:59 +0100925 float mLastVoiceVolume; // last voice volume value sent to audio HAL
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800926 bool mA2dpSuspended; // true if A2DP output is suspended
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800927
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800928 EffectDescriptorCollection mEffects; // list of registered audio effects
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800929 sp<DeviceDescriptor> mDefaultOutputDevice; // output device selected by default at boot time
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000930 HwModuleCollection mHwModules; // contains modules that have been loaded successfully
931 HwModuleCollection mHwModulesAll; // contains all modules declared in the config
Eric Laurentf5aa58d2019-02-22 18:20:11 -0800932
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800933 AudioPolicyConfig mConfig;
François Gaffie53615e22015-03-19 09:24:12 +0100934
Mikhail Naganov2773dd72017-12-08 10:12:11 -0800935 std::atomic<uint32_t> mAudioPortGeneration;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800936
François Gaffie53615e22015-03-19 09:24:12 +0100937 AudioPatchCollection mAudioPatches;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800938
François Gaffiedf372692015-03-19 10:43:27 +0100939 SoundTriggerSessionCollection mSoundTriggerSessions;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800940
Eric Laurentd60560a2015-04-10 11:31:20 -0700941 HwAudioOutputCollection mHwOutputs;
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700942 SourceClientCollection mAudioSources;
Eric Laurentd60560a2015-04-10 11:31:20 -0700943
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800944 // for supporting "beacon" streams, i.e. streams that only play on speaker, and never
945 // when something other than STREAM_TTS (a.k.a. "Transmitted Through Speaker") is playing
946 enum {
947 STARTING_OUTPUT,
948 STARTING_BEACON,
949 STOPPING_OUTPUT,
950 STOPPING_BEACON
951 };
952 uint32_t mBeaconMuteRefCount; // ref count for stream that would mute beacon
953 uint32_t mBeaconPlayingRefCount;// ref count for the playing beacon streams
954 bool mBeaconMuted; // has STREAM_TTS been muted
Carter Hsu1a3364a2022-01-21 15:32:56 +0800955 // true if a dedicated output for TTS stream or Ultrasound is available
956 bool mTtsOutputAvailable;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800957
Andy Hung2ddee192015-12-18 17:34:44 -0800958 bool mMasterMono; // true if we wish to force all outputs to mono
François Gaffie036e1e92015-03-19 10:16:24 +0100959 AudioPolicyMixCollection mPolicyMixes; // list of registered mixes
Eric Laurent36829f92017-04-07 19:04:42 -0700960 audio_io_handle_t mMusicEffectOutput; // output selected for music effects
961
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800962 uint32_t nextAudioPortGeneration();
Jean-Michel Trivi887a9ed2015-03-31 18:02:24 -0700963
964 // Audio Policy Engine Interface.
Mikhail Naganov47835552019-05-14 10:32:51 -0700965 EngineInstance mEngine;
jiabin81772902018-04-02 17:52:27 -0700966
Mikhail Naganov100f0122018-11-29 11:22:16 -0800967 // Surround formats that are enabled manually. Taken into account when
968 // "encoded surround" is forced into "manual" mode.
969 std::unordered_set<audio_format_t> mManualSurroundFormats;
Kevin Rocardb99cc752019-03-21 20:52:24 -0700970
971 std::unordered_map<uid_t, audio_flags_mask_t> mAllowedCapturePolicies;
Kriti Dangef6be8f2020-11-05 11:58:19 +0100972
973 // The map of device descriptor and formats reported by the device.
974 std::map<wp<DeviceDescriptor>, FormatVector> mReportedFormatsMap;
Eric Laurent2517af32020-11-25 15:31:27 +0100975
976 // Cached product strategy ID corresponding to legacy strategy STRATEGY_PHONE
977 product_strategy_t mCommunnicationStrategy;
978
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200979 // The port handle of the hardware audio source created internally for the Call RX audio
980 // end point.
Francois Gaffie601801d2021-06-22 13:27:39 +0200981 sp<SourceClientDescriptor> mCallRxSourceClient;
982 sp<SourceClientDescriptor> mCallTxSourceClient;
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200983
Mikhail Naganov15be9d22017-11-08 14:18:13 +1100984 // Support for Multi-Stream Decoder (MSD) module
985 sp<DeviceDescriptor> getMsdAudioInDevice() const;
François Gaffie11d30102018-11-02 16:09:09 +0100986 DeviceVector getMsdAudioOutDevices() const;
Dean Wheatley8bee85a2021-02-10 16:02:23 +1100987 const AudioPatchCollection getMsdOutputPatches() const;
988 status_t getMsdProfiles(bool hwAvSync,
989 const InputProfileCollection &inputProfiles,
990 const OutputProfileCollection &outputProfiles,
991 const sp<DeviceDescriptor> &sourceDevice,
992 const sp<DeviceDescriptor> &sinkDevice,
993 AudioProfileVector &sourceProfiles,
994 AudioProfileVector &sinkProfiles) const;
995 status_t getBestMsdConfig(bool hwAvSync,
996 const AudioProfileVector &sourceProfiles,
997 const AudioProfileVector &sinkProfiles,
998 audio_port_config *sourceConfig,
999 audio_port_config *sinkConfig) const;
1000 PatchBuilder buildMsdPatch(bool msdIsSource, const sp<DeviceDescriptor> &device) const;
1001 status_t setMsdOutputPatches(const DeviceVector *outputDevices = nullptr);
1002 void releaseMsdOutputPatches(const DeviceVector& devices);
Dorin Drimus94d94412022-02-02 09:05:02 +01001003 bool msdHasPatchesToAllDevices(const AudioDeviceTypeAddrVector& devices);
Nathalie Le Clair88fa2752021-11-23 13:03:41 +01001004
1005 // Overload of setDeviceConnectionState()
1006 status_t setDeviceConnectionState(audio_devices_t deviceType,
1007 audio_policy_dev_state_t state,
1008 const char* device_address, const char* device_name,
1009 audio_format_t encodedFormat);
1010
1011 // Called by setDeviceConnectionState()
1012 status_t deviceToAudioPort(audio_devices_t deviceType, const char* device_address,
1013 const char* device_name, media::AudioPort* aidPort);
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001014 bool isMsdPatch(const audio_patch_handle_t &handle) const;
1015
Michael Chan6fb34492020-12-08 15:44:49 +11001016private:
Francois Gaffie601801d2021-06-22 13:27:39 +02001017 sp<SourceClientDescriptor> startAudioSourceInternal(
1018 const struct audio_port_config *source, const audio_attributes_t *attributes,
1019 uid_t uid);
1020
Michael Chan6fb34492020-12-08 15:44:49 +11001021 void onNewAudioModulesAvailableInt(DeviceVector *newDevices);
1022
1023 // Add or remove AC3 DTS encodings based on user preferences.
1024 void modifySurroundFormats(const sp<DeviceDescriptor>& devDesc, FormatVector *formatsPtr);
1025 void modifySurroundChannelMasks(ChannelMaskSet *channelMasksPtr);
Mikhail Naganov15be9d22017-11-08 14:18:13 +11001026
François Gaffie112b0af2015-11-19 16:13:25 +01001027 // If any, resolve any "dynamic" fields of an Audio Profiles collection
Mikhail Naganovd5e18052018-11-30 14:55:45 -08001028 void updateAudioProfiles(const sp<DeviceDescriptor>& devDesc, audio_io_handle_t ioHandle,
Phil Burk00eeb322016-03-31 12:41:00 -07001029 AudioProfileVector &profiles);
François Gaffie112b0af2015-11-19 16:13:25 +01001030
François Gaffie44481e72016-04-20 07:49:57 +02001031 // Notify the policy client of any change of device state with AUDIO_IO_HANDLE_NONE,
1032 // so that the client interprets it as global to audio hardware interfaces.
1033 // It can give a chance to HAL implementer to retrieve dynamic capabilities associated
1034 // to this device for example.
1035 // TODO avoid opening stream to retrieve capabilities of a profile.
François Gaffie11d30102018-11-02 16:09:09 +01001036 void broadcastDeviceConnectionState(const sp<DeviceDescriptor> &device,
1037 audio_policy_dev_state_t state);
François Gaffie44481e72016-04-20 07:49:57 +02001038
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001039 // updates device caching and output for streams that can influence the
1040 // routing of notifications
1041 void handleNotificationRoutingForStream(audio_stream_type_t stream);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001042 uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
Hongwei Wangbb93dfb2018-10-23 13:54:22 -07001043 // internal method, get audio_attributes_t from either a source audio_attributes_t
1044 // or audio_stream_type_t, respectively.
1045 status_t getAudioAttributes(audio_attributes_t *dstAttr,
1046 const audio_attributes_t *srcAttr,
1047 audio_stream_type_t srcStream);
1048 // internal method, called by getOutputForAttr() and connectAudioSource.
1049 status_t getOutputForAttrInt(audio_attributes_t *resultAttr,
1050 audio_io_handle_t *output,
1051 audio_session_t session,
1052 const audio_attributes_t *attr,
1053 audio_stream_type_t *stream,
1054 uid_t uid,
jiabinf1c73972022-04-14 16:28:52 -07001055 audio_config_t *config,
Hongwei Wangbb93dfb2018-10-23 13:54:22 -07001056 audio_output_flags_t *flags,
François Gaffief579db52018-11-13 11:25:16 +01001057 audio_port_handle_t *selectedDeviceId,
Kevin Rocard153f92d2018-12-18 18:33:28 -08001058 bool *isRequestedDeviceForExclusiveUse,
Eric Laurentc529cf62020-04-17 18:19:10 -07001059 std::vector<sp<AudioPolicyMix>> *secondaryMixes,
Eric Laurentb0a7bc92022-04-05 15:06:08 +02001060 output_type_t *outputType,
1061 bool *isSpatialized);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001062 // internal method to return the output handle for the given device and format
François Gaffie11d30102018-11-02 16:09:09 +01001063 audio_io_handle_t getOutputForDevices(
1064 const DeviceVector &devices,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001065 audio_session_t session,
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001066 const audio_attributes_t *attr,
Eric Laurentfe231122017-11-17 17:48:06 -08001067 const audio_config_t *config,
jiabine375d412019-02-26 12:54:53 -08001068 audio_output_flags_t *flags,
Eric Laurentb0a7bc92022-04-05 15:06:08 +02001069 bool *isSpatialized,
jiabine375d412019-02-26 12:54:53 -08001070 bool forceMutingHaptic = false);
François Gaffiec005e562018-11-06 15:04:49 +01001071
Eric Laurentc529cf62020-04-17 18:19:10 -07001072 // Internal method checking if a direct output can be opened matching the requested
1073 // attributes, flags, config and devices.
1074 // If NAME_NOT_FOUND is returned, an attempt can be made to open a mixed output.
1075 status_t openDirectOutput(
1076 audio_stream_type_t stream,
1077 audio_session_t session,
1078 const audio_config_t *config,
1079 audio_output_flags_t flags,
1080 const DeviceVector &devices,
1081 audio_io_handle_t *output);
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001082
Eric Laurentb4f42a92022-01-17 17:37:31 +01001083 /**
1084 * @brief Queries if some kind of spatialization will be performed if the audio playback
1085 * context described by the provided arguments is present.
1086 * The context is made of:
1087 * - The audio attributes describing the playback use case.
1088 * - The audio configuration describing the audio format, channels, sampling rate ...
1089 * - The devices describing the sink audio device selected for playback.
1090 * All arguments are optional and only the specified arguments are used to match against
1091 * supported criteria. For instance, supplying no argument will tell if spatialization is
1092 * supported or not in general.
1093 * @param attr audio attributes describing the playback use case
1094 * @param config audio configuration describing the audio format, channels, sample rate...
1095 * @param devices the sink audio device selected for playback
Eric Laurentb4f42a92022-01-17 17:37:31 +01001096 * @return true if spatialization is possible for this context, false otherwise.
1097 */
1098 virtual bool canBeSpatializedInt(const audio_attributes_t *attr,
1099 const audio_config_t *config,
Andy Hung9dd1a5b2022-05-10 15:39:39 -07001100 const AudioDeviceTypeAddrVector &devices) const;
Eric Laurentb4f42a92022-01-17 17:37:31 +01001101
Eric Laurent0c8f7cc2022-06-24 14:32:36 +02001102
1103 /**
1104 * @brief Gets an IOProfile for a spatializer output with the best match with
1105 * provided arguments.
1106 * The caller can have the devices criteria ignored by passing and empty vector, and
1107 * getSpatializerOutputProfile() will ignore the devices when looking for a match.
1108 * Otherwise an output profile supporting a spatializer effect that can be routed
1109 * to the specified devices must exist.
1110 * @param config audio configuration describing the audio format, channels, sample rate...
1111 * @param devices the sink audio device selected for playback
1112 * @return an IOProfile that canbe used to open a spatializer output.
1113 */
Eric Laurentfa0f6742021-08-17 18:39:44 +02001114 sp<IOProfile> getSpatializerOutputProfile(const audio_config_t *config,
Eric Laurent39095982021-08-24 18:29:27 +02001115 const AudioDeviceTypeAddrVector &devices) const;
1116
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001117 void checkVirtualizerClientRoutes();
1118
François Gaffiec005e562018-11-06 15:04:49 +01001119 /**
Eric Laurente191d1b2022-04-15 11:59:25 +02001120 * @brief Returns true if at least one device can only be reached via the output passed
1121 * as argument. Always returns false for duplicated outputs.
1122 * This can be used to decide if an output can be closed without forbidding
1123 * playback to any given device.
1124 * @param outputDesc the output to consider
1125 * @return true if at least one device can only be reached via the output.
1126 */
1127 bool isOutputOnlyAvailableRouteToSomeDevice(const sp<SwAudioOutputDescriptor>& outputDesc);
1128
1129 /**
François Gaffiec005e562018-11-06 15:04:49 +01001130 * @brief getInputForDevice selects an input handle for a given input device and
1131 * requester context
1132 * @param device to be used by requester, selected by policy mix rules or engine
1133 * @param session requester session id
1134 * @param uid requester uid
1135 * @param attributes requester audio attributes (e.g. input source and tags matter)
jiabinf1c73972022-04-14 16:28:52 -07001136 * @param config requested audio configuration (e.g. sample rate, format, channel mask),
1137 * will be updated if current configuration doesn't support but another
1138 * one does
François Gaffiec005e562018-11-06 15:04:49 +01001139 * @param flags requester input flags
1140 * @param policyMix may be null, policy rules to be followed by the requester
1141 * @return input io handle aka unique input identifier selected for this device.
1142 */
François Gaffie11d30102018-11-02 16:09:09 +01001143 audio_io_handle_t getInputForDevice(const sp<DeviceDescriptor> &device,
Eric Laurent599c7582015-12-07 18:05:55 -08001144 audio_session_t session,
François Gaffiec005e562018-11-06 15:04:49 +01001145 const audio_attributes_t &attributes,
jiabinf1c73972022-04-14 16:28:52 -07001146 audio_config_base_t *config,
Eric Laurent599c7582015-12-07 18:05:55 -08001147 audio_input_flags_t flags,
Mikhail Naganovbfac5832019-03-05 16:55:28 -08001148 const sp<AudioPolicyMix> &policyMix);
Eric Laurent599c7582015-12-07 18:05:55 -08001149
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001150 // event is one of STARTING_OUTPUT, STARTING_BEACON, STOPPING_OUTPUT, STOPPING_BEACON
1151 // returns 0 if no mute/unmute event happened, the largest latency of the device where
1152 // the mute/unmute happened
1153 uint32_t handleEventForBeacon(int event);
1154 uint32_t setBeaconMute(bool mute);
1155 bool isValidAttributes(const audio_attributes_t *paa);
1156
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001157 // Called by setDeviceConnectionState().
Nathalie Le Clair88fa2752021-11-23 13:03:41 +01001158 status_t setDeviceConnectionStateInt(audio_policy_dev_state_t state,
1159 const android::media::audio::common::AudioPort& port,
1160 audio_format_t encodedFormat);
François Gaffie11d30102018-11-02 16:09:09 +01001161 status_t setDeviceConnectionStateInt(audio_devices_t deviceType,
1162 audio_policy_dev_state_t state,
1163 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -08001164 const char *device_name,
1165 audio_format_t encodedFormat);
Mikhail Naganovd0e2c742020-03-25 15:59:59 -07001166 status_t setDeviceConnectionStateInt(const sp<DeviceDescriptor> &device,
1167 audio_policy_dev_state_t state);
Eric Laurent736a1022019-03-27 18:28:46 -07001168
1169 void setEngineDeviceConnectionState(const sp<DeviceDescriptor> device,
1170 audio_policy_dev_state_t state);
1171
Andy Hung2ddee192015-12-18 17:34:44 -08001172 void updateMono(audio_io_handle_t output) {
1173 AudioParameter param;
Mikhail Naganov388360c2016-10-17 17:09:41 -07001174 param.addInt(String8(AudioParameter::keyMonoOutput), (int)mMasterMono);
Andy Hung2ddee192015-12-18 17:34:44 -08001175 mpClientInterface->setParameters(output, param.toString());
1176 }
François Gaffieafd4cea2019-11-18 15:50:22 +01001177
1178 /**
1179 * @brief createAudioPatchInternal internal function to manage audio patch creation
1180 * @param[in] patch structure containing sink and source ports configuration
1181 * @param[out] handle patch handle to be provided if patch installed correctly
1182 * @param[in] uid of the client
1183 * @param[in] delayMs if required
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001184 * @param[in] sourceDesc source client to be configured when creating the patch, i.e.
1185 * assigning an Output (HW or SW) used for volume control.
François Gaffieafd4cea2019-11-18 15:50:22 +01001186 * @return NO_ERROR if patch installed correctly, error code otherwise.
1187 */
1188 status_t createAudioPatchInternal(const struct audio_patch *patch,
1189 audio_patch_handle_t *handle,
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001190 uid_t uid, uint32_t delayMs,
1191 const sp<SourceClientDescriptor>& sourceDesc);
François Gaffieafd4cea2019-11-18 15:50:22 +01001192 /**
1193 * @brief releaseAudioPatchInternal internal function to remove an audio patch
1194 * @param[in] handle of the patch to be removed
1195 * @param[in] delayMs if required
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001196 * @param[in] sourceDesc [optional] in case of external source, source client to be
1197 * unrouted from the patch, i.e. assigning an Output (HW or SW)
François Gaffieafd4cea2019-11-18 15:50:22 +01001198 * @return NO_ERROR if patch removed correctly, error code otherwise.
1199 */
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001200 status_t releaseAudioPatchInternal(audio_patch_handle_t handle,
1201 uint32_t delayMs = 0,
1202 const sp<SourceClientDescriptor>& sourceDesc = nullptr);
François Gaffieafd4cea2019-11-18 15:50:22 +01001203
Mikhail Naganovdc769682018-05-04 15:34:08 -07001204 status_t installPatch(const char *caller,
1205 audio_patch_handle_t *patchHandle,
1206 AudioIODescriptorInterface *ioDescriptor,
1207 const struct audio_patch *patch,
1208 int delayMs);
1209 status_t installPatch(const char *caller,
1210 ssize_t index,
1211 audio_patch_handle_t *patchHandle,
1212 const struct audio_patch *patch,
1213 int delayMs,
1214 uid_t uid,
1215 sp<AudioPatch> *patchDescPtr);
Eric Laurentc529cf62020-04-17 18:19:10 -07001216
1217 bool areAllDevicesSupported(
jiabin6a02d532020-08-07 11:56:38 -07001218 const AudioDeviceTypeAddrVector& devices,
Eric Laurentc529cf62020-04-17 18:19:10 -07001219 std::function<bool(audio_devices_t)> predicate,
1220 const char* context);
1221
Eric Laurent2517af32020-11-25 15:31:27 +01001222 bool isScoRequestedForComm() const;
jiabinbce0c1d2020-10-05 11:20:18 -07001223
Eric Laurent1a8b45f2022-04-13 16:01:47 +02001224 bool isHearingAidUsedForComm() const;
1225
jiabinbce0c1d2020-10-05 11:20:18 -07001226 bool areAllActiveTracksRerouted(const sp<SwAudioOutputDescriptor>& output);
1227
Eric Laurentb4f42a92022-01-17 17:37:31 +01001228 /**
1229 * @brief Opens an output stream from the supplied IOProfile and route it to the
1230 * supplied audio devices. If a mixer config is specified, it is forwarded to audio
1231 * flinger. If not, a default config is derived from the output stream config.
1232 * Also opens a duplicating output if needed and queries the audio HAL for supported
1233 * audio profiles if the IOProfile is dynamic.
1234 * @param[in] profile IOProfile to use as template
1235 * @param[in] devices initial route to apply to this output stream
1236 * @param[in] mixerConfig if not null, use this to configure the mixer
1237 * @return an output descriptor for the newly opened stream or null in case of error.
1238 */
1239 sp<SwAudioOutputDescriptor> openOutputWithProfileAndDevice(
1240 const sp<IOProfile>& profile, const DeviceVector& devices,
1241 const audio_config_base_t *mixerConfig = nullptr);
jiabinbce0c1d2020-10-05 11:20:18 -07001242
jiabin2b9d5a12021-12-10 01:06:29 +00001243 bool isOffloadPossible(const audio_offload_info_t& offloadInfo,
1244 bool durationIgnored = false);
1245
Dorin Drimus94d94412022-02-02 09:05:02 +01001246 // adds the profiles from the outputProfile to the passed audioProfilesVector
1247 // without duplicating them if already present
1248 void addPortProfilesToVector(sp<IOProfile> outputProfile,
1249 AudioProfileVector& audioProfilesVector);
Dorin Drimusecc9f422022-03-09 17:57:40 +01001250
1251 // Searches for a compatible profile with the sample rate, audio format and channel mask
1252 // in the list of passed HwModule(s).
1253 // returns a compatible profile if found, nullptr otherwise
1254 sp<IOProfile> searchCompatibleProfileHwModules (
1255 const HwModuleCollection& hwModules,
1256 const DeviceVector& devices,
1257 uint32_t samplingRate,
1258 audio_format_t format,
1259 audio_channel_mask_t channelMask,
1260 audio_output_flags_t flags,
1261 bool directOnly);
1262
1263 // Filters only the relevant flags for getProfileForOutput
1264 audio_output_flags_t getRelevantFlags (audio_output_flags_t flags, bool directOnly);
jiabinf1c73972022-04-14 16:28:52 -07001265
1266 status_t getDevicesForAttributes(const audio_attributes_t &attr,
1267 DeviceVector &devices,
1268 bool forVolume);
1269
1270 status_t getProfilesForDevices(const DeviceVector& devices,
1271 AudioProfileVector& audioProfiles,
1272 uint32_t flags,
1273 bool isInput);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001274};
1275
1276};