HWComposer.h revision db27621e22559a1b16414f890677ef04242fbc3b 
1/*
2 * Copyright (C) 2010 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_SF_HWCOMPOSER_H
18#define ANDROID_SF_HWCOMPOSER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <hardware/hwcomposer_defs.h>
24
25#include <utils/Condition.h>
26#include <utils/Mutex.h>
27#include <utils/StrongPointer.h>
28#include <utils/Thread.h>
29#include <utils/Timers.h>
30#include <utils/Vector.h>
31#include <utils/BitSet.h>
32
33extern "C" int clock_nanosleep(clockid_t clock_id, int flags,
34                           const struct timespec *request,
35                           struct timespec *remain);
36
37struct hwc_composer_device_1;
38struct hwc_display_contents_1;
39struct hwc_procs;
40struct framebuffer_device_t;
41
42namespace android {
43// ---------------------------------------------------------------------------
44
45class GraphicBuffer;
46class LayerBase;
47class Region;
48class String8;
49class SurfaceFlinger;
50
51class HWComposer
52{
53public:
54    class EventHandler {
55        friend class HWComposer;
56        virtual void onVSyncReceived(int disp, nsecs_t timestamp) = 0;
57    protected:
58        virtual ~EventHandler() {}
59    };
60
61    enum {
62        MAX_DISPLAYS = HWC_NUM_DISPLAY_TYPES + 1
63    };
64
65    HWComposer(
66            const sp<SurfaceFlinger>& flinger,
67            EventHandler& handler);
68
69    ~HWComposer();
70
71    status_t initCheck() const;
72
73    // returns a display ID starting at MAX_DISPLAYS, this ID
74    // is to be used with createWorkList (and all other
75    // methods requiring an ID below).
76    // IDs below MAX_DISPLAY are pre-defined and therefore are always valid.
77    // returns a negative error code if an ID cannot be allocated
78    int32_t allocateDisplayId();
79
80    // recycles the given ID and frees the associated worklist.
81    // IDs below MAX_DISPLAYS are not recycled
82    status_t freeDisplayId(int32_t id);
83
84
85    // Asks the HAL what it can do
86    status_t prepare();
87
88    // commits the list
89    status_t commit();
90
91    // release hardware resources and blank screen
92    status_t release() const;
93
94    // acquire hardware resources and unblank screen
95    status_t acquire() const;
96
97    // create a work list for numLayers layer. sets HWC_GEOMETRY_CHANGED.
98    status_t createWorkList(int32_t id, size_t numLayers);
99
100    // does this display have layers handled by HWC
101    bool hasHwcComposition(int32_t id) const;
102
103    // does this display have layers handled by GLES
104    bool hasGlesComposition(int32_t id) const;
105
106    // needed forward declarations
107    class LayerListIterator;
108
109    // Forwarding to FB HAL for pre-HWC-1.1 code (see FramebufferSurface).
110    int fbPost(buffer_handle_t buffer);
111    int fbCompositionComplete();
112    void fbDump(String8& result);
113
114    /*
115     * Interface to hardware composer's layers functionality.
116     * This abstracts the HAL interface to layers which can evolve in
117     * incompatible ways from one release to another.
118     * The idea is that we could extend this interface as we add
119     * features to h/w composer.
120     */
121    class HWCLayerInterface {
122    protected:
123        virtual ~HWCLayerInterface() { }
124    public:
125        virtual int32_t getCompositionType() const = 0;
126        virtual uint32_t getHints() const = 0;
127        virtual int getAndResetReleaseFenceFd() = 0;
128        virtual void setDefaultState() = 0;
129        virtual void setSkip(bool skip) = 0;
130        virtual void setBlending(uint32_t blending) = 0;
131        virtual void setTransform(uint32_t transform) = 0;
132        virtual void setFrame(const Rect& frame) = 0;
133        virtual void setCrop(const Rect& crop) = 0;
134        virtual void setVisibleRegionScreen(const Region& reg) = 0;
135        virtual void setBuffer(const sp<GraphicBuffer>& buffer) = 0;
136        virtual void setAcquireFenceFd(int fenceFd) = 0;
137        virtual void onDisplayed() = 0;
138    };
139
140    /*
141     * Interface used to implement an iterator to a list
142     * of HWCLayer.
143     */
144    class HWCLayer : public HWCLayerInterface {
145        friend class LayerListIterator;
146        // select the layer at the given index
147        virtual status_t setLayer(size_t index) = 0;
148        virtual HWCLayer* dup() = 0;
149        static HWCLayer* copy(HWCLayer *rhs) {
150            return rhs ? rhs->dup() : NULL;
151        }
152    protected:
153        virtual ~HWCLayer() { }
154    };
155
156    /*
157     * Iterator through a HWCLayer list.
158     * This behaves more or less like a forward iterator.
159     */
160    class LayerListIterator {
161        friend struct HWComposer;
162        HWCLayer* const mLayerList;
163        size_t mIndex;
164
165        LayerListIterator() : mLayerList(NULL), mIndex(0) { }
166
167        LayerListIterator(HWCLayer* layer, size_t index)
168            : mLayerList(layer), mIndex(index) { }
169
170        // we don't allow assignment, because we don't need it for now
171        LayerListIterator& operator = (const LayerListIterator& rhs);
172
173    public:
174        // copy operators
175        LayerListIterator(const LayerListIterator& rhs)
176            : mLayerList(HWCLayer::copy(rhs.mLayerList)), mIndex(rhs.mIndex) {
177        }
178
179        ~LayerListIterator() { delete mLayerList; }
180
181        // pre-increment
182        LayerListIterator& operator++() {
183            mLayerList->setLayer(++mIndex);
184            return *this;
185        }
186
187        // dereference
188        HWCLayerInterface& operator * () { return *mLayerList; }
189        HWCLayerInterface* operator -> () { return mLayerList; }
190
191        // comparison
192        bool operator == (const LayerListIterator& rhs) const {
193            return mIndex == rhs.mIndex;
194        }
195        bool operator != (const LayerListIterator& rhs) const {
196            return !operator==(rhs);
197        }
198    };
199
200    // Returns an iterator to the beginning of the layer list
201    LayerListIterator begin(int32_t id);
202
203    // Returns an iterator to the end of the layer list
204    LayerListIterator end(int32_t id);
205
206
207    // Events handling ---------------------------------------------------------
208
209    enum {
210        EVENT_VSYNC = HWC_EVENT_VSYNC
211    };
212
213    void eventControl(int event, int enabled);
214
215    // Query display parameters.  Pass in a display index (e.g.
216    // HWC_DISPLAY_PRIMARY).
217    nsecs_t getRefreshPeriod(int disp) const;
218    nsecs_t getRefreshTimestamp(int disp) const;
219    uint32_t getWidth(int disp) const;
220    uint32_t getHeight(int disp) const;
221    uint32_t getFormat(int disp) const;
222    float getDpiX(int disp) const;
223    float getDpiY(int disp) const;
224
225    // this class is only used to fake the VSync event on systems that don't
226    // have it.
227    class VSyncThread : public Thread {
228        HWComposer& mHwc;
229        mutable Mutex mLock;
230        Condition mCondition;
231        bool mEnabled;
232        mutable nsecs_t mNextFakeVSync;
233        nsecs_t mRefreshPeriod;
234        virtual void onFirstRef();
235        virtual bool threadLoop();
236    public:
237        VSyncThread(HWComposer& hwc);
238        void setEnabled(bool enabled);
239    };
240
241    friend class VSyncThread;
242
243    // for debugging ----------------------------------------------------------
244    void dump(String8& out, char* scratch, size_t SIZE,
245            const Vector< sp<LayerBase> >& visibleLayersSortedByZ) const;
246
247private:
248    void loadHwcModule();
249    void loadFbHalModule();
250
251    LayerListIterator getLayerIterator(int32_t id, size_t index);
252    size_t getNumLayers(int32_t id) const;
253
254    struct cb_context;
255
256    static void hook_invalidate(const struct hwc_procs* procs);
257    static void hook_vsync(const struct hwc_procs* procs, int disp,
258            int64_t timestamp);
259    static void hook_hotplug(const struct hwc_procs* procs, int disp,
260            int connected);
261
262    inline void invalidate();
263    inline void vsync(int disp, int64_t timestamp);
264    inline void hotplug(int disp, int connected);
265
266    void queryDisplayProperties(int disp);
267
268    struct DisplayData {
269        DisplayData() : xdpi(0), ydpi(0), refresh(0),
270            hasFbComp(false), hasOvComp(false),
271            capacity(0), list(NULL) { }
272        ~DisplayData() {
273            free(list);
274        }
275        uint32_t width;
276        uint32_t height;
277        uint32_t format;    // pixel format from FB hal, for pre-hwc-1.1
278        float xdpi;
279        float ydpi;
280        nsecs_t refresh;
281        bool hasFbComp;
282        bool hasOvComp;
283        size_t capacity;
284        hwc_display_contents_1* list;
285    };
286
287    sp<SurfaceFlinger>              mFlinger;
288    framebuffer_device_t*           mFbDev;
289    struct hwc_composer_device_1*   mHwc;
290    // invariant: mLists[0] != NULL iff mHwc != NULL
291    // mLists[i>0] can be NULL. that display is to be ignored
292    struct hwc_display_contents_1*  mLists[MAX_DISPLAYS];
293    DisplayData                     mDisplayData[MAX_DISPLAYS];
294    size_t                          mNumDisplays;
295
296    cb_context*                     mCBContext;
297    EventHandler&                   mEventHandler;
298    size_t                          mVSyncCount;
299    sp<VSyncThread>                 mVSyncThread;
300    bool                            mDebugForceFakeVSync;
301    BitSet32                        mAllocatedDisplayIDs;
302
303    // protected by mLock
304    mutable Mutex mLock;
305    mutable nsecs_t mLastHwVSync;
306};
307
308// ---------------------------------------------------------------------------
309}; // namespace android
310
311#endif // ANDROID_SF_HWCOMPOSER_H
312