PlaybackTracks.h revision 7844f679be8d94c5cdf017f53754cb68ee2f00da 
1/*
2**
3** Copyright 2012, 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 INCLUDING_FROM_AUDIOFLINGER_H
19    #error This header file should only be included from AudioFlinger.h
20#endif
21
22// playback track
23class Track : public TrackBase, public VolumeProvider {
24public:
25                        Track(  PlaybackThread *thread,
26                                const sp<Client>& client,
27                                audio_stream_type_t streamType,
28                                uint32_t sampleRate,
29                                audio_format_t format,
30                                audio_channel_mask_t channelMask,
31                                size_t frameCount,
32                                const sp<IMemory>& sharedBuffer,
33                                int sessionId,
34                                int uid,
35                                IAudioFlinger::track_flags_t flags);
36    virtual             ~Track();
37    virtual status_t    initCheck() const;
38
39    static  void        appendDumpHeader(String8& result);
40            void        dump(char* buffer, size_t size);
41    virtual status_t    start(AudioSystem::sync_event_t event =
42                                    AudioSystem::SYNC_EVENT_NONE,
43                             int triggerSession = 0);
44    virtual void        stop();
45            void        pause();
46
47            void        flush();
48            void        destroy();
49            int         name() const { return mName; }
50
51    virtual uint32_t    sampleRate() const;
52
53            audio_stream_type_t streamType() const {
54                return mStreamType;
55            }
56            bool        isOffloaded() const { return (mFlags & IAudioFlinger::TRACK_OFFLOAD) != 0; }
57            status_t    setParameters(const String8& keyValuePairs);
58            status_t    attachAuxEffect(int EffectId);
59            void        setAuxBuffer(int EffectId, int32_t *buffer);
60            int32_t     *auxBuffer() const { return mAuxBuffer; }
61            void        setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; }
62            int16_t     *mainBuffer() const { return mMainBuffer; }
63            int         auxEffectId() const { return mAuxEffectId; }
64    virtual status_t    getTimestamp(AudioTimestamp& timestamp);
65            void        signal();
66
67// implement FastMixerState::VolumeProvider interface
68    virtual uint32_t    getVolumeLR();
69
70    virtual status_t    setSyncEvent(const sp<SyncEvent>& event);
71
72protected:
73    // for numerous
74    friend class PlaybackThread;
75    friend class MixerThread;
76    friend class DirectOutputThread;
77    friend class OffloadThread;
78
79                        Track(const Track&);
80                        Track& operator = (const Track&);
81
82    // AudioBufferProvider interface
83    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
84                                   int64_t pts = kInvalidPTS);
85    // releaseBuffer() not overridden
86
87    // ExtendedAudioBufferProvider interface
88    virtual size_t framesReady() const;
89    virtual size_t framesReleased() const;
90
91    bool isPausing() const { return mState == PAUSING; }
92    bool isPaused() const { return mState == PAUSED; }
93    bool isResuming() const { return mState == RESUMING; }
94    bool isReady() const;
95    void setPaused() { mState = PAUSED; }
96    void reset();
97    bool isFlushPending() const { return mFlushHwPending; }
98    void flushAck();
99
100    bool isOutputTrack() const {
101        return (mStreamType == AUDIO_STREAM_CNT);
102    }
103
104    sp<IMemory> sharedBuffer() const { return mSharedBuffer; }
105
106    // framesWritten is cumulative, never reset, and is shared all tracks
107    // audioHalFrames is derived from output latency
108    // FIXME parameters not needed, could get them from the thread
109    bool presentationComplete(size_t framesWritten, size_t audioHalFrames);
110
111public:
112    void triggerEvents(AudioSystem::sync_event_t type);
113    void invalidate();
114    bool isInvalid() const { return mIsInvalid; }
115    virtual bool isTimedTrack() const { return false; }
116    bool isFastTrack() const { return (mFlags & IAudioFlinger::TRACK_FAST) != 0; }
117    int fastIndex() const { return mFastIndex; }
118
119protected:
120
121    // FILLED state is used for suppressing volume ramp at begin of playing
122    enum {FS_INVALID, FS_FILLING, FS_FILLED, FS_ACTIVE};
123    mutable uint8_t     mFillingUpStatus;
124    int8_t              mRetryCount;
125
126    // see comment at AudioFlinger::PlaybackThread::Track::~Track for why this can't be const
127    sp<IMemory>         mSharedBuffer;
128
129    bool                mResetDone;
130    const audio_stream_type_t mStreamType;
131    int                 mName;      // track name on the normal mixer,
132                                    // allocated statically at track creation time,
133                                    // and is even allocated (though unused) for fast tracks
134                                    // FIXME don't allocate track name for fast tracks
135    int16_t             *mMainBuffer;
136    int32_t             *mAuxBuffer;
137    int                 mAuxEffectId;
138    bool                mHasVolumeController;
139    size_t              mPresentationCompleteFrames; // number of frames written to the
140                                    // audio HAL when this track will be fully rendered
141                                    // zero means not monitoring
142private:
143    IAudioFlinger::track_flags_t mFlags;
144
145    // The following fields are only for fast tracks, and should be in a subclass
146    int                 mFastIndex; // index within FastMixerState::mFastTracks[];
147                                    // either mFastIndex == -1 if not isFastTrack()
148                                    // or 0 < mFastIndex < FastMixerState::kMaxFast because
149                                    // index 0 is reserved for normal mixer's submix;
150                                    // index is allocated statically at track creation time
151                                    // but the slot is only used if track is active
152    FastTrackUnderruns  mObservedUnderruns; // Most recently observed value of
153                                    // mFastMixerDumpState.mTracks[mFastIndex].mUnderruns
154    volatile float      mCachedVolume;  // combined master volume and stream type volume;
155                                        // 'volatile' means accessed without lock or
156                                        // barrier, but is read/written atomically
157    bool                mIsInvalid; // non-resettable latch, set by invalidate()
158    AudioTrackServerProxy*  mAudioTrackServerProxy;
159    bool                mResumeToStopping; // track was paused in stopping state.
160    bool                mFlushHwPending; // track requests for thread flush
161};  // end of Track
162
163class TimedTrack : public Track {
164  public:
165    static sp<TimedTrack> create(PlaybackThread *thread,
166                                 const sp<Client>& client,
167                                 audio_stream_type_t streamType,
168                                 uint32_t sampleRate,
169                                 audio_format_t format,
170                                 audio_channel_mask_t channelMask,
171                                 size_t frameCount,
172                                 const sp<IMemory>& sharedBuffer,
173                                 int sessionId,
174                                 int uid);
175    virtual ~TimedTrack();
176
177    class TimedBuffer {
178      public:
179        TimedBuffer();
180        TimedBuffer(const sp<IMemory>& buffer, int64_t pts);
181        const sp<IMemory>& buffer() const { return mBuffer; }
182        int64_t pts() const { return mPTS; }
183        uint32_t position() const { return mPosition; }
184        void setPosition(uint32_t pos) { mPosition = pos; }
185      private:
186        sp<IMemory> mBuffer;
187        int64_t     mPTS;
188        uint32_t    mPosition;
189    };
190
191    // Mixer facing methods.
192    virtual bool isTimedTrack() const { return true; }
193    virtual size_t framesReady() const;
194
195    // AudioBufferProvider interface
196    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
197                                   int64_t pts);
198    virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
199
200    // Client/App facing methods.
201    status_t    allocateTimedBuffer(size_t size,
202                                    sp<IMemory>* buffer);
203    status_t    queueTimedBuffer(const sp<IMemory>& buffer,
204                                 int64_t pts);
205    status_t    setMediaTimeTransform(const LinearTransform& xform,
206                                      TimedAudioTrack::TargetTimeline target);
207
208  private:
209    TimedTrack(PlaybackThread *thread,
210               const sp<Client>& client,
211               audio_stream_type_t streamType,
212               uint32_t sampleRate,
213               audio_format_t format,
214               audio_channel_mask_t channelMask,
215               size_t frameCount,
216               const sp<IMemory>& sharedBuffer,
217               int sessionId,
218               int uid);
219
220    void timedYieldSamples_l(AudioBufferProvider::Buffer* buffer);
221    void timedYieldSilence_l(uint32_t numFrames,
222                             AudioBufferProvider::Buffer* buffer);
223    void trimTimedBufferQueue_l();
224    void trimTimedBufferQueueHead_l(const char* logTag);
225    void updateFramesPendingAfterTrim_l(const TimedBuffer& buf,
226                                        const char* logTag);
227
228    uint64_t            mLocalTimeFreq;
229    LinearTransform     mLocalTimeToSampleTransform;
230    LinearTransform     mMediaTimeToSampleTransform;
231    sp<MemoryDealer>    mTimedMemoryDealer;
232
233    Vector<TimedBuffer> mTimedBufferQueue;
234    bool                mQueueHeadInFlight;
235    bool                mTrimQueueHeadOnRelease;
236    uint32_t            mFramesPendingInQueue;
237
238    uint8_t*            mTimedSilenceBuffer;
239    uint32_t            mTimedSilenceBufferSize;
240    mutable Mutex       mTimedBufferQueueLock;
241    bool                mTimedAudioOutputOnTime;
242    CCHelper            mCCHelper;
243
244    Mutex               mMediaTimeTransformLock;
245    LinearTransform     mMediaTimeTransform;
246    bool                mMediaTimeTransformValid;
247    TimedAudioTrack::TargetTimeline mMediaTimeTransformTarget;
248};
249
250
251// playback track, used by DuplicatingThread
252class OutputTrack : public Track {
253public:
254
255    class Buffer : public AudioBufferProvider::Buffer {
256    public:
257        int16_t *mBuffer;
258    };
259
260                        OutputTrack(PlaybackThread *thread,
261                                DuplicatingThread *sourceThread,
262                                uint32_t sampleRate,
263                                audio_format_t format,
264                                audio_channel_mask_t channelMask,
265                                size_t frameCount,
266                                int uid);
267    virtual             ~OutputTrack();
268
269    virtual status_t    start(AudioSystem::sync_event_t event =
270                                    AudioSystem::SYNC_EVENT_NONE,
271                             int triggerSession = 0);
272    virtual void        stop();
273            bool        write(int16_t* data, uint32_t frames);
274            bool        bufferQueueEmpty() const { return mBufferQueue.size() == 0; }
275            bool        isActive() const { return mActive; }
276    const wp<ThreadBase>& thread() const { return mThread; }
277
278private:
279
280    status_t            obtainBuffer(AudioBufferProvider::Buffer* buffer,
281                                     uint32_t waitTimeMs);
282    void                clearBufferQueue();
283
284    // Maximum number of pending buffers allocated by OutputTrack::write()
285    static const uint8_t kMaxOverFlowBuffers = 10;
286
287    Vector < Buffer* >          mBufferQueue;
288    AudioBufferProvider::Buffer mOutBuffer;
289    bool                        mActive;
290    DuplicatingThread* const mSourceThread; // for waitTimeMs() in write()
291    AudioTrackClientProxy*      mClientProxy;
292};  // end of OutputTrack
293