DisplayDevice.h revision 028dc8f2d72bc7cd4fbe7808781443125a742f78 
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 DisplaySurface;
41class IGraphicBufferProducer;
42class Layer;
43class SurfaceFlinger;
44class HWComposer;
45
46class DisplayDevice : public LightRefBase<DisplayDevice>
47{
48public:
49    // region in layer-stack space
50    mutable Region dirtyRegion;
51    // region in screen space
52    mutable Region swapRegion;
53    // region in screen space
54    Region undefinedRegion;
55
56    enum DisplayType {
57        DISPLAY_ID_INVALID = -1,
58        DISPLAY_PRIMARY     = HWC_DISPLAY_PRIMARY,
59        DISPLAY_EXTERNAL    = HWC_DISPLAY_EXTERNAL,
60        DISPLAY_VIRTUAL     = HWC_DISPLAY_VIRTUAL,
61        NUM_BUILTIN_DISPLAY_TYPES = HWC_NUM_PHYSICAL_DISPLAY_TYPES,
62    };
63
64    enum {
65        PARTIAL_UPDATES = 0x00020000, // video driver feature
66        SWAP_RECTANGLE  = 0x00080000,
67    };
68
69    enum {
70        NO_LAYER_STACK = 0xFFFFFFFF,
71    };
72
73    DisplayDevice(
74            const sp<SurfaceFlinger>& flinger,
75            DisplayType type,
76            int32_t hwcId,  // negative for non-HWC-composited displays
77            bool isSecure,
78            const wp<IBinder>& displayToken,
79            const sp<DisplaySurface>& displaySurface,
80            const sp<IGraphicBufferProducer>& producer,
81            EGLConfig config);
82
83    ~DisplayDevice();
84
85    // whether this is a valid object. An invalid DisplayDevice is returned
86    // when an non existing id is requested
87    bool isValid() const;
88
89    // isSecure indicates whether this display can be trusted to display
90    // secure surfaces.
91    bool isSecure() const { return mIsSecure; }
92
93    // Flip the front and back buffers if the back buffer is "dirty".  Might
94    // be instantaneous, might involve copying the frame buffer around.
95    void flip(const Region& dirty) const;
96
97    int         getWidth() const;
98    int         getHeight() const;
99    PixelFormat getFormat() const;
100    uint32_t    getFlags() const;
101
102    EGLSurface  getEGLSurface() const;
103
104    void                    setVisibleLayersSortedByZ(const Vector< sp<Layer> >& layers);
105    const Vector< sp<Layer> >& getVisibleLayersSortedByZ() const;
106    bool                    getSecureLayerVisible() const;
107    Region                  getDirtyRegion(bool repaintEverything) const;
108
109    void                    setLayerStack(uint32_t stack);
110    void                    setProjection(int orientation, const Rect& viewport, const Rect& frame);
111
112    int                     getOrientation() const { return mOrientation; }
113    const Transform&        getTransform() const { return mGlobalTransform; }
114    const Rect              getViewport() const { return mViewport; }
115    const Rect              getFrame() const { return mFrame; }
116    const Rect&             getScissor() const { return mScissor; }
117    bool                    needsFiltering() const { return mNeedsFiltering; }
118
119    uint32_t                getLayerStack() const { return mLayerStack; }
120    int32_t                 getDisplayType() const { return mType; }
121    int32_t                 getHwcDisplayId() const { return mHwcDisplayId; }
122    const wp<IBinder>&      getDisplayToken() const { return mDisplayToken; }
123
124    status_t beginFrame() const;
125    status_t prepareFrame(const HWComposer& hwc) const;
126
127    void swapBuffers(HWComposer& hwc) const;
128    status_t compositionComplete() const;
129
130    // called after h/w composer has completed its set() call
131    void onSwapBuffersCompleted(HWComposer& hwc) const;
132
133    Rect getBounds() const {
134        return Rect(mDisplayWidth, mDisplayHeight);
135    }
136    inline Rect bounds() const { return getBounds(); }
137
138    void setDisplayName(const String8& displayName);
139    const String8& getDisplayName() const { return mDisplayName; }
140
141    EGLBoolean makeCurrent(EGLDisplay dpy, EGLContext ctx) const;
142    void setViewportAndProjection() const;
143
144    /* ------------------------------------------------------------------------
145     * blank / unblank management
146     */
147    void releaseScreen() const;
148    void acquireScreen() const;
149    bool isScreenAcquired() const;
150    bool canDraw() const;
151
152    // release HWC resources (if any) for removable displays
153    void disconnect(HWComposer& hwc);
154
155    /* ------------------------------------------------------------------------
156     * Debugging
157     */
158    uint32_t getPageFlipCount() const;
159    void dump(String8& result) const;
160
161private:
162    /*
163     *  Constants, set during initialization
164     */
165    sp<SurfaceFlinger> mFlinger;
166    DisplayType mType;
167    int32_t mHwcDisplayId;
168    wp<IBinder> mDisplayToken;
169
170    // ANativeWindow this display is rendering into
171    sp<ANativeWindow> mNativeWindow;
172    sp<DisplaySurface> mDisplaySurface;
173
174    EGLDisplay      mDisplay;
175    EGLSurface      mSurface;
176    int             mDisplayWidth;
177    int             mDisplayHeight;
178    PixelFormat     mFormat;
179    uint32_t        mFlags;
180    mutable uint32_t mPageFlipCount;
181    String8         mDisplayName;
182    bool            mIsSecure;
183
184    /*
185     * Can only accessed from the main thread, these members
186     * don't need synchronization.
187     */
188
189    // list of visible layers on that display
190    Vector< sp<Layer> > mVisibleLayersSortedByZ;
191
192    // Whether we have a visible secure layer on this display
193    bool mSecureLayerVisible;
194
195    // Whether the screen is blanked;
196    mutable int mScreenAcquired;
197
198
199    /*
200     * Transaction state
201     */
202    static status_t orientationToTransfrom(int orientation,
203            int w, int h, Transform* tr);
204
205    uint32_t mLayerStack;
206    int mOrientation;
207    // user-provided visible area of the layer stack
208    Rect mViewport;
209    // user-provided rectangle where mViewport gets mapped to
210    Rect mFrame;
211    // pre-computed scissor to apply to the display
212    Rect mScissor;
213    Transform mGlobalTransform;
214    bool mNeedsFiltering;
215};
216
217}; // namespace android
218
219#endif // ANDROID_DISPLAY_DEVICE_H
220