DisplayDevice.h revision 766dc49c17dda977bf7b93a5fd8da41c0b737611 
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,
71            bool isSecure,
72            const wp<IBinder>& displayToken,
73            const sp<ANativeWindow>& nativeWindow,
74            const sp<FramebufferSurface>& framebufferSurface,
75            EGLConfig config);
76
77    ~DisplayDevice();
78
79    // whether this is a valid object. An invalid DisplayDevice is returned
80    // when an non existing id is requested
81    bool isValid() const;
82
83    // isSecure indicates whether this display can be trusted to display
84    // secure surfaces.
85    bool isSecure() const { return mIsSecure; }
86
87    // Flip the front and back buffers if the back buffer is "dirty".  Might
88    // be instantaneous, might involve copying the frame buffer around.
89    void flip(const Region& dirty) const;
90
91    int         getWidth() const;
92    int         getHeight() const;
93    PixelFormat getFormat() const;
94    uint32_t    getFlags() const;
95
96    EGLSurface  getEGLSurface() const;
97
98    void                    setVisibleLayersSortedByZ(const Vector< sp<LayerBase> >& layers);
99    const Vector< sp<LayerBase> >& getVisibleLayersSortedByZ() const;
100    bool                    getSecureLayerVisible() const;
101    Region                  getDirtyRegion(bool repaintEverything) const;
102
103    void                    setLayerStack(uint32_t stack);
104    void                    setProjection(int orientation, const Rect& viewport, const Rect& frame);
105
106    int                     getOrientation() const { return mOrientation; }
107    const Transform&        getTransform() const { return mGlobalTransform; }
108    const Rect&             getViewport() const { return mViewport; }
109    const Rect&             getFrame() const { return mFrame; }
110    const Rect&             getScissor() const { return mScissor; }
111    bool                    needsFiltering() const { return mNeedsFiltering; }
112
113    uint32_t                getLayerStack() const { return mLayerStack; }
114    int32_t                 getDisplayType() const { return mType; }
115    int32_t                 getHwcDisplayId() const { return mHwcDisplayId; }
116    const wp<IBinder>&      getDisplayToken() const { return mDisplayToken; }
117
118    void swapBuffers(HWComposer& hwc) const;
119    status_t compositionComplete() const;
120
121    // called after h/w composer has completed its set() call
122    void onSwapBuffersCompleted(HWComposer& hwc) const;
123
124    Rect getBounds() const {
125        return Rect(mDisplayWidth, mDisplayHeight);
126    }
127    inline Rect bounds() const { return getBounds(); }
128
129    void setDisplayName(const String8& displayName);
130    const String8& getDisplayName() const { return mDisplayName; }
131
132    static EGLBoolean makeCurrent(EGLDisplay dpy,
133            const sp<const DisplayDevice>& hw, EGLContext ctx);
134
135    static void setViewportAndProjection(const sp<const DisplayDevice>& hw);
136
137    /* ------------------------------------------------------------------------
138     * blank / unblank management
139     */
140    void releaseScreen() const;
141    void acquireScreen() const;
142    bool isScreenAcquired() const;
143    bool canDraw() const;
144
145    /* ------------------------------------------------------------------------
146     * Debugging
147     */
148    uint32_t getPageFlipCount() const;
149    void dump(String8& result, char* buffer, size_t SIZE) const;
150
151private:
152    void init(EGLConfig config);
153
154    /*
155     *  Constants, set during initialization
156     */
157    sp<SurfaceFlinger> mFlinger;
158    DisplayType mType;
159    int32_t mHwcDisplayId;
160    wp<IBinder> mDisplayToken;
161
162    // ANativeWindow this display is rendering into
163    sp<ANativeWindow> mNativeWindow;
164
165    // set if mNativeWindow is a FramebufferSurface
166    sp<FramebufferSurface> mFramebufferSurface;
167
168    EGLDisplay      mDisplay;
169    EGLSurface      mSurface;
170    EGLContext      mContext;
171    int             mDisplayWidth;
172    int             mDisplayHeight;
173    PixelFormat     mFormat;
174    uint32_t        mFlags;
175    mutable uint32_t mPageFlipCount;
176    String8         mDisplayName;
177    bool            mIsSecure;
178
179    /*
180     * Can only accessed from the main thread, these members
181     * don't need synchronization.
182     */
183
184    // list of visible layers on that display
185    Vector< sp<LayerBase> > mVisibleLayersSortedByZ;
186
187    // Whether we have a visible secure layer on this display
188    bool mSecureLayerVisible;
189
190    // Whether the screen is blanked;
191    mutable int mScreenAcquired;
192
193
194    /*
195     * Transaction state
196     */
197    static status_t orientationToTransfrom(int orientation,
198            int w, int h, Transform* tr);
199
200    void updateGeometryTransform();
201
202    uint32_t mLayerStack;
203    int mOrientation;
204    // user-provided visible area of the layer stack
205    Rect mViewport;
206    // user-provided rectangle where mViewport gets mapped to
207    Rect mFrame;
208    // pre-computed scissor to apply to the display
209    Rect mScissor;
210    Transform mGlobalTransform;
211    bool mNeedsFiltering;
212};
213
214}; // namespace android
215
216#endif // ANDROID_DISPLAY_DEVICE_H
217