The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.view; |
| 18 | |
Tor Norbye | d9273d6 | 2013-05-30 15:59:53 -0700 | [diff] [blame] | 19 | import android.annotation.IntDef; |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 20 | import android.content.res.CompatibilityInfo.Translator; |
Jeff Brown | 0b722fe | 2012-08-24 22:40:14 -0700 | [diff] [blame] | 21 | import android.graphics.Canvas; |
| 22 | import android.graphics.Matrix; |
| 23 | import android.graphics.Rect; |
Jeff Brown | 0b722fe | 2012-08-24 22:40:14 -0700 | [diff] [blame] | 24 | import android.graphics.SurfaceTexture; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 25 | import android.os.Parcel; |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 26 | import android.os.Parcelable; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 27 | import android.util.Log; |
Tor Norbye | d9273d6 | 2013-05-30 15:59:53 -0700 | [diff] [blame] | 28 | |
| 29 | import java.lang.annotation.Retention; |
| 30 | import java.lang.annotation.RetentionPolicy; |
| 31 | |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 32 | import dalvik.system.CloseGuard; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 33 | |
| 34 | /** |
Glenn Kasten | 334031c | 2010-11-09 21:54:38 -0800 | [diff] [blame] | 35 | * Handle onto a raw buffer that is being managed by the screen compositor. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 36 | */ |
| 37 | public class Surface implements Parcelable { |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 38 | private static final String TAG = "Surface"; |
Mathias Agopian | b923066 | 2011-08-03 14:44:48 -0700 | [diff] [blame] | 39 | |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 40 | private static native long nativeCreateFromSurfaceTexture(SurfaceTexture surfaceTexture) |
Mathias Agopian | 29479eb | 2013-02-14 14:36:04 -0800 | [diff] [blame] | 41 | throws OutOfResourcesException; |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 42 | private static native long nativeCreateFromSurfaceControl(long surfaceControlNativeObject); |
Mathias Agopian | 5280061 | 2013-02-14 17:11:20 -0800 | [diff] [blame] | 43 | |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 44 | private static native long nativeLockCanvas(long nativeObject, Canvas canvas, Rect dirty) |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 45 | throws OutOfResourcesException; |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 46 | private static native void nativeUnlockCanvasAndPost(long nativeObject, Canvas canvas); |
Mathias Agopian | 29479eb | 2013-02-14 14:36:04 -0800 | [diff] [blame] | 47 | |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 48 | private static native void nativeRelease(long nativeObject); |
| 49 | private static native boolean nativeIsValid(long nativeObject); |
| 50 | private static native boolean nativeIsConsumerRunningBehind(long nativeObject); |
| 51 | private static native long nativeReadFromParcel(long nativeObject, Parcel source); |
| 52 | private static native void nativeWriteToParcel(long nativeObject, Parcel dest); |
Mathias Agopian | 29479eb | 2013-02-14 14:36:04 -0800 | [diff] [blame] | 53 | |
Dan Stoza | 5795d64 | 2014-06-20 13:01:36 -0700 | [diff] [blame] | 54 | private static native void nativeAllocateBuffers(long nativeObject); |
| 55 | |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 56 | public static final Parcelable.Creator<Surface> CREATOR = |
| 57 | new Parcelable.Creator<Surface>() { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 58 | @Override |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 59 | public Surface createFromParcel(Parcel source) { |
| 60 | try { |
| 61 | Surface s = new Surface(); |
| 62 | s.readFromParcel(source); |
| 63 | return s; |
| 64 | } catch (Exception e) { |
| 65 | Log.e(TAG, "Exception creating surface from parcel", e); |
| 66 | return null; |
| 67 | } |
Kevin Hester | b85c933 | 2012-03-08 17:06:56 -0800 | [diff] [blame] | 68 | } |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 69 | |
| 70 | @Override |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 71 | public Surface[] newArray(int size) { |
| 72 | return new Surface[size]; |
| 73 | } |
| 74 | }; |
Kevin Hester | b85c933 | 2012-03-08 17:06:56 -0800 | [diff] [blame] | 75 | |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 76 | private final CloseGuard mCloseGuard = CloseGuard.get(); |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 77 | |
| 78 | // Guarded state. |
| 79 | final Object mLock = new Object(); // protects the native state |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 80 | private String mName; |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 81 | long mNativeObject; // package scope only for SurfaceControl access |
| 82 | private long mLockedObject; |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 83 | private int mGenerationId; // incremented each time mNativeObject changes |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 84 | private final Canvas mCanvas = new CompatibleCanvas(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 85 | |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 86 | // A matrix to scale the matrix set by application. This is set to null for |
| 87 | // non compatibility mode. |
| 88 | private Matrix mCompatibleMatrix; |
Mitsuru Oshima | 38ed7d7 | 2009-07-21 14:39:34 -0700 | [diff] [blame] | 89 | |
Tor Norbye | d9273d6 | 2013-05-30 15:59:53 -0700 | [diff] [blame] | 90 | /** @hide */ |
| 91 | @IntDef({ROTATION_0, ROTATION_90, ROTATION_180, ROTATION_270}) |
| 92 | @Retention(RetentionPolicy.SOURCE) |
| 93 | public @interface Rotation {} |
| 94 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 95 | /** |
Mathias Agopian | 29479eb | 2013-02-14 14:36:04 -0800 | [diff] [blame] | 96 | * Rotation constant: 0 degree rotation (natural orientation) |
| 97 | */ |
| 98 | public static final int ROTATION_0 = 0; |
| 99 | |
| 100 | /** |
| 101 | * Rotation constant: 90 degree rotation. |
| 102 | */ |
| 103 | public static final int ROTATION_90 = 1; |
| 104 | |
| 105 | /** |
| 106 | * Rotation constant: 180 degree rotation. |
| 107 | */ |
| 108 | public static final int ROTATION_180 = 2; |
| 109 | |
| 110 | /** |
| 111 | * Rotation constant: 270 degree rotation. |
| 112 | */ |
| 113 | public static final int ROTATION_270 = 3; |
| 114 | |
Mathias Agopian | 29479eb | 2013-02-14 14:36:04 -0800 | [diff] [blame] | 115 | /** |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 116 | * Create an empty surface, which will later be filled in by readFromParcel(). |
Mathias Agopian | b923066 | 2011-08-03 14:44:48 -0700 | [diff] [blame] | 117 | * @hide |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 118 | */ |
| 119 | public Surface() { |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Create Surface from a {@link SurfaceTexture}. |
| 124 | * |
| 125 | * Images drawn to the Surface will be made available to the {@link |
| 126 | * SurfaceTexture}, which can attach them to an OpenGL ES texture via {@link |
| 127 | * SurfaceTexture#updateTexImage}. |
| 128 | * |
| 129 | * @param surfaceTexture The {@link SurfaceTexture} that is updated by this |
| 130 | * Surface. |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 131 | * @throws OutOfResourcesException if the surface could not be created. |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 132 | */ |
| 133 | public Surface(SurfaceTexture surfaceTexture) { |
| 134 | if (surfaceTexture == null) { |
| 135 | throw new IllegalArgumentException("surfaceTexture must not be null"); |
| 136 | } |
| 137 | |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 138 | synchronized (mLock) { |
| 139 | mName = surfaceTexture.toString(); |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 140 | setNativeObjectLocked(nativeCreateFromSurfaceTexture(surfaceTexture)); |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 141 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 142 | } |
| 143 | |
Mathias Agopian | 86e1bc7 | 2013-03-13 17:48:22 -0700 | [diff] [blame] | 144 | /* called from android_view_Surface_createFromIGraphicBufferProducer() */ |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 145 | private Surface(long nativeObject) { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 146 | synchronized (mLock) { |
| 147 | setNativeObjectLocked(nativeObject); |
| 148 | } |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 149 | } |
| 150 | |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 151 | @Override |
| 152 | protected void finalize() throws Throwable { |
| 153 | try { |
| 154 | if (mCloseGuard != null) { |
| 155 | mCloseGuard.warnIfOpen(); |
| 156 | } |
Mathias Agopian | 86e1bc7 | 2013-03-13 17:48:22 -0700 | [diff] [blame] | 157 | release(); |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 158 | } finally { |
| 159 | super.finalize(); |
| 160 | } |
| 161 | } |
| 162 | |
| 163 | /** |
| 164 | * Release the local reference to the server-side surface. |
| 165 | * Always call release() when you're done with a Surface. |
| 166 | * This will make the surface invalid. |
| 167 | */ |
| 168 | public void release() { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 169 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 170 | if (mNativeObject != 0) { |
| 171 | nativeRelease(mNativeObject); |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 172 | setNativeObjectLocked(0); |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 173 | } |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 174 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Free all server-side state associated with this surface and |
| 179 | * release this object's reference. This method can only be |
| 180 | * called from the process that created the service. |
| 181 | * @hide |
| 182 | */ |
| 183 | public void destroy() { |
Mathias Agopian | 86e1bc7 | 2013-03-13 17:48:22 -0700 | [diff] [blame] | 184 | release(); |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Returns true if this object holds a valid surface. |
| 189 | * |
| 190 | * @return True if it holds a physical surface, so lockCanvas() will succeed. |
| 191 | * Otherwise returns false. |
| 192 | */ |
| 193 | public boolean isValid() { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 194 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 195 | if (mNativeObject == 0) return false; |
| 196 | return nativeIsValid(mNativeObject); |
| 197 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | /** |
| 201 | * Gets the generation number of this surface, incremented each time |
| 202 | * the native surface contained within this object changes. |
| 203 | * |
| 204 | * @return The current generation number. |
| 205 | * @hide |
| 206 | */ |
| 207 | public int getGenerationId() { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 208 | synchronized (mLock) { |
| 209 | return mGenerationId; |
| 210 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Returns true if the consumer of this Surface is running behind the producer. |
| 215 | * |
| 216 | * @return True if the consumer is more than one buffer ahead of the producer. |
| 217 | * @hide |
| 218 | */ |
| 219 | public boolean isConsumerRunningBehind() { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 220 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 221 | checkNotReleasedLocked(); |
| 222 | return nativeIsConsumerRunningBehind(mNativeObject); |
| 223 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | /** |
| 227 | * Gets a {@link Canvas} for drawing into this surface. |
| 228 | * |
Mathias Agopian | 9ddf32a | 2013-04-17 15:04:47 -0700 | [diff] [blame] | 229 | * After drawing into the provided {@link Canvas}, the caller must |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 230 | * invoke {@link #unlockCanvasAndPost} to post the new contents to the surface. |
| 231 | * |
Mathias Agopian | 30d7ab9 | 2013-02-14 15:38:40 -0800 | [diff] [blame] | 232 | * @param inOutDirty A rectangle that represents the dirty region that the caller wants |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 233 | * to redraw. This function may choose to expand the dirty rectangle if for example |
| 234 | * the surface has been resized or if the previous contents of the surface were |
Mathias Agopian | 9ddf32a | 2013-04-17 15:04:47 -0700 | [diff] [blame] | 235 | * not available. The caller must redraw the entire dirty region as represented |
| 236 | * by the contents of the inOutDirty rectangle upon return from this function. |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 237 | * The caller may also pass <code>null</code> instead, in the case where the |
| 238 | * entire surface should be redrawn. |
| 239 | * @return A canvas for drawing into the surface. |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 240 | * |
| 241 | * @throws IllegalArgumentException If the inOutDirty rectangle is not valid. |
| 242 | * @throws OutOfResourcesException If the canvas cannot be locked. |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 243 | */ |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 244 | public Canvas lockCanvas(Rect inOutDirty) |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 245 | throws Surface.OutOfResourcesException, IllegalArgumentException { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 246 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 247 | checkNotReleasedLocked(); |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 248 | if (mLockedObject != 0) { |
| 249 | // Ideally, nativeLockCanvas() would throw in this situation and prevent the |
| 250 | // double-lock, but that won't happen if mNativeObject was updated. We can't |
| 251 | // abandon the old mLockedObject because it might still be in use, so instead |
| 252 | // we just refuse to re-lock the Surface. |
Jesse Hall | d7e5596 | 2014-10-13 11:01:15 -0700 | [diff] [blame] | 253 | throw new IllegalArgumentException("Surface was already locked"); |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 254 | } |
| 255 | mLockedObject = nativeLockCanvas(mNativeObject, mCanvas, inOutDirty); |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 256 | return mCanvas; |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 257 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | /** |
| 261 | * Posts the new contents of the {@link Canvas} to the surface and |
| 262 | * releases the {@link Canvas}. |
| 263 | * |
| 264 | * @param canvas The canvas previously obtained from {@link #lockCanvas}. |
| 265 | */ |
| 266 | public void unlockCanvasAndPost(Canvas canvas) { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 267 | if (canvas != mCanvas) { |
| 268 | throw new IllegalArgumentException("canvas object must be the same instance that " |
| 269 | + "was previously returned by lockCanvas"); |
| 270 | } |
| 271 | |
| 272 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 273 | checkNotReleasedLocked(); |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 274 | if (mNativeObject != mLockedObject) { |
| 275 | Log.w(TAG, "WARNING: Surface's mNativeObject (0x" + |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 276 | Long.toHexString(mNativeObject) + ") != mLockedObject (0x" + |
| 277 | Long.toHexString(mLockedObject) +")"); |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 278 | } |
| 279 | if (mLockedObject == 0) { |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 280 | throw new IllegalStateException("Surface was not locked"); |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 281 | } |
Jesse Hall | d7e5596 | 2014-10-13 11:01:15 -0700 | [diff] [blame] | 282 | try { |
| 283 | nativeUnlockCanvasAndPost(mLockedObject, canvas); |
| 284 | } finally { |
| 285 | nativeRelease(mLockedObject); |
| 286 | mLockedObject = 0; |
| 287 | } |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 288 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 289 | } |
| 290 | |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 291 | /** |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 292 | * @deprecated This API has been removed and is not supported. Do not use. |
| 293 | */ |
| 294 | @Deprecated |
| 295 | public void unlockCanvas(Canvas canvas) { |
| 296 | throw new UnsupportedOperationException(); |
| 297 | } |
| 298 | |
| 299 | /** |
| 300 | * Sets the translator used to scale canvas's width/height in compatibility |
| 301 | * mode. |
| 302 | */ |
| 303 | void setCompatibilityTranslator(Translator translator) { |
| 304 | if (translator != null) { |
| 305 | float appScale = translator.applicationScale; |
| 306 | mCompatibleMatrix = new Matrix(); |
| 307 | mCompatibleMatrix.setScale(appScale, appScale); |
| 308 | } |
| 309 | } |
| 310 | |
Mitsuru Oshima | 38ed7d7 | 2009-07-21 14:39:34 -0700 | [diff] [blame] | 311 | /** |
Mathias Agopian | b923066 | 2011-08-03 14:44:48 -0700 | [diff] [blame] | 312 | * Copy another surface to this one. This surface now holds a reference |
| 313 | * to the same data as the original surface, and is -not- the owner. |
Dianne Hackborn | 61566cc | 2011-12-02 23:31:52 -0800 | [diff] [blame] | 314 | * This is for use by the window manager when returning a window surface |
| 315 | * back from a client, converting it from the representation being managed |
| 316 | * by the window manager to the representation the client uses to draw |
| 317 | * in to it. |
Mathias Agopian | b923066 | 2011-08-03 14:44:48 -0700 | [diff] [blame] | 318 | * @hide |
| 319 | */ |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 320 | public void copyFrom(SurfaceControl other) { |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 321 | if (other == null) { |
| 322 | throw new IllegalArgumentException("other must not be null"); |
| 323 | } |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 324 | |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 325 | long surfaceControlPtr = other.mNativeObject; |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 326 | if (surfaceControlPtr == 0) { |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 327 | throw new NullPointerException( |
| 328 | "SurfaceControl native object is null. Are you using a released SurfaceControl?"); |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 329 | } |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 330 | long newNativeObject = nativeCreateFromSurfaceControl(surfaceControlPtr); |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 331 | |
| 332 | synchronized (mLock) { |
| 333 | if (mNativeObject != 0) { |
| 334 | nativeRelease(mNativeObject); |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 335 | } |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 336 | setNativeObjectLocked(newNativeObject); |
Mathias Agopian | 86e1bc7 | 2013-03-13 17:48:22 -0700 | [diff] [blame] | 337 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 338 | } |
Dianne Hackborn | 61566cc | 2011-12-02 23:31:52 -0800 | [diff] [blame] | 339 | |
| 340 | /** |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 341 | * This is intended to be used by {@link SurfaceView#updateWindow} only. |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 342 | * @param other access is not thread safe |
| 343 | * @hide |
| 344 | * @deprecated |
Dianne Hackborn | 61566cc | 2011-12-02 23:31:52 -0800 | [diff] [blame] | 345 | */ |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 346 | @Deprecated |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 347 | public void transferFrom(Surface other) { |
| 348 | if (other == null) { |
| 349 | throw new IllegalArgumentException("other must not be null"); |
| 350 | } |
| 351 | if (other != this) { |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 352 | final long newPtr; |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 353 | synchronized (other.mLock) { |
| 354 | newPtr = other.mNativeObject; |
| 355 | other.setNativeObjectLocked(0); |
| 356 | } |
| 357 | |
| 358 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 359 | if (mNativeObject != 0) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 360 | nativeRelease(mNativeObject); |
| 361 | } |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 362 | setNativeObjectLocked(newPtr); |
Mathias Agopian | 3866f0d | 2013-02-11 22:08:48 -0800 | [diff] [blame] | 363 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 364 | } |
Mathias Agopian | b923066 | 2011-08-03 14:44:48 -0700 | [diff] [blame] | 365 | } |
| 366 | |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 367 | @Override |
| 368 | public int describeContents() { |
| 369 | return 0; |
| 370 | } |
| 371 | |
| 372 | public void readFromParcel(Parcel source) { |
| 373 | if (source == null) { |
| 374 | throw new IllegalArgumentException("source must not be null"); |
| 375 | } |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 376 | |
| 377 | synchronized (mLock) { |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 378 | // nativeReadFromParcel() will either return mNativeObject, or |
| 379 | // create a new native Surface and return it after reducing |
| 380 | // the reference count on mNativeObject. Either way, it is |
| 381 | // not necessary to call nativeRelease() here. |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 382 | mName = source.readString(); |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 383 | setNativeObjectLocked(nativeReadFromParcel(mNativeObject, source)); |
Mathias Agopian | 86e1bc7 | 2013-03-13 17:48:22 -0700 | [diff] [blame] | 384 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 385 | } |
| 386 | |
| 387 | @Override |
| 388 | public void writeToParcel(Parcel dest, int flags) { |
| 389 | if (dest == null) { |
| 390 | throw new IllegalArgumentException("dest must not be null"); |
| 391 | } |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 392 | synchronized (mLock) { |
Mathias Agopian | 7c116b5 | 2013-03-18 20:27:02 -0700 | [diff] [blame] | 393 | dest.writeString(mName); |
| 394 | nativeWriteToParcel(mNativeObject, dest); |
| 395 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 396 | if ((flags & Parcelable.PARCELABLE_WRITE_RETURN_VALUE) != 0) { |
| 397 | release(); |
| 398 | } |
| 399 | } |
| 400 | |
| 401 | @Override |
| 402 | public String toString() { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 403 | synchronized (mLock) { |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 404 | return "Surface(name=" + mName + ")/@0x" + |
| 405 | Integer.toHexString(System.identityHashCode(this)); |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 406 | } |
| 407 | } |
| 408 | |
Ashok Bhat | 36bef0b | 2014-01-20 20:08:01 +0000 | [diff] [blame] | 409 | private void setNativeObjectLocked(long ptr) { |
Jeff Brown | fc0ebd7 | 2013-04-30 16:33:00 -0700 | [diff] [blame] | 410 | if (mNativeObject != ptr) { |
| 411 | if (mNativeObject == 0 && ptr != 0) { |
| 412 | mCloseGuard.open("release"); |
| 413 | } else if (mNativeObject != 0 && ptr == 0) { |
| 414 | mCloseGuard.close(); |
| 415 | } |
| 416 | mNativeObject = ptr; |
| 417 | mGenerationId += 1; |
| 418 | } |
| 419 | } |
| 420 | |
| 421 | private void checkNotReleasedLocked() { |
| 422 | if (mNativeObject == 0) { |
| 423 | throw new IllegalStateException("Surface has already been released."); |
| 424 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 425 | } |
| 426 | |
Mathias Agopian | c14bacf | 2012-04-23 18:23:08 -0700 | [diff] [blame] | 427 | /** |
Dan Stoza | 5795d64 | 2014-06-20 13:01:36 -0700 | [diff] [blame] | 428 | * Allocate buffers ahead of time to avoid allocation delays during rendering |
| 429 | * @hide |
| 430 | */ |
| 431 | public void allocateBuffers() { |
| 432 | synchronized (mLock) { |
| 433 | checkNotReleasedLocked(); |
| 434 | nativeAllocateBuffers(mNativeObject); |
| 435 | } |
| 436 | } |
| 437 | |
| 438 | /** |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 439 | * Exception thrown when a Canvas couldn't be locked with {@link Surface#lockCanvas}, or |
| 440 | * when a SurfaceTexture could not successfully be allocated. |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 441 | */ |
Igor Murashkin | a86ab640 | 2013-08-30 12:58:36 -0700 | [diff] [blame] | 442 | @SuppressWarnings("serial") |
| 443 | public static class OutOfResourcesException extends RuntimeException { |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 444 | public OutOfResourcesException() { |
| 445 | } |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 446 | public OutOfResourcesException(String name) { |
| 447 | super(name); |
| 448 | } |
| 449 | } |
| 450 | |
| 451 | /** |
Svetoslav Ganov | 152e9bb | 2012-10-12 20:15:29 -0700 | [diff] [blame] | 452 | * Returns a human readable representation of a rotation. |
| 453 | * |
| 454 | * @param rotation The rotation. |
| 455 | * @return The rotation symbolic name. |
Svetoslav Ganov | 545252f | 2012-12-10 18:29:24 -0800 | [diff] [blame] | 456 | * |
| 457 | * @hide |
Svetoslav Ganov | 152e9bb | 2012-10-12 20:15:29 -0700 | [diff] [blame] | 458 | */ |
| 459 | public static String rotationToString(int rotation) { |
| 460 | switch (rotation) { |
| 461 | case Surface.ROTATION_0: { |
| 462 | return "ROTATION_0"; |
| 463 | } |
| 464 | case Surface.ROTATION_90: { |
| 465 | return "ROATATION_90"; |
| 466 | } |
| 467 | case Surface.ROTATION_180: { |
| 468 | return "ROATATION_180"; |
| 469 | } |
| 470 | case Surface.ROTATION_270: { |
| 471 | return "ROATATION_270"; |
| 472 | } |
| 473 | default: { |
| 474 | throw new IllegalArgumentException("Invalid rotation: " + rotation); |
| 475 | } |
| 476 | } |
| 477 | } |
| 478 | |
| 479 | /** |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 480 | * A Canvas class that can handle the compatibility mode. |
| 481 | * This does two things differently. |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 482 | * <ul> |
Mathias Agopian | b923066 | 2011-08-03 14:44:48 -0700 | [diff] [blame] | 483 | * <li>Returns the width and height of the target metrics, rather than |
| 484 | * native. For example, the canvas returns 320x480 even if an app is running |
| 485 | * in WVGA high density. |
| 486 | * <li>Scales the matrix in setMatrix by the application scale, except if |
| 487 | * the matrix looks like obtained from getMatrix. This is a hack to handle |
| 488 | * the case that an application uses getMatrix to keep the original matrix, |
| 489 | * set matrix of its own, then set the original matrix back. There is no |
| 490 | * perfect solution that works for all cases, and there are a lot of cases |
| 491 | * that this model does not work, but we hope this works for many apps. |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 492 | * </ul> |
| 493 | */ |
Jeff Brown | 64a55af | 2012-08-26 02:47:39 -0700 | [diff] [blame] | 494 | private final class CompatibleCanvas extends Canvas { |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 495 | // A temp matrix to remember what an application obtained via {@link getMatrix} |
| 496 | private Matrix mOrigMatrix = null; |
| 497 | |
| 498 | @Override |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 499 | public void setMatrix(Matrix matrix) { |
| 500 | if (mCompatibleMatrix == null || mOrigMatrix == null || mOrigMatrix.equals(matrix)) { |
| 501 | // don't scale the matrix if it's not compatibility mode, or |
| 502 | // the matrix was obtained from getMatrix. |
| 503 | super.setMatrix(matrix); |
| 504 | } else { |
| 505 | Matrix m = new Matrix(mCompatibleMatrix); |
| 506 | m.preConcat(matrix); |
| 507 | super.setMatrix(m); |
| 508 | } |
| 509 | } |
| 510 | |
Romain Guy | 8b5aa48 | 2013-02-28 18:13:54 -0800 | [diff] [blame] | 511 | @SuppressWarnings("deprecation") |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 512 | @Override |
| 513 | public void getMatrix(Matrix m) { |
| 514 | super.getMatrix(m); |
| 515 | if (mOrigMatrix == null) { |
Andy McFadden | ed55c8d | 2013-08-20 10:05:51 -0700 | [diff] [blame] | 516 | mOrigMatrix = new Matrix(); |
Mitsuru Oshima | 240f8a7 | 2009-07-22 20:39:14 -0700 | [diff] [blame] | 517 | } |
| 518 | mOrigMatrix.set(m); |
| 519 | } |
Romain Guy | d10cd57 | 2010-10-10 13:33:22 -0700 | [diff] [blame] | 520 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 521 | } |