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