RenderNode.cpp revision 70850ea258cbf91477efa57a1f1a23cc0044cc93 
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#define ATRACE_TAG ATRACE_TAG_VIEW
18#define LOG_TAG "OpenGLRenderer"
19
20#include "RenderNode.h"
21
22#include <algorithm>
23#include <string>
24
25#include <SkCanvas.h>
26#include <algorithm>
27
28
29#include "DamageAccumulator.h"
30#include "Debug.h"
31#include "DisplayListOp.h"
32#include "DisplayListLogBuffer.h"
33#include "LayerRenderer.h"
34#include "OpenGLRenderer.h"
35#include "utils/MathUtils.h"
36#include "utils/TraceUtils.h"
37#include "renderthread/CanvasContext.h"
38
39namespace android {
40namespace uirenderer {
41
42void RenderNode::outputLogBuffer(int fd) {
43    DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
44    if (logBuffer.isEmpty()) {
45        return;
46    }
47
48    FILE *file = fdopen(fd, "a");
49
50    fprintf(file, "\nRecent DisplayList operations\n");
51    logBuffer.outputCommands(file);
52
53    if (Caches::hasInstance()) {
54        String8 cachesLog;
55        Caches::getInstance().dumpMemoryUsage(cachesLog);
56        fprintf(file, "\nCaches:\n%s\n", cachesLog.string());
57    } else {
58        fprintf(file, "\nNo caches instance.\n");
59    }
60
61    fflush(file);
62}
63
64void RenderNode::debugDumpLayers(const char* prefix) {
65    if (mLayer) {
66        ALOGD("%sNode %p (%s) has layer %p (fbo = %u, wasBuildLayered = %s)",
67                prefix, this, getName(), mLayer, mLayer->getFbo(),
68                mLayer->wasBuildLayered ? "true" : "false");
69    }
70    if (mDisplayListData) {
71        for (size_t i = 0; i < mDisplayListData->children().size(); i++) {
72            mDisplayListData->children()[i]->mRenderNode->debugDumpLayers(prefix);
73        }
74    }
75}
76
77RenderNode::RenderNode()
78        : mDirtyPropertyFields(0)
79        , mNeedsDisplayListDataSync(false)
80        , mDisplayListData(0)
81        , mStagingDisplayListData(0)
82        , mAnimatorManager(*this)
83        , mLayer(0)
84        , mParentCount(0) {
85}
86
87RenderNode::~RenderNode() {
88    deleteDisplayListData();
89    delete mStagingDisplayListData;
90    if (mLayer) {
91        ALOGW("Memory Warning: Layer %p missed its detachment, held on to for far too long!", mLayer);
92        mLayer->postDecStrong();
93        mLayer = 0;
94    }
95}
96
97void RenderNode::setStagingDisplayList(DisplayListData* data) {
98    mNeedsDisplayListDataSync = true;
99    delete mStagingDisplayListData;
100    mStagingDisplayListData = data;
101}
102
103/**
104 * This function is a simplified version of replay(), where we simply retrieve and log the
105 * display list. This function should remain in sync with the replay() function.
106 */
107void RenderNode::output(uint32_t level) {
108    ALOGD("%*sStart display list (%p, %s, render=%d)", (level - 1) * 2, "", this,
109            getName(), isRenderable());
110    ALOGD("%*s%s %d", level * 2, "", "Save",
111            SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
112
113    properties().debugOutputProperties(level);
114    int flags = DisplayListOp::kOpLogFlag_Recurse;
115    if (mDisplayListData) {
116        // TODO: consider printing the chunk boundaries here
117        for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) {
118            mDisplayListData->displayListOps[i]->output(level, flags);
119        }
120    }
121
122    ALOGD("%*sDone (%p, %s)", (level - 1) * 2, "", this, getName());
123}
124
125int RenderNode::getDebugSize() {
126    int size = sizeof(RenderNode);
127    if (mStagingDisplayListData) {
128        size += mStagingDisplayListData->getUsedSize();
129    }
130    if (mDisplayListData && mDisplayListData != mStagingDisplayListData) {
131        size += mDisplayListData->getUsedSize();
132    }
133    return size;
134}
135
136void RenderNode::prepareTree(TreeInfo& info) {
137    ATRACE_CALL();
138    LOG_ALWAYS_FATAL_IF(!info.damageAccumulator, "DamageAccumulator missing");
139
140    prepareTreeImpl(info);
141}
142
143void RenderNode::addAnimator(const sp<BaseRenderNodeAnimator>& animator) {
144    mAnimatorManager.addAnimator(animator);
145}
146
147void RenderNode::damageSelf(TreeInfo& info) {
148    if (isRenderable()) {
149        if (properties().getClipDamageToBounds()) {
150            info.damageAccumulator->dirty(0, 0, properties().getWidth(), properties().getHeight());
151        } else {
152            // Hope this is big enough?
153            // TODO: Get this from the display list ops or something
154            info.damageAccumulator->dirty(INT_MIN, INT_MIN, INT_MAX, INT_MAX);
155        }
156    }
157}
158
159void RenderNode::prepareLayer(TreeInfo& info, uint32_t dirtyMask) {
160    LayerType layerType = properties().layerProperties().type();
161    if (CC_UNLIKELY(layerType == kLayerTypeRenderLayer)) {
162        // Damage applied so far needs to affect our parent, but does not require
163        // the layer to be updated. So we pop/push here to clear out the current
164        // damage and get a clean state for display list or children updates to
165        // affect, which will require the layer to be updated
166        info.damageAccumulator->popTransform();
167        info.damageAccumulator->pushTransform(this);
168        if (dirtyMask & DISPLAY_LIST) {
169            damageSelf(info);
170        }
171    }
172}
173
174void RenderNode::pushLayerUpdate(TreeInfo& info) {
175    LayerType layerType = properties().layerProperties().type();
176    // If we are not a layer OR we cannot be rendered (eg, view was detached)
177    // we need to destroy any Layers we may have had previously
178    if (CC_LIKELY(layerType != kLayerTypeRenderLayer) || CC_UNLIKELY(!isRenderable())) {
179        if (CC_UNLIKELY(mLayer)) {
180            LayerRenderer::destroyLayer(mLayer);
181            mLayer = NULL;
182        }
183        return;
184    }
185
186    bool transformUpdateNeeded = false;
187    if (!mLayer) {
188        mLayer = LayerRenderer::createRenderLayer(info.renderState, getWidth(), getHeight());
189        applyLayerPropertiesToLayer(info);
190        damageSelf(info);
191        transformUpdateNeeded = true;
192    } else if (mLayer->layer.getWidth() != getWidth() || mLayer->layer.getHeight() != getHeight()) {
193        if (!LayerRenderer::resizeLayer(mLayer, getWidth(), getHeight())) {
194            LayerRenderer::destroyLayer(mLayer);
195            mLayer = 0;
196        }
197        damageSelf(info);
198        transformUpdateNeeded = true;
199    }
200
201    SkRect dirty;
202    info.damageAccumulator->peekAtDirty(&dirty);
203
204    if (!mLayer) {
205        Caches::getInstance().dumpMemoryUsage();
206        if (info.errorHandler) {
207            std::string msg = "Unable to create layer for ";
208            msg += getName();
209            info.errorHandler->onError(msg);
210        }
211        return;
212    }
213
214    if (transformUpdateNeeded) {
215        // update the transform in window of the layer to reset its origin wrt light source position
216        Matrix4 windowTransform;
217        info.damageAccumulator->computeCurrentTransform(&windowTransform);
218        mLayer->setWindowTransform(windowTransform);
219    }
220
221    if (dirty.intersect(0, 0, getWidth(), getHeight())) {
222        dirty.roundOut();
223        mLayer->updateDeferred(this, dirty.fLeft, dirty.fTop, dirty.fRight, dirty.fBottom);
224    }
225    // This is not inside the above if because we may have called
226    // updateDeferred on a previous prepare pass that didn't have a renderer
227    if (info.renderer && mLayer->deferredUpdateScheduled) {
228        info.renderer->pushLayerUpdate(mLayer);
229    }
230
231    if (CC_UNLIKELY(info.canvasContext)) {
232        // If canvasContext is not null that means there are prefetched layers
233        // that need to be accounted for. That might be us, so tell CanvasContext
234        // that this layer is in the tree and should not be destroyed.
235        info.canvasContext->markLayerInUse(this);
236    }
237}
238
239void RenderNode::prepareTreeImpl(TreeInfo& info) {
240    info.damageAccumulator->pushTransform(this);
241
242    if (info.mode == TreeInfo::MODE_FULL) {
243        pushStagingPropertiesChanges(info);
244    }
245    uint32_t animatorDirtyMask = 0;
246    if (CC_LIKELY(info.runAnimations)) {
247        animatorDirtyMask = mAnimatorManager.animate(info);
248    }
249    prepareLayer(info, animatorDirtyMask);
250    if (info.mode == TreeInfo::MODE_FULL) {
251        pushStagingDisplayListChanges(info);
252    }
253    prepareSubTree(info, mDisplayListData);
254    pushLayerUpdate(info);
255
256    info.damageAccumulator->popTransform();
257}
258
259void RenderNode::pushStagingPropertiesChanges(TreeInfo& info) {
260    // Push the animators first so that setupStartValueIfNecessary() is called
261    // before properties() is trampled by stagingProperties(), as they are
262    // required by some animators.
263    if (CC_LIKELY(info.runAnimations)) {
264        mAnimatorManager.pushStaging();
265    }
266    if (mDirtyPropertyFields) {
267        mDirtyPropertyFields = 0;
268        damageSelf(info);
269        info.damageAccumulator->popTransform();
270        mProperties = mStagingProperties;
271        applyLayerPropertiesToLayer(info);
272        // We could try to be clever and only re-damage if the matrix changed.
273        // However, we don't need to worry about that. The cost of over-damaging
274        // here is only going to be a single additional map rect of this node
275        // plus a rect join(). The parent's transform (and up) will only be
276        // performed once.
277        info.damageAccumulator->pushTransform(this);
278        damageSelf(info);
279    }
280}
281
282void RenderNode::applyLayerPropertiesToLayer(TreeInfo& info) {
283    if (CC_LIKELY(!mLayer)) return;
284
285    const LayerProperties& props = properties().layerProperties();
286    mLayer->setAlpha(props.alpha(), props.xferMode());
287    mLayer->setColorFilter(props.colorFilter());
288    mLayer->setBlend(props.needsBlending());
289}
290
291void RenderNode::pushStagingDisplayListChanges(TreeInfo& info) {
292    if (mNeedsDisplayListDataSync) {
293        mNeedsDisplayListDataSync = false;
294        // Make sure we inc first so that we don't fluctuate between 0 and 1,
295        // which would thrash the layer cache
296        if (mStagingDisplayListData) {
297            for (size_t i = 0; i < mStagingDisplayListData->children().size(); i++) {
298                mStagingDisplayListData->children()[i]->mRenderNode->incParentRefCount();
299            }
300        }
301        // Damage with the old display list first then the new one to catch any
302        // changes in isRenderable or, in the future, bounds
303        damageSelf(info);
304        deleteDisplayListData();
305        // TODO: Remove this caches stuff
306        if (mStagingDisplayListData && mStagingDisplayListData->functors.size()) {
307            Caches::getInstance().registerFunctors(mStagingDisplayListData->functors.size());
308        }
309        mDisplayListData = mStagingDisplayListData;
310        mStagingDisplayListData = NULL;
311        if (mDisplayListData) {
312            for (size_t i = 0; i < mDisplayListData->functors.size(); i++) {
313                (*mDisplayListData->functors[i])(DrawGlInfo::kModeSync, NULL);
314            }
315        }
316        damageSelf(info);
317    }
318}
319
320void RenderNode::deleteDisplayListData() {
321    if (mDisplayListData) {
322        for (size_t i = 0; i < mDisplayListData->children().size(); i++) {
323            mDisplayListData->children()[i]->mRenderNode->decParentRefCount();
324        }
325        if (mDisplayListData->functors.size()) {
326            Caches::getInstance().unregisterFunctors(mDisplayListData->functors.size());
327        }
328    }
329    delete mDisplayListData;
330    mDisplayListData = NULL;
331}
332
333void RenderNode::prepareSubTree(TreeInfo& info, DisplayListData* subtree) {
334    if (subtree) {
335        TextureCache& cache = Caches::getInstance().textureCache;
336        info.out.hasFunctors |= subtree->functors.size();
337        // TODO: Fix ownedBitmapResources to not require disabling prepareTextures
338        // and thus falling out of async drawing path.
339        if (subtree->ownedBitmapResources.size()) {
340            info.prepareTextures = false;
341        }
342        for (size_t i = 0; info.prepareTextures && i < subtree->bitmapResources.size(); i++) {
343            info.prepareTextures = cache.prefetchAndMarkInUse(subtree->bitmapResources[i]);
344        }
345        for (size_t i = 0; i < subtree->children().size(); i++) {
346            DrawRenderNodeOp* op = subtree->children()[i];
347            RenderNode* childNode = op->mRenderNode;
348            info.damageAccumulator->pushTransform(&op->mTransformFromParent);
349            childNode->prepareTreeImpl(info);
350            info.damageAccumulator->popTransform();
351        }
352    }
353}
354
355void RenderNode::destroyHardwareResources() {
356    if (mLayer) {
357        LayerRenderer::destroyLayer(mLayer);
358        mLayer = NULL;
359    }
360    if (mDisplayListData) {
361        for (size_t i = 0; i < mDisplayListData->children().size(); i++) {
362            mDisplayListData->children()[i]->mRenderNode->destroyHardwareResources();
363        }
364        if (mNeedsDisplayListDataSync) {
365            // Next prepare tree we are going to push a new display list, so we can
366            // drop our current one now
367            deleteDisplayListData();
368        }
369    }
370}
371
372void RenderNode::decParentRefCount() {
373    LOG_ALWAYS_FATAL_IF(!mParentCount, "already 0!");
374    mParentCount--;
375    if (!mParentCount) {
376        // If a child of ours is being attached to our parent then this will incorrectly
377        // destroy its hardware resources. However, this situation is highly unlikely
378        // and the failure is "just" that the layer is re-created, so this should
379        // be safe enough
380        destroyHardwareResources();
381    }
382}
383
384/*
385 * For property operations, we pass a savecount of 0, since the operations aren't part of the
386 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in
387 * base saveCount (i.e., how RestoreToCount uses saveCount + properties().getCount())
388 */
389#define PROPERTY_SAVECOUNT 0
390
391template <class T>
392void RenderNode::setViewProperties(OpenGLRenderer& renderer, T& handler) {
393#if DEBUG_DISPLAY_LIST
394    properties().debugOutputProperties(handler.level() + 1);
395#endif
396    if (properties().getLeft() != 0 || properties().getTop() != 0) {
397        renderer.translate(properties().getLeft(), properties().getTop());
398    }
399    if (properties().getStaticMatrix()) {
400        renderer.concatMatrix(*properties().getStaticMatrix());
401    } else if (properties().getAnimationMatrix()) {
402        renderer.concatMatrix(*properties().getAnimationMatrix());
403    }
404    if (properties().hasTransformMatrix()) {
405        if (properties().isTransformTranslateOnly()) {
406            renderer.translate(properties().getTranslationX(), properties().getTranslationY());
407        } else {
408            renderer.concatMatrix(*properties().getTransformMatrix());
409        }
410    }
411    const bool isLayer = properties().layerProperties().type() != kLayerTypeNone;
412    int clipFlags = properties().getClippingFlags();
413    if (properties().getAlpha() < 1) {
414        if (isLayer) {
415            clipFlags &= ~CLIP_TO_BOUNDS; // bounds clipping done by layer
416
417            renderer.setOverrideLayerAlpha(properties().getAlpha());
418        } else if (!properties().getHasOverlappingRendering()) {
419            renderer.scaleAlpha(properties().getAlpha());
420        } else {
421            Rect layerBounds(0, 0, getWidth(), getHeight());
422            int saveFlags = SkCanvas::kHasAlphaLayer_SaveFlag;
423            if (clipFlags) {
424                saveFlags |= SkCanvas::kClipToLayer_SaveFlag;
425                properties().getClippingRectForFlags(clipFlags, &layerBounds);
426                clipFlags = 0; // all clipping done by saveLayer
427            }
428
429            ATRACE_FORMAT("%s alpha caused %ssaveLayer %ux%u",
430                    getName(), clipFlags ? "" : "unclipped ",
431                    layerBounds.getWidth(), layerBounds.getHeight());
432
433            SaveLayerOp* op = new (handler.allocator()) SaveLayerOp(
434                    layerBounds.left, layerBounds.top, layerBounds.right, layerBounds.bottom,
435                    properties().getAlpha() * 255, saveFlags);
436            handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
437        }
438    }
439    if (clipFlags) {
440        Rect clipRect;
441        properties().getClippingRectForFlags(clipFlags, &clipRect);
442        ClipRectOp* op = new (handler.allocator()) ClipRectOp(
443                clipRect.left, clipRect.top, clipRect.right, clipRect.bottom,
444                SkRegion::kIntersect_Op);
445        handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
446    }
447
448    // TODO: support nesting round rect clips
449    if (mProperties.getRevealClip().willClip()) {
450        Rect bounds;
451        mProperties.getRevealClip().getBounds(&bounds);
452        renderer.setClippingRoundRect(handler.allocator(), bounds, mProperties.getRevealClip().getRadius());
453    } else if (mProperties.getOutline().willClip()) {
454        renderer.setClippingOutline(handler.allocator(), &(mProperties.getOutline()));
455    }
456}
457
458/**
459 * Apply property-based transformations to input matrix
460 *
461 * If true3dTransform is set to true, the transform applied to the input matrix will use true 4x4
462 * matrix computation instead of the Skia 3x3 matrix + camera hackery.
463 */
464void RenderNode::applyViewPropertyTransforms(mat4& matrix, bool true3dTransform) const {
465    if (properties().getLeft() != 0 || properties().getTop() != 0) {
466        matrix.translate(properties().getLeft(), properties().getTop());
467    }
468    if (properties().getStaticMatrix()) {
469        mat4 stat(*properties().getStaticMatrix());
470        matrix.multiply(stat);
471    } else if (properties().getAnimationMatrix()) {
472        mat4 anim(*properties().getAnimationMatrix());
473        matrix.multiply(anim);
474    }
475
476    bool applyTranslationZ = true3dTransform && !MathUtils::isZero(properties().getZ());
477    if (properties().hasTransformMatrix() || applyTranslationZ) {
478        if (properties().isTransformTranslateOnly()) {
479            matrix.translate(properties().getTranslationX(), properties().getTranslationY(),
480                    true3dTransform ? properties().getZ() : 0.0f);
481        } else {
482            if (!true3dTransform) {
483                matrix.multiply(*properties().getTransformMatrix());
484            } else {
485                mat4 true3dMat;
486                true3dMat.loadTranslate(
487                        properties().getPivotX() + properties().getTranslationX(),
488                        properties().getPivotY() + properties().getTranslationY(),
489                        properties().getZ());
490                true3dMat.rotate(properties().getRotationX(), 1, 0, 0);
491                true3dMat.rotate(properties().getRotationY(), 0, 1, 0);
492                true3dMat.rotate(properties().getRotation(), 0, 0, 1);
493                true3dMat.scale(properties().getScaleX(), properties().getScaleY(), 1);
494                true3dMat.translate(-properties().getPivotX(), -properties().getPivotY());
495
496                matrix.multiply(true3dMat);
497            }
498        }
499    }
500}
501
502/**
503 * Organizes the DisplayList hierarchy to prepare for background projection reordering.
504 *
505 * This should be called before a call to defer() or drawDisplayList()
506 *
507 * Each DisplayList that serves as a 3d root builds its list of composited children,
508 * which are flagged to not draw in the standard draw loop.
509 */
510void RenderNode::computeOrdering() {
511    ATRACE_CALL();
512    mProjectedNodes.clear();
513
514    // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that
515    // transform properties are applied correctly to top level children
516    if (mDisplayListData == NULL) return;
517    for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) {
518        DrawRenderNodeOp* childOp = mDisplayListData->children()[i];
519        childOp->mRenderNode->computeOrderingImpl(childOp,
520                properties().getOutline().getPath(), &mProjectedNodes, &mat4::identity());
521    }
522}
523
524void RenderNode::computeOrderingImpl(
525        DrawRenderNodeOp* opState,
526        const SkPath* outlineOfProjectionSurface,
527        Vector<DrawRenderNodeOp*>* compositedChildrenOfProjectionSurface,
528        const mat4* transformFromProjectionSurface) {
529    mProjectedNodes.clear();
530    if (mDisplayListData == NULL || mDisplayListData->isEmpty()) return;
531
532    // TODO: should avoid this calculation in most cases
533    // TODO: just calculate single matrix, down to all leaf composited elements
534    Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface);
535    localTransformFromProjectionSurface.multiply(opState->mTransformFromParent);
536
537    if (properties().getProjectBackwards()) {
538        // composited projectee, flag for out of order draw, save matrix, and store in proj surface
539        opState->mSkipInOrderDraw = true;
540        opState->mTransformFromCompositingAncestor.load(localTransformFromProjectionSurface);
541        compositedChildrenOfProjectionSurface->add(opState);
542    } else {
543        // standard in order draw
544        opState->mSkipInOrderDraw = false;
545    }
546
547    if (mDisplayListData->children().size() > 0) {
548        const bool isProjectionReceiver = mDisplayListData->projectionReceiveIndex >= 0;
549        bool haveAppliedPropertiesToProjection = false;
550        for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) {
551            DrawRenderNodeOp* childOp = mDisplayListData->children()[i];
552            RenderNode* child = childOp->mRenderNode;
553
554            const SkPath* projectionOutline = NULL;
555            Vector<DrawRenderNodeOp*>* projectionChildren = NULL;
556            const mat4* projectionTransform = NULL;
557            if (isProjectionReceiver && !child->properties().getProjectBackwards()) {
558                // if receiving projections, collect projecting descendent
559
560                // Note that if a direct descendent is projecting backwards, we pass it's
561                // grandparent projection collection, since it shouldn't project onto it's
562                // parent, where it will already be drawing.
563                projectionOutline = properties().getOutline().getPath();
564                projectionChildren = &mProjectedNodes;
565                projectionTransform = &mat4::identity();
566            } else {
567                if (!haveAppliedPropertiesToProjection) {
568                    applyViewPropertyTransforms(localTransformFromProjectionSurface);
569                    haveAppliedPropertiesToProjection = true;
570                }
571                projectionOutline = outlineOfProjectionSurface;
572                projectionChildren = compositedChildrenOfProjectionSurface;
573                projectionTransform = &localTransformFromProjectionSurface;
574            }
575            child->computeOrderingImpl(childOp,
576                    projectionOutline, projectionChildren, projectionTransform);
577        }
578    }
579}
580
581class DeferOperationHandler {
582public:
583    DeferOperationHandler(DeferStateStruct& deferStruct, int level)
584        : mDeferStruct(deferStruct), mLevel(level) {}
585    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
586        operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds);
587    }
588    inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); }
589    inline void startMark(const char* name) {} // do nothing
590    inline void endMark() {}
591    inline int level() { return mLevel; }
592    inline int replayFlags() { return mDeferStruct.mReplayFlags; }
593    inline SkPath* allocPathForFrame() { return mDeferStruct.allocPathForFrame(); }
594
595private:
596    DeferStateStruct& mDeferStruct;
597    const int mLevel;
598};
599
600void RenderNode::defer(DeferStateStruct& deferStruct, const int level) {
601    DeferOperationHandler handler(deferStruct, level);
602    issueOperations<DeferOperationHandler>(deferStruct.mRenderer, handler);
603}
604
605class ReplayOperationHandler {
606public:
607    ReplayOperationHandler(ReplayStateStruct& replayStruct, int level)
608        : mReplayStruct(replayStruct), mLevel(level) {}
609    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
610#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS
611        mReplayStruct.mRenderer.eventMark(operation->name());
612#endif
613        operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds);
614    }
615    inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); }
616    inline void startMark(const char* name) {
617        mReplayStruct.mRenderer.startMark(name);
618    }
619    inline void endMark() {
620        mReplayStruct.mRenderer.endMark();
621    }
622    inline int level() { return mLevel; }
623    inline int replayFlags() { return mReplayStruct.mReplayFlags; }
624    inline SkPath* allocPathForFrame() { return mReplayStruct.allocPathForFrame(); }
625
626private:
627    ReplayStateStruct& mReplayStruct;
628    const int mLevel;
629};
630
631void RenderNode::replay(ReplayStateStruct& replayStruct, const int level) {
632    ReplayOperationHandler handler(replayStruct, level);
633    issueOperations<ReplayOperationHandler>(replayStruct.mRenderer, handler);
634}
635
636void RenderNode::buildZSortedChildList(const DisplayListData::Chunk& chunk,
637        Vector<ZDrawRenderNodeOpPair>& zTranslatedNodes) {
638    if (chunk.beginChildIndex == chunk.endChildIndex) return;
639
640    for (unsigned int i = chunk.beginChildIndex; i < chunk.endChildIndex; i++) {
641        DrawRenderNodeOp* childOp = mDisplayListData->children()[i];
642        RenderNode* child = childOp->mRenderNode;
643        float childZ = child->properties().getZ();
644
645        if (!MathUtils::isZero(childZ) && chunk.reorderChildren) {
646            zTranslatedNodes.add(ZDrawRenderNodeOpPair(childZ, childOp));
647            childOp->mSkipInOrderDraw = true;
648        } else if (!child->properties().getProjectBackwards()) {
649            // regular, in order drawing DisplayList
650            childOp->mSkipInOrderDraw = false;
651        }
652    }
653
654    // Z sort any 3d children (stable-ness makes z compare fall back to standard drawing order)
655    std::stable_sort(zTranslatedNodes.begin(), zTranslatedNodes.end());
656}
657
658template <class T>
659void RenderNode::issueDrawShadowOperation(const Matrix4& transformFromParent, T& handler) {
660    if (properties().getAlpha() <= 0.0f
661            || properties().getOutline().getAlpha() <= 0.0f
662            || !properties().getOutline().getPath()) {
663        // no shadow to draw
664        return;
665    }
666
667    mat4 shadowMatrixXY(transformFromParent);
668    applyViewPropertyTransforms(shadowMatrixXY);
669
670    // Z matrix needs actual 3d transformation, so mapped z values will be correct
671    mat4 shadowMatrixZ(transformFromParent);
672    applyViewPropertyTransforms(shadowMatrixZ, true);
673
674    const SkPath* casterOutlinePath = properties().getOutline().getPath();
675    const SkPath* revealClipPath = properties().getRevealClip().getPath();
676    if (revealClipPath && revealClipPath->isEmpty()) return;
677
678    float casterAlpha = properties().getAlpha() * properties().getOutline().getAlpha();
679
680    const SkPath* outlinePath = casterOutlinePath;
681    if (revealClipPath) {
682        // if we can't simply use the caster's path directly, create a temporary one
683        SkPath* frameAllocatedPath = handler.allocPathForFrame();
684
685        // intersect the outline with the convex reveal clip
686        Op(*casterOutlinePath, *revealClipPath, kIntersect_PathOp, frameAllocatedPath);
687        outlinePath = frameAllocatedPath;
688    }
689
690    DisplayListOp* shadowOp  = new (handler.allocator()) DrawShadowOp(
691            shadowMatrixXY, shadowMatrixZ, casterAlpha, outlinePath);
692    handler(shadowOp, PROPERTY_SAVECOUNT, properties().getClipToBounds());
693}
694
695#define SHADOW_DELTA 0.1f
696
697template <class T>
698void RenderNode::issueOperationsOf3dChildren(ChildrenSelectMode mode,
699        const Matrix4& initialTransform, const Vector<ZDrawRenderNodeOpPair>& zTranslatedNodes,
700        OpenGLRenderer& renderer, T& handler) {
701    const int size = zTranslatedNodes.size();
702    if (size == 0
703            || (mode == kNegativeZChildren && zTranslatedNodes[0].key > 0.0f)
704            || (mode == kPositiveZChildren && zTranslatedNodes[size - 1].key < 0.0f)) {
705        // no 3d children to draw
706        return;
707    }
708
709    // Apply the base transform of the parent of the 3d children. This isolates
710    // 3d children of the current chunk from transformations made in previous chunks.
711    int rootRestoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
712    renderer.setMatrix(initialTransform);
713
714    /**
715     * Draw shadows and (potential) casters mostly in order, but allow the shadows of casters
716     * with very similar Z heights to draw together.
717     *
718     * This way, if Views A & B have the same Z height and are both casting shadows, the shadows are
719     * underneath both, and neither's shadow is drawn on top of the other.
720     */
721    const size_t nonNegativeIndex = findNonNegativeIndex(zTranslatedNodes);
722    size_t drawIndex, shadowIndex, endIndex;
723    if (mode == kNegativeZChildren) {
724        drawIndex = 0;
725        endIndex = nonNegativeIndex;
726        shadowIndex = endIndex; // draw no shadows
727    } else {
728        drawIndex = nonNegativeIndex;
729        endIndex = size;
730        shadowIndex = drawIndex; // potentially draw shadow for each pos Z child
731    }
732
733    DISPLAY_LIST_LOGD("%*s%d %s 3d children:", (handler.level() + 1) * 2, "",
734            endIndex - drawIndex, mode == kNegativeZChildren ? "negative" : "positive");
735
736    float lastCasterZ = 0.0f;
737    while (shadowIndex < endIndex || drawIndex < endIndex) {
738        if (shadowIndex < endIndex) {
739            DrawRenderNodeOp* casterOp = zTranslatedNodes[shadowIndex].value;
740            RenderNode* caster = casterOp->mRenderNode;
741            const float casterZ = zTranslatedNodes[shadowIndex].key;
742            // attempt to render the shadow if the caster about to be drawn is its caster,
743            // OR if its caster's Z value is similar to the previous potential caster
744            if (shadowIndex == drawIndex || casterZ - lastCasterZ < SHADOW_DELTA) {
745                caster->issueDrawShadowOperation(casterOp->mTransformFromParent, handler);
746
747                lastCasterZ = casterZ; // must do this even if current caster not casting a shadow
748                shadowIndex++;
749                continue;
750            }
751        }
752
753        // only the actual child DL draw needs to be in save/restore,
754        // since it modifies the renderer's matrix
755        int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
756
757        DrawRenderNodeOp* childOp = zTranslatedNodes[drawIndex].value;
758        RenderNode* child = childOp->mRenderNode;
759
760        renderer.concatMatrix(childOp->mTransformFromParent);
761        childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
762        handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds());
763        childOp->mSkipInOrderDraw = true;
764
765        renderer.restoreToCount(restoreTo);
766        drawIndex++;
767    }
768    renderer.restoreToCount(rootRestoreTo);
769}
770
771template <class T>
772void RenderNode::issueOperationsOfProjectedChildren(OpenGLRenderer& renderer, T& handler) {
773    DISPLAY_LIST_LOGD("%*s%d projected children:", (handler.level() + 1) * 2, "", mProjectedNodes.size());
774    const SkPath* projectionReceiverOutline = properties().getOutline().getPath();
775    int restoreTo = renderer.getSaveCount();
776
777    LinearAllocator& alloc = handler.allocator();
778    handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag),
779            PROPERTY_SAVECOUNT, properties().getClipToBounds());
780
781    // Transform renderer to match background we're projecting onto
782    // (by offsetting canvas by translationX/Y of background rendernode, since only those are set)
783    const DisplayListOp* op =
784            (mDisplayListData->displayListOps[mDisplayListData->projectionReceiveIndex]);
785    const DrawRenderNodeOp* backgroundOp = reinterpret_cast<const DrawRenderNodeOp*>(op);
786    const RenderProperties& backgroundProps = backgroundOp->mRenderNode->properties();
787    renderer.translate(backgroundProps.getTranslationX(), backgroundProps.getTranslationY());
788
789    // If the projection reciever has an outline, we mask each of the projected rendernodes to it
790    // Either with clipRect, or special saveLayer masking
791    if (projectionReceiverOutline != NULL) {
792        const SkRect& outlineBounds = projectionReceiverOutline->getBounds();
793        if (projectionReceiverOutline->isRect(NULL)) {
794            // mask to the rect outline simply with clipRect
795            ClipRectOp* clipOp = new (alloc) ClipRectOp(
796                    outlineBounds.left(), outlineBounds.top(),
797                    outlineBounds.right(), outlineBounds.bottom(), SkRegion::kIntersect_Op);
798            handler(clipOp, PROPERTY_SAVECOUNT, properties().getClipToBounds());
799        } else {
800            // wrap the projected RenderNodes with a SaveLayer that will mask to the outline
801            SaveLayerOp* op = new (alloc) SaveLayerOp(
802                    outlineBounds.left(), outlineBounds.top(),
803                    outlineBounds.right(), outlineBounds.bottom(),
804                    255, SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag | SkCanvas::kARGB_ClipLayer_SaveFlag);
805            op->setMask(projectionReceiverOutline);
806            handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
807
808            /* TODO: add optimizations here to take advantage of placement/size of projected
809             * children (which may shrink saveLayer area significantly). This is dependent on
810             * passing actual drawing/dirtying bounds of projected content down to native.
811             */
812        }
813    }
814
815    // draw projected nodes
816    for (size_t i = 0; i < mProjectedNodes.size(); i++) {
817        DrawRenderNodeOp* childOp = mProjectedNodes[i];
818
819        // matrix save, concat, and restore can be done safely without allocating operations
820        int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
821        renderer.concatMatrix(childOp->mTransformFromCompositingAncestor);
822        childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
823        handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds());
824        childOp->mSkipInOrderDraw = true;
825        renderer.restoreToCount(restoreTo);
826    }
827
828    if (projectionReceiverOutline != NULL) {
829        handler(new (alloc) RestoreToCountOp(restoreTo),
830                PROPERTY_SAVECOUNT, properties().getClipToBounds());
831    }
832}
833
834/**
835 * This function serves both defer and replay modes, and will organize the displayList's component
836 * operations for a single frame:
837 *
838 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of
839 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom
840 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the
841 * defer vs replay logic, per operation
842 */
843template <class T>
844void RenderNode::issueOperations(OpenGLRenderer& renderer, T& handler) {
845    const int level = handler.level();
846    if (mDisplayListData->isEmpty()) {
847        DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", level * 2, "", this, getName());
848        return;
849    }
850
851    const bool drawLayer = (mLayer && (&renderer != mLayer->renderer));
852    // If we are updating the contents of mLayer, we don't want to apply any of
853    // the RenderNode's properties to this issueOperations pass. Those will all
854    // be applied when the layer is drawn, aka when this is true.
855    const bool useViewProperties = (!mLayer || drawLayer);
856    if (useViewProperties) {
857        const Outline& outline = properties().getOutline();
858        if (properties().getAlpha() <= 0 || (outline.getShouldClip() && outline.isEmpty())) {
859            DISPLAY_LIST_LOGD("%*sRejected display list (%p, %s)", level * 2, "", this, getName());
860            return;
861        }
862    }
863
864    handler.startMark(getName());
865
866#if DEBUG_DISPLAY_LIST
867    const Rect& clipRect = renderer.getLocalClipBounds();
868    DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), localClipBounds: %.0f, %.0f, %.0f, %.0f",
869            level * 2, "", this, getName(),
870            clipRect.left, clipRect.top, clipRect.right, clipRect.bottom);
871#endif
872
873    LinearAllocator& alloc = handler.allocator();
874    int restoreTo = renderer.getSaveCount();
875    handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag),
876            PROPERTY_SAVECOUNT, properties().getClipToBounds());
877
878    DISPLAY_LIST_LOGD("%*sSave %d %d", (level + 1) * 2, "",
879            SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag, restoreTo);
880
881    if (useViewProperties) {
882        setViewProperties<T>(renderer, handler);
883    }
884
885    bool quickRejected = properties().getClipToBounds()
886            && renderer.quickRejectConservative(0, 0, properties().getWidth(), properties().getHeight());
887    if (!quickRejected) {
888        Matrix4 initialTransform(*(renderer.currentTransform()));
889
890        if (drawLayer) {
891            handler(new (alloc) DrawLayerOp(mLayer, 0, 0),
892                    renderer.getSaveCount() - 1, properties().getClipToBounds());
893        } else {
894            const int saveCountOffset = renderer.getSaveCount() - 1;
895            const int projectionReceiveIndex = mDisplayListData->projectionReceiveIndex;
896            DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
897            for (size_t chunkIndex = 0; chunkIndex < mDisplayListData->getChunks().size(); chunkIndex++) {
898                const DisplayListData::Chunk& chunk = mDisplayListData->getChunks()[chunkIndex];
899
900                Vector<ZDrawRenderNodeOpPair> zTranslatedNodes;
901                buildZSortedChildList(chunk, zTranslatedNodes);
902
903                issueOperationsOf3dChildren(kNegativeZChildren,
904                        initialTransform, zTranslatedNodes, renderer, handler);
905
906
907                for (int opIndex = chunk.beginOpIndex; opIndex < chunk.endOpIndex; opIndex++) {
908                    DisplayListOp *op = mDisplayListData->displayListOps[opIndex];
909#if DEBUG_DISPLAY_LIST
910                    op->output(level + 1);
911#endif
912                    logBuffer.writeCommand(level, op->name());
913                    handler(op, saveCountOffset, properties().getClipToBounds());
914
915                    if (CC_UNLIKELY(!mProjectedNodes.isEmpty() && opIndex == projectionReceiveIndex)) {
916                        issueOperationsOfProjectedChildren(renderer, handler);
917                    }
918                }
919
920                issueOperationsOf3dChildren(kPositiveZChildren,
921                        initialTransform, zTranslatedNodes, renderer, handler);
922            }
923        }
924    }
925
926    DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (level + 1) * 2, "", restoreTo);
927    handler(new (alloc) RestoreToCountOp(restoreTo),
928            PROPERTY_SAVECOUNT, properties().getClipToBounds());
929    renderer.setOverrideLayerAlpha(1.0f);
930
931    DISPLAY_LIST_LOGD("%*sDone (%p, %s)", level * 2, "", this, getName());
932    handler.endMark();
933}
934
935} /* namespace uirenderer */
936} /* namespace android */
937