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