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_SF_SURFACE_COMPOSER_CLIENT_H 18 #define ANDROID_SF_SURFACE_COMPOSER_CLIENT_H 19 20 #include <stdint.h> 21 #include <sys/types.h> 22 23 #include <binder/IBinder.h> 24 25 #include <utils/RefBase.h> 26 #include <utils/Singleton.h> 27 #include <utils/SortedVector.h> 28 #include <utils/threads.h> 29 30 #include <ui/PixelFormat.h> 31 #include <ui/Region.h> 32 33 #include <surfaceflinger/Surface.h> 34 35 namespace android { 36 37 // --------------------------------------------------------------------------- 38 39 class DisplayInfo; 40 class Composer; 41 class IMemoryHeap; 42 class ISurfaceComposer; 43 class Region; 44 class surface_flinger_cblk_t; 45 struct layer_state_t; 46 47 // --------------------------------------------------------------------------- 48 49 class ComposerService : public Singleton<ComposerService> 50 { 51 // these are constants 52 sp<ISurfaceComposer> mComposerService; 53 sp<IMemoryHeap> mServerCblkMemory; 54 surface_flinger_cblk_t volatile* mServerCblk; 55 ComposerService(); 56 friend class Singleton<ComposerService>; 57 public: 58 static sp<ISurfaceComposer> getComposerService(); 59 static surface_flinger_cblk_t const volatile * getControlBlock(); 60 }; 61 62 // --------------------------------------------------------------------------- 63 64 class Composer; 65 66 class SurfaceComposerClient : public RefBase 67 { 68 friend class Composer; 69 public: 70 SurfaceComposerClient(); 71 virtual ~SurfaceComposerClient(); 72 73 // Always make sure we could initialize 74 status_t initCheck() const; 75 76 // Return the connection of this client 77 sp<IBinder> connection() const; 78 79 // Forcibly remove connection before all references have gone away. 80 void dispose(); 81 82 // ------------------------------------------------------------------------ 83 // surface creation / destruction 84 85 //! Create a surface 86 sp<SurfaceControl> createSurface( 87 const String8& name,// name of the surface 88 DisplayID display, // Display to create this surface on 89 uint32_t w, // width in pixel 90 uint32_t h, // height in pixel 91 PixelFormat format, // pixel-format desired 92 uint32_t flags = 0 // usage flags 93 ); 94 95 sp<SurfaceControl> createSurface( 96 DisplayID display, // Display to create this surface on 97 uint32_t w, // width in pixel 98 uint32_t h, // height in pixel 99 PixelFormat format, // pixel-format desired 100 uint32_t flags = 0 // usage flags 101 ); 102 103 104 // ------------------------------------------------------------------------ 105 // Composer parameters 106 // All composer parameters must be changed within a transaction 107 // several surfaces can be updated in one transaction, all changes are 108 // committed at once when the transaction is closed. 109 // closeGlobalTransaction() usually requires an IPC with the server. 110 111 //! Open a composer transaction on all active SurfaceComposerClients. 112 static void openGlobalTransaction(); 113 114 //! Close a composer transaction on all active SurfaceComposerClients. 115 static void closeGlobalTransaction(bool synchronous = false); 116 117 //! Freeze the specified display but not transactions. 118 static status_t freezeDisplay(DisplayID dpy, uint32_t flags = 0); 119 120 //! Resume updates on the specified display. 121 static status_t unfreezeDisplay(DisplayID dpy, uint32_t flags = 0); 122 123 //! Set the orientation of the given display 124 static int setOrientation(DisplayID dpy, int orientation, uint32_t flags); 125 126 // Query the number of displays 127 static ssize_t getNumberOfDisplays(); 128 129 // Get information about a display 130 static status_t getDisplayInfo(DisplayID dpy, DisplayInfo* info); 131 static ssize_t getDisplayWidth(DisplayID dpy); 132 static ssize_t getDisplayHeight(DisplayID dpy); 133 static ssize_t getDisplayOrientation(DisplayID dpy); 134 135 status_t linkToComposerDeath(const sp<IBinder::DeathRecipient>& recipient, 136 void* cookie = NULL, uint32_t flags = 0); 137 138 status_t hide(SurfaceID id); 139 status_t show(SurfaceID id, int32_t layer = -1); 140 status_t freeze(SurfaceID id); 141 status_t unfreeze(SurfaceID id); 142 status_t setFlags(SurfaceID id, uint32_t flags, uint32_t mask); 143 status_t setTransparentRegionHint(SurfaceID id, const Region& transparent); 144 status_t setLayer(SurfaceID id, int32_t layer); 145 status_t setAlpha(SurfaceID id, float alpha=1.0f); 146 status_t setFreezeTint(SurfaceID id, uint32_t tint); 147 status_t setMatrix(SurfaceID id, float dsdx, float dtdx, float dsdy, float dtdy); 148 status_t setPosition(SurfaceID id, float x, float y); 149 status_t setSize(SurfaceID id, uint32_t w, uint32_t h); 150 status_t destroySurface(SurfaceID sid); 151 152 private: 153 virtual void onFirstRef(); 154 Composer& getComposer(); 155 156 mutable Mutex mLock; 157 status_t mStatus; 158 sp<ISurfaceComposerClient> mClient; 159 Composer& mComposer; 160 }; 161 162 // --------------------------------------------------------------------------- 163 164 class ScreenshotClient 165 { 166 sp<IMemoryHeap> mHeap; 167 uint32_t mWidth; 168 uint32_t mHeight; 169 PixelFormat mFormat; 170 public: 171 ScreenshotClient(); 172 173 // frees the previous screenshot and capture a new one 174 status_t update(); 175 status_t update(uint32_t reqWidth, uint32_t reqHeight); 176 status_t update(uint32_t reqWidth, uint32_t reqHeight, 177 uint32_t minLayerZ, uint32_t maxLayerZ); 178 179 // release memory occupied by the screenshot 180 void release(); 181 182 // pixels are valid until this object is freed or 183 // release() or update() is called 184 void const* getPixels() const; 185 186 uint32_t getWidth() const; 187 uint32_t getHeight() const; 188 PixelFormat getFormat() const; 189 uint32_t getStride() const; 190 // size of allocated memory in bytes 191 size_t getSize() const; 192 }; 193 194 // --------------------------------------------------------------------------- 195 }; // namespace android 196 197 #endif // ANDROID_SF_SURFACE_COMPOSER_CLIENT_H 198
