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