blob: 3f3188c4c250ea0cdb696fe418b11d9162f02627 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/* //device/include/server/AudioFlinger/AudioFlinger.h
2**
3** Copyright 2007, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9** http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
18#ifndef ANDROID_AUDIO_FLINGER_H
19#define ANDROID_AUDIO_FLINGER_H
20
21#include <stdint.h>
22#include <sys/types.h>
Eric Laurent8ac9f8d2009-12-18 05:47:48 -080023#include <limits.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080024
25#include <media/IAudioFlinger.h>
26#include <media/IAudioFlingerClient.h>
27#include <media/IAudioTrack.h>
28#include <media/IAudioRecord.h>
Glenn Kasten34f9f8b2012-01-20 17:00:00 -080029#include <media/AudioSystem.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030
31#include <utils/Atomic.h>
32#include <utils/Errors.h>
33#include <utils/threads.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080034#include <utils/SortedVector.h>
Dima Zavin31f188892011-04-18 16:57:27 -070035#include <utils/TypeHelpers.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080036#include <utils/Vector.h>
37
Mathias Agopian24651682010-07-14 18:41:18 -070038#include <binder/BinderService.h>
39#include <binder/MemoryDealer.h>
40
Dima Zavin34bb4192011-05-11 14:15:23 -070041#include <system/audio.h>
Dima Zavin290029d2011-06-13 18:16:26 -070042#include <hardware/audio.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043
44#include "AudioBufferProvider.h"
45
Eric Laurent6dbdc402011-07-22 09:04:31 -070046#include <powermanager/IPowerManager.h>
47
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080048namespace android {
49
50class audio_track_cblk_t;
Eric Laurent65b65452010-06-01 23:49:17 -070051class effect_param_cblk_t;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080052class AudioMixer;
53class AudioBuffer;
Eric Laurenta553c252009-07-17 12:17:14 -070054class AudioResampler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080055
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080056// ----------------------------------------------------------------------------
57
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080058static const nsecs_t kStandbyTimeInNsecs = seconds(3);
59
Mathias Agopian24651682010-07-14 18:41:18 -070060class AudioFlinger :
61 public BinderService<AudioFlinger>,
62 public BnAudioFlinger
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080063{
Mathias Agopian24651682010-07-14 18:41:18 -070064 friend class BinderService<AudioFlinger>;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080065public:
Glenn Kasten99c2fd32012-01-06 07:46:30 -080066 static const char* getServiceName() { return "media.audio_flinger"; }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067
68 virtual status_t dump(int fd, const Vector<String16>& args);
69
70 // IAudioFlinger interface
71 virtual sp<IAudioTrack> createTrack(
72 pid_t pid,
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080073 audio_stream_type_t streamType,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -080075 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -070076 uint32_t channelMask,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077 int frameCount,
78 uint32_t flags,
79 const sp<IMemory>& sharedBuffer,
Eric Laurentddb78e72009-07-28 08:44:33 -070080 int output,
Eric Laurent65b65452010-06-01 23:49:17 -070081 int *sessionId,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080082 status_t *status);
83
Eric Laurentddb78e72009-07-28 08:44:33 -070084 virtual uint32_t sampleRate(int output) const;
85 virtual int channelCount(int output) const;
Glenn Kasten0a204ed2012-01-12 12:27:51 -080086 virtual audio_format_t format(int output) const;
Eric Laurentddb78e72009-07-28 08:44:33 -070087 virtual size_t frameCount(int output) const;
88 virtual uint32_t latency(int output) const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089
90 virtual status_t setMasterVolume(float value);
91 virtual status_t setMasterMute(bool muted);
92
93 virtual float masterVolume() const;
94 virtual bool masterMute() const;
95
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080096 virtual status_t setStreamVolume(audio_stream_type_t stream, float value, int output);
97 virtual status_t setStreamMute(audio_stream_type_t stream, bool muted);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080098
Glenn Kastenbc1d77b2012-01-12 16:38:12 -080099 virtual float streamVolume(audio_stream_type_t stream, int output) const;
100 virtual bool streamMute(audio_stream_type_t stream) const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800101
Glenn Kastenaccb1142012-01-04 11:00:47 -0800102 virtual status_t setMode(audio_mode_t mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800103
104 virtual status_t setMicMute(bool state);
105 virtual bool getMicMute() const;
106
Eric Laurentddb78e72009-07-28 08:44:33 -0700107 virtual status_t setParameters(int ioHandle, const String8& keyValuePairs);
108 virtual String8 getParameters(int ioHandle, const String8& keys);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800109
110 virtual void registerClient(const sp<IAudioFlingerClient>& client);
Eric Laurenta553c252009-07-17 12:17:14 -0700111
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800112 virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, int channelCount);
Eric Laurent47d0a922010-02-26 02:47:27 -0800113 virtual unsigned int getInputFramesLost(int ioHandle);
Eric Laurenta553c252009-07-17 12:17:14 -0700114
Eric Laurentddb78e72009-07-28 08:44:33 -0700115 virtual int openOutput(uint32_t *pDevices,
Eric Laurenta553c252009-07-17 12:17:14 -0700116 uint32_t *pSamplingRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800117 audio_format_t *pFormat,
Eric Laurenta553c252009-07-17 12:17:14 -0700118 uint32_t *pChannels,
119 uint32_t *pLatencyMs,
120 uint32_t flags);
121
Eric Laurentddb78e72009-07-28 08:44:33 -0700122 virtual int openDuplicateOutput(int output1, int output2);
Eric Laurenta553c252009-07-17 12:17:14 -0700123
Eric Laurentddb78e72009-07-28 08:44:33 -0700124 virtual status_t closeOutput(int output);
Eric Laurenta553c252009-07-17 12:17:14 -0700125
Eric Laurentddb78e72009-07-28 08:44:33 -0700126 virtual status_t suspendOutput(int output);
Eric Laurenta553c252009-07-17 12:17:14 -0700127
Eric Laurentddb78e72009-07-28 08:44:33 -0700128 virtual status_t restoreOutput(int output);
Eric Laurenta553c252009-07-17 12:17:14 -0700129
Eric Laurentddb78e72009-07-28 08:44:33 -0700130 virtual int openInput(uint32_t *pDevices,
Eric Laurenta553c252009-07-17 12:17:14 -0700131 uint32_t *pSamplingRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800132 audio_format_t *pFormat,
Eric Laurenta553c252009-07-17 12:17:14 -0700133 uint32_t *pChannels,
Glenn Kasten882c0a22012-01-27 12:32:34 -0800134 audio_in_acoustics_t acoustics);
Eric Laurenta553c252009-07-17 12:17:14 -0700135
Eric Laurentddb78e72009-07-28 08:44:33 -0700136 virtual status_t closeInput(int input);
Eric Laurenta553c252009-07-17 12:17:14 -0700137
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800138 virtual status_t setStreamOutput(audio_stream_type_t stream, int output);
Eric Laurenta553c252009-07-17 12:17:14 -0700139
Eric Laurent415f3e22009-10-21 08:14:22 -0700140 virtual status_t setVoiceVolume(float volume);
141
Eric Laurent0986e792010-01-19 17:37:09 -0800142 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, int output);
143
Eric Laurent65b65452010-06-01 23:49:17 -0700144 virtual int newAudioSessionId();
145
Marco Nelissenc74b93f2011-08-02 13:33:41 -0700146 virtual void acquireAudioSessionId(int audioSession);
147
148 virtual void releaseAudioSessionId(int audioSession);
149
Eric Laurent65b65452010-06-01 23:49:17 -0700150 virtual status_t queryNumberEffects(uint32_t *numEffects);
151
Eric Laurent53334cd2010-06-23 17:38:20 -0700152 virtual status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor);
Eric Laurent65b65452010-06-01 23:49:17 -0700153
154 virtual status_t getEffectDescriptor(effect_uuid_t *pUuid, effect_descriptor_t *descriptor);
155
156 virtual sp<IEffect> createEffect(pid_t pid,
157 effect_descriptor_t *pDesc,
158 const sp<IEffectClient>& effectClient,
159 int32_t priority,
Eric Laurent464d5b32011-06-17 21:29:58 -0700160 int io,
Eric Laurent65b65452010-06-01 23:49:17 -0700161 int sessionId,
162 status_t *status,
163 int *id,
164 int *enabled);
165
Eric Laurentf82fccd2011-07-27 19:49:51 -0700166 virtual status_t moveEffects(int sessionId, int srcOutput, int dstOutput);
Eric Laurent53334cd2010-06-23 17:38:20 -0700167
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800168 enum hardware_call_state {
169 AUDIO_HW_IDLE = 0,
170 AUDIO_HW_INIT,
171 AUDIO_HW_OUTPUT_OPEN,
172 AUDIO_HW_OUTPUT_CLOSE,
173 AUDIO_HW_INPUT_OPEN,
174 AUDIO_HW_INPUT_CLOSE,
175 AUDIO_HW_STANDBY,
176 AUDIO_HW_SET_MASTER_VOLUME,
177 AUDIO_HW_GET_ROUTING,
178 AUDIO_HW_SET_ROUTING,
179 AUDIO_HW_GET_MODE,
180 AUDIO_HW_SET_MODE,
181 AUDIO_HW_GET_MIC_MUTE,
182 AUDIO_HW_SET_MIC_MUTE,
183 AUDIO_SET_VOICE_VOLUME,
184 AUDIO_SET_PARAMETER,
185 };
186
187 // record interface
188 virtual sp<IAudioRecord> openRecord(
189 pid_t pid,
Eric Laurentddb78e72009-07-28 08:44:33 -0700190 int input,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800191 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800192 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700193 uint32_t channelMask,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800194 int frameCount,
195 uint32_t flags,
Eric Laurent65b65452010-06-01 23:49:17 -0700196 int *sessionId,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800197 status_t *status);
198
199 virtual status_t onTransact(
200 uint32_t code,
201 const Parcel& data,
202 Parcel* reply,
203 uint32_t flags);
204
Glenn Kastenaccb1142012-01-04 11:00:47 -0800205 audio_mode_t getMode() const { return mMode; }
Eric Laurent53334cd2010-06-23 17:38:20 -0700206
Eric Laurent2d95dfb2011-08-29 12:42:48 -0700207 bool btNrecIsOff() { return mBtNrecIsOff; }
Eric Laurent6639b552011-08-01 09:52:20 -0700208
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800209private:
Glenn Kasten34f9f8b2012-01-20 17:00:00 -0800210
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800211 AudioFlinger();
212 virtual ~AudioFlinger();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800213
Dima Zavin2986f5b2011-04-19 19:04:32 -0700214 status_t initCheck() const;
215 virtual void onFirstRef();
Dima Zavin31f188892011-04-18 16:57:27 -0700216 audio_hw_device_t* findSuitableHwDev_l(uint32_t devices);
Marco Nelissenc74b93f2011-08-02 13:33:41 -0700217 void purgeStaleEffects_l();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800218
219 // Internal dump utilites.
220 status_t dumpPermissionDenial(int fd, const Vector<String16>& args);
221 status_t dumpClients(int fd, const Vector<String16>& args);
222 status_t dumpInternals(int fd, const Vector<String16>& args);
223
224 // --- Client ---
225 class Client : public RefBase {
226 public:
227 Client(const sp<AudioFlinger>& audioFlinger, pid_t pid);
228 virtual ~Client();
Glenn Kasten1f812f72012-01-30 10:15:48 -0800229 sp<MemoryDealer> heap() const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800230 pid_t pid() const { return mPid; }
Eric Laurentb9481d82009-09-17 05:12:56 -0700231 sp<AudioFlinger> audioFlinger() { return mAudioFlinger; }
232
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800233 private:
234 Client(const Client&);
235 Client& operator = (const Client&);
Glenn Kastendc3ac852012-01-25 15:28:08 -0800236 const sp<AudioFlinger> mAudioFlinger;
237 const sp<MemoryDealer> mMemoryDealer;
238 const pid_t mPid;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800239 };
240
Eric Laurent4f0f17d2010-05-12 02:05:53 -0700241 // --- Notification Client ---
242 class NotificationClient : public IBinder::DeathRecipient {
243 public:
244 NotificationClient(const sp<AudioFlinger>& audioFlinger,
245 const sp<IAudioFlingerClient>& client,
246 pid_t pid);
247 virtual ~NotificationClient();
248
Glenn Kastendc3ac852012-01-25 15:28:08 -0800249 sp<IAudioFlingerClient> audioFlingerClient() const { return mAudioFlingerClient; }
Eric Laurent4f0f17d2010-05-12 02:05:53 -0700250
251 // IBinder::DeathRecipient
252 virtual void binderDied(const wp<IBinder>& who);
253
254 private:
255 NotificationClient(const NotificationClient&);
256 NotificationClient& operator = (const NotificationClient&);
257
Glenn Kastendc3ac852012-01-25 15:28:08 -0800258 const sp<AudioFlinger> mAudioFlinger;
259 const pid_t mPid;
260 const sp<IAudioFlingerClient> mAudioFlingerClient;
Eric Laurent4f0f17d2010-05-12 02:05:53 -0700261 };
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800262
263 class TrackHandle;
264 class RecordHandle;
Eric Laurenta553c252009-07-17 12:17:14 -0700265 class RecordThread;
266 class PlaybackThread;
267 class MixerThread;
268 class DirectOutputThread;
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800269 class DuplicatingThread;
Eric Laurenta553c252009-07-17 12:17:14 -0700270 class Track;
271 class RecordTrack;
Eric Laurent65b65452010-06-01 23:49:17 -0700272 class EffectModule;
273 class EffectHandle;
274 class EffectChain;
Dima Zavin31f188892011-04-18 16:57:27 -0700275 struct AudioStreamOut;
276 struct AudioStreamIn;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800277
Eric Laurenta553c252009-07-17 12:17:14 -0700278 class ThreadBase : public Thread {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800279 public:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800280
Glenn Kastenefd511a2012-01-26 10:38:26 -0800281 enum type_t {
Eric Laurent464d5b32011-06-17 21:29:58 -0700282 MIXER, // Thread class is MixerThread
283 DIRECT, // Thread class is DirectOutputThread
284 DUPLICATING, // Thread class is DuplicatingThread
285 RECORD // Thread class is RecordThread
286 };
287
Glenn Kastenefd511a2012-01-26 10:38:26 -0800288 ThreadBase (const sp<AudioFlinger>& audioFlinger, int id, uint32_t device, type_t type);
289 virtual ~ThreadBase();
290
Eric Laurent3fdb1262009-11-07 00:01:32 -0800291 status_t dumpBase(int fd, const Vector<String16>& args);
Eric Laurent1345d332011-07-24 17:49:51 -0700292 status_t dumpEffectChains(int fd, const Vector<String16>& args);
Eric Laurent3fdb1262009-11-07 00:01:32 -0800293
Eric Laurent6dbdc402011-07-22 09:04:31 -0700294 void clearPowerManager();
295
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800296 // base for record and playback
297 class TrackBase : public AudioBufferProvider, public RefBase {
298
299 public:
300 enum track_state {
301 IDLE,
302 TERMINATED,
303 STOPPED,
304 RESUMING,
305 ACTIVE,
306 PAUSING,
307 PAUSED
308 };
309
310 enum track_flags {
311 STEPSERVER_FAILED = 0x01, // StepServer could not acquire cblk->lock mutex
312 SYSTEM_FLAGS_MASK = 0x0000ffffUL,
313 // The upper 16 bits are used for track-specific flags.
314 };
315
Eric Laurenta553c252009-07-17 12:17:14 -0700316 TrackBase(const wp<ThreadBase>& thread,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800317 const sp<Client>& client,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800318 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800319 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700320 uint32_t channelMask,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800321 int frameCount,
322 uint32_t flags,
Eric Laurent65b65452010-06-01 23:49:17 -0700323 const sp<IMemory>& sharedBuffer,
324 int sessionId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800325 ~TrackBase();
326
327 virtual status_t start() = 0;
328 virtual void stop() = 0;
329 sp<IMemory> getCblk() const;
Eric Laurent6c30a712009-08-10 23:22:32 -0700330 audio_track_cblk_t* cblk() const { return mCblk; }
Eric Laurent65b65452010-06-01 23:49:17 -0700331 int sessionId() { return mSessionId; }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800332
333 protected:
Eric Laurenta553c252009-07-17 12:17:14 -0700334 friend class ThreadBase;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800335 friend class RecordHandle;
Eric Laurent2c817f52009-07-23 13:17:39 -0700336 friend class PlaybackThread;
337 friend class RecordThread;
338 friend class MixerThread;
339 friend class DirectOutputThread;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800340
341 TrackBase(const TrackBase&);
342 TrackBase& operator = (const TrackBase&);
343
344 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0;
345 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
346
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800347 audio_format_t format() const {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800348 return mFormat;
349 }
350
351 int channelCount() const ;
352
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700353 uint32_t channelMask() const;
354
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800355 int sampleRate() const;
356
357 void* getBuffer(uint32_t offset, uint32_t frames) const;
358
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800359 bool isStopped() const {
360 return mState == STOPPED;
361 }
362
363 bool isTerminated() const {
364 return mState == TERMINATED;
365 }
366
367 bool step();
368 void reset();
369
Glenn Kastendc3ac852012-01-25 15:28:08 -0800370 const wp<ThreadBase> mThread;
371 /*const*/ sp<Client> mClient; // see explanation at ~TrackBase() why not const
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800372 sp<IMemory> mCblkMemory;
373 audio_track_cblk_t* mCblk;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800374 void* mBuffer;
375 void* mBufferEnd;
376 uint32_t mFrameCount;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800377 // we don't really need a lock for these
Glenn Kasten56356202012-01-26 13:39:18 -0800378 track_state mState;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800379 int mClientTid;
Glenn Kastendc3ac852012-01-25 15:28:08 -0800380 const audio_format_t mFormat;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800381 uint32_t mFlags;
Glenn Kastendc3ac852012-01-25 15:28:08 -0800382 const int mSessionId;
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700383 uint8_t mChannelCount;
384 uint32_t mChannelMask;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800385 };
386
Eric Laurenta553c252009-07-17 12:17:14 -0700387 class ConfigEvent {
388 public:
389 ConfigEvent() : mEvent(0), mParam(0) {}
390
391 int mEvent;
392 int mParam;
393 };
394
Eric Laurent6dbdc402011-07-22 09:04:31 -0700395 class PMDeathRecipient : public IBinder::DeathRecipient {
396 public:
397 PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {}
398 virtual ~PMDeathRecipient() {}
399
400 // IBinder::DeathRecipient
401 virtual void binderDied(const wp<IBinder>& who);
402
403 private:
404 PMDeathRecipient(const PMDeathRecipient&);
405 PMDeathRecipient& operator = (const PMDeathRecipient&);
406
407 wp<ThreadBase> mThread;
408 };
409
Eric Laurent464d5b32011-06-17 21:29:58 -0700410 virtual status_t initCheck() const = 0;
Glenn Kastenefd511a2012-01-26 10:38:26 -0800411 type_t type() const { return mType; }
Eric Laurenta553c252009-07-17 12:17:14 -0700412 uint32_t sampleRate() const;
413 int channelCount() const;
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800414 audio_format_t format() const;
Eric Laurenta553c252009-07-17 12:17:14 -0700415 size_t frameCount() const;
416 void wakeUp() { mWaitWorkCV.broadcast(); }
417 void exit();
418 virtual bool checkForNewParameters_l() = 0;
419 virtual status_t setParameters(const String8& keyValuePairs);
420 virtual String8 getParameters(const String8& keys) = 0;
Eric Laurenteb8f850d2010-05-14 03:26:45 -0700421 virtual void audioConfigChanged_l(int event, int param = 0) = 0;
Eric Laurenta553c252009-07-17 12:17:14 -0700422 void sendConfigEvent(int event, int param = 0);
Eric Laurent8fce46a2009-08-04 09:45:33 -0700423 void sendConfigEvent_l(int event, int param = 0);
Eric Laurenta553c252009-07-17 12:17:14 -0700424 void processConfigEvents();
Eric Laurent49f02be2009-11-19 09:00:56 -0800425 int id() const { return mId;}
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800426 bool standby() { return mStandby; }
Eric Laurent464d5b32011-06-17 21:29:58 -0700427 uint32_t device() { return mDevice; }
428 virtual audio_stream_t* stream() = 0;
429
430 sp<EffectHandle> createEffect_l(
431 const sp<AudioFlinger::Client>& client,
432 const sp<IEffectClient>& effectClient,
433 int32_t priority,
434 int sessionId,
435 effect_descriptor_t *desc,
436 int *enabled,
437 status_t *status);
438 void disconnectEffect(const sp< EffectModule>& effect,
Marco Nelissenc74b93f2011-08-02 13:33:41 -0700439 const wp<EffectHandle>& handle,
440 bool unpiniflast);
Eric Laurent464d5b32011-06-17 21:29:58 -0700441
442 // return values for hasAudioSession (bit field)
443 enum effect_state {
444 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one
445 // effect
446 TRACK_SESSION = 0x2 // the audio session corresponds to at least one
447 // track
448 };
449
450 // get effect chain corresponding to session Id.
451 sp<EffectChain> getEffectChain(int sessionId);
452 // same as getEffectChain() but must be called with ThreadBase mutex locked
453 sp<EffectChain> getEffectChain_l(int sessionId);
454 // add an effect chain to the chain list (mEffectChains)
455 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0;
456 // remove an effect chain from the chain list (mEffectChains)
457 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0;
458 // lock mall effect chains Mutexes. Must be called before releasing the
459 // ThreadBase mutex before processing the mixer and effects. This guarantees the
460 // integrity of the chains during the process.
461 void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains);
462 // unlock effect chains after process
463 void unlockEffectChains(Vector<sp <EffectChain> >& effectChains);
464 // set audio mode to all effect chains
Glenn Kastenaccb1142012-01-04 11:00:47 -0800465 void setMode(audio_mode_t mode);
Eric Laurent464d5b32011-06-17 21:29:58 -0700466 // get effect module with corresponding ID on specified audio session
467 sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId);
468 // add and effect module. Also creates the effect chain is none exists for
469 // the effects audio session
470 status_t addEffect_l(const sp< EffectModule>& effect);
471 // remove and effect module. Also removes the effect chain is this was the last
472 // effect
473 void removeEffect_l(const sp< EffectModule>& effect);
474 // detach all tracks connected to an auxiliary effect
475 virtual void detachAuxEffect_l(int effectId) {}
476 // returns either EFFECT_SESSION if effects on this audio session exist in one
477 // chain, or TRACK_SESSION if tracks on this audio session exist, or both
478 virtual uint32_t hasAudioSession(int sessionId) = 0;
479 // the value returned by default implementation is not important as the
480 // strategy is only meaningful for PlaybackThread which implements this method
481 virtual uint32_t getStrategyForSession_l(int sessionId) { return 0; }
Eric Laurenta553c252009-07-17 12:17:14 -0700482
Eric Laurentf82fccd2011-07-27 19:49:51 -0700483 // suspend or restore effect according to the type of effect passed. a NULL
484 // type pointer means suspend all effects in the session
485 void setEffectSuspended(const effect_uuid_t *type,
486 bool suspend,
487 int sessionId = AUDIO_SESSION_OUTPUT_MIX);
488 // check if some effects must be suspended/restored when an effect is enabled
489 // or disabled
Eric Laurent7fa1cee2011-10-19 11:44:54 -0700490 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect,
Eric Laurentf82fccd2011-07-27 19:49:51 -0700491 bool enabled,
492 int sessionId = AUDIO_SESSION_OUTPUT_MIX);
Eric Laurent7fa1cee2011-10-19 11:44:54 -0700493 void checkSuspendOnEffectEnabled_l(const sp<EffectModule>& effect,
494 bool enabled,
495 int sessionId = AUDIO_SESSION_OUTPUT_MIX);
Eric Laurent2c817f52009-07-23 13:17:39 -0700496 mutable Mutex mLock;
497
Eric Laurenta553c252009-07-17 12:17:14 -0700498 protected:
499
Eric Laurentf82fccd2011-07-27 19:49:51 -0700500 // entry describing an effect being suspended in mSuspendedSessions keyed vector
501 class SuspendedSessionDesc : public RefBase {
502 public:
503 SuspendedSessionDesc() : mRefCount(0) {}
504
505 int mRefCount; // number of active suspend requests
506 effect_uuid_t mType; // effect type UUID
507 };
508
Eric Laurent6dbdc402011-07-22 09:04:31 -0700509 void acquireWakeLock();
510 void acquireWakeLock_l();
511 void releaseWakeLock();
512 void releaseWakeLock_l();
Eric Laurentf82fccd2011-07-27 19:49:51 -0700513 void setEffectSuspended_l(const effect_uuid_t *type,
514 bool suspend,
515 int sessionId = AUDIO_SESSION_OUTPUT_MIX);
516 // updated mSuspendedSessions when an effect suspended or restored
517 void updateSuspendedSessions_l(const effect_uuid_t *type,
518 bool suspend,
519 int sessionId);
520 // check if some effects must be suspended when an effect chain is added
521 void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain);
Eric Laurent6dbdc402011-07-22 09:04:31 -0700522
Marco Nelissenc74b93f2011-08-02 13:33:41 -0700523 friend class AudioFlinger;
Eric Laurenta553c252009-07-17 12:17:14 -0700524 friend class Track;
525 friend class TrackBase;
526 friend class PlaybackThread;
527 friend class MixerThread;
528 friend class DirectOutputThread;
529 friend class DuplicatingThread;
530 friend class RecordThread;
531 friend class RecordTrack;
532
Glenn Kastenefd511a2012-01-26 10:38:26 -0800533 const type_t mType;
Eric Laurenta553c252009-07-17 12:17:14 -0700534 Condition mWaitWorkCV;
Glenn Kastendc3ac852012-01-25 15:28:08 -0800535 const sp<AudioFlinger> mAudioFlinger;
Eric Laurenta553c252009-07-17 12:17:14 -0700536 uint32_t mSampleRate;
537 size_t mFrameCount;
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700538 uint32_t mChannelMask;
Eric Laurentb0a01472010-05-14 05:45:46 -0700539 uint16_t mChannelCount;
Glenn Kastenfaf354d2012-01-11 09:48:27 -0800540 size_t mFrameSize;
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800541 audio_format_t mFormat;
Eric Laurenta553c252009-07-17 12:17:14 -0700542 Condition mParamCond;
Eric Laurent8fce46a2009-08-04 09:45:33 -0700543 Vector<String8> mNewParameters;
Eric Laurenta553c252009-07-17 12:17:14 -0700544 status_t mParamStatus;
Glenn Kasten4b220f02011-12-13 11:50:00 -0800545 Vector<ConfigEvent> mConfigEvents;
Eric Laurenta553c252009-07-17 12:17:14 -0700546 bool mStandby;
Eric Laurent49f02be2009-11-19 09:00:56 -0800547 int mId;
548 bool mExiting;
Eric Laurent464d5b32011-06-17 21:29:58 -0700549 Vector< sp<EffectChain> > mEffectChains;
550 uint32_t mDevice; // output device for PlaybackThread
551 // input + output devices for RecordThread
Eric Laurent6dbdc402011-07-22 09:04:31 -0700552 static const int kNameLength = 32;
553 char mName[kNameLength];
554 sp<IPowerManager> mPowerManager;
555 sp<IBinder> mWakeLockToken;
Glenn Kastendc3ac852012-01-25 15:28:08 -0800556 const sp<PMDeathRecipient> mDeathRecipient;
Eric Laurentf82fccd2011-07-27 19:49:51 -0700557 // list of suspended effects per session and per type. The first vector is
558 // keyed by session ID, the second by type UUID timeLow field
559 KeyedVector< int, KeyedVector< int, sp<SuspendedSessionDesc> > > mSuspendedSessions;
Eric Laurenta553c252009-07-17 12:17:14 -0700560 };
561
562 // --- PlaybackThread ---
563 class PlaybackThread : public ThreadBase {
564 public:
565
Eric Laurent059b4be2009-11-09 23:32:22 -0800566 enum mixer_state {
567 MIXER_IDLE,
568 MIXER_TRACKS_ENABLED,
569 MIXER_TRACKS_READY
570 };
571
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800572 // playback track
573 class Track : public TrackBase {
574 public:
Eric Laurenta553c252009-07-17 12:17:14 -0700575 Track( const wp<ThreadBase>& thread,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800576 const sp<Client>& client,
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800577 audio_stream_type_t streamType,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800578 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800579 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700580 uint32_t channelMask,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800581 int frameCount,
Eric Laurent65b65452010-06-01 23:49:17 -0700582 const sp<IMemory>& sharedBuffer,
583 int sessionId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800584 ~Track();
585
586 void dump(char* buffer, size_t size);
587 virtual status_t start();
588 virtual void stop();
589 void pause();
590
591 void flush();
592 void destroy();
593 void mute(bool);
Eric Laurenta553c252009-07-17 12:17:14 -0700594 int name() const {
595 return mName;
596 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800597
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800598 audio_stream_type_t type() const {
Eric Laurent4bc035a2009-05-22 09:18:15 -0700599 return mStreamType;
600 }
Eric Laurent65b65452010-06-01 23:49:17 -0700601 status_t attachAuxEffect(int EffectId);
602 void setAuxBuffer(int EffectId, int32_t *buffer);
603 int32_t *auxBuffer() { return mAuxBuffer; }
604 void setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; }
605 int16_t *mainBuffer() { return mMainBuffer; }
606 int auxEffectId() { return mAuxEffectId; }
Eric Laurent4bc035a2009-05-22 09:18:15 -0700607
608
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800609 protected:
Eric Laurenta553c252009-07-17 12:17:14 -0700610 friend class ThreadBase;
Eric Laurent2c817f52009-07-23 13:17:39 -0700611 friend class TrackHandle;
612 friend class PlaybackThread;
613 friend class MixerThread;
614 friend class DirectOutputThread;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800615
616 Track(const Track&);
617 Track& operator = (const Track&);
618
619 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
Eric Laurenta553c252009-07-17 12:17:14 -0700620 bool isMuted() { return mMute; }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800621 bool isPausing() const {
622 return mState == PAUSING;
623 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800624 bool isPaused() const {
625 return mState == PAUSED;
626 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800627 bool isReady() const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800628 void setPaused() { mState = PAUSED; }
629 void reset();
630
Eric Laurent49f02be2009-11-19 09:00:56 -0800631 bool isOutputTrack() const {
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700632 return (mStreamType == AUDIO_STREAM_CNT);
Eric Laurent49f02be2009-11-19 09:00:56 -0800633 }
634
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800635 // we don't really need a lock for these
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800636 volatile bool mMute;
637 // FILLED state is used for suppressing volume ramp at begin of playing
638 enum {FS_FILLING, FS_FILLED, FS_ACTIVE};
639 mutable uint8_t mFillingUpStatus;
640 int8_t mRetryCount;
641 sp<IMemory> mSharedBuffer;
642 bool mResetDone;
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800643 audio_stream_type_t mStreamType;
Eric Laurenta553c252009-07-17 12:17:14 -0700644 int mName;
Eric Laurent65b65452010-06-01 23:49:17 -0700645 int16_t *mMainBuffer;
646 int32_t *mAuxBuffer;
647 int mAuxEffectId;
Eric Laurenta92ebfa2010-08-31 13:50:07 -0700648 bool mHasVolumeController;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800649 }; // end of Track
650
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800651
652 // playback track
653 class OutputTrack : public Track {
654 public:
Eric Laurenta553c252009-07-17 12:17:14 -0700655
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800656 class Buffer: public AudioBufferProvider::Buffer {
657 public:
658 int16_t *mBuffer;
659 };
Eric Laurenta553c252009-07-17 12:17:14 -0700660
661 OutputTrack( const wp<ThreadBase>& thread,
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800662 DuplicatingThread *sourceThread,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800663 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800664 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700665 uint32_t channelMask,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800666 int frameCount);
667 ~OutputTrack();
668
669 virtual status_t start();
670 virtual void stop();
Eric Laurenta553c252009-07-17 12:17:14 -0700671 bool write(int16_t* data, uint32_t frames);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800672 bool bufferQueueEmpty() { return (mBufferQueue.size() == 0) ? true : false; }
Eric Laurenta553c252009-07-17 12:17:14 -0700673 bool isActive() { return mActive; }
Glenn Kastendc3ac852012-01-25 15:28:08 -0800674 const wp<ThreadBase>& thread() { return mThread; }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800675
676 private:
677
Glenn Kasten34f9f8b2012-01-20 17:00:00 -0800678 enum {
679 NO_MORE_BUFFERS = 0x80000001, // same in AudioTrack.h, ok to be different value
680 };
681
Eric Laurenta553c252009-07-17 12:17:14 -0700682 status_t obtainBuffer(AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800683 void clearBufferQueue();
Eric Laurenta553c252009-07-17 12:17:14 -0700684
685 // Maximum number of pending buffers allocated by OutputTrack::write()
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800686 static const uint8_t kMaxOverFlowBuffers = 10;
Eric Laurenta553c252009-07-17 12:17:14 -0700687
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800688 Vector < Buffer* > mBufferQueue;
689 AudioBufferProvider::Buffer mOutBuffer;
Eric Laurenta553c252009-07-17 12:17:14 -0700690 bool mActive;
Glenn Kastendc3ac852012-01-25 15:28:08 -0800691 DuplicatingThread* const mSourceThread; // for waitTimeMs() in write()
Eric Laurenta553c252009-07-17 12:17:14 -0700692 }; // end of OutputTrack
693
Glenn Kastenefd511a2012-01-26 10:38:26 -0800694 PlaybackThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id,
695 uint32_t device, type_t type);
Eric Laurenta553c252009-07-17 12:17:14 -0700696 virtual ~PlaybackThread();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800697
698 virtual status_t dump(int fd, const Vector<String16>& args);
699
700 // Thread virtuals
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800701 virtual status_t readyToRun();
702 virtual void onFirstRef();
703
Glenn Kastenc434c902011-12-13 11:53:26 -0800704 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; }
Eric Laurent464d5b32011-06-17 21:29:58 -0700705
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800706 virtual uint32_t latency() const;
707
708 virtual status_t setMasterVolume(float value);
709 virtual status_t setMasterMute(bool muted);
710
711 virtual float masterVolume() const;
712 virtual bool masterMute() const;
713
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800714 virtual status_t setStreamVolume(audio_stream_type_t stream, float value);
715 virtual status_t setStreamMute(audio_stream_type_t stream, bool muted);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800716
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800717 virtual float streamVolume(audio_stream_type_t stream) const;
718 virtual bool streamMute(audio_stream_type_t stream) const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800719
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -0700720 sp<Track> createTrack_l(
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800721 const sp<AudioFlinger::Client>& client,
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800722 audio_stream_type_t streamType,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800723 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800724 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700725 uint32_t channelMask,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800726 int frameCount,
727 const sp<IMemory>& sharedBuffer,
Eric Laurent65b65452010-06-01 23:49:17 -0700728 int sessionId,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800729 status_t *status);
Eric Laurenta553c252009-07-17 12:17:14 -0700730
Glenn Kasten5b0135e2012-01-26 09:46:34 -0800731 AudioStreamOut* getOutput() const;
Eric Laurent828b9772011-08-07 16:32:26 -0700732 AudioStreamOut* clearOutput();
733 virtual audio_stream_t* stream();
Eric Laurenta553c252009-07-17 12:17:14 -0700734
Eric Laurentd5603c12009-08-06 08:49:39 -0700735 void suspend() { mSuspended++; }
736 void restore() { if (mSuspended) mSuspended--; }
Glenn Kasten1dce8412012-01-04 11:01:11 -0800737 bool isSuspended() const { return (mSuspended != 0); }
Eric Laurenta553c252009-07-17 12:17:14 -0700738 virtual String8 getParameters(const String8& keys);
Eric Laurenteb8f850d2010-05-14 03:26:45 -0700739 virtual void audioConfigChanged_l(int event, int param = 0);
Eric Laurent0986e792010-01-19 17:37:09 -0800740 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames);
Eric Laurent65b65452010-06-01 23:49:17 -0700741 int16_t *mixBuffer() { return mMixBuffer; };
742
Eric Laurent464d5b32011-06-17 21:29:58 -0700743 virtual void detachAuxEffect_l(int effectId);
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700744 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track,
745 int EffectId);
746 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track,
747 int EffectId);
Eric Laurenta553c252009-07-17 12:17:14 -0700748
Eric Laurent464d5b32011-06-17 21:29:58 -0700749 virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
750 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
751 virtual uint32_t hasAudioSession(int sessionId);
752 virtual uint32_t getStrategyForSession_l(int sessionId);
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700753
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800754 void setStreamValid(audio_stream_type_t streamType, bool valid);
Eric Laurent05ce0942011-08-30 10:18:54 -0700755
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800756 struct stream_type_t {
757 stream_type_t()
758 : volume(1.0f),
Eric Laurent05ce0942011-08-30 10:18:54 -0700759 mute(false),
760 valid(true)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800761 {
762 }
763 float volume;
764 bool mute;
Eric Laurent05ce0942011-08-30 10:18:54 -0700765 bool valid;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800766 };
767
Eric Laurent2c817f52009-07-23 13:17:39 -0700768 protected:
Eric Laurent2c817f52009-07-23 13:17:39 -0700769 int16_t* mMixBuffer;
Eric Laurentd5603c12009-08-06 08:49:39 -0700770 int mSuspended;
Eric Laurent2c817f52009-07-23 13:17:39 -0700771 int mBytesWritten;
Glenn Kastene6f8a422011-12-13 11:47:54 -0800772 private:
Eric Laurent2c817f52009-07-23 13:17:39 -0700773 bool mMasterMute;
Glenn Kastene6f8a422011-12-13 11:47:54 -0800774 protected:
Eric Laurent2c817f52009-07-23 13:17:39 -0700775 SortedVector< wp<Track> > mActiveTracks;
776
Eric Laurent62443f52009-10-05 20:29:18 -0700777 virtual int getTrackName_l() = 0;
778 virtual void deleteTrackName_l(int name) = 0;
Eric Laurent44331692011-12-05 09:47:19 -0800779 virtual uint32_t activeSleepTimeUs();
Eric Laurent059b4be2009-11-09 23:32:22 -0800780 virtual uint32_t idleSleepTimeUs() = 0;
Eric Laurent8448a792010-08-18 18:13:17 -0700781 virtual uint32_t suspendSleepTimeUs() = 0;
Eric Laurent62443f52009-10-05 20:29:18 -0700782
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800783 private:
784
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800785 friend class AudioFlinger;
Eric Laurent6c30a712009-08-10 23:22:32 -0700786 friend class OutputTrack;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800787 friend class Track;
788 friend class TrackBase;
Eric Laurenta553c252009-07-17 12:17:14 -0700789 friend class MixerThread;
790 friend class DirectOutputThread;
791 friend class DuplicatingThread;
792
793 PlaybackThread(const Client&);
794 PlaybackThread& operator = (const PlaybackThread&);
795
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -0700796 status_t addTrack_l(const sp<Track>& track);
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -0700797 void destroyTrack_l(const sp<Track>& track);
Eric Laurent90681d62011-05-09 12:09:06 -0700798 void removeTrack_l(const sp<Track>& track);
Eric Laurent62443f52009-10-05 20:29:18 -0700799
Eric Laurenta553c252009-07-17 12:17:14 -0700800 void readOutputParameters();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800801
Eric Laurenta553c252009-07-17 12:17:14 -0700802 virtual status_t dumpInternals(int fd, const Vector<String16>& args);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800803 status_t dumpTracks(int fd, const Vector<String16>& args);
Eric Laurenta553c252009-07-17 12:17:14 -0700804
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800805 SortedVector< sp<Track> > mTracks;
Glenn Kasten6e987a42012-01-06 08:40:01 -0800806 // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by DuplicatingThread
Dima Zavin24fc2fb2011-04-19 22:30:36 -0700807 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1];
Glenn Kasten5b0135e2012-01-26 09:46:34 -0800808 AudioStreamOut *mOutput;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800809 float mMasterVolume;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800810 nsecs_t mLastWriteTime;
811 int mNumWrites;
812 int mNumDelayedWrites;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800813 bool mInWrite;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800814 };
815
Eric Laurenta553c252009-07-17 12:17:14 -0700816 class MixerThread : public PlaybackThread {
817 public:
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700818 MixerThread (const sp<AudioFlinger>& audioFlinger,
Dima Zavin31f188892011-04-18 16:57:27 -0700819 AudioStreamOut* output,
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700820 int id,
Glenn Kastenefd511a2012-01-26 10:38:26 -0800821 uint32_t device,
822 type_t type = MIXER);
Eric Laurenta553c252009-07-17 12:17:14 -0700823 virtual ~MixerThread();
824
825 // Thread virtuals
826 virtual bool threadLoop();
827
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800828 void invalidateTracks(audio_stream_type_t streamType);
Eric Laurenta553c252009-07-17 12:17:14 -0700829 virtual bool checkForNewParameters_l();
830 virtual status_t dumpInternals(int fd, const Vector<String16>& args);
831
832 protected:
Glenn Kasten789fef12012-01-26 13:37:52 -0800833 mixer_state prepareTracks_l(const SortedVector< wp<Track> >& activeTracks,
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700834 Vector< sp<Track> > *tracksToRemove);
Eric Laurent62443f52009-10-05 20:29:18 -0700835 virtual int getTrackName_l();
836 virtual void deleteTrackName_l(int name);
Eric Laurent059b4be2009-11-09 23:32:22 -0800837 virtual uint32_t idleSleepTimeUs();
Eric Laurent8448a792010-08-18 18:13:17 -0700838 virtual uint32_t suspendSleepTimeUs();
Eric Laurenta553c252009-07-17 12:17:14 -0700839
Eric Laurent71c44962012-01-17 19:20:12 -0800840 AudioMixer* mAudioMixer;
Glenn Kasten789fef12012-01-26 13:37:52 -0800841 mixer_state mPrevMixerStatus; // previous status returned by prepareTracks_l()
Eric Laurenta553c252009-07-17 12:17:14 -0700842 };
843
844 class DirectOutputThread : public PlaybackThread {
845 public:
846
Dima Zavin31f188892011-04-18 16:57:27 -0700847 DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
Eric Laurenta553c252009-07-17 12:17:14 -0700848 ~DirectOutputThread();
849
850 // Thread virtuals
851 virtual bool threadLoop();
852
Eric Laurent62443f52009-10-05 20:29:18 -0700853 virtual bool checkForNewParameters_l();
854
855 protected:
Eric Laurenta553c252009-07-17 12:17:14 -0700856 virtual int getTrackName_l();
857 virtual void deleteTrackName_l(int name);
Eric Laurent059b4be2009-11-09 23:32:22 -0800858 virtual uint32_t activeSleepTimeUs();
859 virtual uint32_t idleSleepTimeUs();
Eric Laurent8448a792010-08-18 18:13:17 -0700860 virtual uint32_t suspendSleepTimeUs();
Eric Laurenta553c252009-07-17 12:17:14 -0700861
862 private:
Eric Laurent65b65452010-06-01 23:49:17 -0700863 void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp);
864
865 float mLeftVolFloat;
866 float mRightVolFloat;
867 uint16_t mLeftVolShort;
868 uint16_t mRightVolShort;
Eric Laurenta553c252009-07-17 12:17:14 -0700869 };
870
871 class DuplicatingThread : public MixerThread {
872 public:
Eric Laurent49f02be2009-11-19 09:00:56 -0800873 DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, int id);
Eric Laurenta553c252009-07-17 12:17:14 -0700874 ~DuplicatingThread();
875
876 // Thread virtuals
877 virtual bool threadLoop();
878 void addOutputTrack(MixerThread* thread);
879 void removeOutputTrack(MixerThread* thread);
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800880 uint32_t waitTimeMs() { return mWaitTimeMs; }
881 protected:
882 virtual uint32_t activeSleepTimeUs();
Eric Laurenta553c252009-07-17 12:17:14 -0700883
884 private:
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800885 bool outputsReady(SortedVector< sp<OutputTrack> > &outputTracks);
886 void updateWaitTime();
887
Eric Laurenta553c252009-07-17 12:17:14 -0700888 SortedVector < sp<OutputTrack> > mOutputTracks;
Eric Laurent8ac9f8d2009-12-18 05:47:48 -0800889 uint32_t mWaitTimeMs;
Eric Laurenta553c252009-07-17 12:17:14 -0700890 };
891
Eric Laurentddb78e72009-07-28 08:44:33 -0700892 PlaybackThread *checkPlaybackThread_l(int output) const;
893 MixerThread *checkMixerThread_l(int output) const;
894 RecordThread *checkRecordThread_l(int input) const;
Glenn Kastenbc1d77b2012-01-12 16:38:12 -0800895 float streamVolumeInternal(audio_stream_type_t stream) const { return mStreamTypes[stream].volume; }
Eric Laurent49f02be2009-11-19 09:00:56 -0800896 void audioConfigChanged_l(int event, int ioHandle, void *param2);
Eric Laurenta553c252009-07-17 12:17:14 -0700897
Eric Laurent464d5b32011-06-17 21:29:58 -0700898 uint32_t nextUniqueId();
Eric Laurentf82fccd2011-07-27 19:49:51 -0700899 status_t moveEffectChain_l(int sessionId,
Eric Laurent8ed6ed02010-07-13 04:45:46 -0700900 AudioFlinger::PlaybackThread *srcThread,
Eric Laurent493941b2010-07-28 01:32:47 -0700901 AudioFlinger::PlaybackThread *dstThread,
902 bool reRegister);
Eric Laurent464d5b32011-06-17 21:29:58 -0700903 PlaybackThread *primaryPlaybackThread_l();
904 uint32_t primaryOutputDevice_l();
Eric Laurent65b65452010-06-01 23:49:17 -0700905
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800906 friend class AudioBuffer;
907
908 class TrackHandle : public android::BnAudioTrack {
909 public:
Eric Laurenta553c252009-07-17 12:17:14 -0700910 TrackHandle(const sp<PlaybackThread::Track>& track);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800911 virtual ~TrackHandle();
Glenn Kasten0ae4d972012-01-26 13:40:12 -0800912 virtual sp<IMemory> getCblk() const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800913 virtual status_t start();
914 virtual void stop();
915 virtual void flush();
916 virtual void mute(bool);
917 virtual void pause();
Eric Laurent65b65452010-06-01 23:49:17 -0700918 virtual status_t attachAuxEffect(int effectId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800919 virtual status_t onTransact(
920 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
921 private:
Glenn Kastendc3ac852012-01-25 15:28:08 -0800922 const sp<PlaybackThread::Track> mTrack;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800923 };
924
925 friend class Client;
Eric Laurenta553c252009-07-17 12:17:14 -0700926 friend class PlaybackThread::Track;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800927
928
Eric Laurentb9481d82009-09-17 05:12:56 -0700929 void removeClient_l(pid_t pid);
Eric Laurent4f0f17d2010-05-12 02:05:53 -0700930 void removeNotificationClient(pid_t pid);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800931
932
Eric Laurenta553c252009-07-17 12:17:14 -0700933 // record thread
934 class RecordThread : public ThreadBase, public AudioBufferProvider
935 {
936 public:
937
938 // record track
939 class RecordTrack : public TrackBase {
940 public:
941 RecordTrack(const wp<ThreadBase>& thread,
942 const sp<Client>& client,
943 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800944 audio_format_t format,
Jean-Michel Trivi54392232011-05-24 15:53:33 -0700945 uint32_t channelMask,
Eric Laurenta553c252009-07-17 12:17:14 -0700946 int frameCount,
Eric Laurent65b65452010-06-01 23:49:17 -0700947 uint32_t flags,
948 int sessionId);
Eric Laurenta553c252009-07-17 12:17:14 -0700949 ~RecordTrack();
950
951 virtual status_t start();
952 virtual void stop();
953
954 bool overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; }
955 bool setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; }
956
Eric Laurent3fdb1262009-11-07 00:01:32 -0800957 void dump(char* buffer, size_t size);
Eric Laurentf82fccd2011-07-27 19:49:51 -0700958
Eric Laurenta553c252009-07-17 12:17:14 -0700959 private:
960 friend class AudioFlinger;
Eric Laurent2c817f52009-07-23 13:17:39 -0700961 friend class RecordThread;
Eric Laurenta553c252009-07-17 12:17:14 -0700962
963 RecordTrack(const RecordTrack&);
964 RecordTrack& operator = (const RecordTrack&);
965
966 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
967
968 bool mOverflow;
969 };
970
971
972 RecordThread(const sp<AudioFlinger>& audioFlinger,
Dima Zavin31f188892011-04-18 16:57:27 -0700973 AudioStreamIn *input,
Eric Laurenta553c252009-07-17 12:17:14 -0700974 uint32_t sampleRate,
Eric Laurent49f02be2009-11-19 09:00:56 -0800975 uint32_t channels,
Eric Laurent464d5b32011-06-17 21:29:58 -0700976 int id,
977 uint32_t device);
Eric Laurenta553c252009-07-17 12:17:14 -0700978 ~RecordThread();
979
980 virtual bool threadLoop();
Eric Laurent828b9772011-08-07 16:32:26 -0700981 virtual status_t readyToRun();
Eric Laurenta553c252009-07-17 12:17:14 -0700982 virtual void onFirstRef();
983
Glenn Kastenc434c902011-12-13 11:53:26 -0800984 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; }
Eric Laurent464d5b32011-06-17 21:29:58 -0700985 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l(
986 const sp<AudioFlinger::Client>& client,
987 uint32_t sampleRate,
Glenn Kasten0a204ed2012-01-12 12:27:51 -0800988 audio_format_t format,
Eric Laurent464d5b32011-06-17 21:29:58 -0700989 int channelMask,
990 int frameCount,
991 uint32_t flags,
992 int sessionId,
993 status_t *status);
994
Eric Laurenta553c252009-07-17 12:17:14 -0700995 status_t start(RecordTrack* recordTrack);
996 void stop(RecordTrack* recordTrack);
997 status_t dump(int fd, const Vector<String16>& args);
Glenn Kasten5b0135e2012-01-26 09:46:34 -0800998 AudioStreamIn* getInput() const;
Eric Laurent828b9772011-08-07 16:32:26 -0700999 AudioStreamIn* clearInput();
1000 virtual audio_stream_t* stream();
Eric Laurenta553c252009-07-17 12:17:14 -07001001
1002 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
1003 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
1004 virtual bool checkForNewParameters_l();
1005 virtual String8 getParameters(const String8& keys);
Eric Laurenteb8f850d2010-05-14 03:26:45 -07001006 virtual void audioConfigChanged_l(int event, int param = 0);
Eric Laurenta553c252009-07-17 12:17:14 -07001007 void readInputParameters();
Eric Laurent47d0a922010-02-26 02:47:27 -08001008 virtual unsigned int getInputFramesLost();
Eric Laurenta553c252009-07-17 12:17:14 -07001009
Eric Laurent464d5b32011-06-17 21:29:58 -07001010 virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
1011 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
1012 virtual uint32_t hasAudioSession(int sessionId);
Eric Laurent6639b552011-08-01 09:52:20 -07001013 RecordTrack* track();
Eric Laurent464d5b32011-06-17 21:29:58 -07001014
Eric Laurenta553c252009-07-17 12:17:14 -07001015 private:
1016 RecordThread();
Dima Zavin31f188892011-04-18 16:57:27 -07001017 AudioStreamIn *mInput;
Eric Laurent464d5b32011-06-17 21:29:58 -07001018 RecordTrack* mTrack;
Eric Laurenta553c252009-07-17 12:17:14 -07001019 sp<RecordTrack> mActiveTrack;
1020 Condition mStartStopCond;
1021 AudioResampler *mResampler;
1022 int32_t *mRsmpOutBuffer;
1023 int16_t *mRsmpInBuffer;
1024 size_t mRsmpInIndex;
1025 size_t mInputBytes;
Glenn Kastendc3ac852012-01-25 15:28:08 -08001026 const int mReqChannelCount;
1027 const uint32_t mReqSampleRate;
Eric Laurent9cc489a22009-12-05 05:20:01 -08001028 ssize_t mBytesRead;
Eric Laurenta553c252009-07-17 12:17:14 -07001029 };
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001030
1031 class RecordHandle : public android::BnAudioRecord {
1032 public:
Eric Laurenta553c252009-07-17 12:17:14 -07001033 RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001034 virtual ~RecordHandle();
Glenn Kasten0ae4d972012-01-26 13:40:12 -08001035 virtual sp<IMemory> getCblk() const;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001036 virtual status_t start();
1037 virtual void stop();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001038 virtual status_t onTransact(
1039 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
1040 private:
Glenn Kastendc3ac852012-01-25 15:28:08 -08001041 const sp<RecordThread::RecordTrack> mRecordTrack;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001042 };
1043
Eric Laurent65b65452010-06-01 23:49:17 -07001044 //--- Audio Effect Management
1045
1046 // EffectModule and EffectChain classes both have their own mutex to protect
1047 // state changes or resource modifications. Always respect the following order
1048 // if multiple mutexes must be acquired to avoid cross deadlock:
1049 // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule
1050
1051 // The EffectModule class is a wrapper object controlling the effect engine implementation
1052 // in the effect library. It prevents concurrent calls to process() and command() functions
1053 // from different client threads. It keeps a list of EffectHandle objects corresponding
1054 // to all client applications using this effect and notifies applications of effect state,
1055 // control or parameter changes. It manages the activation state machine to send appropriate
1056 // reset, enable, disable commands to effect engine and provide volume
1057 // ramping when effects are activated/deactivated.
1058 // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by
1059 // the attached track(s) to accumulate their auxiliary channel.
1060 class EffectModule: public RefBase {
1061 public:
1062 EffectModule(const wp<ThreadBase>& wThread,
1063 const wp<AudioFlinger::EffectChain>& chain,
1064 effect_descriptor_t *desc,
1065 int id,
1066 int sessionId);
1067 ~EffectModule();
1068
1069 enum effect_state {
1070 IDLE,
Eric Laurent7d850f22010-07-09 13:34:17 -07001071 RESTART,
Eric Laurent65b65452010-06-01 23:49:17 -07001072 STARTING,
1073 ACTIVE,
1074 STOPPING,
Eric Laurent21b5c472011-07-26 20:54:46 -07001075 STOPPED,
1076 DESTROYED
Eric Laurent65b65452010-06-01 23:49:17 -07001077 };
1078
1079 int id() { return mId; }
1080 void process();
Eric Laurent7d850f22010-07-09 13:34:17 -07001081 void updateState();
Eric Laurenta4c72ac2010-07-28 05:40:18 -07001082 status_t command(uint32_t cmdCode,
1083 uint32_t cmdSize,
1084 void *pCmdData,
1085 uint32_t *replySize,
1086 void *pReplyData);
Eric Laurent65b65452010-06-01 23:49:17 -07001087
Eric Laurentdf9b81c2010-07-02 08:12:41 -07001088 void reset_l();
Eric Laurent65b65452010-06-01 23:49:17 -07001089 status_t configure();
1090 status_t init();
Glenn Kasten452d6d62012-01-26 13:43:46 -08001091 effect_state state() const {
Eric Laurent65b65452010-06-01 23:49:17 -07001092 return mState;
1093 }
1094 uint32_t status() {
1095 return mStatus;
1096 }
Eric Laurent8ed6ed02010-07-13 04:45:46 -07001097 int sessionId() {
1098 return mSessionId;
1099 }
Eric Laurent65b65452010-06-01 23:49:17 -07001100 status_t setEnabled(bool enabled);
1101 bool isEnabled();
Eric Laurenta92ebfa2010-08-31 13:50:07 -07001102 bool isProcessEnabled();
Eric Laurent65b65452010-06-01 23:49:17 -07001103
1104 void setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; }
1105 int16_t *inBuffer() { return mConfig.inputCfg.buffer.s16; }
1106 void setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; }
1107 int16_t *outBuffer() { return mConfig.outputCfg.buffer.s16; }
Eric Laurent8ed6ed02010-07-13 04:45:46 -07001108 void setChain(const wp<EffectChain>& chain) { mChain = chain; }
1109 void setThread(const wp<ThreadBase>& thread) { mThread = thread; }
Glenn Kastendc3ac852012-01-25 15:28:08 -08001110 const wp<ThreadBase>& thread() { return mThread; }
Eric Laurent65b65452010-06-01 23:49:17 -07001111
Glenn Kasten1f812f72012-01-30 10:15:48 -08001112 status_t addHandle(const sp<EffectHandle>& handle);
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001113 void disconnect(const wp<EffectHandle>& handle, bool unpiniflast);
Eric Laurent65b65452010-06-01 23:49:17 -07001114 size_t removeHandle (const wp<EffectHandle>& handle);
1115
1116 effect_descriptor_t& desc() { return mDescriptor; }
Eric Laurent53334cd2010-06-23 17:38:20 -07001117 wp<EffectChain>& chain() { return mChain; }
Eric Laurent65b65452010-06-01 23:49:17 -07001118
1119 status_t setDevice(uint32_t device);
1120 status_t setVolume(uint32_t *left, uint32_t *right, bool controller);
Glenn Kastenaccb1142012-01-04 11:00:47 -08001121 status_t setMode(audio_mode_t mode);
Eric Laurent6fccbd02011-10-05 17:42:25 -07001122 status_t start();
Eric Laurent21b5c472011-07-26 20:54:46 -07001123 status_t stop();
Eric Laurentf82fccd2011-07-27 19:49:51 -07001124 void setSuspended(bool suspended);
Glenn Kasten1dce8412012-01-04 11:01:11 -08001125 bool suspended() const;
Eric Laurentf82fccd2011-07-27 19:49:51 -07001126
1127 sp<EffectHandle> controlHandle();
Eric Laurent65b65452010-06-01 23:49:17 -07001128
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001129 bool isPinned() { return mPinned; }
1130 void unPin() { mPinned = false; }
1131
Eric Laurent65b65452010-06-01 23:49:17 -07001132 status_t dump(int fd, const Vector<String16>& args);
1133
1134 protected:
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001135 friend class EffectHandle;
1136 friend class AudioFlinger;
1137 bool mPinned;
Eric Laurent65b65452010-06-01 23:49:17 -07001138
Eric Laurent7d850f22010-07-09 13:34:17 -07001139 // Maximum time allocated to effect engines to complete the turn off sequence
1140 static const uint32_t MAX_DISABLE_TIME_MS = 10000;
1141
Eric Laurent65b65452010-06-01 23:49:17 -07001142 EffectModule(const EffectModule&);
1143 EffectModule& operator = (const EffectModule&);
1144
Eric Laurentdf9b81c2010-07-02 08:12:41 -07001145 status_t start_l();
1146 status_t stop_l();
Eric Laurent65b65452010-06-01 23:49:17 -07001147
Glenn Kasten1dce8412012-01-04 11:01:11 -08001148mutable Mutex mLock; // mutex for process, commands and handles list protection
Eric Laurent65b65452010-06-01 23:49:17 -07001149 wp<ThreadBase> mThread; // parent thread
1150 wp<EffectChain> mChain; // parent effect chain
1151 int mId; // this instance unique ID
1152 int mSessionId; // audio session ID
1153 effect_descriptor_t mDescriptor;// effect descriptor received from effect engine
1154 effect_config_t mConfig; // input and output audio configuration
Eric Laurent0fb66c22011-05-17 19:16:02 -07001155 effect_handle_t mEffectInterface; // Effect module C API
Glenn Kasten452d6d62012-01-26 13:43:46 -08001156 status_t mStatus; // initialization status
1157 effect_state mState; // current activation state
Eric Laurent65b65452010-06-01 23:49:17 -07001158 Vector< wp<EffectHandle> > mHandles; // list of client handles
Eric Laurent7d850f22010-07-09 13:34:17 -07001159 uint32_t mMaxDisableWaitCnt; // maximum grace period before forcing an effect off after
1160 // sending disable command.
1161 uint32_t mDisableWaitCnt; // current process() calls count during disable period.
Eric Laurentf82fccd2011-07-27 19:49:51 -07001162 bool mSuspended; // effect is suspended: temporarily disabled by framework
Eric Laurent65b65452010-06-01 23:49:17 -07001163 };
1164
1165 // The EffectHandle class implements the IEffect interface. It provides resources
1166 // to receive parameter updates, keeps track of effect control
1167 // ownership and state and has a pointer to the EffectModule object it is controlling.
1168 // There is one EffectHandle object for each application controlling (or using)
1169 // an effect module.
1170 // The EffectHandle is obtained by calling AudioFlinger::createEffect().
1171 class EffectHandle: public android::BnEffect {
1172 public:
1173
1174 EffectHandle(const sp<EffectModule>& effect,
1175 const sp<AudioFlinger::Client>& client,
1176 const sp<IEffectClient>& effectClient,
1177 int32_t priority);
1178 virtual ~EffectHandle();
1179
1180 // IEffect
1181 virtual status_t enable();
1182 virtual status_t disable();
Eric Laurenta4c72ac2010-07-28 05:40:18 -07001183 virtual status_t command(uint32_t cmdCode,
1184 uint32_t cmdSize,
1185 void *pCmdData,
1186 uint32_t *replySize,
1187 void *pReplyData);
Eric Laurent65b65452010-06-01 23:49:17 -07001188 virtual void disconnect();
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001189 virtual void disconnect(bool unpiniflast);
Eric Laurent65b65452010-06-01 23:49:17 -07001190 virtual sp<IMemory> getCblk() const;
1191 virtual status_t onTransact(uint32_t code, const Parcel& data,
1192 Parcel* reply, uint32_t flags);
1193
1194
1195 // Give or take control of effect module
Eric Laurentf82fccd2011-07-27 19:49:51 -07001196 // - hasControl: true if control is given, false if removed
1197 // - signal: true client app should be signaled of change, false otherwise
1198 // - enabled: state of the effect when control is passed
1199 void setControl(bool hasControl, bool signal, bool enabled);
Eric Laurenta4c72ac2010-07-28 05:40:18 -07001200 void commandExecuted(uint32_t cmdCode,
1201 uint32_t cmdSize,
1202 void *pCmdData,
1203 uint32_t replySize,
1204 void *pReplyData);
Eric Laurent65b65452010-06-01 23:49:17 -07001205 void setEnabled(bool enabled);
Eric Laurentf82fccd2011-07-27 19:49:51 -07001206 bool enabled() { return mEnabled; }
Eric Laurent65b65452010-06-01 23:49:17 -07001207
1208 // Getters
1209 int id() { return mEffect->id(); }
1210 int priority() { return mPriority; }
1211 bool hasControl() { return mHasControl; }
1212 sp<EffectModule> effect() { return mEffect; }
1213
1214 void dump(char* buffer, size_t size);
1215
1216 protected:
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001217 friend class AudioFlinger;
1218 friend class EffectModule;
Eric Laurent65b65452010-06-01 23:49:17 -07001219 EffectHandle(const EffectHandle&);
1220 EffectHandle& operator =(const EffectHandle&);
1221
1222 sp<EffectModule> mEffect; // pointer to controlled EffectModule
1223 sp<IEffectClient> mEffectClient; // callback interface for client notifications
1224 sp<Client> mClient; // client for shared memory allocation
1225 sp<IMemory> mCblkMemory; // shared memory for control block
1226 effect_param_cblk_t* mCblk; // control block for deferred parameter setting via shared memory
1227 uint8_t* mBuffer; // pointer to parameter area in shared memory
1228 int mPriority; // client application priority to control the effect
1229 bool mHasControl; // true if this handle is controlling the effect
Eric Laurentf82fccd2011-07-27 19:49:51 -07001230 bool mEnabled; // cached enable state: needed when the effect is
1231 // restored after being suspended
Eric Laurent65b65452010-06-01 23:49:17 -07001232 };
1233
1234 // the EffectChain class represents a group of effects associated to one audio session.
1235 // There can be any number of EffectChain objects per output mixer thread (PlaybackThread).
1236 // The EffecChain with session ID 0 contains global effects applied to the output mix.
1237 // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks)
1238 // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding
1239 // in the effect process order. When attached to a track (session ID != 0), it also provide it's own
1240 // input buffer used by the track as accumulation buffer.
1241 class EffectChain: public RefBase {
1242 public:
1243 EffectChain(const wp<ThreadBase>& wThread, int sessionId);
1244 ~EffectChain();
1245
Eric Laurentf82fccd2011-07-27 19:49:51 -07001246 // special key used for an entry in mSuspendedEffects keyed vector
1247 // corresponding to a suspend all request.
1248 static const int kKeyForSuspendAll = 0;
1249
Eric Laurentf9c361d2011-11-11 15:42:52 -08001250 // minimum duration during which we force calling effect process when last track on
1251 // a session is stopped or removed to allow effect tail to be rendered
1252 static const int kProcessTailDurationMs = 1000;
1253
Eric Laurent65b65452010-06-01 23:49:17 -07001254 void process_l();
1255
1256 void lock() {
1257 mLock.lock();
1258 }
1259 void unlock() {
1260 mLock.unlock();
1261 }
1262
Eric Laurent8ed6ed02010-07-13 04:45:46 -07001263 status_t addEffect_l(const sp<EffectModule>& handle);
Eric Laurent76c40f72010-07-15 12:50:15 -07001264 size_t removeEffect_l(const sp<EffectModule>& handle);
Eric Laurent65b65452010-06-01 23:49:17 -07001265
Eric Laurent464d5b32011-06-17 21:29:58 -07001266 int sessionId() { return mSessionId; }
1267 void setSessionId(int sessionId) { mSessionId = sessionId; }
Eric Laurent8ed6ed02010-07-13 04:45:46 -07001268
Eric Laurent76c40f72010-07-15 12:50:15 -07001269 sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor);
1270 sp<EffectModule> getEffectFromId_l(int id);
Eric Laurentf82fccd2011-07-27 19:49:51 -07001271 sp<EffectModule> getEffectFromType_l(const effect_uuid_t *type);
Eric Laurent76c40f72010-07-15 12:50:15 -07001272 bool setVolume_l(uint32_t *left, uint32_t *right);
1273 void setDevice_l(uint32_t device);
Glenn Kastenaccb1142012-01-04 11:00:47 -08001274 void setMode_l(audio_mode_t mode);
Eric Laurent53334cd2010-06-23 17:38:20 -07001275
Eric Laurent65b65452010-06-01 23:49:17 -07001276 void setInBuffer(int16_t *buffer, bool ownsBuffer = false) {
1277 mInBuffer = buffer;
1278 mOwnInBuffer = ownsBuffer;
1279 }
1280 int16_t *inBuffer() {
1281 return mInBuffer;
1282 }
1283 void setOutBuffer(int16_t *buffer) {
1284 mOutBuffer = buffer;
1285 }
1286 int16_t *outBuffer() {
1287 return mOutBuffer;
1288 }
1289
Eric Laurent90681d62011-05-09 12:09:06 -07001290 void incTrackCnt() { android_atomic_inc(&mTrackCnt); }
1291 void decTrackCnt() { android_atomic_dec(&mTrackCnt); }
1292 int32_t trackCnt() { return mTrackCnt;}
1293
Eric Laurentf9c361d2011-11-11 15:42:52 -08001294 void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt);
1295 mTailBufferCount = mMaxTailBuffers; }
Eric Laurent90681d62011-05-09 12:09:06 -07001296 void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); }
1297 int32_t activeTrackCnt() { return mActiveTrackCnt;}
Eric Laurent65b65452010-06-01 23:49:17 -07001298
Eric Laurent8ed6ed02010-07-13 04:45:46 -07001299 uint32_t strategy() { return mStrategy; }
1300 void setStrategy(uint32_t strategy)
1301 { mStrategy = strategy; }
1302
Eric Laurentf82fccd2011-07-27 19:49:51 -07001303 // suspend effect of the given type
1304 void setEffectSuspended_l(const effect_uuid_t *type,
1305 bool suspend);
1306 // suspend all eligible effects
1307 void setEffectSuspendedAll_l(bool suspend);
1308 // check if effects should be suspend or restored when a given effect is enable or disabled
Eric Laurent7fa1cee2011-10-19 11:44:54 -07001309 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect,
Eric Laurentf82fccd2011-07-27 19:49:51 -07001310 bool enabled);
1311
Eric Laurent65b65452010-06-01 23:49:17 -07001312 status_t dump(int fd, const Vector<String16>& args);
1313
1314 protected:
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001315 friend class AudioFlinger;
Eric Laurent65b65452010-06-01 23:49:17 -07001316 EffectChain(const EffectChain&);
1317 EffectChain& operator =(const EffectChain&);
1318
Eric Laurentf82fccd2011-07-27 19:49:51 -07001319 class SuspendedEffectDesc : public RefBase {
1320 public:
1321 SuspendedEffectDesc() : mRefCount(0) {}
1322
1323 int mRefCount;
1324 effect_uuid_t mType;
1325 wp<EffectModule> mEffect;
1326 };
1327
1328 // get a list of effect modules to suspend when an effect of the type
1329 // passed is enabled.
Glenn Kasten97040262012-01-30 12:56:03 -08001330 void getSuspendEligibleEffects(Vector< sp<EffectModule> > &effects);
1331
Eric Laurentf82fccd2011-07-27 19:49:51 -07001332 // get an effect module if it is currently enable
1333 sp<EffectModule> getEffectIfEnabled(const effect_uuid_t *type);
Eric Laurent6752ec82011-08-10 10:37:50 -07001334 // true if the effect whose descriptor is passed can be suspended
1335 // OEMs can modify the rules implemented in this method to exclude specific effect
1336 // types or implementations from the suspend/restore mechanism.
1337 bool isEffectEligibleForSuspend(const effect_descriptor_t& desc);
Eric Laurentf82fccd2011-07-27 19:49:51 -07001338
Eric Laurent65b65452010-06-01 23:49:17 -07001339 wp<ThreadBase> mThread; // parent mixer thread
1340 Mutex mLock; // mutex protecting effect list
1341 Vector<sp<EffectModule> > mEffects; // list of effect modules
1342 int mSessionId; // audio session ID
1343 int16_t *mInBuffer; // chain input buffer
1344 int16_t *mOutBuffer; // chain output buffer
Eric Laurent90681d62011-05-09 12:09:06 -07001345 volatile int32_t mActiveTrackCnt; // number of active tracks connected
1346 volatile int32_t mTrackCnt; // number of tracks connected
Eric Laurentf9c361d2011-11-11 15:42:52 -08001347 int32_t mTailBufferCount; // current effect tail buffer count
1348 int32_t mMaxTailBuffers; // maximum effect tail buffers
Eric Laurent65b65452010-06-01 23:49:17 -07001349 bool mOwnInBuffer; // true if the chain owns its input buffer
Eric Laurent76c40f72010-07-15 12:50:15 -07001350 int mVolumeCtrlIdx; // index of insert effect having control over volume
1351 uint32_t mLeftVolume; // previous volume on left channel
1352 uint32_t mRightVolume; // previous volume on right channel
Eric Laurent0d7e0482010-07-19 06:24:46 -07001353 uint32_t mNewLeftVolume; // new volume on left channel
1354 uint32_t mNewRightVolume; // new volume on right channel
Eric Laurent8ed6ed02010-07-13 04:45:46 -07001355 uint32_t mStrategy; // strategy for this effect chain
Eric Laurentf82fccd2011-07-27 19:49:51 -07001356 // mSuspendedEffects lists all effect currently suspended in the chain
1357 // use effect type UUID timelow field as key. There is no real risk of identical
1358 // timeLow fields among effect type UUIDs.
1359 KeyedVector< int, sp<SuspendedEffectDesc> > mSuspendedEffects;
Eric Laurent65b65452010-06-01 23:49:17 -07001360 };
1361
Glenn Kasten5b0135e2012-01-26 09:46:34 -08001362 // AudioStreamOut and AudioStreamIn are immutable, so their fields are const.
1363 // For emphasis, we could also make all pointers to them be "const *",
1364 // but that would clutter the code unnecessarily.
1365
Dima Zavin31f188892011-04-18 16:57:27 -07001366 struct AudioStreamOut {
Glenn Kasten5b0135e2012-01-26 09:46:34 -08001367 audio_hw_device_t* const hwDev;
1368 audio_stream_out_t* const stream;
Dima Zavin31f188892011-04-18 16:57:27 -07001369
1370 AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) :
1371 hwDev(dev), stream(out) {}
1372 };
1373
1374 struct AudioStreamIn {
Glenn Kasten5b0135e2012-01-26 09:46:34 -08001375 audio_hw_device_t* const hwDev;
1376 audio_stream_in_t* const stream;
Dima Zavin31f188892011-04-18 16:57:27 -07001377
1378 AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) :
1379 hwDev(dev), stream(in) {}
1380 };
1381
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001382 struct AudioSessionRef {
Glenn Kastendc3ac852012-01-25 15:28:08 -08001383 // FIXME rename parameter names when fields get "m" prefix
1384 AudioSessionRef(int sessionid_, pid_t pid_) :
1385 sessionid(sessionid_), pid(pid_), cnt(1) {}
1386 const int sessionid;
1387 const pid_t pid;
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001388 int cnt;
1389 };
1390
Eric Laurenta553c252009-07-17 12:17:14 -07001391 friend class RecordThread;
1392 friend class PlaybackThread;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001393
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001394 mutable Mutex mLock;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001395
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001396 DefaultKeyedVector< pid_t, wp<Client> > mClients;
1397
Eric Laurenta553c252009-07-17 12:17:14 -07001398 mutable Mutex mHardwareLock;
Dima Zavin31f188892011-04-18 16:57:27 -07001399 audio_hw_device_t* mPrimaryHardwareDev;
1400 Vector<audio_hw_device_t*> mAudioHwDevs;
Glenn Kastena934c2c2012-01-04 11:02:33 -08001401 mutable hardware_call_state mHardwareStatus; // for dump only
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07001402
Eric Laurenta553c252009-07-17 12:17:14 -07001403
Eric Laurentddb78e72009-07-28 08:44:33 -07001404 DefaultKeyedVector< int, sp<PlaybackThread> > mPlaybackThreads;
Dima Zavin24fc2fb2011-04-19 22:30:36 -07001405 PlaybackThread::stream_type_t mStreamTypes[AUDIO_STREAM_CNT];
Glenn Kastene6f8a422011-12-13 11:47:54 -08001406
1407 // both are protected by mLock
Eric Laurenta553c252009-07-17 12:17:14 -07001408 float mMasterVolume;
1409 bool mMasterMute;
1410
Eric Laurentddb78e72009-07-28 08:44:33 -07001411 DefaultKeyedVector< int, sp<RecordThread> > mRecordThreads;
Eric Laurenta553c252009-07-17 12:17:14 -07001412
Eric Laurent4f0f17d2010-05-12 02:05:53 -07001413 DefaultKeyedVector< pid_t, sp<NotificationClient> > mNotificationClients;
Eric Laurent65b65452010-06-01 23:49:17 -07001414 volatile int32_t mNextUniqueId;
Glenn Kastenaccb1142012-01-04 11:00:47 -08001415 audio_mode_t mMode;
Eric Laurent2d95dfb2011-08-29 12:42:48 -07001416 bool mBtNrecIsOff;
Eric Laurent53334cd2010-06-23 17:38:20 -07001417
Marco Nelissenc74b93f2011-08-02 13:33:41 -07001418 Vector<AudioSessionRef*> mAudioSessionRefs;
Glenn Kastene6f8a422011-12-13 11:47:54 -08001419
1420 float masterVolume_l() const { return mMasterVolume; }
1421 bool masterMute_l() const { return mMasterMute; }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001422};
1423
Dima Zavin31f188892011-04-18 16:57:27 -07001424
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001425// ----------------------------------------------------------------------------
1426
1427}; // namespace android
1428
1429#endif // ANDROID_AUDIO_FLINGER_H