CanvasContext.h revision 05357641d398ef77d880da387a230820ab3203fe
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 "FrameMetricsReporter.h" 24#include "IContextFactory.h" 25#include "LayerUpdateQueue.h" 26#include "RenderNode.h" 27#include "thread/Task.h" 28#include "thread/TaskProcessor.h" 29#include "utils/RingBuffer.h" 30#include "renderthread/RenderTask.h" 31#include "renderthread/RenderThread.h" 32 33#if HWUI_NEW_OPS 34#include "BakedOpDispatcher.h" 35#include "BakedOpRenderer.h" 36#include "FrameBuilder.h" 37#endif 38 39#include <cutils/compiler.h> 40#include <EGL/egl.h> 41#include <SkBitmap.h> 42#include <SkRect.h> 43#include <utils/Functor.h> 44#include <gui/Surface.h> 45 46#include <functional> 47#include <set> 48#include <string> 49#include <vector> 50 51namespace android { 52namespace uirenderer { 53 54class AnimationContext; 55class DeferredLayerUpdater; 56class OpenGLRenderer; 57class Rect; 58class Layer; 59class RenderState; 60 61namespace renderthread { 62 63class EglManager; 64 65enum SwapBehavior { 66 kSwap_default, 67 kSwap_discardBuffer, 68}; 69 70// This per-renderer class manages the bridge between the global EGL context 71// and the render surface. 72// TODO: Rename to Renderer or some other per-window, top-level manager 73class CanvasContext : public IFrameCallback { 74public: 75 CanvasContext(RenderThread& thread, bool translucent, RenderNode* rootRenderNode, 76 IContextFactory* contextFactory); 77 virtual ~CanvasContext(); 78 79 // Won't take effect until next EGLSurface creation 80 void setSwapBehavior(SwapBehavior swapBehavior); 81 82 void initialize(Surface* surface); 83 void updateSurface(Surface* surface); 84 bool pauseSurface(Surface* surface); 85 void setStopped(bool stopped); 86 bool hasSurface() { return mNativeSurface.get(); } 87 88 void setup(float lightRadius, 89 uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha); 90 void setLightCenter(const Vector3& lightCenter); 91 void setOpaque(bool opaque); 92 bool makeCurrent(); 93 void prepareTree(TreeInfo& info, int64_t* uiFrameInfo, 94 int64_t syncQueued, RenderNode* target); 95 void draw(); 96 void destroy(TreeObserver* observer); 97 98 // IFrameCallback, Choreographer-driven frame callback entry point 99 virtual void doFrame() override; 100 void prepareAndDraw(RenderNode* node); 101 102 void buildLayer(RenderNode* node, TreeObserver* observer); 103 bool copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap); 104 void markLayerInUse(RenderNode* node); 105 106 void destroyHardwareResources(TreeObserver* observer); 107 static void trimMemory(RenderThread& thread, int level); 108 109 static void invokeFunctor(RenderThread& thread, Functor* functor); 110 111 Layer* createTextureLayer(); 112 113 ANDROID_API static void setTextureAtlas(RenderThread& thread, 114 const sp<GraphicBuffer>& buffer, int64_t* map, size_t mapSize); 115 116 void stopDrawing(); 117 void notifyFramePending(); 118 119 FrameInfoVisualizer& profiler() { return mProfiler; } 120 121 void dumpFrames(int fd); 122 void resetFrameStats(); 123 124 void setName(const std::string&& name) { mName = name; } 125 const std::string& name() { return mName; } 126 127 void serializeDisplayListTree(); 128 129 void addRenderNode(RenderNode* node, bool placeFront) { 130 int pos = placeFront ? 0 : static_cast<int>(mRenderNodes.size()); 131 mRenderNodes.emplace(mRenderNodes.begin() + pos, node); 132 } 133 134 void removeRenderNode(RenderNode* node) { 135 mRenderNodes.erase(std::remove(mRenderNodes.begin(), mRenderNodes.end(), node), 136 mRenderNodes.end()); 137 } 138 139 void setContentDrawBounds(int left, int top, int right, int bottom) { 140 mContentDrawBounds.set(left, top, right, bottom); 141 } 142 143 RenderState& getRenderState() { 144 return mRenderThread.renderState(); 145 } 146 147 void addFrameMetricsObserver(FrameMetricsObserver* observer) { 148 if (mFrameMetricsReporter.get() == nullptr) { 149 mFrameMetricsReporter.reset(new FrameMetricsReporter()); 150 } 151 152 mFrameMetricsReporter->addObserver(observer); 153 } 154 155 void removeFrameMetricsObserver(FrameMetricsObserver* observer) { 156 if (mFrameMetricsReporter.get() != nullptr) { 157 mFrameMetricsReporter->removeObserver(observer); 158 if (!mFrameMetricsReporter->hasObservers()) { 159 mFrameMetricsReporter.reset(nullptr); 160 } 161 } 162 } 163 164 // Used to queue up work that needs to be completed before this frame completes 165 ANDROID_API void enqueueFrameWork(std::function<void()>&& func); 166 167 ANDROID_API int64_t getFrameNumber(); 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 177 void freePrefetchedLayers(TreeObserver* observer); 178 179 void waitOnFences(); 180 181 EGLint mLastFrameWidth = 0; 182 EGLint mLastFrameHeight = 0; 183 184 RenderThread& mRenderThread; 185 EglManager& mEglManager; 186 sp<Surface> mNativeSurface; 187 EGLSurface mEglSurface = EGL_NO_SURFACE; 188 // stopped indicates the CanvasContext will reject actual redraw operations, 189 // and defer repaint until it is un-stopped 190 bool mStopped = false; 191 // CanvasContext is dirty if it has received an update that it has not 192 // painted onto its surface. 193 bool mIsDirty = false; 194 bool mBufferPreserved = false; 195 SwapBehavior mSwapBehavior = kSwap_default; 196 struct SwapHistory { 197 SkRect damage; 198 nsecs_t vsyncTime; 199 nsecs_t swapTime; 200 }; 201 202 RingBuffer<SwapHistory, 3> mSwapHistory; 203 int64_t mFrameNumber = -1; 204 205 bool mOpaque; 206#if HWUI_NEW_OPS 207 BakedOpRenderer::LightInfo mLightInfo; 208 FrameBuilder::LightGeometry mLightGeometry = { {0, 0, 0}, 0 }; 209#else 210 OpenGLRenderer* mCanvas = nullptr; 211#endif 212 213 bool mHaveNewSurface = false; 214 DamageAccumulator mDamageAccumulator; 215 LayerUpdateQueue mLayerUpdateQueue; 216 std::unique_ptr<AnimationContext> mAnimationContext; 217 218 std::vector< sp<RenderNode> > mRenderNodes; 219 220 FrameInfo* mCurrentFrameInfo = nullptr; 221 // Ring buffer large enough for 2 seconds worth of frames 222 RingBuffer<FrameInfo, 120> mFrames; 223 std::string mName; 224 JankTracker mJankTracker; 225 FrameInfoVisualizer mProfiler; 226 std::unique_ptr<FrameMetricsReporter> mFrameMetricsReporter; 227 228 std::set<RenderNode*> mPrefetchedLayers; 229 230 // Stores the bounds of the main content. 231 Rect mContentDrawBounds; 232 233 // TODO: This is really a Task<void> but that doesn't really work 234 // when Future<> expects to be able to get/set a value 235 struct FuncTask : public Task<bool> { 236 std::function<void()> func; 237 }; 238 class FuncTaskProcessor; 239 240 std::vector< sp<FuncTask> > mFrameFences; 241 sp<TaskProcessor<bool> > mFrameWorkProcessor; 242}; 243 244} /* namespace renderthread */ 245} /* namespace uirenderer */ 246} /* namespace android */ 247#endif /* CANVASCONTEXT_H_ */ 248