AudioFlinger.h revision 65580f9adf6c4d98449ad0716488f9fe3869aa5a 
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_hal.h>
43
44#include "AudioBufferProvider.h"
45
46namespace android {
47
48class audio_track_cblk_t;
49class effect_param_cblk_t;
50class AudioMixer;
51class AudioBuffer;
52class AudioResampler;
53
54// ----------------------------------------------------------------------------
55
56#define LIKELY( exp )       (__builtin_expect( (exp) != 0, true  ))
57#define UNLIKELY( exp )     (__builtin_expect( (exp) != 0, false ))
58
59
60// ----------------------------------------------------------------------------
61
62static const nsecs_t kStandbyTimeInNsecs = seconds(3);
63
64class AudioFlinger :
65    public BinderService<AudioFlinger>,
66    public BnAudioFlinger
67{
68    friend class BinderService<AudioFlinger>;
69public:
70    static char const* getServiceName() { return "media.audio_flinger"; }
71
72    virtual     status_t    dump(int fd, const Vector<String16>& args);
73
74    // IAudioFlinger interface
75    virtual sp<IAudioTrack> createTrack(
76                                pid_t pid,
77                                int streamType,
78                                uint32_t sampleRate,
79                                int format,
80                                int channelCount,
81                                int frameCount,
82                                uint32_t flags,
83                                const sp<IMemory>& sharedBuffer,
84                                int output,
85                                int *sessionId,
86                                status_t *status);
87
88    virtual     uint32_t    sampleRate(int output) const;
89    virtual     int         channelCount(int output) const;
90    virtual     int         format(int output) const;
91    virtual     size_t      frameCount(int output) const;
92    virtual     uint32_t    latency(int output) const;
93
94    virtual     status_t    setMasterVolume(float value);
95    virtual     status_t    setMasterMute(bool muted);
96
97    virtual     float       masterVolume() const;
98    virtual     bool        masterMute() const;
99
100    virtual     status_t    setStreamVolume(int stream, float value, int output);
101    virtual     status_t    setStreamMute(int stream, bool muted);
102
103    virtual     float       streamVolume(int stream, int output) const;
104    virtual     bool        streamMute(int stream) const;
105
106    virtual     status_t    setMode(int mode);
107
108    virtual     status_t    setMicMute(bool state);
109    virtual     bool        getMicMute() const;
110
111    virtual     status_t    setParameters(int ioHandle, const String8& keyValuePairs);
112    virtual     String8     getParameters(int ioHandle, const String8& keys);
113
114    virtual     void        registerClient(const sp<IAudioFlingerClient>& client);
115
116    virtual     size_t      getInputBufferSize(uint32_t sampleRate, int format, int channelCount);
117    virtual     unsigned int  getInputFramesLost(int ioHandle);
118
119    virtual int openOutput(uint32_t *pDevices,
120                                    uint32_t *pSamplingRate,
121                                    uint32_t *pFormat,
122                                    uint32_t *pChannels,
123                                    uint32_t *pLatencyMs,
124                                    uint32_t flags);
125
126    virtual int openDuplicateOutput(int output1, int output2);
127
128    virtual status_t closeOutput(int output);
129
130    virtual status_t suspendOutput(int output);
131
132    virtual status_t restoreOutput(int output);
133
134    virtual int openInput(uint32_t *pDevices,
135                            uint32_t *pSamplingRate,
136                            uint32_t *pFormat,
137                            uint32_t *pChannels,
138                            uint32_t acoustics);
139
140    virtual status_t closeInput(int input);
141
142    virtual status_t setStreamOutput(uint32_t stream, int output);
143
144    virtual status_t setVoiceVolume(float volume);
145
146    virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, int output);
147
148    virtual int newAudioSessionId();
149
150    virtual status_t queryNumberEffects(uint32_t *numEffects);
151
152    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor);
153
154    virtual status_t getEffectDescriptor(effect_uuid_t *pUuid, effect_descriptor_t *descriptor);
155
156    virtual sp<IEffect> createEffect(pid_t pid,
157                        effect_descriptor_t *pDesc,
158                        const sp<IEffectClient>& effectClient,
159                        int32_t priority,
160                        int output,
161                        int sessionId,
162                        status_t *status,
163                        int *id,
164                        int *enabled);
165
166    virtual status_t moveEffects(int session, int srcOutput, int dstOutput);
167
168    enum hardware_call_state {
169        AUDIO_HW_IDLE = 0,
170        AUDIO_HW_INIT,
171        AUDIO_HW_OUTPUT_OPEN,
172        AUDIO_HW_OUTPUT_CLOSE,
173        AUDIO_HW_INPUT_OPEN,
174        AUDIO_HW_INPUT_CLOSE,
175        AUDIO_HW_STANDBY,
176        AUDIO_HW_SET_MASTER_VOLUME,
177        AUDIO_HW_GET_ROUTING,
178        AUDIO_HW_SET_ROUTING,
179        AUDIO_HW_GET_MODE,
180        AUDIO_HW_SET_MODE,
181        AUDIO_HW_GET_MIC_MUTE,
182        AUDIO_HW_SET_MIC_MUTE,
183        AUDIO_SET_VOICE_VOLUME,
184        AUDIO_SET_PARAMETER,
185    };
186
187    // record interface
188    virtual sp<IAudioRecord> openRecord(
189                                pid_t pid,
190                                int input,
191                                uint32_t sampleRate,
192                                int format,
193                                int channelCount,
194                                int frameCount,
195                                uint32_t flags,
196                                int *sessionId,
197                                status_t *status);
198
199    virtual     status_t    onTransact(
200                                uint32_t code,
201                                const Parcel& data,
202                                Parcel* reply,
203                                uint32_t flags);
204
205                uint32_t    getMode() { return mMode; }
206
207private:
208                            AudioFlinger();
209    virtual                 ~AudioFlinger();
210
211    status_t                initCheck() const;
212    virtual     void        onFirstRef();
213    audio_hw_device_t*      findSuitableHwDev_l(uint32_t devices);
214
215    // Internal dump utilites.
216    status_t dumpPermissionDenial(int fd, const Vector<String16>& args);
217    status_t dumpClients(int fd, const Vector<String16>& args);
218    status_t dumpInternals(int fd, const Vector<String16>& args);
219
220    // --- Client ---
221    class Client : public RefBase {
222    public:
223                            Client(const sp<AudioFlinger>& audioFlinger, pid_t pid);
224        virtual             ~Client();
225        const sp<MemoryDealer>&     heap() const;
226        pid_t               pid() const { return mPid; }
227        sp<AudioFlinger>    audioFlinger() { return mAudioFlinger; }
228
229    private:
230                            Client(const Client&);
231                            Client& operator = (const Client&);
232        sp<AudioFlinger>    mAudioFlinger;
233        sp<MemoryDealer>    mMemoryDealer;
234        pid_t               mPid;
235    };
236
237    // --- Notification Client ---
238    class NotificationClient : public IBinder::DeathRecipient {
239    public:
240                            NotificationClient(const sp<AudioFlinger>& audioFlinger,
241                                                const sp<IAudioFlingerClient>& client,
242                                                pid_t pid);
243        virtual             ~NotificationClient();
244
245                sp<IAudioFlingerClient>    client() { return mClient; }
246
247                // IBinder::DeathRecipient
248                virtual     void        binderDied(const wp<IBinder>& who);
249
250    private:
251                            NotificationClient(const NotificationClient&);
252                            NotificationClient& operator = (const NotificationClient&);
253
254        sp<AudioFlinger>        mAudioFlinger;
255        pid_t                   mPid;
256        sp<IAudioFlingerClient> mClient;
257    };
258
259    class TrackHandle;
260    class RecordHandle;
261    class RecordThread;
262    class PlaybackThread;
263    class MixerThread;
264    class DirectOutputThread;
265    class DuplicatingThread;
266    class Track;
267    class RecordTrack;
268    class EffectModule;
269    class EffectHandle;
270    class EffectChain;
271    struct AudioStreamOut;
272    struct AudioStreamIn;
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 == AUDIO_STREAM_CNT);
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                    sp<Track>   createTrack_l(
583                                    const sp<AudioFlinger::Client>& client,
584                                    int streamType,
585                                    uint32_t sampleRate,
586                                    int format,
587                                    int channelCount,
588                                    int frameCount,
589                                    const sp<IMemory>& sharedBuffer,
590                                    int sessionId,
591                                    status_t *status);
592
593                    AudioStreamOut* getOutput() { return mOutput; }
594
595        virtual     int         type() const { return mType; }
596                    void        suspend() { mSuspended++; }
597                    void        restore() { if (mSuspended) mSuspended--; }
598                    bool        isSuspended() { return (mSuspended != 0); }
599        virtual     String8     getParameters(const String8& keys);
600        virtual     void        audioConfigChanged_l(int event, int param = 0);
601        virtual     status_t    getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames);
602                    int16_t     *mixBuffer() { return mMixBuffer; };
603
604                    sp<EffectHandle> createEffect_l(
605                                        const sp<AudioFlinger::Client>& client,
606                                        const sp<IEffectClient>& effectClient,
607                                        int32_t priority,
608                                        int sessionId,
609                                        effect_descriptor_t *desc,
610                                        int *enabled,
611                                        status_t *status);
612                    void disconnectEffect(const sp< EffectModule>& effect,
613                                          const wp<EffectHandle>& handle);
614
615                    // return values for hasAudioSession (bit field)
616                    enum effect_state {
617                        EFFECT_SESSION = 0x1,   // the audio session corresponds to at least one
618                                                // effect
619                        TRACK_SESSION = 0x2     // the audio session corresponds to at least one
620                                                // track
621                    };
622
623                    uint32_t hasAudioSession(int sessionId);
624                    sp<EffectChain> getEffectChain(int sessionId);
625                    sp<EffectChain> getEffectChain_l(int sessionId);
626                    status_t addEffectChain_l(const sp<EffectChain>& chain);
627                    size_t removeEffectChain_l(const sp<EffectChain>& chain);
628                    void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains);
629                    void unlockEffectChains(Vector<sp <EffectChain> >& effectChains);
630
631                    sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId);
632                    void detachAuxEffect_l(int effectId);
633                    status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track,
634                            int EffectId);
635                    status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track,
636                            int EffectId);
637                    void setMode(uint32_t mode);
638
639                    status_t addEffect_l(const sp< EffectModule>& effect);
640                    void removeEffect_l(const sp< EffectModule>& effect);
641
642                    uint32_t getStrategyForSession_l(int sessionId);
643
644        struct  stream_type_t {
645            stream_type_t()
646                :   volume(1.0f),
647                    mute(false)
648            {
649            }
650            float       volume;
651            bool        mute;
652        };
653
654    protected:
655        int                             mType;
656        int16_t*                        mMixBuffer;
657        int                             mSuspended;
658        int                             mBytesWritten;
659        bool                            mMasterMute;
660        SortedVector< wp<Track> >       mActiveTracks;
661
662        virtual int             getTrackName_l() = 0;
663        virtual void            deleteTrackName_l(int name) = 0;
664        virtual uint32_t        activeSleepTimeUs() = 0;
665        virtual uint32_t        idleSleepTimeUs() = 0;
666        virtual uint32_t        suspendSleepTimeUs() = 0;
667
668    private:
669
670        friend class AudioFlinger;
671        friend class OutputTrack;
672        friend class Track;
673        friend class TrackBase;
674        friend class MixerThread;
675        friend class DirectOutputThread;
676        friend class DuplicatingThread;
677
678        PlaybackThread(const Client&);
679        PlaybackThread& operator = (const PlaybackThread&);
680
681        status_t    addTrack_l(const sp<Track>& track);
682        void        destroyTrack_l(const sp<Track>& track);
683        void        removeTrack_l(const sp<Track>& track);
684
685        void        readOutputParameters();
686
687        uint32_t    device() { return mDevice; }
688
689        virtual status_t    dumpInternals(int fd, const Vector<String16>& args);
690        status_t    dumpTracks(int fd, const Vector<String16>& args);
691        status_t    dumpEffectChains(int fd, const Vector<String16>& args);
692
693        SortedVector< sp<Track> >       mTracks;
694        // mStreamTypes[] uses 1 additionnal stream type internally for the OutputTrack used by DuplicatingThread
695        stream_type_t                   mStreamTypes[AUDIO_STREAM_CNT + 1];
696        AudioStreamOut*                 mOutput;
697        float                           mMasterVolume;
698        nsecs_t                         mLastWriteTime;
699        int                             mNumWrites;
700        int                             mNumDelayedWrites;
701        bool                            mInWrite;
702        Vector< sp<EffectChain> >       mEffectChains;
703        uint32_t                        mDevice;
704    };
705
706    class MixerThread : public PlaybackThread {
707    public:
708        MixerThread (const sp<AudioFlinger>& audioFlinger,
709                     AudioStreamOut* output,
710                     int id,
711                     uint32_t device);
712        virtual             ~MixerThread();
713
714        // Thread virtuals
715        virtual     bool        threadLoop();
716
717                    void        invalidateTracks(int streamType);
718        virtual     bool        checkForNewParameters_l();
719        virtual     status_t    dumpInternals(int fd, const Vector<String16>& args);
720
721    protected:
722                    uint32_t    prepareTracks_l(const SortedVector< wp<Track> >& activeTracks,
723                                                Vector< sp<Track> > *tracksToRemove);
724        virtual     int         getTrackName_l();
725        virtual     void        deleteTrackName_l(int name);
726        virtual     uint32_t    activeSleepTimeUs();
727        virtual     uint32_t    idleSleepTimeUs();
728        virtual     uint32_t    suspendSleepTimeUs();
729
730        AudioMixer*                     mAudioMixer;
731    };
732
733    class DirectOutputThread : public PlaybackThread {
734    public:
735
736        DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device);
737        ~DirectOutputThread();
738
739        // Thread virtuals
740        virtual     bool        threadLoop();
741
742        virtual     bool        checkForNewParameters_l();
743
744    protected:
745        virtual     int         getTrackName_l();
746        virtual     void        deleteTrackName_l(int name);
747        virtual     uint32_t    activeSleepTimeUs();
748        virtual     uint32_t    idleSleepTimeUs();
749        virtual     uint32_t    suspendSleepTimeUs();
750
751    private:
752        void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp);
753
754        float mLeftVolFloat;
755        float mRightVolFloat;
756        uint16_t mLeftVolShort;
757        uint16_t mRightVolShort;
758    };
759
760    class DuplicatingThread : public MixerThread {
761    public:
762        DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, int id);
763        ~DuplicatingThread();
764
765        // Thread virtuals
766        virtual     bool        threadLoop();
767                    void        addOutputTrack(MixerThread* thread);
768                    void        removeOutputTrack(MixerThread* thread);
769                    uint32_t    waitTimeMs() { return mWaitTimeMs; }
770    protected:
771        virtual     uint32_t    activeSleepTimeUs();
772
773    private:
774                    bool        outputsReady(SortedVector< sp<OutputTrack> > &outputTracks);
775                    void        updateWaitTime();
776
777        SortedVector < sp<OutputTrack> >  mOutputTracks;
778                    uint32_t    mWaitTimeMs;
779    };
780
781              PlaybackThread *checkPlaybackThread_l(int output) const;
782              MixerThread *checkMixerThread_l(int output) const;
783              RecordThread *checkRecordThread_l(int input) const;
784              float streamVolumeInternal(int stream) const { return mStreamTypes[stream].volume; }
785              void audioConfigChanged_l(int event, int ioHandle, void *param2);
786
787              int  nextUniqueId_l();
788              status_t moveEffectChain_l(int session,
789                                     AudioFlinger::PlaybackThread *srcThread,
790                                     AudioFlinger::PlaybackThread *dstThread,
791                                     bool reRegister);
792
793    friend class AudioBuffer;
794
795    class TrackHandle : public android::BnAudioTrack {
796    public:
797                            TrackHandle(const sp<PlaybackThread::Track>& track);
798        virtual             ~TrackHandle();
799        virtual status_t    start();
800        virtual void        stop();
801        virtual void        flush();
802        virtual void        mute(bool);
803        virtual void        pause();
804        virtual void        setVolume(float left, float right);
805        virtual sp<IMemory> getCblk() const;
806        virtual status_t    attachAuxEffect(int effectId);
807        virtual status_t onTransact(
808            uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
809    private:
810        sp<PlaybackThread::Track> mTrack;
811    };
812
813    friend class Client;
814    friend class PlaybackThread::Track;
815
816
817                void        removeClient_l(pid_t pid);
818                void        removeNotificationClient(pid_t pid);
819
820
821    // record thread
822    class RecordThread : public ThreadBase, public AudioBufferProvider
823    {
824    public:
825
826        // record track
827        class RecordTrack : public TrackBase {
828        public:
829                                RecordTrack(const wp<ThreadBase>& thread,
830                                        const sp<Client>& client,
831                                        uint32_t sampleRate,
832                                        int format,
833                                        int channelCount,
834                                        int frameCount,
835                                        uint32_t flags,
836                                        int sessionId);
837                                ~RecordTrack();
838
839            virtual status_t    start();
840            virtual void        stop();
841
842                    bool        overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; }
843                    bool        setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; }
844
845                    void        dump(char* buffer, size_t size);
846        private:
847            friend class AudioFlinger;
848            friend class RecordThread;
849
850                                RecordTrack(const RecordTrack&);
851                                RecordTrack& operator = (const RecordTrack&);
852
853            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
854
855            bool                mOverflow;
856        };
857
858
859                RecordThread(const sp<AudioFlinger>& audioFlinger,
860                        AudioStreamIn *input,
861                        uint32_t sampleRate,
862                        uint32_t channels,
863                        int id);
864                ~RecordThread();
865
866        virtual bool        threadLoop();
867        virtual status_t    readyToRun() { return NO_ERROR; }
868        virtual void        onFirstRef();
869
870                status_t    start(RecordTrack* recordTrack);
871                void        stop(RecordTrack* recordTrack);
872                status_t    dump(int fd, const Vector<String16>& args);
873                AudioStreamIn* getInput() { return mInput; }
874
875        virtual status_t    getNextBuffer(AudioBufferProvider::Buffer* buffer);
876        virtual void        releaseBuffer(AudioBufferProvider::Buffer* buffer);
877        virtual bool        checkForNewParameters_l();
878        virtual String8     getParameters(const String8& keys);
879        virtual void        audioConfigChanged_l(int event, int param = 0);
880                void        readInputParameters();
881        virtual unsigned int  getInputFramesLost();
882
883    private:
884                RecordThread();
885                AudioStreamIn                       *mInput;
886                sp<RecordTrack>                     mActiveTrack;
887                Condition                           mStartStopCond;
888                AudioResampler                      *mResampler;
889                int32_t                             *mRsmpOutBuffer;
890                int16_t                             *mRsmpInBuffer;
891                size_t                              mRsmpInIndex;
892                size_t                              mInputBytes;
893                int                                 mReqChannelCount;
894                uint32_t                            mReqSampleRate;
895                ssize_t                             mBytesRead;
896    };
897
898    class RecordHandle : public android::BnAudioRecord {
899    public:
900        RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack);
901        virtual             ~RecordHandle();
902        virtual status_t    start();
903        virtual void        stop();
904        virtual sp<IMemory> getCblk() const;
905        virtual status_t onTransact(
906            uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags);
907    private:
908        sp<RecordThread::RecordTrack> mRecordTrack;
909    };
910
911    //--- Audio Effect Management
912
913    // EffectModule and EffectChain classes both have their own mutex to protect
914    // state changes or resource modifications. Always respect the following order
915    // if multiple mutexes must be acquired to avoid cross deadlock:
916    // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule
917
918    // The EffectModule class is a wrapper object controlling the effect engine implementation
919    // in the effect library. It prevents concurrent calls to process() and command() functions
920    // from different client threads. It keeps a list of EffectHandle objects corresponding
921    // to all client applications using this effect and notifies applications of effect state,
922    // control or parameter changes. It manages the activation state machine to send appropriate
923    // reset, enable, disable commands to effect engine and provide volume
924    // ramping when effects are activated/deactivated.
925    // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by
926    // the attached track(s) to accumulate their auxiliary channel.
927    class EffectModule: public RefBase {
928    public:
929        EffectModule(const wp<ThreadBase>& wThread,
930                        const wp<AudioFlinger::EffectChain>& chain,
931                        effect_descriptor_t *desc,
932                        int id,
933                        int sessionId);
934        ~EffectModule();
935
936        enum effect_state {
937            IDLE,
938            RESTART,
939            STARTING,
940            ACTIVE,
941            STOPPING,
942            STOPPED
943        };
944
945        int         id() { return mId; }
946        void process();
947        void updateState();
948        status_t command(uint32_t cmdCode,
949                         uint32_t cmdSize,
950                         void *pCmdData,
951                         uint32_t *replySize,
952                         void *pReplyData);
953
954        void reset_l();
955        status_t configure();
956        status_t init();
957        uint32_t state() {
958            return mState;
959        }
960        uint32_t status() {
961            return mStatus;
962        }
963        int sessionId() {
964            return mSessionId;
965        }
966        status_t    setEnabled(bool enabled);
967        bool isEnabled();
968        bool isProcessEnabled();
969
970        void        setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; }
971        int16_t     *inBuffer() { return mConfig.inputCfg.buffer.s16; }
972        void        setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; }
973        int16_t     *outBuffer() { return mConfig.outputCfg.buffer.s16; }
974        void        setChain(const wp<EffectChain>& chain) { mChain = chain; }
975        void        setThread(const wp<ThreadBase>& thread) { mThread = thread; }
976
977        status_t addHandle(sp<EffectHandle>& handle);
978        void disconnect(const wp<EffectHandle>& handle);
979        size_t removeHandle (const wp<EffectHandle>& handle);
980
981        effect_descriptor_t& desc() { return mDescriptor; }
982        wp<EffectChain>&     chain() { return mChain; }
983
984        status_t         setDevice(uint32_t device);
985        status_t         setVolume(uint32_t *left, uint32_t *right, bool controller);
986        status_t         setMode(uint32_t mode);
987
988        status_t         dump(int fd, const Vector<String16>& args);
989
990    protected:
991
992        // Maximum time allocated to effect engines to complete the turn off sequence
993        static const uint32_t MAX_DISABLE_TIME_MS = 10000;
994
995        EffectModule(const EffectModule&);
996        EffectModule& operator = (const EffectModule&);
997
998        status_t start_l();
999        status_t stop_l();
1000
1001        Mutex               mLock;      // mutex for process, commands and handles list protection
1002        wp<ThreadBase>      mThread;    // parent thread
1003        wp<EffectChain>     mChain;     // parent effect chain
1004        int                 mId;        // this instance unique ID
1005        int                 mSessionId; // audio session ID
1006        effect_descriptor_t mDescriptor;// effect descriptor received from effect engine
1007        effect_config_t     mConfig;    // input and output audio configuration
1008        effect_handle_t  mEffectInterface; // Effect module C API
1009        status_t mStatus;               // initialization status
1010        uint32_t mState;                // current activation state (effect_state)
1011        Vector< wp<EffectHandle> > mHandles;    // list of client handles
1012        uint32_t mMaxDisableWaitCnt;    // maximum grace period before forcing an effect off after
1013                                        // sending disable command.
1014        uint32_t mDisableWaitCnt;       // current process() calls count during disable period.
1015    };
1016
1017    // The EffectHandle class implements the IEffect interface. It provides resources
1018    // to receive parameter updates, keeps track of effect control
1019    // ownership and state and has a pointer to the EffectModule object it is controlling.
1020    // There is one EffectHandle object for each application controlling (or using)
1021    // an effect module.
1022    // The EffectHandle is obtained by calling AudioFlinger::createEffect().
1023    class EffectHandle: public android::BnEffect {
1024    public:
1025
1026        EffectHandle(const sp<EffectModule>& effect,
1027                const sp<AudioFlinger::Client>& client,
1028                const sp<IEffectClient>& effectClient,
1029                int32_t priority);
1030        virtual ~EffectHandle();
1031
1032        // IEffect
1033        virtual status_t enable();
1034        virtual status_t disable();
1035        virtual status_t command(uint32_t cmdCode,
1036                                 uint32_t cmdSize,
1037                                 void *pCmdData,
1038                                 uint32_t *replySize,
1039                                 void *pReplyData);
1040        virtual void disconnect();
1041        virtual sp<IMemory> getCblk() const;
1042        virtual status_t onTransact(uint32_t code, const Parcel& data,
1043                Parcel* reply, uint32_t flags);
1044
1045
1046        // Give or take control of effect module
1047        void setControl(bool hasControl, bool signal);
1048        void commandExecuted(uint32_t cmdCode,
1049                             uint32_t cmdSize,
1050                             void *pCmdData,
1051                             uint32_t replySize,
1052                             void *pReplyData);
1053        void setEnabled(bool enabled);
1054
1055        // Getters
1056        int id() { return mEffect->id(); }
1057        int priority() { return mPriority; }
1058        bool hasControl() { return mHasControl; }
1059        sp<EffectModule> effect() { return mEffect; }
1060
1061        void dump(char* buffer, size_t size);
1062
1063    protected:
1064
1065        EffectHandle(const EffectHandle&);
1066        EffectHandle& operator =(const EffectHandle&);
1067
1068        sp<EffectModule> mEffect;           // pointer to controlled EffectModule
1069        sp<IEffectClient> mEffectClient;    // callback interface for client notifications
1070        sp<Client>          mClient;        // client for shared memory allocation
1071        sp<IMemory>         mCblkMemory;    // shared memory for control block
1072        effect_param_cblk_t* mCblk;         // control block for deferred parameter setting via shared memory
1073        uint8_t*            mBuffer;        // pointer to parameter area in shared memory
1074        int mPriority;                      // client application priority to control the effect
1075        bool mHasControl;                   // true if this handle is controlling the effect
1076    };
1077
1078    // the EffectChain class represents a group of effects associated to one audio session.
1079    // There can be any number of EffectChain objects per output mixer thread (PlaybackThread).
1080    // The EffecChain with session ID 0 contains global effects applied to the output mix.
1081    // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks)
1082    // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding
1083    // in the effect process order. When attached to a track (session ID != 0), it also provide it's own
1084    // input buffer used by the track as accumulation buffer.
1085    class EffectChain: public RefBase {
1086    public:
1087        EffectChain(const wp<ThreadBase>& wThread, int sessionId);
1088        ~EffectChain();
1089
1090        void process_l();
1091
1092        void lock() {
1093            mLock.lock();
1094        }
1095        void unlock() {
1096            mLock.unlock();
1097        }
1098
1099        status_t addEffect_l(const sp<EffectModule>& handle);
1100        size_t removeEffect_l(const sp<EffectModule>& handle);
1101
1102        int sessionId() {
1103            return mSessionId;
1104        }
1105
1106        sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor);
1107        sp<EffectModule> getEffectFromId_l(int id);
1108        bool setVolume_l(uint32_t *left, uint32_t *right);
1109        void setDevice_l(uint32_t device);
1110        void setMode_l(uint32_t mode);
1111
1112        void setInBuffer(int16_t *buffer, bool ownsBuffer = false) {
1113            mInBuffer = buffer;
1114            mOwnInBuffer = ownsBuffer;
1115        }
1116        int16_t *inBuffer() {
1117            return mInBuffer;
1118        }
1119        void setOutBuffer(int16_t *buffer) {
1120            mOutBuffer = buffer;
1121        }
1122        int16_t *outBuffer() {
1123            return mOutBuffer;
1124        }
1125
1126        void incTrackCnt() { android_atomic_inc(&mTrackCnt); }
1127        void decTrackCnt() { android_atomic_dec(&mTrackCnt); }
1128        int32_t trackCnt() { return mTrackCnt;}
1129
1130        void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt); }
1131        void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); }
1132        int32_t activeTrackCnt() { return mActiveTrackCnt;}
1133
1134        uint32_t strategy() { return mStrategy; }
1135        void setStrategy(uint32_t strategy)
1136                 { mStrategy = strategy; }
1137
1138        status_t dump(int fd, const Vector<String16>& args);
1139
1140    protected:
1141
1142        EffectChain(const EffectChain&);
1143        EffectChain& operator =(const EffectChain&);
1144
1145        wp<ThreadBase> mThread;     // parent mixer thread
1146        Mutex mLock;                // mutex protecting effect list
1147        Vector<sp<EffectModule> > mEffects; // list of effect modules
1148        int mSessionId;             // audio session ID
1149        int16_t *mInBuffer;         // chain input buffer
1150        int16_t *mOutBuffer;        // chain output buffer
1151        volatile int32_t mActiveTrackCnt;  // number of active tracks connected
1152        volatile int32_t mTrackCnt;        // number of tracks connected
1153        bool mOwnInBuffer;          // true if the chain owns its input buffer
1154        int mVolumeCtrlIdx;         // index of insert effect having control over volume
1155        uint32_t mLeftVolume;       // previous volume on left channel
1156        uint32_t mRightVolume;      // previous volume on right channel
1157        uint32_t mNewLeftVolume;       // new volume on left channel
1158        uint32_t mNewRightVolume;      // new volume on right channel
1159        uint32_t mStrategy; // strategy for this effect chain
1160    };
1161
1162    struct AudioStreamOut {
1163        audio_hw_device_t   *hwDev;
1164        audio_stream_out_t  *stream;
1165
1166        AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) :
1167            hwDev(dev), stream(out) {}
1168    };
1169
1170    struct AudioStreamIn {
1171        audio_hw_device_t   *hwDev;
1172        audio_stream_in_t   *stream;
1173
1174        AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) :
1175            hwDev(dev), stream(in) {}
1176    };
1177
1178    friend class RecordThread;
1179    friend class PlaybackThread;
1180
1181    mutable     Mutex                               mLock;
1182
1183                DefaultKeyedVector< pid_t, wp<Client> >     mClients;
1184
1185                mutable     Mutex                   mHardwareLock;
1186                audio_hw_device_t*                  mPrimaryHardwareDev;
1187                Vector<audio_hw_device_t*>          mAudioHwDevs;
1188    mutable     int                                 mHardwareStatus;
1189
1190
1191                DefaultKeyedVector< int, sp<PlaybackThread> >  mPlaybackThreads;
1192                PlaybackThread::stream_type_t       mStreamTypes[AUDIO_STREAM_CNT];
1193                float                               mMasterVolume;
1194                bool                                mMasterMute;
1195
1196                DefaultKeyedVector< int, sp<RecordThread> >    mRecordThreads;
1197
1198                DefaultKeyedVector< pid_t, sp<NotificationClient> >    mNotificationClients;
1199                volatile int32_t                    mNextUniqueId;
1200                uint32_t mMode;
1201
1202};
1203
1204
1205// ----------------------------------------------------------------------------
1206
1207}; // namespace android
1208
1209#endif // ANDROID_AUDIO_FLINGER_H
1210