ISurfaceComposer.h revision 90ac799241f077a7b7e6c1875fd933864c8dd2a7 
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        eFreezeTintChanged          = 0x00000080,
70    };
71
72    enum {
73        eLayerHidden        = 0x01,
74        eLayerFrozen        = 0x02,
75        eLayerDither        = 0x04,
76        eLayerFilter        = 0x08,
77        eLayerBlurFreeze    = 0x10
78    };
79
80    enum {
81        eOrientationDefault     = 0,
82        eOrientation90          = 1,
83        eOrientation180         = 2,
84        eOrientation270         = 3,
85        eOrientationUnchanged   = 4,
86        eOrientationSwapMask    = 0x01
87    };
88
89    enum {
90        eSynchronous            = 0x01,
91    };
92
93    enum {
94        eElectronBeamAnimationOn  = 0x01,
95        eElectronBeamAnimationOff = 0x10
96    };
97
98    /* create connection with surface flinger, requires
99     * ACCESS_SURFACE_FLINGER permission
100     */
101    virtual sp<ISurfaceComposerClient> createConnection() = 0;
102
103    /* create a graphic buffer allocator
104     */
105    virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc() = 0;
106
107    /* retrieve the control block */
108    virtual sp<IMemoryHeap> getCblk() const = 0;
109
110    /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
111    virtual void setTransactionState(const Vector<ComposerState>& state,
112            int orientation, 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
143// ----------------------------------------------------------------------------
144
145class BnSurfaceComposer : public BnInterface<ISurfaceComposer>
146{
147public:
148    enum {
149        // Note: BOOT_FINISHED must remain this value, it is called from
150        // Java by ActivityManagerService.
151        BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
152        CREATE_CONNECTION,
153        CREATE_GRAPHIC_BUFFER_ALLOC,
154        GET_CBLK,
155        SET_TRANSACTION_STATE,
156        SET_ORIENTATION,
157        CAPTURE_SCREEN,
158        TURN_ELECTRON_BEAM_OFF,
159        TURN_ELECTRON_BEAM_ON,
160        AUTHENTICATE_SURFACE,
161        CREATE_DISPLAY_EVENT_CONNECTION,
162    };
163
164    virtual status_t    onTransact( uint32_t code,
165                                    const Parcel& data,
166                                    Parcel* reply,
167                                    uint32_t flags = 0);
168};
169
170// ----------------------------------------------------------------------------
171
172}; // namespace android
173
174#endif // ANDROID_GUI_ISURFACE_COMPOSER_H
175