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