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 #ifndef ANDROID_GUI_SURFACE_H 18 #define ANDROID_GUI_SURFACE_H 19 20 #include <stdint.h> 21 #include <sys/types.h> 22 23 #include <utils/KeyedVector.h> 24 #include <utils/RefBase.h> 25 #include <utils/threads.h> 26 27 #include <ui/PixelFormat.h> 28 #include <ui/Region.h> 29 30 #include <gui/SurfaceTextureClient.h> 31 #include <gui/ISurface.h> 32 #include <gui/ISurfaceComposerClient.h> 33 34 #define ANDROID_VIEW_SURFACE_JNI_ID "mNativeSurface" 35 36 namespace android { 37 38 // --------------------------------------------------------------------------- 39 40 class ISurfaceTexture; 41 class Surface; 42 class SurfaceComposerClient; 43 44 // --------------------------------------------------------------------------- 45 46 class SurfaceControl : public RefBase 47 { 48 public: 49 static bool isValid(const sp<SurfaceControl>& surface) { 50 return (surface != 0) && surface->isValid(); 51 } 52 bool isValid() { 53 return mToken>=0 && mClient!=0; 54 } 55 static bool isSameSurface( 56 const sp<SurfaceControl>& lhs, const sp<SurfaceControl>& rhs); 57 58 uint32_t getIdentity() const { return mIdentity; } 59 60 // release surface data from java 61 void clear(); 62 63 status_t setLayerStack(int32_t layerStack); 64 status_t setLayer(int32_t layer); 65 status_t setPosition(int32_t x, int32_t y); 66 status_t setSize(uint32_t w, uint32_t h); 67 status_t hide(); 68 status_t show(); 69 status_t setFlags(uint32_t flags, uint32_t mask); 70 status_t setTransparentRegionHint(const Region& transparent); 71 status_t setAlpha(float alpha=1.0f); 72 status_t setMatrix(float dsdx, float dtdx, float dsdy, float dtdy); 73 status_t setCrop(const Rect& crop); 74 75 static status_t writeSurfaceToParcel( 76 const sp<SurfaceControl>& control, Parcel* parcel); 77 78 sp<Surface> getSurface() const; 79 80 private: 81 // can't be copied 82 SurfaceControl& operator = (SurfaceControl& rhs); 83 SurfaceControl(const SurfaceControl& rhs); 84 85 friend class SurfaceComposerClient; 86 friend class Surface; 87 88 SurfaceControl( 89 const sp<SurfaceComposerClient>& client, 90 const sp<ISurface>& surface, 91 const ISurfaceComposerClient::surface_data_t& data); 92 93 ~SurfaceControl(); 94 95 status_t validate() const; 96 void destroy(); 97 98 sp<SurfaceComposerClient> mClient; 99 sp<ISurface> mSurface; 100 SurfaceID mToken; 101 uint32_t mIdentity; 102 mutable Mutex mLock; 103 104 mutable sp<Surface> mSurfaceData; 105 }; 106 107 // --------------------------------------------------------------------------- 108 109 class Surface : public SurfaceTextureClient 110 { 111 public: 112 struct SurfaceInfo { 113 uint32_t w; 114 uint32_t h; 115 uint32_t s; 116 uint32_t usage; 117 PixelFormat format; 118 void* bits; 119 uint32_t reserved[2]; 120 }; 121 122 explicit Surface(const sp<ISurfaceTexture>& st); 123 124 static status_t writeToParcel(const sp<Surface>& control, Parcel* parcel); 125 126 static sp<Surface> readFromParcel(const Parcel& data); 127 static bool isValid(const sp<Surface>& surface) { 128 return (surface != 0) && surface->isValid(); 129 } 130 131 bool isValid(); 132 uint32_t getIdentity() const { return mIdentity; } 133 sp<ISurfaceTexture> getSurfaceTexture(); 134 135 // the lock/unlock APIs must be used from the same thread 136 status_t lock(SurfaceInfo* info, Region* dirty = NULL); 137 status_t unlockAndPost(); 138 139 sp<IBinder> asBinder() const; 140 141 private: 142 // this is just to be able to write some unit tests 143 friend class Test; 144 friend class SurfaceControl; 145 146 // can't be copied 147 Surface& operator = (Surface& rhs); 148 Surface(const Surface& rhs); 149 150 explicit Surface(const sp<SurfaceControl>& control); 151 Surface(const Parcel& data, const sp<IBinder>& ref); 152 ~Surface(); 153 154 /* 155 * private stuff... 156 */ 157 void init(const sp<ISurfaceTexture>& surfaceTexture); 158 159 static void cleanCachedSurfacesLocked(); 160 161 virtual int query(int what, int* value) const; 162 163 // constants 164 sp<ISurface> mSurface; 165 uint32_t mIdentity; 166 167 // A cache of Surface objects that have been deserialized into this process. 168 static Mutex sCachedSurfacesLock; 169 static DefaultKeyedVector<wp<IBinder>, wp<Surface> > sCachedSurfaces; 170 }; 171 172 }; // namespace android 173 174 #endif // ANDROID_GUI_SURFACE_H 175
