CanvasContext.h revision bf4b31f7b23b0bc7a2ed4fc779aac37c9c486eb2 
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    void 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 processLayerUpdate(DeferredLayerUpdater* layerUpdater);
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
143private:
144    friend class RegisterFrameCallbackTask;
145    // TODO: Replace with something better for layer & other GL object
146    // lifecycle tracking
147    friend class android::uirenderer::RenderState;
148
149    void setSurface(ANativeWindow* window);
150    void requireSurface();
151
152    void freePrefetechedLayers();
153
154    EGLint mLastFrameWidth = 0;
155    EGLint mLastFrameHeight = 0;
156
157    RenderThread& mRenderThread;
158    EglManager& mEglManager;
159    sp<ANativeWindow> mNativeWindow;
160    EGLSurface mEglSurface = EGL_NO_SURFACE;
161    bool mBufferPreserved = false;
162    SwapBehavior mSwapBehavior = kSwap_default;
163    struct SwapHistory {
164        SkRect damage;
165        nsecs_t vsyncTime;
166        nsecs_t swapTime;
167    };
168
169    RingBuffer<SwapHistory, 3> mSwapHistory;
170
171    bool mOpaque;
172    OpenGLRenderer* mCanvas = nullptr;
173#if HWUI_NEW_OPS
174    BakedOpRenderer::LightInfo mLightInfo;
175    Vector3 mLightCenter = { 0, 0, 0 };
176#endif
177
178    bool mHaveNewSurface = false;
179    DamageAccumulator mDamageAccumulator;
180    LayerUpdateQueue mLayerUpdateQueue;
181    std::unique_ptr<AnimationContext> mAnimationContext;
182
183    std::vector< sp<RenderNode> > mRenderNodes;
184
185    FrameInfo* mCurrentFrameInfo = nullptr;
186    // Ring buffer large enough for 2 seconds worth of frames
187    RingBuffer<FrameInfo, 120> mFrames;
188    std::string mName;
189    JankTracker mJankTracker;
190    FrameInfoVisualizer mProfiler;
191
192    std::set<RenderNode*> mPrefetechedLayers;
193
194    // Stores the bounds of the main content.
195    Rect mContentDrawBounds;
196};
197
198} /* namespace renderthread */
199} /* namespace uirenderer */
200} /* namespace android */
201#endif /* CANVASCONTEXT_H_ */
202