CanvasContext.h revision 11f02d7e522ec8742f7ef533c252e04e24b93f6b 
1/*
2 * Copyright (C) 2014 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 CANVASCONTEXT_H_
18#define CANVASCONTEXT_H_
19
20#include "DamageAccumulator.h"
21#include "FrameInfo.h"
22#include "FrameInfoVisualizer.h"
23#include "FrameMetricsReporter.h"
24#include "IContextFactory.h"
25#include "LayerUpdateQueue.h"
26#include "RenderNode.h"
27#include "utils/RingBuffer.h"
28#include "renderthread/RenderTask.h"
29#include "renderthread/RenderThread.h"
30
31#if HWUI_NEW_OPS
32#include "BakedOpDispatcher.h"
33#include "BakedOpRenderer.h"
34#include "FrameBuilder.h"
35#endif
36
37#include <cutils/compiler.h>
38#include <EGL/egl.h>
39#include <SkBitmap.h>
40#include <SkRect.h>
41#include <utils/Functor.h>
42#include <gui/Surface.h>
43
44#include <set>
45#include <string>
46#include <vector>
47
48namespace android {
49namespace uirenderer {
50
51class AnimationContext;
52class DeferredLayerUpdater;
53class OpenGLRenderer;
54class Rect;
55class Layer;
56class RenderState;
57
58namespace renderthread {
59
60class EglManager;
61
62enum SwapBehavior {
63    kSwap_default,
64    kSwap_discardBuffer,
65};
66
67// This per-renderer class manages the bridge between the global EGL context
68// and the render surface.
69// TODO: Rename to Renderer or some other per-window, top-level manager
70class CanvasContext : public IFrameCallback {
71public:
72    CanvasContext(RenderThread& thread, bool translucent, RenderNode* rootRenderNode,
73            IContextFactory* contextFactory);
74    virtual ~CanvasContext();
75
76    // Won't take effect until next EGLSurface creation
77    void setSwapBehavior(SwapBehavior swapBehavior);
78
79    void initialize(Surface* surface);
80    void updateSurface(Surface* surface);
81    bool pauseSurface(Surface* surface);
82    bool hasSurface() { return mNativeSurface.get(); }
83
84    void setup(int width, int height, float lightRadius,
85            uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha);
86    void setLightCenter(const Vector3& lightCenter);
87    void setOpaque(bool opaque);
88    void makeCurrent();
89    void prepareTree(TreeInfo& info, int64_t* uiFrameInfo,
90            int64_t syncQueued, RenderNode* target);
91    void draw();
92    void destroy();
93
94    // IFrameCallback, Choreographer-driven frame callback entry point
95    virtual void doFrame() override;
96    void prepareAndDraw(RenderNode* node);
97
98    void buildLayer(RenderNode* node);
99    bool copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap);
100    void markLayerInUse(RenderNode* node);
101
102    void destroyHardwareResources();
103    static void trimMemory(RenderThread& thread, int level);
104
105    static void invokeFunctor(RenderThread& thread, Functor* functor);
106
107    void runWithGlContext(RenderTask* task);
108
109    Layer* createTextureLayer();
110
111    ANDROID_API static void setTextureAtlas(RenderThread& thread,
112            const sp<GraphicBuffer>& buffer, int64_t* map, size_t mapSize);
113
114    void stopDrawing();
115    void notifyFramePending();
116
117    FrameInfoVisualizer& profiler() { return mProfiler; }
118
119    void dumpFrames(int fd);
120    void resetFrameStats();
121
122    void setName(const std::string&& name) { mName = name; }
123    const std::string& name() { return mName; }
124
125    void serializeDisplayListTree();
126
127    void addRenderNode(RenderNode* node, bool placeFront) {
128        int pos = placeFront ? 0 : static_cast<int>(mRenderNodes.size());
129        mRenderNodes.emplace(mRenderNodes.begin() + pos, node);
130    }
131
132    void removeRenderNode(RenderNode* node) {
133        mRenderNodes.erase(std::remove(mRenderNodes.begin(), mRenderNodes.end(), node),
134                mRenderNodes.end());
135    }
136
137    void setContentDrawBounds(int left, int top, int right, int bottom) {
138        mContentDrawBounds.set(left, top, right, bottom);
139    }
140
141    RenderState& getRenderState() {
142        return mRenderThread.renderState();
143    }
144
145    void addFrameMetricsObserver(FrameMetricsObserver* observer) {
146        if (mFrameMetricsReporter.get() == nullptr) {
147            mFrameMetricsReporter.reset(new FrameMetricsReporter());
148        }
149
150        mFrameMetricsReporter->addObserver(observer);
151    }
152
153    void removeFrameMetricsObserver(FrameMetricsObserver* observer) {
154        if (mFrameMetricsReporter.get() != nullptr) {
155            mFrameMetricsReporter->removeObserver(observer);
156            if (!mFrameMetricsReporter->hasObservers()) {
157                mFrameMetricsReporter.reset(nullptr);
158            }
159        }
160    }
161
162private:
163    friend class RegisterFrameCallbackTask;
164    // TODO: Replace with something better for layer & other GL object
165    // lifecycle tracking
166    friend class android::uirenderer::RenderState;
167
168    void setSurface(Surface* window);
169    void requireSurface();
170
171    void freePrefetechedLayers();
172
173    EGLint mLastFrameWidth = 0;
174    EGLint mLastFrameHeight = 0;
175
176    RenderThread& mRenderThread;
177    EglManager& mEglManager;
178    sp<Surface> mNativeSurface;
179    EGLSurface mEglSurface = EGL_NO_SURFACE;
180    bool mBufferPreserved = false;
181    SwapBehavior mSwapBehavior = kSwap_default;
182    struct SwapHistory {
183        SkRect damage;
184        nsecs_t vsyncTime;
185        nsecs_t swapTime;
186    };
187
188    RingBuffer<SwapHistory, 3> mSwapHistory;
189
190    bool mOpaque;
191    OpenGLRenderer* mCanvas = nullptr;
192#if HWUI_NEW_OPS
193    BakedOpRenderer::LightInfo mLightInfo;
194    FrameBuilder::LightGeometry mLightGeometry = { {0, 0, 0}, 0 };
195#endif
196
197    bool mHaveNewSurface = false;
198    DamageAccumulator mDamageAccumulator;
199    LayerUpdateQueue mLayerUpdateQueue;
200    std::unique_ptr<AnimationContext> mAnimationContext;
201
202    std::vector< sp<RenderNode> > mRenderNodes;
203
204    FrameInfo* mCurrentFrameInfo = nullptr;
205    // Ring buffer large enough for 2 seconds worth of frames
206    RingBuffer<FrameInfo, 120> mFrames;
207    std::string mName;
208    JankTracker mJankTracker;
209    FrameInfoVisualizer mProfiler;
210    std::unique_ptr<FrameMetricsReporter> mFrameMetricsReporter;
211
212    std::set<RenderNode*> mPrefetechedLayers;
213
214    // Stores the bounds of the main content.
215    Rect mContentDrawBounds;
216};
217
218} /* namespace renderthread */
219} /* namespace uirenderer */
220} /* namespace android */
221#endif /* CANVASCONTEXT_H_ */
222