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