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