SurfaceTexture.java revision bd5404d0312752e7c8946e8540129f0d2d97bcd7
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 17package android.graphics; 18 19import java.lang.ref.WeakReference; 20import android.os.Handler; 21import android.os.Looper; 22import android.os.Message; 23 24/** 25 * Captures frames from an image stream as an OpenGL ES texture. 26 * 27 * <p>The image stream may come from either camera preview or video decode. A SurfaceTexture 28 * may be used in place of a SurfaceHolder when specifying the output destination of a 29 * {@link android.hardware.Camera} or {@link android.media.MediaPlayer} 30 * object. Doing so will cause all the frames from the image stream to be sent to the 31 * SurfaceTexture object rather than to the device's display. When {@link #updateTexImage} is 32 * called, the contents of the texture object specified when the SurfaceTexture was created are 33 * updated to contain the most recent image from the image stream. This may cause some frames of 34 * the stream to be skipped. 35 * 36 * <p>When sampling from the texture one should first transform the texture coordinates using the 37 * matrix queried via {@link #getTransformMatrix(float[])}. The transform matrix may change each 38 * time {@link #updateTexImage} is called, so it should be re-queried each time the texture image 39 * is updated. 40 * This matrix transforms traditional 2D OpenGL ES texture coordinate column vectors of the form (s, 41 * t, 0, 1) where s and t are on the inclusive interval [0, 1] to the proper sampling location in 42 * the streamed texture. This transform compensates for any properties of the image stream source 43 * that cause it to appear different from a traditional OpenGL ES texture. For example, sampling 44 * from the bottom left corner of the image can be accomplished by transforming the column vector 45 * (0, 0, 0, 1) using the queried matrix, while sampling from the top right corner of the image can 46 * be done by transforming (1, 1, 0, 1). 47 * 48 * <p>The texture object uses the GL_TEXTURE_EXTERNAL_OES texture target, which is defined by the 49 * <a href="http://www.khronos.org/registry/gles/extensions/OES/OES_EGL_image_external.txt"> 50 * GL_OES_EGL_image_external</a> OpenGL ES extension. This limits how the texture may be used. 51 * Each time the texture is bound it must be bound to the GL_TEXTURE_EXTERNAL_OES target rather than 52 * the GL_TEXTURE_2D target. Additionally, any OpenGL ES 2.0 shader that samples from the texture 53 * must declare its use of this extension using, for example, an "#extension 54 * GL_OES_EGL_image_external : require" directive. Such shaders must also access the texture using 55 * the samplerExternalOES GLSL sampler type. 56 * 57 * <p>SurfaceTexture objects may be created on any thread. {@link #updateTexImage} may only be 58 * called on the thread with the OpenGL ES context that contains the texture object. The 59 * frame-available callback is called on an arbitrary thread, so unless special care is taken {@link 60 * #updateTexImage} should not be called directly from the callback. 61 */ 62public class SurfaceTexture { 63 64 private EventHandler mEventHandler; 65 private OnFrameAvailableListener mOnFrameAvailableListener; 66 67 /** 68 * This field is used by native code, do not access or modify. 69 */ 70 private int mSurfaceTexture; 71 72 /** 73 * Callback interface for being notified that a new stream frame is available. 74 */ 75 public interface OnFrameAvailableListener { 76 void onFrameAvailable(SurfaceTexture surfaceTexture); 77 } 78 79 /** 80 * Exception thrown when a surface couldn't be created or resized 81 */ 82 public static class OutOfResourcesException extends Exception { 83 public OutOfResourcesException() { 84 } 85 public OutOfResourcesException(String name) { 86 super(name); 87 } 88 } 89 90 /** 91 * Construct a new SurfaceTexture to stream images to a given OpenGL texture. 92 * 93 * @param texName the OpenGL texture object name (e.g. generated via glGenTextures) 94 */ 95 public SurfaceTexture(int texName) { 96 this(texName, true); 97 } 98 99 /** 100 * Construct a new SurfaceTexture to stream images to a given OpenGL texture. 101 * 102 * @param texName the OpenGL texture object name (e.g. generated via glGenTextures) 103 * @param allowSynchronousMode whether the SurfaceTexture can run in the synchronous mode. 104 * When the image stream comes from OpenGL, SurfaceTexture may run in the synchronous 105 * mode where the producer side may be blocked to avoid skipping frames. To avoid the 106 * thread block, set allowSynchronousMode to false. 107 */ 108 public SurfaceTexture(int texName, boolean allowSynchronousMode) { 109 Looper looper; 110 if ((looper = Looper.myLooper()) != null) { 111 mEventHandler = new EventHandler(looper); 112 } else if ((looper = Looper.getMainLooper()) != null) { 113 mEventHandler = new EventHandler(looper); 114 } else { 115 mEventHandler = null; 116 } 117 nativeInit(texName, new WeakReference<SurfaceTexture>(this), allowSynchronousMode); 118 } 119 120 /** 121 * Register a callback to be invoked when a new image frame becomes available to the 122 * SurfaceTexture. Note that this callback may be called on an arbitrary thread, so it is not 123 * safe to call {@link #updateTexImage} without first binding the OpenGL ES context to the 124 * thread invoking the callback. 125 */ 126 public void setOnFrameAvailableListener(OnFrameAvailableListener l) { 127 mOnFrameAvailableListener = l; 128 } 129 130 /** 131 * Set the size of buffers returned by requestBuffers when a width and height 132 * of zero is requested. 133 * 134 * @hide Pending approval by API council. 135 */ 136 public void setDefaultBufferSize(int width, int height) { 137 nativeSetDefaultBufferSize(width, height); 138 } 139 140 /** 141 * Update the texture image to the most recent frame from the image stream. This may only be 142 * called while the OpenGL ES context that owns the texture is bound to the thread. It will 143 * implicitly bind its texture to the GL_TEXTURE_EXTERNAL_OES texture target. 144 */ 145 public void updateTexImage() { 146 nativeUpdateTexImage(); 147 } 148 149 /** 150 * Retrieve the 4x4 texture coordinate transform matrix associated with the texture image set by 151 * the most recent call to updateTexImage. 152 * 153 * This transform matrix maps 2D homogeneous texture coordinates of the form (s, t, 0, 1) with s 154 * and t in the inclusive range [0, 1] to the texture coordinate that should be used to sample 155 * that location from the texture. Sampling the texture outside of the range of this transform 156 * is undefined. 157 * 158 * The matrix is stored in column-major order so that it may be passed directly to OpenGL ES via 159 * the glLoadMatrixf or glUniformMatrix4fv functions. 160 * 161 * @param mtx the array into which the 4x4 matrix will be stored. The array must have exactly 162 * 16 elements. 163 */ 164 public void getTransformMatrix(float[] mtx) { 165 // Note we intentionally don't check mtx for null, so this will result in a 166 // NullPointerException. But it's safe because it happens before the call to native. 167 if (mtx.length != 16) { 168 throw new IllegalArgumentException(); 169 } 170 nativeGetTransformMatrix(mtx); 171 } 172 173 /** 174 * Retrieve the timestamp associated with the texture image set by the most recent call to 175 * updateTexImage. 176 * 177 * This timestamp is in nanoseconds, and is guaranteed to be monotonically increasing. The 178 * specific meaning and zero point of the timestamp depends on the source providing images to 179 * the SurfaceTexture. Unless otherwise specified by the image source, timestamps cannot 180 * generally be compared across SurfaceTexture instances, or across multiple program 181 * invocations. It is mostly useful for determining time offsets between subsequent frames. 182 */ 183 public long getTimestamp() { 184 return nativeGetTimestamp(); 185 } 186 187 protected void finalize() throws Throwable { 188 try { 189 nativeFinalize(); 190 } finally { 191 super.finalize(); 192 } 193 } 194 195 private class EventHandler extends Handler { 196 public EventHandler(Looper looper) { 197 super(looper); 198 } 199 200 @Override 201 public void handleMessage(Message msg) { 202 if (mOnFrameAvailableListener != null) { 203 mOnFrameAvailableListener.onFrameAvailable(SurfaceTexture.this); 204 } 205 } 206 } 207 208 /** 209 * This method is invoked from native code only. 210 */ 211 @SuppressWarnings({"UnusedDeclaration"}) 212 private static void postEventFromNative(Object selfRef) { 213 WeakReference weakSelf = (WeakReference)selfRef; 214 SurfaceTexture st = (SurfaceTexture)weakSelf.get(); 215 if (st == null) { 216 return; 217 } 218 219 if (st.mEventHandler != null) { 220 Message m = st.mEventHandler.obtainMessage(); 221 st.mEventHandler.sendMessage(m); 222 } 223 } 224 225 private native void nativeInit(int texName, Object weakSelf, boolean allowSynchronousMode); 226 private native void nativeFinalize(); 227 private native void nativeGetTransformMatrix(float[] mtx); 228 private native long nativeGetTimestamp(); 229 private native void nativeSetDefaultBufferSize(int width, int height); 230 private native void nativeUpdateTexImage(); 231 private native int nativeGetQueuedCount(); 232 233 /* 234 * We use a class initializer to allow the native code to cache some 235 * field offsets. 236 */ 237 private static native void nativeClassInit(); 238 static { nativeClassInit(); } 239} 240