blob: 885f7c64fde458d32bcb7810478821382ce83dbf [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>
jiabina84c3d32022-12-02 18:59:55 +000050#include <PreferredMixerAttributesInfo.h>
François Gaffiedf372692015-03-19 10:43:27 +010051#include <SoundTriggerSession.h>
Mikhail Naganov47835552019-05-14 10:32:51 -070052#include "EngineLibrary.h"
Eric Laurentf5aa58d2019-02-22 18:20:11 -080053#include "TypeConverter.h"
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080054
55namespace android {
56
Svet Ganov3e5f14f2021-05-13 22:51:08 +000057using content::AttributionSourceState;
58
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080059// ----------------------------------------------------------------------------
60
61// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB
Eric Laurentffbc80f2015-03-18 18:30:19 -070062#define SONIFICATION_HEADSET_VOLUME_FACTOR_DB (-6)
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080063// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB
Eric Laurentffbc80f2015-03-18 18:30:19 -070064#define SONIFICATION_HEADSET_VOLUME_MIN_DB (-36)
Jean-Michel Trivi00a20962016-05-25 19:11:01 -070065// Max volume difference on A2DP between playing media and STRATEGY_SONIFICATION streams: 12dB
66#define SONIFICATION_A2DP_MAX_MEDIA_DIFF_DB (12)
Eric Laurentffbc80f2015-03-18 18:30:19 -070067
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080068// Time in milliseconds during which we consider that music is still active after a music
69// track was stopped - see computeVolume()
70#define SONIFICATION_HEADSET_MUSIC_DELAY 5000
François Gaffie2110e042015-03-24 08:41:51 +010071
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080072// Time in milliseconds during witch some streams are muted while the audio path
73// is switched
74#define MUTE_TIME_MS 2000
75
Eric Laurentac3a6902018-05-11 16:39:10 -070076// multiplication factor applied to output latency when calculating a safe mute delay when
77// invalidating tracks
78#define LATENCY_MUTE_FACTOR 4
79
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080080#define NUM_TEST_OUTPUTS 5
81
82#define NUM_VOL_CURVE_KNEES 2
83
84// Default minimum length allowed for offloading a compressed track
85// Can be overridden by the audio.offload.min.duration.secs property
86#define OFFLOAD_DEFAULT_MIN_DURATION_SECS 60
87
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080088// ----------------------------------------------------------------------------
89// AudioPolicyManager implements audio policy manager behavior common to all platforms.
90// ----------------------------------------------------------------------------
91
François Gaffie2110e042015-03-24 08:41:51 +010092class AudioPolicyManager : public AudioPolicyInterface, public AudioPolicyManagerObserver
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080093{
94
95public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -070096 explicit AudioPolicyManager(AudioPolicyClientInterface *clientInterface);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -080097 virtual ~AudioPolicyManager();
98
99 // AudioPolicyInterface
Nathalie Le Clair88fa2752021-11-23 13:03:41 +0100100 virtual status_t setDeviceConnectionState(audio_policy_dev_state_t state,
101 const android::media::audio::common::AudioPort& port, audio_format_t encodedFormat);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800102 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
103 const char *device_address);
Pavlin Radoslavovf862bc62016-12-26 18:57:22 -0800104 virtual status_t handleDeviceConfigChange(audio_devices_t device,
105 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -0800106 const char *device_name,
107 audio_format_t encodedFormat);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800108 virtual void setPhoneState(audio_mode_t state);
109 virtual void setForceUse(audio_policy_force_use_t usage,
110 audio_policy_forced_cfg_t config);
111 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
François Gaffie2110e042015-03-24 08:41:51 +0100112
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800113 virtual void setSystemProperty(const char* property, const char* value);
114 virtual status_t initCheck();
Eric Laurentf4e63452017-11-06 19:31:46 +0000115 virtual audio_io_handle_t getOutput(audio_stream_type_t stream);
Kevin Rocard153f92d2018-12-18 18:33:28 -0800116 status_t getOutputForAttr(const audio_attributes_t *attr,
117 audio_io_handle_t *output,
118 audio_session_t session,
119 audio_stream_type_t *stream,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000120 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700121 audio_config_t *config,
Kevin Rocard153f92d2018-12-18 18:33:28 -0800122 audio_output_flags_t *flags,
123 audio_port_handle_t *selectedDeviceId,
124 audio_port_handle_t *portId,
Eric Laurent8a1095a2019-11-08 14:44:16 -0800125 std::vector<audio_io_handle_t> *secondaryOutputs,
Eric Laurentb0a7bc92022-04-05 15:06:08 +0200126 output_type_t *outputType,
jiabinc658e452022-10-21 20:52:21 +0000127 bool *isSpatialized,
128 bool *isBitPerfect) override;
Eric Laurent8fc147b2018-07-22 19:13:55 -0700129 virtual status_t startOutput(audio_port_handle_t portId);
130 virtual status_t stopOutput(audio_port_handle_t portId);
jiabinbce0c1d2020-10-05 11:20:18 -0700131 virtual bool releaseOutput(audio_port_handle_t portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800132 virtual status_t getInputForAttr(const audio_attributes_t *attr,
133 audio_io_handle_t *input,
Mikhail Naganov2996f672019-04-18 12:29:59 -0700134 audio_unique_id_t riid,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800135 audio_session_t session,
Svet Ganov3e5f14f2021-05-13 22:51:08 +0000136 const AttributionSourceState& attributionSource,
jiabinf1c73972022-04-14 16:28:52 -0700137 audio_config_base_t *config,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800138 audio_input_flags_t flags,
Eric Laurent2ac76942017-06-22 17:17:09 -0700139 audio_port_handle_t *selectedDeviceId,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800140 input_type_t *inputType,
141 audio_port_handle_t *portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800142
143 // indicates to the audio policy manager that the input starts being used.
Eric Laurent4eb58f12018-12-07 16:41:02 -0800144 virtual status_t startInput(audio_port_handle_t portId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800145
146 // indicates to the audio policy manager that the input stops being used.
Eric Laurent8fc147b2018-07-22 19:13:55 -0700147 virtual status_t stopInput(audio_port_handle_t portId);
148 virtual void releaseInput(audio_port_handle_t portId);
Eric Laurent0dd51852019-04-19 18:18:58 -0700149 virtual void checkCloseInputs();
François Gaffie251c7f02018-11-07 10:41:08 +0100150 /**
151 * @brief initStreamVolume: even if the engine volume files provides min and max, keep this
152 * api for compatibility reason.
153 * AudioServer will get the min and max and may overwrite them if:
154 * -using property (highest priority)
155 * -not defined (-1 by convention), case when still using apm volume tables XML files
156 * @param stream to be considered
157 * @param indexMin to set
158 * @param indexMax to set
159 */
160 virtual void initStreamVolume(audio_stream_type_t stream, int indexMin, int indexMax);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800161 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
162 int index,
163 audio_devices_t device);
164 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
165 int *index,
166 audio_devices_t device);
167
François Gaffiecfe17322018-11-07 13:41:29 +0100168 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr,
169 int index,
170 audio_devices_t device);
171 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr,
172 int &index,
173 audio_devices_t device);
174 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr, int &index);
175
176 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr, int &index);
177
François Gaffieaaac0fd2018-11-22 17:56:39 +0100178 status_t setVolumeCurveIndex(int index,
François Gaffiecfe17322018-11-07 13:41:29 +0100179 audio_devices_t device,
180 IVolumeCurves &volumeCurves);
181
182 status_t getVolumeIndex(const IVolumeCurves &curves, int &index,
jiabin9a3361e2019-10-01 09:38:30 -0700183 const DeviceTypeSet& deviceTypes) const;
François Gaffiecfe17322018-11-07 13:41:29 +0100184
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800185 // return the strategy corresponding to a given stream type
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800186 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream)
François Gaffiec005e562018-11-06 15:04:49 +0100187 {
188 return streamToStrategy(stream);
189 }
190 product_strategy_t streamToStrategy(audio_stream_type_t stream) const
191 {
192 auto attributes = mEngine->getAttributesForStreamType(stream);
193 return mEngine->getProductStrategyForAttributes(attributes);
194 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800195
Andy Hung6d23c0f2022-02-16 09:37:15 -0800196 /**
197 * Returns a vector of devices associated with attributes.
198 *
199 * An AudioTrack opened with specified attributes should play on the returned devices.
200 * If forVolume is set to true, the caller is AudioService, determining the proper
201 * device volume to adjust.
202 *
203 * Devices are determined in the following precedence:
204 * 1) Devices associated with a dynamic policy matching the attributes. This is often
205 * a remote submix from MIX_ROUTE_FLAG_LOOP_BACK. Secondary mixes from a
206 * dynamic policy are not included.
207 *
208 * If no such dynamic policy then
209 * 2) Devices containing an active client using setPreferredDevice
210 * with same strategy as the attributes.
211 * (from the default Engine::getOutputDevicesForAttributes() implementation).
212 *
213 * If no corresponding active client with setPreferredDevice then
214 * 3) Devices associated with the strategy determined by the attributes
215 * (from the default Engine::getOutputDevicesForAttributes() implementation).
216 *
217 * @param attributes to be considered
218 * @param devices an AudioDeviceTypeAddrVector container passed in that
219 * will be filled on success.
220 * @param forVolume true if the devices are to be associated with current device volume.
221 * @return NO_ERROR on success.
222 */
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800223 virtual status_t getDevicesForAttributes(
224 const audio_attributes_t &attributes,
Andy Hung6d23c0f2022-02-16 09:37:15 -0800225 AudioDeviceTypeAddrVector *devices,
226 bool forVolume);
Jean-Michel Trivif41599b2020-01-07 14:22:08 -0800227
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800228 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc = NULL);
229 virtual status_t registerEffect(const effect_descriptor_t *desc,
230 audio_io_handle_t io,
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800231 product_strategy_t strategy,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800232 int session,
233 int id);
Eric Laurentc241b0d2018-11-28 09:08:49 -0800234 virtual status_t unregisterEffect(int id);
235 virtual status_t setEffectEnabled(int id, bool enabled);
Eric Laurent6c796322019-04-09 14:13:17 -0700236 status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) override;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800237
Eric Laurentc75307b2015-03-17 15:29:32 -0700238 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800239 // return whether a stream is playing remotely, override to change the definition of
240 // local/remote playback, used for instance by notification manager to not make
241 // media players lose audio focus when not playing locally
242 // For the base implementation, "remotely" means playing during screen mirroring which
243 // uses an output for playback with a non-empty, non "0" address.
Eric Laurentc75307b2015-03-17 15:29:32 -0700244 virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
245 uint32_t inPastMs = 0) const;
246
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800247 virtual bool isSourceActive(audio_source_t source) const;
248
Mikhail Naganov100f0122018-11-29 11:22:16 -0800249 // helpers for dump(int fd)
250 void dumpManualSurroundFormats(String8 *dst) const;
251 void dump(String8 *dst) const;
Andy Hungc29d82b2018-10-05 12:23:17 -0700252
253 status_t dump(int fd) override;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800254
Kevin Rocardb99cc752019-03-21 20:52:24 -0700255 status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t capturePolicy) override;
Eric Laurent90fe31c2020-11-26 20:06:35 +0100256 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800257
Michael Chana94fbb22018-04-24 14:31:19 +1000258 virtual bool isDirectOutputSupported(const audio_config_base_t& config,
259 const audio_attributes_t& attributes);
260
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800261 virtual status_t listAudioPorts(audio_port_role_t role,
262 audio_port_type_t type,
263 unsigned int *num_ports,
jiabin19cdba52020-11-24 11:28:58 -0800264 struct audio_port_v7 *ports,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800265 unsigned int *generation);
jiabin19cdba52020-11-24 11:28:58 -0800266 virtual status_t getAudioPort(struct audio_port_v7 *port);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800267 virtual status_t createAudioPatch(const struct audio_patch *patch,
268 audio_patch_handle_t *handle,
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200269 uid_t uid);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800270 virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
271 uid_t uid);
272 virtual status_t listAudioPatches(unsigned int *num_patches,
273 struct audio_patch *patches,
274 unsigned int *generation);
275 virtual status_t setAudioPortConfig(const struct audio_port_config *config);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800276
Eric Laurentd60560a2015-04-10 11:31:20 -0700277 virtual void releaseResourcesForUid(uid_t uid);
278
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800279 virtual status_t acquireSoundTriggerSession(audio_session_t *session,
280 audio_io_handle_t *ioHandle,
281 audio_devices_t *device);
282
François Gaffiedf372692015-03-19 10:43:27 +0100283 virtual status_t releaseSoundTriggerSession(audio_session_t session)
284 {
285 return mSoundTriggerSessions.releaseSession(session);
286 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800287
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700288 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800289 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes);
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800290 virtual status_t setUidDeviceAffinities(uid_t uid,
jiabin6a02d532020-08-07 11:56:38 -0700291 const AudioDeviceTypeAddrVector& devices);
Jean-Michel Trivibda70da2018-12-19 07:30:15 -0800292 virtual status_t removeUidDeviceAffinities(uid_t uid);
Oscar Azucena90e77632019-11-27 17:12:28 -0800293 virtual status_t setUserIdDeviceAffinities(int userId,
jiabin6a02d532020-08-07 11:56:38 -0700294 const AudioDeviceTypeAddrVector& devices);
Oscar Azucena90e77632019-11-27 17:12:28 -0800295 virtual status_t removeUserIdDeviceAffinities(int userId);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800296
jiabin0a488932020-08-07 17:32:40 -0700297 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy,
298 device_role_t role,
299 const AudioDeviceTypeAddrVector &devices);
300
301 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy,
302 device_role_t role);
303
304
305 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy,
306 device_role_t role,
307 AudioDeviceTypeAddrVector &devices);
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700308
Jiabin Huang3b98d322020-09-03 17:54:16 +0000309 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource,
310 device_role_t role,
311 const AudioDeviceTypeAddrVector &devices);
312
313 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource,
314 device_role_t role,
315 const AudioDeviceTypeAddrVector &devices);
316
317 virtual status_t removeDevicesRoleForCapturePreset(
318 audio_source_t audioSource, device_role_t role,
319 const AudioDeviceTypeAddrVector& devices);
320
321 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource,
322 device_role_t role);
323
324 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource,
325 device_role_t role,
326 AudioDeviceTypeAddrVector &devices);
327
Eric Laurent554a2772015-04-10 11:29:24 -0700328 virtual status_t startAudioSource(const struct audio_port_config *source,
329 const audio_attributes_t *attributes,
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700330 audio_port_handle_t *portId,
Eric Laurentd60560a2015-04-10 11:31:20 -0700331 uid_t uid);
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700332 virtual status_t stopAudioSource(audio_port_handle_t portId);
Eric Laurent554a2772015-04-10 11:29:24 -0700333
Andy Hung2ddee192015-12-18 17:34:44 -0800334 virtual status_t setMasterMono(bool mono);
335 virtual status_t getMasterMono(bool *mono);
Eric Laurentac9cef52017-06-09 15:46:26 -0700336 virtual float getStreamVolumeDB(
337 audio_stream_type_t stream, int index, audio_devices_t device);
Andy Hung2ddee192015-12-18 17:34:44 -0800338
jiabin81772902018-04-02 17:52:27 -0700339 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats,
340 audio_format_t *surroundFormats,
Kriti Dang6537def2021-03-02 13:46:59 +0100341 bool *surroundFormatsEnabled);
342 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats,
343 audio_format_t *surroundFormats);
jiabin81772902018-04-02 17:52:27 -0700344 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled);
345
Pattydd807582021-11-04 21:01:03 +0800346 virtual status_t getHwOffloadFormatsSupportedForBluetoothMedia(
347 audio_devices_t device, std::vector<audio_format_t> *formats);
Arun Mirpuri11029ad2018-12-19 20:45:19 -0800348
Eric Laurent5ada82e2019-08-29 17:53:54 -0700349 virtual void setAppState(audio_port_handle_t portId, app_state_t state);
Svet Ganovf4ddfef2018-01-16 07:37:58 -0800350
jiabin6012f912018-11-02 17:06:30 -0700351 virtual bool isHapticPlaybackSupported();
352
Carter Hsu325a8eb2022-01-19 19:56:51 +0800353 virtual bool isUltrasoundSupported();
354
François Gaffied0ba9ed2018-11-05 11:50:42 +0100355 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies)
356 {
357 return mEngine->listAudioProductStrategies(strategies);
358 }
359
Francois Gaffie11b65922020-09-24 16:59:08 +0200360 virtual status_t getProductStrategyFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200361 const audio_attributes_t &aa, product_strategy_t &productStrategy,
Francois Gaffie11b65922020-09-24 16:59:08 +0200362 bool fallbackOnDefault)
François Gaffied0ba9ed2018-11-05 11:50:42 +0100363 {
François Gaffie1e2b56f2022-04-01 14:34:29 +0200364 productStrategy = mEngine->getProductStrategyForAttributes(aa, fallbackOnDefault);
Francois Gaffie11b65922020-09-24 16:59:08 +0200365 return (fallbackOnDefault && productStrategy == PRODUCT_STRATEGY_NONE) ?
366 BAD_VALUE : NO_ERROR;
François Gaffie4b2018b2018-11-07 11:18:59 +0100367 }
368
369 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups)
370 {
371 return mEngine->listAudioVolumeGroups(groups);
372 }
373
Francois Gaffie11b65922020-09-24 16:59:08 +0200374 virtual status_t getVolumeGroupFromAudioAttributes(
François Gaffie1e2b56f2022-04-01 14:34:29 +0200375 const audio_attributes_t &aa, volume_group_t &volumeGroup, bool fallbackOnDefault)
François Gaffie4b2018b2018-11-07 11:18:59 +0100376 {
François Gaffie1e2b56f2022-04-01 14:34:29 +0200377 volumeGroup = mEngine->getVolumeGroupForAttributes(aa, fallbackOnDefault);
Francois Gaffie11b65922020-09-24 16:59:08 +0200378 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
jiabina84c3d32022-12-02 18:59:55 +0000400 status_t getSupportedMixerAttributes(
401 audio_port_handle_t portId,
402 std::vector<audio_mixer_attributes_t>& mixerAttrs) override;
403 status_t setPreferredMixerAttributes(
404 const audio_attributes_t* attr,
405 audio_port_handle_t portId,
406 uid_t uid,
407 const audio_mixer_attributes_t* mixerAttributes) override;
408 status_t getPreferredMixerAttributes(const audio_attributes_t* attr,
409 audio_port_handle_t portId,
410 audio_mixer_attributes_t* mixerAttributes) override;
411 status_t clearPreferredMixerAttributes(const audio_attributes_t* attr,
412 audio_port_handle_t portId,
413 uid_t uid) override;
414
Eric Laurent8340e672019-11-06 11:01:08 -0800415 bool isCallScreenModeSupported() override;
416
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000417 void onNewAudioModulesAvailable() override;
418
Eric Laurentcaafba42019-07-13 10:12:45 -0700419 status_t initialize();
420
Paul McLeanaa981192015-03-21 09:55:15 -0700421protected:
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800422 // A constructor that allows more fine-grained control over initialization process,
423 // used in automatic tests.
424 AudioPolicyManager(AudioPolicyClientInterface *clientInterface, bool forTesting);
425
426 // These methods should be used when finer control over APM initialization
427 // is needed, e.g. in tests. Must be used in conjunction with the constructor
428 // that only performs fields initialization. The public constructor comprises
429 // these steps in the following sequence:
430 // - field initializing constructor;
431 // - loadConfig;
432 // - initialize.
433 AudioPolicyConfig& getConfig() { return mConfig; }
434 void loadConfig();
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800435
François Gaffie2110e042015-03-24 08:41:51 +0100436 // From AudioPolicyManagerObserver
437 virtual const AudioPatchCollection &getAudioPatches() const
438 {
439 return mAudioPatches;
440 }
441 virtual const SoundTriggerSessionCollection &getSoundTriggerSessionCollection() const
442 {
443 return mSoundTriggerSessions;
444 }
445 virtual const AudioPolicyMixCollection &getAudioPolicyMixCollection() const
446 {
447 return mPolicyMixes;
448 }
Eric Laurentc75307b2015-03-17 15:29:32 -0700449 virtual const SwAudioOutputCollection &getOutputs() const
François Gaffie2110e042015-03-24 08:41:51 +0100450 {
451 return mOutputs;
452 }
453 virtual const AudioInputCollection &getInputs() const
454 {
455 return mInputs;
456 }
Eric Laurentaf377772019-03-29 14:50:21 -0700457 virtual const DeviceVector getAvailableOutputDevices() const
François Gaffie2110e042015-03-24 08:41:51 +0100458 {
Kevin Rocarde0d004f2019-10-10 10:06:18 +0000459 return mAvailableOutputDevices.filterForEngine();
François Gaffie2110e042015-03-24 08:41:51 +0100460 }
Eric Laurentaf377772019-03-29 14:50:21 -0700461 virtual const DeviceVector getAvailableInputDevices() const
François Gaffie2110e042015-03-24 08:41:51 +0100462 {
Francois Gaffie698d3532019-04-10 15:20:05 +0200463 // legacy and non-legacy remote-submix are managed by the engine, do not filter
464 return mAvailableInputDevices;
François Gaffie2110e042015-03-24 08:41:51 +0100465 }
François Gaffie2110e042015-03-24 08:41:51 +0100466 virtual const sp<DeviceDescriptor> &getDefaultOutputDevice() const
467 {
468 return mDefaultOutputDevice;
469 }
Mikhail Naganovd4120142017-12-06 15:49:22 -0800470
François Gaffieaaac0fd2018-11-22 17:56:39 +0100471 std::vector<volume_group_t> getVolumeGroups() const
472 {
473 return mEngine->getVolumeGroups();
474 }
475
476 VolumeSource toVolumeSource(volume_group_t volumeGroup) const
477 {
478 return static_cast<VolumeSource>(volumeGroup);
479 }
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100480 /**
481 * @brief toVolumeSource converts an audio attributes into a volume source
482 * (either a legacy stream or a volume group). If fallback on default is allowed, and if
483 * the audio attributes do not follow any specific product strategy's rule, it will be
484 * associated to default volume source, e.g. music. Thus, any of call of volume API
485 * using this translation function may affect the default volume source.
486 * If fallback is not allowed and no matching rule is identified for the given attributes,
487 * the volume source will be undefined, thus, no volume will be altered/modified.
488 * @param attributes to be considered
489 * @param fallbackOnDefault
490 * @return volume source associated with given attributes, otherwise either music if
491 * fallbackOnDefault is set or none.
492 */
493 VolumeSource toVolumeSource(
494 const audio_attributes_t &attributes, bool fallbackOnDefault = true) const
François Gaffieaaac0fd2018-11-22 17:56:39 +0100495 {
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100496 return toVolumeSource(mEngine->getVolumeGroupForAttributes(
497 attributes, fallbackOnDefault));
François Gaffieaaac0fd2018-11-22 17:56:39 +0100498 }
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100499 VolumeSource toVolumeSource(
500 audio_stream_type_t stream, bool fallbackOnDefault = true) const
François Gaffieaaac0fd2018-11-22 17:56:39 +0100501 {
Francois Gaffie4404ddb2021-02-04 17:03:38 +0100502 return toVolumeSource(mEngine->getVolumeGroupForStreamType(
503 stream, fallbackOnDefault));
François Gaffieaaac0fd2018-11-22 17:56:39 +0100504 }
505 IVolumeCurves &getVolumeCurves(VolumeSource volumeSource)
506 {
507 auto *curves = mEngine->getVolumeCurvesForVolumeGroup(
508 static_cast<volume_group_t>(volumeSource));
509 ALOG_ASSERT(curves != nullptr, "No curves for volume source %d", volumeSource);
510 return *curves;
511 }
Eric Laurentf5aa58d2019-02-22 18:20:11 -0800512 IVolumeCurves &getVolumeCurves(const audio_attributes_t &attr)
513 {
514 auto *curves = mEngine->getVolumeCurvesForAttributes(attr);
515 ALOG_ASSERT(curves != nullptr, "No curves for attributes %s", toString(attr).c_str());
516 return *curves;
517 }
518 IVolumeCurves &getVolumeCurves(audio_stream_type_t stream)
519 {
520 auto *curves = mEngine->getVolumeCurvesForStreamType(stream);
521 ALOG_ASSERT(curves != nullptr, "No curves for stream %s", toString(stream).c_str());
522 return *curves;
523 }
524
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700525 void addOutput(audio_io_handle_t output, const sp<SwAudioOutputDescriptor>& outputDesc);
François Gaffie53615e22015-03-19 09:24:12 +0100526 void removeOutput(audio_io_handle_t output);
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700527 void addInput(audio_io_handle_t input, const sp<AudioInputDescriptor>& inputDesc);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800528
Francois Gaffie3523ab32021-06-22 13:24:34 +0200529 /**
530 * @brief setOutputDevices change the route of the specified output.
531 * @param outputDesc to be considered
532 * @param device to be considered to route the output
533 * @param force if true, force the routing even if no change.
534 * @param delayMs if specified, delay to apply for mute/volume op when changing device
535 * @param patchHandle if specified, the patch handle this output is connected through.
536 * @param requiresMuteCheck if specified, for e.g. when another output is on a shared device
537 * and currently active, allow to have proper drain and avoid pops
538 * @param requiresVolumeCheck true if called requires to reapply volume if the routing did
539 * not change (but the output is still routed).
540 * @return the number of ms we have slept to allow new routing to take effect in certain
541 * cases.
542 */
François Gaffie11d30102018-11-02 16:09:09 +0100543 uint32_t setOutputDevices(const sp<SwAudioOutputDescriptor>& outputDesc,
544 const DeviceVector &device,
545 bool force = false,
546 int delayMs = 0,
547 audio_patch_handle_t *patchHandle = NULL,
Francois Gaffie3523ab32021-06-22 13:24:34 +0200548 bool requiresMuteCheck = true,
549 bool requiresVolumeCheck = false);
Eric Laurentc75307b2015-03-17 15:29:32 -0700550 status_t resetOutputDevice(const sp<AudioOutputDescriptor>& outputDesc,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800551 int delayMs = 0,
552 audio_patch_handle_t *patchHandle = NULL);
553 status_t setInputDevice(audio_io_handle_t input,
François Gaffie11d30102018-11-02 16:09:09 +0100554 const sp<DeviceDescriptor> &device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800555 bool force = false,
556 audio_patch_handle_t *patchHandle = NULL);
557 status_t resetInputDevice(audio_io_handle_t input,
558 audio_patch_handle_t *patchHandle = NULL);
559
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800560 // compute the actual volume for a given stream according to the requested index and a particular
561 // device
François Gaffieaaac0fd2018-11-22 17:56:39 +0100562 virtual float computeVolume(IVolumeCurves &curves,
563 VolumeSource volumeSource,
Eric Laurentc75307b2015-03-17 15:29:32 -0700564 int index,
jiabin9a3361e2019-10-01 09:38:30 -0700565 const DeviceTypeSet& deviceTypes);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800566
Eric Laurent3839bc02018-07-10 18:33:34 -0700567 // rescale volume index from srcStream within range of dstStream
568 int rescaleVolumeIndex(int srcIndex,
Francois Gaffie2ffdfce2019-03-12 11:26:42 +0100569 VolumeSource fromVolumeSource,
570 VolumeSource toVolumeSource);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800571 // check that volume change is permitted, compute and send new volume to audio hardware
François Gaffieaaac0fd2018-11-22 17:56:39 +0100572 virtual status_t checkAndSetVolume(IVolumeCurves &curves,
573 VolumeSource volumeSource, int index,
Eric Laurentc75307b2015-03-17 15:29:32 -0700574 const sp<AudioOutputDescriptor>& outputDesc,
jiabin9a3361e2019-10-01 09:38:30 -0700575 DeviceTypeSet deviceTypes,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800576 int delayMs = 0, bool force = false);
577
578 // apply all stream volumes to the specified output and device
Eric Laurentc75307b2015-03-17 15:29:32 -0700579 void applyStreamVolumes(const sp<AudioOutputDescriptor>& outputDesc,
jiabin9a3361e2019-10-01 09:38:30 -0700580 const DeviceTypeSet& deviceTypes,
581 int delayMs = 0, bool force = false);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800582
François Gaffiec005e562018-11-06 15:04:49 +0100583 /**
584 * @brief setStrategyMute Mute or unmute all active clients on the considered output
585 * following the given strategy.
586 * @param strategy to be considered
587 * @param on true for mute, false for unmute
588 * @param outputDesc to be considered
589 * @param delayMs
590 * @param device
591 */
592 void setStrategyMute(product_strategy_t strategy,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800593 bool on,
Eric Laurentc75307b2015-03-17 15:29:32 -0700594 const sp<AudioOutputDescriptor>& outputDesc,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800595 int delayMs = 0,
jiabin9a3361e2019-10-01 09:38:30 -0700596 DeviceTypeSet deviceTypes = DeviceTypeSet());
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800597
François Gaffieaaac0fd2018-11-22 17:56:39 +0100598 /**
599 * @brief setVolumeSourceMute Mute or unmute the volume source on the specified output
600 * @param volumeSource to be muted/unmute (may host legacy streams or by extension set of
601 * audio attributes)
602 * @param on true to mute, false to umute
603 * @param outputDesc on which the client following the volume group shall be muted/umuted
604 * @param delayMs
605 * @param device
François Gaffieaaac0fd2018-11-22 17:56:39 +0100606 */
607 void setVolumeSourceMute(VolumeSource volumeSource,
608 bool on,
609 const sp<AudioOutputDescriptor>& outputDesc,
610 int delayMs = 0,
jiabin9a3361e2019-10-01 09:38:30 -0700611 DeviceTypeSet deviceTypes = DeviceTypeSet());
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800612
Jean-Michel Trivi887a9ed2015-03-31 18:02:24 -0700613 audio_mode_t getPhoneState();
614
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800615 // true if device is in a telephony or VoIP call
Eric Laurent96d1dda2022-03-14 17:14:19 +0100616 virtual bool isInCall() const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800617 // true if given state represents a device in a telephony or VoIP call
Eric Laurent96d1dda2022-03-14 17:14:19 +0100618 virtual bool isStateInCall(int state) const;
Eric Laurent74b71512019-11-06 17:21:57 -0800619 // true if playback to call TX or capture from call RX is possible
Eric Laurentf9cccec2022-11-16 19:12:00 +0100620 bool isCallAudioAccessible() const;
621 // true if device is in a telephony or VoIP call or call screening is active
622 bool isInCallOrScreening() const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800623
624 // when a device is connected, checks if an open output can be routed
625 // to this device. If none is open, tries to open one of the available outputs.
626 // Returns an output suitable to this device or 0.
627 // when a device is disconnected, checks if an output is not used any more and
628 // returns its handle if any.
629 // transfers the audio tracks and effects from one output thread to another accordingly.
François Gaffie11d30102018-11-02 16:09:09 +0100630 status_t checkOutputsForDevice(const sp<DeviceDescriptor>& device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800631 audio_policy_dev_state_t state,
François Gaffie11d30102018-11-02 16:09:09 +0100632 SortedVector<audio_io_handle_t>& outputs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800633
François Gaffie11d30102018-11-02 16:09:09 +0100634 status_t checkInputsForDevice(const sp<DeviceDescriptor>& device,
Eric Laurent0dd51852019-04-19 18:18:58 -0700635 audio_policy_dev_state_t state);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800636
637 // close an output and its companion duplicating output.
638 void closeOutput(audio_io_handle_t output);
639
640 // close an input.
641 void closeInput(audio_io_handle_t input);
642
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700643 // runs all the checks required for accommodating changes in devices and outputs
Mikhail Naganov37977152018-07-11 15:54:44 -0700644 // if 'onOutputsChecked' callback is provided, it is executed after the outputs
645 // check via 'checkOutputForAllStrategies'. If the callback returns 'true',
646 // A2DP suspend status is rechecked.
Mikhail Naganov15be9d22017-11-08 14:18:13 +1100647 void checkForDeviceAndOutputChanges(std::function<bool()> onOutputsChecked = nullptr);
Mikhail Naganov37977152018-07-11 15:54:44 -0700648
François Gaffiec005e562018-11-06 15:04:49 +0100649 /**
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700650 * @brief updates routing for all outputs (including call if call in progress).
651 * @param delayMs delay for unmuting if required
652 */
653 void updateCallAndOutputRouting(bool forceVolumeReeval = true, uint32_t delayMs = 0);
654
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200655 bool isCallRxAudioSource(const sp<SourceClientDescriptor> &source) {
Francois Gaffie601801d2021-06-22 13:27:39 +0200656 return mCallRxSourceClient != nullptr && source == mCallRxSourceClient;
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200657 }
658
Eric Laurent78b07302022-10-07 16:20:34 +0200659 bool isCallTxAudioSource(const sp<SourceClientDescriptor> &source) {
660 return mCallTxSourceClient != nullptr && source == mCallTxSourceClient;
661 }
662
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200663 void connectTelephonyRxAudioSource();
664
Francois Gaffie601801d2021-06-22 13:27:39 +0200665 void disconnectTelephonyAudioSource(sp<SourceClientDescriptor> &clientDesc);
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200666
667 void connectTelephonyTxAudioSource(const sp<DeviceDescriptor> &srcdevice,
668 const sp<DeviceDescriptor> &sinkDevice,
669 uint32_t delayMs);
670
Francois Gaffie601801d2021-06-22 13:27:39 +0200671 bool isTelephonyRxOrTx(const sp<SwAudioOutputDescriptor>& desc) const {
672 return (mCallRxSourceClient != nullptr && mCallRxSourceClient->belongsToOutput(desc))
673 || (mCallTxSourceClient != nullptr
674 && mCallTxSourceClient->belongsToOutput(desc));
675 }
Francois Gaffie51c9ccd2020-10-14 18:02:07 +0200676
Jean-Michel Trivi30857152019-11-01 11:04:15 -0700677 /**
Eric Laurent2517af32020-11-25 15:31:27 +0100678 * @brief updates routing for all inputs.
679 */
680 void updateInputRouting();
681
682 /**
François Gaffiec005e562018-11-06 15:04:49 +0100683 * @brief checkOutputForAttributes checks and if necessary changes outputs used for the
684 * given audio attributes.
685 * must be called every time a condition that affects the output choice for a given
686 * attributes changes: connected device, phone state, force use...
687 * Must be called before updateDevicesAndOutputs()
688 * @param attr to be considered
689 */
690 void checkOutputForAttributes(const audio_attributes_t &attr);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800691
Francois Gaffieff1eb522020-05-06 18:37:04 +0200692 /**
693 * @brief checkAudioSourceForAttributes checks if any AudioSource following the same routing
694 * as the given audio attributes is not routed and try to connect it.
695 * It must be called once checkOutputForAttributes has been called for orphans AudioSource,
696 * aka AudioSource not attached to any Audio Output (e.g. AudioSource connected to direct
697 * Output which has been disconnected (and output closed) due to sink device unavailable).
698 * @param attr to be considered
699 */
700 void checkAudioSourceForAttributes(const audio_attributes_t &attr);
701
François Gaffiec005e562018-11-06 15:04:49 +0100702 bool followsSameRouting(const audio_attributes_t &lAttr,
703 const audio_attributes_t &rAttr) const;
704
705 /**
706 * @brief checkOutputForAllStrategies Same as @see checkOutputForAttributes()
707 * but for a all product strategies in order of priority
708 */
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800709 void checkOutputForAllStrategies();
710
Kevin Rocard153f92d2018-12-18 18:33:28 -0800711 // Same as checkOutputForStrategy but for secondary outputs. Make sure if a secondary
712 // output condition changes, the track is properly rerouted
713 void checkSecondaryOutputs();
714
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800715 // manages A2DP output suspend/restore according to phone state and BT SCO usage
716 void checkA2dpSuspend();
717
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800718 // selects the most appropriate device on output for current state
719 // must be called every time a condition that affects the device choice for a given output is
720 // changed: connected device, phone state, force use, output start, output stop..
721 // see getDeviceForStrategy() for the use of fromCache parameter
François Gaffie11d30102018-11-02 16:09:09 +0100722 DeviceVector getNewOutputDevices(const sp<SwAudioOutputDescriptor>& outputDesc,
723 bool fromCache);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800724
François Gaffiec005e562018-11-06 15:04:49 +0100725 /**
726 * @brief updateDevicesAndOutputs: updates cache of devices of the engine
727 * must be called every time a condition that affects the device choice is changed:
728 * connected device, phone state, force use...
729 * cached values are used by getOutputDevicesForStream()/getDevicesForAttributes if
730 * parameter fromCache is true.
731 * Must be called after checkOutputForAllStrategies()
732 */
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800733 void updateDevicesAndOutputs();
734
735 // selects the most appropriate device on input for current state
François Gaffie11d30102018-11-02 16:09:09 +0100736 sp<DeviceDescriptor> getNewInputDevice(const sp<AudioInputDescriptor>& inputDesc);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800737
François Gaffie45ed3b02015-03-19 10:35:14 +0100738 virtual uint32_t getMaxEffectsCpuLoad()
739 {
740 return mEffects.getMaxEffectsCpuLoad();
741 }
742
743 virtual uint32_t getMaxEffectsMemory()
744 {
745 return mEffects.getMaxEffectsMemory();
746 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800747
François Gaffie11d30102018-11-02 16:09:09 +0100748 SortedVector<audio_io_handle_t> getOutputsForDevices(
749 const DeviceVector &devices, const SwAudioOutputCollection& openOutputs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800750
François Gaffiec005e562018-11-06 15:04:49 +0100751 /**
752 * @brief checkDeviceMuteStrategies mute/unmute strategies
753 * using an incompatible device combination.
754 * if muting, wait for the audio in pcm buffer to be drained before proceeding
755 * if unmuting, unmute only after the specified delay
756 * @param outputDesc
757 * @param prevDevice
758 * @param delayMs
759 * @return the number of ms waited
760 */
761 virtual uint32_t checkDeviceMuteStrategies(const sp<AudioOutputDescriptor>& outputDesc,
762 const DeviceVector &prevDevices,
763 uint32_t delayMs);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800764
765 audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
jiabin40573322018-11-08 12:08:02 -0800766 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
767 audio_format_t format = AUDIO_FORMAT_INVALID,
768 audio_channel_mask_t channelMask = AUDIO_CHANNEL_NONE,
jiabinebb6af42020-06-09 17:31:17 -0700769 uint32_t samplingRate = 0,
770 audio_session_t sessionId = AUDIO_SESSION_NONE);
Andy Hungf129b032015-04-07 13:45:50 -0700771 // samplingRate, format, channelMask are in/out and so may be modified
François Gaffie11d30102018-11-02 16:09:09 +0100772 sp<IOProfile> getInputProfile(const sp<DeviceDescriptor> & device,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800773 uint32_t& samplingRate,
Andy Hungf129b032015-04-07 13:45:50 -0700774 audio_format_t& format,
775 audio_channel_mask_t& channelMask,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800776 audio_input_flags_t flags);
François Gaffie11d30102018-11-02 16:09:09 +0100777 /**
778 * @brief getProfileForOutput
779 * @param devices vector of descriptors, may be empty if ignoring the device is required
780 * @param samplingRate
781 * @param format
782 * @param channelMask
783 * @param flags
784 * @param directOnly
785 * @return IOProfile to be used if found, nullptr otherwise
786 */
787 sp<IOProfile> getProfileForOutput(const DeviceVector &devices,
Michael Chana94fbb22018-04-24 14:31:19 +1000788 uint32_t samplingRate,
789 audio_format_t format,
790 audio_channel_mask_t channelMask,
791 audio_output_flags_t flags,
792 bool directOnly);
Dorin Drimusecc9f422022-03-09 17:57:40 +0100793 /**
794 * Same as getProfileForOutput, but it looks for an MSD profile
795 */
796 sp<IOProfile> getMsdProfileForOutput(const DeviceVector &devices,
797 uint32_t samplingRate,
798 audio_format_t format,
799 audio_channel_mask_t channelMask,
800 audio_output_flags_t flags,
801 bool directOnly);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800802
Eric Laurent36829f92017-04-07 19:04:42 -0700803 audio_io_handle_t selectOutputForMusicEffects();
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800804
François Gaffie53615e22015-03-19 09:24:12 +0100805 virtual status_t addAudioPatch(audio_patch_handle_t handle, const sp<AudioPatch>& patch)
806 {
807 return mAudioPatches.addAudioPatch(handle, patch);
808 }
809 virtual status_t removeAudioPatch(audio_patch_handle_t handle)
810 {
811 return mAudioPatches.removeAudioPatch(handle);
812 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800813
François Gaffie9eb18552018-11-05 10:33:26 +0100814 bool isPrimaryModule(const sp<HwModule> &module) const
815 {
816 if (module == 0 || !hasPrimaryOutput()) {
817 return false;
818 }
819 return module->getHandle() == mPrimaryOutput->getModuleHandle();
820 }
François Gaffie11d30102018-11-02 16:09:09 +0100821 DeviceVector availablePrimaryOutputDevices() const
François Gaffie53615e22015-03-19 09:24:12 +0100822 {
Eric Laurent87ffa392015-05-22 10:32:38 -0700823 if (!hasPrimaryOutput()) {
François Gaffie11d30102018-11-02 16:09:09 +0100824 return DeviceVector();
Eric Laurent87ffa392015-05-22 10:32:38 -0700825 }
Francois Gaffie716e1432019-01-14 16:58:59 +0100826 return mAvailableOutputDevices.filter(mPrimaryOutput->supportedDevices());
François Gaffie53615e22015-03-19 09:24:12 +0100827 }
François Gaffie11d30102018-11-02 16:09:09 +0100828 DeviceVector availablePrimaryModuleInputDevices() const
François Gaffie53615e22015-03-19 09:24:12 +0100829 {
Eric Laurent87ffa392015-05-22 10:32:38 -0700830 if (!hasPrimaryOutput()) {
François Gaffie11d30102018-11-02 16:09:09 +0100831 return DeviceVector();
Eric Laurent87ffa392015-05-22 10:32:38 -0700832 }
François Gaffie11d30102018-11-02 16:09:09 +0100833 return mAvailableInputDevices.getDevicesFromHwModule(
Mikhail Naganov93661932018-07-26 14:37:41 -0700834 mPrimaryOutput->getModuleHandle());
François Gaffie53615e22015-03-19 09:24:12 +0100835 }
François Gaffieaca677c2018-05-03 10:47:50 +0200836 /**
837 * @brief getFirstDeviceId of the Device Vector
838 * @return if the collection is not empty, it returns the first device Id,
839 * otherwise AUDIO_PORT_HANDLE_NONE
840 */
841 audio_port_handle_t getFirstDeviceId(const DeviceVector &devices) const
842 {
843 return (devices.size() > 0) ? devices.itemAt(0)->getId() : AUDIO_PORT_HANDLE_NONE;
844 }
845 String8 getFirstDeviceAddress(const DeviceVector &devices) const
846 {
jiabince9f20e2019-09-12 16:29:15 -0700847 return (devices.size() > 0) ?
848 String8(devices.itemAt(0)->address().c_str()) : String8("");
François Gaffieaca677c2018-05-03 10:47:50 +0200849 }
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800850
Francois Gaffie19fd6c52021-02-04 17:02:59 +0100851 status_t updateCallRouting(
852 bool fromCache, uint32_t delayMs = 0, uint32_t *waitMs = nullptr);
853 status_t updateCallRoutingInternal(
854 const DeviceVector &rxDevices, uint32_t delayMs, uint32_t *waitMs);
François Gaffie11d30102018-11-02 16:09:09 +0100855 sp<AudioPatch> createTelephonyPatch(bool isRx, const sp<DeviceDescriptor> &device,
856 uint32_t delayMs);
Francois Gaffie19fd6c52021-02-04 17:02:59 +0100857 /**
858 * @brief selectBestRxSinkDevicesForCall: if the primary module host both Telephony Rx/Tx
859 * devices, and it declares also supporting a HW bridge between the Telephony Rx and the
860 * given sink device for Voice Call audio attributes, select this device in prio.
861 * Otherwise, getNewOutputDevices() is called on the primary output to select sink device.
862 * @param fromCache true to prevent engine reconsidering all product strategies and retrieve
863 * from engine cache.
864 * @return vector of devices, empty if none is found.
865 */
866 DeviceVector selectBestRxSinkDevicesForCall(bool fromCache);
Mikhail Naganov100f0122018-11-29 11:22:16 -0800867 bool isDeviceOfModule(const sp<DeviceDescriptor>& devDesc, const char *moduleId) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800868
Eric Laurent97ac8712018-07-27 18:59:02 -0700869 status_t startSource(const sp<SwAudioOutputDescriptor>& outputDesc,
870 const sp<TrackClientDescriptor>& client,
Eric Laurentc75307b2015-03-17 15:29:32 -0700871 uint32_t *delayMs);
Eric Laurent97ac8712018-07-27 18:59:02 -0700872 status_t stopSource(const sp<SwAudioOutputDescriptor>& outputDesc,
873 const sp<TrackClientDescriptor>& client);
Eric Laurent8c7e6da2015-04-21 17:37:00 -0700874
875 void clearAudioPatches(uid_t uid);
876 void clearSessionRoutes(uid_t uid);
François Gaffiec005e562018-11-06 15:04:49 +0100877
878 /**
879 * @brief checkStrategyRoute: when an output is beeing rerouted, reconsider each output
880 * that may host a strategy playing on the considered output.
881 * @param ps product strategy that initiated the rerouting
882 * @param ouptutToSkip output that initiated the rerouting
883 */
884 void checkStrategyRoute(product_strategy_t ps, audio_io_handle_t ouptutToSkip);
Eric Laurentc75307b2015-03-17 15:29:32 -0700885
Eric Laurent87ffa392015-05-22 10:32:38 -0700886 status_t hasPrimaryOutput() const { return mPrimaryOutput != 0; }
887
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700888 status_t connectAudioSource(const sp<SourceClientDescriptor>& sourceDesc);
889 status_t disconnectAudioSource(const sp<SourceClientDescriptor>& sourceDesc);
Eric Laurentd60560a2015-04-10 11:31:20 -0700890
Francois Gaffieb2e5cb52021-06-22 13:16:09 +0200891 status_t connectAudioSourceToSink(const sp<SourceClientDescriptor>& sourceDesc,
892 const sp<DeviceDescriptor> &sinkDevice,
893 const struct audio_patch *patch,
894 audio_patch_handle_t &handle,
895 uid_t uid, uint32_t delayMs);
896
François Gaffiec005e562018-11-06 15:04:49 +0100897 sp<SourceClientDescriptor> getSourceForAttributesOnOutput(audio_io_handle_t output,
898 const audio_attributes_t &attr);
Francois Gaffieff1eb522020-05-06 18:37:04 +0200899 void clearAudioSourcesForOutput(audio_io_handle_t output);
Eric Laurentd60560a2015-04-10 11:31:20 -0700900
901 void cleanUpForDevice(const sp<DeviceDescriptor>& deviceDesc);
902
903 void clearAudioSources(uid_t uid);
904
Eric Laurent794fde22016-03-11 09:50:45 -0800905 static bool streamsMatchForvolume(audio_stream_type_t stream1,
906 audio_stream_type_t stream2);
Eric Laurent28d09f02016-03-08 10:43:05 -0800907
Eric Laurent8f42ea12018-08-08 09:08:25 -0700908 void closeActiveClients(const sp<AudioInputDescriptor>& input);
909 void closeClient(audio_port_handle_t portId);
Eric Laurent8fc147b2018-07-22 19:13:55 -0700910
Eric Laurent96d1dda2022-03-14 17:14:19 +0100911 /**
912 * @brief isAnyDeviceTypeActive: returns true if at least one active client is routed to
913 * one of the specified devices
914 * @param deviceTypes list of devices to consider
915 */
916 bool isAnyDeviceTypeActive(const DeviceTypeSet& deviceTypes) const;
917 /**
918 * @brief isLeUnicastActive: returns true if a call is active or at least one active client
919 * is routed to a LE unicast device
920 */
921 bool isLeUnicastActive() const;
922
923 void checkLeBroadcastRoutes(bool wasUnicastActive,
924 sp<SwAudioOutputDescriptor> ignoredOutput, uint32_t delayMs);
925
Andy Hung4ef19fa2018-05-15 19:35:29 -0700926 const uid_t mUidCached; // AID_AUDIOSERVER
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800927 AudioPolicyClientInterface *mpClientInterface; // audio policy client interface
Eric Laurentc75307b2015-03-17 15:29:32 -0700928 sp<SwAudioOutputDescriptor> mPrimaryOutput; // primary output descriptor
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800929 // list of descriptors for outputs currently opened
Eric Laurentc75307b2015-03-17 15:29:32 -0700930
Eric Laurentfa0f6742021-08-17 18:39:44 +0200931 sp<SwAudioOutputDescriptor> mSpatializerOutput;
Eric Laurentcad6c0d2021-07-13 15:12:39 +0200932
Eric Laurentc75307b2015-03-17 15:29:32 -0700933 SwAudioOutputCollection mOutputs;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800934 // copy of mOutputs before setDeviceConnectionState() opens new outputs
935 // reset to mOutputs when updateDevicesAndOutputs() is called.
Eric Laurentc75307b2015-03-17 15:29:32 -0700936 SwAudioOutputCollection mPreviousOutputs;
François Gaffie53615e22015-03-19 09:24:12 +0100937 AudioInputCollection mInputs; // list of input descriptors
Eric Laurentc75307b2015-03-17 15:29:32 -0700938
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000939 DeviceVector mOutputDevicesAll; // all output devices from the config
940 DeviceVector mInputDevicesAll; // all input devices from the config
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800941 DeviceVector mAvailableOutputDevices; // all available output devices
942 DeviceVector mAvailableInputDevices; // all available input devices
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800943
François Gaffiedfd74092015-03-19 12:10:59 +0100944 bool mLimitRingtoneVolume; // limit ringtone volume to music volume if headset connected
François Gaffie11d30102018-11-02 16:09:09 +0100945
François Gaffiedfd74092015-03-19 12:10:59 +0100946 float mLastVoiceVolume; // last voice volume value sent to audio HAL
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800947 bool mA2dpSuspended; // true if A2DP output is suspended
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800948
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800949 EffectDescriptorCollection mEffects; // list of registered audio effects
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800950 sp<DeviceDescriptor> mDefaultOutputDevice; // output device selected by default at boot time
Mikhail Naganovc0d04982020-03-02 21:02:28 +0000951 HwModuleCollection mHwModules; // contains modules that have been loaded successfully
952 HwModuleCollection mHwModulesAll; // contains all modules declared in the config
Eric Laurentf5aa58d2019-02-22 18:20:11 -0800953
Mikhail Naganovad3f8a12017-12-12 13:24:23 -0800954 AudioPolicyConfig mConfig;
François Gaffie53615e22015-03-19 09:24:12 +0100955
Mikhail Naganov2773dd72017-12-08 10:12:11 -0800956 std::atomic<uint32_t> mAudioPortGeneration;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800957
François Gaffie53615e22015-03-19 09:24:12 +0100958 AudioPatchCollection mAudioPatches;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800959
François Gaffiedf372692015-03-19 10:43:27 +0100960 SoundTriggerSessionCollection mSoundTriggerSessions;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800961
Eric Laurentd60560a2015-04-10 11:31:20 -0700962 HwAudioOutputCollection mHwOutputs;
Eric Laurent3e6c7e12018-07-27 17:09:23 -0700963 SourceClientCollection mAudioSources;
Eric Laurentd60560a2015-04-10 11:31:20 -0700964
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800965 // for supporting "beacon" streams, i.e. streams that only play on speaker, and never
966 // when something other than STREAM_TTS (a.k.a. "Transmitted Through Speaker") is playing
967 enum {
968 STARTING_OUTPUT,
969 STARTING_BEACON,
970 STOPPING_OUTPUT,
971 STOPPING_BEACON
972 };
973 uint32_t mBeaconMuteRefCount; // ref count for stream that would mute beacon
974 uint32_t mBeaconPlayingRefCount;// ref count for the playing beacon streams
975 bool mBeaconMuted; // has STREAM_TTS been muted
Carter Hsu1a3364a2022-01-21 15:32:56 +0800976 // true if a dedicated output for TTS stream or Ultrasound is available
977 bool mTtsOutputAvailable;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800978
Andy Hung2ddee192015-12-18 17:34:44 -0800979 bool mMasterMono; // true if we wish to force all outputs to mono
François Gaffie036e1e92015-03-19 10:16:24 +0100980 AudioPolicyMixCollection mPolicyMixes; // list of registered mixes
Eric Laurent36829f92017-04-07 19:04:42 -0700981 audio_io_handle_t mMusicEffectOutput; // output selected for music effects
982
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -0800983 uint32_t nextAudioPortGeneration();
Jean-Michel Trivi887a9ed2015-03-31 18:02:24 -0700984
985 // Audio Policy Engine Interface.
Mikhail Naganov47835552019-05-14 10:32:51 -0700986 EngineInstance mEngine;
jiabin81772902018-04-02 17:52:27 -0700987
Mikhail Naganov100f0122018-11-29 11:22:16 -0800988 // Surround formats that are enabled manually. Taken into account when
989 // "encoded surround" is forced into "manual" mode.
990 std::unordered_set<audio_format_t> mManualSurroundFormats;
Kevin Rocardb99cc752019-03-21 20:52:24 -0700991
992 std::unordered_map<uid_t, audio_flags_mask_t> mAllowedCapturePolicies;
Kriti Dangef6be8f2020-11-05 11:58:19 +0100993
994 // The map of device descriptor and formats reported by the device.
995 std::map<wp<DeviceDescriptor>, FormatVector> mReportedFormatsMap;
Eric Laurent2517af32020-11-25 15:31:27 +0100996
997 // Cached product strategy ID corresponding to legacy strategy STRATEGY_PHONE
998 product_strategy_t mCommunnicationStrategy;
999
Francois Gaffie51c9ccd2020-10-14 18:02:07 +02001000 // The port handle of the hardware audio source created internally for the Call RX audio
1001 // end point.
Francois Gaffie601801d2021-06-22 13:27:39 +02001002 sp<SourceClientDescriptor> mCallRxSourceClient;
1003 sp<SourceClientDescriptor> mCallTxSourceClient;
Francois Gaffie51c9ccd2020-10-14 18:02:07 +02001004
jiabina84c3d32022-12-02 18:59:55 +00001005 std::map<audio_port_handle_t,
1006 std::map<product_strategy_t,
1007 sp<PreferredMixerAttributesInfo>>> mPreferredMixerAttrInfos;
1008
Mikhail Naganov15be9d22017-11-08 14:18:13 +11001009 // Support for Multi-Stream Decoder (MSD) module
1010 sp<DeviceDescriptor> getMsdAudioInDevice() const;
François Gaffie11d30102018-11-02 16:09:09 +01001011 DeviceVector getMsdAudioOutDevices() const;
Dean Wheatley8bee85a2021-02-10 16:02:23 +11001012 const AudioPatchCollection getMsdOutputPatches() const;
1013 status_t getMsdProfiles(bool hwAvSync,
1014 const InputProfileCollection &inputProfiles,
1015 const OutputProfileCollection &outputProfiles,
1016 const sp<DeviceDescriptor> &sourceDevice,
1017 const sp<DeviceDescriptor> &sinkDevice,
1018 AudioProfileVector &sourceProfiles,
1019 AudioProfileVector &sinkProfiles) const;
1020 status_t getBestMsdConfig(bool hwAvSync,
1021 const AudioProfileVector &sourceProfiles,
1022 const AudioProfileVector &sinkProfiles,
1023 audio_port_config *sourceConfig,
1024 audio_port_config *sinkConfig) const;
1025 PatchBuilder buildMsdPatch(bool msdIsSource, const sp<DeviceDescriptor> &device) const;
1026 status_t setMsdOutputPatches(const DeviceVector *outputDevices = nullptr);
1027 void releaseMsdOutputPatches(const DeviceVector& devices);
Dorin Drimus94d94412022-02-02 09:05:02 +01001028 bool msdHasPatchesToAllDevices(const AudioDeviceTypeAddrVector& devices);
Nathalie Le Clair88fa2752021-11-23 13:03:41 +01001029
1030 // Overload of setDeviceConnectionState()
1031 status_t setDeviceConnectionState(audio_devices_t deviceType,
1032 audio_policy_dev_state_t state,
1033 const char* device_address, const char* device_name,
1034 audio_format_t encodedFormat);
1035
1036 // Called by setDeviceConnectionState()
1037 status_t deviceToAudioPort(audio_devices_t deviceType, const char* device_address,
Atneya Nair638a6e42022-12-18 16:45:15 -08001038 const char* device_name, media::AudioPortFw* aidPort);
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001039 bool isMsdPatch(const audio_patch_handle_t &handle) const;
1040
Michael Chan6fb34492020-12-08 15:44:49 +11001041private:
Francois Gaffie601801d2021-06-22 13:27:39 +02001042 sp<SourceClientDescriptor> startAudioSourceInternal(
1043 const struct audio_port_config *source, const audio_attributes_t *attributes,
1044 uid_t uid);
1045
Michael Chan6fb34492020-12-08 15:44:49 +11001046 void onNewAudioModulesAvailableInt(DeviceVector *newDevices);
1047
1048 // Add or remove AC3 DTS encodings based on user preferences.
1049 void modifySurroundFormats(const sp<DeviceDescriptor>& devDesc, FormatVector *formatsPtr);
1050 void modifySurroundChannelMasks(ChannelMaskSet *channelMasksPtr);
Mikhail Naganov15be9d22017-11-08 14:18:13 +11001051
François Gaffie112b0af2015-11-19 16:13:25 +01001052 // If any, resolve any "dynamic" fields of an Audio Profiles collection
Mikhail Naganovd5e18052018-11-30 14:55:45 -08001053 void updateAudioProfiles(const sp<DeviceDescriptor>& devDesc, audio_io_handle_t ioHandle,
Phil Burk00eeb322016-03-31 12:41:00 -07001054 AudioProfileVector &profiles);
François Gaffie112b0af2015-11-19 16:13:25 +01001055
François Gaffie44481e72016-04-20 07:49:57 +02001056 // Notify the policy client of any change of device state with AUDIO_IO_HANDLE_NONE,
1057 // so that the client interprets it as global to audio hardware interfaces.
1058 // It can give a chance to HAL implementer to retrieve dynamic capabilities associated
1059 // to this device for example.
1060 // TODO avoid opening stream to retrieve capabilities of a profile.
François Gaffie11d30102018-11-02 16:09:09 +01001061 void broadcastDeviceConnectionState(const sp<DeviceDescriptor> &device,
1062 audio_policy_dev_state_t state);
François Gaffie44481e72016-04-20 07:49:57 +02001063
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001064 // updates device caching and output for streams that can influence the
1065 // routing of notifications
1066 void handleNotificationRoutingForStream(audio_stream_type_t stream);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001067 uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
Hongwei Wangbb93dfb2018-10-23 13:54:22 -07001068 // internal method, get audio_attributes_t from either a source audio_attributes_t
1069 // or audio_stream_type_t, respectively.
1070 status_t getAudioAttributes(audio_attributes_t *dstAttr,
1071 const audio_attributes_t *srcAttr,
1072 audio_stream_type_t srcStream);
1073 // internal method, called by getOutputForAttr() and connectAudioSource.
1074 status_t getOutputForAttrInt(audio_attributes_t *resultAttr,
1075 audio_io_handle_t *output,
1076 audio_session_t session,
1077 const audio_attributes_t *attr,
1078 audio_stream_type_t *stream,
1079 uid_t uid,
jiabinf1c73972022-04-14 16:28:52 -07001080 audio_config_t *config,
Hongwei Wangbb93dfb2018-10-23 13:54:22 -07001081 audio_output_flags_t *flags,
François Gaffief579db52018-11-13 11:25:16 +01001082 audio_port_handle_t *selectedDeviceId,
Kevin Rocard153f92d2018-12-18 18:33:28 -08001083 bool *isRequestedDeviceForExclusiveUse,
Eric Laurentc529cf62020-04-17 18:19:10 -07001084 std::vector<sp<AudioPolicyMix>> *secondaryMixes,
Eric Laurentb0a7bc92022-04-05 15:06:08 +02001085 output_type_t *outputType,
jiabinc658e452022-10-21 20:52:21 +00001086 bool *isSpatialized,
1087 bool *isBitPerfect);
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001088 // internal method to return the output handle for the given device and format
François Gaffie11d30102018-11-02 16:09:09 +01001089 audio_io_handle_t getOutputForDevices(
1090 const DeviceVector &devices,
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001091 audio_session_t session,
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001092 const audio_attributes_t *attr,
Eric Laurentfe231122017-11-17 17:48:06 -08001093 const audio_config_t *config,
jiabine375d412019-02-26 12:54:53 -08001094 audio_output_flags_t *flags,
Eric Laurentb0a7bc92022-04-05 15:06:08 +02001095 bool *isSpatialized,
jiabina84c3d32022-12-02 18:59:55 +00001096 sp<PreferredMixerAttributesInfo> prefMixerAttrInfo = nullptr,
jiabine375d412019-02-26 12:54:53 -08001097 bool forceMutingHaptic = false);
François Gaffiec005e562018-11-06 15:04:49 +01001098
Eric Laurentc529cf62020-04-17 18:19:10 -07001099 // Internal method checking if a direct output can be opened matching the requested
1100 // attributes, flags, config and devices.
1101 // If NAME_NOT_FOUND is returned, an attempt can be made to open a mixed output.
1102 status_t openDirectOutput(
1103 audio_stream_type_t stream,
1104 audio_session_t session,
1105 const audio_config_t *config,
1106 audio_output_flags_t flags,
1107 const DeviceVector &devices,
1108 audio_io_handle_t *output);
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001109
Eric Laurentb4f42a92022-01-17 17:37:31 +01001110 /**
1111 * @brief Queries if some kind of spatialization will be performed if the audio playback
1112 * context described by the provided arguments is present.
1113 * The context is made of:
1114 * - The audio attributes describing the playback use case.
1115 * - The audio configuration describing the audio format, channels, sampling rate ...
1116 * - The devices describing the sink audio device selected for playback.
1117 * All arguments are optional and only the specified arguments are used to match against
1118 * supported criteria. For instance, supplying no argument will tell if spatialization is
1119 * supported or not in general.
1120 * @param attr audio attributes describing the playback use case
1121 * @param config audio configuration describing the audio format, channels, sample rate...
1122 * @param devices the sink audio device selected for playback
Eric Laurentb4f42a92022-01-17 17:37:31 +01001123 * @return true if spatialization is possible for this context, false otherwise.
1124 */
1125 virtual bool canBeSpatializedInt(const audio_attributes_t *attr,
1126 const audio_config_t *config,
Andy Hung9dd1a5b2022-05-10 15:39:39 -07001127 const AudioDeviceTypeAddrVector &devices) const;
Eric Laurentb4f42a92022-01-17 17:37:31 +01001128
Eric Laurent0c8f7cc2022-06-24 14:32:36 +02001129
1130 /**
1131 * @brief Gets an IOProfile for a spatializer output with the best match with
1132 * provided arguments.
1133 * The caller can have the devices criteria ignored by passing and empty vector, and
1134 * getSpatializerOutputProfile() will ignore the devices when looking for a match.
1135 * Otherwise an output profile supporting a spatializer effect that can be routed
1136 * to the specified devices must exist.
1137 * @param config audio configuration describing the audio format, channels, sample rate...
1138 * @param devices the sink audio device selected for playback
1139 * @return an IOProfile that canbe used to open a spatializer output.
1140 */
Eric Laurentfa0f6742021-08-17 18:39:44 +02001141 sp<IOProfile> getSpatializerOutputProfile(const audio_config_t *config,
Eric Laurent39095982021-08-24 18:29:27 +02001142 const AudioDeviceTypeAddrVector &devices) const;
1143
Eric Laurentcad6c0d2021-07-13 15:12:39 +02001144 void checkVirtualizerClientRoutes();
1145
François Gaffiec005e562018-11-06 15:04:49 +01001146 /**
Eric Laurente191d1b2022-04-15 11:59:25 +02001147 * @brief Returns true if at least one device can only be reached via the output passed
1148 * as argument. Always returns false for duplicated outputs.
1149 * This can be used to decide if an output can be closed without forbidding
1150 * playback to any given device.
1151 * @param outputDesc the output to consider
1152 * @return true if at least one device can only be reached via the output.
1153 */
1154 bool isOutputOnlyAvailableRouteToSomeDevice(const sp<SwAudioOutputDescriptor>& outputDesc);
1155
1156 /**
François Gaffiec005e562018-11-06 15:04:49 +01001157 * @brief getInputForDevice selects an input handle for a given input device and
1158 * requester context
1159 * @param device to be used by requester, selected by policy mix rules or engine
1160 * @param session requester session id
1161 * @param uid requester uid
1162 * @param attributes requester audio attributes (e.g. input source and tags matter)
jiabinf1c73972022-04-14 16:28:52 -07001163 * @param config requested audio configuration (e.g. sample rate, format, channel mask),
1164 * will be updated if current configuration doesn't support but another
1165 * one does
François Gaffiec005e562018-11-06 15:04:49 +01001166 * @param flags requester input flags
1167 * @param policyMix may be null, policy rules to be followed by the requester
1168 * @return input io handle aka unique input identifier selected for this device.
1169 */
François Gaffie11d30102018-11-02 16:09:09 +01001170 audio_io_handle_t getInputForDevice(const sp<DeviceDescriptor> &device,
Eric Laurent599c7582015-12-07 18:05:55 -08001171 audio_session_t session,
François Gaffiec005e562018-11-06 15:04:49 +01001172 const audio_attributes_t &attributes,
jiabinf1c73972022-04-14 16:28:52 -07001173 audio_config_base_t *config,
Eric Laurent599c7582015-12-07 18:05:55 -08001174 audio_input_flags_t flags,
Mikhail Naganovbfac5832019-03-05 16:55:28 -08001175 const sp<AudioPolicyMix> &policyMix);
Eric Laurent599c7582015-12-07 18:05:55 -08001176
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001177 // event is one of STARTING_OUTPUT, STARTING_BEACON, STOPPING_OUTPUT, STOPPING_BEACON
1178 // returns 0 if no mute/unmute event happened, the largest latency of the device where
1179 // the mute/unmute happened
1180 uint32_t handleEventForBeacon(int event);
1181 uint32_t setBeaconMute(bool mute);
1182 bool isValidAttributes(const audio_attributes_t *paa);
1183
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001184 // Called by setDeviceConnectionState().
Nathalie Le Clair88fa2752021-11-23 13:03:41 +01001185 status_t setDeviceConnectionStateInt(audio_policy_dev_state_t state,
1186 const android::media::audio::common::AudioPort& port,
1187 audio_format_t encodedFormat);
François Gaffie11d30102018-11-02 16:09:09 +01001188 status_t setDeviceConnectionStateInt(audio_devices_t deviceType,
1189 audio_policy_dev_state_t state,
1190 const char *device_address,
Aniket Kumar Lata4e464702019-01-10 23:38:46 -08001191 const char *device_name,
1192 audio_format_t encodedFormat);
Mikhail Naganovd0e2c742020-03-25 15:59:59 -07001193 status_t setDeviceConnectionStateInt(const sp<DeviceDescriptor> &device,
1194 audio_policy_dev_state_t state);
Eric Laurent736a1022019-03-27 18:28:46 -07001195
1196 void setEngineDeviceConnectionState(const sp<DeviceDescriptor> device,
1197 audio_policy_dev_state_t state);
1198
Andy Hung2ddee192015-12-18 17:34:44 -08001199 void updateMono(audio_io_handle_t output) {
1200 AudioParameter param;
Mikhail Naganov388360c2016-10-17 17:09:41 -07001201 param.addInt(String8(AudioParameter::keyMonoOutput), (int)mMasterMono);
Andy Hung2ddee192015-12-18 17:34:44 -08001202 mpClientInterface->setParameters(output, param.toString());
1203 }
François Gaffieafd4cea2019-11-18 15:50:22 +01001204
1205 /**
1206 * @brief createAudioPatchInternal internal function to manage audio patch creation
1207 * @param[in] patch structure containing sink and source ports configuration
1208 * @param[out] handle patch handle to be provided if patch installed correctly
1209 * @param[in] uid of the client
1210 * @param[in] delayMs if required
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001211 * @param[in] sourceDesc source client to be configured when creating the patch, i.e.
1212 * assigning an Output (HW or SW) used for volume control.
François Gaffieafd4cea2019-11-18 15:50:22 +01001213 * @return NO_ERROR if patch installed correctly, error code otherwise.
1214 */
1215 status_t createAudioPatchInternal(const struct audio_patch *patch,
1216 audio_patch_handle_t *handle,
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001217 uid_t uid, uint32_t delayMs,
1218 const sp<SourceClientDescriptor>& sourceDesc);
François Gaffieafd4cea2019-11-18 15:50:22 +01001219 /**
1220 * @brief releaseAudioPatchInternal internal function to remove an audio patch
1221 * @param[in] handle of the patch to be removed
1222 * @param[in] delayMs if required
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001223 * @param[in] sourceDesc [optional] in case of external source, source client to be
1224 * unrouted from the patch, i.e. assigning an Output (HW or SW)
François Gaffieafd4cea2019-11-18 15:50:22 +01001225 * @return NO_ERROR if patch removed correctly, error code otherwise.
1226 */
Francois Gaffieb2e5cb52021-06-22 13:16:09 +02001227 status_t releaseAudioPatchInternal(audio_patch_handle_t handle,
1228 uint32_t delayMs = 0,
1229 const sp<SourceClientDescriptor>& sourceDesc = nullptr);
François Gaffieafd4cea2019-11-18 15:50:22 +01001230
Mikhail Naganovdc769682018-05-04 15:34:08 -07001231 status_t installPatch(const char *caller,
1232 audio_patch_handle_t *patchHandle,
1233 AudioIODescriptorInterface *ioDescriptor,
1234 const struct audio_patch *patch,
1235 int delayMs);
1236 status_t installPatch(const char *caller,
1237 ssize_t index,
1238 audio_patch_handle_t *patchHandle,
1239 const struct audio_patch *patch,
1240 int delayMs,
1241 uid_t uid,
1242 sp<AudioPatch> *patchDescPtr);
Eric Laurentc529cf62020-04-17 18:19:10 -07001243
1244 bool areAllDevicesSupported(
jiabin6a02d532020-08-07 11:56:38 -07001245 const AudioDeviceTypeAddrVector& devices,
Eric Laurentc529cf62020-04-17 18:19:10 -07001246 std::function<bool(audio_devices_t)> predicate,
1247 const char* context);
1248
Eric Laurent2517af32020-11-25 15:31:27 +01001249 bool isScoRequestedForComm() const;
jiabinbce0c1d2020-10-05 11:20:18 -07001250
Eric Laurent1a8b45f2022-04-13 16:01:47 +02001251 bool isHearingAidUsedForComm() const;
1252
jiabinbce0c1d2020-10-05 11:20:18 -07001253 bool areAllActiveTracksRerouted(const sp<SwAudioOutputDescriptor>& output);
1254
Eric Laurentb4f42a92022-01-17 17:37:31 +01001255 /**
1256 * @brief Opens an output stream from the supplied IOProfile and route it to the
1257 * supplied audio devices. If a mixer config is specified, it is forwarded to audio
1258 * flinger. If not, a default config is derived from the output stream config.
1259 * Also opens a duplicating output if needed and queries the audio HAL for supported
1260 * audio profiles if the IOProfile is dynamic.
1261 * @param[in] profile IOProfile to use as template
1262 * @param[in] devices initial route to apply to this output stream
1263 * @param[in] mixerConfig if not null, use this to configure the mixer
jiabina84c3d32022-12-02 18:59:55 +00001264 * @param[in] halConfig if not null, use this to configure the HAL
1265 * @param[in] flags the flags to be used to open the output
Eric Laurentb4f42a92022-01-17 17:37:31 +01001266 * @return an output descriptor for the newly opened stream or null in case of error.
1267 */
1268 sp<SwAudioOutputDescriptor> openOutputWithProfileAndDevice(
1269 const sp<IOProfile>& profile, const DeviceVector& devices,
jiabina84c3d32022-12-02 18:59:55 +00001270 const audio_config_base_t *mixerConfig = nullptr,
1271 const audio_config_t *halConfig = nullptr,
1272 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE);
jiabinbce0c1d2020-10-05 11:20:18 -07001273
jiabin2b9d5a12021-12-10 01:06:29 +00001274 bool isOffloadPossible(const audio_offload_info_t& offloadInfo,
1275 bool durationIgnored = false);
1276
Dorin Drimus94d94412022-02-02 09:05:02 +01001277 // adds the profiles from the outputProfile to the passed audioProfilesVector
1278 // without duplicating them if already present
1279 void addPortProfilesToVector(sp<IOProfile> outputProfile,
1280 AudioProfileVector& audioProfilesVector);
Dorin Drimusecc9f422022-03-09 17:57:40 +01001281
1282 // Searches for a compatible profile with the sample rate, audio format and channel mask
1283 // in the list of passed HwModule(s).
1284 // returns a compatible profile if found, nullptr otherwise
1285 sp<IOProfile> searchCompatibleProfileHwModules (
1286 const HwModuleCollection& hwModules,
1287 const DeviceVector& devices,
1288 uint32_t samplingRate,
1289 audio_format_t format,
1290 audio_channel_mask_t channelMask,
1291 audio_output_flags_t flags,
1292 bool directOnly);
1293
1294 // Filters only the relevant flags for getProfileForOutput
1295 audio_output_flags_t getRelevantFlags (audio_output_flags_t flags, bool directOnly);
jiabinf1c73972022-04-14 16:28:52 -07001296
1297 status_t getDevicesForAttributes(const audio_attributes_t &attr,
1298 DeviceVector &devices,
1299 bool forVolume);
1300
1301 status_t getProfilesForDevices(const DeviceVector& devices,
1302 AudioProfileVector& audioProfiles,
1303 uint32_t flags,
1304 bool isInput);
jiabina84c3d32022-12-02 18:59:55 +00001305
1306 sp<PreferredMixerAttributesInfo> getPreferredMixerAttributesInfo(
1307 audio_port_handle_t devicePortId, product_strategy_t strategy);
jiabinc44b3462022-12-08 12:52:31 -08001308
jiabin3ff8d7d2022-12-13 06:27:44 +00001309 sp<SwAudioOutputDescriptor> reopenOutput(
1310 sp<SwAudioOutputDescriptor> outputDesc,
1311 const audio_config_t *config,
1312 audio_output_flags_t flags,
1313 const char* caller);
1314
1315 void reopenOutputsWithDevices(
1316 const std::map<audio_io_handle_t, DeviceVector>& outputsToReopen);
jiabinc44b3462022-12-08 12:52:31 -08001317
1318 PortHandleVector getClientsForStream(audio_stream_type_t streamType) const;
1319 void invalidateStreams(StreamTypeVector streams) const;
Jean-Michel Trivi56ec4ff2015-01-23 16:45:18 -08001320};
1321
1322};