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