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