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