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