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