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