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