blob: 2ab2779b1559999df44df5b76298dbaeb74b7285 [file] [log] [blame]
magjeddf494b02016-10-07 05:32:35 -07001/*
2 * Copyright 2016 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11package org.webrtc;
12
sakalfb0c5732016-11-03 09:15:34 -070013import android.graphics.Bitmap;
sakal6bdcefc2017-08-15 01:56:02 -070014import android.graphics.Matrix;
magjed9ab8a182016-10-20 03:18:09 -070015import android.graphics.SurfaceTexture;
magjeddf494b02016-10-07 05:32:35 -070016import android.opengl.GLES20;
17import android.os.Handler;
18import android.os.HandlerThread;
19import android.os.Looper;
Sami Kalliomäki0d26c992018-10-19 12:53:21 +020020import android.os.Message;
Artem Titarenko69540f42018-12-10 12:30:46 +010021import android.support.annotation.Nullable;
magjeddf494b02016-10-07 05:32:35 -070022import android.view.Surface;
sakalfb0c5732016-11-03 09:15:34 -070023import java.nio.ByteBuffer;
Sami Kalliomäki1659e972018-06-04 14:07:58 +020024import java.text.DecimalFormat;
sakalfb0c5732016-11-03 09:15:34 -070025import java.util.ArrayList;
26import java.util.Iterator;
magjeddf494b02016-10-07 05:32:35 -070027import java.util.concurrent.CountDownLatch;
28import java.util.concurrent.TimeUnit;
29
30/**
Magnus Jedvert431f14e2018-06-09 19:41:58 +020031 * Implements VideoSink by displaying the video stream on an EGL Surface. This class is intended to
32 * be used as a helper class for rendering on SurfaceViews and TextureViews.
magjeddf494b02016-10-07 05:32:35 -070033 */
Magnus Jedvert431f14e2018-06-09 19:41:58 +020034public class EglRenderer implements VideoSink {
magjeddf494b02016-10-07 05:32:35 -070035 private static final String TAG = "EglRenderer";
magjed9ab8a182016-10-20 03:18:09 -070036 private static final long LOG_INTERVAL_SEC = 4;
magjeddf494b02016-10-07 05:32:35 -070037
sakalfb0c5732016-11-03 09:15:34 -070038 public interface FrameListener { void onFrame(Bitmap frame); }
39
sakal3a9bc172016-11-30 08:30:05 -080040 private static class FrameListenerAndParams {
sakalfb0c5732016-11-03 09:15:34 -070041 public final FrameListener listener;
sakal3a9bc172016-11-30 08:30:05 -080042 public final float scale;
43 public final RendererCommon.GlDrawer drawer;
sakal8fdf9572017-05-31 02:43:10 -070044 public final boolean applyFpsReduction;
sakalfb0c5732016-11-03 09:15:34 -070045
sakal8fdf9572017-05-31 02:43:10 -070046 public FrameListenerAndParams(FrameListener listener, float scale,
47 RendererCommon.GlDrawer drawer, boolean applyFpsReduction) {
sakalfb0c5732016-11-03 09:15:34 -070048 this.listener = listener;
sakal3a9bc172016-11-30 08:30:05 -080049 this.scale = scale;
50 this.drawer = drawer;
sakal8fdf9572017-05-31 02:43:10 -070051 this.applyFpsReduction = applyFpsReduction;
sakalfb0c5732016-11-03 09:15:34 -070052 }
53 }
54
magjeddf494b02016-10-07 05:32:35 -070055 private class EglSurfaceCreation implements Runnable {
magjed9ab8a182016-10-20 03:18:09 -070056 private Object surface;
magjeddf494b02016-10-07 05:32:35 -070057
Mirko Bonadei12251b62017-11-05 19:35:31 -080058 // TODO(bugs.webrtc.org/8491): Remove NoSynchronizedMethodCheck suppression.
59 @SuppressWarnings("NoSynchronizedMethodCheck")
magjed9ab8a182016-10-20 03:18:09 -070060 public synchronized void setSurface(Object surface) {
magjeddf494b02016-10-07 05:32:35 -070061 this.surface = surface;
62 }
63
64 @Override
Mirko Bonadei12251b62017-11-05 19:35:31 -080065 // TODO(bugs.webrtc.org/8491): Remove NoSynchronizedMethodCheck suppression.
66 @SuppressWarnings("NoSynchronizedMethodCheck")
magjeddf494b02016-10-07 05:32:35 -070067 public synchronized void run() {
68 if (surface != null && eglBase != null && !eglBase.hasSurface()) {
magjed9ab8a182016-10-20 03:18:09 -070069 if (surface instanceof Surface) {
70 eglBase.createSurface((Surface) surface);
71 } else if (surface instanceof SurfaceTexture) {
72 eglBase.createSurface((SurfaceTexture) surface);
73 } else {
74 throw new IllegalStateException("Invalid surface: " + surface);
75 }
magjeddf494b02016-10-07 05:32:35 -070076 eglBase.makeCurrent();
77 // Necessary for YUV frames with odd width.
78 GLES20.glPixelStorei(GLES20.GL_UNPACK_ALIGNMENT, 1);
79 }
80 }
81 }
82
Sami Kalliomäki0d26c992018-10-19 12:53:21 +020083 /**
84 * Handler that triggers a callback when an uncaught exception happens when handling a message.
85 */
86 private static class HandlerWithExceptionCallback extends Handler {
87 private final Runnable exceptionCallback;
88
89 public HandlerWithExceptionCallback(Looper looper, Runnable exceptionCallback) {
90 super(looper);
91 this.exceptionCallback = exceptionCallback;
92 }
93
94 @Override
95 public void dispatchMessage(Message msg) {
96 try {
97 super.dispatchMessage(msg);
98 } catch (Exception e) {
99 Logging.e(TAG, "Exception on EglRenderer thread", e);
100 exceptionCallback.run();
101 throw e;
102 }
103 }
104 }
105
Xiaolei Yu149533a2017-11-03 07:55:01 +0800106 protected final String name;
magjeddf494b02016-10-07 05:32:35 -0700107
108 // |renderThreadHandler| is a handler for communicating with |renderThread|, and is synchronized
109 // on |handlerLock|.
110 private final Object handlerLock = new Object();
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100111 @Nullable private Handler renderThreadHandler;
magjeddf494b02016-10-07 05:32:35 -0700112
sakal3a9bc172016-11-30 08:30:05 -0800113 private final ArrayList<FrameListenerAndParams> frameListeners = new ArrayList<>();
sakalfb0c5732016-11-03 09:15:34 -0700114
magjed9ab8a182016-10-20 03:18:09 -0700115 // Variables for fps reduction.
116 private final Object fpsReductionLock = new Object();
117 // Time for when next frame should be rendered.
118 private long nextFrameTimeNs;
119 // Minimum duration between frames when fps reduction is active, or -1 if video is completely
120 // paused.
121 private long minRenderPeriodNs;
122
magjeddf494b02016-10-07 05:32:35 -0700123 // EGL and GL resources for drawing YUV/OES textures. After initilization, these are only accessed
124 // from the render thread.
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100125 @Nullable private EglBase eglBase;
Åsa Perssonf2889bb2019-02-25 16:20:01 +0100126 private final VideoFrameDrawer frameDrawer;
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100127 @Nullable private RendererCommon.GlDrawer drawer;
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100128 private boolean usePresentationTimeStamp;
magjed7cede372017-09-11 06:12:07 -0700129 private final Matrix drawMatrix = new Matrix();
magjeddf494b02016-10-07 05:32:35 -0700130
131 // Pending frame to render. Serves as a queue with size 1. Synchronized on |frameLock|.
132 private final Object frameLock = new Object();
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100133 @Nullable private VideoFrame pendingFrame;
magjeddf494b02016-10-07 05:32:35 -0700134
135 // These variables are synchronized on |layoutLock|.
136 private final Object layoutLock = new Object();
magjeddf494b02016-10-07 05:32:35 -0700137 private float layoutAspectRatio;
138 // If true, mirrors the video stream horizontally.
Magnus Jedvert3ff71de2018-12-17 10:26:12 +0100139 private boolean mirrorHorizontally;
140 // If true, mirrors the video stream vertically.
141 private boolean mirrorVertically;
magjeddf494b02016-10-07 05:32:35 -0700142
143 // These variables are synchronized on |statisticsLock|.
144 private final Object statisticsLock = new Object();
145 // Total number of video frames received in renderFrame() call.
146 private int framesReceived;
147 // Number of video frames dropped by renderFrame() because previous frame has not been rendered
148 // yet.
149 private int framesDropped;
150 // Number of rendered video frames.
151 private int framesRendered;
magjed9ab8a182016-10-20 03:18:09 -0700152 // Start time for counting these statistics, or 0 if we haven't started measuring yet.
153 private long statisticsStartTimeNs;
magjeddf494b02016-10-07 05:32:35 -0700154 // Time in ns spent in renderFrameOnRenderThread() function.
155 private long renderTimeNs;
magjed9ab8a182016-10-20 03:18:09 -0700156 // Time in ns spent by the render thread in the swapBuffers() function.
157 private long renderSwapBufferTimeNs;
magjeddf494b02016-10-07 05:32:35 -0700158
sakalfb0c5732016-11-03 09:15:34 -0700159 // Used for bitmap capturing.
Magnus Jedvert2ed62b32018-04-11 14:25:14 +0200160 private final GlTextureFrameBuffer bitmapTextureFramebuffer =
161 new GlTextureFrameBuffer(GLES20.GL_RGBA);
sakalfb0c5732016-11-03 09:15:34 -0700162
magjed9ab8a182016-10-20 03:18:09 -0700163 private final Runnable logStatisticsRunnable = new Runnable() {
164 @Override
165 public void run() {
166 logStatistics();
167 synchronized (handlerLock) {
168 if (renderThreadHandler != null) {
169 renderThreadHandler.removeCallbacks(logStatisticsRunnable);
170 renderThreadHandler.postDelayed(
171 logStatisticsRunnable, TimeUnit.SECONDS.toMillis(LOG_INTERVAL_SEC));
172 }
173 }
174 }
175 };
176
magjeddf494b02016-10-07 05:32:35 -0700177 private final EglSurfaceCreation eglSurfaceCreationRunnable = new EglSurfaceCreation();
178
179 /**
180 * Standard constructor. The name will be used for the render thread name and included when
181 * logging. In order to render something, you must first call init() and createEglSurface.
182 */
183 public EglRenderer(String name) {
Åsa Perssonf2889bb2019-02-25 16:20:01 +0100184 this(name, new VideoFrameDrawer());
185 }
186
187 public EglRenderer(String name, VideoFrameDrawer videoFrameDrawer) {
magjeddf494b02016-10-07 05:32:35 -0700188 this.name = name;
Åsa Perssonf2889bb2019-02-25 16:20:01 +0100189 this.frameDrawer = videoFrameDrawer;
magjeddf494b02016-10-07 05:32:35 -0700190 }
191
192 /**
193 * Initialize this class, sharing resources with |sharedContext|. The custom |drawer| will be used
194 * for drawing frames on the EGLSurface. This class is responsible for calling release() on
195 * |drawer|. It is allowed to call init() to reinitialize the renderer after a previous
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100196 * init()/release() cycle. If usePresentationTimeStamp is true, eglPresentationTimeANDROID will be
197 * set with the frame timestamps, which specifies desired presentation time and might be useful
198 * for e.g. syncing audio and video.
magjeddf494b02016-10-07 05:32:35 -0700199 */
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100200 public void init(@Nullable final EglBase.Context sharedContext, final int[] configAttributes,
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100201 RendererCommon.GlDrawer drawer, boolean usePresentationTimeStamp) {
magjeddf494b02016-10-07 05:32:35 -0700202 synchronized (handlerLock) {
203 if (renderThreadHandler != null) {
204 throw new IllegalStateException(name + "Already initialized");
205 }
206 logD("Initializing EglRenderer");
207 this.drawer = drawer;
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100208 this.usePresentationTimeStamp = usePresentationTimeStamp;
magjeddf494b02016-10-07 05:32:35 -0700209
210 final HandlerThread renderThread = new HandlerThread(name + "EglRenderer");
211 renderThread.start();
Sami Kalliomäki0d26c992018-10-19 12:53:21 +0200212 renderThreadHandler =
213 new HandlerWithExceptionCallback(renderThread.getLooper(), new Runnable() {
214 @Override
215 public void run() {
216 synchronized (handlerLock) {
217 renderThreadHandler = null;
218 }
219 }
220 });
magjeddf494b02016-10-07 05:32:35 -0700221 // Create EGL context on the newly created render thread. It should be possibly to create the
222 // context on this thread and make it current on the render thread, but this causes failure on
223 // some Marvel based JB devices. https://bugs.chromium.org/p/webrtc/issues/detail?id=6350.
sakalbf080602017-08-11 01:42:43 -0700224 ThreadUtils.invokeAtFrontUninterruptibly(renderThreadHandler, () -> {
225 // If sharedContext is null, then texture frames are disabled. This is typically for old
226 // devices that might not be fully spec compliant, so force EGL 1.0 since EGL 1.4 has
227 // caused trouble on some weird devices.
228 if (sharedContext == null) {
229 logD("EglBase10.create context");
230 eglBase = EglBase.createEgl10(configAttributes);
231 } else {
232 logD("EglBase.create shared context");
233 eglBase = EglBase.create(sharedContext, configAttributes);
magjeddf494b02016-10-07 05:32:35 -0700234 }
235 });
magjed9ab8a182016-10-20 03:18:09 -0700236 renderThreadHandler.post(eglSurfaceCreationRunnable);
237 final long currentTimeNs = System.nanoTime();
238 resetStatistics(currentTimeNs);
239 renderThreadHandler.postDelayed(
240 logStatisticsRunnable, TimeUnit.SECONDS.toMillis(LOG_INTERVAL_SEC));
magjeddf494b02016-10-07 05:32:35 -0700241 }
242 }
243
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100244 /**
245 * Same as above with usePresentationTimeStamp set to false.
246 *
247 * @see #init(EglBase.Context, int[], RendererCommon.GlDrawer, boolean)
248 */
249 public void init(@Nullable final EglBase.Context sharedContext, final int[] configAttributes,
250 RendererCommon.GlDrawer drawer) {
251 init(sharedContext, configAttributes, drawer, /* usePresentationTimeStamp= */ false);
252 }
253
magjeddf494b02016-10-07 05:32:35 -0700254 public void createEglSurface(Surface surface) {
magjed9ab8a182016-10-20 03:18:09 -0700255 createEglSurfaceInternal(surface);
256 }
257
258 public void createEglSurface(SurfaceTexture surfaceTexture) {
259 createEglSurfaceInternal(surfaceTexture);
260 }
261
262 private void createEglSurfaceInternal(Object surface) {
magjeddf494b02016-10-07 05:32:35 -0700263 eglSurfaceCreationRunnable.setSurface(surface);
magjed9ab8a182016-10-20 03:18:09 -0700264 postToRenderThread(eglSurfaceCreationRunnable);
magjeddf494b02016-10-07 05:32:35 -0700265 }
266
267 /**
268 * Block until any pending frame is returned and all GL resources released, even if an interrupt
269 * occurs. If an interrupt occurs during release(), the interrupt flag will be set. This function
270 * should be called before the Activity is destroyed and the EGLContext is still valid. If you
271 * don't call this function, the GL resources might leak.
272 */
273 public void release() {
magjed9ab8a182016-10-20 03:18:09 -0700274 logD("Releasing.");
magjeddf494b02016-10-07 05:32:35 -0700275 final CountDownLatch eglCleanupBarrier = new CountDownLatch(1);
276 synchronized (handlerLock) {
277 if (renderThreadHandler == null) {
278 logD("Already released");
279 return;
280 }
magjed9ab8a182016-10-20 03:18:09 -0700281 renderThreadHandler.removeCallbacks(logStatisticsRunnable);
magjeddf494b02016-10-07 05:32:35 -0700282 // Release EGL and GL resources on render thread.
sakalbf080602017-08-11 01:42:43 -0700283 renderThreadHandler.postAtFrontOfQueue(() -> {
Magnus Jedvert94c0f262018-12-12 17:35:28 +0100284 // Detach current shader program.
285 GLES20.glUseProgram(/* program= */ 0);
sakalbf080602017-08-11 01:42:43 -0700286 if (drawer != null) {
287 drawer.release();
288 drawer = null;
magjeddf494b02016-10-07 05:32:35 -0700289 }
magjed7cede372017-09-11 06:12:07 -0700290 frameDrawer.release();
Magnus Jedvert2ed62b32018-04-11 14:25:14 +0200291 bitmapTextureFramebuffer.release();
sakalbf080602017-08-11 01:42:43 -0700292 if (eglBase != null) {
293 logD("eglBase detach and release.");
294 eglBase.detachCurrent();
295 eglBase.release();
296 eglBase = null;
297 }
Sami Kalliomäki8ebac242017-11-08 17:13:13 +0100298 frameListeners.clear();
sakalbf080602017-08-11 01:42:43 -0700299 eglCleanupBarrier.countDown();
magjeddf494b02016-10-07 05:32:35 -0700300 });
301 final Looper renderLooper = renderThreadHandler.getLooper();
302 // TODO(magjed): Replace this post() with renderLooper.quitSafely() when API support >= 18.
sakalbf080602017-08-11 01:42:43 -0700303 renderThreadHandler.post(() -> {
304 logD("Quitting render thread.");
305 renderLooper.quit();
magjeddf494b02016-10-07 05:32:35 -0700306 });
307 // Don't accept any more frames or messages to the render thread.
308 renderThreadHandler = null;
309 }
310 // Make sure the EGL/GL cleanup posted above is executed.
311 ThreadUtils.awaitUninterruptibly(eglCleanupBarrier);
312 synchronized (frameLock) {
313 if (pendingFrame != null) {
sakal6bdcefc2017-08-15 01:56:02 -0700314 pendingFrame.release();
magjeddf494b02016-10-07 05:32:35 -0700315 pendingFrame = null;
316 }
317 }
magjeddf494b02016-10-07 05:32:35 -0700318 logD("Releasing done.");
319 }
320
321 /**
magjed9ab8a182016-10-20 03:18:09 -0700322 * Reset the statistics logged in logStatistics().
magjeddf494b02016-10-07 05:32:35 -0700323 */
magjed9ab8a182016-10-20 03:18:09 -0700324 private void resetStatistics(long currentTimeNs) {
magjeddf494b02016-10-07 05:32:35 -0700325 synchronized (statisticsLock) {
magjed9ab8a182016-10-20 03:18:09 -0700326 statisticsStartTimeNs = currentTimeNs;
magjeddf494b02016-10-07 05:32:35 -0700327 framesReceived = 0;
328 framesDropped = 0;
329 framesRendered = 0;
magjeddf494b02016-10-07 05:32:35 -0700330 renderTimeNs = 0;
magjed9ab8a182016-10-20 03:18:09 -0700331 renderSwapBufferTimeNs = 0;
332 }
333 }
334
335 public void printStackTrace() {
336 synchronized (handlerLock) {
337 final Thread renderThread =
338 (renderThreadHandler == null) ? null : renderThreadHandler.getLooper().getThread();
339 if (renderThread != null) {
340 final StackTraceElement[] renderStackTrace = renderThread.getStackTrace();
341 if (renderStackTrace.length > 0) {
Magnus Jedvert0cc11b42018-11-27 16:19:55 +0100342 logW("EglRenderer stack trace:");
magjed9ab8a182016-10-20 03:18:09 -0700343 for (StackTraceElement traceElem : renderStackTrace) {
Magnus Jedvert0cc11b42018-11-27 16:19:55 +0100344 logW(traceElem.toString());
magjed9ab8a182016-10-20 03:18:09 -0700345 }
346 }
347 }
magjeddf494b02016-10-07 05:32:35 -0700348 }
349 }
350
351 /**
Magnus Jedvert3ff71de2018-12-17 10:26:12 +0100352 * Set if the video stream should be mirrored horizontally or not.
magjeddf494b02016-10-07 05:32:35 -0700353 */
354 public void setMirror(final boolean mirror) {
Magnus Jedvert3ff71de2018-12-17 10:26:12 +0100355 logD("setMirrorHorizontally: " + mirror);
magjeddf494b02016-10-07 05:32:35 -0700356 synchronized (layoutLock) {
Magnus Jedvert3ff71de2018-12-17 10:26:12 +0100357 this.mirrorHorizontally = mirror;
358 }
359 }
360
361 /**
362 * Set if the video stream should be mirrored vertically or not.
363 */
364 public void setMirrorVertically(final boolean mirrorVertically) {
365 logD("setMirrorVertically: " + mirrorVertically);
366 synchronized (layoutLock) {
367 this.mirrorVertically = mirrorVertically;
magjeddf494b02016-10-07 05:32:35 -0700368 }
369 }
370
371 /**
372 * Set layout aspect ratio. This is used to crop frames when rendering to avoid stretched video.
373 * Set this to 0 to disable cropping.
374 */
375 public void setLayoutAspectRatio(float layoutAspectRatio) {
376 logD("setLayoutAspectRatio: " + layoutAspectRatio);
377 synchronized (layoutLock) {
378 this.layoutAspectRatio = layoutAspectRatio;
379 }
380 }
381
magjed9ab8a182016-10-20 03:18:09 -0700382 /**
383 * Limit render framerate.
384 *
385 * @param fps Limit render framerate to this value, or use Float.POSITIVE_INFINITY to disable fps
386 * reduction.
387 */
388 public void setFpsReduction(float fps) {
389 logD("setFpsReduction: " + fps);
390 synchronized (fpsReductionLock) {
391 final long previousRenderPeriodNs = minRenderPeriodNs;
392 if (fps <= 0) {
393 minRenderPeriodNs = Long.MAX_VALUE;
394 } else {
395 minRenderPeriodNs = (long) (TimeUnit.SECONDS.toNanos(1) / fps);
396 }
397 if (minRenderPeriodNs != previousRenderPeriodNs) {
398 // Fps reduction changed - reset frame time.
399 nextFrameTimeNs = System.nanoTime();
400 }
401 }
402 }
403
404 public void disableFpsReduction() {
405 setFpsReduction(Float.POSITIVE_INFINITY /* fps */);
406 }
407
408 public void pauseVideo() {
409 setFpsReduction(0 /* fps */);
410 }
411
sakalfb0c5732016-11-03 09:15:34 -0700412 /**
sakal3a9bc172016-11-30 08:30:05 -0800413 * Register a callback to be invoked when a new video frame has been received. This version uses
414 * the drawer of the EglRenderer that was passed in init.
sakalfb0c5732016-11-03 09:15:34 -0700415 *
sakald1516522017-03-13 05:11:48 -0700416 * @param listener The callback to be invoked. The callback will be invoked on the render thread.
417 * It should be lightweight and must not call removeFrameListener.
sakalfb0c5732016-11-03 09:15:34 -0700418 * @param scale The scale of the Bitmap passed to the callback, or 0 if no Bitmap is
419 * required.
420 */
sakalbb584352016-11-28 08:53:44 -0800421 public void addFrameListener(final FrameListener listener, final float scale) {
sakal8fdf9572017-05-31 02:43:10 -0700422 addFrameListener(listener, scale, null, false /* applyFpsReduction */);
sakal3a9bc172016-11-30 08:30:05 -0800423 }
424
425 /**
426 * Register a callback to be invoked when a new video frame has been received.
427 *
sakald1516522017-03-13 05:11:48 -0700428 * @param listener The callback to be invoked. The callback will be invoked on the render thread.
429 * It should be lightweight and must not call removeFrameListener.
sakal3a9bc172016-11-30 08:30:05 -0800430 * @param scale The scale of the Bitmap passed to the callback, or 0 if no Bitmap is
431 * required.
sakald1516522017-03-13 05:11:48 -0700432 * @param drawer Custom drawer to use for this frame listener or null to use the default one.
sakal3a9bc172016-11-30 08:30:05 -0800433 */
434 public void addFrameListener(
sakald1516522017-03-13 05:11:48 -0700435 final FrameListener listener, final float scale, final RendererCommon.GlDrawer drawerParam) {
sakal8fdf9572017-05-31 02:43:10 -0700436 addFrameListener(listener, scale, drawerParam, false /* applyFpsReduction */);
437 }
438
439 /**
440 * Register a callback to be invoked when a new video frame has been received.
441 *
442 * @param listener The callback to be invoked. The callback will be invoked on the render thread.
443 * It should be lightweight and must not call removeFrameListener.
444 * @param scale The scale of the Bitmap passed to the callback, or 0 if no Bitmap is
445 * required.
446 * @param drawer Custom drawer to use for this frame listener or null to use the default one.
447 * @param applyFpsReduction This callback will not be called for frames that have been dropped by
448 * FPS reduction.
449 */
450 public void addFrameListener(final FrameListener listener, final float scale,
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100451 @Nullable final RendererCommon.GlDrawer drawerParam, final boolean applyFpsReduction) {
sakalbf080602017-08-11 01:42:43 -0700452 postToRenderThread(() -> {
453 final RendererCommon.GlDrawer listenerDrawer = drawerParam == null ? drawer : drawerParam;
454 frameListeners.add(
455 new FrameListenerAndParams(listener, scale, listenerDrawer, applyFpsReduction));
sakalbb584352016-11-28 08:53:44 -0800456 });
sakalfb0c5732016-11-03 09:15:34 -0700457 }
458
459 /**
460 * Remove any pending callback that was added with addFrameListener. If the callback is not in
sakalbb584352016-11-28 08:53:44 -0800461 * the queue, nothing happens. It is ensured that callback won't be called after this method
462 * returns.
sakalfb0c5732016-11-03 09:15:34 -0700463 *
464 * @param runnable The callback to remove.
465 */
sakalbb584352016-11-28 08:53:44 -0800466 public void removeFrameListener(final FrameListener listener) {
467 final CountDownLatch latch = new CountDownLatch(1);
Sami Kalliomäki8ebac242017-11-08 17:13:13 +0100468 synchronized (handlerLock) {
469 if (renderThreadHandler == null) {
470 return;
sakalfb0c5732016-11-03 09:15:34 -0700471 }
Sami Kalliomäki8ebac242017-11-08 17:13:13 +0100472 if (Thread.currentThread() == renderThreadHandler.getLooper().getThread()) {
473 throw new RuntimeException("removeFrameListener must not be called on the render thread.");
474 }
475 postToRenderThread(() -> {
476 latch.countDown();
477 final Iterator<FrameListenerAndParams> iter = frameListeners.iterator();
478 while (iter.hasNext()) {
479 if (iter.next().listener == listener) {
480 iter.remove();
481 }
482 }
483 });
484 }
sakalbb584352016-11-28 08:53:44 -0800485 ThreadUtils.awaitUninterruptibly(latch);
sakalfb0c5732016-11-03 09:15:34 -0700486 }
487
sakal6bdcefc2017-08-15 01:56:02 -0700488 // VideoSink interface.
489 @Override
490 public void onFrame(VideoFrame frame) {
magjeddf494b02016-10-07 05:32:35 -0700491 synchronized (statisticsLock) {
492 ++framesReceived;
493 }
magjed9ab8a182016-10-20 03:18:09 -0700494 final boolean dropOldFrame;
magjeddf494b02016-10-07 05:32:35 -0700495 synchronized (handlerLock) {
496 if (renderThreadHandler == null) {
497 logD("Dropping frame - Not initialized or already released.");
magjeddf494b02016-10-07 05:32:35 -0700498 return;
499 }
magjed9ab8a182016-10-20 03:18:09 -0700500 synchronized (frameLock) {
501 dropOldFrame = (pendingFrame != null);
502 if (dropOldFrame) {
sakal6bdcefc2017-08-15 01:56:02 -0700503 pendingFrame.release();
magjeddf494b02016-10-07 05:32:35 -0700504 }
505 pendingFrame = frame;
sakal6bdcefc2017-08-15 01:56:02 -0700506 pendingFrame.retain();
sakalbf080602017-08-11 01:42:43 -0700507 renderThreadHandler.post(this ::renderFrameOnRenderThread);
magjeddf494b02016-10-07 05:32:35 -0700508 }
509 }
magjed9ab8a182016-10-20 03:18:09 -0700510 if (dropOldFrame) {
511 synchronized (statisticsLock) {
512 ++framesDropped;
513 }
514 }
magjeddf494b02016-10-07 05:32:35 -0700515 }
516
517 /**
518 * Release EGL surface. This function will block until the EGL surface is released.
519 */
sakal28ec6bd2016-11-09 01:47:12 -0800520 public void releaseEglSurface(final Runnable completionCallback) {
magjeddf494b02016-10-07 05:32:35 -0700521 // Ensure that the render thread is no longer touching the Surface before returning from this
522 // function.
523 eglSurfaceCreationRunnable.setSurface(null /* surface */);
524 synchronized (handlerLock) {
525 if (renderThreadHandler != null) {
526 renderThreadHandler.removeCallbacks(eglSurfaceCreationRunnable);
sakalbf080602017-08-11 01:42:43 -0700527 renderThreadHandler.postAtFrontOfQueue(() -> {
528 if (eglBase != null) {
529 eglBase.detachCurrent();
530 eglBase.releaseSurface();
magjeddf494b02016-10-07 05:32:35 -0700531 }
sakalbf080602017-08-11 01:42:43 -0700532 completionCallback.run();
magjeddf494b02016-10-07 05:32:35 -0700533 });
sakal28ec6bd2016-11-09 01:47:12 -0800534 return;
magjeddf494b02016-10-07 05:32:35 -0700535 }
536 }
sakal28ec6bd2016-11-09 01:47:12 -0800537 completionCallback.run();
magjeddf494b02016-10-07 05:32:35 -0700538 }
539
540 /**
magjeddf494b02016-10-07 05:32:35 -0700541 * Private helper function to post tasks safely.
542 */
magjed9ab8a182016-10-20 03:18:09 -0700543 private void postToRenderThread(Runnable runnable) {
magjeddf494b02016-10-07 05:32:35 -0700544 synchronized (handlerLock) {
545 if (renderThreadHandler != null) {
546 renderThreadHandler.post(runnable);
547 }
548 }
549 }
550
sakalf25a2202017-05-04 06:06:56 -0700551 private void clearSurfaceOnRenderThread(float r, float g, float b, float a) {
magjeddf494b02016-10-07 05:32:35 -0700552 if (eglBase != null && eglBase.hasSurface()) {
553 logD("clearSurface");
sakalf25a2202017-05-04 06:06:56 -0700554 GLES20.glClearColor(r, g, b, a);
magjeddf494b02016-10-07 05:32:35 -0700555 GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT);
556 eglBase.swapBuffers();
557 }
558 }
559
560 /**
sakalf25a2202017-05-04 06:06:56 -0700561 * Post a task to clear the surface to a transparent uniform color.
magjed9ab8a182016-10-20 03:18:09 -0700562 */
563 public void clearImage() {
sakalf25a2202017-05-04 06:06:56 -0700564 clearImage(0 /* red */, 0 /* green */, 0 /* blue */, 0 /* alpha */);
565 }
566
567 /**
568 * Post a task to clear the surface to a specific color.
569 */
570 public void clearImage(final float r, final float g, final float b, final float a) {
magjed9ab8a182016-10-20 03:18:09 -0700571 synchronized (handlerLock) {
572 if (renderThreadHandler == null) {
573 return;
574 }
sakalbf080602017-08-11 01:42:43 -0700575 renderThreadHandler.postAtFrontOfQueue(() -> clearSurfaceOnRenderThread(r, g, b, a));
magjed9ab8a182016-10-20 03:18:09 -0700576 }
577 }
578
579 /**
magjeddf494b02016-10-07 05:32:35 -0700580 * Renders and releases |pendingFrame|.
581 */
582 private void renderFrameOnRenderThread() {
583 // Fetch and render |pendingFrame|.
sakal6bdcefc2017-08-15 01:56:02 -0700584 final VideoFrame frame;
magjeddf494b02016-10-07 05:32:35 -0700585 synchronized (frameLock) {
586 if (pendingFrame == null) {
587 return;
588 }
589 frame = pendingFrame;
590 pendingFrame = null;
591 }
592 if (eglBase == null || !eglBase.hasSurface()) {
593 logD("Dropping frame - No surface");
sakal6bdcefc2017-08-15 01:56:02 -0700594 frame.release();
magjeddf494b02016-10-07 05:32:35 -0700595 return;
596 }
sakald1516522017-03-13 05:11:48 -0700597 // Check if fps reduction is active.
598 final boolean shouldRenderFrame;
599 synchronized (fpsReductionLock) {
600 if (minRenderPeriodNs == Long.MAX_VALUE) {
601 // Rendering is paused.
602 shouldRenderFrame = false;
603 } else if (minRenderPeriodNs <= 0) {
604 // FPS reduction is disabled.
605 shouldRenderFrame = true;
606 } else {
607 final long currentTimeNs = System.nanoTime();
608 if (currentTimeNs < nextFrameTimeNs) {
609 logD("Skipping frame rendering - fps reduction is active.");
610 shouldRenderFrame = false;
611 } else {
612 nextFrameTimeNs += minRenderPeriodNs;
613 // The time for the next frame should always be in the future.
614 nextFrameTimeNs = Math.max(nextFrameTimeNs, currentTimeNs);
615 shouldRenderFrame = true;
616 }
617 }
618 }
magjeddf494b02016-10-07 05:32:35 -0700619
620 final long startTimeNs = System.nanoTime();
magjeddf494b02016-10-07 05:32:35 -0700621
sakal6bdcefc2017-08-15 01:56:02 -0700622 final float frameAspectRatio = frame.getRotatedWidth() / (float) frame.getRotatedHeight();
623 final float drawnAspectRatio;
magjeddf494b02016-10-07 05:32:35 -0700624 synchronized (layoutLock) {
sakal6bdcefc2017-08-15 01:56:02 -0700625 drawnAspectRatio = layoutAspectRatio != 0f ? layoutAspectRatio : frameAspectRatio;
magjeddf494b02016-10-07 05:32:35 -0700626 }
627
sakal6bdcefc2017-08-15 01:56:02 -0700628 final float scaleX;
629 final float scaleY;
630
631 if (frameAspectRatio > drawnAspectRatio) {
632 scaleX = drawnAspectRatio / frameAspectRatio;
633 scaleY = 1f;
634 } else {
635 scaleX = 1f;
636 scaleY = frameAspectRatio / drawnAspectRatio;
637 }
638
magjed7cede372017-09-11 06:12:07 -0700639 drawMatrix.reset();
sakal6bdcefc2017-08-15 01:56:02 -0700640 drawMatrix.preTranslate(0.5f, 0.5f);
Magnus Jedvert3ff71de2018-12-17 10:26:12 +0100641 drawMatrix.preScale(mirrorHorizontally ? -1f : 1f, mirrorVertically ? -1f : 1f);
sakal6bdcefc2017-08-15 01:56:02 -0700642 drawMatrix.preScale(scaleX, scaleY);
643 drawMatrix.preTranslate(-0.5f, -0.5f);
644
sakald1516522017-03-13 05:11:48 -0700645 if (shouldRenderFrame) {
646 GLES20.glClearColor(0 /* red */, 0 /* green */, 0 /* blue */, 0 /* alpha */);
647 GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT);
magjed7cede372017-09-11 06:12:07 -0700648 frameDrawer.drawFrame(frame, drawer, drawMatrix, 0 /* viewportX */, 0 /* viewportY */,
649 eglBase.surfaceWidth(), eglBase.surfaceHeight());
sakald1516522017-03-13 05:11:48 -0700650
651 final long swapBuffersStartTimeNs = System.nanoTime();
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100652 if (usePresentationTimeStamp) {
653 eglBase.swapBuffers(frame.getTimestampNs());
654 } else {
655 eglBase.swapBuffers();
656 }
sakald1516522017-03-13 05:11:48 -0700657
658 final long currentTimeNs = System.nanoTime();
659 synchronized (statisticsLock) {
660 ++framesRendered;
661 renderTimeNs += (currentTimeNs - startTimeNs);
662 renderSwapBufferTimeNs += (currentTimeNs - swapBuffersStartTimeNs);
663 }
magjeddf494b02016-10-07 05:32:35 -0700664 }
665
magjed7cede372017-09-11 06:12:07 -0700666 notifyCallbacks(frame, shouldRenderFrame);
667 frame.release();
sakalfb0c5732016-11-03 09:15:34 -0700668 }
669
magjed7cede372017-09-11 06:12:07 -0700670 private void notifyCallbacks(VideoFrame frame, boolean wasRendered) {
sakalbb584352016-11-28 08:53:44 -0800671 if (frameListeners.isEmpty())
672 return;
sakalfb0c5732016-11-03 09:15:34 -0700673
magjed7cede372017-09-11 06:12:07 -0700674 drawMatrix.reset();
sakal6bdcefc2017-08-15 01:56:02 -0700675 drawMatrix.preTranslate(0.5f, 0.5f);
Magnus Jedvert3ff71de2018-12-17 10:26:12 +0100676 drawMatrix.preScale(mirrorHorizontally ? -1f : 1f, mirrorVertically ? -1f : 1f);
sakal6bdcefc2017-08-15 01:56:02 -0700677 drawMatrix.preScale(1f, -1f); // We want the output to be upside down for Bitmap.
678 drawMatrix.preTranslate(-0.5f, -0.5f);
sakalfb0c5732016-11-03 09:15:34 -0700679
sakal8fdf9572017-05-31 02:43:10 -0700680 Iterator<FrameListenerAndParams> it = frameListeners.iterator();
681 while (it.hasNext()) {
682 FrameListenerAndParams listenerAndParams = it.next();
683 if (!wasRendered && listenerAndParams.applyFpsReduction) {
684 continue;
685 }
686 it.remove();
687
sakal6bdcefc2017-08-15 01:56:02 -0700688 final int scaledWidth = (int) (listenerAndParams.scale * frame.getRotatedWidth());
689 final int scaledHeight = (int) (listenerAndParams.scale * frame.getRotatedHeight());
sakalfb0c5732016-11-03 09:15:34 -0700690
691 if (scaledWidth == 0 || scaledHeight == 0) {
sakal3a9bc172016-11-30 08:30:05 -0800692 listenerAndParams.listener.onFrame(null);
sakalfb0c5732016-11-03 09:15:34 -0700693 continue;
694 }
695
sakalfb0c5732016-11-03 09:15:34 -0700696 bitmapTextureFramebuffer.setSize(scaledWidth, scaledHeight);
697
698 GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, bitmapTextureFramebuffer.getFrameBufferId());
699 GLES20.glFramebufferTexture2D(GLES20.GL_FRAMEBUFFER, GLES20.GL_COLOR_ATTACHMENT0,
700 GLES20.GL_TEXTURE_2D, bitmapTextureFramebuffer.getTextureId(), 0);
701
sakal103988d2017-02-17 09:59:01 -0800702 GLES20.glClearColor(0 /* red */, 0 /* green */, 0 /* blue */, 0 /* alpha */);
703 GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT);
magjed7cede372017-09-11 06:12:07 -0700704 frameDrawer.drawFrame(frame, listenerAndParams.drawer, drawMatrix, 0 /* viewportX */,
705 0 /* viewportY */, scaledWidth, scaledHeight);
sakalfb0c5732016-11-03 09:15:34 -0700706
707 final ByteBuffer bitmapBuffer = ByteBuffer.allocateDirect(scaledWidth * scaledHeight * 4);
708 GLES20.glViewport(0, 0, scaledWidth, scaledHeight);
709 GLES20.glReadPixels(
710 0, 0, scaledWidth, scaledHeight, GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, bitmapBuffer);
711
712 GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);
713 GlUtil.checkNoGLES2Error("EglRenderer.notifyCallbacks");
714
715 final Bitmap bitmap = Bitmap.createBitmap(scaledWidth, scaledHeight, Bitmap.Config.ARGB_8888);
716 bitmap.copyPixelsFromBuffer(bitmapBuffer);
sakal3a9bc172016-11-30 08:30:05 -0800717 listenerAndParams.listener.onFrame(bitmap);
sakalfb0c5732016-11-03 09:15:34 -0700718 }
magjeddf494b02016-10-07 05:32:35 -0700719 }
720
magjed9ab8a182016-10-20 03:18:09 -0700721 private String averageTimeAsString(long sumTimeNs, int count) {
Magnus Jedvert3bc696f2018-11-12 11:35:20 +0100722 return (count <= 0) ? "NA" : TimeUnit.NANOSECONDS.toMicros(sumTimeNs / count) + " us";
magjed9ab8a182016-10-20 03:18:09 -0700723 }
724
magjeddf494b02016-10-07 05:32:35 -0700725 private void logStatistics() {
Sami Kalliomäki1659e972018-06-04 14:07:58 +0200726 final DecimalFormat fpsFormat = new DecimalFormat("#.0");
magjed9ab8a182016-10-20 03:18:09 -0700727 final long currentTimeNs = System.nanoTime();
magjeddf494b02016-10-07 05:32:35 -0700728 synchronized (statisticsLock) {
magjed9ab8a182016-10-20 03:18:09 -0700729 final long elapsedTimeNs = currentTimeNs - statisticsStartTimeNs;
730 if (elapsedTimeNs <= 0) {
731 return;
magjeddf494b02016-10-07 05:32:35 -0700732 }
magjed9ab8a182016-10-20 03:18:09 -0700733 final float renderFps = framesRendered * TimeUnit.SECONDS.toNanos(1) / (float) elapsedTimeNs;
734 logD("Duration: " + TimeUnit.NANOSECONDS.toMillis(elapsedTimeNs) + " ms."
735 + " Frames received: " + framesReceived + "."
736 + " Dropped: " + framesDropped + "."
737 + " Rendered: " + framesRendered + "."
Sami Kalliomäki1659e972018-06-04 14:07:58 +0200738 + " Render fps: " + fpsFormat.format(renderFps) + "."
magjed9ab8a182016-10-20 03:18:09 -0700739 + " Average render time: " + averageTimeAsString(renderTimeNs, framesRendered) + "."
740 + " Average swapBuffer time: "
741 + averageTimeAsString(renderSwapBufferTimeNs, framesRendered) + ".");
742 resetStatistics(currentTimeNs);
magjeddf494b02016-10-07 05:32:35 -0700743 }
744 }
745
746 private void logD(String string) {
747 Logging.d(TAG, name + string);
748 }
Magnus Jedvert0cc11b42018-11-27 16:19:55 +0100749
750 private void logW(String string) {
751 Logging.w(TAG, name + string);
752 }
magjeddf494b02016-10-07 05:32:35 -0700753}