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