blob: 2d015d39fbf4a265adcb78629fdd7cc515932f34 [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
jiabinc0048632023-04-27 22:04:31 +000038#include <android/media/DeviceConnectedState.h>
Nathalie Le Clair88fa2752021-11-23 13:03:41 +010039#include <android/media/audio/common/AudioPort.h>
François Gaffie2110e042015-03-24 08:41:51 +010040#include <AudioPolicyManagerObserver.h>
Mikhail Naganovad3f8a12017-12-12 13:24:23 -080041#include <AudioPolicyConfig.h>
jiabine1284852019-09-11 10:15:46 -070042#include <PolicyAudioPort.h>
François Gaffie98cc1912015-03-18 17:52:40 +010043#include <AudioPatch.h>
François Gaffie98cc1912015-03-18 17:52:40 +010044#include <DeviceDescriptor.h>
45#include <IOProfile.h>
46#include <HwModule.h>
47#include <AudioInputDescriptor.h>
48#include <AudioOutputDescriptor.h>
François Gaffie036e1e92015-03-19 10:16:24 +010049#include <AudioPolicyMix.h>
François Gaffie45ed3b02015-03-19 10:35:14 +010050#include <EffectDescriptor.h>
jiabina84c3d32022-12-02 18:59:55 +000051#include <PreferredMixerAttributesInfo.h>
François Gaffiedf372692015-03-19 10:43:27 +010052#include <SoundTriggerSession.h>
Mikhail Naganov47835552019-05-14 10:32:51 -070053#include "EngineLibrary.h"
Eric Laurentf5aa58d2019-02-22 18:20:11 -080054#include "TypeConverter.h"
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080055
56namespace android {
57
Svet Ganov3e5f14f2021-05-13 22:51:08 +000058using content::AttributionSourceState;
59
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080060// ----------------------------------------------------------------------------
61
62// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB
Eric Laurentffbc80f2015-03-18 18:30:19 -070063#define SONIFICATION_HEADSET_VOLUME_FACTOR_DB (-6)
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080064// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB
Eric Laurentffbc80f2015-03-18 18:30:19 -070065#define SONIFICATION_HEADSET_VOLUME_MIN_DB (-36)
Jean-Michel Trivi00a20962016-05-25 19:11:01 -070066// Max volume difference on A2DP between playing media and STRATEGY_SONIFICATION streams: 12dB
67#define SONIFICATION_A2DP_MAX_MEDIA_DIFF_DB (12)
Eric Laurentffbc80f2015-03-18 18:30:19 -070068
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080069// Time in milliseconds during which we consider that music is still active after a music
70// track was stopped - see computeVolume()
71#define SONIFICATION_HEADSET_MUSIC_DELAY 5000
François Gaffie2110e042015-03-24 08:41:51 +010072
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080073// Time in milliseconds during witch some streams are muted while the audio path
74// is switched
75#define MUTE_TIME_MS 2000
76
Eric Laurentac3a6902018-05-11 16:39:10 -070077// multiplication factor applied to output latency when calculating a safe mute delay when
78// invalidating tracks
79#define LATENCY_MUTE_FACTOR 4
80
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080081#define NUM_TEST_OUTPUTS 5
82
83#define NUM_VOL_CURVE_KNEES 2
84
85// Default minimum length allowed for offloading a compressed track
86// Can be overridden by the audio.offload.min.duration.secs property
87#define OFFLOAD_DEFAULT_MIN_DURATION_SECS 60
88
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080089// ----------------------------------------------------------------------------
90// AudioPolicyManager implements audio policy manager behavior common to all platforms.
91// ----------------------------------------------------------------------------
92
François Gaffie2110e042015-03-24 08:41:51 +010093class AudioPolicyManager : public AudioPolicyInterface, public AudioPolicyManagerObserver
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080094{
95
96public:
Mikhail Naganov68e3f642023-04-28 13:06:32 -070097 AudioPolicyManager(const sp<const AudioPolicyConfig>& config,
Mikhail Naganovf1b6d972023-05-02 13:56:01 -070098 EngineInstance&& engine,
Mikhail Naganov68e3f642023-04-28 13:06:32 -070099 AudioPolicyClientInterface *clientInterface);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800100 virtual ~AudioPolicyManager();
101
102 // AudioPolicyInterface
Nathalie Le Clair88fa2752021-11-23 13:03:41 +0100103 virtual status_t setDeviceConnectionState(audio_policy_dev_state_t state,
104 const android::media::audio::common::AudioPort& port, audio_format_t encodedFormat);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800105 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
106 const char *device_address);
Pavlin Radoslavovf862bc62016-12-26 18:57:22 -0800107 virtual status_t handleDeviceConfigChange(audio_devices_t device,
108 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800109 const char *device_name,
110 audio_format_t encodedFormat);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800111 virtual void setPhoneState(audio_mode_t state);
112 virtual void setForceUse(audio_policy_force_use_t usage,
113 audio_policy_forced_cfg_t config);
114 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
François Gaffie2110e042015-03-24 08:41:51 +0100115
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800116 virtual void setSystemProperty(const char* property, const char* value);
117 virtual status_t initCheck();
Eric Laurentf4e63452017-11-06 19:31:46 +0000118 virtual audio_io_handle_t getOutput(audio_stream_type_t stream);
Kevin Rocard153f92d2018-12-18 18:33:28 -0800119 status_t getOutputForAttr(const audio_attributes_t *attr,
120 audio_io_handle_t *output,
121 audio_session_t session,
122 audio_stream_type_t *stream,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000123 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700124 audio_config_t *config,
Kevin Rocard153f92d2018-12-18 18:33:28 -0800125 audio_output_flags_t *flags,
126 audio_port_handle_t *selectedDeviceId,
127 audio_port_handle_t *portId,
Eric Laurent8a1095a2019-11-08 14:44:16 -0800128 std::vector<audio_io_handle_t> *secondaryOutputs,
Eric Laurentb0a7bc92022-04-05 15:06:08 +0200129 output_type_t *outputType,
jiabinc658e452022-10-21 20:52:21 +0000130 bool *isSpatialized,
131 bool *isBitPerfect) override;
Eric Laurent8fc147b2018-07-22 19:13:55 -0700132 virtual status_t startOutput(audio_port_handle_t portId);
133 virtual status_t stopOutput(audio_port_handle_t portId);
jiabinbce0c1d2020-10-05 11:20:18 -0700134 virtual bool releaseOutput(audio_port_handle_t portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800135 virtual status_t getInputForAttr(const audio_attributes_t *attr,
136 audio_io_handle_t *input,
Mikhail Naganov2996f672019-04-18 12:29:59 -0700137 audio_unique_id_t riid,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800138 audio_session_t session,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000139 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700140 audio_config_base_t *config,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800141 audio_input_flags_t flags,
Eric Laurent2ac76942017-06-22 17:17:09 -0700142 audio_port_handle_t *selectedDeviceId,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800143 input_type_t *inputType,
Marvin Ramine5a122d2023-12-07 13:57:59 +0100144 audio_port_handle_t *portId,
145 uint32_t *virtualDeviceId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800146
147 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800148 virtual status_t startInput(audio_port_handle_t portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800149
150 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700151 virtual status_t stopInput(audio_port_handle_t portId);
152 virtual void releaseInput(audio_port_handle_t portId);
Eric Laurent0dd51852019-04-19 18:18:58 -0700153 virtual void checkCloseInputs();
François Gaffie251c7f02018-11-07 10:41:08 +0100154 /**
155 * @brief initStreamVolume: even if the engine volume files provides min and max, keep this
156 * api for compatibility reason.
157 * AudioServer will get the min and max and may overwrite them if:
158 * -using property (highest priority)
159 * -not defined (-1 by convention), case when still using apm volume tables XML files
160 * @param stream to be considered
161 * @param indexMin to set
162 * @param indexMax to set
163 */
164 virtual void initStreamVolume(audio_stream_type_t stream, int indexMin, int indexMax);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800165 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
166 int index,
167 audio_devices_t device);
168 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
169 int *index,
170 audio_devices_t device);
171
François Gaffiecfe17322018-11-07 13:41:29 +0100172 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
173 int index,
174 audio_devices_t device);
175 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
176 int &index,
177 audio_devices_t device);
178 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr, int &index);
179
180 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr, int &index);
181
François Gaffieaaac0fd2018-11-22 17:56:39 +0100182 status_t setVolumeCurveIndex(int index,
François Gaffiecfe17322018-11-07 13:41:29 +0100183 audio_devices_t device,
184 IVolumeCurves &volumeCurves);
185
186 status_t getVolumeIndex(const IVolumeCurves &curves, int &index,
jiabin9a3361e2019-10-01 09:38:30 -0700187 const DeviceTypeSet& deviceTypes) const;
François Gaffiecfe17322018-11-07 13:41:29 +0100188
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800189 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800190 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream)
François Gaffiec005e562018-11-06 15:04:49 +0100191 {
192 return streamToStrategy(stream);
193 }
194 product_strategy_t streamToStrategy(audio_stream_type_t stream) const
195 {
196 auto attributes = mEngine->getAttributesForStreamType(stream);
197 return mEngine->getProductStrategyForAttributes(attributes);
198 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800199
Andy Hung6d23c0f2022-02-16 09:37:15 -0800200 /**
201 * Returns a vector of devices associated with attributes.
202 *
203 * An AudioTrack opened with specified attributes should play on the returned devices.
204 * If forVolume is set to true, the caller is AudioService, determining the proper
205 * device volume to adjust.
206 *
207 * Devices are determined in the following precedence:
208 * 1) Devices associated with a dynamic policy matching the attributes. This is often
209 * a remote submix from MIX_ROUTE_FLAG_LOOP_BACK. Secondary mixes from a
210 * dynamic policy are not included.
211 *
212 * If no such dynamic policy then
213 * 2) Devices containing an active client using setPreferredDevice
214 * with same strategy as the attributes.
215 * (from the default Engine::getOutputDevicesForAttributes() implementation).
216 *
217 * If no corresponding active client with setPreferredDevice then
218 * 3) Devices associated with the strategy determined by the attributes
219 * (from the default Engine::getOutputDevicesForAttributes() implementation).
220 *
221 * @param attributes to be considered
222 * @param devices an AudioDeviceTypeAddrVector container passed in that
223 * will be filled on success.
224 * @param forVolume true if the devices are to be associated with current device volume.
225 * @return NO_ERROR on success.
226 */
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800227 virtual status_t getDevicesForAttributes(
228 const audio_attributes_t &attributes,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800229 AudioDeviceTypeAddrVector *devices,
230 bool forVolume);
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800231
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800232 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc = NULL);
233 virtual status_t registerEffect(const effect_descriptor_t *desc,
234 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800235 product_strategy_t strategy,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800236 int session,
237 int id);
Eric Laurentc241b0d2018-11-28 09:08:49 -0800238 virtual status_t unregisterEffect(int id);
239 virtual status_t setEffectEnabled(int id, bool enabled);
Eric Laurent6c796322019-04-09 14:13:17 -0700240 status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) override;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800241
Eric Laurentc75307b2015-03-17 15:29:32 -0700242 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800243 // return whether a stream is playing remotely, override to change the definition of
244 // local/remote playback, used for instance by notification manager to not make
245 // media players lose audio focus when not playing locally
246 // For the base implementation, "remotely" means playing during screen mirroring which
247 // uses an output for playback with a non-empty, non "0" address.
Eric Laurentc75307b2015-03-17 15:29:32 -0700248 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
249 uint32_t inPastMs = 0) const;
250
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800251 virtual bool isSourceActive(audio_source_t source) const;
252
Mikhail Naganov100f0122018-11-29 11:22:16 -0800253 // helpers for dump(int fd)
254 void dumpManualSurroundFormats(String8 *dst) const;
255 void dump(String8 *dst) const;
Andy Hungc29d82b2018-10-05 12:23:17 -0700256
257 status_t dump(int fd) override;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800258
Kevin Rocardb99cc752019-03-21 20:52:24 -0700259 status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t capturePolicy) override;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100260 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800261
Michael Chana94fbb22018-04-24 14:31:19 +1000262 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
263 const audio_attributes_t& attributes);
264
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800265 virtual status_t listAudioPorts(audio_port_role_t role,
266 audio_port_type_t type,
267 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800268 struct audio_port_v7 *ports,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800269 unsigned int *generation);
Mikhail Naganov5edc5ed2023-03-23 14:52:15 -0700270 status_t listDeclaredDevicePorts(media::AudioPortRole role,
271 std::vector<media::AudioPortFw>* result) override;
jiabin19cdba52020-11-24 11:28:58 -0800272 virtual status_t getAudioPort(struct audio_port_v7 *port);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800273 virtual status_t createAudioPatch(const struct audio_patch *patch,
274 audio_patch_handle_t *handle,
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200275 uid_t uid);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800276 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
277 uid_t uid);
278 virtual status_t listAudioPatches(unsigned int *num_patches,
279 struct audio_patch *patches,
280 unsigned int *generation);
281 virtual status_t setAudioPortConfig(const struct audio_port_config *config);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800282
Eric Laurentd60560a2015-04-10 11:31:20 -0700283 virtual void releaseResourcesForUid(uid_t uid);
284
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800285 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
286 audio_io_handle_t *ioHandle,
287 audio_devices_t *device);
288
François Gaffiedf372692015-03-19 10:43:27 +0100289 virtual status_t releaseSoundTriggerSession(audio_session_t session)
290 {
291 return mSoundTriggerSessions.releaseSession(session);
292 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800293
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700294 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800295 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes);
Marvin Raminbdefaf02023-11-01 09:10:32 +0100296 virtual status_t getRegisteredPolicyMixes(std::vector<AudioMix>& mixes) override;
Jan Sebechlebsky0af8e872023-08-11 14:45:08 +0200297 virtual status_t updatePolicyMix(
298 const AudioMix& mix,
299 const std::vector<AudioMixMatchCriterion>& updatedCriteria) override;
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800300 virtual status_t setUidDeviceAffinities(uid_t uid,
jiabin6a02d532020-08-07 11:56:38 -0700301 const AudioDeviceTypeAddrVector& devices);
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800302 virtual status_t removeUidDeviceAffinities(uid_t uid);
Oscar Azucena90e77632019-11-27 17:12:28 -0800303 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700304 const AudioDeviceTypeAddrVector& devices);
Oscar Azucena90e77632019-11-27 17:12:28 -0800305 virtual status_t removeUserIdDeviceAffinities(int userId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800306
jiabin0a488932020-08-07 17:32:40 -0700307 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
308 device_role_t role,
309 const AudioDeviceTypeAddrVector &devices);
310
311 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
Paul Wang5d7cdb52022-11-22 09:45:06 +0000312 device_role_t role,
313 const AudioDeviceTypeAddrVector &devices);
jiabin0a488932020-08-07 17:32:40 -0700314
Paul Wang5d7cdb52022-11-22 09:45:06 +0000315 virtual status_t clearDevicesRoleForStrategy(product_strategy_t strategy,
316 device_role_t role);
jiabin0a488932020-08-07 17:32:40 -0700317
318 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
319 device_role_t role,
320 AudioDeviceTypeAddrVector &devices);
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700321
Jiabin Huang3b98d322020-09-03 17:54:16 +0000322 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
323 device_role_t role,
324 const AudioDeviceTypeAddrVector &devices);
325
326 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
327 device_role_t role,
328 const AudioDeviceTypeAddrVector &devices);
329
330 virtual status_t removeDevicesRoleForCapturePreset(
331 audio_source_t audioSource, device_role_t role,
332 const AudioDeviceTypeAddrVector& devices);
333
334 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
335 device_role_t role);
336
337 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
338 device_role_t role,
339 AudioDeviceTypeAddrVector &devices);
340
Eric Laurent554a2772015-04-10 11:29:24 -0700341 virtual status_t startAudioSource(const struct audio_port_config *source,
342 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700343 audio_port_handle_t *portId,
Eric Laurent541a2002024-01-15 18:11:42 +0100344 uid_t uid,
345 bool internal = false);
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700346 virtual status_t stopAudioSource(audio_port_handle_t portId);
Eric Laurent554a2772015-04-10 11:29:24 -0700347
Andy Hung2ddee192015-12-18 17:34:44 -0800348 virtual status_t setMasterMono(bool mono);
349 virtual status_t getMasterMono(bool *mono);
Eric Laurentac9cef52017-06-09 15:46:26 -0700350 virtual float getStreamVolumeDB(
351 audio_stream_type_t stream, int index, audio_devices_t device);
Andy Hung2ddee192015-12-18 17:34:44 -0800352
jiabin81772902018-04-02 17:52:27 -0700353 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
354 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100355 bool *surroundFormatsEnabled);
356 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
357 audio_format_t *surroundFormats);
jiabin81772902018-04-02 17:52:27 -0700358 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled);
359
Pattydd807582021-11-04 21:01:03 +0800360 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
361 audio_devices_t device, std::vector<audio_format_t> *formats);
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800362
Eric Laurent5ada82e2019-08-29 17:53:54 -0700363 virtual void setAppState(audio_port_handle_t portId, app_state_t state);
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800364
jiabin6012f912018-11-02 17:06:30 -0700365 virtual bool isHapticPlaybackSupported();
366
Carter Hsu325a8eb2022-01-19 19:56:51 +0800367 virtual bool isUltrasoundSupported();
368
Atneya Nair698f5ef2022-12-15 16:15:09 -0800369 bool isHotwordStreamSupported(bool lookbackAudio) override;
370
François Gaffied0ba9ed2018-11-05 11:50:42 +0100371 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies)
372 {
373 return mEngine->listAudioProductStrategies(strategies);
374 }
375
Francois Gaffie11b65922020-09-24 16:59:08 +0200376 virtual status_t getProductStrategyFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200377 const audio_attributes_t &aa, product_strategy_t &productStrategy,
Francois Gaffie11b65922020-09-24 16:59:08 +0200378 bool fallbackOnDefault)
François Gaffied0ba9ed2018-11-05 11:50:42 +0100379 {
François Gaffie1e2b56f2022-04-01 14:34:29 +0200380 productStrategy = mEngine->getProductStrategyForAttributes(aa, fallbackOnDefault);
Francois Gaffie11b65922020-09-24 16:59:08 +0200381 return (fallbackOnDefault && productStrategy == PRODUCT_STRATEGY_NONE) ?
382 BAD_VALUE : NO_ERROR;
François Gaffie4b2018b2018-11-07 11:18:59 +0100383 }
384
385 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups)
386 {
387 return mEngine->listAudioVolumeGroups(groups);
388 }
389
Francois Gaffie11b65922020-09-24 16:59:08 +0200390 virtual status_t getVolumeGroupFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200391 const audio_attributes_t &aa, volume_group_t &volumeGroup, bool fallbackOnDefault)
François Gaffie4b2018b2018-11-07 11:18:59 +0100392 {
François Gaffie1e2b56f2022-04-01 14:34:29 +0200393 volumeGroup = mEngine->getVolumeGroupForAttributes(aa, fallbackOnDefault);
Francois Gaffie11b65922020-09-24 16:59:08 +0200394 return (fallbackOnDefault && volumeGroup == VOLUME_GROUP_NONE) ?
395 BAD_VALUE : NO_ERROR;
François Gaffied0ba9ed2018-11-05 11:50:42 +0100396 }
397
Eric Laurentfa0f6742021-08-17 18:39:44 +0200398 virtual bool canBeSpatialized(const audio_attributes_t *attr,
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200399 const audio_config_t *config,
Eric Laurentb4f42a92022-01-17 17:37:31 +0100400 const AudioDeviceTypeAddrVector &devices) const {
401 return canBeSpatializedInt(attr, config, devices);
402 }
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200403
Eric Laurentfa0f6742021-08-17 18:39:44 +0200404 virtual status_t getSpatializerOutput(const audio_config_base_t *config,
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200405 const audio_attributes_t *attr,
406 audio_io_handle_t *output);
407
Eric Laurentfa0f6742021-08-17 18:39:44 +0200408 virtual status_t releaseSpatializerOutput(audio_io_handle_t output);
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200409
jiabin2b9d5a12021-12-10 01:06:29 +0000410 virtual audio_direct_mode_t getDirectPlaybackSupport(const audio_attributes_t *attr,
411 const audio_config_t *config);
412
Dorin Drimusf2196d82022-01-03 12:11:18 +0100413 virtual status_t getDirectProfilesForAttributes(const audio_attributes_t* attr,
414 AudioProfileVector& audioProfiles);
415
jiabina84c3d32022-12-02 18:59:55 +0000416 status_t getSupportedMixerAttributes(
417 audio_port_handle_t portId,
418 std::vector<audio_mixer_attributes_t>& mixerAttrs) override;
419 status_t setPreferredMixerAttributes(
420 const audio_attributes_t* attr,
421 audio_port_handle_t portId,
422 uid_t uid,
423 const audio_mixer_attributes_t* mixerAttributes) override;
424 status_t getPreferredMixerAttributes(const audio_attributes_t* attr,
425 audio_port_handle_t portId,
426 audio_mixer_attributes_t* mixerAttributes) override;
427 status_t clearPreferredMixerAttributes(const audio_attributes_t* attr,
428 audio_port_handle_t portId,
429 uid_t uid) override;
430
Eric Laurent8340e672019-11-06 11:01:08 -0800431 bool isCallScreenModeSupported() override;
432
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000433 void onNewAudioModulesAvailable() override;
434
Eric Laurentcaafba42019-07-13 10:12:45 -0700435 status_t initialize();
436
Paul McLeanaa981192015-03-21 09:55:15 -0700437protected:
Mikhail Naganov68e3f642023-04-28 13:06:32 -0700438 const AudioPolicyConfig& getConfig() const { return *(mConfig.get()); }
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800439
François Gaffie2110e042015-03-24 08:41:51 +0100440 // From AudioPolicyManagerObserver
441 virtual const AudioPatchCollection &getAudioPatches() const
442 {
443 return mAudioPatches;
444 }
445 virtual const SoundTriggerSessionCollection &getSoundTriggerSessionCollection() const
446 {
447 return mSoundTriggerSessions;
448 }
449 virtual const AudioPolicyMixCollection &getAudioPolicyMixCollection() const
450 {
451 return mPolicyMixes;
452 }
Eric Laurentc75307b2015-03-17 15:29:32 -0700453 virtual const SwAudioOutputCollection &getOutputs() const
François Gaffie2110e042015-03-24 08:41:51 +0100454 {
455 return mOutputs;
456 }
457 virtual const AudioInputCollection &getInputs() const
458 {
459 return mInputs;
460 }
Eric Laurentaf377772019-03-29 14:50:21 -0700461 virtual const DeviceVector getAvailableOutputDevices() const
François Gaffie2110e042015-03-24 08:41:51 +0100462 {
Kevin Rocarde0d004f2019-10-10 10:06:18 +0000463 return mAvailableOutputDevices.filterForEngine();
François Gaffie2110e042015-03-24 08:41:51 +0100464 }
Eric Laurentaf377772019-03-29 14:50:21 -0700465 virtual const DeviceVector getAvailableInputDevices() const
François Gaffie2110e042015-03-24 08:41:51 +0100466 {
Francois Gaffie698d3532019-04-10 15:20:05 +0200467 // legacy and non-legacy remote-submix are managed by the engine, do not filter
468 return mAvailableInputDevices;
François Gaffie2110e042015-03-24 08:41:51 +0100469 }
François Gaffie2110e042015-03-24 08:41:51 +0100470 virtual const sp<DeviceDescriptor> &getDefaultOutputDevice() const
471 {
Mikhail Naganov68e3f642023-04-28 13:06:32 -0700472 return mConfig->getDefaultOutputDevice();
François Gaffie2110e042015-03-24 08:41:51 +0100473 }
Mikhail Naganovd4120142017-12-06 15:49:22 -0800474
François Gaffieaaac0fd2018-11-22 17:56:39 +0100475 std::vector<volume_group_t> getVolumeGroups() const
476 {
477 return mEngine->getVolumeGroups();
478 }
479
480 VolumeSource toVolumeSource(volume_group_t volumeGroup) const
481 {
482 return static_cast<VolumeSource>(volumeGroup);
483 }
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100484 /**
485 * @brief toVolumeSource converts an audio attributes into a volume source
486 * (either a legacy stream or a volume group). If fallback on default is allowed, and if
487 * the audio attributes do not follow any specific product strategy's rule, it will be
488 * associated to default volume source, e.g. music. Thus, any of call of volume API
489 * using this translation function may affect the default volume source.
490 * If fallback is not allowed and no matching rule is identified for the given attributes,
491 * the volume source will be undefined, thus, no volume will be altered/modified.
492 * @param attributes to be considered
493 * @param fallbackOnDefault
494 * @return volume source associated with given attributes, otherwise either music if
495 * fallbackOnDefault is set or none.
496 */
497 VolumeSource toVolumeSource(
498 const audio_attributes_t &attributes, bool fallbackOnDefault = true) const
François Gaffieaaac0fd2018-11-22 17:56:39 +0100499 {
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100500 return toVolumeSource(mEngine->getVolumeGroupForAttributes(
501 attributes, fallbackOnDefault));
François Gaffieaaac0fd2018-11-22 17:56:39 +0100502 }
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100503 VolumeSource toVolumeSource(
504 audio_stream_type_t stream, bool fallbackOnDefault = true) const
François Gaffieaaac0fd2018-11-22 17:56:39 +0100505 {
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100506 return toVolumeSource(mEngine->getVolumeGroupForStreamType(
507 stream, fallbackOnDefault));
François Gaffieaaac0fd2018-11-22 17:56:39 +0100508 }
509 IVolumeCurves &getVolumeCurves(VolumeSource volumeSource)
510 {
511 auto *curves = mEngine->getVolumeCurvesForVolumeGroup(
512 static_cast<volume_group_t>(volumeSource));
513 ALOG_ASSERT(curves != nullptr, "No curves for volume source %d", volumeSource);
514 return *curves;
515 }
Eric Laurentf5aa58d2019-02-22 18:20:11 -0800516 IVolumeCurves &getVolumeCurves(const audio_attributes_t &attr)
517 {
518 auto *curves = mEngine->getVolumeCurvesForAttributes(attr);
519 ALOG_ASSERT(curves != nullptr, "No curves for attributes %s", toString(attr).c_str());
520 return *curves;
521 }
522 IVolumeCurves &getVolumeCurves(audio_stream_type_t stream)
523 {
524 auto *curves = mEngine->getVolumeCurvesForStreamType(stream);
525 ALOG_ASSERT(curves != nullptr, "No curves for stream %s", toString(stream).c_str());
526 return *curves;
527 }
528
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700529 void addOutput(audio_io_handle_t output, const sp<SwAudioOutputDescriptor>& outputDesc);
François Gaffie53615e22015-03-19 09:24:12 +0100530 void removeOutput(audio_io_handle_t output);
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700531 void addInput(audio_io_handle_t input, const sp<AudioInputDescriptor>& inputDesc);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800532
Francois Gaffie3523ab32021-06-22 13:24:34 +0200533 /**
534 * @brief setOutputDevices change the route of the specified output.
Jaideep Sharma4b5c4252023-07-27 14:47:32 +0530535 * @param caller of the method
Francois Gaffie3523ab32021-06-22 13:24:34 +0200536 * @param outputDesc to be considered
537 * @param device to be considered to route the output
538 * @param force if true, force the routing even if no change.
539 * @param delayMs if specified, delay to apply for mute/volume op when changing device
540 * @param patchHandle if specified, the patch handle this output is connected through.
541 * @param requiresMuteCheck if specified, for e.g. when another output is on a shared device
542 * and currently active, allow to have proper drain and avoid pops
543 * @param requiresVolumeCheck true if called requires to reapply volume if the routing did
544 * not change (but the output is still routed).
Oscar Azucena29956552023-04-27 16:32:09 -0700545 * @param skipMuteDelay if true will skip mute delay when installing audio patch
Francois Gaffie3523ab32021-06-22 13:24:34 +0200546 * @return the number of ms we have slept to allow new routing to take effect in certain
Oscar Azucena29956552023-04-27 16:32:09 -0700547 * cases.
Francois Gaffie3523ab32021-06-22 13:24:34 +0200548 */
Jaideep Sharma4b5c4252023-07-27 14:47:32 +0530549 uint32_t setOutputDevices(const char *caller,
550 const sp<SwAudioOutputDescriptor>& outputDesc,
François Gaffie11d30102018-11-02 16:09:09 +0100551 const DeviceVector &device,
552 bool force = false,
553 int delayMs = 0,
554 audio_patch_handle_t *patchHandle = NULL,
Francois Gaffie3523ab32021-06-22 13:24:34 +0200555 bool requiresMuteCheck = true,
Oscar Azucena29956552023-04-27 16:32:09 -0700556 bool requiresVolumeCheck = false,
557 bool skipMuteDelay = false);
Eric Laurentc75307b2015-03-17 15:29:32 -0700558 status_t resetOutputDevice(const sp<AudioOutputDescriptor>& outputDesc,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800559 int delayMs = 0,
560 audio_patch_handle_t *patchHandle = NULL);
561 status_t setInputDevice(audio_io_handle_t input,
François Gaffie11d30102018-11-02 16:09:09 +0100562 const sp<DeviceDescriptor> &device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800563 bool force = false,
564 audio_patch_handle_t *patchHandle = NULL);
565 status_t resetInputDevice(audio_io_handle_t input,
566 audio_patch_handle_t *patchHandle = NULL);
567
Oscar Azucenae763f7a2024-03-27 18:56:02 -0700568 /**
569 * Compute volume in DB that should be applied for a volume source and device types for a
570 * particular volume index.
571 *
572 * <p><b>Note:</b>Internally the compute method recursively calls itself to accurately
573 * determine the volume given the currently active sources and devices. Some of the
574 * interaction that require recursive computation are:
575 * <ul>
576 * <li>Match accessibility volume if ringtone volume is much louder</li>
577 * <li>If voice call is active cap other volumes (except ringtone and accessibility)</li>
578 * <li>Attenuate notification if headset is connected to prevent burst in user's ear</li>
579 * <li>Attenuate ringtone if headset is connected and music is not playing and speaker is
580 * part of the devices to prevent burst in user's ear</li>
581 * <li>Limit music volume if headset is connected and notification is also active</li>
582 * </ul>
583 *
584 * @param curves volume curves to use for calculating volume value given the index
585 * @param volumeSource source (use case) of the volume
586 * @param index index to match in the volume curves for the calculation
587 * @param deviceTypes devices that should be considered in the volume curves for the
588 * calculation
589 * @param computeInternalInteraction boolean indicating whether recursive volume computation
590 * should continue within the volume computation. Defaults to {@code true} so the
591 * volume interactions can be computed. Calls within the method should always set the
592 * the value to {@code false} to prevent infinite recursion.
593 * @return computed volume in DB
594 */
595 virtual float computeVolume(IVolumeCurves &curves, VolumeSource volumeSource,
596 int index, const DeviceTypeSet& deviceTypes,
597 bool computeInternalInteraction = true);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800598
Eric Laurent3839bc02018-07-10 18:33:34 -0700599 // rescale volume index from srcStream within range of dstStream
600 int rescaleVolumeIndex(int srcIndex,
Francois Gaffie2ffdfce2019-03-12 11:26:42 +0100601 VolumeSource fromVolumeSource,
602 VolumeSource toVolumeSource);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800603 // check that volume change is permitted, compute and send new volume to audio hardware
François Gaffieaaac0fd2018-11-22 17:56:39 +0100604 virtual status_t checkAndSetVolume(IVolumeCurves &curves,
605 VolumeSource volumeSource, int index,
Eric Laurentc75307b2015-03-17 15:29:32 -0700606 const sp<AudioOutputDescriptor>& outputDesc,
jiabin9a3361e2019-10-01 09:38:30 -0700607 DeviceTypeSet deviceTypes,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800608 int delayMs = 0, bool force = false);
609
Eric Laurentae6e88c2024-01-10 14:42:57 +0100610 void setVoiceVolume(int index, IVolumeCurves &curves, bool isVoiceVolSrc, int delayMs);
611
612 // returns true if the supplied set of volume source and devices are consistent with
613 // call volume rules:
614 // if Bluetooth SCO and voice call use different volume curves:
615 // - do not apply voice call volume if Bluetooth SCO is used for call
616 // - do not apply Bluetooth SCO volume if SCO or Hearing Aid is not used for call.
617 // Also updates the booleans isVoiceVolSrc and isBtScoVolSrc according to the
618 // volume source supplied.
619 bool isVolumeConsistentForCalls(VolumeSource volumeSource,
620 const DeviceTypeSet& deviceTypes,
621 bool& isVoiceVolSrc,
622 bool& isBtScoVolSrc,
623 const char* caller);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800624 // apply all stream volumes to the specified output and device
Eric Laurentc75307b2015-03-17 15:29:32 -0700625 void applyStreamVolumes(const sp<AudioOutputDescriptor>& outputDesc,
jiabin9a3361e2019-10-01 09:38:30 -0700626 const DeviceTypeSet& deviceTypes,
627 int delayMs = 0, bool force = false);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800628
François Gaffiec005e562018-11-06 15:04:49 +0100629 /**
630 * @brief setStrategyMute Mute or unmute all active clients on the considered output
631 * following the given strategy.
632 * @param strategy to be considered
633 * @param on true for mute, false for unmute
634 * @param outputDesc to be considered
635 * @param delayMs
636 * @param device
637 */
638 void setStrategyMute(product_strategy_t strategy,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800639 bool on,
Eric Laurentc75307b2015-03-17 15:29:32 -0700640 const sp<AudioOutputDescriptor>& outputDesc,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800641 int delayMs = 0,
jiabin9a3361e2019-10-01 09:38:30 -0700642 DeviceTypeSet deviceTypes = DeviceTypeSet());
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800643
François Gaffieaaac0fd2018-11-22 17:56:39 +0100644 /**
645 * @brief setVolumeSourceMute Mute or unmute the volume source on the specified output
646 * @param volumeSource to be muted/unmute (may host legacy streams or by extension set of
647 * audio attributes)
648 * @param on true to mute, false to umute
649 * @param outputDesc on which the client following the volume group shall be muted/umuted
650 * @param delayMs
651 * @param device
François Gaffieaaac0fd2018-11-22 17:56:39 +0100652 */
653 void setVolumeSourceMute(VolumeSource volumeSource,
654 bool on,
655 const sp<AudioOutputDescriptor>& outputDesc,
656 int delayMs = 0,
jiabin9a3361e2019-10-01 09:38:30 -0700657 DeviceTypeSet deviceTypes = DeviceTypeSet());
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800658
Jean-Michel Trivi887a9ed2015-03-31 18:02:24 -0700659 audio_mode_t getPhoneState();
660
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800661 // true if device is in a telephony or VoIP call
Eric Laurent96d1dda2022-03-14 17:14:19 +0100662 virtual bool isInCall() const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800663 // true if given state represents a device in a telephony or VoIP call
Eric Laurent96d1dda2022-03-14 17:14:19 +0100664 virtual bool isStateInCall(int state) const;
Eric Laurent74b71512019-11-06 17:21:57 -0800665 // true if playback to call TX or capture from call RX is possible
Eric Laurentf9cccec2022-11-16 19:12:00 +0100666 bool isCallAudioAccessible() const;
667 // true if device is in a telephony or VoIP call or call screening is active
668 bool isInCallOrScreening() const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800669
670 // when a device is connected, checks if an open output can be routed
671 // to this device. If none is open, tries to open one of the available outputs.
672 // Returns an output suitable to this device or 0.
673 // when a device is disconnected, checks if an output is not used any more and
674 // returns its handle if any.
675 // transfers the audio tracks and effects from one output thread to another accordingly.
François Gaffie11d30102018-11-02 16:09:09 +0100676 status_t checkOutputsForDevice(const sp<DeviceDescriptor>& device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800677 audio_policy_dev_state_t state,
François Gaffie11d30102018-11-02 16:09:09 +0100678 SortedVector<audio_io_handle_t>& outputs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800679
François Gaffie11d30102018-11-02 16:09:09 +0100680 status_t checkInputsForDevice(const sp<DeviceDescriptor>& device,
Eric Laurent0dd51852019-04-19 18:18:58 -0700681 audio_policy_dev_state_t state);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800682
683 // close an output and its companion duplicating output.
684 void closeOutput(audio_io_handle_t output);
685
686 // close an input.
687 void closeInput(audio_io_handle_t input);
688
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700689 // runs all the checks required for accommodating changes in devices and outputs
Mikhail Naganov37977152018-07-11 15:54:44 -0700690 // if 'onOutputsChecked' callback is provided, it is executed after the outputs
691 // check via 'checkOutputForAllStrategies'. If the callback returns 'true',
692 // A2DP suspend status is rechecked.
Mikhail Naganov15be9d22017-11-08 14:18:13 +1100693 void checkForDeviceAndOutputChanges(std::function<bool()> onOutputsChecked = nullptr);
Mikhail Naganov37977152018-07-11 15:54:44 -0700694
François Gaffiec005e562018-11-06 15:04:49 +0100695 /**
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700696 * @brief updates routing for all outputs (including call if call in progress).
697 * @param delayMs delay for unmuting if required
Oscar Azucena29956552023-04-27 16:32:09 -0700698 * @param skipDelays if true all the delays will be skip while updating routing
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700699 */
Oscar Azucena29956552023-04-27 16:32:09 -0700700 void updateCallAndOutputRouting(bool forceVolumeReeval = true, uint32_t delayMs = 0,
701 bool skipDelays = false);
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700702
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200703 bool isCallRxAudioSource(const sp<SourceClientDescriptor> &source) {
Francois Gaffie601801d2021-06-22 13:27:39 +0200704 return mCallRxSourceClient != nullptr && source == mCallRxSourceClient;
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200705 }
706
Eric Laurent78b07302022-10-07 16:20:34 +0200707 bool isCallTxAudioSource(const sp<SourceClientDescriptor> &source) {
708 return mCallTxSourceClient != nullptr && source == mCallTxSourceClient;
709 }
710
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200711 void connectTelephonyRxAudioSource();
712
Francois Gaffie601801d2021-06-22 13:27:39 +0200713 void disconnectTelephonyAudioSource(sp<SourceClientDescriptor> &clientDesc);
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200714
715 void connectTelephonyTxAudioSource(const sp<DeviceDescriptor> &srcdevice,
716 const sp<DeviceDescriptor> &sinkDevice,
717 uint32_t delayMs);
718
Francois Gaffie601801d2021-06-22 13:27:39 +0200719 bool isTelephonyRxOrTx(const sp<SwAudioOutputDescriptor>& desc) const {
720 return (mCallRxSourceClient != nullptr && mCallRxSourceClient->belongsToOutput(desc))
721 || (mCallTxSourceClient != nullptr
722 && mCallTxSourceClient->belongsToOutput(desc));
723 }
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200724
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700725 /**
Eric Laurent2517af32020-11-25 15:31:27 +0100726 * @brief updates routing for all inputs.
727 */
728 void updateInputRouting();
729
730 /**
François Gaffiec005e562018-11-06 15:04:49 +0100731 * @brief checkOutputForAttributes checks and if necessary changes outputs used for the
732 * given audio attributes.
733 * must be called every time a condition that affects the output choice for a given
734 * attributes changes: connected device, phone state, force use...
735 * Must be called before updateDevicesAndOutputs()
736 * @param attr to be considered
737 */
738 void checkOutputForAttributes(const audio_attributes_t &attr);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800739
Francois Gaffieff1eb522020-05-06 18:37:04 +0200740 /**
741 * @brief checkAudioSourceForAttributes checks if any AudioSource following the same routing
742 * as the given audio attributes is not routed and try to connect it.
743 * It must be called once checkOutputForAttributes has been called for orphans AudioSource,
744 * aka AudioSource not attached to any Audio Output (e.g. AudioSource connected to direct
745 * Output which has been disconnected (and output closed) due to sink device unavailable).
746 * @param attr to be considered
747 */
748 void checkAudioSourceForAttributes(const audio_attributes_t &attr);
749
François Gaffiec005e562018-11-06 15:04:49 +0100750 bool followsSameRouting(const audio_attributes_t &lAttr,
751 const audio_attributes_t &rAttr) const;
752
753 /**
754 * @brief checkOutputForAllStrategies Same as @see checkOutputForAttributes()
755 * but for a all product strategies in order of priority
756 */
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800757 void checkOutputForAllStrategies();
758
Kevin Rocard153f92d2018-12-18 18:33:28 -0800759 // Same as checkOutputForStrategy but for secondary outputs. Make sure if a secondary
760 // output condition changes, the track is properly rerouted
761 void checkSecondaryOutputs();
762
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800763 // manages A2DP output suspend/restore according to phone state and BT SCO usage
764 void checkA2dpSuspend();
765
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800766 // selects the most appropriate device on output for current state
767 // must be called every time a condition that affects the device choice for a given output is
768 // changed: connected device, phone state, force use, output start, output stop..
769 // see getDeviceForStrategy() for the use of fromCache parameter
François Gaffie11d30102018-11-02 16:09:09 +0100770 DeviceVector getNewOutputDevices(const sp<SwAudioOutputDescriptor>& outputDesc,
771 bool fromCache);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800772
François Gaffiec005e562018-11-06 15:04:49 +0100773 /**
774 * @brief updateDevicesAndOutputs: updates cache of devices of the engine
775 * must be called every time a condition that affects the device choice is changed:
776 * connected device, phone state, force use...
777 * cached values are used by getOutputDevicesForStream()/getDevicesForAttributes if
778 * parameter fromCache is true.
779 * Must be called after checkOutputForAllStrategies()
780 */
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800781 void updateDevicesAndOutputs();
782
783 // selects the most appropriate device on input for current state
François Gaffie11d30102018-11-02 16:09:09 +0100784 sp<DeviceDescriptor> getNewInputDevice(const sp<AudioInputDescriptor>& inputDesc);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800785
François Gaffie45ed3b02015-03-19 10:35:14 +0100786 virtual uint32_t getMaxEffectsCpuLoad()
787 {
788 return mEffects.getMaxEffectsCpuLoad();
789 }
790
791 virtual uint32_t getMaxEffectsMemory()
792 {
793 return mEffects.getMaxEffectsMemory();
794 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800795
François Gaffie11d30102018-11-02 16:09:09 +0100796 SortedVector<audio_io_handle_t> getOutputsForDevices(
797 const DeviceVector &devices, const SwAudioOutputCollection& openOutputs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800798
François Gaffiec005e562018-11-06 15:04:49 +0100799 /**
800 * @brief checkDeviceMuteStrategies mute/unmute strategies
801 * using an incompatible device combination.
802 * if muting, wait for the audio in pcm buffer to be drained before proceeding
803 * if unmuting, unmute only after the specified delay
804 * @param outputDesc
805 * @param prevDevice
806 * @param delayMs
807 * @return the number of ms waited
808 */
809 virtual uint32_t checkDeviceMuteStrategies(const sp<AudioOutputDescriptor>& outputDesc,
810 const DeviceVector &prevDevices,
811 uint32_t delayMs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800812
813 audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
jiabin40573322018-11-08 12:08:02 -0800814 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
815 audio_format_t format = AUDIO_FORMAT_INVALID,
816 audio_channel_mask_t channelMask = AUDIO_CHANNEL_NONE,
jiabinebb6af42020-06-09 17:31:17 -0700817 uint32_t samplingRate = 0,
818 audio_session_t sessionId = AUDIO_SESSION_NONE);
Andy Hungf129b032015-04-07 13:45:50 -0700819 // samplingRate, format, channelMask are in/out and so may be modified
François Gaffie11d30102018-11-02 16:09:09 +0100820 sp<IOProfile> getInputProfile(const sp<DeviceDescriptor> & device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800821 uint32_t& samplingRate,
Andy Hungf129b032015-04-07 13:45:50 -0700822 audio_format_t& format,
823 audio_channel_mask_t& channelMask,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800824 audio_input_flags_t flags);
François Gaffie11d30102018-11-02 16:09:09 +0100825 /**
826 * @brief getProfileForOutput
827 * @param devices vector of descriptors, may be empty if ignoring the device is required
828 * @param samplingRate
829 * @param format
830 * @param channelMask
831 * @param flags
832 * @param directOnly
833 * @return IOProfile to be used if found, nullptr otherwise
834 */
835 sp<IOProfile> getProfileForOutput(const DeviceVector &devices,
Michael Chana94fbb22018-04-24 14:31:19 +1000836 uint32_t samplingRate,
837 audio_format_t format,
838 audio_channel_mask_t channelMask,
839 audio_output_flags_t flags,
840 bool directOnly);
Dorin Drimusecc9f422022-03-09 17:57:40 +0100841 /**
842 * Same as getProfileForOutput, but it looks for an MSD profile
843 */
844 sp<IOProfile> getMsdProfileForOutput(const DeviceVector &devices,
845 uint32_t samplingRate,
846 audio_format_t format,
847 audio_channel_mask_t channelMask,
848 audio_output_flags_t flags,
849 bool directOnly);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800850
Eric Laurent36829f92017-04-07 19:04:42 -0700851 audio_io_handle_t selectOutputForMusicEffects();
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800852
François Gaffie53615e22015-03-19 09:24:12 +0100853 virtual status_t addAudioPatch(audio_patch_handle_t handle, const sp<AudioPatch>& patch)
854 {
855 return mAudioPatches.addAudioPatch(handle, patch);
856 }
857 virtual status_t removeAudioPatch(audio_patch_handle_t handle)
858 {
859 return mAudioPatches.removeAudioPatch(handle);
860 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800861
François Gaffie9eb18552018-11-05 10:33:26 +0100862 bool isPrimaryModule(const sp<HwModule> &module) const
863 {
François Gaffiedb1755b2023-09-01 11:50:35 +0200864 if (module == nullptr || mPrimaryModuleHandle == AUDIO_MODULE_HANDLE_NONE) {
François Gaffie9eb18552018-11-05 10:33:26 +0100865 return false;
866 }
François Gaffiedb1755b2023-09-01 11:50:35 +0200867 return module->getHandle() == mPrimaryModuleHandle;
François Gaffie9eb18552018-11-05 10:33:26 +0100868 }
François Gaffie11d30102018-11-02 16:09:09 +0100869 DeviceVector availablePrimaryOutputDevices() const
François Gaffie53615e22015-03-19 09:24:12 +0100870 {
Eric Laurent87ffa392015-05-22 10:32:38 -0700871 if (!hasPrimaryOutput()) {
François Gaffie11d30102018-11-02 16:09:09 +0100872 return DeviceVector();
Eric Laurent87ffa392015-05-22 10:32:38 -0700873 }
Francois Gaffie716e1432019-01-14 16:58:59 +0100874 return mAvailableOutputDevices.filter(mPrimaryOutput->supportedDevices());
François Gaffie53615e22015-03-19 09:24:12 +0100875 }
François Gaffie11d30102018-11-02 16:09:09 +0100876 DeviceVector availablePrimaryModuleInputDevices() const
François Gaffie53615e22015-03-19 09:24:12 +0100877 {
Eric Laurent87ffa392015-05-22 10:32:38 -0700878 if (!hasPrimaryOutput()) {
François Gaffie11d30102018-11-02 16:09:09 +0100879 return DeviceVector();
Eric Laurent87ffa392015-05-22 10:32:38 -0700880 }
François Gaffie11d30102018-11-02 16:09:09 +0100881 return mAvailableInputDevices.getDevicesFromHwModule(
Mikhail Naganov93661932018-07-26 14:37:41 -0700882 mPrimaryOutput->getModuleHandle());
François Gaffie53615e22015-03-19 09:24:12 +0100883 }
François Gaffieaca677c2018-05-03 10:47:50 +0200884 /**
885 * @brief getFirstDeviceId of the Device Vector
886 * @return if the collection is not empty, it returns the first device Id,
887 * otherwise AUDIO_PORT_HANDLE_NONE
888 */
889 audio_port_handle_t getFirstDeviceId(const DeviceVector &devices) const
890 {
891 return (devices.size() > 0) ? devices.itemAt(0)->getId() : AUDIO_PORT_HANDLE_NONE;
892 }
893 String8 getFirstDeviceAddress(const DeviceVector &devices) const
894 {
jiabince9f20e2019-09-12 16:29:15 -0700895 return (devices.size() > 0) ?
896 String8(devices.itemAt(0)->address().c_str()) : String8("");
François Gaffieaca677c2018-05-03 10:47:50 +0200897 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800898
Francois Gaffie19fd6c52021-02-04 17:02:59 +0100899 status_t updateCallRouting(
900 bool fromCache, uint32_t delayMs = 0, uint32_t *waitMs = nullptr);
901 status_t updateCallRoutingInternal(
902 const DeviceVector &rxDevices, uint32_t delayMs, uint32_t *waitMs);
François Gaffie11d30102018-11-02 16:09:09 +0100903 sp<AudioPatch> createTelephonyPatch(bool isRx, const sp<DeviceDescriptor> &device,
904 uint32_t delayMs);
Francois Gaffie19fd6c52021-02-04 17:02:59 +0100905 /**
906 * @brief selectBestRxSinkDevicesForCall: if the primary module host both Telephony Rx/Tx
907 * devices, and it declares also supporting a HW bridge between the Telephony Rx and the
908 * given sink device for Voice Call audio attributes, select this device in prio.
909 * Otherwise, getNewOutputDevices() is called on the primary output to select sink device.
910 * @param fromCache true to prevent engine reconsidering all product strategies and retrieve
911 * from engine cache.
912 * @return vector of devices, empty if none is found.
913 */
914 DeviceVector selectBestRxSinkDevicesForCall(bool fromCache);
Mikhail Naganov100f0122018-11-29 11:22:16 -0800915 bool isDeviceOfModule(const sp<DeviceDescriptor>& devDesc, const char *moduleId) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800916
Eric Laurent97ac8712018-07-27 18:59:02 -0700917 status_t startSource(const sp<SwAudioOutputDescriptor>& outputDesc,
918 const sp<TrackClientDescriptor>& client,
Eric Laurentc75307b2015-03-17 15:29:32 -0700919 uint32_t *delayMs);
Eric Laurent97ac8712018-07-27 18:59:02 -0700920 status_t stopSource(const sp<SwAudioOutputDescriptor>& outputDesc,
921 const sp<TrackClientDescriptor>& client);
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700922
923 void clearAudioPatches(uid_t uid);
924 void clearSessionRoutes(uid_t uid);
François Gaffiec005e562018-11-06 15:04:49 +0100925
926 /**
927 * @brief checkStrategyRoute: when an output is beeing rerouted, reconsider each output
928 * that may host a strategy playing on the considered output.
929 * @param ps product strategy that initiated the rerouting
930 * @param ouptutToSkip output that initiated the rerouting
931 */
932 void checkStrategyRoute(product_strategy_t ps, audio_io_handle_t ouptutToSkip);
Eric Laurentc75307b2015-03-17 15:29:32 -0700933
Eric Laurent87ffa392015-05-22 10:32:38 -0700934 status_t hasPrimaryOutput() const { return mPrimaryOutput != 0; }
935
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700936 status_t connectAudioSource(const sp<SourceClientDescriptor>& sourceDesc);
937 status_t disconnectAudioSource(const sp<SourceClientDescriptor>& sourceDesc);
Eric Laurentd60560a2015-04-10 11:31:20 -0700938
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200939 status_t connectAudioSourceToSink(const sp<SourceClientDescriptor>& sourceDesc,
940 const sp<DeviceDescriptor> &sinkDevice,
941 const struct audio_patch *patch,
942 audio_patch_handle_t &handle,
943 uid_t uid, uint32_t delayMs);
944
François Gaffiec005e562018-11-06 15:04:49 +0100945 sp<SourceClientDescriptor> getSourceForAttributesOnOutput(audio_io_handle_t output,
946 const audio_attributes_t &attr);
Francois Gaffieff1eb522020-05-06 18:37:04 +0200947 void clearAudioSourcesForOutput(audio_io_handle_t output);
Eric Laurentd60560a2015-04-10 11:31:20 -0700948
949 void cleanUpForDevice(const sp<DeviceDescriptor>& deviceDesc);
950
951 void clearAudioSources(uid_t uid);
952
Eric Laurent794fde22016-03-11 09:50:45 -0800953 static bool streamsMatchForvolume(audio_stream_type_t stream1,
954 audio_stream_type_t stream2);
Eric Laurent28d09f02016-03-08 10:43:05 -0800955
Eric Laurent8f42ea12018-08-08 09:08:25 -0700956 void closeActiveClients(const sp<AudioInputDescriptor>& input);
957 void closeClient(audio_port_handle_t portId);
Eric Laurent8fc147b2018-07-22 19:13:55 -0700958
Eric Laurent96d1dda2022-03-14 17:14:19 +0100959 /**
960 * @brief isAnyDeviceTypeActive: returns true if at least one active client is routed to
961 * one of the specified devices
962 * @param deviceTypes list of devices to consider
963 */
964 bool isAnyDeviceTypeActive(const DeviceTypeSet& deviceTypes) const;
965 /**
966 * @brief isLeUnicastActive: returns true if a call is active or at least one active client
967 * is routed to a LE unicast device
968 */
969 bool isLeUnicastActive() const;
970
971 void checkLeBroadcastRoutes(bool wasUnicastActive,
972 sp<SwAudioOutputDescriptor> ignoredOutput, uint32_t delayMs);
973
Andy Hung4ef19fa2018-05-15 19:35:29 -0700974 const uid_t mUidCached; // AID_AUDIOSERVER
Mikhail Naganov68e3f642023-04-28 13:06:32 -0700975 sp<const AudioPolicyConfig> mConfig;
Mikhail Naganovf1b6d972023-05-02 13:56:01 -0700976 EngineInstance mEngine; // Audio Policy Engine instance
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800977 AudioPolicyClientInterface *mpClientInterface; // audio policy client interface
Eric Laurentc75307b2015-03-17 15:29:32 -0700978 sp<SwAudioOutputDescriptor> mPrimaryOutput; // primary output descriptor
François Gaffiedb1755b2023-09-01 11:50:35 +0200979 // mPrimaryModuleHandle is cached mPrimaryOutput->getModuleHandle();
980 audio_module_handle_t mPrimaryModuleHandle = AUDIO_MODULE_HANDLE_NONE;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800981 // list of descriptors for outputs currently opened
Eric Laurentc75307b2015-03-17 15:29:32 -0700982
Eric Laurentfa0f6742021-08-17 18:39:44 +0200983 sp<SwAudioOutputDescriptor> mSpatializerOutput;
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200984
Eric Laurentc75307b2015-03-17 15:29:32 -0700985 SwAudioOutputCollection mOutputs;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800986 // copy of mOutputs before setDeviceConnectionState() opens new outputs
987 // reset to mOutputs when updateDevicesAndOutputs() is called.
Eric Laurentc75307b2015-03-17 15:29:32 -0700988 SwAudioOutputCollection mPreviousOutputs;
François Gaffie53615e22015-03-19 09:24:12 +0100989 AudioInputCollection mInputs; // list of input descriptors
Eric Laurentc75307b2015-03-17 15:29:32 -0700990
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800991 DeviceVector mAvailableOutputDevices; // all available output devices
992 DeviceVector mAvailableInputDevices; // all available input devices
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800993
François Gaffiedfd74092015-03-19 12:10:59 +0100994 bool mLimitRingtoneVolume; // limit ringtone volume to music volume if headset connected
François Gaffie11d30102018-11-02 16:09:09 +0100995
François Gaffiedfd74092015-03-19 12:10:59 +0100996 float mLastVoiceVolume; // last voice volume value sent to audio HAL
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800997 bool mA2dpSuspended; // true if A2DP output is suspended
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800998
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800999 EffectDescriptorCollection mEffects; // list of registered audio effects
Mikhail Naganovc0d04982020-03-02 21:02:28 +00001000 HwModuleCollection mHwModules; // contains modules that have been loaded successfully
François Gaffie53615e22015-03-19 09:24:12 +01001001
Mikhail Naganov2773dd72017-12-08 10:12:11 -08001002 std::atomic<uint32_t> mAudioPortGeneration;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001003
François Gaffie53615e22015-03-19 09:24:12 +01001004 AudioPatchCollection mAudioPatches;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001005
François Gaffiedf372692015-03-19 10:43:27 +01001006 SoundTriggerSessionCollection mSoundTriggerSessions;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001007
Eric Laurentd60560a2015-04-10 11:31:20 -07001008 HwAudioOutputCollection mHwOutputs;
Eric Laurent3e6c7e12018-07-27 17:09:23 -07001009 SourceClientCollection mAudioSources;
Eric Laurentd60560a2015-04-10 11:31:20 -07001010
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001011 // for supporting "beacon" streams, i.e. streams that only play on speaker, and never
1012 // when something other than STREAM_TTS (a.k.a. "Transmitted Through Speaker") is playing
1013 enum {
1014 STARTING_OUTPUT,
1015 STARTING_BEACON,
1016 STOPPING_OUTPUT,
1017 STOPPING_BEACON
1018 };
1019 uint32_t mBeaconMuteRefCount; // ref count for stream that would mute beacon
1020 uint32_t mBeaconPlayingRefCount;// ref count for the playing beacon streams
1021 bool mBeaconMuted; // has STREAM_TTS been muted
Carter Hsu1a3364a2022-01-21 15:32:56 +08001022 // true if a dedicated output for TTS stream or Ultrasound is available
1023 bool mTtsOutputAvailable;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001024
Andy Hung2ddee192015-12-18 17:34:44 -08001025 bool mMasterMono; // true if we wish to force all outputs to mono
François Gaffie036e1e92015-03-19 10:16:24 +01001026 AudioPolicyMixCollection mPolicyMixes; // list of registered mixes
Eric Laurent36829f92017-04-07 19:04:42 -07001027 audio_io_handle_t mMusicEffectOutput; // output selected for music effects
1028
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001029 uint32_t nextAudioPortGeneration();
Jean-Michel Trivi887a9ed2015-03-31 18:02:24 -07001030
Mikhail Naganov100f0122018-11-29 11:22:16 -08001031 // Surround formats that are enabled manually. Taken into account when
1032 // "encoded surround" is forced into "manual" mode.
1033 std::unordered_set<audio_format_t> mManualSurroundFormats;
Kevin Rocardb99cc752019-03-21 20:52:24 -07001034
1035 std::unordered_map<uid_t, audio_flags_mask_t> mAllowedCapturePolicies;
Kriti Dangef6be8f2020-11-05 11:58:19 +01001036
1037 // The map of device descriptor and formats reported by the device.
1038 std::map<wp<DeviceDescriptor>, FormatVector> mReportedFormatsMap;
Eric Laurent2517af32020-11-25 15:31:27 +01001039
1040 // Cached product strategy ID corresponding to legacy strategy STRATEGY_PHONE
1041 product_strategy_t mCommunnicationStrategy;
1042
Francois Gaffie51c9ccd2020-10-14 18:02:07 +02001043 // The port handle of the hardware audio source created internally for the Call RX audio
1044 // end point.
Francois Gaffie601801d2021-06-22 13:27:39 +02001045 sp<SourceClientDescriptor> mCallRxSourceClient;
1046 sp<SourceClientDescriptor> mCallTxSourceClient;
Francois Gaffie51c9ccd2020-10-14 18:02:07 +02001047
jiabina84c3d32022-12-02 18:59:55 +00001048 std::map<audio_port_handle_t,
1049 std::map<product_strategy_t,
1050 sp<PreferredMixerAttributesInfo>>> mPreferredMixerAttrInfos;
1051
Mikhail Naganov15be9d22017-11-08 14:18:13 +11001052 // Support for Multi-Stream Decoder (MSD) module
1053 sp<DeviceDescriptor> getMsdAudioInDevice() const;
François Gaffie11d30102018-11-02 16:09:09 +01001054 DeviceVector getMsdAudioOutDevices() const;
Dean Wheatley8bee85a2021-02-10 16:02:23 +11001055 const AudioPatchCollection getMsdOutputPatches() const;
1056 status_t getMsdProfiles(bool hwAvSync,
1057 const InputProfileCollection &inputProfiles,
1058 const OutputProfileCollection &outputProfiles,
1059 const sp<DeviceDescriptor> &sourceDevice,
1060 const sp<DeviceDescriptor> &sinkDevice,
1061 AudioProfileVector &sourceProfiles,
1062 AudioProfileVector &sinkProfiles) const;
1063 status_t getBestMsdConfig(bool hwAvSync,
1064 const AudioProfileVector &sourceProfiles,
1065 const AudioProfileVector &sinkProfiles,
1066 audio_port_config *sourceConfig,
1067 audio_port_config *sinkConfig) const;
1068 PatchBuilder buildMsdPatch(bool msdIsSource, const sp<DeviceDescriptor> &device) const;
1069 status_t setMsdOutputPatches(const DeviceVector *outputDevices = nullptr);
1070 void releaseMsdOutputPatches(const DeviceVector& devices);
Dorin Drimus94d94412022-02-02 09:05:02 +01001071 bool msdHasPatchesToAllDevices(const AudioDeviceTypeAddrVector& devices);
Nathalie Le Clair88fa2752021-11-23 13:03:41 +01001072
1073 // Overload of setDeviceConnectionState()
1074 status_t setDeviceConnectionState(audio_devices_t deviceType,
1075 audio_policy_dev_state_t state,
1076 const char* device_address, const char* device_name,
1077 audio_format_t encodedFormat);
1078
1079 // Called by setDeviceConnectionState()
1080 status_t deviceToAudioPort(audio_devices_t deviceType, const char* device_address,
Atneya Nair638a6e42022-12-18 16:45:15 -08001081 const char* device_name, media::AudioPortFw* aidPort);
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001082 bool isMsdPatch(const audio_patch_handle_t &handle) const;
1083
Michael Chan6fb34492020-12-08 15:44:49 +11001084private:
Francois Gaffie601801d2021-06-22 13:27:39 +02001085
Michael Chan6fb34492020-12-08 15:44:49 +11001086 void onNewAudioModulesAvailableInt(DeviceVector *newDevices);
1087
1088 // Add or remove AC3 DTS encodings based on user preferences.
1089 void modifySurroundFormats(const sp<DeviceDescriptor>& devDesc, FormatVector *formatsPtr);
1090 void modifySurroundChannelMasks(ChannelMaskSet *channelMasksPtr);
Mikhail Naganov15be9d22017-11-08 14:18:13 +11001091
jiabin12537fc2023-10-12 17:56:08 +00001092 // If any, resolve any "dynamic" fields of the Audio Profiles collection of and IOProfile
Mikhail Naganovd5e18052018-11-30 14:55:45 -08001093 void updateAudioProfiles(const sp<DeviceDescriptor>& devDesc, audio_io_handle_t ioHandle,
jiabin12537fc2023-10-12 17:56:08 +00001094 const sp<IOProfile> &profiles);
François Gaffie112b0af2015-11-19 16:13:25 +01001095
jiabinc0048632023-04-27 22:04:31 +00001096 // Notify the policy client to prepare for disconnecting external device.
1097 void prepareToDisconnectExternalDevice(const sp<DeviceDescriptor> &device);
1098
François Gaffie44481e72016-04-20 07:49:57 +02001099 // Notify the policy client of any change of device state with AUDIO_IO_HANDLE_NONE,
1100 // so that the client interprets it as global to audio hardware interfaces.
1101 // It can give a chance to HAL implementer to retrieve dynamic capabilities associated
1102 // to this device for example.
1103 // TODO avoid opening stream to retrieve capabilities of a profile.
François Gaffie11d30102018-11-02 16:09:09 +01001104 void broadcastDeviceConnectionState(const sp<DeviceDescriptor> &device,
jiabinc0048632023-04-27 22:04:31 +00001105 media::DeviceConnectedState state);
François Gaffie44481e72016-04-20 07:49:57 +02001106
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001107 // updates device caching and output for streams that can influence the
1108 // routing of notifications
1109 void handleNotificationRoutingForStream(audio_stream_type_t stream);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001110 uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
Hongwei Wangbb93dfb2018-10-23 13:54:22 -07001111 // internal method, get audio_attributes_t from either a source audio_attributes_t
1112 // or audio_stream_type_t, respectively.
1113 status_t getAudioAttributes(audio_attributes_t *dstAttr,
1114 const audio_attributes_t *srcAttr,
1115 audio_stream_type_t srcStream);
1116 // internal method, called by getOutputForAttr() and connectAudioSource.
1117 status_t getOutputForAttrInt(audio_attributes_t *resultAttr,
1118 audio_io_handle_t *output,
1119 audio_session_t session,
1120 const audio_attributes_t *attr,
1121 audio_stream_type_t *stream,
1122 uid_t uid,
jiabinf1c73972022-04-14 16:28:52 -07001123 audio_config_t *config,
Hongwei Wangbb93dfb2018-10-23 13:54:22 -07001124 audio_output_flags_t *flags,
François Gaffief579db52018-11-13 11:25:16 +01001125 audio_port_handle_t *selectedDeviceId,
Kevin Rocard153f92d2018-12-18 18:33:28 -08001126 bool *isRequestedDeviceForExclusiveUse,
Eric Laurentc529cf62020-04-17 18:19:10 -07001127 std::vector<sp<AudioPolicyMix>> *secondaryMixes,
Eric Laurentb0a7bc92022-04-05 15:06:08 +02001128 output_type_t *outputType,
jiabinc658e452022-10-21 20:52:21 +00001129 bool *isSpatialized,
1130 bool *isBitPerfect);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001131 // internal method to return the output handle for the given device and format
François Gaffie11d30102018-11-02 16:09:09 +01001132 audio_io_handle_t getOutputForDevices(
1133 const DeviceVector &devices,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001134 audio_session_t session,
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001135 const audio_attributes_t *attr,
Eric Laurentfe231122017-11-17 17:48:06 -08001136 const audio_config_t *config,
jiabine375d412019-02-26 12:54:53 -08001137 audio_output_flags_t *flags,
Eric Laurentb0a7bc92022-04-05 15:06:08 +02001138 bool *isSpatialized,
jiabina84c3d32022-12-02 18:59:55 +00001139 sp<PreferredMixerAttributesInfo> prefMixerAttrInfo = nullptr,
jiabine375d412019-02-26 12:54:53 -08001140 bool forceMutingHaptic = false);
François Gaffiec005e562018-11-06 15:04:49 +01001141
Eric Laurentc529cf62020-04-17 18:19:10 -07001142 // Internal method checking if a direct output can be opened matching the requested
1143 // attributes, flags, config and devices.
1144 // If NAME_NOT_FOUND is returned, an attempt can be made to open a mixed output.
1145 status_t openDirectOutput(
1146 audio_stream_type_t stream,
1147 audio_session_t session,
1148 const audio_config_t *config,
1149 audio_output_flags_t flags,
1150 const DeviceVector &devices,
1151 audio_io_handle_t *output);
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001152
Eric Laurentb4f42a92022-01-17 17:37:31 +01001153 /**
1154 * @brief Queries if some kind of spatialization will be performed if the audio playback
1155 * context described by the provided arguments is present.
1156 * The context is made of:
1157 * - The audio attributes describing the playback use case.
1158 * - The audio configuration describing the audio format, channels, sampling rate ...
1159 * - The devices describing the sink audio device selected for playback.
1160 * All arguments are optional and only the specified arguments are used to match against
1161 * supported criteria. For instance, supplying no argument will tell if spatialization is
1162 * supported or not in general.
1163 * @param attr audio attributes describing the playback use case
1164 * @param config audio configuration describing the audio format, channels, sample rate...
1165 * @param devices the sink audio device selected for playback
Eric Laurentb4f42a92022-01-17 17:37:31 +01001166 * @return true if spatialization is possible for this context, false otherwise.
1167 */
1168 virtual bool canBeSpatializedInt(const audio_attributes_t *attr,
1169 const audio_config_t *config,
Andy Hung9dd1a5b2022-05-10 15:39:39 -07001170 const AudioDeviceTypeAddrVector &devices) const;
Eric Laurentb4f42a92022-01-17 17:37:31 +01001171
Eric Laurent0c8f7cc2022-06-24 14:32:36 +02001172
1173 /**
1174 * @brief Gets an IOProfile for a spatializer output with the best match with
1175 * provided arguments.
1176 * The caller can have the devices criteria ignored by passing and empty vector, and
1177 * getSpatializerOutputProfile() will ignore the devices when looking for a match.
1178 * Otherwise an output profile supporting a spatializer effect that can be routed
1179 * to the specified devices must exist.
1180 * @param config audio configuration describing the audio format, channels, sample rate...
1181 * @param devices the sink audio device selected for playback
1182 * @return an IOProfile that canbe used to open a spatializer output.
1183 */
Eric Laurentfa0f6742021-08-17 18:39:44 +02001184 sp<IOProfile> getSpatializerOutputProfile(const audio_config_t *config,
Eric Laurent39095982021-08-24 18:29:27 +02001185 const AudioDeviceTypeAddrVector &devices) const;
1186
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001187 void checkVirtualizerClientRoutes();
1188
François Gaffiec005e562018-11-06 15:04:49 +01001189 /**
Eric Laurente191d1b2022-04-15 11:59:25 +02001190 * @brief Returns true if at least one device can only be reached via the output passed
1191 * as argument. Always returns false for duplicated outputs.
1192 * This can be used to decide if an output can be closed without forbidding
1193 * playback to any given device.
1194 * @param outputDesc the output to consider
1195 * @return true if at least one device can only be reached via the output.
1196 */
1197 bool isOutputOnlyAvailableRouteToSomeDevice(const sp<SwAudioOutputDescriptor>& outputDesc);
1198
1199 /**
François Gaffiec005e562018-11-06 15:04:49 +01001200 * @brief getInputForDevice selects an input handle for a given input device and
1201 * requester context
1202 * @param device to be used by requester, selected by policy mix rules or engine
1203 * @param session requester session id
1204 * @param uid requester uid
1205 * @param attributes requester audio attributes (e.g. input source and tags matter)
jiabinf1c73972022-04-14 16:28:52 -07001206 * @param config requested audio configuration (e.g. sample rate, format, channel mask),
1207 * will be updated if current configuration doesn't support but another
1208 * one does
François Gaffiec005e562018-11-06 15:04:49 +01001209 * @param flags requester input flags
1210 * @param policyMix may be null, policy rules to be followed by the requester
1211 * @return input io handle aka unique input identifier selected for this device.
1212 */
François Gaffie11d30102018-11-02 16:09:09 +01001213 audio_io_handle_t getInputForDevice(const sp<DeviceDescriptor> &device,
Eric Laurent599c7582015-12-07 18:05:55 -08001214 audio_session_t session,
François Gaffiec005e562018-11-06 15:04:49 +01001215 const audio_attributes_t &attributes,
jiabinf1c73972022-04-14 16:28:52 -07001216 audio_config_base_t *config,
Eric Laurent599c7582015-12-07 18:05:55 -08001217 audio_input_flags_t flags,
Mikhail Naganovbfac5832019-03-05 16:55:28 -08001218 const sp<AudioPolicyMix> &policyMix);
Eric Laurent599c7582015-12-07 18:05:55 -08001219
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001220 // event is one of STARTING_OUTPUT, STARTING_BEACON, STOPPING_OUTPUT, STOPPING_BEACON
1221 // returns 0 if no mute/unmute event happened, the largest latency of the device where
1222 // the mute/unmute happened
1223 uint32_t handleEventForBeacon(int event);
1224 uint32_t setBeaconMute(bool mute);
1225 bool isValidAttributes(const audio_attributes_t *paa);
1226
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001227 // Called by setDeviceConnectionState().
Nathalie Le Clair88fa2752021-11-23 13:03:41 +01001228 status_t setDeviceConnectionStateInt(audio_policy_dev_state_t state,
1229 const android::media::audio::common::AudioPort& port,
1230 audio_format_t encodedFormat);
François Gaffie11d30102018-11-02 16:09:09 +01001231 status_t setDeviceConnectionStateInt(audio_devices_t deviceType,
1232 audio_policy_dev_state_t state,
1233 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -08001234 const char *device_name,
1235 audio_format_t encodedFormat);
Mikhail Naganovd0e2c742020-03-25 15:59:59 -07001236 status_t setDeviceConnectionStateInt(const sp<DeviceDescriptor> &device,
1237 audio_policy_dev_state_t state);
Eric Laurent736a1022019-03-27 18:28:46 -07001238
1239 void setEngineDeviceConnectionState(const sp<DeviceDescriptor> device,
1240 audio_policy_dev_state_t state);
1241
Andy Hung2ddee192015-12-18 17:34:44 -08001242 void updateMono(audio_io_handle_t output) {
1243 AudioParameter param;
Mikhail Naganov388360c2016-10-17 17:09:41 -07001244 param.addInt(String8(AudioParameter::keyMonoOutput), (int)mMasterMono);
Andy Hung2ddee192015-12-18 17:34:44 -08001245 mpClientInterface->setParameters(output, param.toString());
1246 }
François Gaffieafd4cea2019-11-18 15:50:22 +01001247
1248 /**
1249 * @brief createAudioPatchInternal internal function to manage audio patch creation
1250 * @param[in] patch structure containing sink and source ports configuration
1251 * @param[out] handle patch handle to be provided if patch installed correctly
1252 * @param[in] uid of the client
1253 * @param[in] delayMs if required
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001254 * @param[in] sourceDesc source client to be configured when creating the patch, i.e.
1255 * assigning an Output (HW or SW) used for volume control.
François Gaffieafd4cea2019-11-18 15:50:22 +01001256 * @return NO_ERROR if patch installed correctly, error code otherwise.
1257 */
1258 status_t createAudioPatchInternal(const struct audio_patch *patch,
1259 audio_patch_handle_t *handle,
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001260 uid_t uid, uint32_t delayMs,
1261 const sp<SourceClientDescriptor>& sourceDesc);
François Gaffieafd4cea2019-11-18 15:50:22 +01001262 /**
1263 * @brief releaseAudioPatchInternal internal function to remove an audio patch
1264 * @param[in] handle of the patch to be removed
1265 * @param[in] delayMs if required
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001266 * @param[in] sourceDesc [optional] in case of external source, source client to be
1267 * unrouted from the patch, i.e. assigning an Output (HW or SW)
François Gaffieafd4cea2019-11-18 15:50:22 +01001268 * @return NO_ERROR if patch removed correctly, error code otherwise.
1269 */
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001270 status_t releaseAudioPatchInternal(audio_patch_handle_t handle,
1271 uint32_t delayMs = 0,
1272 const sp<SourceClientDescriptor>& sourceDesc = nullptr);
François Gaffieafd4cea2019-11-18 15:50:22 +01001273
Mikhail Naganovdc769682018-05-04 15:34:08 -07001274 status_t installPatch(const char *caller,
1275 audio_patch_handle_t *patchHandle,
1276 AudioIODescriptorInterface *ioDescriptor,
1277 const struct audio_patch *patch,
1278 int delayMs);
1279 status_t installPatch(const char *caller,
1280 ssize_t index,
1281 audio_patch_handle_t *patchHandle,
1282 const struct audio_patch *patch,
1283 int delayMs,
1284 uid_t uid,
1285 sp<AudioPatch> *patchDescPtr);
Eric Laurentc529cf62020-04-17 18:19:10 -07001286
1287 bool areAllDevicesSupported(
jiabin6a02d532020-08-07 11:56:38 -07001288 const AudioDeviceTypeAddrVector& devices,
Eric Laurentc529cf62020-04-17 18:19:10 -07001289 std::function<bool(audio_devices_t)> predicate,
Eric Laurent78fedbf2023-03-09 14:40:44 +01001290 const char* context,
1291 bool matchAddress = true);
Eric Laurentc529cf62020-04-17 18:19:10 -07001292
Oscar Azucena29956552023-04-27 16:32:09 -07001293 /**
1294 * @brief changeOutputDevicesMuteState mute/unmute devices using checkDeviceMuteStrategies
1295 * @param devices devices to mute/unmute
1296 */
1297 void changeOutputDevicesMuteState(const AudioDeviceTypeAddrVector& devices);
1298
1299 /**
1300 * @brief Returns a vector of software output descriptor that support the queried devices
1301 * @param devices devices to query
1302 * @param openOutputs open outputs where the devices are supported as determined by
1303 * SwAudioOutputDescriptor::supportsAtLeastOne
1304 */
1305 std::vector<sp<SwAudioOutputDescriptor>> getSoftwareOutputsForDevices(
1306 const AudioDeviceTypeAddrVector& devices) const;
1307
Eric Laurent2517af32020-11-25 15:31:27 +01001308 bool isScoRequestedForComm() const;
jiabinbce0c1d2020-10-05 11:20:18 -07001309
Eric Laurent1a8b45f2022-04-13 16:01:47 +02001310 bool isHearingAidUsedForComm() const;
1311
jiabinbce0c1d2020-10-05 11:20:18 -07001312 bool areAllActiveTracksRerouted(const sp<SwAudioOutputDescriptor>& output);
1313
Eric Laurentb4f42a92022-01-17 17:37:31 +01001314 /**
1315 * @brief Opens an output stream from the supplied IOProfile and route it to the
1316 * supplied audio devices. If a mixer config is specified, it is forwarded to audio
1317 * flinger. If not, a default config is derived from the output stream config.
1318 * Also opens a duplicating output if needed and queries the audio HAL for supported
1319 * audio profiles if the IOProfile is dynamic.
1320 * @param[in] profile IOProfile to use as template
1321 * @param[in] devices initial route to apply to this output stream
1322 * @param[in] mixerConfig if not null, use this to configure the mixer
jiabina84c3d32022-12-02 18:59:55 +00001323 * @param[in] halConfig if not null, use this to configure the HAL
1324 * @param[in] flags the flags to be used to open the output
Eric Laurentb4f42a92022-01-17 17:37:31 +01001325 * @return an output descriptor for the newly opened stream or null in case of error.
1326 */
1327 sp<SwAudioOutputDescriptor> openOutputWithProfileAndDevice(
1328 const sp<IOProfile>& profile, const DeviceVector& devices,
jiabina84c3d32022-12-02 18:59:55 +00001329 const audio_config_base_t *mixerConfig = nullptr,
1330 const audio_config_t *halConfig = nullptr,
1331 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE);
jiabinbce0c1d2020-10-05 11:20:18 -07001332
jiabin2b9d5a12021-12-10 01:06:29 +00001333 bool isOffloadPossible(const audio_offload_info_t& offloadInfo,
1334 bool durationIgnored = false);
1335
Dorin Drimus94d94412022-02-02 09:05:02 +01001336 // adds the profiles from the outputProfile to the passed audioProfilesVector
1337 // without duplicating them if already present
1338 void addPortProfilesToVector(sp<IOProfile> outputProfile,
1339 AudioProfileVector& audioProfilesVector);
Dorin Drimusecc9f422022-03-09 17:57:40 +01001340
1341 // Searches for a compatible profile with the sample rate, audio format and channel mask
1342 // in the list of passed HwModule(s).
1343 // returns a compatible profile if found, nullptr otherwise
1344 sp<IOProfile> searchCompatibleProfileHwModules (
1345 const HwModuleCollection& hwModules,
1346 const DeviceVector& devices,
1347 uint32_t samplingRate,
1348 audio_format_t format,
1349 audio_channel_mask_t channelMask,
1350 audio_output_flags_t flags,
1351 bool directOnly);
1352
1353 // Filters only the relevant flags for getProfileForOutput
1354 audio_output_flags_t getRelevantFlags (audio_output_flags_t flags, bool directOnly);
jiabinf1c73972022-04-14 16:28:52 -07001355
1356 status_t getDevicesForAttributes(const audio_attributes_t &attr,
1357 DeviceVector &devices,
1358 bool forVolume);
1359
1360 status_t getProfilesForDevices(const DeviceVector& devices,
1361 AudioProfileVector& audioProfiles,
1362 uint32_t flags,
1363 bool isInput);
jiabina84c3d32022-12-02 18:59:55 +00001364
jiabind9a58d32023-06-01 17:57:30 +00001365 /**
1366 * Returns the preferred mixer attributes info for the given device port id and strategy.
1367 * Bit-perfect mixer attributes will be returned if it is active and
1368 * `activeBitPerfectPreferred` is true.
1369 */
jiabina84c3d32022-12-02 18:59:55 +00001370 sp<PreferredMixerAttributesInfo> getPreferredMixerAttributesInfo(
jiabind9a58d32023-06-01 17:57:30 +00001371 audio_port_handle_t devicePortId,
1372 product_strategy_t strategy,
1373 bool activeBitPerfectPreferred = false);
jiabinc44b3462022-12-08 12:52:31 -08001374
jiabin3ff8d7d2022-12-13 06:27:44 +00001375 sp<SwAudioOutputDescriptor> reopenOutput(
1376 sp<SwAudioOutputDescriptor> outputDesc,
1377 const audio_config_t *config,
1378 audio_output_flags_t flags,
1379 const char* caller);
1380
1381 void reopenOutputsWithDevices(
1382 const std::map<audio_io_handle_t, DeviceVector>& outputsToReopen);
jiabinc44b3462022-12-08 12:52:31 -08001383
1384 PortHandleVector getClientsForStream(audio_stream_type_t streamType) const;
1385 void invalidateStreams(StreamTypeVector streams) const;
Shunkai Yao4c3af932024-04-26 04:12:21 +00001386
1387 bool checkHapticCompatibilityOnSpatializerOutput(const audio_config_t* config,
1388 audio_session_t sessionId) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001389};
1390
1391};