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