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 DisplayState;
  38 class DisplayInfo;
  39 class IDisplayEventConnection;
  40 class IMemoryHeap;
  41
  42 class ISurfaceComposer: public IInterface {
  43 public:
  44     DECLARE_META_INTERFACE(SurfaceComposer);
  45
  46     // flags for setTransactionState()
  47     enum {
  48         eSynchronous = 0x01,
  49     };
  50
  51     enum {
  52         eDisplayIdMain = 0,
  53         eDisplayIdHdmi = 1
  54     };
  55
  56     /* create connection with surface flinger, requires
  57      * ACCESS_SURFACE_FLINGER permission
  58      */
  59     virtual sp<ISurfaceComposerClient> createConnection() = 0;
  60
  61     /* create a graphic buffer allocator
  62      */
  63     virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc() = 0;
  64
  65     /* return an IDisplayEventConnection */
  66     virtual sp<IDisplayEventConnection> createDisplayEventConnection() = 0;
  67
  68     /* create a display with given id.
  69      * requires ACCESS_SURFACE_FLINGER permission.
  70      */
  71     virtual sp<IBinder> createDisplay() = 0;
  72
  73     /* get the token for the existing default displays. possible values
  74      * for id are eDisplayIdMain and eDisplayIdHdmi.
  75      */
  76     virtual sp<IBinder> getBuiltInDisplay(int32_t id) = 0;
  77
  78     /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
  79     virtual void setTransactionState(const Vector<ComposerState>& state,
  80             const Vector<DisplayState>& displays, uint32_t flags) = 0;
  81
  82     /* signal that we're done booting.
  83      * Requires ACCESS_SURFACE_FLINGER permission
  84      */
  85     virtual void bootFinished() = 0;
  86
  87     /* verify that an ISurfaceTexture was created by SurfaceFlinger.
  88      */
  89     virtual bool authenticateSurfaceTexture(
  90             const sp<ISurfaceTexture>& surface) const = 0;
  91
  92     /* Capture the specified screen. requires READ_FRAME_BUFFER permission
  93      * This function will fail if there is a secure window on screen.
  94      */
  95     virtual status_t captureScreen(DisplayID dpy, sp<IMemoryHeap>* heap,
  96             uint32_t* width, uint32_t* height, PixelFormat* format,
  97             uint32_t reqWidth, uint32_t reqHeight, uint32_t minLayerZ,
  98             uint32_t maxLayerZ) = 0;
  99
 100
 101     /* triggers screen off and waits for it to complete */
 102     virtual void blank() = 0;
 103
 104     /* triggers screen on and waits for it to complete */
 105     virtual void unblank() = 0;
 106
 107     /* returns information about a physical screen. This is intended to be
 108      * used by low-level native tests */
 109     virtual status_t getDisplayInfo(DisplayID dpy, DisplayInfo* info) = 0;
 110
 111     /* connects to an external display */
 112     virtual void connectDisplay(const sp<ISurfaceTexture> display) = 0;
 113 };
 114
 115 // ----------------------------------------------------------------------------
 116
 117 class BnSurfaceComposer: public BnInterface<ISurfaceComposer> {
 118 public:
 119     enum {
 120         // Note: BOOT_FINISHED must remain this value, it is called from
 121         // Java by ActivityManagerService.
 122         BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
 123         CREATE_CONNECTION,
 124         CREATE_GRAPHIC_BUFFER_ALLOC,
 125         CREATE_DISPLAY_EVENT_CONNECTION,
 126         CREATE_DISPLAY,
 127         GET_BUILT_IN_DISPLAY,
 128         SET_TRANSACTION_STATE,
 129         AUTHENTICATE_SURFACE,
 130         CAPTURE_SCREEN,
 131         BLANK,
 132         UNBLANK,
 133         GET_DISPLAY_INFO,
 134         CONNECT_DISPLAY,
 135     };
 136
 137     virtual status_t onTransact(uint32_t code, const Parcel& data,
 138             Parcel* reply, uint32_t flags = 0);
 139 };
 140
 141 // ----------------------------------------------------------------------------
 142
 143 }; // namespace android
 144
 145 #endif // ANDROID_GUI_ISURFACE_COMPOSER_H