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