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