CanvasContext.cpp revision 0e40462e11d27eb859b829b112cecb8c6f0d7afb 
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    setSurface(NULL);
64    freePrefetechedLayers();
65    destroyHardwareResources();
66    mAnimationContext->destroy();
67    if (mCanvas) {
68        delete mCanvas;
69        mCanvas = 0;
70    }
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
126bool CanvasContext::pauseSurface(ANativeWindow* window) {
127    return mRenderThread.removeFrameCallback(this);
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    status_t status;
228    if (!dirty.isEmpty()) {
229        status = mCanvas->prepareDirty(dirty.fLeft, dirty.fTop,
230                dirty.fRight, dirty.fBottom, mOpaque);
231    } else {
232        status = mCanvas->prepare(mOpaque);
233    }
234
235    Rect outBounds;
236    status |= mCanvas->drawRenderNode(mRootRenderNode.get(), outBounds);
237
238    profiler().draw(mCanvas);
239
240    mCanvas->finish();
241
242    profiler().markPlaybackEnd();
243
244    if (status & DrawGlInfo::kStatusDrew) {
245        swapBuffers();
246    } else {
247        mEglManager.cancelFrame();
248    }
249
250    profiler().finishFrame();
251}
252
253// Called by choreographer to do an RT-driven animation
254void CanvasContext::doFrame() {
255    if (CC_UNLIKELY(!mCanvas || mEglSurface == EGL_NO_SURFACE)) {
256        return;
257    }
258
259    ATRACE_CALL();
260
261    profiler().startFrame();
262
263    TreeInfo info(TreeInfo::MODE_RT_ONLY, mRenderThread.renderState());
264    prepareTree(info);
265    if (info.out.canDrawThisFrame) {
266        draw();
267    }
268}
269
270void CanvasContext::invokeFunctor(RenderThread& thread, Functor* functor) {
271    ATRACE_CALL();
272    DrawGlInfo::Mode mode = DrawGlInfo::kModeProcessNoContext;
273    if (thread.eglManager().hasEglContext()) {
274        thread.eglManager().requireGlContext();
275        mode = DrawGlInfo::kModeProcess;
276    }
277
278    thread.renderState().invokeFunctor(functor, mode, NULL);
279}
280
281void CanvasContext::markLayerInUse(RenderNode* node) {
282    if (mPrefetechedLayers.erase(node)) {
283        node->decStrong(0);
284    }
285}
286
287static void destroyPrefetechedNode(RenderNode* node) {
288    ALOGW("Incorrectly called buildLayer on View: %s, destroying layer...", node->getName());
289    node->destroyHardwareResources();
290    node->decStrong(0);
291}
292
293void CanvasContext::freePrefetechedLayers() {
294    if (mPrefetechedLayers.size()) {
295        requireGlContext();
296        std::for_each(mPrefetechedLayers.begin(), mPrefetechedLayers.end(), destroyPrefetechedNode);
297        mPrefetechedLayers.clear();
298    }
299}
300
301void CanvasContext::buildLayer(RenderNode* node) {
302    ATRACE_CALL();
303    if (!mEglManager.hasEglContext() || !mCanvas) {
304        return;
305    }
306    requireGlContext();
307    // buildLayer() will leave the tree in an unknown state, so we must stop drawing
308    stopDrawing();
309
310    TreeInfo info(TreeInfo::MODE_FULL, mRenderThread.renderState());
311    info.damageAccumulator = &mDamageAccumulator;
312    info.renderer = mCanvas;
313    info.runAnimations = false;
314    node->prepareTree(info);
315    SkRect ignore;
316    mDamageAccumulator.finish(&ignore);
317    // Tickle the GENERIC property on node to mark it as dirty for damaging
318    // purposes when the frame is actually drawn
319    node->setPropertyFieldsDirty(RenderNode::GENERIC);
320
321    mCanvas->markLayersAsBuildLayers();
322    mCanvas->flushLayerUpdates();
323
324    node->incStrong(0);
325    mPrefetechedLayers.insert(node);
326}
327
328bool CanvasContext::copyLayerInto(DeferredLayerUpdater* layer, SkBitmap* bitmap) {
329    requireGlContext();
330    layer->apply();
331    return LayerRenderer::copyLayer(mRenderThread.renderState(), layer->backingLayer(), bitmap);
332}
333
334void CanvasContext::destroyHardwareResources() {
335    stopDrawing();
336    if (mEglManager.hasEglContext()) {
337        requireGlContext();
338        freePrefetechedLayers();
339        mRootRenderNode->destroyHardwareResources();
340        Caches::getInstance().flush(Caches::kFlushMode_Layers);
341    }
342}
343
344void CanvasContext::trimMemory(RenderThread& thread, int level) {
345    // No context means nothing to free
346    if (!thread.eglManager().hasEglContext()) return;
347
348    ATRACE_CALL();
349    thread.eglManager().requireGlContext();
350    if (level >= TRIM_MEMORY_COMPLETE) {
351        Caches::getInstance().flush(Caches::kFlushMode_Full);
352        thread.eglManager().destroy();
353    } else if (level >= TRIM_MEMORY_UI_HIDDEN) {
354        Caches::getInstance().flush(Caches::kFlushMode_Moderate);
355    }
356}
357
358void CanvasContext::runWithGlContext(RenderTask* task) {
359    requireGlContext();
360    task->run();
361}
362
363Layer* CanvasContext::createTextureLayer() {
364    requireSurface();
365    return LayerRenderer::createTextureLayer(mRenderThread.renderState());
366}
367
368void CanvasContext::requireGlContext() {
369    mEglManager.requireGlContext();
370}
371
372void CanvasContext::setTextureAtlas(RenderThread& thread,
373        const sp<GraphicBuffer>& buffer, int64_t* map, size_t mapSize) {
374    thread.eglManager().setTextureAtlas(buffer, map, mapSize);
375}
376
377} /* namespace renderthread */
378} /* namespace uirenderer */
379} /* namespace android */
380