PlaybackTracks.h revision 8d6c292a0bed3d63b5b7297d09a604af6327c663 
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, bool active);
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    bool isResumePending();
100    void resumeAck();
101
102    bool isOutputTrack() const {
103        return (mStreamType == AUDIO_STREAM_CNT);
104    }
105
106    sp<IMemory> sharedBuffer() const { return mSharedBuffer; }
107
108    // framesWritten is cumulative, never reset, and is shared all tracks
109    // audioHalFrames is derived from output latency
110    // FIXME parameters not needed, could get them from the thread
111    bool presentationComplete(size_t framesWritten, size_t audioHalFrames);
112
113public:
114    void triggerEvents(AudioSystem::sync_event_t type);
115    void invalidate();
116    bool isInvalid() const { return mIsInvalid; }
117    virtual bool isTimedTrack() const { return false; }
118    bool isFastTrack() const { return (mFlags & IAudioFlinger::TRACK_FAST) != 0; }
119    int fastIndex() const { return mFastIndex; }
120
121protected:
122
123    // FILLED state is used for suppressing volume ramp at begin of playing
124    enum {FS_INVALID, FS_FILLING, FS_FILLED, FS_ACTIVE};
125    mutable uint8_t     mFillingUpStatus;
126    int8_t              mRetryCount;
127
128    // see comment at AudioFlinger::PlaybackThread::Track::~Track for why this can't be const
129    sp<IMemory>         mSharedBuffer;
130
131    bool                mResetDone;
132    const audio_stream_type_t mStreamType;
133    int                 mName;      // track name on the normal mixer,
134                                    // allocated statically at track creation time,
135                                    // and is even allocated (though unused) for fast tracks
136                                    // FIXME don't allocate track name for fast tracks
137    int16_t             *mMainBuffer;
138    int32_t             *mAuxBuffer;
139    int                 mAuxEffectId;
140    bool                mHasVolumeController;
141    size_t              mPresentationCompleteFrames; // number of frames written to the
142                                    // audio HAL when this track will be fully rendered
143                                    // zero means not monitoring
144private:
145    IAudioFlinger::track_flags_t mFlags;
146
147    // The following fields are only for fast tracks, and should be in a subclass
148    int                 mFastIndex; // index within FastMixerState::mFastTracks[];
149                                    // either mFastIndex == -1 if not isFastTrack()
150                                    // or 0 < mFastIndex < FastMixerState::kMaxFast because
151                                    // index 0 is reserved for normal mixer's submix;
152                                    // index is allocated statically at track creation time
153                                    // but the slot is only used if track is active
154    FastTrackUnderruns  mObservedUnderruns; // Most recently observed value of
155                                    // mFastMixerDumpState.mTracks[mFastIndex].mUnderruns
156    volatile float      mCachedVolume;  // combined master volume and stream type volume;
157                                        // 'volatile' means accessed without lock or
158                                        // barrier, but is read/written atomically
159    bool                mIsInvalid; // non-resettable latch, set by invalidate()
160    AudioTrackServerProxy*  mAudioTrackServerProxy;
161    bool                mResumeToStopping; // track was paused in stopping state.
162    bool                mFlushHwPending; // track requests for thread flush
163};  // end of Track
164
165class TimedTrack : public Track {
166  public:
167    static sp<TimedTrack> create(PlaybackThread *thread,
168                                 const sp<Client>& client,
169                                 audio_stream_type_t streamType,
170                                 uint32_t sampleRate,
171                                 audio_format_t format,
172                                 audio_channel_mask_t channelMask,
173                                 size_t frameCount,
174                                 const sp<IMemory>& sharedBuffer,
175                                 int sessionId,
176                                 int uid);
177    virtual ~TimedTrack();
178
179    class TimedBuffer {
180      public:
181        TimedBuffer();
182        TimedBuffer(const sp<IMemory>& buffer, int64_t pts);
183        const sp<IMemory>& buffer() const { return mBuffer; }
184        int64_t pts() const { return mPTS; }
185        uint32_t position() const { return mPosition; }
186        void setPosition(uint32_t pos) { mPosition = pos; }
187      private:
188        sp<IMemory> mBuffer;
189        int64_t     mPTS;
190        uint32_t    mPosition;
191    };
192
193    // Mixer facing methods.
194    virtual bool isTimedTrack() const { return true; }
195    virtual size_t framesReady() const;
196
197    // AudioBufferProvider interface
198    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
199                                   int64_t pts);
200    virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
201
202    // Client/App facing methods.
203    status_t    allocateTimedBuffer(size_t size,
204                                    sp<IMemory>* buffer);
205    status_t    queueTimedBuffer(const sp<IMemory>& buffer,
206                                 int64_t pts);
207    status_t    setMediaTimeTransform(const LinearTransform& xform,
208                                      TimedAudioTrack::TargetTimeline target);
209
210  private:
211    TimedTrack(PlaybackThread *thread,
212               const sp<Client>& client,
213               audio_stream_type_t streamType,
214               uint32_t sampleRate,
215               audio_format_t format,
216               audio_channel_mask_t channelMask,
217               size_t frameCount,
218               const sp<IMemory>& sharedBuffer,
219               int sessionId,
220               int uid);
221
222    void timedYieldSamples_l(AudioBufferProvider::Buffer* buffer);
223    void timedYieldSilence_l(uint32_t numFrames,
224                             AudioBufferProvider::Buffer* buffer);
225    void trimTimedBufferQueue_l();
226    void trimTimedBufferQueueHead_l(const char* logTag);
227    void updateFramesPendingAfterTrim_l(const TimedBuffer& buf,
228                                        const char* logTag);
229
230    uint64_t            mLocalTimeFreq;
231    LinearTransform     mLocalTimeToSampleTransform;
232    LinearTransform     mMediaTimeToSampleTransform;
233    sp<MemoryDealer>    mTimedMemoryDealer;
234
235    Vector<TimedBuffer> mTimedBufferQueue;
236    bool                mQueueHeadInFlight;
237    bool                mTrimQueueHeadOnRelease;
238    uint32_t            mFramesPendingInQueue;
239
240    uint8_t*            mTimedSilenceBuffer;
241    uint32_t            mTimedSilenceBufferSize;
242    mutable Mutex       mTimedBufferQueueLock;
243    bool                mTimedAudioOutputOnTime;
244    CCHelper            mCCHelper;
245
246    Mutex               mMediaTimeTransformLock;
247    LinearTransform     mMediaTimeTransform;
248    bool                mMediaTimeTransformValid;
249    TimedAudioTrack::TargetTimeline mMediaTimeTransformTarget;
250};
251
252
253// playback track, used by DuplicatingThread
254class OutputTrack : public Track {
255public:
256
257    class Buffer : public AudioBufferProvider::Buffer {
258    public:
259        int16_t *mBuffer;
260    };
261
262                        OutputTrack(PlaybackThread *thread,
263                                DuplicatingThread *sourceThread,
264                                uint32_t sampleRate,
265                                audio_format_t format,
266                                audio_channel_mask_t channelMask,
267                                size_t frameCount,
268                                int uid);
269    virtual             ~OutputTrack();
270
271    virtual status_t    start(AudioSystem::sync_event_t event =
272                                    AudioSystem::SYNC_EVENT_NONE,
273                             int triggerSession = 0);
274    virtual void        stop();
275            bool        write(int16_t* data, uint32_t frames);
276            bool        bufferQueueEmpty() const { return mBufferQueue.size() == 0; }
277            bool        isActive() const { return mActive; }
278    const wp<ThreadBase>& thread() const { return mThread; }
279
280private:
281
282    status_t            obtainBuffer(AudioBufferProvider::Buffer* buffer,
283                                     uint32_t waitTimeMs);
284    void                clearBufferQueue();
285
286    // Maximum number of pending buffers allocated by OutputTrack::write()
287    static const uint8_t kMaxOverFlowBuffers = 10;
288
289    Vector < Buffer* >          mBufferQueue;
290    AudioBufferProvider::Buffer mOutBuffer;
291    bool                        mActive;
292    DuplicatingThread* const mSourceThread; // for waitTimeMs() in write()
293    AudioTrackClientProxy*      mClientProxy;
294};  // end of OutputTrack
295