AudioSystem.h revision b42f318d9733f88c7eb9bedfd33b086b8ea5dff5
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 output on which the specified stream is playing 129 // has exited standby. 130 // returned status (from utils/Errors.h) can be: 131 // - NO_ERROR: successful operation, halFrames and dspFrames point to valid data 132 // - INVALID_OPERATION: Not supported on current hardware platform 133 // - BAD_VALUE: invalid parameter 134 // NOTE: this feature is not supported on all hardware platforms and it is 135 // necessary to check returned status before using the returned values. 136 static status_t getRenderPosition(audio_io_handle_t output, 137 uint32_t *halFrames, 138 uint32_t *dspFrames, 139 audio_stream_type_t stream = AUDIO_STREAM_DEFAULT); 140 141 // return the number of input frames lost by HAL implementation, or 0 if the handle is invalid 142 static uint32_t getInputFramesLost(audio_io_handle_t ioHandle); 143 144 static int newAudioSessionId(); 145 static void acquireAudioSessionId(int audioSession, pid_t pid); 146 static void releaseAudioSessionId(int audioSession, pid_t pid); 147 148 // types of io configuration change events received with ioConfigChanged() 149 enum io_config_event { 150 OUTPUT_OPENED, 151 OUTPUT_CLOSED, 152 OUTPUT_CONFIG_CHANGED, 153 INPUT_OPENED, 154 INPUT_CLOSED, 155 INPUT_CONFIG_CHANGED, 156 STREAM_CONFIG_CHANGED, 157 NUM_CONFIG_EVENTS 158 }; 159 160 // audio output descriptor used to cache output configurations in client process to avoid 161 // frequent calls through IAudioFlinger 162 class OutputDescriptor { 163 public: 164 OutputDescriptor() 165 : samplingRate(0), format(AUDIO_FORMAT_DEFAULT), channelMask(0), frameCount(0), latency(0) 166 {} 167 168 uint32_t samplingRate; 169 audio_format_t format; 170 audio_channel_mask_t channelMask; 171 size_t frameCount; 172 uint32_t latency; 173 }; 174 175 // Events used to synchronize actions between audio sessions. 176 // For instance SYNC_EVENT_PRESENTATION_COMPLETE can be used to delay recording start until 177 // playback is complete on another audio session. 178 // See definitions in MediaSyncEvent.java 179 enum sync_event_t { 180 SYNC_EVENT_SAME = -1, // used internally to indicate restart with same event 181 SYNC_EVENT_NONE = 0, 182 SYNC_EVENT_PRESENTATION_COMPLETE, 183 184 // 185 // Define new events here: SYNC_EVENT_START, SYNC_EVENT_STOP, SYNC_EVENT_TIME ... 186 // 187 SYNC_EVENT_CNT, 188 }; 189 190 // Timeout for synchronous record start. Prevents from blocking the record thread forever 191 // if the trigger event is not fired. 192 static const uint32_t kSyncRecordStartTimeOutMs = 30000; 193 194 // 195 // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions) 196 // 197 static status_t setDeviceConnectionState(audio_devices_t device, audio_policy_dev_state_t state, 198 const char *device_address); 199 static audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, 200 const char *device_address); 201 static status_t setPhoneState(audio_mode_t state); 202 static status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config); 203 static audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage); 204 205 // Client must successfully hand off the handle reference to AudioFlinger via createTrack(), 206 // or release it with releaseOutput(). 207 static audio_io_handle_t getOutput(audio_stream_type_t stream, 208 uint32_t samplingRate = 0, 209 audio_format_t format = AUDIO_FORMAT_DEFAULT, 210 audio_channel_mask_t channelMask = AUDIO_CHANNEL_OUT_STEREO, 211 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 212 const audio_offload_info_t *offloadInfo = NULL); 213 214 static status_t startOutput(audio_io_handle_t output, 215 audio_stream_type_t stream, 216 int session); 217 static status_t stopOutput(audio_io_handle_t output, 218 audio_stream_type_t stream, 219 int session); 220 static void releaseOutput(audio_io_handle_t output); 221 222 // Client must successfully hand off the handle reference to AudioFlinger via openRecord(), 223 // or release it with releaseInput(). 224 static audio_io_handle_t getInput(audio_source_t inputSource, 225 uint32_t samplingRate, 226 audio_format_t format, 227 audio_channel_mask_t channelMask, 228 int sessionId); 229 230 static status_t startInput(audio_io_handle_t input); 231 static status_t stopInput(audio_io_handle_t input); 232 static void releaseInput(audio_io_handle_t input); 233 static status_t initStreamVolume(audio_stream_type_t stream, 234 int indexMin, 235 int indexMax); 236 static status_t setStreamVolumeIndex(audio_stream_type_t stream, 237 int index, 238 audio_devices_t device); 239 static status_t getStreamVolumeIndex(audio_stream_type_t stream, 240 int *index, 241 audio_devices_t device); 242 243 static uint32_t getStrategyForStream(audio_stream_type_t stream); 244 static audio_devices_t getDevicesForStream(audio_stream_type_t stream); 245 246 static audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc); 247 static status_t registerEffect(const effect_descriptor_t *desc, 248 audio_io_handle_t io, 249 uint32_t strategy, 250 int session, 251 int id); 252 static status_t unregisterEffect(int id); 253 static status_t setEffectEnabled(int id, bool enabled); 254 255 // clear stream to output mapping cache (gStreamOutputMap) 256 // and output configuration cache (gOutputs) 257 static void clearAudioConfigCache(); 258 259 static const sp<IAudioPolicyService>& get_audio_policy_service(); 260 261 // helpers for android.media.AudioManager.getProperty(), see description there for meaning 262 static uint32_t getPrimaryOutputSamplingRate(); 263 static size_t getPrimaryOutputFrameCount(); 264 265 static status_t setLowRamDevice(bool isLowRamDevice); 266 267 // Check if hw offload is possible for given format, stream type, sample rate, 268 // bit rate, duration, video and streaming or offload property is enabled 269 static bool isOffloadSupported(const audio_offload_info_t& info); 270 271 // check presence of audio flinger service. 272 // returns NO_ERROR if binding to service succeeds, DEAD_OBJECT otherwise 273 static status_t checkAudioFlinger(); 274 // ---------------------------------------------------------------------------- 275 276private: 277 278 class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient 279 { 280 public: 281 AudioFlingerClient() { 282 } 283 284 // DeathRecipient 285 virtual void binderDied(const wp<IBinder>& who); 286 287 // IAudioFlingerClient 288 289 // indicate a change in the configuration of an output or input: keeps the cached 290 // values for output/input parameters up-to-date in client process 291 virtual void ioConfigChanged(int event, audio_io_handle_t ioHandle, const void *param2); 292 }; 293 294 class AudioPolicyServiceClient: public IBinder::DeathRecipient 295 { 296 public: 297 AudioPolicyServiceClient() { 298 } 299 300 // DeathRecipient 301 virtual void binderDied(const wp<IBinder>& who); 302 }; 303 304 static sp<AudioFlingerClient> gAudioFlingerClient; 305 static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient; 306 friend class AudioFlingerClient; 307 friend class AudioPolicyServiceClient; 308 309 static Mutex gLock; 310 static sp<IAudioFlinger> gAudioFlinger; 311 static audio_error_callback gAudioErrorCallback; 312 313 static size_t gInBuffSize; 314 // previous parameters for recording buffer size queries 315 static uint32_t gPrevInSamplingRate; 316 static audio_format_t gPrevInFormat; 317 static audio_channel_mask_t gPrevInChannelMask; 318 319 static sp<IAudioPolicyService> gAudioPolicyService; 320 321 // mapping between stream types and outputs 322 static DefaultKeyedVector<audio_stream_type_t, audio_io_handle_t> gStreamOutputMap; 323 // list of output descriptors containing cached parameters 324 // (sampling rate, framecount, channel count...) 325 static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs; 326}; 327 328}; // namespace android 329 330#endif /*ANDROID_AUDIOSYSTEM_H_*/ 331