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