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