talk/app/webrtc/java/android/org/webrtc/SurfaceTextureHelper.java - platform/external/webrtc - Git at Google

 /*
  * libjingle
  * Copyright 2015 Google Inc.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *  1. Redistributions of source code must retain the above copyright notice,
  *     this list of conditions and the following disclaimer.
  *  2. Redistributions in binary form must reproduce the above copyright notice,
  *     this list of conditions and the following disclaimer in the documentation
  *     and/or other materials provided with the distribution.
  *  3. The name of the author may not be used to endorse or promote products
  *     derived from this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 package org.webrtc;

 import android.graphics.SurfaceTexture;
 import android.opengl.GLES11Ext;
 import android.opengl.GLES20;
 import android.os.Build;
 import android.os.Handler;
 import android.os.HandlerThread;
 import android.os.SystemClock;

 import java.util.concurrent.Callable;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;

 import javax.microedition.khronos.egl.EGLContext;

 /**
  * Helper class to create and synchronize access to a SurfaceTexture. The caller will get notified
  * of new frames in onTextureFrameAvailable(), and should call returnTextureFrame() when done with
  * the frame. Only one texture frame can be in flight at once, so returnTextureFrame() must be
  * called in order to receive a new frame. Call disconnect() to stop receiveing new frames and
  * release all resources.
  * Note that there is a C++ counter part of this class that optionally can be used. It is used for
  * wrapping texture frames into webrtc::VideoFrames and also handles calling returnTextureFrame()
  * when the webrtc::VideoFrame is no longer used.
  */
 final class SurfaceTextureHelper {
   private static final String TAG = "SurfaceTextureHelper";
   /**
    * Callback interface for being notified that a new texture frame is available. The calls will be
    * made on a dedicated thread with a bound EGLContext. The thread will be the same throughout the
    * lifetime of the SurfaceTextureHelper instance, but different from the thread calling the
    * SurfaceTextureHelper constructor. The callee is not allowed to make another EGLContext current
    * on the calling thread.
    */
   public interface OnTextureFrameAvailableListener {
     abstract void onTextureFrameAvailable(
         int oesTextureId, float[] transformMatrix, long timestampNs);
   }

   public static SurfaceTextureHelper create(EGLContext sharedContext) {
     return create(sharedContext, null);
   }

   /**
    * Construct a new SurfaceTextureHelper sharing OpenGL resources with |sharedContext|. If
    * |handler| is non-null, the callback will be executed on that handler's thread. If |handler| is
    * null, a dedicated private thread is created for the callbacks.
    */
   public static SurfaceTextureHelper create(final EGLContext sharedContext, final Handler handler) {
     final Handler finalHandler;
     if (handler != null) {
       finalHandler = handler;
     } else {
       final HandlerThread thread = new HandlerThread(TAG);
       thread.start();
       finalHandler = new Handler(thread.getLooper());
     }
     // The onFrameAvailable() callback will be executed on the SurfaceTexture ctor thread. See:
     // http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/5.1.1_r1/android/graphics/SurfaceTexture.java#195.
     // Therefore, in order to control the callback thread on API lvl < 21, the SurfaceTextureHelper
     // is constructed on the |handler| thread.
     return ThreadUtils.invokeUninterruptibly(finalHandler, new Callable<SurfaceTextureHelper>() {
       @Override public SurfaceTextureHelper call() {
         return new SurfaceTextureHelper(sharedContext, finalHandler, (handler == null));
       }
     });
   }

   private final Handler handler;
   private final boolean isOwningThread;
   private final EglBase eglBase;
   private final SurfaceTexture surfaceTexture;
   private final int oesTextureId;
   private OnTextureFrameAvailableListener listener;
   // The possible states of this class.
   private boolean hasPendingTexture = false;
   private boolean isTextureInUse = false;
   private boolean isQuitting = false;

   private SurfaceTextureHelper(EGLContext sharedContext, Handler handler, boolean isOwningThread) {
     if (handler.getLooper().getThread() != Thread.currentThread()) {
       throw new IllegalStateException("SurfaceTextureHelper must be created on the handler thread");
     }
     this.handler = handler;
     this.isOwningThread = isOwningThread;

     eglBase = new EglBase(sharedContext, EglBase.ConfigType.PIXEL_BUFFER);
     eglBase.createDummyPbufferSurface();
     eglBase.makeCurrent();

     oesTextureId = GlUtil.generateTexture(GLES11Ext.GL_TEXTURE_EXTERNAL_OES);
     surfaceTexture = new SurfaceTexture(oesTextureId);
   }

   /**
    *  Start to stream textures to the given |listener|.
    *  A Listener can only be set once.
    */
   public void setListener(OnTextureFrameAvailableListener listener) {
     if (this.listener != null) {
       throw new IllegalStateException("SurfaceTextureHelper listener has already been set.");
     }
     this.listener = listener;
     surfaceTexture.setOnFrameAvailableListener(new SurfaceTexture.OnFrameAvailableListener() {
       @Override
       public void onFrameAvailable(SurfaceTexture surfaceTexture) {
         hasPendingTexture = true;
         tryDeliverTextureFrame();
       }
     });
   }

   /**
    * Retrieve the underlying SurfaceTexture. The SurfaceTexture should be passed in to a video
    * producer such as a camera or decoder.
    */
   public SurfaceTexture getSurfaceTexture() {
     return surfaceTexture;
   }

   /**
    * Call this function to signal that you are done with the frame received in
    * onTextureFrameAvailable(). Only one texture frame can be in flight at once, so you must call
    * this function in order to receive a new frame.
    */
   public void returnTextureFrame() {
     handler.post(new Runnable() {
       @Override public void run() {
         isTextureInUse = false;
         if (isQuitting) {
           release();
         } else {
           tryDeliverTextureFrame();
         }
       }
     });
   }

   /**
    * Call disconnect() to stop receiving frames. Resources are released when the texture frame has
    * been returned by a call to returnTextureFrame(). You are guaranteed to not receive any more
    * onTextureFrameAvailable() after this function returns.
    */
   public void disconnect() {
     if (handler.getLooper().getThread() == Thread.currentThread()) {
       isQuitting = true;
       if (!isTextureInUse) {
         release();
       }
       return;
     }
     final CountDownLatch barrier = new CountDownLatch(1);
     handler.postAtFrontOfQueue(new Runnable() {
       @Override public void run() {
         isQuitting = true;
         barrier.countDown();
         if (!isTextureInUse) {
           release();
         }
       }
     });
     ThreadUtils.awaitUninterruptibly(barrier);
   }

   private void tryDeliverTextureFrame() {
     if (handler.getLooper().getThread() != Thread.currentThread()) {
       throw new IllegalStateException("Wrong thread.");
     }
     if (isQuitting || !hasPendingTexture || isTextureInUse) {
       return;
     }
     isTextureInUse = true;
     hasPendingTexture = false;

     eglBase.makeCurrent();
     surfaceTexture.updateTexImage();

     final float[] transformMatrix = new float[16];
     surfaceTexture.getTransformMatrix(transformMatrix);
     final long timestampNs = (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH)
         ? surfaceTexture.getTimestamp()
         : TimeUnit.MILLISECONDS.toNanos(SystemClock.elapsedRealtime());
     listener.onTextureFrameAvailable(oesTextureId, transformMatrix, timestampNs);
   }

   private void release() {
     if (handler.getLooper().getThread() != Thread.currentThread()) {
       throw new IllegalStateException("Wrong thread.");
     }
     if (isTextureInUse || !isQuitting) {
       throw new IllegalStateException("Unexpected release.");
     }
     eglBase.makeCurrent();
     GLES20.glDeleteTextures(1, new int[] {oesTextureId}, 0);
     surfaceTexture.release();
     eglBase.release();
     if (isOwningThread) {
       handler.getLooper().quitSafely();
     }
   }
 }
	/*
	* libjingle
	* Copyright 2015 Google Inc.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions are met:
	*
	* 1. Redistributions of source code must retain the above copyright notice,
	* this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright notice,
	* this list of conditions and the following disclaimer in the documentation
	* and/or other materials provided with the distribution.
	* 3. The name of the author may not be used to endorse or promote products
	* derived from this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
	* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
	* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
	* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
	* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
	* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	package org.webrtc;

	import android.graphics.SurfaceTexture;
	import android.opengl.GLES11Ext;
	import android.opengl.GLES20;
	import android.os.Build;
	import android.os.Handler;
	import android.os.HandlerThread;
	import android.os.SystemClock;

	import java.util.concurrent.Callable;
	import java.util.concurrent.CountDownLatch;
	import java.util.concurrent.TimeUnit;

	import javax.microedition.khronos.egl.EGLContext;

	/**
	* Helper class to create and synchronize access to a SurfaceTexture. The caller will get notified
	* of new frames in onTextureFrameAvailable(), and should call returnTextureFrame() when done with
	* the frame. Only one texture frame can be in flight at once, so returnTextureFrame() must be
	* called in order to receive a new frame. Call disconnect() to stop receiveing new frames and
	* release all resources.
	* Note that there is a C++ counter part of this class that optionally can be used. It is used for
	* wrapping texture frames into webrtc::VideoFrames and also handles calling returnTextureFrame()
	* when the webrtc::VideoFrame is no longer used.
	*/
	final class SurfaceTextureHelper {
	private static final String TAG = "SurfaceTextureHelper";
	/**
	* Callback interface for being notified that a new texture frame is available. The calls will be
	* made on a dedicated thread with a bound EGLContext. The thread will be the same throughout the
	* lifetime of the SurfaceTextureHelper instance, but different from the thread calling the
	* SurfaceTextureHelper constructor. The callee is not allowed to make another EGLContext current
	* on the calling thread.
	*/
	public interface OnTextureFrameAvailableListener {
	abstract void onTextureFrameAvailable(
	int oesTextureId, float[] transformMatrix, long timestampNs);
	}

	public static SurfaceTextureHelper create(EGLContext sharedContext) {
	return create(sharedContext, null);
	}

	/**
	* Construct a new SurfaceTextureHelper sharing OpenGL resources with \|sharedContext\|. If
	* \|handler\| is non-null, the callback will be executed on that handler's thread. If \|handler\| is
	* null, a dedicated private thread is created for the callbacks.
	*/
	public static SurfaceTextureHelper create(final EGLContext sharedContext, final Handler handler) {
	final Handler finalHandler;
	if (handler != null) {
	finalHandler = handler;
	} else {
	final HandlerThread thread = new HandlerThread(TAG);
	thread.start();
	finalHandler = new Handler(thread.getLooper());
	}
	// The onFrameAvailable() callback will be executed on the SurfaceTexture ctor thread. See:
	// http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/5.1.1_r1/android/graphics/SurfaceTexture.java#195.
	// Therefore, in order to control the callback thread on API lvl < 21, the SurfaceTextureHelper
	// is constructed on the \|handler\| thread.
	return ThreadUtils.invokeUninterruptibly(finalHandler, new Callable<SurfaceTextureHelper>() {
	@Override public SurfaceTextureHelper call() {
	return new SurfaceTextureHelper(sharedContext, finalHandler, (handler == null));
	}
	});
	}

	private final Handler handler;
	private final boolean isOwningThread;
	private final EglBase eglBase;
	private final SurfaceTexture surfaceTexture;
	private final int oesTextureId;
	private OnTextureFrameAvailableListener listener;
	// The possible states of this class.
	private boolean hasPendingTexture = false;
	private boolean isTextureInUse = false;
	private boolean isQuitting = false;

	private SurfaceTextureHelper(EGLContext sharedContext, Handler handler, boolean isOwningThread) {
	if (handler.getLooper().getThread() != Thread.currentThread()) {
	throw new IllegalStateException("SurfaceTextureHelper must be created on the handler thread");
	}
	this.handler = handler;
	this.isOwningThread = isOwningThread;

	eglBase = new EglBase(sharedContext, EglBase.ConfigType.PIXEL_BUFFER);
	eglBase.createDummyPbufferSurface();
	eglBase.makeCurrent();

	oesTextureId = GlUtil.generateTexture(GLES11Ext.GL_TEXTURE_EXTERNAL_OES);
	surfaceTexture = new SurfaceTexture(oesTextureId);
	}

	/**
	* Start to stream textures to the given \|listener\|.
	* A Listener can only be set once.
	*/
	public void setListener(OnTextureFrameAvailableListener listener) {
	if (this.listener != null) {
	throw new IllegalStateException("SurfaceTextureHelper listener has already been set.");
	}
	this.listener = listener;
	surfaceTexture.setOnFrameAvailableListener(new SurfaceTexture.OnFrameAvailableListener() {
	@Override
	public void onFrameAvailable(SurfaceTexture surfaceTexture) {
	hasPendingTexture = true;
	tryDeliverTextureFrame();
	}
	});
	}

	/**
	* Retrieve the underlying SurfaceTexture. The SurfaceTexture should be passed in to a video
	* producer such as a camera or decoder.
	*/
	public SurfaceTexture getSurfaceTexture() {
	return surfaceTexture;
	}

	/**
	* Call this function to signal that you are done with the frame received in
	* onTextureFrameAvailable(). Only one texture frame can be in flight at once, so you must call
	* this function in order to receive a new frame.
	*/
	public void returnTextureFrame() {
	handler.post(new Runnable() {
	@Override public void run() {
	isTextureInUse = false;
	if (isQuitting) {
	release();
	} else {
	tryDeliverTextureFrame();
	}
	}
	});
	}

	/**
	* Call disconnect() to stop receiving frames. Resources are released when the texture frame has
	* been returned by a call to returnTextureFrame(). You are guaranteed to not receive any more
	* onTextureFrameAvailable() after this function returns.
	*/
	public void disconnect() {
	if (handler.getLooper().getThread() == Thread.currentThread()) {
	isQuitting = true;
	if (!isTextureInUse) {
	release();
	}
	return;
	}
	final CountDownLatch barrier = new CountDownLatch(1);
	handler.postAtFrontOfQueue(new Runnable() {
	@Override public void run() {
	isQuitting = true;
	barrier.countDown();
	if (!isTextureInUse) {
	release();
	}
	}
	});
	ThreadUtils.awaitUninterruptibly(barrier);
	}

	private void tryDeliverTextureFrame() {
	if (handler.getLooper().getThread() != Thread.currentThread()) {
	throw new IllegalStateException("Wrong thread.");
	}
	if (isQuitting \|\| !hasPendingTexture \|\| isTextureInUse) {
	return;
	}
	isTextureInUse = true;
	hasPendingTexture = false;

	eglBase.makeCurrent();
	surfaceTexture.updateTexImage();

	final float[] transformMatrix = new float[16];
	surfaceTexture.getTransformMatrix(transformMatrix);
	final long timestampNs = (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH)
	? surfaceTexture.getTimestamp()
	: TimeUnit.MILLISECONDS.toNanos(SystemClock.elapsedRealtime());
	listener.onTextureFrameAvailable(oesTextureId, transformMatrix, timestampNs);
	}

	private void release() {
	if (handler.getLooper().getThread() != Thread.currentThread()) {
	throw new IllegalStateException("Wrong thread.");
	}
	if (isTextureInUse \|\| !isQuitting) {
	throw new IllegalStateException("Unexpected release.");
	}
	eglBase.makeCurrent();
	GLES20.glDeleteTextures(1, new int[] {oesTextureId}, 0);
	surfaceTexture.release();
	eglBase.release();
	if (isOwningThread) {
	handler.getLooper().quitSafely();
	}
	}
	}