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