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