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