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