• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <atomic>
22 
23 #include <media/AudioResamplerPublic.h>
24 #include <media/AVSyncSettings.h>
25 
26 #include "NuPlayer.h"
27 
28 namespace android {
29 
30 class  AWakeLock;
31 struct MediaClock;
32 class MediaCodecBuffer;
33 struct VideoFrameSchedulerBase;
34 
35 struct NuPlayer::Renderer : public AHandler {
36     enum Flags {
37         FLAG_REAL_TIME = 1,
38         FLAG_OFFLOAD_AUDIO = 2,
39     };
40     Renderer(const sp<MediaPlayerBase::AudioSink> &sink,
41              const sp<MediaClock> &mediaClock,
42              const sp<AMessage> &notify,
43              uint32_t flags = 0);
44 
45     static size_t AudioSinkCallback(
46             MediaPlayerBase::AudioSink *audioSink,
47             void *data, size_t size, void *me,
48             MediaPlayerBase::AudioSink::cb_event_t event);
49 
50     void queueBuffer(
51             bool audio,
52             const sp<MediaCodecBuffer> &buffer,
53             const sp<AMessage> &notifyConsumed);
54 
55     void queueEOS(bool audio, status_t finalResult);
56 
57     status_t setPlaybackSettings(const AudioPlaybackRate &rate /* sanitized */);
58     status_t getPlaybackSettings(AudioPlaybackRate *rate /* nonnull */);
59     status_t setSyncSettings(const AVSyncSettings &sync, float videoFpsHint);
60     status_t getSyncSettings(AVSyncSettings *sync /* nonnull */, float *videoFps /* nonnull */);
61 
62     void flush(bool audio, bool notifyComplete);
63 
64     void signalTimeDiscontinuity();
65 
66     void signalDisableOffloadAudio();
67     void signalEnableOffloadAudio();
68 
69     void pause();
70     void resume();
71 
72     void setVideoFrameRate(float fps);
73 
74     status_t getCurrentPosition(int64_t *mediaUs);
75     int64_t getVideoLateByUs();
76 
77     status_t openAudioSink(
78             const sp<AMessage> &format,
79             bool offloadOnly,
80             bool hasVideo,
81             uint32_t flags,
82             bool *isOffloaded,
83             bool isStreaming);
84     void closeAudioSink();
85 
86     void dump(AString& logString);
87 
88     // re-open audio sink after all pending audio buffers played.
89     void changeAudioFormat(
90             const sp<AMessage> &format,
91             bool offloadOnly,
92             bool hasVideo,
93             uint32_t flags,
94             bool isStreaming,
95             const sp<AMessage> &notify);
96 
97     enum {
98         kWhatEOS                      = 'eos ',
99         kWhatFlushComplete            = 'fluC',
100         kWhatPosition                 = 'posi',
101         kWhatVideoRenderingStart      = 'vdrd',
102         kWhatMediaRenderingStart      = 'mdrd',
103         kWhatAudioTearDown            = 'adTD',
104         kWhatAudioOffloadPauseTimeout = 'aOPT',
105         kWhatReleaseWakeLock          = 'adRL',
106     };
107 
108     enum AudioTearDownReason {
109         kDueToError = 0,   // Could restart with either offload or non-offload.
110         kDueToTimeout,
111         kForceNonOffload,  // Restart only with non-offload.
112     };
113 
114 protected:
115     virtual ~Renderer();
116 
117     virtual void onMessageReceived(const sp<AMessage> &msg);
118 
119 private:
120     enum {
121         kWhatDrainAudioQueue     = 'draA',
122         kWhatDrainVideoQueue     = 'draV',
123         kWhatPostDrainVideoQueue = 'pDVQ',
124         kWhatQueueBuffer         = 'queB',
125         kWhatQueueEOS            = 'qEOS',
126         kWhatConfigPlayback      = 'cfPB',
127         kWhatConfigSync          = 'cfSy',
128         kWhatGetPlaybackSettings = 'gPbS',
129         kWhatGetSyncSettings     = 'gSyS',
130         kWhatFlush               = 'flus',
131         kWhatPause               = 'paus',
132         kWhatResume              = 'resm',
133         kWhatOpenAudioSink       = 'opnA',
134         kWhatCloseAudioSink      = 'clsA',
135         kWhatChangeAudioFormat   = 'chgA',
136         kWhatStopAudioSink       = 'stpA',
137         kWhatDisableOffloadAudio = 'noOA',
138         kWhatEnableOffloadAudio  = 'enOA',
139         kWhatSetVideoFrameRate   = 'sVFR',
140     };
141 
142     // if mBuffer != nullptr, it's a buffer containing real data.
143     // else if mNotifyConsumed == nullptr, it's EOS.
144     // else it's a tag for re-opening audio sink in different format.
145     struct QueueEntry {
146         sp<MediaCodecBuffer> mBuffer;
147         sp<AMessage> mMeta;
148         sp<AMessage> mNotifyConsumed;
149         size_t mOffset;
150         status_t mFinalResult;
151         int32_t mBufferOrdinal;
152     };
153 
154     static const int64_t kMinPositionUpdateDelayUs;
155 
156     sp<MediaPlayerBase::AudioSink> mAudioSink;
157     bool mUseVirtualAudioSink;
158     sp<AMessage> mNotify;
159     Mutex mLock;
160     uint32_t mFlags;
161     List<QueueEntry> mAudioQueue;
162     List<QueueEntry> mVideoQueue;
163     uint32_t mNumFramesWritten;
164     sp<VideoFrameSchedulerBase> mVideoScheduler;
165 
166     bool mDrainAudioQueuePending;
167     bool mDrainVideoQueuePending;
168     int32_t mAudioQueueGeneration;
169     int32_t mVideoQueueGeneration;
170     int32_t mAudioDrainGeneration;
171     int32_t mVideoDrainGeneration;
172     int32_t mAudioEOSGeneration;
173 
174     const sp<MediaClock> mMediaClock;
175     float mPlaybackRate; // audio track rate
176 
177     AudioPlaybackRate mPlaybackSettings;
178     AVSyncSettings mSyncSettings;
179     float mVideoFpsHint;
180 
181     int64_t mAudioFirstAnchorTimeMediaUs;
182     int64_t mAnchorTimeMediaUs;
183     int64_t mAnchorNumFramesWritten;
184     int64_t mVideoLateByUs;
185     int64_t mNextVideoTimeMediaUs;
186     bool mHasAudio;
187     bool mHasVideo;
188 
189     bool mNotifyCompleteAudio;
190     bool mNotifyCompleteVideo;
191 
192     bool mSyncQueues;
193 
194     // modified on only renderer's thread.
195     bool mPaused;
196     int64_t mPauseDrainAudioAllowedUs; // time when we can drain/deliver audio in pause mode.
197 
198     bool mVideoSampleReceived;
199     bool mVideoRenderingStarted;
200     int32_t mVideoRenderingStartGeneration;
201     int32_t mAudioRenderingStartGeneration;
202     bool mRenderingDataDelivered;
203 
204     int64_t mNextAudioClockUpdateTimeUs;
205     // the media timestamp of last audio sample right before EOS.
206     int64_t mLastAudioMediaTimeUs;
207 
208     int32_t mAudioOffloadPauseTimeoutGeneration;
209     bool mAudioTornDown;
210     audio_offload_info_t mCurrentOffloadInfo;
211 
212     struct PcmInfo {
213         audio_channel_mask_t mChannelMask;
214         audio_output_flags_t mFlags;
215         audio_format_t mFormat;
216         int32_t mNumChannels;
217         int32_t mSampleRate;
218     };
219     PcmInfo mCurrentPcmInfo;
220     static const PcmInfo AUDIO_PCMINFO_INITIALIZER;
221 
222     int32_t mTotalBuffersQueued;
223     int32_t mLastAudioBufferDrained;
224     bool mUseAudioCallback;
225 
226     sp<AWakeLock> mWakeLock;
227 
228     std::atomic_flag mSyncFlag = ATOMIC_FLAG_INIT;
229     Mutex mSyncLock;
230     Condition mSyncCondition;
231     int64_t mSyncCount{0};
232 
233     status_t getCurrentPositionOnLooper(int64_t *mediaUs);
234     status_t getCurrentPositionOnLooper(
235             int64_t *mediaUs, int64_t nowUs, bool allowPastQueuedVideo = false);
236     bool getCurrentPositionIfPaused_l(int64_t *mediaUs);
237     status_t getCurrentPositionFromAnchor(
238             int64_t *mediaUs, int64_t nowUs, bool allowPastQueuedVideo = false);
239 
240     struct WakeLockEvent{
241         int64_t mTimeMs;
242         int32_t mEventTimeoutGeneration;
243         int32_t mRendererTimeoutGeneration;
244 
WakeLockEventRenderer::WakeLockEvent245         WakeLockEvent():
246             mTimeMs(0),
247             mEventTimeoutGeneration(0),
248             mRendererTimeoutGeneration(0) {}
249 
updateValuesRenderer::WakeLockEvent250         void updateValues(int64_t timeMs,
251                           int32_t eventGeneration,
252                           int32_t rendererGeneration) {
253             mTimeMs = timeMs;
254             mEventTimeoutGeneration = eventGeneration;
255             mRendererTimeoutGeneration = rendererGeneration;
256         }
257 
258         void dump(AString& logString);
259     };
260 
261     WakeLockEvent mWakelockAcquireEvent;
262     WakeLockEvent mWakelockTimeoutEvent;
263     WakeLockEvent mWakelockReleaseEvent;
264     WakeLockEvent mWakelockCancelEvent;
265 
266     void notifyEOSCallback();
267     size_t fillAudioBuffer(void *buffer, size_t size);
268 
269     bool onDrainAudioQueue();
270     void drainAudioQueueUntilLastEOS();
271     int64_t getPendingAudioPlayoutDurationUs(int64_t nowUs);
272     void postDrainAudioQueue_l(int64_t delayUs = 0);
273 
274     void clearAnchorTime();
275     void clearAudioFirstAnchorTime_l();
276     void setAudioFirstAnchorTimeIfNeeded_l(int64_t mediaUs);
277     void setVideoLateByUs(int64_t lateUs);
278 
279     void onNewAudioMediaTime(int64_t mediaTimeUs);
280     int64_t getRealTimeUs(int64_t mediaTimeUs, int64_t nowUs);
281 
282     void onDrainVideoQueue();
283     void postDrainVideoQueue();
284 
285     void prepareForMediaRenderingStart_l();
286     void notifyIfMediaRenderingStarted_l();
287 
288     void onQueueBuffer(const sp<AMessage> &msg);
289     void onQueueEOS(const sp<AMessage> &msg);
290     void onFlush(const sp<AMessage> &msg);
291     void onAudioSinkChanged();
292     void onDisableOffloadAudio();
293     void onEnableOffloadAudio();
294     status_t onConfigPlayback(const AudioPlaybackRate &rate /* sanitized */);
295     status_t onGetPlaybackSettings(AudioPlaybackRate *rate /* nonnull */);
296     status_t onConfigSync(const AVSyncSettings &sync, float videoFpsHint);
297     status_t onGetSyncSettings(AVSyncSettings *sync /* nonnull */, float *videoFps /* nonnull */);
298 
299     void onPause();
300     void onResume();
301     void onSetVideoFrameRate(float fps);
302     int32_t getQueueGeneration(bool audio);
303     int32_t getDrainGeneration(bool audio);
304     bool getSyncQueues();
305     void onAudioTearDown(AudioTearDownReason reason);
306     status_t onOpenAudioSink(
307             const sp<AMessage> &format,
308             bool offloadOnly,
309             bool hasVideo,
310             uint32_t flags,
311             bool isStreaming);
312     void onCloseAudioSink();
313     void onChangeAudioFormat(const sp<AMessage> &meta, const sp<AMessage> &notify);
314 
315     void notifyEOS(bool audio, status_t finalResult, int64_t delayUs = 0);
316     void notifyEOS_l(bool audio, status_t finalResult, int64_t delayUs = 0);
317     void notifyFlushComplete(bool audio);
318     void notifyPosition();
319     void notifyVideoLateBy(int64_t lateByUs);
320     void notifyVideoRenderingStart();
321     void notifyAudioTearDown(AudioTearDownReason reason);
322 
323     void flushQueue(List<QueueEntry> *queue);
324     bool dropBufferIfStale(bool audio, const sp<AMessage> &msg);
325     void syncQueuesDone_l();
326 
offloadingAudioRenderer327     bool offloadingAudio() const { return (mFlags & FLAG_OFFLOAD_AUDIO) != 0; }
328 
329     void startAudioOffloadPauseTimeout();
330     void cancelAudioOffloadPauseTimeout();
331 
332     int64_t getDurationUsIfPlayedAtSampleRate(uint32_t numFrames);
333 
334     DISALLOW_EVIL_CONSTRUCTORS(Renderer);
335 };
336 
337 } // namespace android
338 
339 #endif  // NUPLAYER_RENDERER_H_
340