AudioSystem.h revision e662cd5cdbe1312d6b74754d2945fffe99e4fe2c
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 getOutputSamplingRateForAttr(uint32_t* samplingRate, 103 const audio_attributes_t *attr); 104 static status_t getOutputFrameCount(size_t* frameCount, 105 audio_stream_type_t stream); 106 static status_t getOutputLatency(uint32_t* latency, 107 audio_stream_type_t stream); 108 static status_t getSamplingRate(audio_io_handle_t output, 109 uint32_t* samplingRate); 110 // returns the number of frames per audio HAL write buffer. Corresponds to 111 // audio_stream->get_buffer_size()/audio_stream_out_frame_size() 112 static status_t getFrameCount(audio_io_handle_t output, 113 size_t* frameCount); 114 // returns the audio output stream latency in ms. Corresponds to 115 // audio_stream_out->get_latency() 116 static status_t getLatency(audio_io_handle_t output, 117 uint32_t* latency); 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 unique ID for use as an audio session ID or I/O handle. 141 // If unable to contact AudioFlinger, returns AUDIO_UNIQUE_ID_ALLOCATE instead. 142 // FIXME If AudioFlinger were to ever exhaust the unique ID namespace, 143 // this method could fail by returning either AUDIO_UNIQUE_ID_ALLOCATE 144 // or an unspecified existing unique ID. 145 static audio_unique_id_t newAudioUniqueId(); 146 147 static void acquireAudioSessionId(int audioSession, pid_t pid); 148 static void releaseAudioSessionId(int audioSession, pid_t pid); 149 150 // Get the HW synchronization source used for an audio session. 151 // Return a valid source or AUDIO_HW_SYNC_INVALID if an error occurs 152 // or no HW sync source is used. 153 static audio_hw_sync_t getAudioHwSyncForSession(audio_session_t sessionId); 154 155 // types of io configuration change events received with ioConfigChanged() 156 enum io_config_event { 157 OUTPUT_OPENED, 158 OUTPUT_CLOSED, 159 OUTPUT_CONFIG_CHANGED, 160 INPUT_OPENED, 161 INPUT_CLOSED, 162 INPUT_CONFIG_CHANGED, 163 STREAM_CONFIG_CHANGED, 164 NUM_CONFIG_EVENTS 165 }; 166 167 // audio output descriptor used to cache output configurations in client process to avoid 168 // frequent calls through IAudioFlinger 169 class OutputDescriptor { 170 public: 171 OutputDescriptor() 172 : samplingRate(0), format(AUDIO_FORMAT_DEFAULT), channelMask(0), frameCount(0), latency(0) 173 {} 174 175 uint32_t samplingRate; 176 audio_format_t format; 177 audio_channel_mask_t channelMask; 178 size_t frameCount; 179 uint32_t latency; 180 }; 181 182 // Events used to synchronize actions between audio sessions. 183 // For instance SYNC_EVENT_PRESENTATION_COMPLETE can be used to delay recording start until 184 // playback is complete on another audio session. 185 // See definitions in MediaSyncEvent.java 186 enum sync_event_t { 187 SYNC_EVENT_SAME = -1, // used internally to indicate restart with same event 188 SYNC_EVENT_NONE = 0, 189 SYNC_EVENT_PRESENTATION_COMPLETE, 190 191 // 192 // Define new events here: SYNC_EVENT_START, SYNC_EVENT_STOP, SYNC_EVENT_TIME ... 193 // 194 SYNC_EVENT_CNT, 195 }; 196 197 // Timeout for synchronous record start. Prevents from blocking the record thread forever 198 // if the trigger event is not fired. 199 static const uint32_t kSyncRecordStartTimeOutMs = 30000; 200 201 // 202 // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions) 203 // 204 static status_t setDeviceConnectionState(audio_devices_t device, audio_policy_dev_state_t state, 205 const char *device_address); 206 static audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, 207 const char *device_address); 208 static status_t setPhoneState(audio_mode_t state); 209 static status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config); 210 static audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage); 211 212 // Client must successfully hand off the handle reference to AudioFlinger via createTrack(), 213 // or release it with releaseOutput(). 214 static audio_io_handle_t getOutput(audio_stream_type_t stream, 215 uint32_t samplingRate = 0, 216 audio_format_t format = AUDIO_FORMAT_DEFAULT, 217 audio_channel_mask_t channelMask = AUDIO_CHANNEL_OUT_STEREO, 218 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 219 const audio_offload_info_t *offloadInfo = NULL); 220 static audio_io_handle_t getOutputForAttr(const audio_attributes_t *attr, 221 uint32_t samplingRate = 0, 222 audio_format_t format = AUDIO_FORMAT_DEFAULT, 223 audio_channel_mask_t channelMask = AUDIO_CHANNEL_OUT_STEREO, 224 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 225 const audio_offload_info_t *offloadInfo = NULL); 226 static status_t startOutput(audio_io_handle_t output, 227 audio_stream_type_t stream, 228 int session); 229 static status_t stopOutput(audio_io_handle_t output, 230 audio_stream_type_t stream, 231 int session); 232 static void releaseOutput(audio_io_handle_t output); 233 234 // Client must successfully hand off the handle reference to AudioFlinger via openRecord(), 235 // or release it with releaseInput(). 236 static audio_io_handle_t getInput(audio_source_t inputSource, 237 uint32_t samplingRate, 238 audio_format_t format, 239 audio_channel_mask_t channelMask, 240 int sessionId, 241 audio_input_flags_t); 242 243 static status_t startInput(audio_io_handle_t input, 244 audio_session_t session); 245 static status_t stopInput(audio_io_handle_t input, 246 audio_session_t session); 247 static void releaseInput(audio_io_handle_t input, 248 audio_session_t session); 249 static status_t initStreamVolume(audio_stream_type_t stream, 250 int indexMin, 251 int indexMax); 252 static status_t setStreamVolumeIndex(audio_stream_type_t stream, 253 int index, 254 audio_devices_t device); 255 static status_t getStreamVolumeIndex(audio_stream_type_t stream, 256 int *index, 257 audio_devices_t device); 258 259 static uint32_t getStrategyForStream(audio_stream_type_t stream); 260 static audio_devices_t getDevicesForStream(audio_stream_type_t stream); 261 262 static audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc); 263 static status_t registerEffect(const effect_descriptor_t *desc, 264 audio_io_handle_t io, 265 uint32_t strategy, 266 int session, 267 int id); 268 static status_t unregisterEffect(int id); 269 static status_t setEffectEnabled(int id, bool enabled); 270 271 // clear stream to output mapping cache (gStreamOutputMap) 272 // and output configuration cache (gOutputs) 273 static void clearAudioConfigCache(); 274 275 static const sp<IAudioPolicyService>& get_audio_policy_service(); 276 277 // helpers for android.media.AudioManager.getProperty(), see description there for meaning 278 static uint32_t getPrimaryOutputSamplingRate(); 279 static size_t getPrimaryOutputFrameCount(); 280 281 static status_t setLowRamDevice(bool isLowRamDevice); 282 283 // Check if hw offload is possible for given format, stream type, sample rate, 284 // bit rate, duration, video and streaming or offload property is enabled 285 static bool isOffloadSupported(const audio_offload_info_t& info); 286 287 // check presence of audio flinger service. 288 // returns NO_ERROR if binding to service succeeds, DEAD_OBJECT otherwise 289 static status_t checkAudioFlinger(); 290 291 /* List available audio ports and their attributes */ 292 static status_t listAudioPorts(audio_port_role_t role, 293 audio_port_type_t type, 294 unsigned int *num_ports, 295 struct audio_port *ports, 296 unsigned int *generation); 297 298 /* Get attributes for a given audio port */ 299 static status_t getAudioPort(struct audio_port *port); 300 301 /* Create an audio patch between several source and sink ports */ 302 static status_t createAudioPatch(const struct audio_patch *patch, 303 audio_patch_handle_t *handle); 304 305 /* Release an audio patch */ 306 static status_t releaseAudioPatch(audio_patch_handle_t handle); 307 308 /* List existing audio patches */ 309 static status_t listAudioPatches(unsigned int *num_patches, 310 struct audio_patch *patches, 311 unsigned int *generation); 312 /* Set audio port configuration */ 313 static status_t setAudioPortConfig(const struct audio_port_config *config); 314 315 316 static status_t acquireSoundTriggerSession(audio_session_t *session, 317 audio_io_handle_t *ioHandle, 318 audio_devices_t *device); 319 static status_t releaseSoundTriggerSession(audio_session_t session); 320 321 static audio_mode_t getPhoneState(); 322 323 // ---------------------------------------------------------------------------- 324 325 class AudioPortCallback : public RefBase 326 { 327 public: 328 329 AudioPortCallback() {} 330 virtual ~AudioPortCallback() {} 331 332 virtual void onAudioPortListUpdate() = 0; 333 virtual void onAudioPatchListUpdate() = 0; 334 virtual void onServiceDied() = 0; 335 336 }; 337 338 static void setAudioPortCallback(sp<AudioPortCallback> callBack); 339 340private: 341 342 class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient 343 { 344 public: 345 AudioFlingerClient() { 346 } 347 348 // DeathRecipient 349 virtual void binderDied(const wp<IBinder>& who); 350 351 // IAudioFlingerClient 352 353 // indicate a change in the configuration of an output or input: keeps the cached 354 // values for output/input parameters up-to-date in client process 355 virtual void ioConfigChanged(int event, audio_io_handle_t ioHandle, const void *param2); 356 }; 357 358 class AudioPolicyServiceClient: public IBinder::DeathRecipient, 359 public BnAudioPolicyServiceClient 360 { 361 public: 362 AudioPolicyServiceClient() { 363 } 364 365 // DeathRecipient 366 virtual void binderDied(const wp<IBinder>& who); 367 368 // IAudioPolicyServiceClient 369 virtual void onAudioPortListUpdate(); 370 virtual void onAudioPatchListUpdate(); 371 }; 372 373 static sp<AudioFlingerClient> gAudioFlingerClient; 374 static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient; 375 friend class AudioFlingerClient; 376 friend class AudioPolicyServiceClient; 377 378 static Mutex gLock; // protects all members except gAudioPolicyService, 379 // gAudioPolicyServiceClient, and gAudioPortCallback 380 static Mutex gLockAPS; // protects gAudioPolicyService and gAudioPolicyServiceClient 381 static Mutex gLockAPC; // protects gAudioPortCallback 382 static sp<IAudioFlinger> gAudioFlinger; 383 static audio_error_callback gAudioErrorCallback; 384 385 static size_t gInBuffSize; 386 // previous parameters for recording buffer size queries 387 static uint32_t gPrevInSamplingRate; 388 static audio_format_t gPrevInFormat; 389 static audio_channel_mask_t gPrevInChannelMask; 390 391 static sp<IAudioPolicyService> gAudioPolicyService; 392 393 // list of output descriptors containing cached parameters 394 // (sampling rate, framecount, channel count...) 395 static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs; 396 397 static sp<AudioPortCallback> gAudioPortCallback; 398}; 399 400}; // namespace android 401 402#endif /*ANDROID_AUDIOSYSTEM_H_*/ 403