DisplayDevice.h revision 1d12d8a8e61163b35cf42c51c558a67138014e82 
1/*
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
17#ifndef ANDROID_DISPLAY_DEVICE_H
18#define ANDROID_DISPLAY_DEVICE_H
19
20#include <stdlib.h>
21
22#include <ui/PixelFormat.h>
23#include <ui/Region.h>
24
25#include <EGL/egl.h>
26#include <EGL/eglext.h>
27
28#include <utils/Mutex.h>
29#include <utils/Timers.h>
30
31#include <hardware/hwcomposer_defs.h>
32
33#include "Transform.h"
34
35struct ANativeWindow;
36
37namespace android {
38
39class DisplayInfo;
40class FramebufferSurface;
41class LayerBase;
42class SurfaceFlinger;
43class HWComposer;
44
45class DisplayDevice : public LightRefBase<DisplayDevice>
46{
47public:
48    // region in layer-stack space
49    mutable Region dirtyRegion;
50    // region in screen space
51    mutable Region swapRegion;
52    // region in screen space
53    Region undefinedRegion;
54
55    enum DisplayType {
56        DISPLAY_ID_INVALID = -1,
57        DISPLAY_PRIMARY     = HWC_DISPLAY_PRIMARY,
58        DISPLAY_EXTERNAL    = HWC_DISPLAY_EXTERNAL,
59        NUM_DISPLAY_TYPES   = HWC_NUM_DISPLAY_TYPES,
60        DISPLAY_VIRTUAL     = HWC_NUM_DISPLAY_TYPES
61    };
62
63    enum {
64        PARTIAL_UPDATES = 0x00020000, // video driver feature
65        SWAP_RECTANGLE  = 0x00080000,
66    };
67
68    DisplayDevice(
69            const sp<SurfaceFlinger>& flinger,
70            DisplayType type, const wp<IBinder>& displayToken,
71            const sp<ANativeWindow>& nativeWindow,
72            const sp<FramebufferSurface>& framebufferSurface,
73            EGLConfig config);
74
75    ~DisplayDevice();
76
77    // whether this is a valid object. An invalid DisplayDevice is returned
78    // when an non existing id is requested
79    bool isValid() const;
80
81    // Flip the front and back buffers if the back buffer is "dirty".  Might
82    // be instantaneous, might involve copying the frame buffer around.
83    void flip(const Region& dirty) const;
84
85    int         getWidth() const;
86    int         getHeight() const;
87    PixelFormat getFormat() const;
88    uint32_t    getFlags() const;
89
90    EGLSurface  getEGLSurface() const;
91
92    void                    setVisibleLayersSortedByZ(const Vector< sp<LayerBase> >& layers);
93    const Vector< sp<LayerBase> >& getVisibleLayersSortedByZ() const;
94    bool                    getSecureLayerVisible() const;
95    Region                  getDirtyRegion(bool repaintEverything) const;
96
97    void                    setLayerStack(uint32_t stack);
98    void                    setProjection(int orientation, const Rect& viewport, const Rect& frame);
99
100    int                     getOrientation() const { return mOrientation; }
101    const Transform&        getTransform() const { return mGlobalTransform; }
102    const Rect&             getViewport() const { return mViewport; }
103    const Rect&             getFrame() const { return mFrame; }
104
105    uint32_t                getLayerStack() const { return mLayerStack; }
106    int32_t                 getDisplayType() const { return mType; }
107    int32_t                 getHwcDisplayId() const { return mHwcDisplayId; }
108    const wp<IBinder>&      getDisplayToken() const { return mDisplayToken; }
109
110    void swapBuffers(HWComposer& hwc) const;
111    status_t compositionComplete() const;
112
113    // called after h/w composer has completed its set() call
114    void onSwapBuffersCompleted(HWComposer& hwc) const;
115
116    Rect getBounds() const {
117        return Rect(mDisplayWidth, mDisplayHeight);
118    }
119    inline Rect bounds() const { return getBounds(); }
120
121    void setDisplayName(const String8& displayName) {
122        mDisplayName = displayName;
123    }
124    const String8& getDisplayName() const { return mDisplayName; }
125
126    static EGLBoolean makeCurrent(EGLDisplay dpy,
127            const sp<const DisplayDevice>& hw, EGLContext ctx);
128
129    /* ------------------------------------------------------------------------
130     * blank / unblank management
131     */
132    void releaseScreen() const;
133    void acquireScreen() const;
134    bool isScreenAcquired() const;
135    bool canDraw() const;
136
137    /* ------------------------------------------------------------------------
138     * Debugging
139     */
140    uint32_t getPageFlipCount() const;
141    void dump(String8& result, char* buffer, size_t SIZE) const;
142
143private:
144    void init(EGLConfig config);
145
146    /*
147     *  Constants, set during initialization
148     */
149    sp<SurfaceFlinger> mFlinger;
150    DisplayType mType;
151    int32_t mHwcDisplayId;
152    wp<IBinder> mDisplayToken;
153
154    // ANativeWindow this display is rendering into
155    sp<ANativeWindow> mNativeWindow;
156
157    // set if mNativeWindow is a FramebufferSurface
158    sp<FramebufferSurface> mFramebufferSurface;
159
160    EGLDisplay      mDisplay;
161    EGLSurface      mSurface;
162    EGLContext      mContext;
163    int             mDisplayWidth;
164    int             mDisplayHeight;
165    PixelFormat     mFormat;
166    uint32_t        mFlags;
167    mutable uint32_t mPageFlipCount;
168    String8         mDisplayName;
169
170    /*
171     * Can only accessed from the main thread, these members
172     * don't need synchronization.
173     */
174
175    // list of visible layers on that display
176    Vector< sp<LayerBase> > mVisibleLayersSortedByZ;
177
178    // Whether we have a visible secure layer on this display
179    bool mSecureLayerVisible;
180
181    // Whether the screen is blanked;
182    mutable int mScreenAcquired;
183
184
185    /*
186     * Transaction state
187     */
188    static status_t orientationToTransfrom(int orientation,
189            int w, int h, Transform* tr);
190
191    void updateGeometryTransform();
192
193    uint32_t mLayerStack;
194    int mOrientation;
195    Rect mViewport;
196    Rect mFrame;
197    Transform mGlobalTransform;
198};
199
200}; // namespace android
201
202#endif // ANDROID_DISPLAY_DEVICE_H
203