Layer.h revision 1b03149f3533db04e72e088d3fdd09d0087ca594 
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(HWComposer::HWCLayerInterface& layer);
68    virtual void setPerFrameData(HWComposer::HWCLayerInterface& layer);
69    virtual void onDraw(const DisplayHardware& hw, const Region& clip) const;
70    virtual uint32_t doTransaction(uint32_t transactionFlags);
71    virtual void lockPageFlip(bool& recomputeVisibleRegions);
72    virtual void unlockPageFlip(const Transform& planeTransform, Region& outDirtyRegion);
73    virtual bool isOpaque() const;
74    virtual bool isSecure() const           { return mSecure; }
75    virtual bool isProtected() const;
76    virtual void onRemoved();
77    virtual sp<Layer> getLayer() const { return const_cast<Layer*>(this); }
78    virtual void setName(const String8& name);
79    virtual void validateVisibility(const Transform& globalTransform, const DisplayHardware& hw);
80
81    // LayerBaseClient interface
82    virtual wp<IBinder> getSurfaceTextureBinder() const;
83
84    virtual void onLayerDisplayed(HWComposer::HWCLayerInterface* layer);
85    virtual bool onPreComposition();
86
87    // only for debugging
88    inline const sp<GraphicBuffer>& getActiveBuffer() const { return mActiveBuffer; }
89
90protected:
91    virtual void onFirstRef();
92    virtual void dump(String8& result, char* scratch, size_t size) const;
93    virtual void dumpStats(String8& result, char* buffer, size_t SIZE) const;
94    virtual void clearStats();
95
96private:
97    friend class SurfaceTextureLayer;
98    void onFrameQueued();
99    virtual sp<ISurface> createSurface();
100    uint32_t getEffectiveUsage(uint32_t usage) const;
101    uint32_t getTransformHint() const;
102    bool isCropped() const;
103    Rect computeBufferCrop() const;
104    static bool getOpacityForFormat(uint32_t format);
105
106    // -----------------------------------------------------------------------
107
108    // constants
109    sp<SurfaceTexture> mSurfaceTexture;
110    GLuint mTextureName;
111
112    // thread-safe
113    volatile int32_t mQueuedFrames;
114
115    // main thread
116    sp<GraphicBuffer> mActiveBuffer;
117    Rect mCurrentCrop;
118    uint32_t mCurrentTransform;
119    uint32_t mCurrentScalingMode;
120    bool mCurrentOpacity;
121    bool mRefreshPending;
122    bool mFrameLatencyNeeded;
123    int mFrameLatencyOffset;
124
125    struct Statistics {
126        Statistics() : timestamp(0), set(0), vsync(0) { }
127        nsecs_t timestamp;  // buffer timestamp
128        nsecs_t set;        // buffer displayed timestamp
129        nsecs_t vsync;      // vsync immediately before set
130    };
131
132    // protected by mLock
133    Statistics mFrameStats[128];
134
135    // constants
136    PixelFormat mFormat;
137    const GLExtensions& mGLExtensions;
138    bool mOpaqueLayer;
139
140    // page-flip thread (currently main thread)
141    bool mSecure;         // no screenshots
142    bool mProtectedByApp; // application requires protected path to external sink
143    Region mPostedDirtyRegion;
144};
145
146// ---------------------------------------------------------------------------
147
148}; // namespace android
149
150#endif // ANDROID_LAYER_H
151