• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 display
74      * requires ACCESS_SURFACE_FLINGER permission.
75      */
76     virtual sp<IBinder> createDisplay(const String8& displayName,
77             bool secure) = 0;
78 
79     /* get the token for the existing default displays. possible values
80      * for id are eDisplayIdMain and eDisplayIdHdmi.
81      */
82     virtual sp<IBinder> getBuiltInDisplay(int32_t id) = 0;
83 
84     /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
85     virtual void setTransactionState(const Vector<ComposerState>& state,
86             const Vector<DisplayState>& displays, uint32_t flags) = 0;
87 
88     /* signal that we're done booting.
89      * Requires ACCESS_SURFACE_FLINGER permission
90      */
91     virtual void bootFinished() = 0;
92 
93     /* verify that an IGraphicBufferProducer was created by SurfaceFlinger.
94      */
95     virtual bool authenticateSurfaceTexture(
96             const sp<IGraphicBufferProducer>& surface) const = 0;
97 
98     /* triggers screen off and waits for it to complete
99      * requires ACCESS_SURFACE_FLINGER permission.
100      */
101     virtual void blank(const sp<IBinder>& display) = 0;
102 
103     /* triggers screen on and waits for it to complete
104      * requires ACCESS_SURFACE_FLINGER permission.
105      */
106     virtual void unblank(const sp<IBinder>& display) = 0;
107 
108     /* returns information about a display
109      * intended to be used to get information about built-in displays */
110     virtual status_t getDisplayInfo(const sp<IBinder>& display, DisplayInfo* info) = 0;
111 
112     /* Capture the specified screen. requires READ_FRAME_BUFFER permission
113      * This function will fail if there is a secure window on screen.
114      */
115     virtual status_t captureScreen(const sp<IBinder>& display,
116             const sp<IGraphicBufferProducer>& producer,
117             uint32_t reqWidth, uint32_t reqHeight,
118             uint32_t minLayerZ, uint32_t maxLayerZ,
119             bool isCpuConsumer) = 0;
120 };
121 
122 // ----------------------------------------------------------------------------
123 
124 class BnSurfaceComposer: public BnInterface<ISurfaceComposer> {
125 public:
126     enum {
127         // Note: BOOT_FINISHED must remain this value, it is called from
128         // Java by ActivityManagerService.
129         BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
130         CREATE_CONNECTION,
131         CREATE_GRAPHIC_BUFFER_ALLOC,
132         CREATE_DISPLAY_EVENT_CONNECTION,
133         CREATE_DISPLAY,
134         GET_BUILT_IN_DISPLAY,
135         SET_TRANSACTION_STATE,
136         AUTHENTICATE_SURFACE,
137         BLANK,
138         UNBLANK,
139         GET_DISPLAY_INFO,
140         CONNECT_DISPLAY,
141         CAPTURE_SCREEN,
142     };
143 
144     virtual status_t onTransact(uint32_t code, const Parcel& data,
145             Parcel* reply, uint32_t flags = 0);
146 };
147 
148 // ----------------------------------------------------------------------------
149 
150 }; // namespace android
151 
152 #endif // ANDROID_GUI_ISURFACE_COMPOSER_H
153