Layer.h revision 4297734c1156fd8ede7e9c61b1e439f9e1c18cd9 
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_LAYER_H
18#define ANDROID_LAYER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <gui/SurfaceTexture.h>
24
25#include <utils/Timers.h>
26
27#include <ui/GraphicBuffer.h>
28#include <ui/PixelFormat.h>
29
30#include <gui/ISurfaceComposerClient.h>
31
32#include <EGL/egl.h>
33#include <EGL/eglext.h>
34#include <GLES/gl.h>
35#include <GLES/glext.h>
36
37#include "LayerBase.h"
38#include "SurfaceTextureLayer.h"
39#include "Transform.h"
40
41namespace android {
42
43// ---------------------------------------------------------------------------
44
45class Client;
46class GLExtensions;
47
48// ---------------------------------------------------------------------------
49
50class Layer : public LayerBaseClient
51{
52public:
53            Layer(SurfaceFlinger* flinger, DisplayID display,
54                    const sp<Client>& client);
55
56    virtual ~Layer();
57
58    virtual const char* getTypeId() const { return "Layer"; }
59
60    // the this layer's size and format
61    status_t setBuffers(uint32_t w, uint32_t h,
62            PixelFormat format, uint32_t flags=0);
63
64    bool isFixedSize() const;
65
66    // LayerBase interface
67    virtual void setGeometry(const sp<const DisplayDevice>& hw,
68            HWComposer::HWCLayerInterface& layer);
69    virtual void setPerFrameData(const sp<const DisplayDevice>& hw,
70            HWComposer::HWCLayerInterface& layer);
71    virtual void setAcquireFence(const sp<const DisplayDevice>& hw,
72            HWComposer::HWCLayerInterface& layer);
73    virtual void onLayerDisplayed(const sp<const DisplayDevice>& hw,
74            HWComposer::HWCLayerInterface* layer);
75    virtual bool onPreComposition();
76    virtual void onPostComposition();
77
78    virtual void onDraw(const sp<const DisplayDevice>& hw, const Region& clip) const;
79    virtual uint32_t doTransaction(uint32_t transactionFlags);
80    virtual Region latchBuffer(bool& recomputeVisibleRegions);
81    virtual bool isOpaque() const;
82    virtual bool isSecure() const           { return mSecure; }
83    virtual bool isProtected() const;
84    virtual void onRemoved();
85    virtual sp<Layer> getLayer() const { return const_cast<Layer*>(this); }
86    virtual void setName(const String8& name);
87
88    // LayerBaseClient interface
89    virtual wp<IBinder> getSurfaceTextureBinder() const;
90
91    // only for debugging
92    inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; }
93
94protected:
95    virtual void onFirstRef();
96    virtual void dump(String8& result, char* scratch, size_t size) const;
97    virtual void dumpStats(String8& result, char* buffer, size_t SIZE) const;
98    virtual void clearStats();
99
100private:
101    friend class SurfaceTextureLayer;
102    void onFrameQueued();
103    virtual sp<ISurface> createSurface();
104    uint32_t getEffectiveUsage(uint32_t usage) const;
105    uint32_t getTransformHint() const;
106    bool isCropped() const;
107    Rect computeBufferCrop() const;
108    static bool getOpacityForFormat(uint32_t format);
109
110    // -----------------------------------------------------------------------
111
112    // constants
113    sp<SurfaceTexture> mSurfaceTexture;
114    GLuint mTextureName;
115
116    // thread-safe
117    volatile int32_t mQueuedFrames;
118
119    // main thread
120    sp<GraphicBuffer> mActiveBuffer;
121    Rect mCurrentCrop;
122    uint32_t mCurrentTransform;
123    uint32_t mCurrentScalingMode;
124    bool mCurrentOpacity;
125    bool mRefreshPending;
126    bool mFrameLatencyNeeded;
127    int mFrameLatencyOffset;
128
129    struct Statistics {
130        Statistics() : timestamp(0), set(0), vsync(0) { }
131        nsecs_t timestamp;  // buffer timestamp
132        nsecs_t set;        // buffer displayed timestamp
133        nsecs_t vsync;      // vsync immediately before set
134    };
135
136    // protected by mLock
137    Statistics mFrameStats[128];
138
139    // constants
140    PixelFormat mFormat;
141    const GLExtensions& mGLExtensions;
142    bool mOpaqueLayer;
143
144    // page-flip thread (currently main thread)
145    bool mSecure;         // no screenshots
146    bool mProtectedByApp; // application requires protected path to external sink
147};
148
149// ---------------------------------------------------------------------------
150
151}; // namespace android
152
153#endif // ANDROID_LAYER_H
154