include/gui/ISurfaceComposer.h

   1 /*
   2  * Copyright (C) 2006 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_ISURFACE_COMPOSER_H
  18 #define ANDROID_GUI_ISURFACE_COMPOSER_H
  19
  20 #include <stdint.h>
  21 #include <sys/types.h>
  22
  23 #include <utils/RefBase.h>
  24 #include <utils/Errors.h>
  25
  26 #include <binder/IInterface.h>
  27
  28 #include <ui/PixelFormat.h>
  29
  30 #include <gui/IGraphicBufferAlloc.h>
  31 #include <gui/ISurfaceComposerClient.h>
  32
  33 namespace android {
  34 // ----------------------------------------------------------------------------
  35
  36 class ComposerState;
  37 class IDisplayEventConnection;
  38 class IMemoryHeap;
  39
  40 class ISurfaceComposer : public IInterface
  41 {
  42 public:
  43     DECLARE_META_INTERFACE(SurfaceComposer);
  44
  45     enum { // (keep in sync with Surface.java)
  46         eHidden             = 0x00000004,
  47         eDestroyBackbuffer  = 0x00000020,
  48         eSecure             = 0x00000080,
  49         eNonPremultiplied   = 0x00000100,
  50         eOpaque             = 0x00000400,
  51         eProtectedByApp     = 0x00000800,
  52         eProtectedByDRM     = 0x00001000,
  53
  54         eFXSurfaceNormal    = 0x00000000,
  55         eFXSurfaceBlur      = 0x00010000,
  56         eFXSurfaceDim       = 0x00020000,
  57         eFXSurfaceScreenshot= 0x00030000,
  58         eFXSurfaceMask      = 0x000F0000,
  59     };
  60
  61     enum {
  62         ePositionChanged            = 0x00000001,
  63         eLayerChanged               = 0x00000002,
  64         eSizeChanged                = 0x00000004,
  65         eAlphaChanged               = 0x00000008,
  66         eMatrixChanged              = 0x00000010,
  67         eTransparentRegionChanged   = 0x00000020,
  68         eVisibilityChanged          = 0x00000040,
  69         eFreezeTintChanged          = 0x00000080,
  70         eCropChanged                = 0x00000100,
  71     };
  72
  73     enum {
  74         eLayerHidden        = 0x01,
  75         eLayerFrozen        = 0x02,
  76         eLayerDither        = 0x04,
  77         eLayerFilter        = 0x08,
  78         eLayerBlurFreeze    = 0x10
  79     };
  80
  81     enum {
  82         eOrientationDefault     = 0,
  83         eOrientation90          = 1,
  84         eOrientation180         = 2,
  85         eOrientation270         = 3,
  86         eOrientationUnchanged   = 4,
  87         eOrientationSwapMask    = 0x01
  88     };
  89
  90     enum {
  91         eSynchronous            = 0x01,
  92     };
  93
  94     enum {
  95         eElectronBeamAnimationOn  = 0x01,
  96         eElectronBeamAnimationOff = 0x10
  97     };
  98
  99     enum {
 100         eDisplayIdMain = 0
 101     };
 102
 103     /* create connection with surface flinger, requires
 104      * ACCESS_SURFACE_FLINGER permission
 105      */
 106     virtual sp<ISurfaceComposerClient> createConnection() = 0;
 107
 108     /* create a graphic buffer allocator
 109      */
 110     virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc() = 0;
 111
 112     /* retrieve the control block */
 113     virtual sp<IMemoryHeap> getCblk() const = 0;
 114
 115     /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
 116     virtual void setTransactionState(const Vector<ComposerState>& state,
 117             int orientation, uint32_t flags) = 0;
 118
 119     /* signal that we're done booting.
 120      * Requires ACCESS_SURFACE_FLINGER permission
 121      */
 122     virtual void bootFinished() = 0;
 123
 124     /* Capture the specified screen. requires READ_FRAME_BUFFER permission
 125      * This function will fail if there is a secure window on screen.
 126      */
 127     virtual status_t captureScreen(DisplayID dpy,
 128             sp<IMemoryHeap>* heap,
 129             uint32_t* width, uint32_t* height, PixelFormat* format,
 130             uint32_t reqWidth, uint32_t reqHeight,
 131             uint32_t minLayerZ, uint32_t maxLayerZ) = 0;
 132
 133     /* triggers screen off animation */
 134     virtual status_t turnElectronBeamOff(int32_t mode) = 0;
 135
 136     /* triggers screen on animation */
 137     virtual status_t turnElectronBeamOn(int32_t mode) = 0;
 138
 139     /* verify that an ISurfaceTexture was created by SurfaceFlinger.
 140      */
 141     virtual bool authenticateSurfaceTexture(
 142             const sp<ISurfaceTexture>& surface) const = 0;
 143
 144     /* return an IDisplayEventConnection */
 145     virtual sp<IDisplayEventConnection> createDisplayEventConnection() = 0;
 146 };
 147
 148 // ----------------------------------------------------------------------------
 149
 150 class BnSurfaceComposer : public BnInterface<ISurfaceComposer>
 151 {
 152 public:
 153     enum {
 154         // Note: BOOT_FINISHED must remain this value, it is called from
 155         // Java by ActivityManagerService.
 156         BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
 157         CREATE_CONNECTION,
 158         CREATE_GRAPHIC_BUFFER_ALLOC,
 159         GET_CBLK,
 160         SET_TRANSACTION_STATE,
 161         SET_ORIENTATION,
 162         CAPTURE_SCREEN,
 163         TURN_ELECTRON_BEAM_OFF,
 164         TURN_ELECTRON_BEAM_ON,
 165         AUTHENTICATE_SURFACE,
 166         CREATE_DISPLAY_EVENT_CONNECTION,
 167     };
 168
 169     virtual status_t    onTransact( uint32_t code,
 170                                     const Parcel& data,
 171                                     Parcel* reply,
 172                                     uint32_t flags = 0);
 173 };
 174
 175 // ----------------------------------------------------------------------------
 176
 177 }; // namespace android
 178
 179 #endif // ANDROID_GUI_ISURFACE_COMPOSER_H