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