blob: c56798b05bea09bed1e4a2a06671873b3171759f [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;
magjed7cede372017-09-11 06:12:07 -0700126 private final VideoFrameDrawer frameDrawer = new VideoFrameDrawer();
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.
139 private boolean mirror;
140
141 // These variables are synchronized on |statisticsLock|.
142 private final Object statisticsLock = new Object();
143 // Total number of video frames received in renderFrame() call.
144 private int framesReceived;
145 // Number of video frames dropped by renderFrame() because previous frame has not been rendered
146 // yet.
147 private int framesDropped;
148 // Number of rendered video frames.
149 private int framesRendered;
magjed9ab8a182016-10-20 03:18:09 -0700150 // Start time for counting these statistics, or 0 if we haven't started measuring yet.
151 private long statisticsStartTimeNs;
magjeddf494b02016-10-07 05:32:35 -0700152 // Time in ns spent in renderFrameOnRenderThread() function.
153 private long renderTimeNs;
magjed9ab8a182016-10-20 03:18:09 -0700154 // Time in ns spent by the render thread in the swapBuffers() function.
155 private long renderSwapBufferTimeNs;
magjeddf494b02016-10-07 05:32:35 -0700156
sakalfb0c5732016-11-03 09:15:34 -0700157 // Used for bitmap capturing.
Magnus Jedvert2ed62b32018-04-11 14:25:14 +0200158 private final GlTextureFrameBuffer bitmapTextureFramebuffer =
159 new GlTextureFrameBuffer(GLES20.GL_RGBA);
sakalfb0c5732016-11-03 09:15:34 -0700160
magjed9ab8a182016-10-20 03:18:09 -0700161 private final Runnable logStatisticsRunnable = new Runnable() {
162 @Override
163 public void run() {
164 logStatistics();
165 synchronized (handlerLock) {
166 if (renderThreadHandler != null) {
167 renderThreadHandler.removeCallbacks(logStatisticsRunnable);
168 renderThreadHandler.postDelayed(
169 logStatisticsRunnable, TimeUnit.SECONDS.toMillis(LOG_INTERVAL_SEC));
170 }
171 }
172 }
173 };
174
magjeddf494b02016-10-07 05:32:35 -0700175 private final EglSurfaceCreation eglSurfaceCreationRunnable = new EglSurfaceCreation();
176
177 /**
178 * Standard constructor. The name will be used for the render thread name and included when
179 * logging. In order to render something, you must first call init() and createEglSurface.
180 */
181 public EglRenderer(String name) {
182 this.name = name;
183 }
184
185 /**
186 * Initialize this class, sharing resources with |sharedContext|. The custom |drawer| will be used
187 * for drawing frames on the EGLSurface. This class is responsible for calling release() on
188 * |drawer|. It is allowed to call init() to reinitialize the renderer after a previous
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100189 * init()/release() cycle. If usePresentationTimeStamp is true, eglPresentationTimeANDROID will be
190 * set with the frame timestamps, which specifies desired presentation time and might be useful
191 * for e.g. syncing audio and video.
magjeddf494b02016-10-07 05:32:35 -0700192 */
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100193 public void init(@Nullable final EglBase.Context sharedContext, final int[] configAttributes,
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100194 RendererCommon.GlDrawer drawer, boolean usePresentationTimeStamp) {
magjeddf494b02016-10-07 05:32:35 -0700195 synchronized (handlerLock) {
196 if (renderThreadHandler != null) {
197 throw new IllegalStateException(name + "Already initialized");
198 }
199 logD("Initializing EglRenderer");
200 this.drawer = drawer;
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100201 this.usePresentationTimeStamp = usePresentationTimeStamp;
magjeddf494b02016-10-07 05:32:35 -0700202
203 final HandlerThread renderThread = new HandlerThread(name + "EglRenderer");
204 renderThread.start();
Sami Kalliomäki0d26c992018-10-19 12:53:21 +0200205 renderThreadHandler =
206 new HandlerWithExceptionCallback(renderThread.getLooper(), new Runnable() {
207 @Override
208 public void run() {
209 synchronized (handlerLock) {
210 renderThreadHandler = null;
211 }
212 }
213 });
magjeddf494b02016-10-07 05:32:35 -0700214 // Create EGL context on the newly created render thread. It should be possibly to create the
215 // context on this thread and make it current on the render thread, but this causes failure on
216 // some Marvel based JB devices. https://bugs.chromium.org/p/webrtc/issues/detail?id=6350.
sakalbf080602017-08-11 01:42:43 -0700217 ThreadUtils.invokeAtFrontUninterruptibly(renderThreadHandler, () -> {
218 // If sharedContext is null, then texture frames are disabled. This is typically for old
219 // devices that might not be fully spec compliant, so force EGL 1.0 since EGL 1.4 has
220 // caused trouble on some weird devices.
221 if (sharedContext == null) {
222 logD("EglBase10.create context");
223 eglBase = EglBase.createEgl10(configAttributes);
224 } else {
225 logD("EglBase.create shared context");
226 eglBase = EglBase.create(sharedContext, configAttributes);
magjeddf494b02016-10-07 05:32:35 -0700227 }
228 });
magjed9ab8a182016-10-20 03:18:09 -0700229 renderThreadHandler.post(eglSurfaceCreationRunnable);
230 final long currentTimeNs = System.nanoTime();
231 resetStatistics(currentTimeNs);
232 renderThreadHandler.postDelayed(
233 logStatisticsRunnable, TimeUnit.SECONDS.toMillis(LOG_INTERVAL_SEC));
magjeddf494b02016-10-07 05:32:35 -0700234 }
235 }
236
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100237 /**
238 * Same as above with usePresentationTimeStamp set to false.
239 *
240 * @see #init(EglBase.Context, int[], RendererCommon.GlDrawer, boolean)
241 */
242 public void init(@Nullable final EglBase.Context sharedContext, final int[] configAttributes,
243 RendererCommon.GlDrawer drawer) {
244 init(sharedContext, configAttributes, drawer, /* usePresentationTimeStamp= */ false);
245 }
246
magjeddf494b02016-10-07 05:32:35 -0700247 public void createEglSurface(Surface surface) {
magjed9ab8a182016-10-20 03:18:09 -0700248 createEglSurfaceInternal(surface);
249 }
250
251 public void createEglSurface(SurfaceTexture surfaceTexture) {
252 createEglSurfaceInternal(surfaceTexture);
253 }
254
255 private void createEglSurfaceInternal(Object surface) {
magjeddf494b02016-10-07 05:32:35 -0700256 eglSurfaceCreationRunnable.setSurface(surface);
magjed9ab8a182016-10-20 03:18:09 -0700257 postToRenderThread(eglSurfaceCreationRunnable);
magjeddf494b02016-10-07 05:32:35 -0700258 }
259
260 /**
261 * Block until any pending frame is returned and all GL resources released, even if an interrupt
262 * occurs. If an interrupt occurs during release(), the interrupt flag will be set. This function
263 * should be called before the Activity is destroyed and the EGLContext is still valid. If you
264 * don't call this function, the GL resources might leak.
265 */
266 public void release() {
magjed9ab8a182016-10-20 03:18:09 -0700267 logD("Releasing.");
magjeddf494b02016-10-07 05:32:35 -0700268 final CountDownLatch eglCleanupBarrier = new CountDownLatch(1);
269 synchronized (handlerLock) {
270 if (renderThreadHandler == null) {
271 logD("Already released");
272 return;
273 }
magjed9ab8a182016-10-20 03:18:09 -0700274 renderThreadHandler.removeCallbacks(logStatisticsRunnable);
magjeddf494b02016-10-07 05:32:35 -0700275 // Release EGL and GL resources on render thread.
sakalbf080602017-08-11 01:42:43 -0700276 renderThreadHandler.postAtFrontOfQueue(() -> {
277 if (drawer != null) {
278 drawer.release();
279 drawer = null;
magjeddf494b02016-10-07 05:32:35 -0700280 }
magjed7cede372017-09-11 06:12:07 -0700281 frameDrawer.release();
Magnus Jedvert2ed62b32018-04-11 14:25:14 +0200282 bitmapTextureFramebuffer.release();
sakalbf080602017-08-11 01:42:43 -0700283 if (eglBase != null) {
284 logD("eglBase detach and release.");
285 eglBase.detachCurrent();
286 eglBase.release();
287 eglBase = null;
288 }
Sami Kalliomäki8ebac242017-11-08 17:13:13 +0100289 frameListeners.clear();
sakalbf080602017-08-11 01:42:43 -0700290 eglCleanupBarrier.countDown();
magjeddf494b02016-10-07 05:32:35 -0700291 });
292 final Looper renderLooper = renderThreadHandler.getLooper();
293 // TODO(magjed): Replace this post() with renderLooper.quitSafely() when API support >= 18.
sakalbf080602017-08-11 01:42:43 -0700294 renderThreadHandler.post(() -> {
295 logD("Quitting render thread.");
296 renderLooper.quit();
magjeddf494b02016-10-07 05:32:35 -0700297 });
298 // Don't accept any more frames or messages to the render thread.
299 renderThreadHandler = null;
300 }
301 // Make sure the EGL/GL cleanup posted above is executed.
302 ThreadUtils.awaitUninterruptibly(eglCleanupBarrier);
303 synchronized (frameLock) {
304 if (pendingFrame != null) {
sakal6bdcefc2017-08-15 01:56:02 -0700305 pendingFrame.release();
magjeddf494b02016-10-07 05:32:35 -0700306 pendingFrame = null;
307 }
308 }
magjeddf494b02016-10-07 05:32:35 -0700309 logD("Releasing done.");
310 }
311
312 /**
magjed9ab8a182016-10-20 03:18:09 -0700313 * Reset the statistics logged in logStatistics().
magjeddf494b02016-10-07 05:32:35 -0700314 */
magjed9ab8a182016-10-20 03:18:09 -0700315 private void resetStatistics(long currentTimeNs) {
magjeddf494b02016-10-07 05:32:35 -0700316 synchronized (statisticsLock) {
magjed9ab8a182016-10-20 03:18:09 -0700317 statisticsStartTimeNs = currentTimeNs;
magjeddf494b02016-10-07 05:32:35 -0700318 framesReceived = 0;
319 framesDropped = 0;
320 framesRendered = 0;
magjeddf494b02016-10-07 05:32:35 -0700321 renderTimeNs = 0;
magjed9ab8a182016-10-20 03:18:09 -0700322 renderSwapBufferTimeNs = 0;
323 }
324 }
325
326 public void printStackTrace() {
327 synchronized (handlerLock) {
328 final Thread renderThread =
329 (renderThreadHandler == null) ? null : renderThreadHandler.getLooper().getThread();
330 if (renderThread != null) {
331 final StackTraceElement[] renderStackTrace = renderThread.getStackTrace();
332 if (renderStackTrace.length > 0) {
Magnus Jedvert0cc11b42018-11-27 16:19:55 +0100333 logW("EglRenderer stack trace:");
magjed9ab8a182016-10-20 03:18:09 -0700334 for (StackTraceElement traceElem : renderStackTrace) {
Magnus Jedvert0cc11b42018-11-27 16:19:55 +0100335 logW(traceElem.toString());
magjed9ab8a182016-10-20 03:18:09 -0700336 }
337 }
338 }
magjeddf494b02016-10-07 05:32:35 -0700339 }
340 }
341
342 /**
343 * Set if the video stream should be mirrored or not.
344 */
345 public void setMirror(final boolean mirror) {
346 logD("setMirror: " + mirror);
347 synchronized (layoutLock) {
348 this.mirror = mirror;
349 }
350 }
351
352 /**
353 * Set layout aspect ratio. This is used to crop frames when rendering to avoid stretched video.
354 * Set this to 0 to disable cropping.
355 */
356 public void setLayoutAspectRatio(float layoutAspectRatio) {
357 logD("setLayoutAspectRatio: " + layoutAspectRatio);
358 synchronized (layoutLock) {
359 this.layoutAspectRatio = layoutAspectRatio;
360 }
361 }
362
magjed9ab8a182016-10-20 03:18:09 -0700363 /**
364 * Limit render framerate.
365 *
366 * @param fps Limit render framerate to this value, or use Float.POSITIVE_INFINITY to disable fps
367 * reduction.
368 */
369 public void setFpsReduction(float fps) {
370 logD("setFpsReduction: " + fps);
371 synchronized (fpsReductionLock) {
372 final long previousRenderPeriodNs = minRenderPeriodNs;
373 if (fps <= 0) {
374 minRenderPeriodNs = Long.MAX_VALUE;
375 } else {
376 minRenderPeriodNs = (long) (TimeUnit.SECONDS.toNanos(1) / fps);
377 }
378 if (minRenderPeriodNs != previousRenderPeriodNs) {
379 // Fps reduction changed - reset frame time.
380 nextFrameTimeNs = System.nanoTime();
381 }
382 }
383 }
384
385 public void disableFpsReduction() {
386 setFpsReduction(Float.POSITIVE_INFINITY /* fps */);
387 }
388
389 public void pauseVideo() {
390 setFpsReduction(0 /* fps */);
391 }
392
sakalfb0c5732016-11-03 09:15:34 -0700393 /**
sakal3a9bc172016-11-30 08:30:05 -0800394 * Register a callback to be invoked when a new video frame has been received. This version uses
395 * the drawer of the EglRenderer that was passed in init.
sakalfb0c5732016-11-03 09:15:34 -0700396 *
sakald1516522017-03-13 05:11:48 -0700397 * @param listener The callback to be invoked. The callback will be invoked on the render thread.
398 * It should be lightweight and must not call removeFrameListener.
sakalfb0c5732016-11-03 09:15:34 -0700399 * @param scale The scale of the Bitmap passed to the callback, or 0 if no Bitmap is
400 * required.
401 */
sakalbb584352016-11-28 08:53:44 -0800402 public void addFrameListener(final FrameListener listener, final float scale) {
sakal8fdf9572017-05-31 02:43:10 -0700403 addFrameListener(listener, scale, null, false /* applyFpsReduction */);
sakal3a9bc172016-11-30 08:30:05 -0800404 }
405
406 /**
407 * Register a callback to be invoked when a new video frame has been received.
408 *
sakald1516522017-03-13 05:11:48 -0700409 * @param listener The callback to be invoked. The callback will be invoked on the render thread.
410 * It should be lightweight and must not call removeFrameListener.
sakal3a9bc172016-11-30 08:30:05 -0800411 * @param scale The scale of the Bitmap passed to the callback, or 0 if no Bitmap is
412 * required.
sakald1516522017-03-13 05:11:48 -0700413 * @param drawer Custom drawer to use for this frame listener or null to use the default one.
sakal3a9bc172016-11-30 08:30:05 -0800414 */
415 public void addFrameListener(
sakald1516522017-03-13 05:11:48 -0700416 final FrameListener listener, final float scale, final RendererCommon.GlDrawer drawerParam) {
sakal8fdf9572017-05-31 02:43:10 -0700417 addFrameListener(listener, scale, drawerParam, false /* applyFpsReduction */);
418 }
419
420 /**
421 * Register a callback to be invoked when a new video frame has been received.
422 *
423 * @param listener The callback to be invoked. The callback will be invoked on the render thread.
424 * It should be lightweight and must not call removeFrameListener.
425 * @param scale The scale of the Bitmap passed to the callback, or 0 if no Bitmap is
426 * required.
427 * @param drawer Custom drawer to use for this frame listener or null to use the default one.
428 * @param applyFpsReduction This callback will not be called for frames that have been dropped by
429 * FPS reduction.
430 */
431 public void addFrameListener(final FrameListener listener, final float scale,
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100432 @Nullable final RendererCommon.GlDrawer drawerParam, final boolean applyFpsReduction) {
sakalbf080602017-08-11 01:42:43 -0700433 postToRenderThread(() -> {
434 final RendererCommon.GlDrawer listenerDrawer = drawerParam == null ? drawer : drawerParam;
435 frameListeners.add(
436 new FrameListenerAndParams(listener, scale, listenerDrawer, applyFpsReduction));
sakalbb584352016-11-28 08:53:44 -0800437 });
sakalfb0c5732016-11-03 09:15:34 -0700438 }
439
440 /**
441 * Remove any pending callback that was added with addFrameListener. If the callback is not in
sakalbb584352016-11-28 08:53:44 -0800442 * the queue, nothing happens. It is ensured that callback won't be called after this method
443 * returns.
sakalfb0c5732016-11-03 09:15:34 -0700444 *
445 * @param runnable The callback to remove.
446 */
sakalbb584352016-11-28 08:53:44 -0800447 public void removeFrameListener(final FrameListener listener) {
448 final CountDownLatch latch = new CountDownLatch(1);
Sami Kalliomäki8ebac242017-11-08 17:13:13 +0100449 synchronized (handlerLock) {
450 if (renderThreadHandler == null) {
451 return;
sakalfb0c5732016-11-03 09:15:34 -0700452 }
Sami Kalliomäki8ebac242017-11-08 17:13:13 +0100453 if (Thread.currentThread() == renderThreadHandler.getLooper().getThread()) {
454 throw new RuntimeException("removeFrameListener must not be called on the render thread.");
455 }
456 postToRenderThread(() -> {
457 latch.countDown();
458 final Iterator<FrameListenerAndParams> iter = frameListeners.iterator();
459 while (iter.hasNext()) {
460 if (iter.next().listener == listener) {
461 iter.remove();
462 }
463 }
464 });
465 }
sakalbb584352016-11-28 08:53:44 -0800466 ThreadUtils.awaitUninterruptibly(latch);
sakalfb0c5732016-11-03 09:15:34 -0700467 }
468
sakal6bdcefc2017-08-15 01:56:02 -0700469 // VideoSink interface.
470 @Override
471 public void onFrame(VideoFrame frame) {
magjeddf494b02016-10-07 05:32:35 -0700472 synchronized (statisticsLock) {
473 ++framesReceived;
474 }
magjed9ab8a182016-10-20 03:18:09 -0700475 final boolean dropOldFrame;
magjeddf494b02016-10-07 05:32:35 -0700476 synchronized (handlerLock) {
477 if (renderThreadHandler == null) {
478 logD("Dropping frame - Not initialized or already released.");
magjeddf494b02016-10-07 05:32:35 -0700479 return;
480 }
magjed9ab8a182016-10-20 03:18:09 -0700481 synchronized (frameLock) {
482 dropOldFrame = (pendingFrame != null);
483 if (dropOldFrame) {
sakal6bdcefc2017-08-15 01:56:02 -0700484 pendingFrame.release();
magjeddf494b02016-10-07 05:32:35 -0700485 }
486 pendingFrame = frame;
sakal6bdcefc2017-08-15 01:56:02 -0700487 pendingFrame.retain();
sakalbf080602017-08-11 01:42:43 -0700488 renderThreadHandler.post(this ::renderFrameOnRenderThread);
magjeddf494b02016-10-07 05:32:35 -0700489 }
490 }
magjed9ab8a182016-10-20 03:18:09 -0700491 if (dropOldFrame) {
492 synchronized (statisticsLock) {
493 ++framesDropped;
494 }
495 }
magjeddf494b02016-10-07 05:32:35 -0700496 }
497
498 /**
499 * Release EGL surface. This function will block until the EGL surface is released.
500 */
sakal28ec6bd2016-11-09 01:47:12 -0800501 public void releaseEglSurface(final Runnable completionCallback) {
magjeddf494b02016-10-07 05:32:35 -0700502 // Ensure that the render thread is no longer touching the Surface before returning from this
503 // function.
504 eglSurfaceCreationRunnable.setSurface(null /* surface */);
505 synchronized (handlerLock) {
506 if (renderThreadHandler != null) {
507 renderThreadHandler.removeCallbacks(eglSurfaceCreationRunnable);
sakalbf080602017-08-11 01:42:43 -0700508 renderThreadHandler.postAtFrontOfQueue(() -> {
509 if (eglBase != null) {
510 eglBase.detachCurrent();
511 eglBase.releaseSurface();
magjeddf494b02016-10-07 05:32:35 -0700512 }
sakalbf080602017-08-11 01:42:43 -0700513 completionCallback.run();
magjeddf494b02016-10-07 05:32:35 -0700514 });
sakal28ec6bd2016-11-09 01:47:12 -0800515 return;
magjeddf494b02016-10-07 05:32:35 -0700516 }
517 }
sakal28ec6bd2016-11-09 01:47:12 -0800518 completionCallback.run();
magjeddf494b02016-10-07 05:32:35 -0700519 }
520
521 /**
magjeddf494b02016-10-07 05:32:35 -0700522 * Private helper function to post tasks safely.
523 */
magjed9ab8a182016-10-20 03:18:09 -0700524 private void postToRenderThread(Runnable runnable) {
magjeddf494b02016-10-07 05:32:35 -0700525 synchronized (handlerLock) {
526 if (renderThreadHandler != null) {
527 renderThreadHandler.post(runnable);
528 }
529 }
530 }
531
sakalf25a2202017-05-04 06:06:56 -0700532 private void clearSurfaceOnRenderThread(float r, float g, float b, float a) {
magjeddf494b02016-10-07 05:32:35 -0700533 if (eglBase != null && eglBase.hasSurface()) {
534 logD("clearSurface");
sakalf25a2202017-05-04 06:06:56 -0700535 GLES20.glClearColor(r, g, b, a);
magjeddf494b02016-10-07 05:32:35 -0700536 GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT);
537 eglBase.swapBuffers();
538 }
539 }
540
541 /**
sakalf25a2202017-05-04 06:06:56 -0700542 * Post a task to clear the surface to a transparent uniform color.
magjed9ab8a182016-10-20 03:18:09 -0700543 */
544 public void clearImage() {
sakalf25a2202017-05-04 06:06:56 -0700545 clearImage(0 /* red */, 0 /* green */, 0 /* blue */, 0 /* alpha */);
546 }
547
548 /**
549 * Post a task to clear the surface to a specific color.
550 */
551 public void clearImage(final float r, final float g, final float b, final float a) {
magjed9ab8a182016-10-20 03:18:09 -0700552 synchronized (handlerLock) {
553 if (renderThreadHandler == null) {
554 return;
555 }
sakalbf080602017-08-11 01:42:43 -0700556 renderThreadHandler.postAtFrontOfQueue(() -> clearSurfaceOnRenderThread(r, g, b, a));
magjed9ab8a182016-10-20 03:18:09 -0700557 }
558 }
559
560 /**
magjeddf494b02016-10-07 05:32:35 -0700561 * Renders and releases |pendingFrame|.
562 */
563 private void renderFrameOnRenderThread() {
564 // Fetch and render |pendingFrame|.
sakal6bdcefc2017-08-15 01:56:02 -0700565 final VideoFrame frame;
magjeddf494b02016-10-07 05:32:35 -0700566 synchronized (frameLock) {
567 if (pendingFrame == null) {
568 return;
569 }
570 frame = pendingFrame;
571 pendingFrame = null;
572 }
573 if (eglBase == null || !eglBase.hasSurface()) {
574 logD("Dropping frame - No surface");
sakal6bdcefc2017-08-15 01:56:02 -0700575 frame.release();
magjeddf494b02016-10-07 05:32:35 -0700576 return;
577 }
sakald1516522017-03-13 05:11:48 -0700578 // Check if fps reduction is active.
579 final boolean shouldRenderFrame;
580 synchronized (fpsReductionLock) {
581 if (minRenderPeriodNs == Long.MAX_VALUE) {
582 // Rendering is paused.
583 shouldRenderFrame = false;
584 } else if (minRenderPeriodNs <= 0) {
585 // FPS reduction is disabled.
586 shouldRenderFrame = true;
587 } else {
588 final long currentTimeNs = System.nanoTime();
589 if (currentTimeNs < nextFrameTimeNs) {
590 logD("Skipping frame rendering - fps reduction is active.");
591 shouldRenderFrame = false;
592 } else {
593 nextFrameTimeNs += minRenderPeriodNs;
594 // The time for the next frame should always be in the future.
595 nextFrameTimeNs = Math.max(nextFrameTimeNs, currentTimeNs);
596 shouldRenderFrame = true;
597 }
598 }
599 }
magjeddf494b02016-10-07 05:32:35 -0700600
601 final long startTimeNs = System.nanoTime();
magjeddf494b02016-10-07 05:32:35 -0700602
sakal6bdcefc2017-08-15 01:56:02 -0700603 final float frameAspectRatio = frame.getRotatedWidth() / (float) frame.getRotatedHeight();
604 final float drawnAspectRatio;
magjeddf494b02016-10-07 05:32:35 -0700605 synchronized (layoutLock) {
sakal6bdcefc2017-08-15 01:56:02 -0700606 drawnAspectRatio = layoutAspectRatio != 0f ? layoutAspectRatio : frameAspectRatio;
magjeddf494b02016-10-07 05:32:35 -0700607 }
608
sakal6bdcefc2017-08-15 01:56:02 -0700609 final float scaleX;
610 final float scaleY;
611
612 if (frameAspectRatio > drawnAspectRatio) {
613 scaleX = drawnAspectRatio / frameAspectRatio;
614 scaleY = 1f;
615 } else {
616 scaleX = 1f;
617 scaleY = frameAspectRatio / drawnAspectRatio;
618 }
619
magjed7cede372017-09-11 06:12:07 -0700620 drawMatrix.reset();
sakal6bdcefc2017-08-15 01:56:02 -0700621 drawMatrix.preTranslate(0.5f, 0.5f);
sakal6bdcefc2017-08-15 01:56:02 -0700622 if (mirror)
623 drawMatrix.preScale(-1f, 1f);
624 drawMatrix.preScale(scaleX, scaleY);
625 drawMatrix.preTranslate(-0.5f, -0.5f);
626
sakald1516522017-03-13 05:11:48 -0700627 if (shouldRenderFrame) {
628 GLES20.glClearColor(0 /* red */, 0 /* green */, 0 /* blue */, 0 /* alpha */);
629 GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT);
magjed7cede372017-09-11 06:12:07 -0700630 frameDrawer.drawFrame(frame, drawer, drawMatrix, 0 /* viewportX */, 0 /* viewportY */,
631 eglBase.surfaceWidth(), eglBase.surfaceHeight());
sakald1516522017-03-13 05:11:48 -0700632
633 final long swapBuffersStartTimeNs = System.nanoTime();
Magnus Jedvert361dbc12018-11-06 11:32:46 +0100634 if (usePresentationTimeStamp) {
635 eglBase.swapBuffers(frame.getTimestampNs());
636 } else {
637 eglBase.swapBuffers();
638 }
sakald1516522017-03-13 05:11:48 -0700639
640 final long currentTimeNs = System.nanoTime();
641 synchronized (statisticsLock) {
642 ++framesRendered;
643 renderTimeNs += (currentTimeNs - startTimeNs);
644 renderSwapBufferTimeNs += (currentTimeNs - swapBuffersStartTimeNs);
645 }
magjeddf494b02016-10-07 05:32:35 -0700646 }
647
magjed7cede372017-09-11 06:12:07 -0700648 notifyCallbacks(frame, shouldRenderFrame);
649 frame.release();
sakalfb0c5732016-11-03 09:15:34 -0700650 }
651
magjed7cede372017-09-11 06:12:07 -0700652 private void notifyCallbacks(VideoFrame frame, boolean wasRendered) {
sakalbb584352016-11-28 08:53:44 -0800653 if (frameListeners.isEmpty())
654 return;
sakalfb0c5732016-11-03 09:15:34 -0700655
magjed7cede372017-09-11 06:12:07 -0700656 drawMatrix.reset();
sakal6bdcefc2017-08-15 01:56:02 -0700657 drawMatrix.preTranslate(0.5f, 0.5f);
sakal6bdcefc2017-08-15 01:56:02 -0700658 if (mirror)
659 drawMatrix.preScale(-1f, 1f);
660 drawMatrix.preScale(1f, -1f); // We want the output to be upside down for Bitmap.
661 drawMatrix.preTranslate(-0.5f, -0.5f);
sakalfb0c5732016-11-03 09:15:34 -0700662
sakal8fdf9572017-05-31 02:43:10 -0700663 Iterator<FrameListenerAndParams> it = frameListeners.iterator();
664 while (it.hasNext()) {
665 FrameListenerAndParams listenerAndParams = it.next();
666 if (!wasRendered && listenerAndParams.applyFpsReduction) {
667 continue;
668 }
669 it.remove();
670
sakal6bdcefc2017-08-15 01:56:02 -0700671 final int scaledWidth = (int) (listenerAndParams.scale * frame.getRotatedWidth());
672 final int scaledHeight = (int) (listenerAndParams.scale * frame.getRotatedHeight());
sakalfb0c5732016-11-03 09:15:34 -0700673
674 if (scaledWidth == 0 || scaledHeight == 0) {
sakal3a9bc172016-11-30 08:30:05 -0800675 listenerAndParams.listener.onFrame(null);
sakalfb0c5732016-11-03 09:15:34 -0700676 continue;
677 }
678
sakalfb0c5732016-11-03 09:15:34 -0700679 bitmapTextureFramebuffer.setSize(scaledWidth, scaledHeight);
680
681 GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, bitmapTextureFramebuffer.getFrameBufferId());
682 GLES20.glFramebufferTexture2D(GLES20.GL_FRAMEBUFFER, GLES20.GL_COLOR_ATTACHMENT0,
683 GLES20.GL_TEXTURE_2D, bitmapTextureFramebuffer.getTextureId(), 0);
684
sakal103988d2017-02-17 09:59:01 -0800685 GLES20.glClearColor(0 /* red */, 0 /* green */, 0 /* blue */, 0 /* alpha */);
686 GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT);
magjed7cede372017-09-11 06:12:07 -0700687 frameDrawer.drawFrame(frame, listenerAndParams.drawer, drawMatrix, 0 /* viewportX */,
688 0 /* viewportY */, scaledWidth, scaledHeight);
sakalfb0c5732016-11-03 09:15:34 -0700689
690 final ByteBuffer bitmapBuffer = ByteBuffer.allocateDirect(scaledWidth * scaledHeight * 4);
691 GLES20.glViewport(0, 0, scaledWidth, scaledHeight);
692 GLES20.glReadPixels(
693 0, 0, scaledWidth, scaledHeight, GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, bitmapBuffer);
694
695 GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);
696 GlUtil.checkNoGLES2Error("EglRenderer.notifyCallbacks");
697
698 final Bitmap bitmap = Bitmap.createBitmap(scaledWidth, scaledHeight, Bitmap.Config.ARGB_8888);
699 bitmap.copyPixelsFromBuffer(bitmapBuffer);
sakal3a9bc172016-11-30 08:30:05 -0800700 listenerAndParams.listener.onFrame(bitmap);
sakalfb0c5732016-11-03 09:15:34 -0700701 }
magjeddf494b02016-10-07 05:32:35 -0700702 }
703
magjed9ab8a182016-10-20 03:18:09 -0700704 private String averageTimeAsString(long sumTimeNs, int count) {
Magnus Jedvert3bc696f2018-11-12 11:35:20 +0100705 return (count <= 0) ? "NA" : TimeUnit.NANOSECONDS.toMicros(sumTimeNs / count) + " us";
magjed9ab8a182016-10-20 03:18:09 -0700706 }
707
magjeddf494b02016-10-07 05:32:35 -0700708 private void logStatistics() {
Sami Kalliomäki1659e972018-06-04 14:07:58 +0200709 final DecimalFormat fpsFormat = new DecimalFormat("#.0");
magjed9ab8a182016-10-20 03:18:09 -0700710 final long currentTimeNs = System.nanoTime();
magjeddf494b02016-10-07 05:32:35 -0700711 synchronized (statisticsLock) {
magjed9ab8a182016-10-20 03:18:09 -0700712 final long elapsedTimeNs = currentTimeNs - statisticsStartTimeNs;
713 if (elapsedTimeNs <= 0) {
714 return;
magjeddf494b02016-10-07 05:32:35 -0700715 }
magjed9ab8a182016-10-20 03:18:09 -0700716 final float renderFps = framesRendered * TimeUnit.SECONDS.toNanos(1) / (float) elapsedTimeNs;
717 logD("Duration: " + TimeUnit.NANOSECONDS.toMillis(elapsedTimeNs) + " ms."
718 + " Frames received: " + framesReceived + "."
719 + " Dropped: " + framesDropped + "."
720 + " Rendered: " + framesRendered + "."
Sami Kalliomäki1659e972018-06-04 14:07:58 +0200721 + " Render fps: " + fpsFormat.format(renderFps) + "."
magjed9ab8a182016-10-20 03:18:09 -0700722 + " Average render time: " + averageTimeAsString(renderTimeNs, framesRendered) + "."
723 + " Average swapBuffer time: "
724 + averageTimeAsString(renderSwapBufferTimeNs, framesRendered) + ".");
725 resetStatistics(currentTimeNs);
magjeddf494b02016-10-07 05:32:35 -0700726 }
727 }
728
729 private void logD(String string) {
730 Logging.d(TAG, name + string);
731 }
Magnus Jedvert0cc11b42018-11-27 16:19:55 +0100732
733 private void logW(String string) {
734 Logging.w(TAG, name + string);
735 }
magjeddf494b02016-10-07 05:32:35 -0700736}