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