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