NuPlayerRenderer.h revision d2f35de429c67a156299f662b0783fbcead13cb6 
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    bool mUseVirtualAudioSink;
138    sp<AMessage> mNotify;
139    Mutex mLock;
140    uint32_t mFlags;
141    List<QueueEntry> mAudioQueue;
142    List<QueueEntry> mVideoQueue;
143    uint32_t mNumFramesWritten;
144    sp<VideoFrameScheduler> mVideoScheduler;
145
146    bool mDrainAudioQueuePending;
147    bool mDrainVideoQueuePending;
148    int32_t mAudioQueueGeneration;
149    int32_t mVideoQueueGeneration;
150    int32_t mAudioDrainGeneration;
151    int32_t mVideoDrainGeneration;
152    int32_t mAudioEOSGeneration;
153
154    sp<MediaClock> mMediaClock;
155    float mPlaybackRate; // audio track rate
156
157    AudioPlaybackRate mPlaybackSettings;
158    AVSyncSettings mSyncSettings;
159    float mVideoFpsHint;
160
161    int64_t mAudioFirstAnchorTimeMediaUs;
162    int64_t mAnchorTimeMediaUs;
163    int64_t mAnchorNumFramesWritten;
164    int64_t mVideoLateByUs;
165    bool mHasAudio;
166    bool mHasVideo;
167
168    bool mNotifyCompleteAudio;
169    bool mNotifyCompleteVideo;
170
171    bool mSyncQueues;
172
173    // modified on only renderer's thread.
174    bool mPaused;
175    int64_t mPauseDrainAudioAllowedUs; // time when we can drain/deliver audio in pause mode.
176
177    bool mVideoSampleReceived;
178    bool mVideoRenderingStarted;
179    int32_t mVideoRenderingStartGeneration;
180    int32_t mAudioRenderingStartGeneration;
181    bool mRenderingDataDelivered;
182
183    int64_t mNextAudioClockUpdateTimeUs;
184    // the media timestamp of last audio sample right before EOS.
185    int64_t mLastAudioMediaTimeUs;
186
187    int32_t mAudioOffloadPauseTimeoutGeneration;
188    bool mAudioTornDown;
189    audio_offload_info_t mCurrentOffloadInfo;
190
191    struct PcmInfo {
192        audio_channel_mask_t mChannelMask;
193        audio_output_flags_t mFlags;
194        audio_format_t mFormat;
195        int32_t mNumChannels;
196        int32_t mSampleRate;
197    };
198    PcmInfo mCurrentPcmInfo;
199    static const PcmInfo AUDIO_PCMINFO_INITIALIZER;
200
201    int32_t mTotalBuffersQueued;
202    int32_t mLastAudioBufferDrained;
203    bool mUseAudioCallback;
204
205    sp<AWakeLock> mWakeLock;
206
207    status_t getCurrentPositionOnLooper(int64_t *mediaUs);
208    status_t getCurrentPositionOnLooper(
209            int64_t *mediaUs, int64_t nowUs, bool allowPastQueuedVideo = false);
210    bool getCurrentPositionIfPaused_l(int64_t *mediaUs);
211    status_t getCurrentPositionFromAnchor(
212            int64_t *mediaUs, int64_t nowUs, bool allowPastQueuedVideo = false);
213
214    size_t fillAudioBuffer(void *buffer, size_t size);
215
216    bool onDrainAudioQueue();
217    void drainAudioQueueUntilLastEOS();
218    int64_t getPendingAudioPlayoutDurationUs(int64_t nowUs);
219    void postDrainAudioQueue_l(int64_t delayUs = 0);
220
221    void clearAnchorTime_l();
222    void clearAudioFirstAnchorTime_l();
223    void setAudioFirstAnchorTimeIfNeeded_l(int64_t mediaUs);
224    void setVideoLateByUs(int64_t lateUs);
225
226    void onNewAudioMediaTime(int64_t mediaTimeUs);
227    int64_t getRealTimeUs(int64_t mediaTimeUs, int64_t nowUs);
228
229    void onDrainVideoQueue();
230    void postDrainVideoQueue();
231
232    void prepareForMediaRenderingStart_l();
233    void notifyIfMediaRenderingStarted_l();
234
235    void onQueueBuffer(const sp<AMessage> &msg);
236    void onQueueEOS(const sp<AMessage> &msg);
237    void onFlush(const sp<AMessage> &msg);
238    void onAudioSinkChanged();
239    void onDisableOffloadAudio();
240    void onEnableOffloadAudio();
241    status_t onConfigPlayback(const AudioPlaybackRate &rate /* sanitized */);
242    status_t onGetPlaybackSettings(AudioPlaybackRate *rate /* nonnull */);
243    status_t onConfigSync(const AVSyncSettings &sync, float videoFpsHint);
244    status_t onGetSyncSettings(AVSyncSettings *sync /* nonnull */, float *videoFps /* nonnull */);
245
246    void onPause();
247    void onResume();
248    void onSetVideoFrameRate(float fps);
249    int32_t getQueueGeneration(bool audio);
250    int32_t getDrainGeneration(bool audio);
251    bool getSyncQueues();
252    void onAudioTearDown(AudioTearDownReason reason);
253    status_t onOpenAudioSink(
254            const sp<AMessage> &format,
255            bool offloadOnly,
256            bool hasVideo,
257            uint32_t flags);
258    void onCloseAudioSink();
259
260    void notifyEOS(bool audio, status_t finalResult, int64_t delayUs = 0);
261    void notifyFlushComplete(bool audio);
262    void notifyPosition();
263    void notifyVideoLateBy(int64_t lateByUs);
264    void notifyVideoRenderingStart();
265    void notifyAudioTearDown();
266
267    void flushQueue(List<QueueEntry> *queue);
268    bool dropBufferIfStale(bool audio, const sp<AMessage> &msg);
269    void syncQueuesDone_l();
270
271    bool offloadingAudio() const { return (mFlags & FLAG_OFFLOAD_AUDIO) != 0; }
272
273    void startAudioOffloadPauseTimeout();
274    void cancelAudioOffloadPauseTimeout();
275
276    int64_t getDurationUsIfPlayedAtSampleRate(uint32_t numFrames);
277
278    DISALLOW_EVIL_CONSTRUCTORS(Renderer);
279};
280
281} // namespace android
282
283#endif  // NUPLAYER_RENDERER_H_
284