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