AudioPolicyManagerBase.h revision 9029a4fe8abafd383e6fbb1409d1e2f749b51391
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 18#include <stdint.h> 19#include <sys/types.h> 20#include <cutils/config_utils.h> 21#include <cutils/misc.h> 22#include <utils/Timers.h> 23#include <utils/Errors.h> 24#include <utils/KeyedVector.h> 25#include <utils/SortedVector.h> 26#include <hardware_legacy/AudioPolicyInterface.h> 27 28 29namespace android_audio_legacy { 30 using android::KeyedVector; 31 using android::DefaultKeyedVector; 32 using android::SortedVector; 33 34// ---------------------------------------------------------------------------- 35 36#define MAX_DEVICE_ADDRESS_LEN 20 37// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB 38#define SONIFICATION_HEADSET_VOLUME_FACTOR 0.5 39// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB 40#define SONIFICATION_HEADSET_VOLUME_MIN 0.016 41// Time in milliseconds during which we consider that music is still active after a music 42// track was stopped - see computeVolume() 43#define SONIFICATION_HEADSET_MUSIC_DELAY 5000 44// Time in milliseconds after media stopped playing during which we consider that the 45// sonification should be as unobtrusive as during the time media was playing. 46#define SONIFICATION_RESPECTFUL_AFTER_MUSIC_DELAY 5000 47// Time in milliseconds during witch some streams are muted while the audio path 48// is switched 49#define MUTE_TIME_MS 2000 50 51#define NUM_TEST_OUTPUTS 5 52 53#define NUM_VOL_CURVE_KNEES 2 54 55// ---------------------------------------------------------------------------- 56// AudioPolicyManagerBase implements audio policy manager behavior common to all platforms. 57// Each platform must implement an AudioPolicyManager class derived from AudioPolicyManagerBase 58// and override methods for which the platform specific behavior differs from the implementation 59// in AudioPolicyManagerBase. Even if no specific behavior is required, the AudioPolicyManager 60// class must be implemented as well as the class factory function createAudioPolicyManager() 61// and provided in a shared library libaudiopolicy.so. 62// ---------------------------------------------------------------------------- 63 64class AudioPolicyManagerBase: public AudioPolicyInterface 65#ifdef AUDIO_POLICY_TEST 66 , public Thread 67#endif //AUDIO_POLICY_TEST 68{ 69 70public: 71 AudioPolicyManagerBase(AudioPolicyClientInterface *clientInterface); 72 virtual ~AudioPolicyManagerBase(); 73 74 // AudioPolicyInterface 75 virtual status_t setDeviceConnectionState(AudioSystem::audio_devices device, 76 AudioSystem::device_connection_state state, 77 const char *device_address); 78 virtual AudioSystem::device_connection_state getDeviceConnectionState(AudioSystem::audio_devices device, 79 const char *device_address); 80 virtual void setPhoneState(int state); 81 virtual void setForceUse(AudioSystem::force_use usage, AudioSystem::forced_config config); 82 virtual AudioSystem::forced_config getForceUse(AudioSystem::force_use usage); 83 virtual void setSystemProperty(const char* property, const char* value); 84 virtual status_t initCheck(); 85 virtual audio_io_handle_t getOutput(AudioSystem::stream_type stream, 86 uint32_t samplingRate = 0, 87 uint32_t format = AudioSystem::FORMAT_DEFAULT, 88 uint32_t channels = 0, 89 AudioSystem::output_flags flags = 90 AudioSystem::OUTPUT_FLAG_INDIRECT); 91 virtual status_t startOutput(audio_io_handle_t output, 92 AudioSystem::stream_type stream, 93 int session = 0); 94 virtual status_t stopOutput(audio_io_handle_t output, 95 AudioSystem::stream_type stream, 96 int session = 0); 97 virtual void releaseOutput(audio_io_handle_t output); 98 virtual audio_io_handle_t getInput(int inputSource, 99 uint32_t samplingRate, 100 uint32_t format, 101 uint32_t channels, 102 AudioSystem::audio_in_acoustics acoustics); 103 104 // indicates to the audio policy manager that the input starts being used. 105 virtual status_t startInput(audio_io_handle_t input); 106 107 // indicates to the audio policy manager that the input stops being used. 108 virtual status_t stopInput(audio_io_handle_t input); 109 virtual void releaseInput(audio_io_handle_t input); 110 virtual void initStreamVolume(AudioSystem::stream_type stream, 111 int indexMin, 112 int indexMax); 113 virtual status_t setStreamVolumeIndex(AudioSystem::stream_type stream, 114 int index, 115 audio_devices_t device); 116 virtual status_t getStreamVolumeIndex(AudioSystem::stream_type stream, 117 int *index, 118 audio_devices_t device); 119 120 // return the strategy corresponding to a given stream type 121 virtual uint32_t getStrategyForStream(AudioSystem::stream_type stream); 122 123 // return the enabled output devices for the given stream type 124 virtual audio_devices_t getDevicesForStream(AudioSystem::stream_type stream); 125 126 virtual audio_io_handle_t getOutputForEffect(effect_descriptor_t *desc); 127 virtual status_t registerEffect(effect_descriptor_t *desc, 128 audio_io_handle_t io, 129 uint32_t strategy, 130 int session, 131 int id); 132 virtual status_t unregisterEffect(int id); 133 virtual status_t setEffectEnabled(int id, bool enabled); 134 135 virtual bool isStreamActive(int stream, uint32_t inPastMs = 0) const; 136 137 virtual status_t dump(int fd); 138 139protected: 140 141 enum routing_strategy { 142 STRATEGY_MEDIA, 143 STRATEGY_PHONE, 144 STRATEGY_SONIFICATION, 145 STRATEGY_SONIFICATION_RESPECTFUL, 146 STRATEGY_DTMF, 147 STRATEGY_ENFORCED_AUDIBLE, 148 NUM_STRATEGIES 149 }; 150 151 // 4 points to define the volume attenuation curve, each characterized by the volume 152 // index (from 0 to 100) at which they apply, and the attenuation in dB at that index. 153 // we use 100 steps to avoid rounding errors when computing the volume in volIndexToAmpl() 154 155 enum { VOLMIN = 0, VOLKNEE1 = 1, VOLKNEE2 = 2, VOLMAX = 3, VOLCNT = 4}; 156 157 class VolumeCurvePoint 158 { 159 public: 160 int mIndex; 161 float mDBAttenuation; 162 }; 163 164 // device categories used for volume curve management. 165 enum device_category { 166 DEVICE_CATEGORY_HEADSET, 167 DEVICE_CATEGORY_SPEAKER, 168 DEVICE_CATEGORY_EARPIECE, 169 DEVICE_CATEGORY_CNT 170 }; 171 172 class IOProfile; 173 174 class HwModule { 175 public: 176 HwModule(const char *name); 177 ~HwModule(); 178 179 void dump(int fd); 180 181 const char *const mName; // base name of the audio HW module (primary, a2dp ...) 182 audio_module_handle_t mHandle; 183 Vector <IOProfile *> mOutputProfiles; // output profiles exposed by this module 184 Vector <IOProfile *> mInputProfiles; // input profiles exposed by this module 185 }; 186 187 // the IOProfile class describes the capabilities of an output or input stream. 188 // It is currently assumed that all combination of listed parameters are supported. 189 // It is used by the policy manager to determine if an output or input is suitable for 190 // a given use case, open/close it accordingly and connect/disconnect audio tracks 191 // to/from it. 192 class IOProfile 193 { 194 public: 195 IOProfile(HwModule *module); 196 ~IOProfile(); 197 198 bool isCompatibleProfile(audio_devices_t device, 199 uint32_t samplingRate, 200 uint32_t format, 201 uint32_t channelMask, 202 audio_output_flags_t flags) const; 203 204 void dump(int fd); 205 206 Vector <uint32_t> mSamplingRates; // supported sampling rates 207 Vector <audio_channel_mask_t> mChannelMasks; // supported channel masks 208 Vector <audio_format_t> mFormats; // supported audio formats 209 audio_devices_t mSupportedDevices; // supported devices (devices this output can be 210 // routed to) 211 audio_output_flags_t mFlags; // attribute flags (e.g primary output, 212 // direct output...). For outputs only. 213 HwModule *mModule; // audio HW module exposing this I/O stream 214 }; 215 216 // default volume curve 217 static const VolumeCurvePoint sDefaultVolumeCurve[AudioPolicyManagerBase::VOLCNT]; 218 // default volume curve for media strategy 219 static const VolumeCurvePoint sDefaultMediaVolumeCurve[AudioPolicyManagerBase::VOLCNT]; 220 // volume curve for media strategy on speakers 221 static const VolumeCurvePoint sSpeakerMediaVolumeCurve[AudioPolicyManagerBase::VOLCNT]; 222 // volume curve for sonification strategy on speakers 223 static const VolumeCurvePoint sSpeakerSonificationVolumeCurve[AudioPolicyManagerBase::VOLCNT]; 224 // default volume curves per strategy and device category. See initializeVolumeCurves() 225 static const VolumeCurvePoint *sVolumeProfiles[NUM_STRATEGIES][DEVICE_CATEGORY_CNT]; 226 227 // descriptor for audio outputs. Used to maintain current configuration of each opened audio output 228 // and keep track of the usage of this output by each audio stream type. 229 class AudioOutputDescriptor 230 { 231 public: 232 AudioOutputDescriptor(const IOProfile *profile); 233 234 status_t dump(int fd); 235 236 audio_devices_t device(); 237 void changeRefCount(AudioSystem::stream_type, int delta); 238 uint32_t refCount(); 239 uint32_t strategyRefCount(routing_strategy strategy); 240 bool isUsedByStrategy(routing_strategy strategy) { return (strategyRefCount(strategy) != 0);} 241 bool isDuplicated() const { return (mOutput1 != NULL && mOutput2 != NULL); } 242 audio_devices_t supportedDevices(); 243 uint32_t latency(); 244 bool sharesHwModuleWith(const AudioOutputDescriptor *outputDesc); 245 246 audio_io_handle_t mId; // output handle 247 uint32_t mSamplingRate; // 248 audio_format_t mFormat; // 249 audio_channel_mask_t mChannelMask; // output configuration 250 uint32_t mLatency; // 251 audio_output_flags_t mFlags; // 252 audio_devices_t mDevice; // current device this output is routed to 253 uint32_t mRefCount[AudioSystem::NUM_STREAM_TYPES]; // number of streams of each type using this output 254 nsecs_t mStopTime[AudioSystem::NUM_STREAM_TYPES]; 255 AudioOutputDescriptor *mOutput1; // used by duplicated outputs: first output 256 AudioOutputDescriptor *mOutput2; // used by duplicated outputs: second output 257 float mCurVolume[AudioSystem::NUM_STREAM_TYPES]; // current stream volume 258 int mMuteCount[AudioSystem::NUM_STREAM_TYPES]; // mute request counter 259 const IOProfile *mProfile; // I/O profile this output derives from 260 bool mStrategyMutedByDevice[NUM_STRATEGIES]; // strategies muted because of incompatible 261 // device selection. See checkDeviceMuteStrategies() 262 }; 263 264 // descriptor for audio inputs. Used to maintain current configuration of each opened audio input 265 // and keep track of the usage of this input. 266 class AudioInputDescriptor 267 { 268 public: 269 AudioInputDescriptor(const IOProfile *profile); 270 271 status_t dump(int fd); 272 273 uint32_t mSamplingRate; // 274 audio_format_t mFormat; // input configuration 275 audio_channel_mask_t mChannelMask; // 276 audio_devices_t mDevice; // current device this input is routed to 277 uint32_t mRefCount; // number of AudioRecord clients using this output 278 int mInputSource; // input source selected by application (mediarecorder.h) 279 const IOProfile *mProfile; // I/O profile this output derives from 280 }; 281 282 // stream descriptor used for volume control 283 class StreamDescriptor 284 { 285 public: 286 StreamDescriptor(); 287 288 int getVolumeIndex(audio_devices_t device); 289 void dump(int fd); 290 291 int mIndexMin; // min volume index 292 int mIndexMax; // max volume index 293 KeyedVector<audio_devices_t, int> mIndexCur; // current volume index per device 294 bool mCanBeMuted; // true is the stream can be muted 295 296 const VolumeCurvePoint *mVolumeCurve[DEVICE_CATEGORY_CNT]; 297 }; 298 299 // stream descriptor used for volume control 300 class EffectDescriptor 301 { 302 public: 303 304 status_t dump(int fd); 305 306 int mIo; // io the effect is attached to 307 routing_strategy mStrategy; // routing strategy the effect is associated to 308 int mSession; // audio session the effect is on 309 effect_descriptor_t mDesc; // effect descriptor 310 bool mEnabled; // enabled state: CPU load being used or not 311 }; 312 313 void addOutput(audio_io_handle_t id, AudioOutputDescriptor *outputDesc); 314 315 // return the strategy corresponding to a given stream type 316 static routing_strategy getStrategy(AudioSystem::stream_type stream); 317 318 // return appropriate device for streams handled by the specified strategy according to current 319 // phone state, connected devices... 320 // if fromCache is true, the device is returned from mDeviceForStrategy[], 321 // otherwise it is determine by current state 322 // (device connected,phone state, force use, a2dp output...) 323 // This allows to: 324 // 1 speed up process when the state is stable (when starting or stopping an output) 325 // 2 access to either current device selection (fromCache == true) or 326 // "future" device selection (fromCache == false) when called from a context 327 // where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND 328 // before updateDeviceForStrategy() is called. 329 virtual audio_devices_t getDeviceForStrategy(routing_strategy strategy, 330 bool fromCache); 331 332 // change the route of the specified output. Returns the number of ms we have slept to 333 // allow new routing to take effect in certain cases. 334 uint32_t setOutputDevice(audio_io_handle_t output, 335 audio_devices_t device, 336 bool force = false, 337 int delayMs = 0); 338 339 // select input device corresponding to requested audio source 340 virtual audio_devices_t getDeviceForInputSource(int inputSource); 341 342 // return io handle of active input or 0 if no input is active 343 audio_io_handle_t getActiveInput(); 344 345 // initialize volume curves for each strategy and device category 346 void initializeVolumeCurves(); 347 348 // compute the actual volume for a given stream according to the requested index and a particular 349 // device 350 virtual float computeVolume(int stream, int index, audio_io_handle_t output, audio_devices_t device); 351 352 // check that volume change is permitted, compute and send new volume to audio hardware 353 status_t checkAndSetVolume(int stream, int index, audio_io_handle_t output, audio_devices_t device, int delayMs = 0, bool force = false); 354 355 // apply all stream volumes to the specified output and device 356 void applyStreamVolumes(audio_io_handle_t output, audio_devices_t device, int delayMs = 0, bool force = false); 357 358 // Mute or unmute all streams handled by the specified strategy on the specified output 359 void setStrategyMute(routing_strategy strategy, bool on, audio_io_handle_t output, int delayMs = 0); 360 361 // Mute or unmute the stream on the specified output 362 void setStreamMute(int stream, bool on, audio_io_handle_t output, int delayMs = 0); 363 364 // handle special cases for sonification strategy while in call: mute streams or replace by 365 // a special tone in the device used for communication 366 void handleIncallSonification(int stream, bool starting, bool stateChange); 367 368 // true if device is in a telephony or VoIP call 369 virtual bool isInCall(); 370 371 // true if given state represents a device in a telephony or VoIP call 372 virtual bool isStateInCall(int state); 373 374 // when a device is connected, checks if an open output can be routed 375 // to this device. If none is open, tries to open one of the available outputs. 376 // Returns an output suitable to this device or 0. 377 // when a device is disconnected, checks if an output is not used any more and 378 // returns its handle if any. 379 // transfers the audio tracks and effects from one output thread to another accordingly. 380 audio_io_handle_t checkOutputForDevice(audio_devices_t device, 381 AudioSystem::device_connection_state state); 382 383 // close an output and its companion duplicating output. 384 void closeOutput(audio_io_handle_t output); 385 386 // checks and if necessary changes outputs used for all strategies. 387 // must be called every time a condition that affects the output choice for a given strategy 388 // changes: connected device, phone state, force use... 389 // Must be called before updateDeviceForStrategy() 390 void checkOutputForStrategy(routing_strategy strategy); 391 392 // Same as checkOutputForStrategy() but for a all strategies in order of priority 393 void checkOutputForAllStrategies(); 394 395 // manages A2DP output suspend/restore according to phone state and BT SCO usage 396 void checkA2dpSuspend(); 397 398 // returns the A2DP output handle if it is open or 0 otherwise 399 audio_io_handle_t getA2dpOutput(); 400 401 // selects the most appropriate device on output for current state 402 // must be called every time a condition that affects the device choice for a given output is 403 // changed: connected device, phone state, force use, output start, output stop.. 404 // see getDeviceForStrategy() for the use of fromCache parameter 405 406 audio_devices_t getNewDevice(audio_io_handle_t output, bool fromCache); 407 // updates cache of device used by all strategies (mDeviceForStrategy[]) 408 // must be called every time a condition that affects the device choice for a given strategy is 409 // changed: connected device, phone state, force use... 410 // cached values are used by getDeviceForStrategy() if parameter fromCache is true. 411 // Must be called after checkOutputForAllStrategies() 412 413 void updateDeviceForStrategy(); 414 415 // true if current platform requires a specific output to be opened for this particular 416 // set of parameters. This function is called by getOutput() and is implemented by platform 417 // specific audio policy manager. 418 virtual bool needsDirectOuput(audio_stream_type_t stream, 419 uint32_t samplingRate, 420 audio_format_t format, 421 audio_channel_mask_t channelMask, 422 audio_output_flags_t flags, 423 audio_devices_t device); 424 425 virtual uint32_t getMaxEffectsCpuLoad(); 426 virtual uint32_t getMaxEffectsMemory(); 427#ifdef AUDIO_POLICY_TEST 428 virtual bool threadLoop(); 429 void exit(); 430 int testOutputIndex(audio_io_handle_t output); 431#endif //AUDIO_POLICY_TEST 432 433 status_t setEffectEnabled(EffectDescriptor *pDesc, bool enabled); 434 435 // returns the category the device belongs to with regard to volume curve management 436 static device_category getDeviceCategory(audio_devices_t device); 437 438 // extract one device relevant for volume control from multiple device selection 439 static audio_devices_t getDeviceForVolume(audio_devices_t device); 440 441 SortedVector<audio_io_handle_t> getOutputsForDevice(audio_devices_t device); 442 bool vectorsEqual(SortedVector<audio_io_handle_t>& outputs1, 443 SortedVector<audio_io_handle_t>& outputs2); 444 445 // mute/unmute strategies using an incompatible device combination 446 // if muting, wait for the audio in pcm buffer to be drained before proceeding 447 // if unmuting, unmute only after the specified delay 448 // Returns the number of ms waited 449 uint32_t checkDeviceMuteStrategies(AudioOutputDescriptor *outputDesc, 450 audio_devices_t prevDevice, 451 uint32_t delayMs); 452 453 audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs, 454 AudioSystem::output_flags flags); 455 IOProfile *getInputProfile(audio_devices_t device, 456 uint32_t samplingRate, 457 uint32_t format, 458 uint32_t channelMask); 459 audio_module_handle_t getModuleForDirectoutput(audio_devices_t device, 460 uint32_t samplingRate, 461 uint32_t format, 462 uint32_t channelMask, 463 audio_output_flags_t flags); 464 // 465 // Audio policy configuration file parsing (audio_policy.conf) 466 // 467 static uint32_t stringToEnum(const struct StringToEnum *table, 468 size_t size, 469 const char *name); 470 static audio_output_flags_t parseFlagNames(char *name); 471 static audio_devices_t parseDeviceNames(char *name); 472 void loadSamplingRates(char *name, IOProfile *profile); 473 void loadFormats(char *name, IOProfile *profile); 474 void loadOutChannels(char *name, IOProfile *profile); 475 void loadInChannels(char *name, IOProfile *profile); 476 status_t loadOutput(cnode *root, HwModule *module); 477 status_t loadInput(cnode *root, HwModule *module); 478 void loadHwModule(cnode *root); 479 void loadHwModules(cnode *root); 480 void loadGlobalConfig(cnode *root); 481 status_t loadAudioPolicyConfig(const char *path); 482 483 484 AudioPolicyClientInterface *mpClientInterface; // audio policy client interface 485 audio_io_handle_t mPrimaryOutput; // primary output handle 486 DefaultKeyedVector<audio_io_handle_t, AudioOutputDescriptor *> mOutputs; // list of output descriptors 487 DefaultKeyedVector<audio_io_handle_t, AudioInputDescriptor *> mInputs; // list of input descriptors 488 audio_devices_t mAvailableOutputDevices; // bit field of all available output devices 489 audio_devices_t mAvailableInputDevices; // bit field of all available input devices 490 int mPhoneState; // current phone state 491 AudioSystem::forced_config mForceUse[AudioSystem::NUM_FORCE_USE]; // current forced use configuration 492 493 StreamDescriptor mStreams[AudioSystem::NUM_STREAM_TYPES]; // stream descriptors for volume control 494 String8 mA2dpDeviceAddress; // A2DP device MAC address 495 String8 mScoDeviceAddress; // SCO device MAC address 496 String8 mUsbCardAndDevice; // USB audio ALSA card and device numbers: 497 // card=<card_number>;device=<><device_number> 498 bool mLimitRingtoneVolume; // limit ringtone volume to music volume if headset connected 499 audio_devices_t mDeviceForStrategy[NUM_STRATEGIES]; 500 float mLastVoiceVolume; // last voice volume value sent to audio HAL 501 502 // Maximum CPU load allocated to audio effects in 0.1 MIPS (ARMv5TE, 0 WS memory) units 503 static const uint32_t MAX_EFFECTS_CPU_LOAD = 1000; 504 // Maximum memory allocated to audio effects in KB 505 static const uint32_t MAX_EFFECTS_MEMORY = 512; 506 uint32_t mTotalEffectsCpuLoad; // current CPU load used by effects 507 uint32_t mTotalEffectsMemory; // current memory used by effects 508 KeyedVector<int, EffectDescriptor *> mEffects; // list of registered audio effects 509 bool mA2dpSuspended; // true if A2DP output is suspended 510 bool mHasA2dp; // true on platforms with support for bluetooth A2DP 511 bool mHasUsb; // true on platforms with support for USB audio 512 audio_devices_t mAttachedOutputDevices; // output devices always available on the platform 513 audio_devices_t mDefaultOutputDevice; // output device selected by default at boot time 514 // (must be in mAttachedOutputDevices) 515 516 Vector <HwModule *> mHwModules; 517 Vector <IOProfile *> mOutputProfiles; // output profiles loaded from audio_policy.conf 518 Vector <IOProfile *> mInputProfiles; // input profiles loaded from audio_policy.conf 519 520#ifdef AUDIO_POLICY_TEST 521 Mutex mLock; 522 Condition mWaitWorkCV; 523 524 int mCurOutput; 525 bool mDirectOutput; 526 audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS]; 527 int mTestInput; 528 uint32_t mTestDevice; 529 uint32_t mTestSamplingRate; 530 uint32_t mTestFormat; 531 uint32_t mTestChannels; 532 uint32_t mTestLatencyMs; 533#endif //AUDIO_POLICY_TEST 534 535private: 536 static float volIndexToAmpl(audio_devices_t device, const StreamDescriptor& streamDesc, 537 int indexInUi); 538 // updates device caching and output for streams that can influence the 539 // routing of notifications 540 void handleNotificationRoutingForStream(AudioSystem::stream_type stream); 541}; 542 543}; 544