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