CanvasContext.cpp revision 62bdf2c86342db66d86ceff3a8c0b609e4570bfc 
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#include "CanvasContext.h"
18
19#include <algorithm>
20#include <private/hwui/DrawGlInfo.h>
21#include <strings.h>
22
23#include "EglManager.h"
24#include "RenderThread.h"
25#include "../AnimationContext.h"
26#include "../Caches.h"
27#include "../DeferredLayerUpdater.h"
28#include "../RenderState.h"
29#include "../LayerRenderer.h"
30#include "../OpenGLRenderer.h"
31#include "../Stencil.h"
32
33#define TRIM_MEMORY_COMPLETE 80
34#define TRIM_MEMORY_UI_HIDDEN 20
35
36namespace android {
37namespace uirenderer {
38namespace renderthread {
39
40CanvasContext::CanvasContext(RenderThread& thread, bool translucent,
41        RenderNode* rootRenderNode, IContextFactory* contextFactory)
42        : mRenderThread(thread)
43        , mEglManager(thread.eglManager())
44        , mEglSurface(EGL_NO_SURFACE)
45        , mBufferPreserved(false)
46        , mSwapBehavior(kSwap_default)
47        , mOpaque(!translucent)
48        , mCanvas(NULL)
49        , mHaveNewSurface(false)
50        , mRootRenderNode(rootRenderNode) {
51    mAnimationContext = contextFactory->createAnimationContext(mRenderThread.timeLord());
52    mRenderThread.renderState().registerCanvasContext(this);
53}
54
55CanvasContext::~CanvasContext() {
56    destroy();
57    delete mAnimationContext;
58    mRenderThread.renderState().unregisterCanvasContext(this);
59}
60
61void CanvasContext::destroy() {
62    stopDrawing();
63    freePrefetechedLayers();
64    destroyHardwareResources();
65    mAnimationContext->destroy();
66    if (mCanvas) {
67        delete mCanvas;
68        mCanvas = 0;
69    }
70    setSurface(NULL);
71}
72
73void CanvasContext::setSurface(ANativeWindow* window) {
74    ATRACE_CALL();
75
76    mNativeWindow = window;
77
78    if (mEglSurface != EGL_NO_SURFACE) {
79        mEglManager.destroySurface(mEglSurface);
80        mEglSurface = EGL_NO_SURFACE;
81    }
82
83    if (window) {
84        mEglSurface = mEglManager.createSurface(window);
85    }
86
87    if (mEglSurface != EGL_NO_SURFACE) {
88        const bool preserveBuffer = (mSwapBehavior != kSwap_discardBuffer);
89        mBufferPreserved = mEglManager.setPreserveBuffer(mEglSurface, preserveBuffer);
90        mHaveNewSurface = true;
91        makeCurrent();
92    } else {
93        mRenderThread.removeFrameCallback(this);
94    }
95}
96
97void CanvasContext::swapBuffers() {
98    if (CC_UNLIKELY(!mEglManager.swapBuffers(mEglSurface))) {
99        setSurface(NULL);
100    }
101    mHaveNewSurface = false;
102}
103
104void CanvasContext::requireSurface() {
105    LOG_ALWAYS_FATAL_IF(mEglSurface == EGL_NO_SURFACE,
106            "requireSurface() called but no surface set!");
107    makeCurrent();
108}
109
110void CanvasContext::setSwapBehavior(SwapBehavior swapBehavior) {
111    mSwapBehavior = swapBehavior;
112}
113
114bool CanvasContext::initialize(ANativeWindow* window) {
115    setSurface(window);
116    if (mCanvas) return false;
117    mCanvas = new OpenGLRenderer(mRenderThread.renderState());
118    mCanvas->initProperties();
119    return true;
120}
121
122void CanvasContext::updateSurface(ANativeWindow* window) {
123    setSurface(window);
124}
125
126void CanvasContext::pauseSurface(ANativeWindow* window) {
127    stopDrawing();
128}
129
130// TODO: don't pass viewport size, it's automatic via EGL
131void CanvasContext::setup(int width, int height, const Vector3& lightCenter, float lightRadius,
132        uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha) {
133    if (!mCanvas) return;
134    mCanvas->initLight(lightCenter, lightRadius, ambientShadowAlpha, spotShadowAlpha);
135}
136
137void CanvasContext::setOpaque(bool opaque) {
138    mOpaque = opaque;
139}
140
141void CanvasContext::makeCurrent() {
142    // TODO: Figure out why this workaround is needed, see b/13913604
143    // In the meantime this matches the behavior of GLRenderer, so it is not a regression
144    mHaveNewSurface |= mEglManager.makeCurrent(mEglSurface);
145}
146
147void CanvasContext::processLayerUpdate(DeferredLayerUpdater* layerUpdater) {
148    bool success = layerUpdater->apply();
149    LOG_ALWAYS_FATAL_IF(!success, "Failed to update layer!");
150    if (layerUpdater->backingLayer()->deferredUpdateScheduled) {
151        mCanvas->pushLayerUpdate(layerUpdater->backingLayer());
152    }
153}
154
155void CanvasContext::prepareTree(TreeInfo& info) {
156    mRenderThread.removeFrameCallback(this);
157
158    info.damageAccumulator = &mDamageAccumulator;
159    info.renderer = mCanvas;
160    if (mPrefetechedLayers.size() && info.mode == TreeInfo::MODE_FULL) {
161        info.canvasContext = this;
162    }
163    mAnimationContext->startFrame(info.mode);
164    mRootRenderNode->prepareTree(info);
165    mAnimationContext->runRemainingAnimations(info);
166
167    if (info.canvasContext) {
168        freePrefetechedLayers();
169    }
170
171    if (CC_UNLIKELY(!mNativeWindow.get())) {
172        info.out.canDrawThisFrame = false;
173        return;
174    }
175
176    int runningBehind = 0;
177    // TODO: This query is moderately expensive, investigate adding some sort
178    // of fast-path based off when we last called eglSwapBuffers() as well as
179    // last vsync time. Or something.
180    mNativeWindow->query(mNativeWindow.get(),
181            NATIVE_WINDOW_CONSUMER_RUNNING_BEHIND, &runningBehind);
182    info.out.canDrawThisFrame = !runningBehind;
183
184    if (info.out.hasAnimations || !info.out.canDrawThisFrame) {
185        if (!info.out.requiresUiRedraw) {
186            // If animationsNeedsRedraw is set don't bother posting for an RT anim
187            // as we will just end up fighting the UI thread.
188            mRenderThread.postFrameCallback(this);
189        }
190    }
191}
192
193void CanvasContext::stopDrawing() {
194    mRenderThread.removeFrameCallback(this);
195}
196
197void CanvasContext::notifyFramePending() {
198    ATRACE_CALL();
199    mRenderThread.pushBackFrameCallback(this);
200}
201
202void CanvasContext::draw() {
203    LOG_ALWAYS_FATAL_IF(!mCanvas || mEglSurface == EGL_NO_SURFACE,
204            "drawRenderNode called on a context with no canvas or surface!");
205
206    profiler().markPlaybackStart();
207
208    SkRect dirty;
209    mDamageAccumulator.finish(&dirty);
210
211    EGLint width, height;
212    mEglManager.beginFrame(mEglSurface, &width, &height);
213    if (width != mCanvas->getViewportWidth() || height != mCanvas->getViewportHeight()) {
214        mCanvas->setViewport(width, height);
215        dirty.setEmpty();
216    } else if (!mBufferPreserved || mHaveNewSurface) {
217        dirty.setEmpty();
218    } else {
219        if (!dirty.isEmpty() && !dirty.intersect(0, 0, width, height)) {
220            ALOGW("Dirty " RECT_STRING " doesn't intersect with 0 0 %d %d ?",
221                    SK_RECT_ARGS(dirty), width, height);
222            dirty.setEmpty();
223        }
224        profiler().unionDirty(&dirty);
225    }
226
227    if (!dirty.isEmpty()) {
228        mCanvas->prepareDirty(dirty.fLeft, dirty.fTop,
229                dirty.fRight, dirty.fBottom, mOpaque);
230    } else {
231        mCanvas->prepare(mOpaque);
232    }
233
234    Rect outBounds;
235    mCanvas->drawRenderNode(mRootRenderNode.get(), outBounds);
236
237    profiler().draw(mCanvas);
238
239    bool drew = mCanvas->finish();
240
241    profiler().markPlaybackEnd();
242
243    if (drew) {
244        swapBuffers();
245    } else {
246        mEglManager.cancelFrame();
247    }
248
249    profiler().finishFrame();
250}
251
252// Called by choreographer to do an RT-driven animation
253void CanvasContext::doFrame() {
254    if (CC_UNLIKELY(!mCanvas || mEglSurface == EGL_NO_SURFACE)) {
255        return;
256    }
257
258    ATRACE_CALL();
259
260    profiler().startFrame();
261
262    TreeInfo info(TreeInfo::MODE_RT_ONLY, mRenderThread.renderState());
263    prepareTree(info);
264    if (info.out.canDrawThisFrame) {
265        draw();
266    }
267}
268
269void CanvasContext::invokeFunctor(RenderThread& thread, Functor* functor) {
270    ATRACE_CALL();
271    DrawGlInfo::Mode mode = DrawGlInfo::kModeProcessNoContext;
272    if (thread.eglManager().hasEglContext()) {
273        thread.eglManager().requireGlContext();
274        mode = DrawGlInfo::kModeProcess;
275    }
276
277    thread.renderState().invokeFunctor(functor, mode, NULL);
278}
279
280void CanvasContext::markLayerInUse(RenderNode* node) {
281    if (mPrefetechedLayers.erase(node)) {
282        node->decStrong(0);
283    }
284}
285
286static void destroyPrefetechedNode(RenderNode* node) {
287    ALOGW("Incorrectly called buildLayer on View: %s, destroying layer...", node->getName());
288    node->destroyHardwareResources();
289    node->decStrong(0);
290}
291
292void CanvasContext::freePrefetechedLayers() {
293    if (mPrefetechedLayers.size()) {
294        requireGlContext();
295        std::for_each(mPrefetechedLayers.begin(), mPrefetechedLayers.end(), destroyPrefetechedNode);
296        mPrefetechedLayers.clear();
297    }
298}
299
300void CanvasContext::buildLayer(RenderNode* node) {
301    ATRACE_CALL();
302    if (!mEglManager.hasEglContext() || !mCanvas) {
303        return;
304    }
305    requireGlContext();
306    // buildLayer() will leave the tree in an unknown state, so we must stop drawing
307    stopDrawing();
308
309    TreeInfo info(TreeInfo::MODE_FULL, mRenderThread.renderState());
310    info.damageAccumulator = &mDamageAccumulator;
311    info.renderer = mCanvas;
312    info.runAnimations = false;
313    node->prepareTree(info);
314    SkRect ignore;
315    mDamageAccumulator.finish(&ignore);
316    // Tickle the GENERIC property on node to mark it as dirty for damaging
317    // purposes when the frame is actually drawn
318    node->setPropertyFieldsDirty(RenderNode::GENERIC);
319
320    mCanvas->markLayersAsBuildLayers();
321    mCanvas->flushLayerUpdates();
322
323    node->incStrong(0);
324    mPrefetechedLayers.insert(node);
325}
326
327bool CanvasContext::copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap) {
328    requireGlContext();
329    layer->apply();
330    return LayerRenderer::copyLayer(mRenderThread.renderState(), layer->backingLayer(), bitmap);
331}
332
333void CanvasContext::destroyHardwareResources() {
334    stopDrawing();
335    if (mEglManager.hasEglContext()) {
336        requireGlContext();
337        freePrefetechedLayers();
338        mRootRenderNode->destroyHardwareResources();
339        Caches::getInstance().flush(Caches::kFlushMode_Layers);
340    }
341}
342
343void CanvasContext::trimMemory(RenderThread& thread, int level) {
344    // No context means nothing to free
345    if (!thread.eglManager().hasEglContext()) return;
346
347    ATRACE_CALL();
348    thread.eglManager().requireGlContext();
349    if (level >= TRIM_MEMORY_COMPLETE) {
350        Caches::getInstance().flush(Caches::kFlushMode_Full);
351        thread.eglManager().destroy();
352    } else if (level >= TRIM_MEMORY_UI_HIDDEN) {
353        Caches::getInstance().flush(Caches::kFlushMode_Moderate);
354    }
355}
356
357void CanvasContext::runWithGlContext(RenderTask* task) {
358    requireGlContext();
359    task->run();
360}
361
362Layer* CanvasContext::createTextureLayer() {
363    requireSurface();
364    return LayerRenderer::createTextureLayer(mRenderThread.renderState());
365}
366
367void CanvasContext::requireGlContext() {
368    mEglManager.requireGlContext();
369}
370
371void CanvasContext::setTextureAtlas(RenderThread& thread,
372        const sp<GraphicBuffer>& buffer, int64_t* map, size_t mapSize) {
373    thread.eglManager().setTextureAtlas(buffer, map, mapSize);
374}
375
376} /* namespace renderthread */
377} /* namespace uirenderer */
378} /* namespace android */
379