AudioSystem.h revision a011e35b22f95f558d81dc9c94b68b1465c4661d
1/* 2 * Copyright (C) 2008 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_AUDIOSYSTEM_H_ 18#define ANDROID_AUDIOSYSTEM_H_ 19 20#include <utils/RefBase.h> 21#include <utils/threads.h> 22#include <media/IAudioFlinger.h> 23 24#include <system/audio.h> 25#include <system/audio_policy.h> 26 27/* XXX: Should be include by all the users instead */ 28#include <media/AudioParameter.h> 29 30namespace android { 31 32typedef void (*audio_error_callback)(status_t err); 33 34class IAudioPolicyService; 35class String8; 36 37class AudioSystem 38{ 39public: 40 41 /* These are static methods to control the system-wide AudioFlinger 42 * only privileged processes can have access to them 43 */ 44 45 // mute/unmute microphone 46 static status_t muteMicrophone(bool state); 47 static status_t isMicrophoneMuted(bool *state); 48 49 // set/get master volume 50 static status_t setMasterVolume(float value); 51 static status_t getMasterVolume(float* volume); 52 53 // mute/unmute audio outputs 54 static status_t setMasterMute(bool mute); 55 static status_t getMasterMute(bool* mute); 56 57 // set/get stream volume on specified output 58 static status_t setStreamVolume(audio_stream_type_t stream, float value, 59 audio_io_handle_t output); 60 static status_t getStreamVolume(audio_stream_type_t stream, float* volume, 61 audio_io_handle_t output); 62 63 // mute/unmute stream 64 static status_t setStreamMute(audio_stream_type_t stream, bool mute); 65 static status_t getStreamMute(audio_stream_type_t stream, bool* mute); 66 67 // set audio mode in audio hardware 68 static status_t setMode(audio_mode_t mode); 69 70 // returns true in *state if tracks are active on the specified stream or has been active 71 // in the past inPastMs milliseconds 72 static status_t isStreamActive(audio_stream_type_t stream, bool *state, uint32_t inPastMs = 0); 73 74 // set/get audio hardware parameters. The function accepts a list of parameters 75 // key value pairs in the form: key1=value1;key2=value2;... 76 // Some keys are reserved for standard parameters (See AudioParameter class). 77 static status_t setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs); 78 static String8 getParameters(audio_io_handle_t ioHandle, const String8& keys); 79 80 static void setErrorCallback(audio_error_callback cb); 81 82 // helper function to obtain AudioFlinger service handle 83 static const sp<IAudioFlinger>& get_audio_flinger(); 84 85 static float linearToLog(int volume); 86 static int logToLinear(float volume); 87 88 static status_t getOutputSamplingRate(int* samplingRate, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT); 89 static status_t getOutputFrameCount(int* frameCount, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT); 90 static status_t getOutputLatency(uint32_t* latency, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT); 91 92 // DEPRECATED 93 static status_t getOutputSamplingRate(int* samplingRate, int stream = AUDIO_STREAM_DEFAULT); 94 95 // DEPRECATED 96 static status_t getOutputFrameCount(int* frameCount, int stream = AUDIO_STREAM_DEFAULT); 97 98 static bool routedToA2dpOutput(audio_stream_type_t streamType); 99 100 static status_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, int channelCount, 101 size_t* buffSize); 102 103 static status_t setVoiceVolume(float volume); 104 105 // return the number of audio frames written by AudioFlinger to audio HAL and 106 // audio dsp to DAC since the output on which the specified stream is playing 107 // has exited standby. 108 // returned status (from utils/Errors.h) can be: 109 // - NO_ERROR: successful operation, halFrames and dspFrames point to valid data 110 // - INVALID_OPERATION: Not supported on current hardware platform 111 // - BAD_VALUE: invalid parameter 112 // NOTE: this feature is not supported on all hardware platforms and it is 113 // necessary to check returned status before using the returned values. 114 static status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT); 115 116 static unsigned int getInputFramesLost(audio_io_handle_t ioHandle); 117 118 static int newAudioSessionId(); 119 static void acquireAudioSessionId(int audioSession); 120 static void releaseAudioSessionId(int audioSession); 121 122 // types of io configuration change events received with ioConfigChanged() 123 enum io_config_event { 124 OUTPUT_OPENED, 125 OUTPUT_CLOSED, 126 OUTPUT_CONFIG_CHANGED, 127 INPUT_OPENED, 128 INPUT_CLOSED, 129 INPUT_CONFIG_CHANGED, 130 STREAM_CONFIG_CHANGED, 131 NUM_CONFIG_EVENTS 132 }; 133 134 // audio output descriptor used to cache output configurations in client process to avoid frequent calls 135 // through IAudioFlinger 136 class OutputDescriptor { 137 public: 138 OutputDescriptor() 139 : samplingRate(0), format(AUDIO_FORMAT_DEFAULT), channels(0), frameCount(0), latency(0) {} 140 141 uint32_t samplingRate; 142 int32_t format; 143 int32_t channels; 144 size_t frameCount; 145 uint32_t latency; 146 }; 147 148 // Events used to synchronize actions between audio sessions. 149 // For instance SYNC_EVENT_PRESENTATION_COMPLETE can be used to delay recording start until playback 150 // is complete on another audio session. 151 // See definitions in MediaSyncEvent.java 152 enum sync_event_t { 153 SYNC_EVENT_SAME = -1, // used internally to indicate restart with same event 154 SYNC_EVENT_NONE = 0, 155 SYNC_EVENT_PRESENTATION_COMPLETE, 156 157 // 158 // Define new events here: SYNC_EVENT_START, SYNC_EVENT_STOP, SYNC_EVENT_TIME ... 159 // 160 SYNC_EVENT_CNT, 161 }; 162 163 // 164 // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions) 165 // 166 static status_t setDeviceConnectionState(audio_devices_t device, audio_policy_dev_state_t state, const char *device_address); 167 static audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, const char *device_address); 168 static status_t setPhoneState(audio_mode_t state); 169 static status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config); 170 static audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage); 171 static audio_io_handle_t getOutput(audio_stream_type_t stream, 172 uint32_t samplingRate = 0, 173 audio_format_t format = AUDIO_FORMAT_DEFAULT, 174 uint32_t channels = AUDIO_CHANNEL_OUT_STEREO, 175 audio_policy_output_flags_t flags = AUDIO_POLICY_OUTPUT_FLAG_NONE); 176 static status_t startOutput(audio_io_handle_t output, 177 audio_stream_type_t stream, 178 int session = 0); 179 static status_t stopOutput(audio_io_handle_t output, 180 audio_stream_type_t stream, 181 int session = 0); 182 static void releaseOutput(audio_io_handle_t output); 183 static audio_io_handle_t getInput(audio_source_t inputSource, 184 uint32_t samplingRate = 0, 185 audio_format_t format = AUDIO_FORMAT_DEFAULT, 186 uint32_t channels = AUDIO_CHANNEL_IN_MONO, 187 audio_in_acoustics_t acoustics = (audio_in_acoustics_t)0, 188 int sessionId = 0); 189 static status_t startInput(audio_io_handle_t input); 190 static status_t stopInput(audio_io_handle_t input); 191 static void releaseInput(audio_io_handle_t input); 192 static status_t initStreamVolume(audio_stream_type_t stream, 193 int indexMin, 194 int indexMax); 195 static status_t setStreamVolumeIndex(audio_stream_type_t stream, 196 int index, 197 audio_devices_t device); 198 static status_t getStreamVolumeIndex(audio_stream_type_t stream, 199 int *index, 200 audio_devices_t device); 201 202 static uint32_t getStrategyForStream(audio_stream_type_t stream); 203 static audio_devices_t getDevicesForStream(audio_stream_type_t stream); 204 205 static audio_io_handle_t getOutputForEffect(effect_descriptor_t *desc); 206 static status_t registerEffect(effect_descriptor_t *desc, 207 audio_io_handle_t io, 208 uint32_t strategy, 209 int session, 210 int id); 211 static status_t unregisterEffect(int id); 212 static status_t setEffectEnabled(int id, bool enabled); 213 214 // clear stream to output mapping cache (gStreamOutputMap) 215 // and output configuration cache (gOutputs) 216 static void clearAudioConfigCache(); 217 218 static const sp<IAudioPolicyService>& get_audio_policy_service(); 219 220 // ---------------------------------------------------------------------------- 221 222private: 223 224 class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient 225 { 226 public: 227 AudioFlingerClient() { 228 } 229 230 // DeathRecipient 231 virtual void binderDied(const wp<IBinder>& who); 232 233 // IAudioFlingerClient 234 235 // indicate a change in the configuration of an output or input: keeps the cached 236 // values for output/input parameters up-to-date in client process 237 virtual void ioConfigChanged(int event, audio_io_handle_t ioHandle, const void *param2); 238 }; 239 240 class AudioPolicyServiceClient: public IBinder::DeathRecipient 241 { 242 public: 243 AudioPolicyServiceClient() { 244 } 245 246 // DeathRecipient 247 virtual void binderDied(const wp<IBinder>& who); 248 }; 249 250 static sp<AudioFlingerClient> gAudioFlingerClient; 251 static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient; 252 friend class AudioFlingerClient; 253 friend class AudioPolicyServiceClient; 254 255 static Mutex gLock; 256 static sp<IAudioFlinger> gAudioFlinger; 257 static audio_error_callback gAudioErrorCallback; 258 259 static size_t gInBuffSize; 260 // previous parameters for recording buffer size queries 261 static uint32_t gPrevInSamplingRate; 262 static audio_format_t gPrevInFormat; 263 static int gPrevInChannelCount; 264 265 static sp<IAudioPolicyService> gAudioPolicyService; 266 267 // mapping between stream types and outputs 268 static DefaultKeyedVector<audio_stream_type_t, audio_io_handle_t> gStreamOutputMap; 269 // list of output descriptors containing cached parameters 270 // (sampling rate, framecount, channel count...) 271 static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs; 272}; 273 274}; // namespace android 275 276#endif /*ANDROID_AUDIOSYSTEM_H_*/ 277