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