AudioFlinger.h revision 23bb8becff20449a9b1647d5a1a99b14c83f0cce 
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
281        enum type_t {
282            MIXER,              // Thread class is MixerThread
283            DIRECT,             // Thread class is DirectOutputThread
284            DUPLICATING,        // Thread class is DuplicatingThread
285            RECORD              // Thread class is RecordThread
286        };
287
288        ThreadBase (const sp<AudioFlinger>& audioFlinger, int id, uint32_t device, type_t type);
289        virtual             ~ThreadBase();
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                    type_t      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                    const type_t            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,
695                        uint32_t device, type_t type);
696        virtual             ~PlaybackThread();
697
698        virtual     status_t    dump(int fd, const Vector<String16>& args);
699
700        // Thread virtuals
701        virtual     status_t    readyToRun();
702        virtual     void        onFirstRef();
703
704        virtual     status_t    initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; }
705
706        virtual     uint32_t    latency() const;
707
708        virtual     status_t    setMasterVolume(float value);
709        virtual     status_t    setMasterMute(bool muted);
710
711        virtual     float       masterVolume() const;
712        virtual     bool        masterMute() const;
713
714        virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value);
715        virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted);
716
717        virtual     float       streamVolume(audio_stream_type_t stream) const;
718        virtual     bool        streamMute(audio_stream_type_t stream) const;
719
720                    sp<Track>   createTrack_l(
721                                    const sp<AudioFlinger::Client>& client,
722                                    audio_stream_type_t streamType,
723                                    uint32_t sampleRate,
724                                    audio_format_t format,
725                                    uint32_t channelMask,
726                                    int frameCount,
727                                    const sp<IMemory>& sharedBuffer,
728                                    int sessionId,
729                                    status_t *status);
730
731                    AudioStreamOut* getOutput();
732                    AudioStreamOut* clearOutput();
733                    virtual audio_stream_t* stream();
734
735                    void        suspend() { mSuspended++; }
736                    void        restore() { if (mSuspended) mSuspended--; }
737                    bool        isSuspended() const { return (mSuspended != 0); }
738        virtual     String8     getParameters(const String8& keys);
739        virtual     void        audioConfigChanged_l(int event, int param = 0);
740        virtual     status_t    getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames);
741                    int16_t     *mixBuffer() { return mMixBuffer; };
742
743        virtual     void detachAuxEffect_l(int effectId);
744                    status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track,
745                            int EffectId);
746                    status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track,
747                            int EffectId);
748
749                    virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
750                    virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
751                    virtual uint32_t hasAudioSession(int sessionId);
752                    virtual uint32_t getStrategyForSession_l(int sessionId);
753
754                            void setStreamValid(audio_stream_type_t streamType, bool valid);
755
756        struct  stream_type_t {
757            stream_type_t()
758                :   volume(1.0f),
759                    mute(false),
760                    valid(true)
761            {
762            }
763            float       volume;
764            bool        mute;
765            bool        valid;
766        };
767
768    protected:
769        int16_t*                        mMixBuffer;
770        int                             mSuspended;
771        int                             mBytesWritten;
772    private:
773        bool                            mMasterMute;
774    protected:
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();
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 additional 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                     type_t type = MIXER);
823        virtual             ~MixerThread();
824
825        // Thread virtuals
826        virtual     bool        threadLoop();
827
828                    void        invalidateTracks(audio_stream_type_t streamType);
829        virtual     bool        checkForNewParameters_l();
830        virtual     status_t    dumpInternals(int fd, const Vector<String16>& args);
831
832    protected:
833                    uint32_t    prepareTracks_l(const SortedVector< wp<Track> >& activeTracks,
834                                                Vector< sp<Track> > *tracksToRemove);
835        virtual     int         getTrackName_l();
836        virtual     void        deleteTrackName_l(int name);
837        virtual     uint32_t    idleSleepTimeUs();
838        virtual     uint32_t    suspendSleepTimeUs();
839
840                    AudioMixer* mAudioMixer;
841                    uint32_t    mPrevMixerStatus; // previous status (mixer_state) returned by
842                                                  // prepareTracks_l()
843    };
844
845    class DirectOutputThread : public PlaybackThread {
846    public:
847
848        DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
849        ~DirectOutputThread();
850
851        // Thread virtuals
852        virtual     bool        threadLoop();
853
854        virtual     bool        checkForNewParameters_l();
855
856    protected:
857        virtual     int         getTrackName_l();
858        virtual     void        deleteTrackName_l(int name);
859        virtual     uint32_t    activeSleepTimeUs();
860        virtual     uint32_t    idleSleepTimeUs();
861        virtual     uint32_t    suspendSleepTimeUs();
862
863    private:
864        void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp);
865
866        float mLeftVolFloat;
867        float mRightVolFloat;
868        uint16_t mLeftVolShort;
869        uint16_t mRightVolShort;
870    };
871
872    class DuplicatingThread : public MixerThread {
873    public:
874        DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, int id);
875        ~DuplicatingThread();
876
877        // Thread virtuals
878        virtual     bool        threadLoop();
879                    void        addOutputTrack(MixerThread* thread);
880                    void        removeOutputTrack(MixerThread* thread);
881                    uint32_t    waitTimeMs() { return mWaitTimeMs; }
882    protected:
883        virtual     uint32_t    activeSleepTimeUs();
884
885    private:
886                    bool        outputsReady(SortedVector< sp<OutputTrack> > &outputTracks);
887                    void        updateWaitTime();
888
889        SortedVector < sp<OutputTrack> >  mOutputTracks;
890                    uint32_t    mWaitTimeMs;
891    };
892
893              PlaybackThread *checkPlaybackThread_l(int output) const;
894              MixerThread *checkMixerThread_l(int output) const;
895              RecordThread *checkRecordThread_l(int input) const;
896              float streamVolumeInternal(audio_stream_type_t stream) const { return mStreamTypes[stream].volume; }
897              void audioConfigChanged_l(int event, int ioHandle, void *param2);
898
899              uint32_t nextUniqueId();
900              status_t moveEffectChain_l(int sessionId,
901                                     AudioFlinger::PlaybackThread *srcThread,
902                                     AudioFlinger::PlaybackThread *dstThread,
903                                     bool reRegister);
904              PlaybackThread *primaryPlaybackThread_l();
905              uint32_t primaryOutputDevice_l();
906
907    friend class AudioBuffer;
908
909    class TrackHandle : public android::BnAudioTrack {
910    public:
911                            TrackHandle(const sp<PlaybackThread::Track>& track);
912        virtual             ~TrackHandle();
913        virtual status_t    start();
914        virtual void        stop();
915        virtual void        flush();
916        virtual void        mute(bool);
917        virtual void        pause();
918        virtual sp<IMemory> getCblk() const;
919        virtual status_t    attachAuxEffect(int effectId);
920        virtual status_t onTransact(
921            uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
922    private:
923        sp<PlaybackThread::Track> mTrack;
924    };
925
926    friend class Client;
927    friend class PlaybackThread::Track;
928
929
930                void        removeClient_l(pid_t pid);
931                void        removeNotificationClient(pid_t pid);
932
933
934    // record thread
935    class RecordThread : public ThreadBase, public AudioBufferProvider
936    {
937    public:
938
939        // record track
940        class RecordTrack : public TrackBase {
941        public:
942                                RecordTrack(const wp<ThreadBase>& thread,
943                                        const sp<Client>& client,
944                                        uint32_t sampleRate,
945                                        audio_format_t format,
946                                        uint32_t channelMask,
947                                        int frameCount,
948                                        uint32_t flags,
949                                        int sessionId);
950                                ~RecordTrack();
951
952            virtual status_t    start();
953            virtual void        stop();
954
955                    bool        overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; }
956                    bool        setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; }
957
958                    void        dump(char* buffer, size_t size);
959
960        private:
961            friend class AudioFlinger;
962            friend class RecordThread;
963
964                                RecordTrack(const RecordTrack&);
965                                RecordTrack& operator = (const RecordTrack&);
966
967            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
968
969            bool                mOverflow;
970        };
971
972
973                RecordThread(const sp<AudioFlinger>& audioFlinger,
974                        AudioStreamIn *input,
975                        uint32_t sampleRate,
976                        uint32_t channels,
977                        int id,
978                        uint32_t device);
979                ~RecordThread();
980
981        virtual bool        threadLoop();
982        virtual status_t    readyToRun();
983        virtual void        onFirstRef();
984
985        virtual status_t    initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; }
986                sp<AudioFlinger::RecordThread::RecordTrack>  createRecordTrack_l(
987                        const sp<AudioFlinger::Client>& client,
988                        uint32_t sampleRate,
989                        audio_format_t format,
990                        int channelMask,
991                        int frameCount,
992                        uint32_t flags,
993                        int sessionId,
994                        status_t *status);
995
996                status_t    start(RecordTrack* recordTrack);
997                void        stop(RecordTrack* recordTrack);
998                status_t    dump(int fd, const Vector<String16>& args);
999                AudioStreamIn* getInput();
1000                AudioStreamIn* clearInput();
1001                virtual audio_stream_t* stream();
1002
1003        virtual status_t    getNextBuffer(AudioBufferProvider::Buffer* buffer);
1004        virtual void        releaseBuffer(AudioBufferProvider::Buffer* buffer);
1005        virtual bool        checkForNewParameters_l();
1006        virtual String8     getParameters(const String8& keys);
1007        virtual void        audioConfigChanged_l(int event, int param = 0);
1008                void        readInputParameters();
1009        virtual unsigned int  getInputFramesLost();
1010
1011        virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
1012        virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
1013        virtual uint32_t hasAudioSession(int sessionId);
1014                RecordTrack* track();
1015
1016    private:
1017                RecordThread();
1018                AudioStreamIn                       *mInput;
1019                RecordTrack*                        mTrack;
1020                sp<RecordTrack>                     mActiveTrack;
1021                Condition                           mStartStopCond;
1022                AudioResampler                      *mResampler;
1023                int32_t                             *mRsmpOutBuffer;
1024                int16_t                             *mRsmpInBuffer;
1025                size_t                              mRsmpInIndex;
1026                size_t                              mInputBytes;
1027                int                                 mReqChannelCount;
1028                uint32_t                            mReqSampleRate;
1029                ssize_t                             mBytesRead;
1030    };
1031
1032    class RecordHandle : public android::BnAudioRecord {
1033    public:
1034        RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack);
1035        virtual             ~RecordHandle();
1036        virtual status_t    start();
1037        virtual void        stop();
1038        virtual sp<IMemory> getCblk() const;
1039        virtual status_t onTransact(
1040            uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
1041    private:
1042        sp<RecordThread::RecordTrack> mRecordTrack;
1043    };
1044
1045    //--- Audio Effect Management
1046
1047    // EffectModule and EffectChain classes both have their own mutex to protect
1048    // state changes or resource modifications. Always respect the following order
1049    // if multiple mutexes must be acquired to avoid cross deadlock:
1050    // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule
1051
1052    // The EffectModule class is a wrapper object controlling the effect engine implementation
1053    // in the effect library. It prevents concurrent calls to process() and command() functions
1054    // from different client threads. It keeps a list of EffectHandle objects corresponding
1055    // to all client applications using this effect and notifies applications of effect state,
1056    // control or parameter changes. It manages the activation state machine to send appropriate
1057    // reset, enable, disable commands to effect engine and provide volume
1058    // ramping when effects are activated/deactivated.
1059    // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by
1060    // the attached track(s) to accumulate their auxiliary channel.
1061    class EffectModule: public RefBase {
1062    public:
1063        EffectModule(const wp<ThreadBase>& wThread,
1064                        const wp<AudioFlinger::EffectChain>& chain,
1065                        effect_descriptor_t *desc,
1066                        int id,
1067                        int sessionId);
1068        ~EffectModule();
1069
1070        enum effect_state {
1071            IDLE,
1072            RESTART,
1073            STARTING,
1074            ACTIVE,
1075            STOPPING,
1076            STOPPED,
1077            DESTROYED
1078        };
1079
1080        int         id() { return mId; }
1081        void process();
1082        void updateState();
1083        status_t command(uint32_t cmdCode,
1084                         uint32_t cmdSize,
1085                         void *pCmdData,
1086                         uint32_t *replySize,
1087                         void *pReplyData);
1088
1089        void reset_l();
1090        status_t configure();
1091        status_t init();
1092        uint32_t state() {
1093            return mState;
1094        }
1095        uint32_t status() {
1096            return mStatus;
1097        }
1098        int sessionId() {
1099            return mSessionId;
1100        }
1101        status_t    setEnabled(bool enabled);
1102        bool isEnabled();
1103        bool isProcessEnabled();
1104
1105        void        setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; }
1106        int16_t     *inBuffer() { return mConfig.inputCfg.buffer.s16; }
1107        void        setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; }
1108        int16_t     *outBuffer() { return mConfig.outputCfg.buffer.s16; }
1109        void        setChain(const wp<EffectChain>& chain) { mChain = chain; }
1110        void        setThread(const wp<ThreadBase>& thread) { mThread = thread; }
1111        wp<ThreadBase>& thread() { return mThread; }
1112
1113        status_t addHandle(sp<EffectHandle>& handle);
1114        void disconnect(const wp<EffectHandle>& handle, bool unpiniflast);
1115        size_t removeHandle (const wp<EffectHandle>& handle);
1116
1117        effect_descriptor_t& desc() { return mDescriptor; }
1118        wp<EffectChain>&     chain() { return mChain; }
1119
1120        status_t         setDevice(uint32_t device);
1121        status_t         setVolume(uint32_t *left, uint32_t *right, bool controller);
1122        status_t         setMode(audio_mode_t mode);
1123        status_t         start();
1124        status_t         stop();
1125        void             setSuspended(bool suspended);
1126        bool             suspended() const;
1127
1128        sp<EffectHandle> controlHandle();
1129
1130        bool             isPinned() { return mPinned; }
1131        void             unPin() { mPinned = false; }
1132
1133        status_t         dump(int fd, const Vector<String16>& args);
1134
1135    protected:
1136        friend class EffectHandle;
1137        friend class AudioFlinger;
1138        bool                mPinned;
1139
1140        // Maximum time allocated to effect engines to complete the turn off sequence
1141        static const uint32_t MAX_DISABLE_TIME_MS = 10000;
1142
1143        EffectModule(const EffectModule&);
1144        EffectModule& operator = (const EffectModule&);
1145
1146        status_t start_l();
1147        status_t stop_l();
1148
1149mutable Mutex               mLock;      // mutex for process, commands and handles list protection
1150        wp<ThreadBase>      mThread;    // parent thread
1151        wp<EffectChain>     mChain;     // parent effect chain
1152        int                 mId;        // this instance unique ID
1153        int                 mSessionId; // audio session ID
1154        effect_descriptor_t mDescriptor;// effect descriptor received from effect engine
1155        effect_config_t     mConfig;    // input and output audio configuration
1156        effect_handle_t  mEffectInterface; // Effect module C API
1157        status_t mStatus;               // initialization status
1158        uint32_t mState;                // current activation state (effect_state)
1159        Vector< wp<EffectHandle> > mHandles;    // list of client handles
1160        uint32_t mMaxDisableWaitCnt;    // maximum grace period before forcing an effect off after
1161                                        // sending disable command.
1162        uint32_t mDisableWaitCnt;       // current process() calls count during disable period.
1163        bool     mSuspended;            // effect is suspended: temporarily disabled by framework
1164    };
1165
1166    // The EffectHandle class implements the IEffect interface. It provides resources
1167    // to receive parameter updates, keeps track of effect control
1168    // ownership and state and has a pointer to the EffectModule object it is controlling.
1169    // There is one EffectHandle object for each application controlling (or using)
1170    // an effect module.
1171    // The EffectHandle is obtained by calling AudioFlinger::createEffect().
1172    class EffectHandle: public android::BnEffect {
1173    public:
1174
1175        EffectHandle(const sp<EffectModule>& effect,
1176                const sp<AudioFlinger::Client>& client,
1177                const sp<IEffectClient>& effectClient,
1178                int32_t priority);
1179        virtual ~EffectHandle();
1180
1181        // IEffect
1182        virtual status_t enable();
1183        virtual status_t disable();
1184        virtual status_t command(uint32_t cmdCode,
1185                                 uint32_t cmdSize,
1186                                 void *pCmdData,
1187                                 uint32_t *replySize,
1188                                 void *pReplyData);
1189        virtual void disconnect();
1190        virtual void disconnect(bool unpiniflast);
1191        virtual sp<IMemory> getCblk() const;
1192        virtual status_t onTransact(uint32_t code, const Parcel& data,
1193                Parcel* reply, uint32_t flags);
1194
1195
1196        // Give or take control of effect module
1197        // - hasControl: true if control is given, false if removed
1198        // - signal: true client app should be signaled of change, false otherwise
1199        // - enabled: state of the effect when control is passed
1200        void setControl(bool hasControl, bool signal, bool enabled);
1201        void commandExecuted(uint32_t cmdCode,
1202                             uint32_t cmdSize,
1203                             void *pCmdData,
1204                             uint32_t replySize,
1205                             void *pReplyData);
1206        void setEnabled(bool enabled);
1207        bool enabled() { return mEnabled; }
1208
1209        // Getters
1210        int id() { return mEffect->id(); }
1211        int priority() { return mPriority; }
1212        bool hasControl() { return mHasControl; }
1213        sp<EffectModule> effect() { return mEffect; }
1214
1215        void dump(char* buffer, size_t size);
1216
1217    protected:
1218        friend class AudioFlinger;
1219        friend class EffectModule;
1220        EffectHandle(const EffectHandle&);
1221        EffectHandle& operator =(const EffectHandle&);
1222
1223        sp<EffectModule> mEffect;           // pointer to controlled EffectModule
1224        sp<IEffectClient> mEffectClient;    // callback interface for client notifications
1225        sp<Client>          mClient;        // client for shared memory allocation
1226        sp<IMemory>         mCblkMemory;    // shared memory for control block
1227        effect_param_cblk_t* mCblk;         // control block for deferred parameter setting via shared memory
1228        uint8_t*            mBuffer;        // pointer to parameter area in shared memory
1229        int mPriority;                      // client application priority to control the effect
1230        bool mHasControl;                   // true if this handle is controlling the effect
1231        bool mEnabled;                      // cached enable state: needed when the effect is
1232                                            // restored after being suspended
1233    };
1234
1235    // the EffectChain class represents a group of effects associated to one audio session.
1236    // There can be any number of EffectChain objects per output mixer thread (PlaybackThread).
1237    // The EffecChain with session ID 0 contains global effects applied to the output mix.
1238    // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks)
1239    // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding
1240    // in the effect process order. When attached to a track (session ID != 0), it also provide it's own
1241    // input buffer used by the track as accumulation buffer.
1242    class EffectChain: public RefBase {
1243    public:
1244        EffectChain(const wp<ThreadBase>& wThread, int sessionId);
1245        ~EffectChain();
1246
1247        // special key used for an entry in mSuspendedEffects keyed vector
1248        // corresponding to a suspend all request.
1249        static const int        kKeyForSuspendAll = 0;
1250
1251        // minimum duration during which we force calling effect process when last track on
1252        // a session is stopped or removed to allow effect tail to be rendered
1253        static const int        kProcessTailDurationMs = 1000;
1254
1255        void process_l();
1256
1257        void lock() {
1258            mLock.lock();
1259        }
1260        void unlock() {
1261            mLock.unlock();
1262        }
1263
1264        status_t addEffect_l(const sp<EffectModule>& handle);
1265        size_t removeEffect_l(const sp<EffectModule>& handle);
1266
1267        int sessionId() { return mSessionId; }
1268        void setSessionId(int sessionId) { mSessionId = sessionId; }
1269
1270        sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor);
1271        sp<EffectModule> getEffectFromId_l(int id);
1272        sp<EffectModule> getEffectFromType_l(const effect_uuid_t *type);
1273        bool setVolume_l(uint32_t *left, uint32_t *right);
1274        void setDevice_l(uint32_t device);
1275        void setMode_l(audio_mode_t mode);
1276
1277        void setInBuffer(int16_t *buffer, bool ownsBuffer = false) {
1278            mInBuffer = buffer;
1279            mOwnInBuffer = ownsBuffer;
1280        }
1281        int16_t *inBuffer() {
1282            return mInBuffer;
1283        }
1284        void setOutBuffer(int16_t *buffer) {
1285            mOutBuffer = buffer;
1286        }
1287        int16_t *outBuffer() {
1288            return mOutBuffer;
1289        }
1290
1291        void incTrackCnt() { android_atomic_inc(&mTrackCnt); }
1292        void decTrackCnt() { android_atomic_dec(&mTrackCnt); }
1293        int32_t trackCnt() { return mTrackCnt;}
1294
1295        void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt);
1296                                   mTailBufferCount = mMaxTailBuffers; }
1297        void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); }
1298        int32_t activeTrackCnt() { return mActiveTrackCnt;}
1299
1300        uint32_t strategy() { return mStrategy; }
1301        void setStrategy(uint32_t strategy)
1302                 { mStrategy = strategy; }
1303
1304        // suspend effect of the given type
1305        void setEffectSuspended_l(const effect_uuid_t *type,
1306                                  bool suspend);
1307        // suspend all eligible effects
1308        void setEffectSuspendedAll_l(bool suspend);
1309        // check if effects should be suspend or restored when a given effect is enable or disabled
1310        void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect,
1311                                              bool enabled);
1312
1313        status_t dump(int fd, const Vector<String16>& args);
1314
1315    protected:
1316        friend class AudioFlinger;
1317        EffectChain(const EffectChain&);
1318        EffectChain& operator =(const EffectChain&);
1319
1320        class SuspendedEffectDesc : public RefBase {
1321        public:
1322            SuspendedEffectDesc() : mRefCount(0) {}
1323
1324            int mRefCount;
1325            effect_uuid_t mType;
1326            wp<EffectModule> mEffect;
1327        };
1328
1329        // get a list of effect modules to suspend when an effect of the type
1330        // passed is enabled.
1331        Vector< sp<EffectModule> > getSuspendEligibleEffects();
1332        // get an effect module if it is currently enable
1333        sp<EffectModule> getEffectIfEnabled(const effect_uuid_t *type);
1334        // true if the effect whose descriptor is passed can be suspended
1335        // OEMs can modify the rules implemented in this method to exclude specific effect
1336        // types or implementations from the suspend/restore mechanism.
1337        bool isEffectEligibleForSuspend(const effect_descriptor_t& desc);
1338
1339        wp<ThreadBase> mThread;     // parent mixer thread
1340        Mutex mLock;                // mutex protecting effect list
1341        Vector<sp<EffectModule> > mEffects; // list of effect modules
1342        int mSessionId;             // audio session ID
1343        int16_t *mInBuffer;         // chain input buffer
1344        int16_t *mOutBuffer;        // chain output buffer
1345        volatile int32_t mActiveTrackCnt;  // number of active tracks connected
1346        volatile int32_t mTrackCnt;        // number of tracks connected
1347        int32_t mTailBufferCount;   // current effect tail buffer count
1348        int32_t mMaxTailBuffers;    // maximum effect tail buffers
1349        bool mOwnInBuffer;          // true if the chain owns its input buffer
1350        int mVolumeCtrlIdx;         // index of insert effect having control over volume
1351        uint32_t mLeftVolume;       // previous volume on left channel
1352        uint32_t mRightVolume;      // previous volume on right channel
1353        uint32_t mNewLeftVolume;       // new volume on left channel
1354        uint32_t mNewRightVolume;      // new volume on right channel
1355        uint32_t mStrategy; // strategy for this effect chain
1356        // mSuspendedEffects lists all effect currently suspended in the chain
1357        // use effect type UUID timelow field as key. There is no real risk of identical
1358        // timeLow fields among effect type UUIDs.
1359        KeyedVector< int, sp<SuspendedEffectDesc> > mSuspendedEffects;
1360    };
1361
1362    struct AudioStreamOut {
1363        audio_hw_device_t   *hwDev;
1364        audio_stream_out_t  *stream;
1365
1366        AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) :
1367            hwDev(dev), stream(out) {}
1368    };
1369
1370    struct AudioStreamIn {
1371        audio_hw_device_t   *hwDev;
1372        audio_stream_in_t   *stream;
1373
1374        AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) :
1375            hwDev(dev), stream(in) {}
1376    };
1377
1378    struct AudioSessionRef {
1379        int sessionid;
1380        pid_t pid;
1381        int cnt;
1382    };
1383
1384    friend class RecordThread;
1385    friend class PlaybackThread;
1386
1387    mutable     Mutex                               mLock;
1388
1389                DefaultKeyedVector< pid_t, wp<Client> >     mClients;
1390
1391                mutable     Mutex                   mHardwareLock;
1392                audio_hw_device_t*                  mPrimaryHardwareDev;
1393                Vector<audio_hw_device_t*>          mAudioHwDevs;
1394    mutable     hardware_call_state                 mHardwareStatus;    // for dump only
1395
1396
1397                DefaultKeyedVector< int, sp<PlaybackThread> >  mPlaybackThreads;
1398                PlaybackThread::stream_type_t       mStreamTypes[AUDIO_STREAM_CNT];
1399
1400                // both are protected by mLock
1401                float                               mMasterVolume;
1402                bool                                mMasterMute;
1403
1404                DefaultKeyedVector< int, sp<RecordThread> >    mRecordThreads;
1405
1406                DefaultKeyedVector< pid_t, sp<NotificationClient> >    mNotificationClients;
1407                volatile int32_t                    mNextUniqueId;
1408                audio_mode_t                        mMode;
1409                bool                                mBtNrecIsOff;
1410
1411                Vector<AudioSessionRef*> mAudioSessionRefs;
1412
1413                float       masterVolume_l() const  { return mMasterVolume; }
1414                bool        masterMute_l() const    { return mMasterMute; }
1415};
1416
1417
1418// ----------------------------------------------------------------------------
1419
1420}; // namespace android
1421
1422#endif // ANDROID_AUDIO_FLINGER_H
1423