AudioSystem.h revision 0ed19594452c901c3c8665d06610fffe46895d06
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 <hardware/audio_effect.h> 21#include <media/IAudioFlingerClient.h> 22#include <system/audio.h> 23#include <system/audio_policy.h> 24#include <utils/Errors.h> 25#include <utils/Mutex.h> 26 27namespace android { 28 29typedef void (*audio_error_callback)(status_t err); 30 31class IAudioFlinger; 32class IAudioPolicyService; 33class String8; 34 35class AudioSystem 36{ 37public: 38 39 /* These are static methods to control the system-wide AudioFlinger 40 * only privileged processes can have access to them 41 */ 42 43 // mute/unmute microphone 44 static status_t muteMicrophone(bool state); 45 static status_t isMicrophoneMuted(bool *state); 46 47 // set/get master volume 48 static status_t setMasterVolume(float value); 49 static status_t getMasterVolume(float* volume); 50 51 // mute/unmute audio outputs 52 static status_t setMasterMute(bool mute); 53 static status_t getMasterMute(bool* mute); 54 55 // set/get stream volume on specified output 56 static status_t setStreamVolume(audio_stream_type_t stream, float value, 57 audio_io_handle_t output); 58 static status_t getStreamVolume(audio_stream_type_t stream, float* volume, 59 audio_io_handle_t output); 60 61 // mute/unmute stream 62 static status_t setStreamMute(audio_stream_type_t stream, bool mute); 63 static status_t getStreamMute(audio_stream_type_t stream, bool* mute); 64 65 // set audio mode in audio hardware 66 static status_t setMode(audio_mode_t mode); 67 68 // returns true in *state if tracks are active on the specified stream or have been active 69 // in the past inPastMs milliseconds 70 static status_t isStreamActive(audio_stream_type_t stream, bool *state, uint32_t inPastMs); 71 // returns true in *state if tracks are active for what qualifies as remote playback 72 // on the specified stream or have been active in the past inPastMs milliseconds. Remote 73 // playback isn't mutually exclusive with local playback. 74 static status_t isStreamActiveRemotely(audio_stream_type_t stream, bool *state, 75 uint32_t inPastMs); 76 // returns true in *state if a recorder is currently recording with the specified source 77 static status_t isSourceActive(audio_source_t source, bool *state); 78 79 // set/get audio hardware parameters. The function accepts a list of parameters 80 // key value pairs in the form: key1=value1;key2=value2;... 81 // Some keys are reserved for standard parameters (See AudioParameter class). 82 // The versions with audio_io_handle_t are intended for internal media framework use only. 83 static status_t setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs); 84 static String8 getParameters(audio_io_handle_t ioHandle, const String8& keys); 85 // The versions without audio_io_handle_t are intended for JNI. 86 static status_t setParameters(const String8& keyValuePairs); 87 static String8 getParameters(const String8& keys); 88 89 static void setErrorCallback(audio_error_callback cb); 90 91 // helper function to obtain AudioFlinger service handle 92 static const sp<IAudioFlinger>& get_audio_flinger(); 93 94 static float linearToLog(int volume); 95 static int logToLinear(float volume); 96 97 // Returned samplingRate and frameCount output values are guaranteed 98 // to be non-zero if status == NO_ERROR 99 static status_t getOutputSamplingRate(uint32_t* samplingRate, 100 audio_stream_type_t stream); 101 static status_t getOutputFrameCount(size_t* frameCount, 102 audio_stream_type_t stream); 103 static status_t getOutputLatency(uint32_t* latency, 104 audio_stream_type_t stream); 105 static status_t getSamplingRate(audio_io_handle_t output, 106 audio_stream_type_t streamType, 107 uint32_t* samplingRate); 108 // returns the number of frames per audio HAL write buffer. Corresponds to 109 // audio_stream->get_buffer_size()/audio_stream_frame_size() 110 static status_t getFrameCount(audio_io_handle_t output, 111 audio_stream_type_t stream, 112 size_t* frameCount); 113 // returns the audio output stream latency in ms. Corresponds to 114 // audio_stream_out->get_latency() 115 static status_t getLatency(audio_io_handle_t output, 116 audio_stream_type_t stream, 117 uint32_t* latency); 118 119 static bool routedToA2dpOutput(audio_stream_type_t streamType); 120 121 // return status NO_ERROR implies *buffSize > 0 122 static status_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, 123 audio_channel_mask_t channelMask, size_t* buffSize); 124 125 static status_t setVoiceVolume(float volume); 126 127 // return the number of audio frames written by AudioFlinger to audio HAL and 128 // audio dsp to DAC since the specified output I/O handle has exited standby. 129 // returned status (from utils/Errors.h) can be: 130 // - NO_ERROR: successful operation, halFrames and dspFrames point to valid data 131 // - INVALID_OPERATION: Not supported on current hardware platform 132 // - BAD_VALUE: invalid parameter 133 // NOTE: this feature is not supported on all hardware platforms and it is 134 // necessary to check returned status before using the returned values. 135 static status_t getRenderPosition(audio_io_handle_t output, 136 uint32_t *halFrames, 137 uint32_t *dspFrames); 138 139 // return the number of input frames lost by HAL implementation, or 0 if the handle is invalid 140 static uint32_t getInputFramesLost(audio_io_handle_t ioHandle); 141 142 static int newAudioSessionId(); 143 static void acquireAudioSessionId(int audioSession, pid_t pid); 144 static void releaseAudioSessionId(int audioSession, pid_t pid); 145 146 // types of io configuration change events received with ioConfigChanged() 147 enum io_config_event { 148 OUTPUT_OPENED, 149 OUTPUT_CLOSED, 150 OUTPUT_CONFIG_CHANGED, 151 INPUT_OPENED, 152 INPUT_CLOSED, 153 INPUT_CONFIG_CHANGED, 154 STREAM_CONFIG_CHANGED, 155 NUM_CONFIG_EVENTS 156 }; 157 158 // audio output descriptor used to cache output configurations in client process to avoid 159 // frequent calls through IAudioFlinger 160 class OutputDescriptor { 161 public: 162 OutputDescriptor() 163 : samplingRate(0), format(AUDIO_FORMAT_DEFAULT), channelMask(0), frameCount(0), latency(0) 164 {} 165 166 uint32_t samplingRate; 167 audio_format_t format; 168 audio_channel_mask_t channelMask; 169 size_t frameCount; 170 uint32_t latency; 171 }; 172 173 // Events used to synchronize actions between audio sessions. 174 // For instance SYNC_EVENT_PRESENTATION_COMPLETE can be used to delay recording start until 175 // playback is complete on another audio session. 176 // See definitions in MediaSyncEvent.java 177 enum sync_event_t { 178 SYNC_EVENT_SAME = -1, // used internally to indicate restart with same event 179 SYNC_EVENT_NONE = 0, 180 SYNC_EVENT_PRESENTATION_COMPLETE, 181 182 // 183 // Define new events here: SYNC_EVENT_START, SYNC_EVENT_STOP, SYNC_EVENT_TIME ... 184 // 185 SYNC_EVENT_CNT, 186 }; 187 188 // Timeout for synchronous record start. Prevents from blocking the record thread forever 189 // if the trigger event is not fired. 190 static const uint32_t kSyncRecordStartTimeOutMs = 30000; 191 192 // 193 // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions) 194 // 195 static status_t setDeviceConnectionState(audio_devices_t device, audio_policy_dev_state_t state, 196 const char *device_address); 197 static audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, 198 const char *device_address); 199 static status_t setPhoneState(audio_mode_t state); 200 static status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config); 201 static audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage); 202 203 // Client must successfully hand off the handle reference to AudioFlinger via createTrack(), 204 // or release it with releaseOutput(). 205 static audio_io_handle_t getOutput(audio_stream_type_t stream, 206 uint32_t samplingRate = 0, 207 audio_format_t format = AUDIO_FORMAT_DEFAULT, 208 audio_channel_mask_t channelMask = AUDIO_CHANNEL_OUT_STEREO, 209 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 210 const audio_offload_info_t *offloadInfo = NULL); 211 212 static status_t startOutput(audio_io_handle_t output, 213 audio_stream_type_t stream, 214 int session); 215 static status_t stopOutput(audio_io_handle_t output, 216 audio_stream_type_t stream, 217 int session); 218 static void releaseOutput(audio_io_handle_t output); 219 220 // Client must successfully hand off the handle reference to AudioFlinger via openRecord(), 221 // or release it with releaseInput(). 222 static audio_io_handle_t getInput(audio_source_t inputSource, 223 uint32_t samplingRate, 224 audio_format_t format, 225 audio_channel_mask_t channelMask, 226 int sessionId); 227 228 static status_t startInput(audio_io_handle_t input); 229 static status_t stopInput(audio_io_handle_t input); 230 static void releaseInput(audio_io_handle_t input); 231 static status_t initStreamVolume(audio_stream_type_t stream, 232 int indexMin, 233 int indexMax); 234 static status_t setStreamVolumeIndex(audio_stream_type_t stream, 235 int index, 236 audio_devices_t device); 237 static status_t getStreamVolumeIndex(audio_stream_type_t stream, 238 int *index, 239 audio_devices_t device); 240 241 static uint32_t getStrategyForStream(audio_stream_type_t stream); 242 static audio_devices_t getDevicesForStream(audio_stream_type_t stream); 243 244 static audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc); 245 static status_t registerEffect(const effect_descriptor_t *desc, 246 audio_io_handle_t io, 247 uint32_t strategy, 248 int session, 249 int id); 250 static status_t unregisterEffect(int id); 251 static status_t setEffectEnabled(int id, bool enabled); 252 253 // clear stream to output mapping cache (gStreamOutputMap) 254 // and output configuration cache (gOutputs) 255 static void clearAudioConfigCache(); 256 257 static const sp<IAudioPolicyService>& get_audio_policy_service(); 258 259 // helpers for android.media.AudioManager.getProperty(), see description there for meaning 260 static uint32_t getPrimaryOutputSamplingRate(); 261 static size_t getPrimaryOutputFrameCount(); 262 263 static status_t setLowRamDevice(bool isLowRamDevice); 264 265 // Check if hw offload is possible for given format, stream type, sample rate, 266 // bit rate, duration, video and streaming or offload property is enabled 267 static bool isOffloadSupported(const audio_offload_info_t& info); 268 269 // check presence of audio flinger service. 270 // returns NO_ERROR if binding to service succeeds, DEAD_OBJECT otherwise 271 static status_t checkAudioFlinger(); 272 // ---------------------------------------------------------------------------- 273 274private: 275 276 class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient 277 { 278 public: 279 AudioFlingerClient() { 280 } 281 282 // DeathRecipient 283 virtual void binderDied(const wp<IBinder>& who); 284 285 // IAudioFlingerClient 286 287 // indicate a change in the configuration of an output or input: keeps the cached 288 // values for output/input parameters up-to-date in client process 289 virtual void ioConfigChanged(int event, audio_io_handle_t ioHandle, const void *param2); 290 }; 291 292 class AudioPolicyServiceClient: public IBinder::DeathRecipient 293 { 294 public: 295 AudioPolicyServiceClient() { 296 } 297 298 // DeathRecipient 299 virtual void binderDied(const wp<IBinder>& who); 300 }; 301 302 static sp<AudioFlingerClient> gAudioFlingerClient; 303 static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient; 304 friend class AudioFlingerClient; 305 friend class AudioPolicyServiceClient; 306 307 static Mutex gLock; 308 static sp<IAudioFlinger> gAudioFlinger; 309 static audio_error_callback gAudioErrorCallback; 310 311 static size_t gInBuffSize; 312 // previous parameters for recording buffer size queries 313 static uint32_t gPrevInSamplingRate; 314 static audio_format_t gPrevInFormat; 315 static audio_channel_mask_t gPrevInChannelMask; 316 317 static sp<IAudioPolicyService> gAudioPolicyService; 318 319 // mapping between stream types and outputs 320 static DefaultKeyedVector<audio_stream_type_t, audio_io_handle_t> gStreamOutputMap; 321 // list of output descriptors containing cached parameters 322 // (sampling rate, framecount, channel count...) 323 static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs; 324}; 325 326}; // namespace android 327 328#endif /*ANDROID_AUDIOSYSTEM_H_*/ 329