1 /* 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 17 #ifndef ANDROID_AUDIOPOLICY_INTERFACE_H 18 #define ANDROID_AUDIOPOLICY_INTERFACE_H 19 20 #include <media/AudioCommonTypes.h> 21 #include <media/AudioDeviceTypeAddr.h> 22 #include <media/AudioSystem.h> 23 #include <media/AudioPolicy.h> 24 #include <media/DeviceDescriptorBase.h> 25 #include <android/content/AttributionSourceState.h> 26 #include <utils/String8.h> 27 28 namespace android { 29 30 using content::AttributionSourceState; 31 32 // ---------------------------------------------------------------------------- 33 34 // The AudioPolicyInterface and AudioPolicyClientInterface classes define the communication interfaces 35 // between the platform specific audio policy manager and Android generic audio policy manager. 36 // The platform specific audio policy manager must implement methods of the AudioPolicyInterface class. 37 // This implementation makes use of the AudioPolicyClientInterface to control the activity and 38 // configuration of audio input and output streams. 39 // 40 // The platform specific audio policy manager is in charge of the audio routing and volume control 41 // policies for a given platform. 42 // The main roles of this module are: 43 // - keep track of current system state (removable device connections, phone state, user requests...). 44 // System state changes and user actions are notified to audio policy manager with methods of the AudioPolicyInterface. 45 // - process getOutput() queries received when AudioTrack objects are created: Those queries 46 // return a handler on an output that has been selected, configured and opened by the audio policy manager and that 47 // must be used by the AudioTrack when registering to the AudioFlinger with the createTrack() method. 48 // When the AudioTrack object is released, a putOutput() query is received and the audio policy manager can decide 49 // to close or reconfigure the output depending on other streams using this output and current system state. 50 // - similarly process getInput() and putInput() queries received from AudioRecord objects and configure audio inputs. 51 // - process volume control requests: the stream volume is converted from an index value (received from UI) to a float value 52 // applicable to each output as a function of platform specific settings and current output route (destination device). It 53 // also make sure that streams are not muted if not allowed (e.g. camera shutter sound in some countries). 54 // 55 // The platform specific audio policy manager is provided as a shared library by platform vendors (as for libaudio.so) 56 // and is linked with libaudioflinger.so 57 58 59 // Audio Policy Manager Interface 60 class AudioPolicyInterface 61 { 62 63 public: 64 typedef enum { 65 API_INPUT_INVALID = -1, 66 API_INPUT_LEGACY = 0,// e.g. audio recording from a microphone 67 API_INPUT_MIX_CAPTURE,// used for "remote submix" legacy mode (no DAP), 68 // capture of the media to play it remotely 69 API_INPUT_MIX_EXT_POLICY_REROUTE,// used for platform audio rerouting, where mixes are 70 // handled by external and dynamically installed 71 // policies which reroute audio mixes 72 API_INPUT_MIX_PUBLIC_CAPTURE_PLAYBACK, // used for playback capture with a MediaProjection 73 API_INPUT_TELEPHONY_RX, // used for capture from telephony RX path 74 } input_type_t; 75 76 typedef enum { 77 API_OUTPUT_INVALID = -1, 78 API_OUTPUT_LEGACY = 0,// e.g. audio playing to speaker 79 API_OUT_MIX_PLAYBACK, // used for "remote submix" playback of audio from remote source 80 // to local capture 81 API_OUTPUT_TELEPHONY_TX, // used for playback to telephony TX path 82 } output_type_t; 83 84 public: ~AudioPolicyInterface()85 virtual ~AudioPolicyInterface() {} 86 // 87 // configuration functions 88 // 89 90 // Informs APM that new HAL modules are available. This typically happens 91 // due to registration of an audio HAL service. 92 virtual void onNewAudioModulesAvailable() = 0; 93 94 // indicate a change in device connection status 95 virtual status_t setDeviceConnectionState(audio_devices_t device, 96 audio_policy_dev_state_t state, 97 const char *device_address, 98 const char *device_name, 99 audio_format_t encodedFormat) = 0; 100 // retrieve a device connection status 101 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, 102 const char *device_address) = 0; 103 // indicate a change in device configuration 104 virtual status_t handleDeviceConfigChange(audio_devices_t device, 105 const char *device_address, 106 const char *device_name, 107 audio_format_t encodedFormat) = 0; 108 // indicate a change in phone state. Valid phones states are defined by audio_mode_t 109 virtual void setPhoneState(audio_mode_t state) = 0; 110 // force using a specific device category for the specified usage 111 virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0; 112 // retrieve current device category forced for a given usage 113 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0; 114 // set a system property (e.g. camera sound always audible) 115 virtual void setSystemProperty(const char* property, const char* value) = 0; 116 // check proper initialization 117 virtual status_t initCheck() = 0; 118 119 // 120 // Audio routing query functions 121 // 122 123 // request an output appropriate for playback of the supplied stream type and parameters 124 virtual audio_io_handle_t getOutput(audio_stream_type_t stream) = 0; 125 virtual status_t getOutputForAttr(const audio_attributes_t *attr, 126 audio_io_handle_t *output, 127 audio_session_t session, 128 audio_stream_type_t *stream, 129 const AttributionSourceState& attributionSouce, 130 const audio_config_t *config, 131 audio_output_flags_t *flags, 132 audio_port_handle_t *selectedDeviceId, 133 audio_port_handle_t *portId, 134 std::vector<audio_io_handle_t> *secondaryOutputs, 135 output_type_t *outputType) = 0; 136 // indicates to the audio policy manager that the output starts being used by corresponding stream. 137 virtual status_t startOutput(audio_port_handle_t portId) = 0; 138 // indicates to the audio policy manager that the output stops being used by corresponding stream. 139 virtual status_t stopOutput(audio_port_handle_t portId) = 0; 140 // releases the output, return true if the output descriptor is reopened. 141 virtual bool releaseOutput(audio_port_handle_t portId) = 0; 142 143 // request an input appropriate for record from the supplied device with supplied parameters. 144 virtual status_t getInputForAttr(const audio_attributes_t *attr, 145 audio_io_handle_t *input, 146 audio_unique_id_t riid, 147 audio_session_t session, 148 const AttributionSourceState& attributionSouce, 149 const audio_config_base_t *config, 150 audio_input_flags_t flags, 151 audio_port_handle_t *selectedDeviceId, 152 input_type_t *inputType, 153 audio_port_handle_t *portId) = 0; 154 // indicates to the audio policy manager that the input starts being used. 155 virtual status_t startInput(audio_port_handle_t portId) = 0; 156 // indicates to the audio policy manager that the input stops being used. 157 virtual status_t stopInput(audio_port_handle_t portId) = 0; 158 // releases the input. 159 virtual void releaseInput(audio_port_handle_t portId) = 0; 160 161 // 162 // volume control functions 163 // 164 165 // initialises stream volume conversion parameters by specifying volume index range. 166 virtual void initStreamVolume(audio_stream_type_t stream, 167 int indexMin, 168 int indexMax) = 0; 169 170 // sets the new stream volume at a level corresponding to the supplied index for the 171 // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means 172 // setting volume for all devices 173 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream, 174 int index, 175 audio_devices_t device) = 0; 176 177 // retrieve current volume index for the specified stream and the 178 // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means 179 // querying the volume of the active device. 180 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream, 181 int *index, 182 audio_devices_t device) = 0; 183 184 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr, 185 int index, 186 audio_devices_t device) = 0; 187 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr, 188 int &index, 189 audio_devices_t device) = 0; 190 191 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr, 192 int &index) = 0; 193 194 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr, 195 int &index) = 0; 196 197 // return the strategy corresponding to a given stream type 198 virtual product_strategy_t getStrategyForStream(audio_stream_type_t stream) = 0; 199 200 // return the enabled output devices for the given stream type 201 virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream) = 0; 202 203 // retrieves the list of enabled output devices for the given audio attributes 204 virtual status_t getDevicesForAttributes(const audio_attributes_t &attr, 205 AudioDeviceTypeAddrVector *devices) = 0; 206 207 // Audio effect management 208 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0; 209 virtual status_t registerEffect(const effect_descriptor_t *desc, 210 audio_io_handle_t io, 211 product_strategy_t strategy, 212 int session, 213 int id) = 0; 214 virtual status_t unregisterEffect(int id) = 0; 215 virtual status_t setEffectEnabled(int id, bool enabled) = 0; 216 virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0; 217 218 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0; 219 virtual bool isStreamActiveRemotely(audio_stream_type_t stream, 220 uint32_t inPastMs = 0) const = 0; 221 virtual bool isSourceActive(audio_source_t source) const = 0; 222 223 //dump state 224 virtual status_t dump(int fd) = 0; 225 226 virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0; 227 virtual audio_offload_mode_t getOffloadSupport(const audio_offload_info_t& offloadInfo) = 0; 228 virtual bool isDirectOutputSupported(const audio_config_base_t& config, 229 const audio_attributes_t& attributes) = 0; 230 231 virtual status_t listAudioPorts(audio_port_role_t role, 232 audio_port_type_t type, 233 unsigned int *num_ports, 234 struct audio_port_v7 *ports, 235 unsigned int *generation) = 0; 236 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0; 237 virtual status_t createAudioPatch(const struct audio_patch *patch, 238 audio_patch_handle_t *handle, 239 uid_t uid) = 0; 240 virtual status_t releaseAudioPatch(audio_patch_handle_t handle, 241 uid_t uid) = 0; 242 virtual status_t listAudioPatches(unsigned int *num_patches, 243 struct audio_patch *patches, 244 unsigned int *generation) = 0; 245 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0; 246 virtual void releaseResourcesForUid(uid_t uid) = 0; 247 248 virtual status_t acquireSoundTriggerSession(audio_session_t *session, 249 audio_io_handle_t *ioHandle, 250 audio_devices_t *device) = 0; 251 252 virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0; 253 254 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0; 255 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0; 256 257 virtual status_t setUidDeviceAffinities(uid_t uid, const AudioDeviceTypeAddrVector& devices) 258 = 0; 259 virtual status_t removeUidDeviceAffinities(uid_t uid) = 0; 260 261 virtual status_t setUserIdDeviceAffinities(int userId, 262 const AudioDeviceTypeAddrVector& devices) = 0; 263 virtual status_t removeUserIdDeviceAffinities(int userId) = 0; 264 265 virtual status_t startAudioSource(const struct audio_port_config *source, 266 const audio_attributes_t *attributes, 267 audio_port_handle_t *portId, 268 uid_t uid) = 0; 269 virtual status_t stopAudioSource(audio_port_handle_t portId) = 0; 270 271 virtual status_t setMasterMono(bool mono) = 0; 272 virtual status_t getMasterMono(bool *mono) = 0; 273 274 virtual float getStreamVolumeDB( 275 audio_stream_type_t stream, int index, audio_devices_t device) = 0; 276 277 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats, 278 audio_format_t *surroundFormats, 279 bool *surroundFormatsEnabled) = 0; 280 281 virtual status_t getReportedSurroundFormats(unsigned int *numSurroundFormats, 282 audio_format_t *surroundFormats) = 0; 283 284 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0; 285 286 virtual bool isHapticPlaybackSupported() = 0; 287 288 virtual status_t getHwOffloadEncodingFormatsSupportedForA2DP( 289 std::vector<audio_format_t> *formats) = 0; 290 291 virtual void setAppState(audio_port_handle_t portId, app_state_t state) = 0; 292 293 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0; 294 295 virtual status_t getProductStrategyFromAudioAttributes( 296 const AudioAttributes &aa, product_strategy_t &productStrategy, 297 bool fallbackOnDefault) = 0; 298 299 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0; 300 301 virtual status_t getVolumeGroupFromAudioAttributes( 302 const AudioAttributes &aa, volume_group_t &volumeGroup, bool fallbackOnDefault) = 0; 303 304 virtual bool isCallScreenModeSupported() = 0; 305 306 virtual status_t setDevicesRoleForStrategy(product_strategy_t strategy, 307 device_role_t role, 308 const AudioDeviceTypeAddrVector &devices) = 0; 309 310 virtual status_t removeDevicesRoleForStrategy(product_strategy_t strategy, 311 device_role_t role) = 0; 312 313 314 virtual status_t getDevicesForRoleAndStrategy(product_strategy_t strategy, 315 device_role_t role, 316 AudioDeviceTypeAddrVector &devices) = 0; 317 318 virtual status_t setDevicesRoleForCapturePreset(audio_source_t audioSource, 319 device_role_t role, 320 const AudioDeviceTypeAddrVector &devices) = 0; 321 322 virtual status_t addDevicesRoleForCapturePreset(audio_source_t audioSource, 323 device_role_t role, 324 const AudioDeviceTypeAddrVector &devices) = 0; 325 326 virtual status_t removeDevicesRoleForCapturePreset( 327 audio_source_t audioSource, device_role_t role, 328 const AudioDeviceTypeAddrVector& devices) = 0; 329 330 virtual status_t clearDevicesRoleForCapturePreset(audio_source_t audioSource, 331 device_role_t role) = 0; 332 333 virtual status_t getDevicesForRoleAndCapturePreset(audio_source_t audioSource, 334 device_role_t role, 335 AudioDeviceTypeAddrVector &devices) = 0; 336 337 /** 338 * Queries if some kind of spatialization will be performed if the audio playback context 339 * described by the provided arguments is present. 340 * The context is made of: 341 * - The audio attributes describing the playback use case. 342 * - The audio configuration describing the audio format, channels, sampling rate ... 343 * - The devices describing the sink audio device selected for playback. 344 * All arguments are optional and only the specified arguments are used to match against 345 * supported criteria. For instance, supplying no argument will tell if spatialization is 346 * supported or not in general. 347 * @param attr audio attributes describing the playback use case 348 * @param config audio configuration describing the audio format, channels, sampling rate... 349 * @param devices the sink audio device selected for playback 350 * @return true if spatialization is enabled for this context, 351 * false otherwise 352 */ 353 virtual bool canBeSpatialized(const audio_attributes_t *attr, 354 const audio_config_t *config, 355 const AudioDeviceTypeAddrVector &devices) const = 0; 356 357 /** 358 * Opens a specialized spatializer output if supported by the platform. 359 * If several spatializer output profiles exist, the one supporting the sink device 360 * corresponding to the provided audio attributes will be selected. 361 * Only one spatializer output stream can be opened at a time and an error is returned 362 * if one already exists. 363 * @param config audio format, channel mask and sampling rate to be used as the mixer 364 * configuration for the spatializer mixer created. 365 * @param attr audio attributes describing the playback use case that will drive the 366 * sink device selection 367 * @param output the IO handle of the output opened 368 * @return NO_ERROR if an output was opened, INVALID_OPERATION or BAD_VALUE otherwise 369 */ 370 virtual status_t getSpatializerOutput(const audio_config_base_t *config, 371 const audio_attributes_t *attr, 372 audio_io_handle_t *output) = 0; 373 374 /** 375 * Closes a previously opened specialized spatializer output. 376 * @param output the IO handle of the output to close. 377 * @return NO_ERROR if an output was closed, INVALID_OPERATION or BAD_VALUE otherwise 378 */ 379 virtual status_t releaseSpatializerOutput(audio_io_handle_t output) = 0; 380 }; 381 382 383 // Audio Policy client Interface 384 class AudioPolicyClientInterface 385 { 386 public: ~AudioPolicyClientInterface()387 virtual ~AudioPolicyClientInterface() {} 388 389 // 390 // Audio HW module functions 391 // 392 393 // loads a HW module. 394 virtual audio_module_handle_t loadHwModule(const char *name) = 0; 395 396 // 397 // Audio output Control functions 398 // 399 400 // opens an audio output with the requested parameters. The parameter values can indicate to use the default values 401 // in case the audio policy manager has no specific requirements for the output being opened. 402 // When the function returns, the parameter values reflect the actual values used by the audio hardware output stream. 403 // The audio policy manager can check if the proposed parameters are suitable or not and act accordingly. 404 virtual status_t openOutput(audio_module_handle_t module, 405 audio_io_handle_t *output, 406 audio_config_t *halConfig, 407 audio_config_base_t *mixerConfig, 408 const sp<DeviceDescriptorBase>& device, 409 uint32_t *latencyMs, 410 audio_output_flags_t flags) = 0; 411 // creates a special output that is duplicated to the two outputs passed as arguments. The duplication is performed by 412 // a special mixer thread in the AudioFlinger. 413 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, audio_io_handle_t output2) = 0; 414 // closes the output stream 415 virtual status_t closeOutput(audio_io_handle_t output) = 0; 416 // suspends the output. When an output is suspended, the corresponding audio hardware output stream is placed in 417 // standby and the AudioTracks attached to the mixer thread are still processed but the output mix is discarded. 418 virtual status_t suspendOutput(audio_io_handle_t output) = 0; 419 // restores a suspended output. 420 virtual status_t restoreOutput(audio_io_handle_t output) = 0; 421 422 // 423 // Audio input Control functions 424 // 425 426 // opens an audio input 427 virtual status_t openInput(audio_module_handle_t module, 428 audio_io_handle_t *input, 429 audio_config_t *config, 430 audio_devices_t *device, 431 const String8& address, 432 audio_source_t source, 433 audio_input_flags_t flags) = 0; 434 // closes an audio input 435 virtual status_t closeInput(audio_io_handle_t input) = 0; 436 // 437 // misc control functions 438 // 439 440 // set a stream volume for a particular output. For the same user setting, a given stream type can have different volumes 441 // for each output (destination device) it is attached to. 442 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume, audio_io_handle_t output, int delayMs = 0) = 0; 443 444 // invalidate a stream type, causing a reroute to an unspecified new output 445 virtual status_t invalidateStream(audio_stream_type_t stream) = 0; 446 447 // function enabling to send proprietary informations directly from audio policy manager to audio hardware interface. 448 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs, int delayMs = 0) = 0; 449 // function enabling to receive proprietary informations directly from audio hardware interface to audio policy manager. 450 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0; 451 452 // set down link audio volume. 453 virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0; 454 455 // move effect to the specified output 456 virtual status_t moveEffects(audio_session_t session, 457 audio_io_handle_t srcOutput, 458 audio_io_handle_t dstOutput) = 0; 459 460 virtual void setEffectSuspended(int effectId, 461 audio_session_t sessionId, 462 bool suspended) = 0; 463 464 /* Create a patch between several source and sink ports */ 465 virtual status_t createAudioPatch(const struct audio_patch *patch, 466 audio_patch_handle_t *handle, 467 int delayMs) = 0; 468 469 /* Release a patch */ 470 virtual status_t releaseAudioPatch(audio_patch_handle_t handle, 471 int delayMs) = 0; 472 473 /* Set audio port configuration */ 474 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0; 475 476 virtual void onAudioPortListUpdate() = 0; 477 478 virtual void onAudioPatchListUpdate() = 0; 479 480 virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0; 481 482 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0; 483 484 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0; 485 486 virtual void onRecordingConfigurationUpdate(int event, 487 const record_client_info_t *clientInfo, 488 const audio_config_base_t *clientConfig, 489 std::vector<effect_descriptor_t> clientEffects, 490 const audio_config_base_t *deviceConfig, 491 std::vector<effect_descriptor_t> effects, 492 audio_patch_handle_t patchHandle, 493 audio_source_t source) = 0; 494 495 virtual void onRoutingUpdated() = 0; 496 497 // Used to notify the sound trigger module that an audio capture is about to 498 // take place. This should typically result in any active recognition 499 // sessions to be preempted on modules that do not support sound trigger 500 // recognition concurrently with audio capture. 501 virtual void setSoundTriggerCaptureState(bool active) = 0; 502 503 virtual status_t getAudioPort(struct audio_port_v7 *port) = 0; 504 505 virtual status_t updateSecondaryOutputs( 506 const TrackSecondaryOutputsMap& trackSecondaryOutputs) = 0; 507 }; 508 509 // These are the signatures of createAudioPolicyManager/destroyAudioPolicyManager 510 // methods respectively, expected by AudioPolicyService, needs to be exposed by 511 // libaudiopolicymanagercustom. 512 using CreateAudioPolicyManagerInstance = AudioPolicyInterface* (*)(AudioPolicyClientInterface*); 513 using DestroyAudioPolicyManagerInstance = void (*)(AudioPolicyInterface*); 514 515 } // namespace android 516 517 #endif // ANDROID_AUDIOPOLICY_INTERFACE_H 518