blob: e20f1fdc99d97d623ffcd81e5390347148d75cad [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
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 <utils/RefBase.h>
21#include <utils/threads.h>
22#include <media/IAudioFlinger.h>
23
Dima Zavin34bb4192011-05-11 14:15:23 -070024#include <system/audio.h>
Dima Zavin290029d2011-06-13 18:16:26 -070025#include <system/audio_policy.h>
Dima Zavin24fc2fb2011-04-19 22:30:36 -070026
Dima Zavin4dc22e72011-04-19 22:20:55 -070027/* XXX: Should be include by all the users instead */
28#include <media/AudioParameter.h>
29
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030namespace android {
31
32typedef void (*audio_error_callback)(status_t err);
Eric Laurenta553c252009-07-17 12:17:14 -070033
34class IAudioPolicyService;
35class String8;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080036
37class AudioSystem
38{
39public:
40
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041 /* These are static methods to control the system-wide AudioFlinger
42 * only privileged processes can have access to them
43 */
44
Eric Laurenta553c252009-07-17 12:17:14 -070045 // mute/unmute microphone
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080046 static status_t muteMicrophone(bool state);
47 static status_t isMicrophoneMuted(bool *state);
48
Eric Laurenta553c252009-07-17 12:17:14 -070049 // set/get master volume
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050 static status_t setMasterVolume(float value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080051 static status_t getMasterVolume(float* volume);
Glenn Kastened0079d2011-04-04 10:50:50 -070052
Eric Laurenta553c252009-07-17 12:17:14 -070053 // mute/unmute audio outputs
54 static status_t setMasterMute(bool mute);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080055 static status_t getMasterMute(bool* mute);
56
Eric Laurenta553c252009-07-17 12:17:14 -070057 // set/get stream volume on specified output
Glenn Kasten39d00cb2012-01-17 11:09:42 -080058 static status_t setStreamVolume(audio_stream_type_t stream, float value,
59 audio_io_handle_t output);
60 static status_t getStreamVolume(audio_stream_type_t stream, float* volume,
61 audio_io_handle_t output);
Eric Laurenta553c252009-07-17 12:17:14 -070062
63 // mute/unmute stream
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080064 static status_t setStreamMute(audio_stream_type_t stream, bool mute);
65 static status_t getStreamMute(audio_stream_type_t stream, bool* mute);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080066
Glenn Kastenaccb1142012-01-04 11:00:47 -080067 // set audio mode in audio hardware
68 static status_t setMode(audio_mode_t mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069
Eric Laurent25101b02011-02-02 09:33:30 -080070 // returns true in *state if tracks are active on the specified stream or has been active
71 // in the past inPastMs milliseconds
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080072 static status_t isStreamActive(audio_stream_type_t stream, bool *state, uint32_t inPastMs = 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080073
Eric Laurenta553c252009-07-17 12:17:14 -070074 // set/get audio hardware parameters. The function accepts a list of parameters
75 // key value pairs in the form: key1=value1;key2=value2;...
76 // Some keys are reserved for standard parameters (See AudioParameter class).
77 static status_t setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs);
78 static String8 getParameters(audio_io_handle_t ioHandle, const String8& keys);
79
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080080 static void setErrorCallback(audio_error_callback cb);
81
82 // helper function to obtain AudioFlinger service handle
83 static const sp<IAudioFlinger>& get_audio_flinger();
84
85 static float linearToLog(int volume);
86 static int logToLinear(float volume);
87
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080088 static status_t getOutputSamplingRate(int* samplingRate, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT);
89 static status_t getOutputFrameCount(int* frameCount, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT);
90 static status_t getOutputLatency(uint32_t* latency, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080091
Andreas Huber28ea0132012-01-18 10:51:55 -080092 // DEPRECATED
93 static status_t getOutputSamplingRate(int* samplingRate, int stream = AUDIO_STREAM_DEFAULT);
94
95 // DEPRECATED
96 static status_t getOutputFrameCount(int* frameCount, int stream = AUDIO_STREAM_DEFAULT);
97
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080098 static bool routedToA2dpOutput(audio_stream_type_t streamType);
Eric Laurenta553c252009-07-17 12:17:14 -070099
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800100 static status_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, int channelCount,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800101 size_t* buffSize);
102
Eric Laurent415f3e22009-10-21 08:14:22 -0700103 static status_t setVoiceVolume(float volume);
Eric Laurenta553c252009-07-17 12:17:14 -0700104
Eric Laurent0986e792010-01-19 17:37:09 -0800105 // return the number of audio frames written by AudioFlinger to audio HAL and
Glenn Kastened0079d2011-04-04 10:50:50 -0700106 // audio dsp to DAC since the output on which the specified stream is playing
Eric Laurent0986e792010-01-19 17:37:09 -0800107 // has exited standby.
108 // returned status (from utils/Errors.h) can be:
109 // - NO_ERROR: successful operation, halFrames and dspFrames point to valid data
110 // - INVALID_OPERATION: Not supported on current hardware platform
111 // - BAD_VALUE: invalid parameter
112 // NOTE: this feature is not supported on all hardware platforms and it is
113 // necessary to check returned status before using the returned values.
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800114 static status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, audio_stream_type_t stream = AUDIO_STREAM_DEFAULT);
Eric Laurent0986e792010-01-19 17:37:09 -0800115
Eric Laurent47d0a922010-02-26 02:47:27 -0800116 static unsigned int getInputFramesLost(audio_io_handle_t ioHandle);
Eric Laurent65b65452010-06-01 23:49:17 -0700117
118 static int newAudioSessionId();
Marco Nelissenc74b93f2011-08-02 13:33:41 -0700119 static void acquireAudioSessionId(int audioSession);
120 static void releaseAudioSessionId(int audioSession);
Eric Laurenta553c252009-07-17 12:17:14 -0700121
122 // types of io configuration change events received with ioConfigChanged()
123 enum io_config_event {
124 OUTPUT_OPENED,
125 OUTPUT_CLOSED,
126 OUTPUT_CONFIG_CHANGED,
127 INPUT_OPENED,
128 INPUT_CLOSED,
129 INPUT_CONFIG_CHANGED,
130 STREAM_CONFIG_CHANGED,
131 NUM_CONFIG_EVENTS
132 };
133
Glenn Kastenb3db2132012-01-19 08:59:58 -0800134 // audio output descriptor used to cache output configurations in client process to avoid frequent calls
Eric Laurenta553c252009-07-17 12:17:14 -0700135 // through IAudioFlinger
136 class OutputDescriptor {
137 public:
138 OutputDescriptor()
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800139 : samplingRate(0), format(AUDIO_FORMAT_DEFAULT), channels(0), frameCount(0), latency(0) {}
Eric Laurenta553c252009-07-17 12:17:14 -0700140
141 uint32_t samplingRate;
142 int32_t format;
143 int32_t channels;
144 size_t frameCount;
145 uint32_t latency;
146 };
147
148 //
149 // IAudioPolicyService interface (see AudioPolicyInterface for method descriptions)
150 //
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700151 static status_t setDeviceConnectionState(audio_devices_t device, audio_policy_dev_state_t state, const char *device_address);
152 static audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device, const char *device_address);
Glenn Kastenaccb1142012-01-04 11:00:47 -0800153 static status_t setPhoneState(audio_mode_t state);
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700154 static status_t setForceUse(audio_policy_force_use_t usage, audio_policy_forced_cfg_t config);
155 static audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
156 static audio_io_handle_t getOutput(audio_stream_type_t stream,
Eric Laurenta553c252009-07-17 12:17:14 -0700157 uint32_t samplingRate = 0,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800158 audio_format_t format = AUDIO_FORMAT_DEFAULT,
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700159 uint32_t channels = AUDIO_CHANNEL_OUT_STEREO,
Eric Laurent45d8c802012-03-01 09:38:00 -0800160 audio_policy_output_flags_t flags = AUDIO_POLICY_OUTPUT_FLAG_NONE);
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700161 static status_t startOutput(audio_io_handle_t output,
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700162 audio_stream_type_t stream,
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700163 int session = 0);
164 static status_t stopOutput(audio_io_handle_t output,
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700165 audio_stream_type_t stream,
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700166 int session = 0);
Eric Laurenta553c252009-07-17 12:17:14 -0700167 static void releaseOutput(audio_io_handle_t output);
Glenn Kasten0f0fbd92012-01-23 13:58:49 -0800168 static audio_io_handle_t getInput(audio_source_t inputSource,
Eric Laurenta553c252009-07-17 12:17:14 -0700169 uint32_t samplingRate = 0,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800170 audio_format_t format = AUDIO_FORMAT_DEFAULT,
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700171 uint32_t channels = AUDIO_CHANNEL_IN_MONO,
Eric Laurent464d5b32011-06-17 21:29:58 -0700172 audio_in_acoustics_t acoustics = (audio_in_acoustics_t)0,
173 int sessionId = 0);
Eric Laurenta553c252009-07-17 12:17:14 -0700174 static status_t startInput(audio_io_handle_t input);
175 static status_t stopInput(audio_io_handle_t input);
176 static void releaseInput(audio_io_handle_t input);
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700177 static status_t initStreamVolume(audio_stream_type_t stream,
Eric Laurenta553c252009-07-17 12:17:14 -0700178 int indexMin,
179 int indexMax);
Eric Laurent9bc8358d2011-11-18 16:43:31 -0800180 static status_t setStreamVolumeIndex(audio_stream_type_t stream,
181 int index,
182 audio_devices_t device);
183 static status_t getStreamVolumeIndex(audio_stream_type_t stream,
184 int *index,
185 audio_devices_t device);
Eric Laurenta553c252009-07-17 12:17:14 -0700186
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700187 static uint32_t getStrategyForStream(audio_stream_type_t stream);
Eric Laurentc9ab9f52012-03-08 13:42:42 -0800188 static audio_devices_t getDevicesForStream(audio_stream_type_t stream);
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700189
190 static audio_io_handle_t getOutputForEffect(effect_descriptor_t *desc);
191 static status_t registerEffect(effect_descriptor_t *desc,
Eric Laurent464d5b32011-06-17 21:29:58 -0700192 audio_io_handle_t io,
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700193 uint32_t strategy,
194 int session,
195 int id);
196 static status_t unregisterEffect(int id);
Eric Laurent6752ec82011-08-10 10:37:50 -0700197 static status_t setEffectEnabled(int id, bool enabled);
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700198
Eric Laurent05ce0942011-08-30 10:18:54 -0700199 // clear stream to output mapping cache (gStreamOutputMap)
200 // and output configuration cache (gOutputs)
201 static void clearAudioConfigCache();
202
Eric Laurenta553c252009-07-17 12:17:14 -0700203 static const sp<IAudioPolicyService>& get_audio_policy_service();
204
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800205 // ----------------------------------------------------------------------------
206
207private:
208
209 class AudioFlingerClient: public IBinder::DeathRecipient, public BnAudioFlingerClient
210 {
211 public:
Eric Laurenta553c252009-07-17 12:17:14 -0700212 AudioFlingerClient() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800213 }
Eric Laurenta553c252009-07-17 12:17:14 -0700214
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800215 // DeathRecipient
216 virtual void binderDied(const wp<IBinder>& who);
Eric Laurenta553c252009-07-17 12:17:14 -0700217
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800218 // IAudioFlingerClient
Eric Laurenta553c252009-07-17 12:17:14 -0700219
220 // indicate a change in the configuration of an output or input: keeps the cached
221 // values for output/input parameters upto date in client process
Glenn Kasten39d00cb2012-01-17 11:09:42 -0800222 virtual void ioConfigChanged(int event, audio_io_handle_t ioHandle, void *param2);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800223 };
Eric Laurenta553c252009-07-17 12:17:14 -0700224
225 class AudioPolicyServiceClient: public IBinder::DeathRecipient
226 {
227 public:
228 AudioPolicyServiceClient() {
229 }
230
231 // DeathRecipient
232 virtual void binderDied(const wp<IBinder>& who);
233 };
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800234
235 static sp<AudioFlingerClient> gAudioFlingerClient;
Eric Laurenta553c252009-07-17 12:17:14 -0700236 static sp<AudioPolicyServiceClient> gAudioPolicyServiceClient;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800237 friend class AudioFlingerClient;
Eric Laurenta553c252009-07-17 12:17:14 -0700238 friend class AudioPolicyServiceClient;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800239
240 static Mutex gLock;
241 static sp<IAudioFlinger> gAudioFlinger;
242 static audio_error_callback gAudioErrorCallback;
Eric Laurenta553c252009-07-17 12:17:14 -0700243
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800244 static size_t gInBuffSize;
245 // previous parameters for recording buffer size queries
246 static uint32_t gPrevInSamplingRate;
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800247 static audio_format_t gPrevInFormat;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800248 static int gPrevInChannelCount;
249
Eric Laurenta553c252009-07-17 12:17:14 -0700250 static sp<IAudioPolicyService> gAudioPolicyService;
251
252 // mapping between stream types and outputs
Glenn Kastenb7cffb42012-01-20 09:37:45 -0800253 static DefaultKeyedVector<audio_stream_type_t, audio_io_handle_t> gStreamOutputMap;
Eric Laurent05ce0942011-08-30 10:18:54 -0700254 // list of output descriptors containing cached parameters
255 // (sampling rate, framecount, channel count...)
Eric Laurenta553c252009-07-17 12:17:14 -0700256 static DefaultKeyedVector<audio_io_handle_t, OutputDescriptor *> gOutputs;
257};
258
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800259}; // namespace android
260
261#endif /*ANDROID_AUDIOSYSTEM_H_*/