AudioPolicyManagerBase.h revision 36291a74cd212c4172ac054ad0eec686b7e15c96
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 <utils/Timers.h> 21#include <utils/Errors.h> 22#include <utils/KeyedVector.h> 23#include <hardware_legacy/AudioPolicyInterface.h> 24 25 26namespace android { 27 28// ---------------------------------------------------------------------------- 29 30#define MAX_DEVICE_ADDRESS_LEN 20 31// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB 32#define SONIFICATION_HEADSET_VOLUME_FACTOR 0.5 33// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB 34#define SONIFICATION_HEADSET_VOLUME_MIN 0.016 35// Time in milliseconds during which we consider that music is still active after a music 36// track was stopped - see computeVolume() 37#define SONIFICATION_HEADSET_MUSIC_DELAY 5000 38// Time in milliseconds during witch some streams are muted while the audio path 39// is switched 40#define MUTE_TIME_MS 2000 41 42#define NUM_TEST_OUTPUTS 5 43 44// ---------------------------------------------------------------------------- 45// AudioPolicyManagerBase implements audio policy manager behavior common to all platforms. 46// Each platform must implement an AudioPolicyManager class derived from AudioPolicyManagerBase 47// and override methods for which the platform specific behavior differs from the implementation 48// in AudioPolicyManagerBase. Even if no specific behavior is required, the AudioPolicyManager 49// class must be implemented as well as the class factory function createAudioPolicyManager() 50// and provided in a shared library libaudiopolicy.so. 51// ---------------------------------------------------------------------------- 52 53class AudioPolicyManagerBase: public AudioPolicyInterface 54#ifdef AUDIO_POLICY_TEST 55 , public Thread 56#endif //AUDIO_POLICY_TEST 57{ 58 59public: 60 AudioPolicyManagerBase(AudioPolicyClientInterface *clientInterface); 61 virtual ~AudioPolicyManagerBase(); 62 63 // AudioPolicyInterface 64 virtual status_t setDeviceConnectionState(AudioSystem::audio_devices device, 65 AudioSystem::device_connection_state state, 66 const char *device_address); 67 virtual AudioSystem::device_connection_state getDeviceConnectionState(AudioSystem::audio_devices device, 68 const char *device_address); 69 virtual void setPhoneState(int state); 70 virtual void setRingerMode(uint32_t mode, uint32_t mask); 71 virtual void setForceUse(AudioSystem::force_use usage, AudioSystem::forced_config config); 72 virtual AudioSystem::forced_config getForceUse(AudioSystem::force_use usage); 73 virtual void setSystemProperty(const char* property, const char* value); 74 virtual status_t initCheck(); 75 virtual audio_io_handle_t getOutput(AudioSystem::stream_type stream, 76 uint32_t samplingRate = 0, 77 uint32_t format = AudioSystem::FORMAT_DEFAULT, 78 uint32_t channels = 0, 79 AudioSystem::output_flags flags = 80 AudioSystem::OUTPUT_FLAG_INDIRECT); 81 virtual status_t startOutput(audio_io_handle_t output, 82 AudioSystem::stream_type stream, 83 int session = 0); 84 virtual status_t stopOutput(audio_io_handle_t output, 85 AudioSystem::stream_type stream, 86 int session = 0); 87 virtual void releaseOutput(audio_io_handle_t output); 88 virtual audio_io_handle_t getInput(int inputSource, 89 uint32_t samplingRate, 90 uint32_t format, 91 uint32_t channels, 92 AudioSystem::audio_in_acoustics acoustics); 93 // indicates to the audio policy manager that the input starts being used. 94 virtual status_t startInput(audio_io_handle_t input); 95 // indicates to the audio policy manager that the input stops being used. 96 virtual status_t stopInput(audio_io_handle_t input); 97 virtual void releaseInput(audio_io_handle_t input); 98 virtual void initStreamVolume(AudioSystem::stream_type stream, 99 int indexMin, 100 int indexMax); 101 virtual status_t setStreamVolumeIndex(AudioSystem::stream_type stream, int index); 102 virtual status_t getStreamVolumeIndex(AudioSystem::stream_type stream, int *index); 103 104 // return the strategy corresponding to a given stream type 105 virtual uint32_t getStrategyForStream(AudioSystem::stream_type stream); 106 107 virtual audio_io_handle_t getOutputForEffect(effect_descriptor_t *desc); 108 virtual status_t registerEffect(effect_descriptor_t *desc, 109 audio_io_handle_t output, 110 uint32_t strategy, 111 int session, 112 int id); 113 virtual status_t unregisterEffect(int id); 114 115 virtual bool isStreamActive(int stream, uint32_t inPastMs = 0) const; 116 117 virtual status_t dump(int fd); 118 119protected: 120 121 enum routing_strategy { 122 STRATEGY_MEDIA, 123 STRATEGY_PHONE, 124 STRATEGY_SONIFICATION, 125 STRATEGY_DTMF, 126 NUM_STRATEGIES 127 }; 128 129 // descriptor for audio outputs. Used to maintain current configuration of each opened audio output 130 // and keep track of the usage of this output by each audio stream type. 131 class AudioOutputDescriptor 132 { 133 public: 134 AudioOutputDescriptor(); 135 136 status_t dump(int fd); 137 138 uint32_t device(); 139 void changeRefCount(AudioSystem::stream_type, int delta); 140 uint32_t refCount(); 141 uint32_t strategyRefCount(routing_strategy strategy); 142 bool isUsedByStrategy(routing_strategy strategy) { return (strategyRefCount(strategy) != 0);} 143 bool isDuplicated() { return (mOutput1 != NULL && mOutput2 != NULL); } 144 145 audio_io_handle_t mId; // output handle 146 uint32_t mSamplingRate; // 147 uint32_t mFormat; // 148 uint32_t mChannels; // output configuration 149 uint32_t mLatency; // 150 AudioSystem::output_flags mFlags; // 151 uint32_t mDevice; // current device this output is routed to 152 uint32_t mRefCount[AudioSystem::NUM_STREAM_TYPES]; // number of streams of each type using this output 153 nsecs_t mStopTime[AudioSystem::NUM_STREAM_TYPES]; 154 AudioOutputDescriptor *mOutput1; // used by duplicated outputs: first output 155 AudioOutputDescriptor *mOutput2; // used by duplicated outputs: second output 156 float mCurVolume[AudioSystem::NUM_STREAM_TYPES]; // current stream volume 157 int mMuteCount[AudioSystem::NUM_STREAM_TYPES]; // mute request counter 158 }; 159 160 // descriptor for audio inputs. Used to maintain current configuration of each opened audio input 161 // and keep track of the usage of this input. 162 class AudioInputDescriptor 163 { 164 public: 165 AudioInputDescriptor(); 166 167 status_t dump(int fd); 168 169 uint32_t mSamplingRate; // 170 uint32_t mFormat; // input configuration 171 uint32_t mChannels; // 172 AudioSystem::audio_in_acoustics mAcoustics; // 173 uint32_t mDevice; // current device this input is routed to 174 uint32_t mRefCount; // number of AudioRecord clients using this output 175 int mInputSource; // input source selected by application (mediarecorder.h) 176 }; 177 178 // stream descriptor used for volume control 179 class StreamDescriptor 180 { 181 public: 182 StreamDescriptor() 183 : mIndexMin(0), mIndexMax(1), mIndexCur(1), mCanBeMuted(true) {} 184 185 void dump(char* buffer, size_t size); 186 187 int mIndexMin; // min volume index 188 int mIndexMax; // max volume index 189 int mIndexCur; // current volume index 190 bool mCanBeMuted; // true is the stream can be muted 191 }; 192 193 // stream descriptor used for volume control 194 class EffectDescriptor 195 { 196 public: 197 198 status_t dump(int fd); 199 200 int mOutput; // output the effect is attached to 201 routing_strategy mStrategy; // routing strategy the effect is associated to 202 int mSession; // audio session the effect is on 203 effect_descriptor_t mDesc; // effect descriptor 204 }; 205 206 void addOutput(audio_io_handle_t id, AudioOutputDescriptor *outputDesc); 207 208 // return the strategy corresponding to a given stream type 209 static routing_strategy getStrategy(AudioSystem::stream_type stream); 210 // return appropriate device for streams handled by the specified strategy according to current 211 // phone state, connected devices... 212 // if fromCache is true, the device is returned from mDeviceForStrategy[], otherwise it is determined 213 // by current state (device connected, phone state, force use, a2dp output...) 214 // This allows to: 215 // 1 speed up process when the state is stable (when starting or stopping an output) 216 // 2 access to either current device selection (fromCache == true) or 217 // "future" device selection (fromCache == false) when called from a context 218 // where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND 219 // before updateDeviceForStrategy() is called. 220 virtual uint32_t getDeviceForStrategy(routing_strategy strategy, bool fromCache = true); 221 // change the route of the specified output 222 void setOutputDevice(audio_io_handle_t output, uint32_t device, bool force = false, int delayMs = 0); 223 // select input device corresponding to requested audio source 224 virtual uint32_t getDeviceForInputSource(int inputSource); 225 // return io handle of active input or 0 if no input is active 226 audio_io_handle_t getActiveInput(); 227 // compute the actual volume for a given stream according to the requested index and a particular 228 // device 229 virtual float computeVolume(int stream, int index, audio_io_handle_t output, uint32_t device); 230 // check that volume change is permitted, compute and send new volume to audio hardware 231 status_t checkAndSetVolume(int stream, int index, audio_io_handle_t output, uint32_t device, int delayMs = 0, bool force = false); 232 // apply all stream volumes to the specified output and device 233 void applyStreamVolumes(audio_io_handle_t output, uint32_t device, int delayMs = 0); 234 // Mute or unmute all streams handled by the specified strategy on the specified output 235 void setStrategyMute(routing_strategy strategy, bool on, audio_io_handle_t output, int delayMs = 0); 236 // Mute or unmute the stream on the specified output 237 void setStreamMute(int stream, bool on, audio_io_handle_t output, int delayMs = 0); 238 // handle special cases for sonification strategy while in call: mute streams or replace by 239 // a special tone in the device used for communication 240 void handleIncallSonification(int stream, bool starting, bool stateChange); 241 // true is current platform implements a back microphone 242 virtual bool hasBackMicrophone() const { return false; } 243 // true if device is in a telephony or VoIP call 244 virtual bool isInCall(); 245 // true if given state represents a device in a telephony or VoIP call 246 virtual bool isStateInCall(int state); 247 248#ifdef WITH_A2DP 249 // true is current platform supports suplication of notifications and ringtones over A2DP output 250 virtual bool a2dpUsedForSonification() const { return true; } 251 status_t handleA2dpConnection(AudioSystem::audio_devices device, 252 const char *device_address); 253 status_t handleA2dpDisconnection(AudioSystem::audio_devices device, 254 const char *device_address); 255 void closeA2dpOutputs(); 256 // checks and if necessary changes output (a2dp, duplicated or hardware) used for all strategies. 257 // must be called every time a condition that affects the output choice for a given strategy is 258 // changed: connected device, phone state, force use... 259 // Must be called before updateDeviceForStrategy() 260 void checkOutputForStrategy(routing_strategy strategy); 261 // Same as checkOutputForStrategy() but for a all strategies in order of priority 262 void checkOutputForAllStrategies(); 263 // manages A2DP output suspend/restore according to phone state and BT SCO usage 264 void checkA2dpSuspend(); 265#endif 266 // selects the most appropriate device on output for current state 267 // must be called every time a condition that affects the device choice for a given output is 268 // changed: connected device, phone state, force use, output start, output stop.. 269 // see getDeviceForStrategy() for the use of fromCache parameter 270 uint32_t getNewDevice(audio_io_handle_t output, bool fromCache = true); 271 // updates cache of device used by all strategies (mDeviceForStrategy[]) 272 // must be called every time a condition that affects the device choice for a given strategy is 273 // changed: connected device, phone state, force use... 274 // cached values are used by getDeviceForStrategy() if parameter fromCache is true. 275 // Must be called after checkOutputForAllStrategies() 276 void updateDeviceForStrategy(); 277 // true if current platform requires a specific output to be opened for this particular 278 // set of parameters. This function is called by getOutput() and is implemented by platform 279 // specific audio policy manager. 280 virtual bool needsDirectOuput(AudioSystem::stream_type stream, 281 uint32_t samplingRate, 282 uint32_t format, 283 uint32_t channels, 284 AudioSystem::output_flags flags, 285 uint32_t device); 286 virtual uint32_t getMaxEffectsCpuLoad(); 287 virtual uint32_t getMaxEffectsMemory(); 288#ifdef AUDIO_POLICY_TEST 289 virtual bool threadLoop(); 290 void exit(); 291 int testOutputIndex(audio_io_handle_t output); 292#endif //AUDIO_POLICY_TEST 293 294 AudioPolicyClientInterface *mpClientInterface; // audio policy client interface 295 audio_io_handle_t mHardwareOutput; // hardware output handler 296 audio_io_handle_t mA2dpOutput; // A2DP output handler 297 audio_io_handle_t mDuplicatedOutput; // duplicated output handler: outputs to hardware and A2DP. 298 299 KeyedVector<audio_io_handle_t, AudioOutputDescriptor *> mOutputs; // list of output descriptors 300 KeyedVector<audio_io_handle_t, AudioInputDescriptor *> mInputs; // list of input descriptors 301 uint32_t mAvailableOutputDevices; // bit field of all available output devices 302 uint32_t mAvailableInputDevices; // bit field of all available input devices 303 int mPhoneState; // current phone state 304 uint32_t mRingerMode; // current ringer mode 305 AudioSystem::forced_config mForceUse[AudioSystem::NUM_FORCE_USE]; // current forced use configuration 306 307 StreamDescriptor mStreams[AudioSystem::NUM_STREAM_TYPES]; // stream descriptors for volume control 308 String8 mA2dpDeviceAddress; // A2DP device MAC address 309 String8 mScoDeviceAddress; // SCO device MAC address 310 bool mLimitRingtoneVolume; // limit ringtone volume to music volume if headset connected 311 uint32_t mDeviceForStrategy[NUM_STRATEGIES]; 312 float mLastVoiceVolume; // last voice volume value sent to audio HAL 313 314 // Maximum CPU load allocated to audio effects in 0.1 MIPS (ARMv5TE, 0 WS memory) units 315 static const uint32_t MAX_EFFECTS_CPU_LOAD = 1000; 316 // Maximum memory allocated to audio effects in KB 317 static const uint32_t MAX_EFFECTS_MEMORY = 512; 318 uint32_t mTotalEffectsCpuLoad; // current CPU load used by effects 319 uint32_t mTotalEffectsMemory; // current memory used by effects 320 KeyedVector<int, EffectDescriptor *> mEffects; // list of registered audio effects 321 bool mA2dpSuspended; // true if A2DP output is suspended 322 323#ifdef AUDIO_POLICY_TEST 324 Mutex mLock; 325 Condition mWaitWorkCV; 326 327 int mCurOutput; 328 bool mDirectOutput; 329 audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS]; 330 int mTestInput; 331 uint32_t mTestDevice; 332 uint32_t mTestSamplingRate; 333 uint32_t mTestFormat; 334 uint32_t mTestChannels; 335 uint32_t mTestLatencyMs; 336#endif //AUDIO_POLICY_TEST 337}; 338 339}; 340