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