AudioFlinger.h revision aeeb7e219e34d2d657d829913659a4e10e976375 
1/* //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>
23#include <limits.h>
24
25#include <media/IAudioFlinger.h>
26#include <media/IAudioFlingerClient.h>
27#include <media/IAudioTrack.h>
28#include <media/IAudioRecord.h>
29#include <media/AudioTrack.h>
30
31#include <utils/Atomic.h>
32#include <utils/Errors.h>
33#include <utils/threads.h>
34#include <utils/SortedVector.h>
35#include <utils/TypeHelpers.h>
36#include <utils/Vector.h>
37
38#include <binder/BinderService.h>
39#include <binder/MemoryDealer.h>
40
41#include <system/audio.h>
42#include <hardware/audio.h>
43
44#include "AudioBufferProvider.h"
45
46#include <powermanager/IPowerManager.h>
47
48namespace android {
49
50class audio_track_cblk_t;
51class effect_param_cblk_t;
52class AudioMixer;
53class AudioBuffer;
54class AudioResampler;
55
56// ----------------------------------------------------------------------------
57
58static const nsecs_t kStandbyTimeInNsecs = seconds(3);
59
60class AudioFlinger :
61    public BinderService<AudioFlinger>,
62    public BnAudioFlinger
63{
64    friend class BinderService<AudioFlinger>;
65public:
66    static const char* getServiceName() { return "media.audio_flinger"; }
67
68    virtual     status_t    dump(int fd, const Vector<String16>& args);
69
70    // IAudioFlinger interface
71    virtual sp<IAudioTrack> createTrack(
72                                pid_t pid,
73                                audio_stream_type_t streamType,
74                                uint32_t sampleRate,
75                                uint32_t format,
76                                uint32_t channelMask,
77                                int frameCount,
78                                uint32_t flags,
79                                const sp<IMemory>& sharedBuffer,
80                                int output,
81                                int *sessionId,
82                                status_t *status);
83
84    virtual     uint32_t    sampleRate(int output) const;
85    virtual     int         channelCount(int output) const;
86    virtual     uint32_t    format(int output) const;
87    virtual     size_t      frameCount(int output) const;
88    virtual     uint32_t    latency(int output) const;
89
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
96    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);
98
99    virtual     float       streamVolume(audio_stream_type_t stream, int output) const;
100    virtual     bool        streamMute(audio_stream_type_t stream) const;
101
102    virtual     status_t    setMode(audio_mode_t mode);
103
104    virtual     status_t    setMicMute(bool state);
105    virtual     bool        getMicMute() const;
106
107    virtual     status_t    setParameters(int ioHandle, const String8& keyValuePairs);
108    virtual     String8     getParameters(int ioHandle, const String8& keys);
109
110    virtual     void        registerClient(const sp<IAudioFlingerClient>& client);
111
112    virtual     size_t      getInputBufferSize(uint32_t sampleRate, int format, int channelCount);
113    virtual     unsigned int  getInputFramesLost(int ioHandle);
114
115    virtual int openOutput(uint32_t *pDevices,
116                                    uint32_t *pSamplingRate,
117                                    uint32_t *pFormat,
118                                    uint32_t *pChannels,
119                                    uint32_t *pLatencyMs,
120                                    uint32_t flags);
121
122    virtual int openDuplicateOutput(int output1, int output2);
123
124    virtual status_t closeOutput(int output);
125
126    virtual status_t suspendOutput(int output);
127
128    virtual status_t restoreOutput(int output);
129
130    virtual int openInput(uint32_t *pDevices,
131                            uint32_t *pSamplingRate,
132                            uint32_t *pFormat,
133                            uint32_t *pChannels,
134                            uint32_t acoustics);
135
136    virtual status_t closeInput(int input);
137
138    virtual status_t setStreamOutput(audio_stream_type_t stream, int output);
139
140    virtual status_t setVoiceVolume(float volume);
141
142    virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, int output);
143
144    virtual int newAudioSessionId();
145
146    virtual void acquireAudioSessionId(int audioSession);
147
148    virtual void releaseAudioSessionId(int audioSession);
149
150    virtual status_t queryNumberEffects(uint32_t *numEffects);
151
152    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor);
153
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,
160                        int io,
161                        int sessionId,
162                        status_t *status,
163                        int *id,
164                        int *enabled);
165
166    virtual status_t moveEffects(int sessionId, int srcOutput, int dstOutput);
167
168    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,
190                                int input,
191                                uint32_t sampleRate,
192                                uint32_t format,
193                                uint32_t channelMask,
194                                int frameCount,
195                                uint32_t flags,
196                                int *sessionId,
197                                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
205               audio_mode_t getMode() const { return mMode; }
206
207                bool        btNrecIsOff() { return mBtNrecIsOff; }
208
209private:
210                            AudioFlinger();
211    virtual                 ~AudioFlinger();
212
213    status_t                initCheck() const;
214    virtual     void        onFirstRef();
215    audio_hw_device_t*      findSuitableHwDev_l(uint32_t devices);
216    void                    purgeStaleEffects_l();
217
218    // Internal dump utilites.
219    status_t dumpPermissionDenial(int fd, const Vector<String16>& args);
220    status_t dumpClients(int fd, const Vector<String16>& args);
221    status_t dumpInternals(int fd, const Vector<String16>& args);
222
223    // --- Client ---
224    class Client : public RefBase {
225    public:
226                            Client(const sp<AudioFlinger>& audioFlinger, pid_t pid);
227        virtual             ~Client();
228        const sp<MemoryDealer>&     heap() const;
229        pid_t               pid() const { return mPid; }
230        sp<AudioFlinger>    audioFlinger() { return mAudioFlinger; }
231
232    private:
233                            Client(const Client&);
234                            Client& operator = (const Client&);
235        sp<AudioFlinger>    mAudioFlinger;
236        sp<MemoryDealer>    mMemoryDealer;
237        pid_t               mPid;
238    };
239
240    // --- Notification Client ---
241    class NotificationClient : public IBinder::DeathRecipient {
242    public:
243                            NotificationClient(const sp<AudioFlinger>& audioFlinger,
244                                                const sp<IAudioFlingerClient>& client,
245                                                pid_t pid);
246        virtual             ~NotificationClient();
247
248                sp<IAudioFlingerClient>    client() { return mClient; }
249
250                // IBinder::DeathRecipient
251                virtual     void        binderDied(const wp<IBinder>& who);
252
253    private:
254                            NotificationClient(const NotificationClient&);
255                            NotificationClient& operator = (const NotificationClient&);
256
257        sp<AudioFlinger>        mAudioFlinger;
258        pid_t                   mPid;
259        sp<IAudioFlingerClient> mClient;
260    };
261
262    class TrackHandle;
263    class RecordHandle;
264    class RecordThread;
265    class PlaybackThread;
266    class MixerThread;
267    class DirectOutputThread;
268    class DuplicatingThread;
269    class Track;
270    class RecordTrack;
271    class EffectModule;
272    class EffectHandle;
273    class EffectChain;
274    struct AudioStreamOut;
275    struct AudioStreamIn;
276
277    class ThreadBase : public Thread {
278    public:
279        ThreadBase (const sp<AudioFlinger>& audioFlinger, int id, uint32_t device);
280        virtual             ~ThreadBase();
281
282
283        enum type {
284            MIXER,              // Thread class is MixerThread
285            DIRECT,             // Thread class is DirectOutputThread
286            DUPLICATING,        // Thread class is DuplicatingThread
287            RECORD              // Thread class is RecordThread
288        };
289
290        status_t dumpBase(int fd, const Vector<String16>& args);
291        status_t dumpEffectChains(int fd, const Vector<String16>& args);
292
293        void clearPowerManager();
294
295        // base for record and playback
296        class TrackBase : public AudioBufferProvider, public RefBase {
297
298        public:
299            enum track_state {
300                IDLE,
301                TERMINATED,
302                STOPPED,
303                RESUMING,
304                ACTIVE,
305                PAUSING,
306                PAUSED
307            };
308
309            enum track_flags {
310                STEPSERVER_FAILED = 0x01, //  StepServer could not acquire cblk->lock mutex
311                SYSTEM_FLAGS_MASK = 0x0000ffffUL,
312                // The upper 16 bits are used for track-specific flags.
313            };
314
315                                TrackBase(const wp<ThreadBase>& thread,
316                                        const sp<Client>& client,
317                                        uint32_t sampleRate,
318                                        uint32_t format,
319                                        uint32_t channelMask,
320                                        int frameCount,
321                                        uint32_t flags,
322                                        const sp<IMemory>& sharedBuffer,
323                                        int sessionId);
324                                ~TrackBase();
325
326            virtual status_t    start() = 0;
327            virtual void        stop() = 0;
328                    sp<IMemory> getCblk() const;
329                    audio_track_cblk_t* cblk() const { return mCblk; }
330                    int         sessionId() { return mSessionId; }
331
332        protected:
333            friend class ThreadBase;
334            friend class RecordHandle;
335            friend class PlaybackThread;
336            friend class RecordThread;
337            friend class MixerThread;
338            friend class DirectOutputThread;
339
340                                TrackBase(const TrackBase&);
341                                TrackBase& operator = (const TrackBase&);
342
343            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0;
344            virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
345
346            uint32_t format() const {
347                return mFormat;
348            }
349
350            int channelCount() const ;
351
352            uint32_t channelMask() const;
353
354            int sampleRate() const;
355
356            void* getBuffer(uint32_t offset, uint32_t frames) const;
357
358            bool isStopped() const {
359                return mState == STOPPED;
360            }
361
362            bool isTerminated() const {
363                return mState == TERMINATED;
364            }
365
366            bool step();
367            void reset();
368
369            wp<ThreadBase>      mThread;
370            sp<Client>          mClient;
371            sp<IMemory>         mCblkMemory;
372            audio_track_cblk_t* mCblk;
373            void*               mBuffer;
374            void*               mBufferEnd;
375            uint32_t            mFrameCount;
376            // we don't really need a lock for these
377            int                 mState;
378            int                 mClientTid;
379            uint32_t            mFormat;
380            uint32_t            mFlags;
381            int                 mSessionId;
382            uint8_t             mChannelCount;
383            uint32_t            mChannelMask;
384        };
385
386        class ConfigEvent {
387        public:
388            ConfigEvent() : mEvent(0), mParam(0) {}
389
390            int mEvent;
391            int mParam;
392        };
393
394        class PMDeathRecipient : public IBinder::DeathRecipient {
395        public:
396                        PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {}
397            virtual     ~PMDeathRecipient() {}
398
399            // IBinder::DeathRecipient
400            virtual     void        binderDied(const wp<IBinder>& who);
401
402        private:
403                        PMDeathRecipient(const PMDeathRecipient&);
404                        PMDeathRecipient& operator = (const PMDeathRecipient&);
405
406            wp<ThreadBase> mThread;
407        };
408
409        virtual     status_t    initCheck() const = 0;
410                    int         type() const { return mType; }
411                    uint32_t    sampleRate() const;
412                    int         channelCount() const;
413                    uint32_t    format() const;
414                    size_t      frameCount() const;
415                    void        wakeUp()    { mWaitWorkCV.broadcast(); }
416                    void        exit();
417        virtual     bool        checkForNewParameters_l() = 0;
418        virtual     status_t    setParameters(const String8& keyValuePairs);
419        virtual     String8     getParameters(const String8& keys) = 0;
420        virtual     void        audioConfigChanged_l(int event, int param = 0) = 0;
421                    void        sendConfigEvent(int event, int param = 0);
422                    void        sendConfigEvent_l(int event, int param = 0);
423                    void        processConfigEvents();
424                    int         id() const { return mId;}
425                    bool        standby() { return mStandby; }
426                    uint32_t    device() { return mDevice; }
427        virtual     audio_stream_t* stream() = 0;
428
429                    sp<EffectHandle> createEffect_l(
430                                        const sp<AudioFlinger::Client>& client,
431                                        const sp<IEffectClient>& effectClient,
432                                        int32_t priority,
433                                        int sessionId,
434                                        effect_descriptor_t *desc,
435                                        int *enabled,
436                                        status_t *status);
437                    void disconnectEffect(const sp< EffectModule>& effect,
438                                          const wp<EffectHandle>& handle,
439                                          bool unpiniflast);
440
441                    // return values for hasAudioSession (bit field)
442                    enum effect_state {
443                        EFFECT_SESSION = 0x1,   // the audio session corresponds to at least one
444                                                // effect
445                        TRACK_SESSION = 0x2     // the audio session corresponds to at least one
446                                                // track
447                    };
448
449                    // get effect chain corresponding to session Id.
450                    sp<EffectChain> getEffectChain(int sessionId);
451                    // same as getEffectChain() but must be called with ThreadBase mutex locked
452                    sp<EffectChain> getEffectChain_l(int sessionId);
453                    // add an effect chain to the chain list (mEffectChains)
454        virtual     status_t addEffectChain_l(const sp<EffectChain>& chain) = 0;
455                    // remove an effect chain from the chain list (mEffectChains)
456        virtual     size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0;
457                    // lock mall effect chains Mutexes. Must be called before releasing the
458                    // ThreadBase mutex before processing the mixer and effects. This guarantees the
459                    // integrity of the chains during the process.
460                    void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains);
461                    // unlock effect chains after process
462                    void unlockEffectChains(Vector<sp <EffectChain> >& effectChains);
463                    // set audio mode to all effect chains
464                    void setMode(audio_mode_t mode);
465                    // get effect module with corresponding ID on specified audio session
466                    sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId);
467                    // add and effect module. Also creates the effect chain is none exists for
468                    // the effects audio session
469                    status_t addEffect_l(const sp< EffectModule>& effect);
470                    // remove and effect module. Also removes the effect chain is this was the last
471                    // effect
472                    void removeEffect_l(const sp< EffectModule>& effect);
473                    // detach all tracks connected to an auxiliary effect
474        virtual     void detachAuxEffect_l(int effectId) {}
475                    // returns either EFFECT_SESSION if effects on this audio session exist in one
476                    // chain, or TRACK_SESSION if tracks on this audio session exist, or both
477                    virtual uint32_t hasAudioSession(int sessionId) = 0;
478                    // the value returned by default implementation is not important as the
479                    // strategy is only meaningful for PlaybackThread which implements this method
480                    virtual uint32_t getStrategyForSession_l(int sessionId) { return 0; }
481
482                    // suspend or restore effect according to the type of effect passed. a NULL
483                    // type pointer means suspend all effects in the session
484                    void setEffectSuspended(const effect_uuid_t *type,
485                                            bool suspend,
486                                            int sessionId = AUDIO_SESSION_OUTPUT_MIX);
487                    // check if some effects must be suspended/restored when an effect is enabled
488                    // or disabled
489                    void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect,
490                                                     bool enabled,
491                                                     int sessionId = AUDIO_SESSION_OUTPUT_MIX);
492                    void checkSuspendOnEffectEnabled_l(const sp<EffectModule>& effect,
493                                                       bool enabled,
494                                                       int sessionId = AUDIO_SESSION_OUTPUT_MIX);
495        mutable     Mutex                   mLock;
496
497    protected:
498
499                    // entry describing an effect being suspended in mSuspendedSessions keyed vector
500                    class SuspendedSessionDesc : public RefBase {
501                    public:
502                        SuspendedSessionDesc() : mRefCount(0) {}
503
504                        int mRefCount;          // number of active suspend requests
505                        effect_uuid_t mType;    // effect type UUID
506                    };
507
508                    void        acquireWakeLock();
509                    void        acquireWakeLock_l();
510                    void        releaseWakeLock();
511                    void        releaseWakeLock_l();
512                    void setEffectSuspended_l(const effect_uuid_t *type,
513                                              bool suspend,
514                                              int sessionId = AUDIO_SESSION_OUTPUT_MIX);
515                    // updated mSuspendedSessions when an effect suspended or restored
516                    void        updateSuspendedSessions_l(const effect_uuid_t *type,
517                                                          bool suspend,
518                                                          int sessionId);
519                    // check if some effects must be suspended when an effect chain is added
520                    void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain);
521
522        friend class AudioFlinger;
523        friend class Track;
524        friend class TrackBase;
525        friend class PlaybackThread;
526        friend class MixerThread;
527        friend class DirectOutputThread;
528        friend class DuplicatingThread;
529        friend class RecordThread;
530        friend class RecordTrack;
531
532                    int                     mType;
533                    Condition               mWaitWorkCV;
534                    sp<AudioFlinger>        mAudioFlinger;
535                    uint32_t                mSampleRate;
536                    size_t                  mFrameCount;
537                    uint32_t                mChannelMask;
538                    uint16_t                mChannelCount;
539                    size_t                  mFrameSize;
540                    uint32_t                mFormat;
541                    Condition               mParamCond;
542                    Vector<String8>         mNewParameters;
543                    status_t                mParamStatus;
544                    Vector<ConfigEvent>     mConfigEvents;
545                    bool                    mStandby;
546                    int                     mId;
547                    bool                    mExiting;
548                    Vector< sp<EffectChain> > mEffectChains;
549                    uint32_t                mDevice;    // output device for PlaybackThread
550                                                        // input + output devices for RecordThread
551                    static const int        kNameLength = 32;
552                    char                    mName[kNameLength];
553                    sp<IPowerManager>       mPowerManager;
554                    sp<IBinder>             mWakeLockToken;
555                    sp<PMDeathRecipient>    mDeathRecipient;
556                    // list of suspended effects per session and per type. The first vector is
557                    // keyed by session ID, the second by type UUID timeLow field
558                    KeyedVector< int, KeyedVector< int, sp<SuspendedSessionDesc> > >  mSuspendedSessions;
559    };
560
561    // --- PlaybackThread ---
562    class PlaybackThread : public ThreadBase {
563    public:
564
565        enum mixer_state {
566            MIXER_IDLE,
567            MIXER_TRACKS_ENABLED,
568            MIXER_TRACKS_READY
569        };
570
571        // playback track
572        class Track : public TrackBase {
573        public:
574                                Track(  const wp<ThreadBase>& thread,
575                                        const sp<Client>& client,
576                                        audio_stream_type_t streamType,
577                                        uint32_t sampleRate,
578                                        uint32_t format,
579                                        uint32_t channelMask,
580                                        int frameCount,
581                                        const sp<IMemory>& sharedBuffer,
582                                        int sessionId);
583                                ~Track();
584
585                    void        dump(char* buffer, size_t size);
586            virtual status_t    start();
587            virtual void        stop();
588                    void        pause();
589
590                    void        flush();
591                    void        destroy();
592                    void        mute(bool);
593                    int name() const {
594                        return mName;
595                    }
596
597                    audio_stream_type_t type() const {
598                        return mStreamType;
599                    }
600                    status_t    attachAuxEffect(int EffectId);
601                    void        setAuxBuffer(int EffectId, int32_t *buffer);
602                    int32_t     *auxBuffer() { return mAuxBuffer; }
603                    void        setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; }
604                    int16_t     *mainBuffer() { return mMainBuffer; }
605                    int         auxEffectId() { return mAuxEffectId; }
606
607
608        protected:
609            friend class ThreadBase;
610            friend class TrackHandle;
611            friend class PlaybackThread;
612            friend class MixerThread;
613            friend class DirectOutputThread;
614
615                                Track(const Track&);
616                                Track& operator = (const Track&);
617
618            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
619            bool isMuted() { return mMute; }
620            bool isPausing() const {
621                return mState == PAUSING;
622            }
623            bool isPaused() const {
624                return mState == PAUSED;
625            }
626            bool isReady() const;
627            void setPaused() { mState = PAUSED; }
628            void reset();
629
630            bool isOutputTrack() const {
631                return (mStreamType == AUDIO_STREAM_CNT);
632            }
633
634            // we don't really need a lock for these
635            volatile bool       mMute;
636            // FILLED state is used for suppressing volume ramp at begin of playing
637            enum {FS_FILLING, FS_FILLED, FS_ACTIVE};
638            mutable uint8_t     mFillingUpStatus;
639            int8_t              mRetryCount;
640            sp<IMemory>         mSharedBuffer;
641            bool                mResetDone;
642            audio_stream_type_t mStreamType;
643            int                 mName;
644            int16_t             *mMainBuffer;
645            int32_t             *mAuxBuffer;
646            int                 mAuxEffectId;
647            bool                mHasVolumeController;
648        };  // end of Track
649
650
651        // playback track
652        class OutputTrack : public Track {
653        public:
654
655            class Buffer: public AudioBufferProvider::Buffer {
656            public:
657                int16_t *mBuffer;
658            };
659
660                                OutputTrack(  const wp<ThreadBase>& thread,
661                                        DuplicatingThread *sourceThread,
662                                        uint32_t sampleRate,
663                                        uint32_t format,
664                                        uint32_t channelMask,
665                                        int frameCount);
666                                ~OutputTrack();
667
668            virtual status_t    start();
669            virtual void        stop();
670                    bool        write(int16_t* data, uint32_t frames);
671                    bool        bufferQueueEmpty() { return (mBufferQueue.size() == 0) ? true : false; }
672                    bool        isActive() { return mActive; }
673            wp<ThreadBase>&     thread()  { return mThread; }
674
675        private:
676
677            status_t            obtainBuffer(AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs);
678            void                clearBufferQueue();
679
680            // Maximum number of pending buffers allocated by OutputTrack::write()
681            static const uint8_t kMaxOverFlowBuffers = 10;
682
683            Vector < Buffer* >          mBufferQueue;
684            AudioBufferProvider::Buffer mOutBuffer;
685            bool                        mActive;
686            DuplicatingThread*          mSourceThread;
687        };  // end of OutputTrack
688
689        PlaybackThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
690        virtual             ~PlaybackThread();
691
692        virtual     status_t    dump(int fd, const Vector<String16>& args);
693
694        // Thread virtuals
695        virtual     status_t    readyToRun();
696        virtual     void        onFirstRef();
697
698        virtual     status_t    initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; }
699
700        virtual     uint32_t    latency() const;
701
702        virtual     status_t    setMasterVolume(float value);
703        virtual     status_t    setMasterMute(bool muted);
704
705        virtual     float       masterVolume() const;
706        virtual     bool        masterMute() const;
707
708        virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value);
709        virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted);
710
711        virtual     float       streamVolume(audio_stream_type_t stream) const;
712        virtual     bool        streamMute(audio_stream_type_t stream) const;
713
714                    sp<Track>   createTrack_l(
715                                    const sp<AudioFlinger::Client>& client,
716                                    audio_stream_type_t streamType,
717                                    uint32_t sampleRate,
718                                    uint32_t format,
719                                    uint32_t channelMask,
720                                    int frameCount,
721                                    const sp<IMemory>& sharedBuffer,
722                                    int sessionId,
723                                    status_t *status);
724
725                    AudioStreamOut* getOutput();
726                    AudioStreamOut* clearOutput();
727                    virtual audio_stream_t* stream();
728
729                    void        suspend() { mSuspended++; }
730                    void        restore() { if (mSuspended) mSuspended--; }
731                    bool        isSuspended() const { return (mSuspended != 0); }
732        virtual     String8     getParameters(const String8& keys);
733        virtual     void        audioConfigChanged_l(int event, int param = 0);
734        virtual     status_t    getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames);
735                    int16_t     *mixBuffer() { return mMixBuffer; };
736
737        virtual     void detachAuxEffect_l(int effectId);
738                    status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track,
739                            int EffectId);
740                    status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track,
741                            int EffectId);
742
743                    virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
744                    virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
745                    virtual uint32_t hasAudioSession(int sessionId);
746                    virtual uint32_t getStrategyForSession_l(int sessionId);
747
748                            void setStreamValid(audio_stream_type_t streamType, bool valid);
749
750        struct  stream_type_t {
751            stream_type_t()
752                :   volume(1.0f),
753                    mute(false),
754                    valid(true)
755            {
756            }
757            float       volume;
758            bool        mute;
759            bool        valid;
760        };
761
762    protected:
763        int16_t*                        mMixBuffer;
764        int                             mSuspended;
765        int                             mBytesWritten;
766    private:
767        bool                            mMasterMute;
768    protected:
769        SortedVector< wp<Track> >       mActiveTracks;
770
771        virtual int             getTrackName_l() = 0;
772        virtual void            deleteTrackName_l(int name) = 0;
773        virtual uint32_t        activeSleepTimeUs();
774        virtual uint32_t        idleSleepTimeUs() = 0;
775        virtual uint32_t        suspendSleepTimeUs() = 0;
776
777    private:
778
779        friend class AudioFlinger;
780        friend class OutputTrack;
781        friend class Track;
782        friend class TrackBase;
783        friend class MixerThread;
784        friend class DirectOutputThread;
785        friend class DuplicatingThread;
786
787        PlaybackThread(const Client&);
788        PlaybackThread& operator = (const PlaybackThread&);
789
790        status_t    addTrack_l(const sp<Track>& track);
791        void        destroyTrack_l(const sp<Track>& track);
792        void        removeTrack_l(const sp<Track>& track);
793
794        void        readOutputParameters();
795
796        virtual status_t    dumpInternals(int fd, const Vector<String16>& args);
797        status_t    dumpTracks(int fd, const Vector<String16>& args);
798
799        SortedVector< sp<Track> >       mTracks;
800        // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by DuplicatingThread
801        stream_type_t                   mStreamTypes[AUDIO_STREAM_CNT + 1];
802        AudioStreamOut*                 mOutput;
803        float                           mMasterVolume;
804        nsecs_t                         mLastWriteTime;
805        int                             mNumWrites;
806        int                             mNumDelayedWrites;
807        bool                            mInWrite;
808    };
809
810    class MixerThread : public PlaybackThread {
811    public:
812        MixerThread (const sp<AudioFlinger>& audioFlinger,
813                     AudioStreamOut* output,
814                     int id,
815                     uint32_t device);
816        virtual             ~MixerThread();
817
818        // Thread virtuals
819        virtual     bool        threadLoop();
820
821                    void        invalidateTracks(audio_stream_type_t streamType);
822        virtual     bool        checkForNewParameters_l();
823        virtual     status_t    dumpInternals(int fd, const Vector<String16>& args);
824
825    protected:
826                    uint32_t    prepareTracks_l(const SortedVector< wp<Track> >& activeTracks,
827                                                Vector< sp<Track> > *tracksToRemove);
828        virtual     int         getTrackName_l();
829        virtual     void        deleteTrackName_l(int name);
830        virtual     uint32_t    idleSleepTimeUs();
831        virtual     uint32_t    suspendSleepTimeUs();
832
833                    AudioMixer* mAudioMixer;
834                    uint32_t    mPrevMixerStatus; // previous status (mixer_state) returned by
835                                                  // prepareTracks_l()
836    };
837
838    class DirectOutputThread : public PlaybackThread {
839    public:
840
841        DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
842        ~DirectOutputThread();
843
844        // Thread virtuals
845        virtual     bool        threadLoop();
846
847        virtual     bool        checkForNewParameters_l();
848
849    protected:
850        virtual     int         getTrackName_l();
851        virtual     void        deleteTrackName_l(int name);
852        virtual     uint32_t    activeSleepTimeUs();
853        virtual     uint32_t    idleSleepTimeUs();
854        virtual     uint32_t    suspendSleepTimeUs();
855
856    private:
857        void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp);
858
859        float mLeftVolFloat;
860        float mRightVolFloat;
861        uint16_t mLeftVolShort;
862        uint16_t mRightVolShort;
863    };
864
865    class DuplicatingThread : public MixerThread {
866    public:
867        DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, int id);
868        ~DuplicatingThread();
869
870        // Thread virtuals
871        virtual     bool        threadLoop();
872                    void        addOutputTrack(MixerThread* thread);
873                    void        removeOutputTrack(MixerThread* thread);
874                    uint32_t    waitTimeMs() { return mWaitTimeMs; }
875    protected:
876        virtual     uint32_t    activeSleepTimeUs();
877
878    private:
879                    bool        outputsReady(SortedVector< sp<OutputTrack> > &outputTracks);
880                    void        updateWaitTime();
881
882        SortedVector < sp<OutputTrack> >  mOutputTracks;
883                    uint32_t    mWaitTimeMs;
884    };
885
886              PlaybackThread *checkPlaybackThread_l(int output) const;
887              MixerThread *checkMixerThread_l(int output) const;
888              RecordThread *checkRecordThread_l(int input) const;
889              float streamVolumeInternal(audio_stream_type_t stream) const { return mStreamTypes[stream].volume; }
890              void audioConfigChanged_l(int event, int ioHandle, void *param2);
891
892              uint32_t nextUniqueId();
893              status_t moveEffectChain_l(int sessionId,
894                                     AudioFlinger::PlaybackThread *srcThread,
895                                     AudioFlinger::PlaybackThread *dstThread,
896                                     bool reRegister);
897              PlaybackThread *primaryPlaybackThread_l();
898              uint32_t primaryOutputDevice_l();
899
900    friend class AudioBuffer;
901
902    class TrackHandle : public android::BnAudioTrack {
903    public:
904                            TrackHandle(const sp<PlaybackThread::Track>& track);
905        virtual             ~TrackHandle();
906        virtual status_t    start();
907        virtual void        stop();
908        virtual void        flush();
909        virtual void        mute(bool);
910        virtual void        pause();
911        virtual sp<IMemory> getCblk() const;
912        virtual status_t    attachAuxEffect(int effectId);
913        virtual status_t onTransact(
914            uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
915    private:
916        sp<PlaybackThread::Track> mTrack;
917    };
918
919    friend class Client;
920    friend class PlaybackThread::Track;
921
922
923                void        removeClient_l(pid_t pid);
924                void        removeNotificationClient(pid_t pid);
925
926
927    // record thread
928    class RecordThread : public ThreadBase, public AudioBufferProvider
929    {
930    public:
931
932        // record track
933        class RecordTrack : public TrackBase {
934        public:
935                                RecordTrack(const wp<ThreadBase>& thread,
936                                        const sp<Client>& client,
937                                        uint32_t sampleRate,
938                                        uint32_t format,
939                                        uint32_t channelMask,
940                                        int frameCount,
941                                        uint32_t flags,
942                                        int sessionId);
943                                ~RecordTrack();
944
945            virtual status_t    start();
946            virtual void        stop();
947
948                    bool        overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; }
949                    bool        setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; }
950
951                    void        dump(char* buffer, size_t size);
952
953        private:
954            friend class AudioFlinger;
955            friend class RecordThread;
956
957                                RecordTrack(const RecordTrack&);
958                                RecordTrack& operator = (const RecordTrack&);
959
960            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
961
962            bool                mOverflow;
963        };
964
965
966                RecordThread(const sp<AudioFlinger>& audioFlinger,
967                        AudioStreamIn *input,
968                        uint32_t sampleRate,
969                        uint32_t channels,
970                        int id,
971                        uint32_t device);
972                ~RecordThread();
973
974        virtual bool        threadLoop();
975        virtual status_t    readyToRun();
976        virtual void        onFirstRef();
977
978        virtual status_t    initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; }
979                sp<AudioFlinger::RecordThread::RecordTrack>  createRecordTrack_l(
980                        const sp<AudioFlinger::Client>& client,
981                        uint32_t sampleRate,
982                        int format,
983                        int channelMask,
984                        int frameCount,
985                        uint32_t flags,
986                        int sessionId,
987                        status_t *status);
988
989                status_t    start(RecordTrack* recordTrack);
990                void        stop(RecordTrack* recordTrack);
991                status_t    dump(int fd, const Vector<String16>& args);
992                AudioStreamIn* getInput();
993                AudioStreamIn* clearInput();
994                virtual audio_stream_t* stream();
995
996        virtual status_t    getNextBuffer(AudioBufferProvider::Buffer* buffer);
997        virtual void        releaseBuffer(AudioBufferProvider::Buffer* buffer);
998        virtual bool        checkForNewParameters_l();
999        virtual String8     getParameters(const String8& keys);
1000        virtual void        audioConfigChanged_l(int event, int param = 0);
1001                void        readInputParameters();
1002        virtual unsigned int  getInputFramesLost();
1003
1004        virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
1005        virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
1006        virtual uint32_t hasAudioSession(int sessionId);
1007                RecordTrack* track();
1008
1009    private:
1010                RecordThread();
1011                AudioStreamIn                       *mInput;
1012                RecordTrack*                        mTrack;
1013                sp<RecordTrack>                     mActiveTrack;
1014                Condition                           mStartStopCond;
1015                AudioResampler                      *mResampler;
1016                int32_t                             *mRsmpOutBuffer;
1017                int16_t                             *mRsmpInBuffer;
1018                size_t                              mRsmpInIndex;
1019                size_t                              mInputBytes;
1020                int                                 mReqChannelCount;
1021                uint32_t                            mReqSampleRate;
1022                ssize_t                             mBytesRead;
1023    };
1024
1025    class RecordHandle : public android::BnAudioRecord {
1026    public:
1027        RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack);
1028        virtual             ~RecordHandle();
1029        virtual status_t    start();
1030        virtual void        stop();
1031        virtual sp<IMemory> getCblk() const;
1032        virtual status_t onTransact(
1033            uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
1034    private:
1035        sp<RecordThread::RecordTrack> mRecordTrack;
1036    };
1037
1038    //--- Audio Effect Management
1039
1040    // EffectModule and EffectChain classes both have their own mutex to protect
1041    // state changes or resource modifications. Always respect the following order
1042    // if multiple mutexes must be acquired to avoid cross deadlock:
1043    // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule
1044
1045    // The EffectModule class is a wrapper object controlling the effect engine implementation
1046    // in the effect library. It prevents concurrent calls to process() and command() functions
1047    // from different client threads. It keeps a list of EffectHandle objects corresponding
1048    // to all client applications using this effect and notifies applications of effect state,
1049    // control or parameter changes. It manages the activation state machine to send appropriate
1050    // reset, enable, disable commands to effect engine and provide volume
1051    // ramping when effects are activated/deactivated.
1052    // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by
1053    // the attached track(s) to accumulate their auxiliary channel.
1054    class EffectModule: public RefBase {
1055    public:
1056        EffectModule(const wp<ThreadBase>& wThread,
1057                        const wp<AudioFlinger::EffectChain>& chain,
1058                        effect_descriptor_t *desc,
1059                        int id,
1060                        int sessionId);
1061        ~EffectModule();
1062
1063        enum effect_state {
1064            IDLE,
1065            RESTART,
1066            STARTING,
1067            ACTIVE,
1068            STOPPING,
1069            STOPPED,
1070            DESTROYED
1071        };
1072
1073        int         id() { return mId; }
1074        void process();
1075        void updateState();
1076        status_t command(uint32_t cmdCode,
1077                         uint32_t cmdSize,
1078                         void *pCmdData,
1079                         uint32_t *replySize,
1080                         void *pReplyData);
1081
1082        void reset_l();
1083        status_t configure();
1084        status_t init();
1085        uint32_t state() {
1086            return mState;
1087        }
1088        uint32_t status() {
1089            return mStatus;
1090        }
1091        int sessionId() {
1092            return mSessionId;
1093        }
1094        status_t    setEnabled(bool enabled);
1095        bool isEnabled();
1096        bool isProcessEnabled();
1097
1098        void        setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; }
1099        int16_t     *inBuffer() { return mConfig.inputCfg.buffer.s16; }
1100        void        setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; }
1101        int16_t     *outBuffer() { return mConfig.outputCfg.buffer.s16; }
1102        void        setChain(const wp<EffectChain>& chain) { mChain = chain; }
1103        void        setThread(const wp<ThreadBase>& thread) { mThread = thread; }
1104        wp<ThreadBase>& thread() { return mThread; }
1105
1106        status_t addHandle(sp<EffectHandle>& handle);
1107        void disconnect(const wp<EffectHandle>& handle, bool unpiniflast);
1108        size_t removeHandle (const wp<EffectHandle>& handle);
1109
1110        effect_descriptor_t& desc() { return mDescriptor; }
1111        wp<EffectChain>&     chain() { return mChain; }
1112
1113        status_t         setDevice(uint32_t device);
1114        status_t         setVolume(uint32_t *left, uint32_t *right, bool controller);
1115        status_t         setMode(audio_mode_t mode);
1116        status_t         start();
1117        status_t         stop();
1118        void             setSuspended(bool suspended);
1119        bool             suspended() const;
1120
1121        sp<EffectHandle> controlHandle();
1122
1123        bool             isPinned() { return mPinned; }
1124        void             unPin() { mPinned = false; }
1125
1126        status_t         dump(int fd, const Vector<String16>& args);
1127
1128    protected:
1129        friend class EffectHandle;
1130        friend class AudioFlinger;
1131        bool                mPinned;
1132
1133        // Maximum time allocated to effect engines to complete the turn off sequence
1134        static const uint32_t MAX_DISABLE_TIME_MS = 10000;
1135
1136        EffectModule(const EffectModule&);
1137        EffectModule& operator = (const EffectModule&);
1138
1139        status_t start_l();
1140        status_t stop_l();
1141
1142mutable Mutex               mLock;      // mutex for process, commands and handles list protection
1143        wp<ThreadBase>      mThread;    // parent thread
1144        wp<EffectChain>     mChain;     // parent effect chain
1145        int                 mId;        // this instance unique ID
1146        int                 mSessionId; // audio session ID
1147        effect_descriptor_t mDescriptor;// effect descriptor received from effect engine
1148        effect_config_t     mConfig;    // input and output audio configuration
1149        effect_handle_t  mEffectInterface; // Effect module C API
1150        status_t mStatus;               // initialization status
1151        uint32_t mState;                // current activation state (effect_state)
1152        Vector< wp<EffectHandle> > mHandles;    // list of client handles
1153        uint32_t mMaxDisableWaitCnt;    // maximum grace period before forcing an effect off after
1154                                        // sending disable command.
1155        uint32_t mDisableWaitCnt;       // current process() calls count during disable period.
1156        bool     mSuspended;            // effect is suspended: temporarily disabled by framework
1157    };
1158
1159    // The EffectHandle class implements the IEffect interface. It provides resources
1160    // to receive parameter updates, keeps track of effect control
1161    // ownership and state and has a pointer to the EffectModule object it is controlling.
1162    // There is one EffectHandle object for each application controlling (or using)
1163    // an effect module.
1164    // The EffectHandle is obtained by calling AudioFlinger::createEffect().
1165    class EffectHandle: public android::BnEffect {
1166    public:
1167
1168        EffectHandle(const sp<EffectModule>& effect,
1169                const sp<AudioFlinger::Client>& client,
1170                const sp<IEffectClient>& effectClient,
1171                int32_t priority);
1172        virtual ~EffectHandle();
1173
1174        // IEffect
1175        virtual status_t enable();
1176        virtual status_t disable();
1177        virtual status_t command(uint32_t cmdCode,
1178                                 uint32_t cmdSize,
1179                                 void *pCmdData,
1180                                 uint32_t *replySize,
1181                                 void *pReplyData);
1182        virtual void disconnect();
1183        virtual void disconnect(bool unpiniflast);
1184        virtual sp<IMemory> getCblk() const;
1185        virtual status_t onTransact(uint32_t code, const Parcel& data,
1186                Parcel* reply, uint32_t flags);
1187
1188
1189        // Give or take control of effect module
1190        // - hasControl: true if control is given, false if removed
1191        // - signal: true client app should be signaled of change, false otherwise
1192        // - enabled: state of the effect when control is passed
1193        void setControl(bool hasControl, bool signal, bool enabled);
1194        void commandExecuted(uint32_t cmdCode,
1195                             uint32_t cmdSize,
1196                             void *pCmdData,
1197                             uint32_t replySize,
1198                             void *pReplyData);
1199        void setEnabled(bool enabled);
1200        bool enabled() { return mEnabled; }
1201
1202        // Getters
1203        int id() { return mEffect->id(); }
1204        int priority() { return mPriority; }
1205        bool hasControl() { return mHasControl; }
1206        sp<EffectModule> effect() { return mEffect; }
1207
1208        void dump(char* buffer, size_t size);
1209
1210    protected:
1211        friend class AudioFlinger;
1212        friend class EffectModule;
1213        EffectHandle(const EffectHandle&);
1214        EffectHandle& operator =(const EffectHandle&);
1215
1216        sp<EffectModule> mEffect;           // pointer to controlled EffectModule
1217        sp<IEffectClient> mEffectClient;    // callback interface for client notifications
1218        sp<Client>          mClient;        // client for shared memory allocation
1219        sp<IMemory>         mCblkMemory;    // shared memory for control block
1220        effect_param_cblk_t* mCblk;         // control block for deferred parameter setting via shared memory
1221        uint8_t*            mBuffer;        // pointer to parameter area in shared memory
1222        int mPriority;                      // client application priority to control the effect
1223        bool mHasControl;                   // true if this handle is controlling the effect
1224        bool mEnabled;                      // cached enable state: needed when the effect is
1225                                            // restored after being suspended
1226    };
1227
1228    // the EffectChain class represents a group of effects associated to one audio session.
1229    // There can be any number of EffectChain objects per output mixer thread (PlaybackThread).
1230    // The EffecChain with session ID 0 contains global effects applied to the output mix.
1231    // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks)
1232    // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding
1233    // in the effect process order. When attached to a track (session ID != 0), it also provide it's own
1234    // input buffer used by the track as accumulation buffer.
1235    class EffectChain: public RefBase {
1236    public:
1237        EffectChain(const wp<ThreadBase>& wThread, int sessionId);
1238        ~EffectChain();
1239
1240        // special key used for an entry in mSuspendedEffects keyed vector
1241        // corresponding to a suspend all request.
1242        static const int        kKeyForSuspendAll = 0;
1243
1244        // minimum duration during which we force calling effect process when last track on
1245        // a session is stopped or removed to allow effect tail to be rendered
1246        static const int        kProcessTailDurationMs = 1000;
1247
1248        void process_l();
1249
1250        void lock() {
1251            mLock.lock();
1252        }
1253        void unlock() {
1254            mLock.unlock();
1255        }
1256
1257        status_t addEffect_l(const sp<EffectModule>& handle);
1258        size_t removeEffect_l(const sp<EffectModule>& handle);
1259
1260        int sessionId() { return mSessionId; }
1261        void setSessionId(int sessionId) { mSessionId = sessionId; }
1262
1263        sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor);
1264        sp<EffectModule> getEffectFromId_l(int id);
1265        sp<EffectModule> getEffectFromType_l(const effect_uuid_t *type);
1266        bool setVolume_l(uint32_t *left, uint32_t *right);
1267        void setDevice_l(uint32_t device);
1268        void setMode_l(audio_mode_t mode);
1269
1270        void setInBuffer(int16_t *buffer, bool ownsBuffer = false) {
1271            mInBuffer = buffer;
1272            mOwnInBuffer = ownsBuffer;
1273        }
1274        int16_t *inBuffer() {
1275            return mInBuffer;
1276        }
1277        void setOutBuffer(int16_t *buffer) {
1278            mOutBuffer = buffer;
1279        }
1280        int16_t *outBuffer() {
1281            return mOutBuffer;
1282        }
1283
1284        void incTrackCnt() { android_atomic_inc(&mTrackCnt); }
1285        void decTrackCnt() { android_atomic_dec(&mTrackCnt); }
1286        int32_t trackCnt() { return mTrackCnt;}
1287
1288        void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt);
1289                                   mTailBufferCount = mMaxTailBuffers; }
1290        void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); }
1291        int32_t activeTrackCnt() { return mActiveTrackCnt;}
1292
1293        uint32_t strategy() { return mStrategy; }
1294        void setStrategy(uint32_t strategy)
1295                 { mStrategy = strategy; }
1296
1297        // suspend effect of the given type
1298        void setEffectSuspended_l(const effect_uuid_t *type,
1299                                  bool suspend);
1300        // suspend all eligible effects
1301        void setEffectSuspendedAll_l(bool suspend);
1302        // check if effects should be suspend or restored when a given effect is enable or disabled
1303        void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect,
1304                                              bool enabled);
1305
1306        status_t dump(int fd, const Vector<String16>& args);
1307
1308    protected:
1309        friend class AudioFlinger;
1310        EffectChain(const EffectChain&);
1311        EffectChain& operator =(const EffectChain&);
1312
1313        class SuspendedEffectDesc : public RefBase {
1314        public:
1315            SuspendedEffectDesc() : mRefCount(0) {}
1316
1317            int mRefCount;
1318            effect_uuid_t mType;
1319            wp<EffectModule> mEffect;
1320        };
1321
1322        // get a list of effect modules to suspend when an effect of the type
1323        // passed is enabled.
1324        Vector< sp<EffectModule> > getSuspendEligibleEffects();
1325        // get an effect module if it is currently enable
1326        sp<EffectModule> getEffectIfEnabled(const effect_uuid_t *type);
1327        // true if the effect whose descriptor is passed can be suspended
1328        // OEMs can modify the rules implemented in this method to exclude specific effect
1329        // types or implementations from the suspend/restore mechanism.
1330        bool isEffectEligibleForSuspend(const effect_descriptor_t& desc);
1331
1332        wp<ThreadBase> mThread;     // parent mixer thread
1333        Mutex mLock;                // mutex protecting effect list
1334        Vector<sp<EffectModule> > mEffects; // list of effect modules
1335        int mSessionId;             // audio session ID
1336        int16_t *mInBuffer;         // chain input buffer
1337        int16_t *mOutBuffer;        // chain output buffer
1338        volatile int32_t mActiveTrackCnt;  // number of active tracks connected
1339        volatile int32_t mTrackCnt;        // number of tracks connected
1340        int32_t mTailBufferCount;   // current effect tail buffer count
1341        int32_t mMaxTailBuffers;    // maximum effect tail buffers
1342        bool mOwnInBuffer;          // true if the chain owns its input buffer
1343        int mVolumeCtrlIdx;         // index of insert effect having control over volume
1344        uint32_t mLeftVolume;       // previous volume on left channel
1345        uint32_t mRightVolume;      // previous volume on right channel
1346        uint32_t mNewLeftVolume;       // new volume on left channel
1347        uint32_t mNewRightVolume;      // new volume on right channel
1348        uint32_t mStrategy; // strategy for this effect chain
1349        // mSuspendedEffects lists all effect currently suspended in the chain
1350        // use effect type UUID timelow field as key. There is no real risk of identical
1351        // timeLow fields among effect type UUIDs.
1352        KeyedVector< int, sp<SuspendedEffectDesc> > mSuspendedEffects;
1353    };
1354
1355    struct AudioStreamOut {
1356        audio_hw_device_t   *hwDev;
1357        audio_stream_out_t  *stream;
1358
1359        AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) :
1360            hwDev(dev), stream(out) {}
1361    };
1362
1363    struct AudioStreamIn {
1364        audio_hw_device_t   *hwDev;
1365        audio_stream_in_t   *stream;
1366
1367        AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) :
1368            hwDev(dev), stream(in) {}
1369    };
1370
1371    struct AudioSessionRef {
1372        int sessionid;
1373        pid_t pid;
1374        int cnt;
1375    };
1376
1377    friend class RecordThread;
1378    friend class PlaybackThread;
1379
1380    mutable     Mutex                               mLock;
1381
1382                DefaultKeyedVector< pid_t, wp<Client> >     mClients;
1383
1384                mutable     Mutex                   mHardwareLock;
1385                audio_hw_device_t*                  mPrimaryHardwareDev;
1386                Vector<audio_hw_device_t*>          mAudioHwDevs;
1387    mutable     hardware_call_state                 mHardwareStatus;    // for dump only
1388
1389
1390                DefaultKeyedVector< int, sp<PlaybackThread> >  mPlaybackThreads;
1391                PlaybackThread::stream_type_t       mStreamTypes[AUDIO_STREAM_CNT];
1392
1393                // both are protected by mLock
1394                float                               mMasterVolume;
1395                bool                                mMasterMute;
1396
1397                DefaultKeyedVector< int, sp<RecordThread> >    mRecordThreads;
1398
1399                DefaultKeyedVector< pid_t, sp<NotificationClient> >    mNotificationClients;
1400                volatile int32_t                    mNextUniqueId;
1401                audio_mode_t                        mMode;
1402                bool                                mBtNrecIsOff;
1403
1404                Vector<AudioSessionRef*> mAudioSessionRefs;
1405
1406                float       masterVolume_l() const  { return mMasterVolume; }
1407                bool        masterMute_l() const    { return mMasterMute; }
1408};
1409
1410
1411// ----------------------------------------------------------------------------
1412
1413}; // namespace android
1414
1415#endif // ANDROID_AUDIO_FLINGER_H
1416