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 public: ~AudioPolicyInterface()73 virtual ~AudioPolicyInterface() {} 74 // 75 // configuration functions 76 // 77 78 // Informs APM that new HAL modules are available. This typically happens 79 // due to registration of an audio HAL service. 80 virtual void onNewAudioModulesAvailable() = 0; 81 82 // indicate a change in device connection status 83 virtual status_t setDeviceConnectionState(audio_devices_t device, 84 audio_policy_dev_state_t state, 85 const char *device_address, 86 const char *device_name, 87 audio_format_t encodedFormat) = 0; 88 // retrieve a device connection status 89 virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, 90 const char *device_address) = 0; 91 // indicate a change in device configuration 92 virtual status_t handleDeviceConfigChange(audio_devices_t device, 93 const char *device_address, 94 const char *device_name, 95 audio_format_t encodedFormat) = 0; 96 // indicate a change in phone state. Valid phones states are defined by audio_mode_t 97 virtual void setPhoneState(audio_mode_t state) = 0; 98 // force using a specific device category for the specified usage 99 virtual void setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config) = 0; 100 // retrieve current device category forced for a given usage 101 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) = 0; 102 // set a system property (e.g. camera sound always audible) 103 virtual void setSystemProperty(const char* property, const char* value) = 0; 104 // check proper initialization 105 virtual status_t initCheck() = 0; 106 107 // 108 // Audio routing query functions 109 // 110 111 // request an output appropriate for playback of the supplied stream type and parameters 112 virtual audio_io_handle_t getOutput(audio_stream_type_t stream) = 0; 113 virtual status_t getOutputForAttr(const audio_attributes_t *attr, 114 audio_io_handle_t *output, 115 audio_session_t session, 116 audio_stream_type_t *stream, 117 uid_t uid, 118 const audio_config_t *config, 119 audio_output_flags_t *flags, 120 audio_port_handle_t *selectedDeviceId, 121 audio_port_handle_t *portId, 122 std::vector<audio_io_handle_t> *secondaryOutputs) = 0; 123 // indicates to the audio policy manager that the output starts being used by corresponding stream. 124 virtual status_t startOutput(audio_port_handle_t portId) = 0; 125 // indicates to the audio policy manager that the output stops being used by corresponding stream. 126 virtual status_t stopOutput(audio_port_handle_t portId) = 0; 127 // releases the output. 128 virtual void releaseOutput(audio_port_handle_t portId) = 0; 129 130 // request an input appropriate for record from the supplied device with supplied parameters. 131 virtual status_t getInputForAttr(const audio_attributes_t *attr, 132 audio_io_handle_t *input, 133 audio_unique_id_t riid, 134 audio_session_t session, 135 uid_t uid, 136 const audio_config_base_t *config, 137 audio_input_flags_t flags, 138 audio_port_handle_t *selectedDeviceId, 139 input_type_t *inputType, 140 audio_port_handle_t *portId) = 0; 141 // indicates to the audio policy manager that the input starts being used. 142 virtual status_t startInput(audio_port_handle_t portId) = 0; 143 // indicates to the audio policy manager that the input stops being used. 144 virtual status_t stopInput(audio_port_handle_t portId) = 0; 145 // releases the input. 146 virtual void releaseInput(audio_port_handle_t portId) = 0; 147 148 // 149 // volume control functions 150 // 151 152 // initialises stream volume conversion parameters by specifying volume index range. 153 virtual void initStreamVolume(audio_stream_type_t stream, 154 int indexMin, 155 int indexMax) = 0; 156 157 // sets the new stream volume at a level corresponding to the supplied index for the 158 // supplied device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means 159 // setting volume for all devices 160 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream, 161 int index, 162 audio_devices_t device) = 0; 163 164 // retrieve current volume index for the specified stream and the 165 // specified device. By convention, specifying AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME means 166 // querying the volume of the active device. 167 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream, 168 int *index, 169 audio_devices_t device) = 0; 170 171 virtual status_t setVolumeIndexForAttributes(const audio_attributes_t &attr, 172 int index, 173 audio_devices_t device) = 0; 174 virtual status_t getVolumeIndexForAttributes(const audio_attributes_t &attr, 175 int &index, 176 audio_devices_t device) = 0; 177 178 virtual status_t getMaxVolumeIndexForAttributes(const audio_attributes_t &attr, 179 int &index) = 0; 180 181 virtual status_t getMinVolumeIndexForAttributes(const audio_attributes_t &attr, 182 int &index) = 0; 183 184 // return the strategy corresponding to a given stream type 185 virtual uint32_t getStrategyForStream(audio_stream_type_t stream) = 0; 186 187 // return the enabled output devices for the given stream type 188 virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream) = 0; 189 190 // Audio effect management 191 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc) = 0; 192 virtual status_t registerEffect(const effect_descriptor_t *desc, 193 audio_io_handle_t io, 194 uint32_t strategy, 195 int session, 196 int id) = 0; 197 virtual status_t unregisterEffect(int id) = 0; 198 virtual status_t setEffectEnabled(int id, bool enabled) = 0; 199 virtual status_t moveEffectsToIo(const std::vector<int>& ids, audio_io_handle_t io) = 0; 200 201 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const = 0; 202 virtual bool isStreamActiveRemotely(audio_stream_type_t stream, 203 uint32_t inPastMs = 0) const = 0; 204 virtual bool isSourceActive(audio_source_t source) const = 0; 205 206 //dump state 207 virtual status_t dump(int fd) = 0; 208 209 virtual status_t setAllowedCapturePolicy(uid_t uid, audio_flags_mask_t flags) = 0; 210 virtual bool isOffloadSupported(const audio_offload_info_t& offloadInfo) = 0; 211 virtual bool isDirectOutputSupported(const audio_config_base_t& config, 212 const audio_attributes_t& attributes) = 0; 213 214 virtual status_t listAudioPorts(audio_port_role_t role, 215 audio_port_type_t type, 216 unsigned int *num_ports, 217 struct audio_port *ports, 218 unsigned int *generation) = 0; 219 virtual status_t getAudioPort(struct audio_port *port) = 0; 220 virtual status_t createAudioPatch(const struct audio_patch *patch, 221 audio_patch_handle_t *handle, 222 uid_t uid) = 0; 223 virtual status_t releaseAudioPatch(audio_patch_handle_t handle, 224 uid_t uid) = 0; 225 virtual status_t listAudioPatches(unsigned int *num_patches, 226 struct audio_patch *patches, 227 unsigned int *generation) = 0; 228 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0; 229 virtual void releaseResourcesForUid(uid_t uid) = 0; 230 231 virtual status_t acquireSoundTriggerSession(audio_session_t *session, 232 audio_io_handle_t *ioHandle, 233 audio_devices_t *device) = 0; 234 235 virtual status_t releaseSoundTriggerSession(audio_session_t session) = 0; 236 237 virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes) = 0; 238 virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes) = 0; 239 240 virtual status_t setUidDeviceAffinities(uid_t uid, const Vector<AudioDeviceTypeAddr>& devices) 241 = 0; 242 virtual status_t removeUidDeviceAffinities(uid_t uid) = 0; 243 244 virtual status_t startAudioSource(const struct audio_port_config *source, 245 const audio_attributes_t *attributes, 246 audio_port_handle_t *portId, 247 uid_t uid) = 0; 248 virtual status_t stopAudioSource(audio_port_handle_t portId) = 0; 249 250 virtual status_t setMasterMono(bool mono) = 0; 251 virtual status_t getMasterMono(bool *mono) = 0; 252 253 virtual float getStreamVolumeDB( 254 audio_stream_type_t stream, int index, audio_devices_t device) = 0; 255 256 virtual status_t getSurroundFormats(unsigned int *numSurroundFormats, 257 audio_format_t *surroundFormats, 258 bool *surroundFormatsEnabled, 259 bool reported) = 0; 260 virtual status_t setSurroundFormatEnabled(audio_format_t audioFormat, bool enabled) = 0; 261 262 virtual bool isHapticPlaybackSupported() = 0; 263 264 virtual status_t getHwOffloadEncodingFormatsSupportedForA2DP( 265 std::vector<audio_format_t> *formats) = 0; 266 267 virtual void setAppState(uid_t uid, app_state_t state) = 0; 268 269 virtual status_t listAudioProductStrategies(AudioProductStrategyVector &strategies) = 0; 270 271 virtual status_t getProductStrategyFromAudioAttributes(const AudioAttributes &aa, 272 product_strategy_t &productStrategy) = 0; 273 274 virtual status_t listAudioVolumeGroups(AudioVolumeGroupVector &groups) = 0; 275 276 virtual status_t getVolumeGroupFromAudioAttributes(const AudioAttributes &aa, 277 volume_group_t &volumeGroup) = 0; 278 279 virtual status_t setPreferredDeviceForStrategy(product_strategy_t strategy, 280 const AudioDeviceTypeAddr &device) = 0; 281 282 virtual status_t removePreferredDeviceForStrategy(product_strategy_t strategy) = 0; 283 284 virtual status_t getPreferredDeviceForStrategy(product_strategy_t strategy, 285 AudioDeviceTypeAddr &device) = 0; 286 }; 287 288 289 // Audio Policy client Interface 290 class AudioPolicyClientInterface 291 { 292 public: ~AudioPolicyClientInterface()293 virtual ~AudioPolicyClientInterface() {} 294 295 // 296 // Audio HW module functions 297 // 298 299 // loads a HW module. 300 virtual audio_module_handle_t loadHwModule(const char *name) = 0; 301 302 // 303 // Audio output Control functions 304 // 305 306 // opens an audio output with the requested parameters. The parameter values can indicate to use the default values 307 // in case the audio policy manager has no specific requirements for the output being opened. 308 // When the function returns, the parameter values reflect the actual values used by the audio hardware output stream. 309 // The audio policy manager can check if the proposed parameters are suitable or not and act accordingly. 310 virtual status_t openOutput(audio_module_handle_t module, 311 audio_io_handle_t *output, 312 audio_config_t *config, 313 const sp<DeviceDescriptorBase>& device, 314 uint32_t *latencyMs, 315 audio_output_flags_t flags) = 0; 316 // creates a special output that is duplicated to the two outputs passed as arguments. The duplication is performed by 317 // a special mixer thread in the AudioFlinger. 318 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, audio_io_handle_t output2) = 0; 319 // closes the output stream 320 virtual status_t closeOutput(audio_io_handle_t output) = 0; 321 // suspends the output. When an output is suspended, the corresponding audio hardware output stream is placed in 322 // standby and the AudioTracks attached to the mixer thread are still processed but the output mix is discarded. 323 virtual status_t suspendOutput(audio_io_handle_t output) = 0; 324 // restores a suspended output. 325 virtual status_t restoreOutput(audio_io_handle_t output) = 0; 326 327 // 328 // Audio input Control functions 329 // 330 331 // opens an audio input 332 virtual status_t openInput(audio_module_handle_t module, 333 audio_io_handle_t *input, 334 audio_config_t *config, 335 audio_devices_t *device, 336 const String8& address, 337 audio_source_t source, 338 audio_input_flags_t flags) = 0; 339 // closes an audio input 340 virtual status_t closeInput(audio_io_handle_t input) = 0; 341 // 342 // misc control functions 343 // 344 345 // set a stream volume for a particular output. For the same user setting, a given stream type can have different volumes 346 // for each output (destination device) it is attached to. 347 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume, audio_io_handle_t output, int delayMs = 0) = 0; 348 349 // invalidate a stream type, causing a reroute to an unspecified new output 350 virtual status_t invalidateStream(audio_stream_type_t stream) = 0; 351 352 // function enabling to send proprietary informations directly from audio policy manager to audio hardware interface. 353 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs, int delayMs = 0) = 0; 354 // function enabling to receive proprietary informations directly from audio hardware interface to audio policy manager. 355 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) = 0; 356 357 // set down link audio volume. 358 virtual status_t setVoiceVolume(float volume, int delayMs = 0) = 0; 359 360 // move effect to the specified output 361 virtual status_t moveEffects(audio_session_t session, 362 audio_io_handle_t srcOutput, 363 audio_io_handle_t dstOutput) = 0; 364 365 virtual void setEffectSuspended(int effectId, 366 audio_session_t sessionId, 367 bool suspended) = 0; 368 369 /* Create a patch between several source and sink ports */ 370 virtual status_t createAudioPatch(const struct audio_patch *patch, 371 audio_patch_handle_t *handle, 372 int delayMs) = 0; 373 374 /* Release a patch */ 375 virtual status_t releaseAudioPatch(audio_patch_handle_t handle, 376 int delayMs) = 0; 377 378 /* Set audio port configuration */ 379 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs) = 0; 380 381 virtual void onAudioPortListUpdate() = 0; 382 383 virtual void onAudioPatchListUpdate() = 0; 384 385 virtual void onAudioVolumeGroupChanged(volume_group_t group, int flags) = 0; 386 387 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0; 388 389 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state) = 0; 390 391 virtual void onRecordingConfigurationUpdate(int event, 392 const record_client_info_t *clientInfo, 393 const audio_config_base_t *clientConfig, 394 std::vector<effect_descriptor_t> clientEffects, 395 const audio_config_base_t *deviceConfig, 396 std::vector<effect_descriptor_t> effects, 397 audio_patch_handle_t patchHandle, 398 audio_source_t source) = 0; 399 }; 400 401 extern "C" AudioPolicyInterface* createAudioPolicyManager(AudioPolicyClientInterface *clientInterface); 402 extern "C" void destroyAudioPolicyManager(AudioPolicyInterface *interface); 403 404 405 } // namespace android 406 407 #endif // ANDROID_AUDIOPOLICY_INTERFACE_H 408