AudioPolicyManagerBase.h revision 195368626339aefc4732661d009e8de1aacc24d1
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 seconds during which we consider that music is still active after a music 36// track was stopped - see computeVolume() 37#define SONIFICATION_HEADSET_MUSIC_DELAY 5 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 platfrom 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 audio_io_handle_t getOutput(AudioSystem::stream_type stream, 75 uint32_t samplingRate, 76 uint32_t format, 77 uint32_t channels, 78 AudioSystem::output_flags flags); 79 virtual status_t startOutput(audio_io_handle_t output, AudioSystem::stream_type stream); 80 virtual status_t stopOutput(audio_io_handle_t output, AudioSystem::stream_type stream); 81 virtual void releaseOutput(audio_io_handle_t output); 82 virtual audio_io_handle_t getInput(int inputSource, 83 uint32_t samplingRate, 84 uint32_t format, 85 uint32_t channels, 86 AudioSystem::audio_in_acoustics acoustics); 87 // indicates to the audio policy manager that the input starts being used. 88 virtual status_t startInput(audio_io_handle_t input); 89 // indicates to the audio policy manager that the input stops being used. 90 virtual status_t stopInput(audio_io_handle_t input); 91 virtual void releaseInput(audio_io_handle_t input); 92 virtual void initStreamVolume(AudioSystem::stream_type stream, 93 int indexMin, 94 int indexMax); 95 virtual status_t setStreamVolumeIndex(AudioSystem::stream_type stream, int index); 96 virtual status_t getStreamVolumeIndex(AudioSystem::stream_type stream, int *index); 97 98 virtual status_t dump(int fd); 99 100protected: 101 102 enum routing_strategy { 103 STRATEGY_MEDIA, 104 STRATEGY_PHONE, 105 STRATEGY_SONIFICATION, 106 STRATEGY_DTMF, 107 NUM_STRATEGIES 108 }; 109 110 // descriptor for audio outputs. Used to maintain current configuration of each opened audio output 111 // and keep track of the usage of this output by each audio stream type. 112 class AudioOutputDescriptor 113 { 114 public: 115 AudioOutputDescriptor(); 116 117 status_t dump(int fd); 118 119 uint32_t device(); 120 void changeRefCount(AudioSystem::stream_type, int delta); 121 uint32_t refCount(); 122 uint32_t strategyRefCount(routing_strategy strategy); 123 bool isUsedByStrategy(routing_strategy strategy) { return (strategyRefCount(strategy) != 0);} 124 bool isDuplicated() { return (mOutput1 != NULL && mOutput2 != NULL); } 125 126 audio_io_handle_t mId; // output handle 127 uint32_t mSamplingRate; // 128 uint32_t mFormat; // 129 uint32_t mChannels; // output configuration 130 uint32_t mLatency; // 131 AudioSystem::output_flags mFlags; // 132 uint32_t mDevice; // current device this output is routed to 133 uint32_t mRefCount[AudioSystem::NUM_STREAM_TYPES]; // number of streams of each type using this output 134 AudioOutputDescriptor *mOutput1; // used by duplicated outputs: first output 135 AudioOutputDescriptor *mOutput2; // used by duplicated outputs: second output 136 float mCurVolume[AudioSystem::NUM_STREAM_TYPES]; // current stream volume 137 int mMuteCount[AudioSystem::NUM_STREAM_TYPES]; // mute request counter 138 }; 139 140 // descriptor for audio inputs. Used to maintain current configuration of each opened audio input 141 // and keep track of the usage of this input. 142 class AudioInputDescriptor 143 { 144 public: 145 AudioInputDescriptor(); 146 147 status_t dump(int fd); 148 149 uint32_t mSamplingRate; // 150 uint32_t mFormat; // input configuration 151 uint32_t mChannels; // 152 AudioSystem::audio_in_acoustics mAcoustics; // 153 uint32_t mDevice; // current device this input is routed to 154 uint32_t mRefCount; // number of AudioRecord clients using this output 155 int mInputSource; // input source selected by application (mediarecorder.h) 156 }; 157 158 // stream descriptor used for volume control 159 class StreamDescriptor 160 { 161 public: 162 StreamDescriptor() 163 : mIndexMin(0), mIndexMax(1), mIndexCur(1), mCanBeMuted(true) {} 164 165 void dump(char* buffer, size_t size); 166 167 int mIndexMin; // min volume index 168 int mIndexMax; // max volume index 169 int mIndexCur; // current volume index 170 bool mCanBeMuted; // true is the stream can be muted 171 }; 172 173 void addOutput(audio_io_handle_t id, AudioOutputDescriptor *outputDesc); 174 175 // return the strategy corresponding to a given stream type 176 static routing_strategy getStrategy(AudioSystem::stream_type stream); 177 // return appropriate device for streams handled by the specified strategy according to current 178 // phone state, connected devices... 179 // if fromCache is true, the device is returned from mDeviceForStrategy[], otherwise it is determined 180 // by current state (device connected, phone state, force use, a2dp output...) 181 // This allows to: 182 // 1 speed up process when the state is stable (when starting or stopping an output) 183 // 2 access to either current device selection (fromCache == true) or 184 // "future" device selection (fromCache == false) when called from a context 185 // where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND 186 // before updateDeviceForStrategy() is called. 187 virtual uint32_t getDeviceForStrategy(routing_strategy strategy, bool fromCache = true); 188 // change the route of the specified output 189 void setOutputDevice(audio_io_handle_t output, uint32_t device, bool force = false, int delayMs = 0); 190 // select input device corresponding to requested audio source 191 virtual uint32_t getDeviceForInputSource(int inputSource); 192 // return io handle of active input or 0 if no input is active 193 audio_io_handle_t getActiveInput(); 194 // compute the actual volume for a given stream according to the requested index and a particular 195 // device 196 virtual float computeVolume(int stream, int index, audio_io_handle_t output, uint32_t device); 197 // check that volume change is permitted, compute and send new volume to audio hardware 198 status_t checkAndSetVolume(int stream, int index, audio_io_handle_t output, uint32_t device, int delayMs = 0, bool force = false); 199 // apply all stream volumes to the specified output and device 200 void applyStreamVolumes(audio_io_handle_t output, uint32_t device, int delayMs = 0); 201 // Mute or unmute all streams handled by the specified strategy on the specified output 202 void setStrategyMute(routing_strategy strategy, bool on, audio_io_handle_t output, int delayMs = 0); 203 // Mute or unmute the stream on the specified output 204 void setStreamMute(int stream, bool on, audio_io_handle_t output, int delayMs = 0); 205 // handle special cases for sonification strategy while in call: mute streams or replace by 206 // a special tone in the device used for communication 207 void handleIncallSonification(int stream, bool starting, bool stateChange); 208 // true is current platform implements a back microphone 209 virtual bool hasBackMicrophone() const { return false; } 210 211#ifdef WITH_A2DP 212 // true is current platform supports suplication of notifications and ringtones over A2DP output 213 virtual bool a2dpUsedForSonification() const { return true; } 214 status_t handleA2dpConnection(AudioSystem::audio_devices device, 215 const char *device_address); 216 status_t handleA2dpDisconnection(AudioSystem::audio_devices device, 217 const char *device_address); 218 void closeA2dpOutputs(); 219 // checks and if necessary changes output (a2dp, duplicated or hardware) used for all strategies. 220 // must be called every time a condition that affects the output choice for a given strategy is 221 // changed: connected device, phone state, force use... 222 // Must be called before updateDeviceForStrategy() 223 void checkOutputForStrategy(routing_strategy strategy, uint32_t &newDevice); 224 // Same as checkOutputForStrategy() but for a all strategies in order of priority 225 void checkOutputForAllStrategies(uint32_t &newDevice); 226 227#endif 228 // selects the most appropriate device on output for current state 229 // must be called every time a condition that affects the device choice for a given output is 230 // changed: connected device, phone state, force use, output start, output stop.. 231 // see getDeviceForStrategy() for the use of fromCache parameter 232 uint32_t getNewDevice(audio_io_handle_t output, bool fromCache = true); 233 // updates cache of device used by all strategies (mDeviceForStrategy[]) 234 // must be called every time a condition that affects the device choice for a given strategy is 235 // changed: connected device, phone state, force use... 236 // cached values are used by getDeviceForStrategy() if parameter fromCache is true. 237 // Must be called after checkOutputForAllStrategies() 238 void updateDeviceForStrategy(); 239 240#ifdef AUDIO_POLICY_TEST 241 virtual bool threadLoop(); 242 void exit(); 243 int testOutputIndex(audio_io_handle_t output); 244#endif //AUDIO_POLICY_TEST 245 246 AudioPolicyClientInterface *mpClientInterface; // audio policy client interface 247 audio_io_handle_t mHardwareOutput; // hardware output handler 248 audio_io_handle_t mA2dpOutput; // A2DP output handler 249 audio_io_handle_t mDuplicatedOutput; // duplicated output handler: outputs to hardware and A2DP. 250 251 KeyedVector<audio_io_handle_t, AudioOutputDescriptor *> mOutputs; // list of output descriptors 252 KeyedVector<audio_io_handle_t, AudioInputDescriptor *> mInputs; // list of input descriptors 253 uint32_t mAvailableOutputDevices; // bit field of all available output devices 254 uint32_t mAvailableInputDevices; // bit field of all available input devices 255 int mPhoneState; // current phone state 256 uint32_t mRingerMode; // current ringer mode 257 AudioSystem::forced_config mForceUse[AudioSystem::NUM_FORCE_USE]; // current forced use configuration 258 259 StreamDescriptor mStreams[AudioSystem::NUM_STREAM_TYPES]; // stream descriptors for volume control 260 String8 mA2dpDeviceAddress; // A2DP device MAC address 261 String8 mScoDeviceAddress; // SCO device MAC address 262 nsecs_t mMusicStopTime; // time when last music stream was stopped 263 bool mLimitRingtoneVolume; // limit ringtone volume to music volume if headset connected 264 uint32_t mDeviceForStrategy[NUM_STRATEGIES]; 265 266#ifdef AUDIO_POLICY_TEST 267 Mutex mLock; 268 Condition mWaitWorkCV; 269 270 int mCurOutput; 271 bool mDirectOutput; 272 audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS]; 273 int mTestInput; 274 uint32_t mTestDevice; 275 uint32_t mTestSamplingRate; 276 uint32_t mTestFormat; 277 uint32_t mTestChannels; 278 uint32_t mTestLatencyMs; 279#endif //AUDIO_POLICY_TEST 280}; 281 282}; 283