AudioPolicyService.h revision 8c7cf3b7d0d7bccb9affbc34ae2ab2d6b332f972
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_AUDIOPOLICYSERVICE_H 18#define ANDROID_AUDIOPOLICYSERVICE_H 19 20#include <cutils/misc.h> 21#include <cutils/config_utils.h> 22#include <cutils/compiler.h> 23#include <utils/String8.h> 24#include <utils/Vector.h> 25#include <utils/SortedVector.h> 26#include <binder/BinderService.h> 27#include <system/audio.h> 28#include <system/audio_policy.h> 29#include <hardware/audio_policy.h> 30#include <media/IAudioPolicyService.h> 31#include <media/ToneGenerator.h> 32#include <media/AudioEffect.h> 33#include <media/AudioPolicy.h> 34#ifdef USE_LEGACY_AUDIO_POLICY 35#include <hardware_legacy/AudioPolicyInterface.h> 36#endif 37#include "AudioPolicyEffects.h" 38#include "managerdefault/AudioPolicyManager.h" 39 40 41namespace android { 42 43// ---------------------------------------------------------------------------- 44 45class AudioPolicyService : 46 public BinderService<AudioPolicyService>, 47 public BnAudioPolicyService, 48 public IBinder::DeathRecipient 49{ 50 friend class BinderService<AudioPolicyService>; 51 52public: 53 // for BinderService 54 static const char *getServiceName() ANDROID_API { return "media.audio_policy"; } 55 56 virtual status_t dump(int fd, const Vector<String16>& args); 57 58 // 59 // BnAudioPolicyService (see AudioPolicyInterface for method descriptions) 60 // 61 62 virtual status_t setDeviceConnectionState(audio_devices_t device, 63 audio_policy_dev_state_t state, 64 const char *device_address, 65 const char *device_name); 66 virtual audio_policy_dev_state_t getDeviceConnectionState( 67 audio_devices_t device, 68 const char *device_address); 69 virtual status_t setPhoneState(audio_mode_t state); 70 virtual status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config); 71 virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage); 72 virtual audio_io_handle_t getOutput(audio_stream_type_t stream, 73 uint32_t samplingRate = 0, 74 audio_format_t format = AUDIO_FORMAT_DEFAULT, 75 audio_channel_mask_t channelMask = 0, 76 audio_output_flags_t flags = 77 AUDIO_OUTPUT_FLAG_NONE, 78 const audio_offload_info_t *offloadInfo = NULL); 79 virtual status_t getOutputForAttr(const audio_attributes_t *attr, 80 audio_io_handle_t *output, 81 audio_session_t session, 82 audio_stream_type_t *stream, 83 uid_t uid, 84 uint32_t samplingRate = 0, 85 audio_format_t format = AUDIO_FORMAT_DEFAULT, 86 audio_channel_mask_t channelMask = 0, 87 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 88 audio_port_handle_t selectedDeviceId = AUDIO_PORT_HANDLE_NONE, 89 const audio_offload_info_t *offloadInfo = NULL); 90 virtual status_t startOutput(audio_io_handle_t output, 91 audio_stream_type_t stream, 92 audio_session_t session); 93 virtual status_t stopOutput(audio_io_handle_t output, 94 audio_stream_type_t stream, 95 audio_session_t session); 96 virtual void releaseOutput(audio_io_handle_t output, 97 audio_stream_type_t stream, 98 audio_session_t session); 99 virtual status_t getInputForAttr(const audio_attributes_t *attr, 100 audio_io_handle_t *input, 101 audio_session_t session, 102 uid_t uid, 103 uint32_t samplingRate, 104 audio_format_t format, 105 audio_channel_mask_t channelMask, 106 audio_input_flags_t flags, 107 audio_port_handle_t selectedDeviceId = AUDIO_PORT_HANDLE_NONE); 108 virtual status_t startInput(audio_io_handle_t input, 109 audio_session_t session); 110 virtual status_t stopInput(audio_io_handle_t input, 111 audio_session_t session); 112 virtual void releaseInput(audio_io_handle_t input, 113 audio_session_t session); 114 virtual status_t initStreamVolume(audio_stream_type_t stream, 115 int indexMin, 116 int indexMax); 117 virtual status_t setStreamVolumeIndex(audio_stream_type_t stream, 118 int index, 119 audio_devices_t device); 120 virtual status_t getStreamVolumeIndex(audio_stream_type_t stream, 121 int *index, 122 audio_devices_t device); 123 124 virtual uint32_t getStrategyForStream(audio_stream_type_t stream); 125 virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream); 126 127 virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc); 128 virtual status_t registerEffect(const effect_descriptor_t *desc, 129 audio_io_handle_t io, 130 uint32_t strategy, 131 int session, 132 int id); 133 virtual status_t unregisterEffect(int id); 134 virtual status_t setEffectEnabled(int id, bool enabled); 135 virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const; 136 virtual bool isStreamActiveRemotely(audio_stream_type_t stream, uint32_t inPastMs = 0) const; 137 virtual bool isSourceActive(audio_source_t source) const; 138 139 virtual status_t queryDefaultPreProcessing(int audioSession, 140 effect_descriptor_t *descriptors, 141 uint32_t *count); 142 virtual status_t onTransact( 143 uint32_t code, 144 const Parcel& data, 145 Parcel* reply, 146 uint32_t flags); 147 148 // IBinder::DeathRecipient 149 virtual void binderDied(const wp<IBinder>& who); 150 151 // RefBase 152 virtual void onFirstRef(); 153 154 // 155 // Helpers for the struct audio_policy_service_ops implementation. 156 // This is used by the audio policy manager for certain operations that 157 // are implemented by the policy service. 158 // 159 virtual void setParameters(audio_io_handle_t ioHandle, 160 const char *keyValuePairs, 161 int delayMs); 162 163 virtual status_t setStreamVolume(audio_stream_type_t stream, 164 float volume, 165 audio_io_handle_t output, 166 int delayMs = 0); 167 virtual status_t startTone(audio_policy_tone_t tone, audio_stream_type_t stream); 168 virtual status_t stopTone(); 169 virtual status_t setVoiceVolume(float volume, int delayMs = 0); 170 virtual bool isOffloadSupported(const audio_offload_info_t &config); 171 172 virtual status_t listAudioPorts(audio_port_role_t role, 173 audio_port_type_t type, 174 unsigned int *num_ports, 175 struct audio_port *ports, 176 unsigned int *generation); 177 virtual status_t getAudioPort(struct audio_port *port); 178 virtual status_t createAudioPatch(const struct audio_patch *patch, 179 audio_patch_handle_t *handle); 180 virtual status_t releaseAudioPatch(audio_patch_handle_t handle); 181 virtual status_t listAudioPatches(unsigned int *num_patches, 182 struct audio_patch *patches, 183 unsigned int *generation); 184 virtual status_t setAudioPortConfig(const struct audio_port_config *config); 185 186 virtual void registerClient(const sp<IAudioPolicyServiceClient>& client); 187 188 virtual void setAudioPortCallbacksEnabled(bool enabled); 189 190 virtual status_t acquireSoundTriggerSession(audio_session_t *session, 191 audio_io_handle_t *ioHandle, 192 audio_devices_t *device); 193 194 virtual status_t releaseSoundTriggerSession(audio_session_t session); 195 196 virtual audio_mode_t getPhoneState(); 197 198 virtual status_t registerPolicyMixes(Vector<AudioMix> mixes, bool registration); 199 200 virtual status_t startAudioSource(const struct audio_port_config *source, 201 const audio_attributes_t *attributes, 202 audio_io_handle_t *handle); 203 virtual status_t stopAudioSource(audio_io_handle_t handle); 204 205 virtual status_t setMasterMono(bool mono); 206 virtual status_t getMasterMono(bool *mono); 207 208 status_t doStopOutput(audio_io_handle_t output, 209 audio_stream_type_t stream, 210 audio_session_t session); 211 void doReleaseOutput(audio_io_handle_t output, 212 audio_stream_type_t stream, 213 audio_session_t session); 214 215 status_t clientCreateAudioPatch(const struct audio_patch *patch, 216 audio_patch_handle_t *handle, 217 int delayMs); 218 status_t clientReleaseAudioPatch(audio_patch_handle_t handle, 219 int delayMs); 220 virtual status_t clientSetAudioPortConfig(const struct audio_port_config *config, 221 int delayMs); 222 223 void removeNotificationClient(uid_t uid); 224 void onAudioPortListUpdate(); 225 void doOnAudioPortListUpdate(); 226 void onAudioPatchListUpdate(); 227 void doOnAudioPatchListUpdate(); 228 229 void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 230 void doOnDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 231 void onRecordingConfigurationUpdate(int event, audio_session_t session, 232 audio_source_t source, const audio_config_base_t *clientConfig, 233 const audio_config_base_t *deviceConfig, audio_patch_handle_t patchHandle); 234 void doOnRecordingConfigurationUpdate(int event, audio_session_t session, 235 audio_source_t source, const audio_config_base_t *clientConfig, 236 const audio_config_base_t *deviceConfig, audio_patch_handle_t patchHandle); 237 238private: 239 AudioPolicyService() ANDROID_API; 240 virtual ~AudioPolicyService(); 241 242 status_t dumpInternals(int fd); 243 244 // Thread used for tone playback and to send audio config commands to audio flinger 245 // For tone playback, using a separate thread is necessary to avoid deadlock with mLock because 246 // startTone() and stopTone() are normally called with mLock locked and requesting a tone start 247 // or stop will cause calls to AudioPolicyService and an attempt to lock mLock. 248 // For audio config commands, it is necessary because audio flinger requires that the calling 249 // process (user) has permission to modify audio settings. 250 class AudioCommandThread : public Thread { 251 class AudioCommand; 252 public: 253 254 // commands for tone AudioCommand 255 enum { 256 START_TONE, 257 STOP_TONE, 258 SET_VOLUME, 259 SET_PARAMETERS, 260 SET_VOICE_VOLUME, 261 STOP_OUTPUT, 262 RELEASE_OUTPUT, 263 CREATE_AUDIO_PATCH, 264 RELEASE_AUDIO_PATCH, 265 UPDATE_AUDIOPORT_LIST, 266 UPDATE_AUDIOPATCH_LIST, 267 SET_AUDIOPORT_CONFIG, 268 DYN_POLICY_MIX_STATE_UPDATE, 269 RECORDING_CONFIGURATION_UPDATE 270 }; 271 272 AudioCommandThread (String8 name, const wp<AudioPolicyService>& service); 273 virtual ~AudioCommandThread(); 274 275 status_t dump(int fd); 276 277 // Thread virtuals 278 virtual void onFirstRef(); 279 virtual bool threadLoop(); 280 281 void exit(); 282 void startToneCommand(ToneGenerator::tone_type type, 283 audio_stream_type_t stream); 284 void stopToneCommand(); 285 status_t volumeCommand(audio_stream_type_t stream, float volume, 286 audio_io_handle_t output, int delayMs = 0); 287 status_t parametersCommand(audio_io_handle_t ioHandle, 288 const char *keyValuePairs, int delayMs = 0); 289 status_t voiceVolumeCommand(float volume, int delayMs = 0); 290 void stopOutputCommand(audio_io_handle_t output, 291 audio_stream_type_t stream, 292 audio_session_t session); 293 void releaseOutputCommand(audio_io_handle_t output, 294 audio_stream_type_t stream, 295 audio_session_t session); 296 status_t sendCommand(sp<AudioCommand>& command, int delayMs = 0); 297 void insertCommand_l(sp<AudioCommand>& command, int delayMs = 0); 298 status_t createAudioPatchCommand(const struct audio_patch *patch, 299 audio_patch_handle_t *handle, 300 int delayMs); 301 status_t releaseAudioPatchCommand(audio_patch_handle_t handle, 302 int delayMs); 303 void updateAudioPortListCommand(); 304 void updateAudioPatchListCommand(); 305 status_t setAudioPortConfigCommand(const struct audio_port_config *config, 306 int delayMs); 307 void dynamicPolicyMixStateUpdateCommand(String8 regId, int32_t state); 308 void recordingConfigurationUpdateCommand( 309 int event, audio_session_t session, 310 audio_source_t source, 311 const audio_config_base_t *clientConfig, 312 const audio_config_base_t *deviceConfig, 313 audio_patch_handle_t patchHandle); 314 void insertCommand_l(AudioCommand *command, int delayMs = 0); 315 316 private: 317 class AudioCommandData; 318 319 // descriptor for requested tone playback event 320 class AudioCommand: public RefBase { 321 322 public: 323 AudioCommand() 324 : mCommand(-1), mStatus(NO_ERROR), mWaitStatus(false) {} 325 326 void dump(char* buffer, size_t size); 327 328 int mCommand; // START_TONE, STOP_TONE ... 329 nsecs_t mTime; // time stamp 330 Mutex mLock; // mutex associated to mCond 331 Condition mCond; // condition for status return 332 status_t mStatus; // command status 333 bool mWaitStatus; // true if caller is waiting for status 334 sp<AudioCommandData> mParam; // command specific parameter data 335 }; 336 337 class AudioCommandData: public RefBase { 338 public: 339 virtual ~AudioCommandData() {} 340 protected: 341 AudioCommandData() {} 342 }; 343 344 class ToneData : public AudioCommandData { 345 public: 346 ToneGenerator::tone_type mType; // tone type (START_TONE only) 347 audio_stream_type_t mStream; // stream type (START_TONE only) 348 }; 349 350 class VolumeData : public AudioCommandData { 351 public: 352 audio_stream_type_t mStream; 353 float mVolume; 354 audio_io_handle_t mIO; 355 }; 356 357 class ParametersData : public AudioCommandData { 358 public: 359 audio_io_handle_t mIO; 360 String8 mKeyValuePairs; 361 }; 362 363 class VoiceVolumeData : public AudioCommandData { 364 public: 365 float mVolume; 366 }; 367 368 class StopOutputData : public AudioCommandData { 369 public: 370 audio_io_handle_t mIO; 371 audio_stream_type_t mStream; 372 audio_session_t mSession; 373 }; 374 375 class ReleaseOutputData : public AudioCommandData { 376 public: 377 audio_io_handle_t mIO; 378 audio_stream_type_t mStream; 379 audio_session_t mSession; 380 }; 381 382 class CreateAudioPatchData : public AudioCommandData { 383 public: 384 struct audio_patch mPatch; 385 audio_patch_handle_t mHandle; 386 }; 387 388 class ReleaseAudioPatchData : public AudioCommandData { 389 public: 390 audio_patch_handle_t mHandle; 391 }; 392 393 class SetAudioPortConfigData : public AudioCommandData { 394 public: 395 struct audio_port_config mConfig; 396 }; 397 398 class DynPolicyMixStateUpdateData : public AudioCommandData { 399 public: 400 String8 mRegId; 401 int32_t mState; 402 }; 403 404 class RecordingConfigurationUpdateData : public AudioCommandData { 405 public: 406 int mEvent; 407 audio_session_t mSession; 408 audio_source_t mSource; 409 struct audio_config_base mClientConfig; 410 struct audio_config_base mDeviceConfig; 411 audio_patch_handle_t mPatchHandle; 412 }; 413 414 Mutex mLock; 415 Condition mWaitWorkCV; 416 Vector < sp<AudioCommand> > mAudioCommands; // list of pending commands 417 ToneGenerator *mpToneGenerator; // the tone generator 418 sp<AudioCommand> mLastCommand; // last processed command (used by dump) 419 String8 mName; // string used by wake lock fo delayed commands 420 wp<AudioPolicyService> mService; 421 }; 422 423 class AudioPolicyClient : public AudioPolicyClientInterface 424 { 425 public: 426 AudioPolicyClient(AudioPolicyService *service) : mAudioPolicyService(service) {} 427 virtual ~AudioPolicyClient() {} 428 429 // 430 // Audio HW module functions 431 // 432 433 // loads a HW module. 434 virtual audio_module_handle_t loadHwModule(const char *name); 435 436 // 437 // Audio output Control functions 438 // 439 440 // opens an audio output with the requested parameters. The parameter values can indicate to use the default values 441 // in case the audio policy manager has no specific requirements for the output being opened. 442 // When the function returns, the parameter values reflect the actual values used by the audio hardware output stream. 443 // The audio policy manager can check if the proposed parameters are suitable or not and act accordingly. 444 virtual status_t openOutput(audio_module_handle_t module, 445 audio_io_handle_t *output, 446 audio_config_t *config, 447 audio_devices_t *devices, 448 const String8& address, 449 uint32_t *latencyMs, 450 audio_output_flags_t flags); 451 // creates a special output that is duplicated to the two outputs passed as arguments. The duplication is performed by 452 // a special mixer thread in the AudioFlinger. 453 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, audio_io_handle_t output2); 454 // closes the output stream 455 virtual status_t closeOutput(audio_io_handle_t output); 456 // suspends the output. When an output is suspended, the corresponding audio hardware output stream is placed in 457 // standby and the AudioTracks attached to the mixer thread are still processed but the output mix is discarded. 458 virtual status_t suspendOutput(audio_io_handle_t output); 459 // restores a suspended output. 460 virtual status_t restoreOutput(audio_io_handle_t output); 461 462 // 463 // Audio input Control functions 464 // 465 466 // opens an audio input 467 virtual audio_io_handle_t openInput(audio_module_handle_t module, 468 audio_io_handle_t *input, 469 audio_config_t *config, 470 audio_devices_t *devices, 471 const String8& address, 472 audio_source_t source, 473 audio_input_flags_t flags); 474 // closes an audio input 475 virtual status_t closeInput(audio_io_handle_t input); 476 // 477 // misc control functions 478 // 479 480 // set a stream volume for a particular output. For the same user setting, a given stream type can have different volumes 481 // for each output (destination device) it is attached to. 482 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume, audio_io_handle_t output, int delayMs = 0); 483 484 // invalidate a stream type, causing a reroute to an unspecified new output 485 virtual status_t invalidateStream(audio_stream_type_t stream); 486 487 // function enabling to send proprietary informations directly from audio policy manager to audio hardware interface. 488 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs, int delayMs = 0); 489 // function enabling to receive proprietary informations directly from audio hardware interface to audio policy manager. 490 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys); 491 492 // request the playback of a tone on the specified stream: used for instance to replace notification sounds when playing 493 // over a telephony device during a phone call. 494 virtual status_t startTone(audio_policy_tone_t tone, audio_stream_type_t stream); 495 virtual status_t stopTone(); 496 497 // set down link audio volume. 498 virtual status_t setVoiceVolume(float volume, int delayMs = 0); 499 500 // move effect to the specified output 501 virtual status_t moveEffects(int session, 502 audio_io_handle_t srcOutput, 503 audio_io_handle_t dstOutput); 504 505 /* Create a patch between several source and sink ports */ 506 virtual status_t createAudioPatch(const struct audio_patch *patch, 507 audio_patch_handle_t *handle, 508 int delayMs); 509 510 /* Release a patch */ 511 virtual status_t releaseAudioPatch(audio_patch_handle_t handle, 512 int delayMs); 513 514 /* Set audio port configuration */ 515 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs); 516 517 virtual void onAudioPortListUpdate(); 518 virtual void onAudioPatchListUpdate(); 519 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 520 virtual void onRecordingConfigurationUpdate(int event, 521 audio_session_t session, audio_source_t source, 522 const audio_config_base_t *clientConfig, 523 const audio_config_base_t *deviceConfig, audio_patch_handle_t patchHandle); 524 525 virtual audio_unique_id_t newAudioUniqueId(); 526 527 private: 528 AudioPolicyService *mAudioPolicyService; 529 }; 530 531 // --- Notification Client --- 532 class NotificationClient : public IBinder::DeathRecipient { 533 public: 534 NotificationClient(const sp<AudioPolicyService>& service, 535 const sp<IAudioPolicyServiceClient>& client, 536 uid_t uid); 537 virtual ~NotificationClient(); 538 539 void onAudioPortListUpdate(); 540 void onAudioPatchListUpdate(); 541 void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 542 void onRecordingConfigurationUpdate( 543 int event, audio_session_t session, 544 audio_source_t source, 545 const audio_config_base_t *clientConfig, 546 const audio_config_base_t *deviceConfig, 547 audio_patch_handle_t patchHandle); 548 void setAudioPortCallbacksEnabled(bool enabled); 549 550 // IBinder::DeathRecipient 551 virtual void binderDied(const wp<IBinder>& who); 552 553 private: 554 NotificationClient(const NotificationClient&); 555 NotificationClient& operator = (const NotificationClient&); 556 557 const wp<AudioPolicyService> mService; 558 const uid_t mUid; 559 const sp<IAudioPolicyServiceClient> mAudioPolicyServiceClient; 560 bool mAudioPortCallbacksEnabled; 561 }; 562 563 // Internal dump utilities. 564 status_t dumpPermissionDenial(int fd); 565 566 567 mutable Mutex mLock; // prevents concurrent access to AudioPolicy manager functions changing 568 // device connection state or routing 569 mutable Mutex mEffectsLock; // serialize access to Effect state within APM. 570 // Note: lock acquisition order is always mLock > mEffectsLock: 571 // mLock protects AudioPolicyManager methods that can call into audio flinger 572 // and possibly back in to audio policy service and acquire mEffectsLock. 573 sp<AudioCommandThread> mAudioCommandThread; // audio commands thread 574 sp<AudioCommandThread> mTonePlaybackThread; // tone playback thread 575 sp<AudioCommandThread> mOutputCommandThread; // process stop and release output 576 struct audio_policy_device *mpAudioPolicyDev; 577 struct audio_policy *mpAudioPolicy; 578 AudioPolicyInterface *mAudioPolicyManager; 579 AudioPolicyClient *mAudioPolicyClient; 580 581 DefaultKeyedVector< uid_t, sp<NotificationClient> > mNotificationClients; 582 Mutex mNotificationClientsLock; // protects mNotificationClients 583 // Manage all effects configured in audio_effects.conf 584 sp<AudioPolicyEffects> mAudioPolicyEffects; 585 audio_mode_t mPhoneState; 586}; 587 588}; // namespace android 589 590#endif // ANDROID_AUDIOPOLICYSERVICE_H 591