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