AudioPolicyService.h revision 2f4fe9f7df8f22c6bc8745407d19df73128810ec
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 status_t doStopOutput(audio_io_handle_t output, 206 audio_stream_type_t stream, 207 audio_session_t session); 208 void doReleaseOutput(audio_io_handle_t output, 209 audio_stream_type_t stream, 210 audio_session_t session); 211 212 status_t clientCreateAudioPatch(const struct audio_patch *patch, 213 audio_patch_handle_t *handle, 214 int delayMs); 215 status_t clientReleaseAudioPatch(audio_patch_handle_t handle, 216 int delayMs); 217 virtual status_t clientSetAudioPortConfig(const struct audio_port_config *config, 218 int delayMs); 219 220 void removeNotificationClient(uid_t uid); 221 void onAudioPortListUpdate(); 222 void doOnAudioPortListUpdate(); 223 void onAudioPatchListUpdate(); 224 void doOnAudioPatchListUpdate(); 225 226 void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 227 void doOnDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 228 void onRecordingConfigurationUpdate(int event, audio_session_t session, 229 audio_source_t source); 230 void doOnRecordingConfigurationUpdate(int event, audio_session_t session, 231 audio_source_t source); 232 233private: 234 AudioPolicyService() ANDROID_API; 235 virtual ~AudioPolicyService(); 236 237 status_t dumpInternals(int fd); 238 239 // Thread used for tone playback and to send audio config commands to audio flinger 240 // For tone playback, using a separate thread is necessary to avoid deadlock with mLock because 241 // startTone() and stopTone() are normally called with mLock locked and requesting a tone start 242 // or stop will cause calls to AudioPolicyService and an attempt to lock mLock. 243 // For audio config commands, it is necessary because audio flinger requires that the calling 244 // process (user) has permission to modify audio settings. 245 class AudioCommandThread : public Thread { 246 class AudioCommand; 247 public: 248 249 // commands for tone AudioCommand 250 enum { 251 START_TONE, 252 STOP_TONE, 253 SET_VOLUME, 254 SET_PARAMETERS, 255 SET_VOICE_VOLUME, 256 STOP_OUTPUT, 257 RELEASE_OUTPUT, 258 CREATE_AUDIO_PATCH, 259 RELEASE_AUDIO_PATCH, 260 UPDATE_AUDIOPORT_LIST, 261 UPDATE_AUDIOPATCH_LIST, 262 SET_AUDIOPORT_CONFIG, 263 DYN_POLICY_MIX_STATE_UPDATE, 264 RECORDING_CONFIGURATION_UPDATE 265 }; 266 267 AudioCommandThread (String8 name, const wp<AudioPolicyService>& service); 268 virtual ~AudioCommandThread(); 269 270 status_t dump(int fd); 271 272 // Thread virtuals 273 virtual void onFirstRef(); 274 virtual bool threadLoop(); 275 276 void exit(); 277 void startToneCommand(ToneGenerator::tone_type type, 278 audio_stream_type_t stream); 279 void stopToneCommand(); 280 status_t volumeCommand(audio_stream_type_t stream, float volume, 281 audio_io_handle_t output, int delayMs = 0); 282 status_t parametersCommand(audio_io_handle_t ioHandle, 283 const char *keyValuePairs, int delayMs = 0); 284 status_t voiceVolumeCommand(float volume, int delayMs = 0); 285 void stopOutputCommand(audio_io_handle_t output, 286 audio_stream_type_t stream, 287 audio_session_t session); 288 void releaseOutputCommand(audio_io_handle_t output, 289 audio_stream_type_t stream, 290 audio_session_t session); 291 status_t sendCommand(sp<AudioCommand>& command, int delayMs = 0); 292 void insertCommand_l(sp<AudioCommand>& command, int delayMs = 0); 293 status_t createAudioPatchCommand(const struct audio_patch *patch, 294 audio_patch_handle_t *handle, 295 int delayMs); 296 status_t releaseAudioPatchCommand(audio_patch_handle_t handle, 297 int delayMs); 298 void updateAudioPortListCommand(); 299 void updateAudioPatchListCommand(); 300 status_t setAudioPortConfigCommand(const struct audio_port_config *config, 301 int delayMs); 302 void dynamicPolicyMixStateUpdateCommand(String8 regId, int32_t state); 303 void recordingConfigurationUpdateCommand( 304 int event, audio_session_t session, 305 audio_source_t source); 306 void insertCommand_l(AudioCommand *command, int delayMs = 0); 307 308 private: 309 class AudioCommandData; 310 311 // descriptor for requested tone playback event 312 class AudioCommand: public RefBase { 313 314 public: 315 AudioCommand() 316 : mCommand(-1), mStatus(NO_ERROR), mWaitStatus(false) {} 317 318 void dump(char* buffer, size_t size); 319 320 int mCommand; // START_TONE, STOP_TONE ... 321 nsecs_t mTime; // time stamp 322 Mutex mLock; // mutex associated to mCond 323 Condition mCond; // condition for status return 324 status_t mStatus; // command status 325 bool mWaitStatus; // true if caller is waiting for status 326 sp<AudioCommandData> mParam; // command specific parameter data 327 }; 328 329 class AudioCommandData: public RefBase { 330 public: 331 virtual ~AudioCommandData() {} 332 protected: 333 AudioCommandData() {} 334 }; 335 336 class ToneData : public AudioCommandData { 337 public: 338 ToneGenerator::tone_type mType; // tone type (START_TONE only) 339 audio_stream_type_t mStream; // stream type (START_TONE only) 340 }; 341 342 class VolumeData : public AudioCommandData { 343 public: 344 audio_stream_type_t mStream; 345 float mVolume; 346 audio_io_handle_t mIO; 347 }; 348 349 class ParametersData : public AudioCommandData { 350 public: 351 audio_io_handle_t mIO; 352 String8 mKeyValuePairs; 353 }; 354 355 class VoiceVolumeData : public AudioCommandData { 356 public: 357 float mVolume; 358 }; 359 360 class StopOutputData : public AudioCommandData { 361 public: 362 audio_io_handle_t mIO; 363 audio_stream_type_t mStream; 364 audio_session_t mSession; 365 }; 366 367 class ReleaseOutputData : public AudioCommandData { 368 public: 369 audio_io_handle_t mIO; 370 audio_stream_type_t mStream; 371 audio_session_t mSession; 372 }; 373 374 class CreateAudioPatchData : public AudioCommandData { 375 public: 376 struct audio_patch mPatch; 377 audio_patch_handle_t mHandle; 378 }; 379 380 class ReleaseAudioPatchData : public AudioCommandData { 381 public: 382 audio_patch_handle_t mHandle; 383 }; 384 385 class SetAudioPortConfigData : public AudioCommandData { 386 public: 387 struct audio_port_config mConfig; 388 }; 389 390 class DynPolicyMixStateUpdateData : public AudioCommandData { 391 public: 392 String8 mRegId; 393 int32_t mState; 394 }; 395 396 class RecordingConfigurationUpdateData : public AudioCommandData { 397 public: 398 int mEvent; 399 audio_session_t mSession; 400 audio_source_t mSource; 401 }; 402 403 Mutex mLock; 404 Condition mWaitWorkCV; 405 Vector < sp<AudioCommand> > mAudioCommands; // list of pending commands 406 ToneGenerator *mpToneGenerator; // the tone generator 407 sp<AudioCommand> mLastCommand; // last processed command (used by dump) 408 String8 mName; // string used by wake lock fo delayed commands 409 wp<AudioPolicyService> mService; 410 }; 411 412 class AudioPolicyClient : public AudioPolicyClientInterface 413 { 414 public: 415 AudioPolicyClient(AudioPolicyService *service) : mAudioPolicyService(service) {} 416 virtual ~AudioPolicyClient() {} 417 418 // 419 // Audio HW module functions 420 // 421 422 // loads a HW module. 423 virtual audio_module_handle_t loadHwModule(const char *name); 424 425 // 426 // Audio output Control functions 427 // 428 429 // opens an audio output with the requested parameters. The parameter values can indicate to use the default values 430 // in case the audio policy manager has no specific requirements for the output being opened. 431 // When the function returns, the parameter values reflect the actual values used by the audio hardware output stream. 432 // The audio policy manager can check if the proposed parameters are suitable or not and act accordingly. 433 virtual status_t openOutput(audio_module_handle_t module, 434 audio_io_handle_t *output, 435 audio_config_t *config, 436 audio_devices_t *devices, 437 const String8& address, 438 uint32_t *latencyMs, 439 audio_output_flags_t flags); 440 // creates a special output that is duplicated to the two outputs passed as arguments. The duplication is performed by 441 // a special mixer thread in the AudioFlinger. 442 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, audio_io_handle_t output2); 443 // closes the output stream 444 virtual status_t closeOutput(audio_io_handle_t output); 445 // suspends the output. When an output is suspended, the corresponding audio hardware output stream is placed in 446 // standby and the AudioTracks attached to the mixer thread are still processed but the output mix is discarded. 447 virtual status_t suspendOutput(audio_io_handle_t output); 448 // restores a suspended output. 449 virtual status_t restoreOutput(audio_io_handle_t output); 450 451 // 452 // Audio input Control functions 453 // 454 455 // opens an audio input 456 virtual audio_io_handle_t openInput(audio_module_handle_t module, 457 audio_io_handle_t *input, 458 audio_config_t *config, 459 audio_devices_t *devices, 460 const String8& address, 461 audio_source_t source, 462 audio_input_flags_t flags); 463 // closes an audio input 464 virtual status_t closeInput(audio_io_handle_t input); 465 // 466 // misc control functions 467 // 468 469 // set a stream volume for a particular output. For the same user setting, a given stream type can have different volumes 470 // for each output (destination device) it is attached to. 471 virtual status_t setStreamVolume(audio_stream_type_t stream, float volume, audio_io_handle_t output, int delayMs = 0); 472 473 // invalidate a stream type, causing a reroute to an unspecified new output 474 virtual status_t invalidateStream(audio_stream_type_t stream); 475 476 // function enabling to send proprietary informations directly from audio policy manager to audio hardware interface. 477 virtual void setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs, int delayMs = 0); 478 // function enabling to receive proprietary informations directly from audio hardware interface to audio policy manager. 479 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys); 480 481 // request the playback of a tone on the specified stream: used for instance to replace notification sounds when playing 482 // over a telephony device during a phone call. 483 virtual status_t startTone(audio_policy_tone_t tone, audio_stream_type_t stream); 484 virtual status_t stopTone(); 485 486 // set down link audio volume. 487 virtual status_t setVoiceVolume(float volume, int delayMs = 0); 488 489 // move effect to the specified output 490 virtual status_t moveEffects(int session, 491 audio_io_handle_t srcOutput, 492 audio_io_handle_t dstOutput); 493 494 /* Create a patch between several source and sink ports */ 495 virtual status_t createAudioPatch(const struct audio_patch *patch, 496 audio_patch_handle_t *handle, 497 int delayMs); 498 499 /* Release a patch */ 500 virtual status_t releaseAudioPatch(audio_patch_handle_t handle, 501 int delayMs); 502 503 /* Set audio port configuration */ 504 virtual status_t setAudioPortConfig(const struct audio_port_config *config, int delayMs); 505 506 virtual void onAudioPortListUpdate(); 507 virtual void onAudioPatchListUpdate(); 508 virtual void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 509 virtual void onRecordingConfigurationUpdate(int event, 510 audio_session_t session, audio_source_t source); 511 512 virtual audio_unique_id_t newAudioUniqueId(); 513 514 private: 515 AudioPolicyService *mAudioPolicyService; 516 }; 517 518 // --- Notification Client --- 519 class NotificationClient : public IBinder::DeathRecipient { 520 public: 521 NotificationClient(const sp<AudioPolicyService>& service, 522 const sp<IAudioPolicyServiceClient>& client, 523 uid_t uid); 524 virtual ~NotificationClient(); 525 526 void onAudioPortListUpdate(); 527 void onAudioPatchListUpdate(); 528 void onDynamicPolicyMixStateUpdate(String8 regId, int32_t state); 529 void onRecordingConfigurationUpdate( 530 int event, audio_session_t session, 531 audio_source_t source); 532 void setAudioPortCallbacksEnabled(bool enabled); 533 534 // IBinder::DeathRecipient 535 virtual void binderDied(const wp<IBinder>& who); 536 537 private: 538 NotificationClient(const NotificationClient&); 539 NotificationClient& operator = (const NotificationClient&); 540 541 const wp<AudioPolicyService> mService; 542 const uid_t mUid; 543 const sp<IAudioPolicyServiceClient> mAudioPolicyServiceClient; 544 bool mAudioPortCallbacksEnabled; 545 }; 546 547 // Internal dump utilities. 548 status_t dumpPermissionDenial(int fd); 549 550 551 mutable Mutex mLock; // prevents concurrent access to AudioPolicy manager functions changing 552 // device connection state or routing 553 sp<AudioCommandThread> mAudioCommandThread; // audio commands thread 554 sp<AudioCommandThread> mTonePlaybackThread; // tone playback thread 555 sp<AudioCommandThread> mOutputCommandThread; // process stop and release output 556 struct audio_policy_device *mpAudioPolicyDev; 557 struct audio_policy *mpAudioPolicy; 558 AudioPolicyInterface *mAudioPolicyManager; 559 AudioPolicyClient *mAudioPolicyClient; 560 561 DefaultKeyedVector< uid_t, sp<NotificationClient> > mNotificationClients; 562 Mutex mNotificationClientsLock; // protects mNotificationClients 563 // Manage all effects configured in audio_effects.conf 564 sp<AudioPolicyEffects> mAudioPolicyEffects; 565 audio_mode_t mPhoneState; 566}; 567 568}; // namespace android 569 570#endif // ANDROID_AUDIOPOLICYSERVICE_H 571