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