blob: 8226abec1c1331eeb7a629f502efb9cde2b1806b [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 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
Mathias Agopian000479f2010-02-09 17:46:37 -080017#ifndef ANDROID_SF_SURFACE_COMPOSER_CLIENT_H
18#define ANDROID_SF_SURFACE_COMPOSER_CLIENT_H
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080019
20#include <stdint.h>
21#include <sys/types.h>
22
Mathias Agopianbc726112009-09-23 15:44:05 -070023#include <binder/IBinder.h>
24
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025#include <utils/RefBase.h>
Mathias Agopian7623da42010-06-01 15:12:58 -070026#include <utils/Singleton.h>
27#include <utils/SortedVector.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028#include <utils/threads.h>
29
30#include <ui/PixelFormat.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080031#include <ui/Region.h>
Mathias Agopian000479f2010-02-09 17:46:37 -080032
33#include <surfaceflinger/Surface.h>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080034
35namespace android {
36
37// ---------------------------------------------------------------------------
38
Mathias Agopian000479f2010-02-09 17:46:37 -080039class DisplayInfo;
Mathias Agopian439863f2011-06-28 19:09:31 -070040class Composer;
Mathias Agopian7bb843c2011-04-20 14:20:59 -070041class IMemoryHeap;
42class ISurfaceComposer;
43class Region;
Mathias Agopian7623da42010-06-01 15:12:58 -070044class surface_flinger_cblk_t;
Mathias Agopian439863f2011-06-28 19:09:31 -070045struct layer_state_t;
Mathias Agopian7623da42010-06-01 15:12:58 -070046
47// ---------------------------------------------------------------------------
48
49class ComposerService : public Singleton<ComposerService>
50{
51 // these are constants
52 sp<ISurfaceComposer> mComposerService;
53 sp<IMemoryHeap> mServerCblkMemory;
54 surface_flinger_cblk_t volatile* mServerCblk;
55 ComposerService();
56 friend class Singleton<ComposerService>;
57public:
58 static sp<ISurfaceComposer> getComposerService();
59 static surface_flinger_cblk_t const volatile * getControlBlock();
60};
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080061
Mathias Agopianc7b388c2010-05-27 19:41:15 -070062// ---------------------------------------------------------------------------
63
Mathias Agopian439863f2011-06-28 19:09:31 -070064class Composer;
65
Mathias Agopianc7b388c2010-05-27 19:41:15 -070066class SurfaceComposerClient : public RefBase
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067{
Mathias Agopian439863f2011-06-28 19:09:31 -070068 friend class Composer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069public:
70 SurfaceComposerClient();
71 virtual ~SurfaceComposerClient();
72
73 // Always make sure we could initialize
74 status_t initCheck() const;
75
76 // Return the connection of this client
77 sp<IBinder> connection() const;
78
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080079 // Forcibly remove connection before all references have gone away.
80 void dispose();
81
82 // ------------------------------------------------------------------------
83 // surface creation / destruction
84
85 //! Create a surface
Mathias Agopian17f638b2009-04-16 20:04:08 -070086 sp<SurfaceControl> createSurface(
Mathias Agopian5d26c1e2010-03-01 16:09:43 -080087 const String8& name,// name of the surface
Mathias Agopian9779b222009-09-07 16:32:45 -070088 DisplayID display, // Display to create this surface on
89 uint32_t w, // width in pixel
90 uint32_t h, // height in pixel
91 PixelFormat format, // pixel-format desired
92 uint32_t flags = 0 // usage flags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080093 );
94
Mathias Agopian5d26c1e2010-03-01 16:09:43 -080095 sp<SurfaceControl> createSurface(
Mathias Agopian5d26c1e2010-03-01 16:09:43 -080096 DisplayID display, // Display to create this surface on
97 uint32_t w, // width in pixel
98 uint32_t h, // height in pixel
99 PixelFormat format, // pixel-format desired
100 uint32_t flags = 0 // usage flags
101 );
102
103
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800104 // ------------------------------------------------------------------------
105 // Composer parameters
106 // All composer parameters must be changed within a transaction
107 // several surfaces can be updated in one transaction, all changes are
108 // committed at once when the transaction is closed.
Mathias Agopian439863f2011-06-28 19:09:31 -0700109 // closeGlobalTransaction() usually requires an IPC with the server.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800110
111 //! Open a composer transaction on all active SurfaceComposerClients.
112 static void openGlobalTransaction();
113
114 //! Close a composer transaction on all active SurfaceComposerClients.
Jamie Gennis122aa6b2011-10-12 17:39:00 -0700115 static void closeGlobalTransaction(bool synchronous = false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800116
117 //! Freeze the specified display but not transactions.
118 static status_t freezeDisplay(DisplayID dpy, uint32_t flags = 0);
119
120 //! Resume updates on the specified display.
121 static status_t unfreezeDisplay(DisplayID dpy, uint32_t flags = 0);
122
123 //! Set the orientation of the given display
Mathias Agopianeb0c86e2009-03-27 18:11:38 -0700124 static int setOrientation(DisplayID dpy, int orientation, uint32_t flags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800125
126 // Query the number of displays
127 static ssize_t getNumberOfDisplays();
128
129 // Get information about a display
130 static status_t getDisplayInfo(DisplayID dpy, DisplayInfo* info);
131 static ssize_t getDisplayWidth(DisplayID dpy);
132 static ssize_t getDisplayHeight(DisplayID dpy);
133 static ssize_t getDisplayOrientation(DisplayID dpy);
134
Mathias Agopianbc726112009-09-23 15:44:05 -0700135 status_t linkToComposerDeath(const sp<IBinder::DeathRecipient>& recipient,
136 void* cookie = NULL, uint32_t flags = 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800137
Mathias Agopian6d2c0bc2009-04-16 16:19:50 -0700138 status_t hide(SurfaceID id);
139 status_t show(SurfaceID id, int32_t layer = -1);
140 status_t freeze(SurfaceID id);
141 status_t unfreeze(SurfaceID id);
142 status_t setFlags(SurfaceID id, uint32_t flags, uint32_t mask);
143 status_t setTransparentRegionHint(SurfaceID id, const Region& transparent);
144 status_t setLayer(SurfaceID id, int32_t layer);
145 status_t setAlpha(SurfaceID id, float alpha=1.0f);
146 status_t setFreezeTint(SurfaceID id, uint32_t tint);
147 status_t setMatrix(SurfaceID id, float dsdx, float dtdx, float dsdy, float dtdy);
Mathias Agopian34cb9f2a2011-08-30 18:51:54 -0700148 status_t setPosition(SurfaceID id, float x, float y);
Mathias Agopian6d2c0bc2009-04-16 16:19:50 -0700149 status_t setSize(SurfaceID id, uint32_t w, uint32_t h);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800150 status_t destroySurface(SurfaceID sid);
151
Mathias Agopian2ce19af2010-05-25 17:51:34 -0700152private:
Mathias Agopianc7b388c2010-05-27 19:41:15 -0700153 virtual void onFirstRef();
Mathias Agopian439863f2011-06-28 19:09:31 -0700154 Composer& getComposer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800155
Mathias Agopian439863f2011-06-28 19:09:31 -0700156 mutable Mutex mLock;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800157 status_t mStatus;
Mathias Agopian770492c2010-05-28 14:22:23 -0700158 sp<ISurfaceComposerClient> mClient;
Mathias Agopian439863f2011-06-28 19:09:31 -0700159 Composer& mComposer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800160};
161
Mathias Agopianc7b388c2010-05-27 19:41:15 -0700162// ---------------------------------------------------------------------------
Mathias Agopian38ed2e32010-09-29 13:02:36 -0700163
164class ScreenshotClient
165{
166 sp<IMemoryHeap> mHeap;
167 uint32_t mWidth;
168 uint32_t mHeight;
169 PixelFormat mFormat;
170public:
171 ScreenshotClient();
172
173 // frees the previous screenshot and capture a new one
174 status_t update();
175 status_t update(uint32_t reqWidth, uint32_t reqHeight);
Mathias Agopian3dd25a62010-12-10 16:22:31 -0800176 status_t update(uint32_t reqWidth, uint32_t reqHeight,
177 uint32_t minLayerZ, uint32_t maxLayerZ);
Mathias Agopian38ed2e32010-09-29 13:02:36 -0700178
179 // release memory occupied by the screenshot
180 void release();
181
182 // pixels are valid until this object is freed or
183 // release() or update() is called
184 void const* getPixels() const;
185
186 uint32_t getWidth() const;
187 uint32_t getHeight() const;
188 PixelFormat getFormat() const;
189 uint32_t getStride() const;
190 // size of allocated memory in bytes
191 size_t getSize() const;
192};
193
194// ---------------------------------------------------------------------------
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800195}; // namespace android
196
Mathias Agopian000479f2010-02-09 17:46:37 -0800197#endif // ANDROID_SF_SURFACE_COMPOSER_CLIENT_H