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