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