NuPlayerRenderer.h revision 528c8403ad2ede53054a706a20c00b710fa08166 
1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef NUPLAYER_RENDERER_H_
18
19#define NUPLAYER_RENDERER_H_
20
21#include <media/AudioResamplerPublic.h>
22#include <media/AVSyncSettings.h>
23
24#include "NuPlayer.h"
25
26namespace android {
27
28struct ABuffer;
29class  AWakeLock;
30struct MediaClock;
31struct VideoFrameScheduler;
32
33struct NuPlayer::Renderer : public AHandler {
34    enum Flags {
35        FLAG_REAL_TIME = 1,
36        FLAG_OFFLOAD_AUDIO = 2,
37    };
38    Renderer(const sp<MediaPlayerBase::AudioSink> &sink,
39             const sp<AMessage> &notify,
40             uint32_t flags = 0);
41
42    static size_t AudioSinkCallback(
43            MediaPlayerBase::AudioSink *audioSink,
44            void *data, size_t size, void *me,
45            MediaPlayerBase::AudioSink::cb_event_t event);
46
47    void queueBuffer(
48            bool audio,
49            const sp<ABuffer> &buffer,
50            const sp<AMessage> &notifyConsumed);
51
52    void queueEOS(bool audio, status_t finalResult);
53
54    status_t setPlaybackSettings(const AudioPlaybackRate &rate /* sanitized */);
55    status_t getPlaybackSettings(AudioPlaybackRate *rate /* nonnull */);
56    status_t setSyncSettings(const AVSyncSettings &sync, float videoFpsHint);
57    status_t getSyncSettings(AVSyncSettings *sync /* nonnull */, float *videoFps /* nonnull */);
58
59    void flush(bool audio, bool notifyComplete);
60
61    void signalTimeDiscontinuity();
62
63    void signalAudioSinkChanged();
64
65    void signalDisableOffloadAudio();
66    void signalEnableOffloadAudio();
67
68    void pause();
69    void resume();
70
71    void setVideoFrameRate(float fps);
72
73    status_t getCurrentPosition(int64_t *mediaUs);
74    int64_t getVideoLateByUs();
75
76    status_t openAudioSink(
77            const sp<AMessage> &format,
78            bool offloadOnly,
79            bool hasVideo,
80            uint32_t flags,
81            bool *isOffloaded);
82    void closeAudioSink();
83
84    enum {
85        kWhatEOS                      = 'eos ',
86        kWhatFlushComplete            = 'fluC',
87        kWhatPosition                 = 'posi',
88        kWhatVideoRenderingStart      = 'vdrd',
89        kWhatMediaRenderingStart      = 'mdrd',
90        kWhatAudioTearDown            = 'adTD',
91        kWhatAudioOffloadPauseTimeout = 'aOPT',
92    };
93
94    enum AudioTearDownReason {
95        kDueToError = 0,
96        kDueToTimeout,
97    };
98
99protected:
100    virtual ~Renderer();
101
102    virtual void onMessageReceived(const sp<AMessage> &msg);
103
104private:
105    enum {
106        kWhatDrainAudioQueue     = 'draA',
107        kWhatDrainVideoQueue     = 'draV',
108        kWhatPostDrainVideoQueue = 'pDVQ',
109        kWhatQueueBuffer         = 'queB',
110        kWhatQueueEOS            = 'qEOS',
111        kWhatConfigPlayback      = 'cfPB',
112        kWhatConfigSync          = 'cfSy',
113        kWhatGetPlaybackSettings = 'gPbS',
114        kWhatGetSyncSettings     = 'gSyS',
115        kWhatFlush               = 'flus',
116        kWhatPause               = 'paus',
117        kWhatResume              = 'resm',
118        kWhatOpenAudioSink       = 'opnA',
119        kWhatCloseAudioSink      = 'clsA',
120        kWhatStopAudioSink       = 'stpA',
121        kWhatDisableOffloadAudio = 'noOA',
122        kWhatEnableOffloadAudio  = 'enOA',
123        kWhatSetVideoFrameRate   = 'sVFR',
124    };
125
126    struct QueueEntry {
127        sp<ABuffer> mBuffer;
128        sp<AMessage> mNotifyConsumed;
129        size_t mOffset;
130        status_t mFinalResult;
131        int32_t mBufferOrdinal;
132    };
133
134    static const int64_t kMinPositionUpdateDelayUs;
135
136    sp<MediaPlayerBase::AudioSink> mAudioSink;
137    sp<AMessage> mNotify;
138    Mutex mLock;
139    uint32_t mFlags;
140    List<QueueEntry> mAudioQueue;
141    List<QueueEntry> mVideoQueue;
142    uint32_t mNumFramesWritten;
143    sp<VideoFrameScheduler> mVideoScheduler;
144
145    bool mDrainAudioQueuePending;
146    bool mDrainVideoQueuePending;
147    int32_t mAudioQueueGeneration;
148    int32_t mVideoQueueGeneration;
149    int32_t mAudioDrainGeneration;
150    int32_t mVideoDrainGeneration;
151    int32_t mAudioEOSGeneration;
152
153    sp<MediaClock> mMediaClock;
154    float mPlaybackRate; // audio track rate
155
156    AudioPlaybackRate mPlaybackSettings;
157    AVSyncSettings mSyncSettings;
158    float mVideoFpsHint;
159
160    int64_t mAudioFirstAnchorTimeMediaUs;
161    int64_t mAnchorTimeMediaUs;
162    int64_t mAnchorNumFramesWritten;
163    int64_t mVideoLateByUs;
164    bool mHasAudio;
165    bool mHasVideo;
166
167    bool mNotifyCompleteAudio;
168    bool mNotifyCompleteVideo;
169
170    bool mSyncQueues;
171
172    // modified on only renderer's thread.
173    bool mPaused;
174    int64_t mPauseDrainAudioAllowedUs; // time when we can drain/deliver audio in pause mode.
175
176    bool mVideoSampleReceived;
177    bool mVideoRenderingStarted;
178    int32_t mVideoRenderingStartGeneration;
179    int32_t mAudioRenderingStartGeneration;
180    bool mRenderingDataDelivered;
181
182    int64_t mNextAudioClockUpdateTimeUs;
183    // the media timestamp of last audio sample right before EOS.
184    int64_t mLastAudioMediaTimeUs;
185
186    int32_t mAudioOffloadPauseTimeoutGeneration;
187    bool mAudioTornDown;
188    audio_offload_info_t mCurrentOffloadInfo;
189
190    struct PcmInfo {
191        audio_channel_mask_t mChannelMask;
192        audio_output_flags_t mFlags;
193        audio_format_t mFormat;
194        int32_t mNumChannels;
195        int32_t mSampleRate;
196    };
197    PcmInfo mCurrentPcmInfo;
198    static const PcmInfo AUDIO_PCMINFO_INITIALIZER;
199
200    int32_t mTotalBuffersQueued;
201    int32_t mLastAudioBufferDrained;
202    bool mUseAudioCallback;
203
204    sp<AWakeLock> mWakeLock;
205
206    status_t getCurrentPositionOnLooper(int64_t *mediaUs);
207    status_t getCurrentPositionOnLooper(
208            int64_t *mediaUs, int64_t nowUs, bool allowPastQueuedVideo = false);
209    bool getCurrentPositionIfPaused_l(int64_t *mediaUs);
210    status_t getCurrentPositionFromAnchor(
211            int64_t *mediaUs, int64_t nowUs, bool allowPastQueuedVideo = false);
212
213    size_t fillAudioBuffer(void *buffer, size_t size);
214
215    bool onDrainAudioQueue();
216    void drainAudioQueueUntilLastEOS();
217    int64_t getPendingAudioPlayoutDurationUs(int64_t nowUs);
218    void postDrainAudioQueue_l(int64_t delayUs = 0);
219
220    void clearAnchorTime_l();
221    void clearAudioFirstAnchorTime_l();
222    void setAudioFirstAnchorTimeIfNeeded_l(int64_t mediaUs);
223    void setVideoLateByUs(int64_t lateUs);
224
225    void onNewAudioMediaTime(int64_t mediaTimeUs);
226    int64_t getRealTimeUs(int64_t mediaTimeUs, int64_t nowUs);
227
228    void onDrainVideoQueue();
229    void postDrainVideoQueue();
230
231    void prepareForMediaRenderingStart_l();
232    void notifyIfMediaRenderingStarted_l();
233
234    void onQueueBuffer(const sp<AMessage> &msg);
235    void onQueueEOS(const sp<AMessage> &msg);
236    void onFlush(const sp<AMessage> &msg);
237    void onAudioSinkChanged();
238    void onDisableOffloadAudio();
239    void onEnableOffloadAudio();
240    status_t onConfigPlayback(const AudioPlaybackRate &rate /* sanitized */);
241    status_t onGetPlaybackSettings(AudioPlaybackRate *rate /* nonnull */);
242    status_t onConfigSync(const AVSyncSettings &sync, float videoFpsHint);
243    status_t onGetSyncSettings(AVSyncSettings *sync /* nonnull */, float *videoFps /* nonnull */);
244
245    void onPause();
246    void onResume();
247    void onSetVideoFrameRate(float fps);
248    int32_t getQueueGeneration(bool audio);
249    int32_t getDrainGeneration(bool audio);
250    bool getSyncQueues();
251    void onAudioTearDown(AudioTearDownReason reason);
252    status_t onOpenAudioSink(
253            const sp<AMessage> &format,
254            bool offloadOnly,
255            bool hasVideo,
256            uint32_t flags);
257    void onCloseAudioSink();
258
259    void notifyEOS(bool audio, status_t finalResult, int64_t delayUs = 0);
260    void notifyFlushComplete(bool audio);
261    void notifyPosition();
262    void notifyVideoLateBy(int64_t lateByUs);
263    void notifyVideoRenderingStart();
264    void notifyAudioTearDown();
265
266    void flushQueue(List<QueueEntry> *queue);
267    bool dropBufferIfStale(bool audio, const sp<AMessage> &msg);
268    void syncQueuesDone_l();
269
270    bool offloadingAudio() const { return (mFlags & FLAG_OFFLOAD_AUDIO) != 0; }
271
272    void startAudioOffloadPauseTimeout();
273    void cancelAudioOffloadPauseTimeout();
274
275    int64_t getDurationUsIfPlayedAtSampleRate(uint32_t numFrames);
276
277    DISALLOW_EVIL_CONSTRUCTORS(Renderer);
278};
279
280} // namespace android
281
282#endif  // NUPLAYER_RENDERER_H_
283