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