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/Vector.h>
     36 
     37 #include <binder/BinderService.h>
     38 #include <binder/MemoryDealer.h>
     39 
     40 #include <hardware_legacy/AudioHardwareInterface.h>
     41 
     42 #include "AudioBufferProvider.h"
     43 
     44 namespace android {
     45 
     46 class audio_track_cblk_t;
     47 class effect_param_cblk_t;
     48 class AudioMixer;
     49 class AudioBuffer;
     50 class AudioResampler;
     51 
     52 
     53 // ----------------------------------------------------------------------------
     54 
     55 #define LIKELY( exp )       (__builtin_expect( (exp) != 0, true  ))
     56 #define UNLIKELY( exp )     (__builtin_expect( (exp) != 0, false ))
     57 
     58 
     59 // ----------------------------------------------------------------------------
     60 
     61 static const nsecs_t kStandbyTimeInNsecs = seconds(3);
     62 
     63 class AudioFlinger :
     64     public BinderService<AudioFlinger>,
     65     public BnAudioFlinger
     66 {
     67     friend class BinderService<AudioFlinger>;
     68 public:
     69     static char const* getServiceName() { return "media.audio_flinger"; }
     70 
     71     virtual     status_t    dump(int fd, const Vector<String16>& args);
     72 
     73     // IAudioFlinger interface
     74     virtual sp<IAudioTrack> createTrack(
     75                                 pid_t pid,
     76                                 int streamType,
     77                                 uint32_t sampleRate,
     78                                 int format,
     79                                 int channelCount,
     80                                 int frameCount,
     81                                 uint32_t flags,
     82                                 const sp<IMemory>& sharedBuffer,
     83                                 int output,
     84                                 int *sessionId,
     85                                 status_t *status);
     86 
     87     virtual     uint32_t    sampleRate(int output) const;
     88     virtual     int         channelCount(int output) const;
     89     virtual     int         format(int output) const;
     90     virtual     size_t      frameCount(int output) const;
     91     virtual     uint32_t    latency(int output) const;
     92 
     93     virtual     status_t    setMasterVolume(float value);
     94     virtual     status_t    setMasterMute(bool muted);
     95 
     96     virtual     float       masterVolume() const;
     97     virtual     bool        masterMute() const;
     98 
     99     virtual     status_t    setStreamVolume(int stream, float value, int output);
    100     virtual     status_t    setStreamMute(int stream, bool muted);
    101 
    102     virtual     float       streamVolume(int stream, int output) const;
    103     virtual     bool        streamMute(int stream) const;
    104 
    105     virtual     status_t    setMode(int mode);
    106 
    107     virtual     status_t    setMicMute(bool state);
    108     virtual     bool        getMicMute() const;
    109 
    110     virtual     bool        isStreamActive(int stream) const;
    111 
    112     virtual     status_t    setParameters(int ioHandle, const String8& keyValuePairs);
    113     virtual     String8     getParameters(int ioHandle, const String8& keys);
    114 
    115     virtual     void        registerClient(const sp<IAudioFlingerClient>& client);
    116 
    117     virtual     size_t      getInputBufferSize(uint32_t sampleRate, int format, int channelCount);
    118     virtual     unsigned int  getInputFramesLost(int ioHandle);
    119 
    120     virtual int openOutput(uint32_t *pDevices,
    121                                     uint32_t *pSamplingRate,
    122                                     uint32_t *pFormat,
    123                                     uint32_t *pChannels,
    124                                     uint32_t *pLatencyMs,
    125                                     uint32_t flags);
    126 
    127     virtual int openDuplicateOutput(int output1, int output2);
    128 
    129     virtual status_t closeOutput(int output);
    130 
    131     virtual status_t suspendOutput(int output);
    132 
    133     virtual status_t restoreOutput(int output);
    134 
    135     virtual int openInput(uint32_t *pDevices,
    136                             uint32_t *pSamplingRate,
    137                             uint32_t *pFormat,
    138                             uint32_t *pChannels,
    139                             uint32_t acoustics);
    140 
    141     virtual status_t closeInput(int input);
    142 
    143     virtual status_t setStreamOutput(uint32_t stream, int output);
    144 
    145     virtual status_t setVoiceVolume(float volume);
    146 
    147     virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, int output);
    148 
    149     virtual int newAudioSessionId();
    150 
    151     virtual status_t loadEffectLibrary(const char *libPath, int *handle);
    152 
    153     virtual status_t unloadEffectLibrary(int handle);
    154 
    155     virtual status_t queryNumberEffects(uint32_t *numEffects);
    156 
    157     virtual status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor);
    158 
    159     virtual status_t getEffectDescriptor(effect_uuid_t *pUuid, effect_descriptor_t *descriptor);
    160 
    161     virtual sp<IEffect> createEffect(pid_t pid,
    162                         effect_descriptor_t *pDesc,
    163                         const sp<IEffectClient>& effectClient,
    164                         int32_t priority,
    165                         int output,
    166                         int sessionId,
    167                         status_t *status,
    168                         int *id,
    169                         int *enabled);
    170 
    171     virtual status_t moveEffects(int session, int srcOutput, int dstOutput);
    172 
    173     enum hardware_call_state {
    174         AUDIO_HW_IDLE = 0,
    175         AUDIO_HW_INIT,
    176         AUDIO_HW_OUTPUT_OPEN,
    177         AUDIO_HW_OUTPUT_CLOSE,
    178         AUDIO_HW_INPUT_OPEN,
    179         AUDIO_HW_INPUT_CLOSE,
    180         AUDIO_HW_STANDBY,
    181         AUDIO_HW_SET_MASTER_VOLUME,
    182         AUDIO_HW_GET_ROUTING,
    183         AUDIO_HW_SET_ROUTING,
    184         AUDIO_HW_GET_MODE,
    185         AUDIO_HW_SET_MODE,
    186         AUDIO_HW_GET_MIC_MUTE,
    187         AUDIO_HW_SET_MIC_MUTE,
    188         AUDIO_SET_VOICE_VOLUME,
    189         AUDIO_SET_PARAMETER,
    190     };
    191 
    192     // record interface
    193     virtual sp<IAudioRecord> openRecord(
    194                                 pid_t pid,
    195                                 int input,
    196                                 uint32_t sampleRate,
    197                                 int format,
    198                                 int channelCount,
    199                                 int frameCount,
    200                                 uint32_t flags,
    201                                 int *sessionId,
    202                                 status_t *status);
    203 
    204     virtual     status_t    onTransact(
    205                                 uint32_t code,
    206                                 const Parcel& data,
    207                                 Parcel* reply,
    208                                 uint32_t flags);
    209 
    210                 uint32_t    getMode() { return mMode; }
    211 
    212 private:
    213                             AudioFlinger();
    214     virtual                 ~AudioFlinger();
    215 
    216 
    217     // Internal dump utilites.
    218     status_t dumpPermissionDenial(int fd, const Vector<String16>& args);
    219     status_t dumpClients(int fd, const Vector<String16>& args);
    220     status_t dumpInternals(int fd, const Vector<String16>& args);
    221 
    222     // --- Client ---
    223     class Client : public RefBase {
    224     public:
    225                             Client(const sp<AudioFlinger>& audioFlinger, pid_t pid);
    226         virtual             ~Client();
    227         const sp<MemoryDealer>&     heap() const;
    228         pid_t               pid() const { return mPid; }
    229         sp<AudioFlinger>    audioFlinger() { return mAudioFlinger; }
    230 
    231     private:
    232                             Client(const Client&);
    233                             Client& operator = (const Client&);
    234         sp<AudioFlinger>    mAudioFlinger;
    235         sp<MemoryDealer>    mMemoryDealer;
    236         pid_t               mPid;
    237     };
    238 
    239     // --- Notification Client ---
    240     class NotificationClient : public IBinder::DeathRecipient {
    241     public:
    242                             NotificationClient(const sp<AudioFlinger>& audioFlinger,
    243                                                 const sp<IAudioFlingerClient>& client,
    244                                                 pid_t pid);
    245         virtual             ~NotificationClient();
    246 
    247                 sp<IAudioFlingerClient>    client() { return mClient; }
    248 
    249                 // IBinder::DeathRecipient
    250                 virtual     void        binderDied(const wp<IBinder>& who);
    251 
    252     private:
    253                             NotificationClient(const NotificationClient&);
    254                             NotificationClient& operator = (const NotificationClient&);
    255 
    256         sp<AudioFlinger>        mAudioFlinger;
    257         pid_t                   mPid;
    258         sp<IAudioFlingerClient> mClient;
    259     };
    260 
    261     class TrackHandle;
    262     class RecordHandle;
    263     class RecordThread;
    264     class PlaybackThread;
    265     class MixerThread;
    266     class DirectOutputThread;
    267     class DuplicatingThread;
    268     class Track;
    269     class RecordTrack;
    270     class EffectModule;
    271     class EffectHandle;
    272     class EffectChain;
    273 
    274     class ThreadBase : public Thread {
    275     public:
    276         ThreadBase (const sp<AudioFlinger>& audioFlinger, int id);
    277         virtual             ~ThreadBase();
    278 
    279         status_t dumpBase(int fd, const Vector<String16>& args);
    280 
    281         // base for record and playback
    282         class TrackBase : public AudioBufferProvider, public RefBase {
    283 
    284         public:
    285             enum track_state {
    286                 IDLE,
    287                 TERMINATED,
    288                 STOPPED,
    289                 RESUMING,
    290                 ACTIVE,
    291                 PAUSING,
    292                 PAUSED
    293             };
    294 
    295             enum track_flags {
    296                 STEPSERVER_FAILED = 0x01, //  StepServer could not acquire cblk->lock mutex
    297                 SYSTEM_FLAGS_MASK = 0x0000ffffUL,
    298                 // The upper 16 bits are used for track-specific flags.
    299             };
    300 
    301                                 TrackBase(const wp<ThreadBase>& thread,
    302                                         const sp<Client>& client,
    303                                         uint32_t sampleRate,
    304                                         int format,
    305                                         int channelCount,
    306                                         int frameCount,
    307                                         uint32_t flags,
    308                                         const sp<IMemory>& sharedBuffer,
    309                                         int sessionId);
    310                                 ~TrackBase();
    311 
    312             virtual status_t    start() = 0;
    313             virtual void        stop() = 0;
    314                     sp<IMemory> getCblk() const;
    315                     audio_track_cblk_t* cblk() const { return mCblk; }
    316                     int         sessionId() { return mSessionId; }
    317 
    318         protected:
    319             friend class ThreadBase;
    320             friend class RecordHandle;
    321             friend class PlaybackThread;
    322             friend class RecordThread;
    323             friend class MixerThread;
    324             friend class DirectOutputThread;
    325 
    326                                 TrackBase(const TrackBase&);
    327                                 TrackBase& operator = (const TrackBase&);
    328 
    329             virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0;
    330             virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
    331 
    332             int format() const {
    333                 return mFormat;
    334             }
    335 
    336             int channelCount() const ;
    337 
    338             int sampleRate() const;
    339 
    340             void* getBuffer(uint32_t offset, uint32_t frames) const;
    341 
    342             bool isStopped() const {
    343                 return mState == STOPPED;
    344             }
    345 
    346             bool isTerminated() const {
    347                 return mState == TERMINATED;
    348             }
    349 
    350             bool step();
    351             void reset();
    352 
    353             wp<ThreadBase>      mThread;
    354             sp<Client>          mClient;
    355             sp<IMemory>         mCblkMemory;
    356             audio_track_cblk_t* mCblk;
    357             void*               mBuffer;
    358             void*               mBufferEnd;
    359             uint32_t            mFrameCount;
    360             // we don't really need a lock for these
    361             int                 mState;
    362             int                 mClientTid;
    363             uint8_t             mFormat;
    364             uint32_t            mFlags;
    365             int                 mSessionId;
    366         };
    367 
    368         class ConfigEvent {
    369         public:
    370             ConfigEvent() : mEvent(0), mParam(0) {}
    371 
    372             int mEvent;
    373             int mParam;
    374         };
    375 
    376                     uint32_t    sampleRate() const;
    377                     int         channelCount() const;
    378                     int         format() const;
    379                     size_t      frameCount() const;
    380                     void        wakeUp()    { mWaitWorkCV.broadcast(); }
    381                     void        exit();
    382         virtual     bool        checkForNewParameters_l() = 0;
    383         virtual     status_t    setParameters(const String8& keyValuePairs);
    384         virtual     String8     getParameters(const String8& keys) = 0;
    385         virtual     void        audioConfigChanged_l(int event, int param = 0) = 0;
    386                     void        sendConfigEvent(int event, int param = 0);
    387                     void        sendConfigEvent_l(int event, int param = 0);
    388                     void        processConfigEvents();
    389                     int         id() const { return mId;}
    390                     bool        standby() { return mStandby; }
    391 
    392         mutable     Mutex                   mLock;
    393 
    394     protected:
    395 
    396         friend class Track;
    397         friend class TrackBase;
    398         friend class PlaybackThread;
    399         friend class MixerThread;
    400         friend class DirectOutputThread;
    401         friend class DuplicatingThread;
    402         friend class RecordThread;
    403         friend class RecordTrack;
    404 
    405                     Condition               mWaitWorkCV;
    406                     sp<AudioFlinger>        mAudioFlinger;
    407                     uint32_t                mSampleRate;
    408                     size_t                  mFrameCount;
    409                     uint32_t                mChannels;
    410                     uint16_t                mChannelCount;
    411                     uint16_t                mFrameSize;
    412                     int                     mFormat;
    413                     Condition               mParamCond;
    414                     Vector<String8>         mNewParameters;
    415                     status_t                mParamStatus;
    416                     Vector<ConfigEvent *>   mConfigEvents;
    417                     bool                    mStandby;
    418                     int                     mId;
    419                     bool                    mExiting;
    420     };
    421 
    422     // --- PlaybackThread ---
    423     class PlaybackThread : public ThreadBase {
    424     public:
    425 
    426         enum type {
    427             MIXER,
    428             DIRECT,
    429             DUPLICATING
    430         };
    431 
    432         enum mixer_state {
    433             MIXER_IDLE,
    434             MIXER_TRACKS_ENABLED,
    435             MIXER_TRACKS_READY
    436         };
    437 
    438         // playback track
    439         class Track : public TrackBase {
    440         public:
    441                                 Track(  const wp<ThreadBase>& thread,
    442                                         const sp<Client>& client,
    443                                         int streamType,
    444                                         uint32_t sampleRate,
    445                                         int format,
    446                                         int channelCount,
    447                                         int frameCount,
    448                                         const sp<IMemory>& sharedBuffer,
    449                                         int sessionId);
    450                                 ~Track();
    451 
    452                     void        dump(char* buffer, size_t size);
    453             virtual status_t    start();
    454             virtual void        stop();
    455                     void        pause();
    456 
    457                     void        flush();
    458                     void        destroy();
    459                     void        mute(bool);
    460                     void        setVolume(float left, float right);
    461                     int name() const {
    462                         return mName;
    463                     }
    464 
    465                     int type() const {
    466                         return mStreamType;
    467                     }
    468                     status_t    attachAuxEffect(int EffectId);
    469                     void        setAuxBuffer(int EffectId, int32_t *buffer);
    470                     int32_t     *auxBuffer() { return mAuxBuffer; }
    471                     void        setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; }
    472                     int16_t     *mainBuffer() { return mMainBuffer; }
    473                     int         auxEffectId() { return mAuxEffectId; }
    474 
    475 
    476         protected:
    477             friend class ThreadBase;
    478             friend class AudioFlinger;
    479             friend class TrackHandle;
    480             friend class PlaybackThread;
    481             friend class MixerThread;
    482             friend class DirectOutputThread;
    483 
    484                                 Track(const Track&);
    485                                 Track& operator = (const Track&);
    486 
    487             virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
    488             bool isMuted() { return mMute; }
    489             bool isPausing() const {
    490                 return mState == PAUSING;
    491             }
    492             bool isPaused() const {
    493                 return mState == PAUSED;
    494             }
    495             bool isReady() const;
    496             void setPaused() { mState = PAUSED; }
    497             void reset();
    498 
    499             bool isOutputTrack() const {
    500                 return (mStreamType == AudioSystem::NUM_STREAM_TYPES);
    501             }
    502 
    503             // we don't really need a lock for these
    504             float               mVolume[2];
    505             volatile bool       mMute;
    506             // FILLED state is used for suppressing volume ramp at begin of playing
    507             enum {FS_FILLING, FS_FILLED, FS_ACTIVE};
    508             mutable uint8_t     mFillingUpStatus;
    509             int8_t              mRetryCount;
    510             sp<IMemory>         mSharedBuffer;
    511             bool                mResetDone;
    512             int                 mStreamType;
    513             int                 mName;
    514             int16_t             *mMainBuffer;
    515             int32_t             *mAuxBuffer;
    516             int                 mAuxEffectId;
    517             bool                mHasVolumeController;
    518         };  // end of Track
    519 
    520 
    521         // playback track
    522         class OutputTrack : public Track {
    523         public:
    524 
    525             class Buffer: public AudioBufferProvider::Buffer {
    526             public:
    527                 int16_t *mBuffer;
    528             };
    529 
    530                                 OutputTrack(  const wp<ThreadBase>& thread,
    531                                         DuplicatingThread *sourceThread,
    532                                         uint32_t sampleRate,
    533                                         int format,
    534                                         int channelCount,
    535                                         int frameCount);
    536                                 ~OutputTrack();
    537 
    538             virtual status_t    start();
    539             virtual void        stop();
    540                     bool        write(int16_t* data, uint32_t frames);
    541                     bool        bufferQueueEmpty() { return (mBufferQueue.size() == 0) ? true : false; }
    542                     bool        isActive() { return mActive; }
    543             wp<ThreadBase>&     thread()  { return mThread; }
    544 
    545         private:
    546 
    547             status_t            obtainBuffer(AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs);
    548             void                clearBufferQueue();
    549 
    550             // Maximum number of pending buffers allocated by OutputTrack::write()
    551             static const uint8_t kMaxOverFlowBuffers = 10;
    552 
    553             Vector < Buffer* >          mBufferQueue;
    554             AudioBufferProvider::Buffer mOutBuffer;
    555             bool                        mActive;
    556             DuplicatingThread*          mSourceThread;
    557         };  // end of OutputTrack
    558 
    559         PlaybackThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
    560         virtual             ~PlaybackThread();
    561 
    562         virtual     status_t    dump(int fd, const Vector<String16>& args);
    563 
    564         // Thread virtuals
    565         virtual     status_t    readyToRun();
    566         virtual     void        onFirstRef();
    567 
    568         virtual     uint32_t    latency() const;
    569 
    570         virtual     status_t    setMasterVolume(float value);
    571         virtual     status_t    setMasterMute(bool muted);
    572 
    573         virtual     float       masterVolume() const;
    574         virtual     bool        masterMute() const;
    575 
    576         virtual     status_t    setStreamVolume(int stream, float value);
    577         virtual     status_t    setStreamMute(int stream, bool muted);
    578 
    579         virtual     float       streamVolume(int stream) const;
    580         virtual     bool        streamMute(int stream) const;
    581 
    582                     bool        isStreamActive(int stream) const;
    583 
    584                     sp<Track>   createTrack_l(
    585                                     const sp<AudioFlinger::Client>& client,
    586                                     int streamType,
    587                                     uint32_t sampleRate,
    588                                     int format,
    589                                     int channelCount,
    590                                     int frameCount,
    591                                     const sp<IMemory>& sharedBuffer,
    592                                     int sessionId,
    593                                     status_t *status);
    594 
    595                     AudioStreamOut* getOutput() { return mOutput; }
    596 
    597         virtual     int         type() const { return mType; }
    598                     void        suspend() { mSuspended++; }
    599                     void        restore() { if (mSuspended) mSuspended--; }
    600                     bool        isSuspended() { return (mSuspended != 0); }
    601         virtual     String8     getParameters(const String8& keys);
    602         virtual     void        audioConfigChanged_l(int event, int param = 0);
    603         virtual     status_t    getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames);
    604                     int16_t     *mixBuffer() { return mMixBuffer; };
    605 
    606                     sp<EffectHandle> createEffect_l(
    607                                         const sp<AudioFlinger::Client>& client,
    608                                         const sp<IEffectClient>& effectClient,
    609                                         int32_t priority,
    610                                         int sessionId,
    611                                         effect_descriptor_t *desc,
    612                                         int *enabled,
    613                                         status_t *status);
    614                     void disconnectEffect(const sp< EffectModule>& effect,
    615                                           const wp<EffectHandle>& handle);
    616 
    617                     // return values for hasAudioSession (bit field)
    618                     enum effect_state {
    619                         EFFECT_SESSION = 0x1,   // the audio session corresponds to at least one
    620                                                 // effect
    621                         TRACK_SESSION = 0x2     // the audio session corresponds to at least one
    622                                                 // track
    623                     };
    624 
    625                     uint32_t hasAudioSession(int sessionId);
    626                     sp<EffectChain> getEffectChain(int sessionId);
    627                     sp<EffectChain> getEffectChain_l(int sessionId);
    628                     status_t addEffectChain_l(const sp<EffectChain>& chain);
    629                     size_t removeEffectChain_l(const sp<EffectChain>& chain);
    630                     void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains);
    631                     void unlockEffectChains(Vector<sp <EffectChain> >& effectChains);
    632 
    633                     sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId);
    634                     void detachAuxEffect_l(int effectId);
    635                     status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track,
    636                             int EffectId);
    637                     status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track,
    638                             int EffectId);
    639                     void setMode(uint32_t mode);
    640 
    641                     status_t addEffect_l(const sp< EffectModule>& effect);
    642                     void removeEffect_l(const sp< EffectModule>& effect);
    643 
    644                     uint32_t getStrategyForSession_l(int sessionId);
    645 
    646         struct  stream_type_t {
    647             stream_type_t()
    648                 :   volume(1.0f),
    649                     mute(false)
    650             {
    651             }
    652             float       volume;
    653             bool        mute;
    654         };
    655 
    656     protected:
    657         int                             mType;
    658         int16_t*                        mMixBuffer;
    659         int                             mSuspended;
    660         int                             mBytesWritten;
    661         bool                            mMasterMute;
    662         SortedVector< wp<Track> >       mActiveTracks;
    663 
    664         virtual int             getTrackName_l() = 0;
    665         virtual void            deleteTrackName_l(int name) = 0;
    666         virtual uint32_t        activeSleepTimeUs() = 0;
    667         virtual uint32_t        idleSleepTimeUs() = 0;
    668         virtual uint32_t        suspendSleepTimeUs() = 0;
    669 
    670     private:
    671 
    672         friend class AudioFlinger;
    673         friend class OutputTrack;
    674         friend class Track;
    675         friend class TrackBase;
    676         friend class MixerThread;
    677         friend class DirectOutputThread;
    678         friend class DuplicatingThread;
    679 
    680         PlaybackThread(const Client&);
    681         PlaybackThread& operator = (const PlaybackThread&);
    682 
    683         status_t    addTrack_l(const sp<Track>& track);
    684         void        destroyTrack_l(const sp<Track>& track);
    685 
    686         void        readOutputParameters();
    687 
    688         uint32_t    device() { return mDevice; }
    689 
    690         virtual status_t    dumpInternals(int fd, const Vector<String16>& args);
    691         status_t    dumpTracks(int fd, const Vector<String16>& args);
    692         status_t    dumpEffectChains(int fd, const Vector<String16>& args);
    693 
    694         SortedVector< sp<Track> >       mTracks;
    695         // mStreamTypes[] uses 1 additionnal stream type internally for the OutputTrack used by DuplicatingThread
    696         stream_type_t                   mStreamTypes[AudioSystem::NUM_STREAM_TYPES + 1];
    697         AudioStreamOut*                 mOutput;
    698         float                           mMasterVolume;
    699         nsecs_t                         mLastWriteTime;
    700         int                             mNumWrites;
    701         int                             mNumDelayedWrites;
    702         bool                            mInWrite;
    703         Vector< sp<EffectChain> >       mEffectChains;
    704         uint32_t                        mDevice;
    705     };
    706 
    707     class MixerThread : public PlaybackThread {
    708     public:
    709         MixerThread (const sp<AudioFlinger>& audioFlinger,
    710                      AudioStreamOut* output,
    711                      int id,
    712                      uint32_t device);
    713         virtual             ~MixerThread();
    714 
    715         // Thread virtuals
    716         virtual     bool        threadLoop();
    717 
    718                     void        invalidateTracks(int streamType);
    719         virtual     bool        checkForNewParameters_l();
    720         virtual     status_t    dumpInternals(int fd, const Vector<String16>& args);
    721 
    722     protected:
    723                     uint32_t    prepareTracks_l(const SortedVector< wp<Track> >& activeTracks,
    724                                                 Vector< sp<Track> > *tracksToRemove);
    725         virtual     int         getTrackName_l();
    726         virtual     void        deleteTrackName_l(int name);
    727         virtual     uint32_t    activeSleepTimeUs();
    728         virtual     uint32_t    idleSleepTimeUs();
    729         virtual     uint32_t    suspendSleepTimeUs();
    730 
    731         AudioMixer*                     mAudioMixer;
    732     };
    733 
    734     class DirectOutputThread : public PlaybackThread {
    735     public:
    736 
    737         DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
    738         ~DirectOutputThread();
    739 
    740         // Thread virtuals
    741         virtual     bool        threadLoop();
    742 
    743         virtual     bool        checkForNewParameters_l();
    744 
    745     protected:
    746         virtual     int         getTrackName_l();
    747         virtual     void        deleteTrackName_l(int name);
    748         virtual     uint32_t    activeSleepTimeUs();
    749         virtual     uint32_t    idleSleepTimeUs();
    750         virtual     uint32_t    suspendSleepTimeUs();
    751 
    752     private:
    753         void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp);
    754 
    755         float mLeftVolFloat;
    756         float mRightVolFloat;
    757         uint16_t mLeftVolShort;
    758         uint16_t mRightVolShort;
    759     };
    760 
    761     class DuplicatingThread : public MixerThread {
    762     public:
    763         DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, int id);
    764         ~DuplicatingThread();
    765 
    766         // Thread virtuals
    767         virtual     bool        threadLoop();
    768                     void        addOutputTrack(MixerThread* thread);
    769                     void        removeOutputTrack(MixerThread* thread);
    770                     uint32_t    waitTimeMs() { return mWaitTimeMs; }
    771     protected:
    772         virtual     uint32_t    activeSleepTimeUs();
    773 
    774     private:
    775                     bool        outputsReady(SortedVector< sp<OutputTrack> > &outputTracks);
    776                     void        updateWaitTime();
    777 
    778         SortedVector < sp<OutputTrack> >  mOutputTracks;
    779                     uint32_t    mWaitTimeMs;
    780     };
    781 
    782               PlaybackThread *checkPlaybackThread_l(int output) const;
    783               MixerThread *checkMixerThread_l(int output) const;
    784               RecordThread *checkRecordThread_l(int input) const;
    785               float streamVolumeInternal(int stream) const { return mStreamTypes[stream].volume; }
    786               void audioConfigChanged_l(int event, int ioHandle, void *param2);
    787 
    788               int  nextUniqueId();
    789               status_t moveEffectChain_l(int session,
    790                                      AudioFlinger::PlaybackThread *srcThread,
    791                                      AudioFlinger::PlaybackThread *dstThread,
    792                                      bool reRegister);
    793 
    794     friend class AudioBuffer;
    795 
    796     class TrackHandle : public android::BnAudioTrack {
    797     public:
    798                             TrackHandle(const sp<PlaybackThread::Track>& track);
    799         virtual             ~TrackHandle();
    800         virtual status_t    start();
    801         virtual void        stop();
    802         virtual void        flush();
    803         virtual void        mute(bool);
    804         virtual void        pause();
    805         virtual void        setVolume(float left, float right);
    806         virtual sp<IMemory> getCblk() const;
    807         virtual status_t    attachAuxEffect(int effectId);
    808         virtual status_t onTransact(
    809             uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
    810     private:
    811         sp<PlaybackThread::Track> mTrack;
    812     };
    813 
    814     friend class Client;
    815     friend class PlaybackThread::Track;
    816 
    817 
    818                 void        removeClient_l(pid_t pid);
    819                 void        removeNotificationClient(pid_t pid);
    820 
    821 
    822     // record thread
    823     class RecordThread : public ThreadBase, public AudioBufferProvider
    824     {
    825     public:
    826 
    827         // record track
    828         class RecordTrack : public TrackBase {
    829         public:
    830                                 RecordTrack(const wp<ThreadBase>& thread,
    831                                         const sp<Client>& client,
    832                                         uint32_t sampleRate,
    833                                         int format,
    834                                         int channelCount,
    835                                         int frameCount,
    836                                         uint32_t flags,
    837                                         int sessionId);
    838                                 ~RecordTrack();
    839 
    840             virtual status_t    start();
    841             virtual void        stop();
    842 
    843                     bool        overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; }
    844                     bool        setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; }
    845 
    846                     void        dump(char* buffer, size_t size);
    847         private:
    848             friend class AudioFlinger;
    849             friend class RecordThread;
    850 
    851                                 RecordTrack(const RecordTrack&);
    852                                 RecordTrack& operator = (const RecordTrack&);
    853 
    854             virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
    855 
    856             bool                mOverflow;
    857         };
    858 
    859 
    860                 RecordThread(const sp<AudioFlinger>& audioFlinger,
    861                         AudioStreamIn *input,
    862                         uint32_t sampleRate,
    863                         uint32_t channels,
    864                         int id);
    865                 ~RecordThread();
    866 
    867         virtual bool        threadLoop();
    868         virtual status_t    readyToRun() { return NO_ERROR; }
    869         virtual void        onFirstRef();
    870 
    871                 status_t    start(RecordTrack* recordTrack);
    872                 void        stop(RecordTrack* recordTrack);
    873                 status_t    dump(int fd, const Vector<String16>& args);
    874                 AudioStreamIn* getInput() { return mInput; }
    875 
    876         virtual status_t    getNextBuffer(AudioBufferProvider::Buffer* buffer);
    877         virtual void        releaseBuffer(AudioBufferProvider::Buffer* buffer);
    878         virtual bool        checkForNewParameters_l();
    879         virtual String8     getParameters(const String8& keys);
    880         virtual void        audioConfigChanged_l(int event, int param = 0);
    881                 void        readInputParameters();
    882         virtual unsigned int  getInputFramesLost();
    883 
    884     private:
    885                 RecordThread();
    886                 AudioStreamIn                       *mInput;
    887                 sp<RecordTrack>                     mActiveTrack;
    888                 Condition                           mStartStopCond;
    889                 AudioResampler                      *mResampler;
    890                 int32_t                             *mRsmpOutBuffer;
    891                 int16_t                             *mRsmpInBuffer;
    892                 size_t                              mRsmpInIndex;
    893                 size_t                              mInputBytes;
    894                 int                                 mReqChannelCount;
    895                 uint32_t                            mReqSampleRate;
    896                 ssize_t                             mBytesRead;
    897     };
    898 
    899     class RecordHandle : public android::BnAudioRecord {
    900     public:
    901         RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack);
    902         virtual             ~RecordHandle();
    903         virtual status_t    start();
    904         virtual void        stop();
    905         virtual sp<IMemory> getCblk() const;
    906         virtual status_t onTransact(
    907             uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
    908     private:
    909         sp<RecordThread::RecordTrack> mRecordTrack;
    910     };
    911 
    912     //--- Audio Effect Management
    913 
    914     // EffectModule and EffectChain classes both have their own mutex to protect
    915     // state changes or resource modifications. Always respect the following order
    916     // if multiple mutexes must be acquired to avoid cross deadlock:
    917     // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule
    918 
    919     // The EffectModule class is a wrapper object controlling the effect engine implementation
    920     // in the effect library. It prevents concurrent calls to process() and command() functions
    921     // from different client threads. It keeps a list of EffectHandle objects corresponding
    922     // to all client applications using this effect and notifies applications of effect state,
    923     // control or parameter changes. It manages the activation state machine to send appropriate
    924     // reset, enable, disable commands to effect engine and provide volume
    925     // ramping when effects are activated/deactivated.
    926     // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by
    927     // the attached track(s) to accumulate their auxiliary channel.
    928     class EffectModule: public RefBase {
    929     public:
    930         EffectModule(const wp<ThreadBase>& wThread,
    931                         const wp<AudioFlinger::EffectChain>& chain,
    932                         effect_descriptor_t *desc,
    933                         int id,
    934                         int sessionId);
    935         ~EffectModule();
    936 
    937         enum effect_state {
    938             IDLE,
    939             RESTART,
    940             STARTING,
    941             ACTIVE,
    942             STOPPING,
    943             STOPPED
    944         };
    945 
    946         int         id() { return mId; }
    947         void process();
    948         void updateState();
    949         status_t command(uint32_t cmdCode,
    950                          uint32_t cmdSize,
    951                          void *pCmdData,
    952                          uint32_t *replySize,
    953                          void *pReplyData);
    954 
    955         void reset_l();
    956         status_t configure();
    957         status_t init();
    958         uint32_t state() {
    959             return mState;
    960         }
    961         uint32_t status() {
    962             return mStatus;
    963         }
    964         int sessionId() {
    965             return mSessionId;
    966         }
    967         status_t    setEnabled(bool enabled);
    968         bool isEnabled();
    969         bool isProcessEnabled();
    970 
    971         void        setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; }
    972         int16_t     *inBuffer() { return mConfig.inputCfg.buffer.s16; }
    973         void        setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; }
    974         int16_t     *outBuffer() { return mConfig.outputCfg.buffer.s16; }
    975         void        setChain(const wp<EffectChain>& chain) { mChain = chain; }
    976         void        setThread(const wp<ThreadBase>& thread) { mThread = thread; }
    977 
    978         status_t addHandle(sp<EffectHandle>& handle);
    979         void disconnect(const wp<EffectHandle>& handle);
    980         size_t removeHandle (const wp<EffectHandle>& handle);
    981 
    982         effect_descriptor_t& desc() { return mDescriptor; }
    983         wp<EffectChain>&     chain() { return mChain; }
    984 
    985         status_t         setDevice(uint32_t device);
    986         status_t         setVolume(uint32_t *left, uint32_t *right, bool controller);
    987         status_t         setMode(uint32_t mode);
    988 
    989         status_t         dump(int fd, const Vector<String16>& args);
    990 
    991     protected:
    992 
    993         // Maximum time allocated to effect engines to complete the turn off sequence
    994         static const uint32_t MAX_DISABLE_TIME_MS = 10000;
    995 
    996         EffectModule(const EffectModule&);
    997         EffectModule& operator = (const EffectModule&);
    998 
    999         status_t start_l();
   1000         status_t stop_l();
   1001 
   1002         // update this table when AudioSystem::audio_devices or audio_device_e (in EffectApi.h) are modified
   1003         static const uint32_t sDeviceConvTable[];
   1004         static uint32_t deviceAudioSystemToEffectApi(uint32_t device);
   1005 
   1006         // update this table when AudioSystem::audio_mode or audio_mode_e (in EffectApi.h) are modified
   1007         static const uint32_t sModeConvTable[];
   1008         static int modeAudioSystemToEffectApi(uint32_t mode);
   1009 
   1010         Mutex               mLock;      // mutex for process, commands and handles list protection
   1011         wp<ThreadBase>      mThread;    // parent thread
   1012         wp<EffectChain>     mChain;     // parent effect chain
   1013         int                 mId;        // this instance unique ID
   1014         int                 mSessionId; // audio session ID
   1015         effect_descriptor_t mDescriptor;// effect descriptor received from effect engine
   1016         effect_config_t     mConfig;    // input and output audio configuration
   1017         effect_interface_t  mEffectInterface; // Effect module C API
   1018         status_t mStatus;               // initialization status
   1019         uint32_t mState;                // current activation state (effect_state)
   1020         Vector< wp<EffectHandle> > mHandles;    // list of client handles
   1021         uint32_t mMaxDisableWaitCnt;    // maximum grace period before forcing an effect off after
   1022                                         // sending disable command.
   1023         uint32_t mDisableWaitCnt;       // current process() calls count during disable period.
   1024     };
   1025 
   1026     // The EffectHandle class implements the IEffect interface. It provides resources
   1027     // to receive parameter updates, keeps track of effect control
   1028     // ownership and state and has a pointer to the EffectModule object it is controlling.
   1029     // There is one EffectHandle object for each application controlling (or using)
   1030     // an effect module.
   1031     // The EffectHandle is obtained by calling AudioFlinger::createEffect().
   1032     class EffectHandle: public android::BnEffect {
   1033     public:
   1034 
   1035         EffectHandle(const sp<EffectModule>& effect,
   1036                 const sp<AudioFlinger::Client>& client,
   1037                 const sp<IEffectClient>& effectClient,
   1038                 int32_t priority);
   1039         virtual ~EffectHandle();
   1040 
   1041         // IEffect
   1042         virtual status_t enable();
   1043         virtual status_t disable();
   1044         virtual status_t command(uint32_t cmdCode,
   1045                                  uint32_t cmdSize,
   1046                                  void *pCmdData,
   1047                                  uint32_t *replySize,
   1048                                  void *pReplyData);
   1049         virtual void disconnect();
   1050         virtual sp<IMemory> getCblk() const;
   1051         virtual status_t onTransact(uint32_t code, const Parcel& data,
   1052                 Parcel* reply, uint32_t flags);
   1053 
   1054 
   1055         // Give or take control of effect module
   1056         void setControl(bool hasControl, bool signal);
   1057         void commandExecuted(uint32_t cmdCode,
   1058                              uint32_t cmdSize,
   1059                              void *pCmdData,
   1060                              uint32_t replySize,
   1061                              void *pReplyData);
   1062         void setEnabled(bool enabled);
   1063 
   1064         // Getters
   1065         int id() { return mEffect->id(); }
   1066         int priority() { return mPriority; }
   1067         bool hasControl() { return mHasControl; }
   1068         sp<EffectModule> effect() { return mEffect; }
   1069 
   1070         void dump(char* buffer, size_t size);
   1071 
   1072     protected:
   1073 
   1074         EffectHandle(const EffectHandle&);
   1075         EffectHandle& operator =(const EffectHandle&);
   1076 
   1077         sp<EffectModule> mEffect;           // pointer to controlled EffectModule
   1078         sp<IEffectClient> mEffectClient;    // callback interface for client notifications
   1079         sp<Client>          mClient;        // client for shared memory allocation
   1080         sp<IMemory>         mCblkMemory;    // shared memory for control block
   1081         effect_param_cblk_t* mCblk;         // control block for deferred parameter setting via shared memory
   1082         uint8_t*            mBuffer;        // pointer to parameter area in shared memory
   1083         int mPriority;                      // client application priority to control the effect
   1084         bool mHasControl;                   // true if this handle is controlling the effect
   1085     };
   1086 
   1087     // the EffectChain class represents a group of effects associated to one audio session.
   1088     // There can be any number of EffectChain objects per output mixer thread (PlaybackThread).
   1089     // The EffecChain with session ID 0 contains global effects applied to the output mix.
   1090     // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks)
   1091     // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding
   1092     // in the effect process order. When attached to a track (session ID != 0), it also provide it's own
   1093     // input buffer used by the track as accumulation buffer.
   1094     class EffectChain: public RefBase {
   1095     public:
   1096         EffectChain(const wp<ThreadBase>& wThread, int sessionId);
   1097         ~EffectChain();
   1098 
   1099         void process_l();
   1100 
   1101         void lock() {
   1102             mLock.lock();
   1103         }
   1104         void unlock() {
   1105             mLock.unlock();
   1106         }
   1107 
   1108         status_t addEffect_l(const sp<EffectModule>& handle);
   1109         size_t removeEffect_l(const sp<EffectModule>& handle);
   1110 
   1111         int sessionId() {
   1112             return mSessionId;
   1113         }
   1114 
   1115         sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor);
   1116         sp<EffectModule> getEffectFromId_l(int id);
   1117         bool setVolume_l(uint32_t *left, uint32_t *right);
   1118         void setDevice_l(uint32_t device);
   1119         void setMode_l(uint32_t mode);
   1120 
   1121         void setInBuffer(int16_t *buffer, bool ownsBuffer = false) {
   1122             mInBuffer = buffer;
   1123             mOwnInBuffer = ownsBuffer;
   1124         }
   1125         int16_t *inBuffer() {
   1126             return mInBuffer;
   1127         }
   1128         void setOutBuffer(int16_t *buffer) {
   1129             mOutBuffer = buffer;
   1130         }
   1131         int16_t *outBuffer() {
   1132             return mOutBuffer;
   1133         }
   1134 
   1135         void startTrack() {mActiveTrackCnt++;}
   1136         void stopTrack() {mActiveTrackCnt--;}
   1137         int activeTracks() { return mActiveTrackCnt;}
   1138 
   1139         uint32_t strategy() { return mStrategy; }
   1140         void setStrategy(uint32_t strategy)
   1141                  { mStrategy = strategy; }
   1142 
   1143         status_t dump(int fd, const Vector<String16>& args);
   1144 
   1145     protected:
   1146 
   1147         EffectChain(const EffectChain&);
   1148         EffectChain& operator =(const EffectChain&);
   1149 
   1150         wp<ThreadBase> mThread;     // parent mixer thread
   1151         Mutex mLock;                // mutex protecting effect list
   1152         Vector<sp<EffectModule> > mEffects; // list of effect modules
   1153         int mSessionId;             // audio session ID
   1154         int16_t *mInBuffer;         // chain input buffer
   1155         int16_t *mOutBuffer;        // chain output buffer
   1156         int mActiveTrackCnt;        // number of active tracks connected
   1157         bool mOwnInBuffer;          // true if the chain owns its input buffer
   1158         int mVolumeCtrlIdx;         // index of insert effect having control over volume
   1159         uint32_t mLeftVolume;       // previous volume on left channel
   1160         uint32_t mRightVolume;      // previous volume on right channel
   1161         uint32_t mNewLeftVolume;       // new volume on left channel
   1162         uint32_t mNewRightVolume;      // new volume on right channel
   1163         uint32_t mStrategy; // strategy for this effect chain
   1164     };
   1165 
   1166     friend class RecordThread;
   1167     friend class PlaybackThread;
   1168 
   1169 
   1170     mutable     Mutex                               mLock;
   1171 
   1172                 DefaultKeyedVector< pid_t, wp<Client> >     mClients;
   1173 
   1174                 mutable     Mutex                   mHardwareLock;
   1175                 AudioHardwareInterface*             mAudioHardware;
   1176     mutable     int                                 mHardwareStatus;
   1177 
   1178 
   1179                 DefaultKeyedVector< int, sp<PlaybackThread> >  mPlaybackThreads;
   1180                 PlaybackThread::stream_type_t       mStreamTypes[AudioSystem::NUM_STREAM_TYPES];
   1181                 float                               mMasterVolume;
   1182                 bool                                mMasterMute;
   1183 
   1184                 DefaultKeyedVector< int, sp<RecordThread> >    mRecordThreads;
   1185 
   1186                 DefaultKeyedVector< pid_t, sp<NotificationClient> >    mNotificationClients;
   1187                 volatile int32_t                    mNextUniqueId;
   1188 #ifdef LVMX
   1189                 int mLifeVibesClientPid;
   1190 #endif
   1191                 uint32_t mMode;
   1192 
   1193 };
   1194 
   1195 // ----------------------------------------------------------------------------
   1196 
   1197 }; // namespace android
   1198 
   1199 #endif // ANDROID_AUDIO_FLINGER_H
   1200