RenderNode.cpp revision 44b49f070aafe8ad44efae87341121cce49ff11c 
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#include "RenderNode.h"
18
19#include "DamageAccumulator.h"
20#include "Debug.h"
21#if HWUI_NEW_OPS
22#include "BakedOpRenderer.h"
23#include "RecordedOp.h"
24#include "OpDumper.h"
25#endif
26#include "DisplayListOp.h"
27#include "LayerRenderer.h"
28#include "OpenGLRenderer.h"
29#include "TreeInfo.h"
30#include "utils/MathUtils.h"
31#include "utils/TraceUtils.h"
32#include "renderthread/CanvasContext.h"
33
34#include "protos/hwui.pb.h"
35#include "protos/ProtoHelpers.h"
36
37#include <algorithm>
38#include <sstream>
39#include <string>
40
41namespace android {
42namespace uirenderer {
43
44void RenderNode::debugDumpLayers(const char* prefix) {
45#if HWUI_NEW_OPS
46    LOG_ALWAYS_FATAL("TODO: dump layer");
47#else
48    if (mLayer) {
49        ALOGD("%sNode %p (%s) has layer %p (fbo = %u, wasBuildLayered = %s)",
50                prefix, this, getName(), mLayer, mLayer->getFbo(),
51                mLayer->wasBuildLayered ? "true" : "false");
52    }
53#endif
54    if (mDisplayList) {
55        for (auto&& child : mDisplayList->getChildren()) {
56            child->renderNode->debugDumpLayers(prefix);
57        }
58    }
59}
60
61RenderNode::RenderNode()
62        : mDirtyPropertyFields(0)
63        , mNeedsDisplayListSync(false)
64        , mDisplayList(nullptr)
65        , mStagingDisplayList(nullptr)
66        , mAnimatorManager(*this)
67        , mParentCount(0) {
68}
69
70RenderNode::~RenderNode() {
71    deleteDisplayList(nullptr);
72    delete mStagingDisplayList;
73#if HWUI_NEW_OPS
74    LOG_ALWAYS_FATAL_IF(mLayer, "layer missed detachment!");
75#else
76    if (mLayer) {
77        ALOGW("Memory Warning: Layer %p missed its detachment, held on to for far too long!", mLayer);
78        mLayer->postDecStrong();
79        mLayer = nullptr;
80    }
81#endif
82}
83
84void RenderNode::setStagingDisplayList(DisplayList* displayList) {
85    mNeedsDisplayListSync = true;
86    delete mStagingDisplayList;
87    mStagingDisplayList = displayList;
88    // If mParentCount == 0 we are the sole reference to this RenderNode,
89    // so immediately free the old display list
90    if (!mParentCount && !mStagingDisplayList) {
91        deleteDisplayList(nullptr);
92    }
93}
94
95/**
96 * This function is a simplified version of replay(), where we simply retrieve and log the
97 * display list. This function should remain in sync with the replay() function.
98 */
99#if HWUI_NEW_OPS
100void RenderNode::output(uint32_t level, const char* label) {
101    ALOGD("%s (%s %p%s%s%s%s%s)",
102            label,
103            getName(),
104            this,
105            (MathUtils::isZero(properties().getAlpha()) ? ", zero alpha" : ""),
106            (properties().hasShadow() ? ", casting shadow" : ""),
107            (isRenderable() ? "" : ", empty"),
108            (properties().getProjectBackwards() ? ", projected" : ""),
109            (mLayer != nullptr ? ", on HW Layer" : ""));
110    properties().debugOutputProperties(level + 1);
111
112    if (mDisplayList) {
113        for (auto&& op : mDisplayList->getOps()) {
114            std::stringstream strout;
115            OpDumper::dump(*op, strout, level + 1);
116            if (op->opId == RecordedOpId::RenderNodeOp) {
117                auto rnOp = reinterpret_cast<const RenderNodeOp*>(op);
118                rnOp->renderNode->output(level + 1, strout.str().c_str());
119            } else {
120                ALOGD("%s", strout.str().c_str());
121            }
122        }
123    }
124    ALOGD("%*s/RenderNode(%s %p)", level * 2, "", getName(), this);
125}
126#else
127void RenderNode::output(uint32_t level) {
128    ALOGD("%*sStart display list (%p, %s%s%s%s%s%s)", (level - 1) * 2, "", this,
129            getName(),
130            (MathUtils::isZero(properties().getAlpha()) ? ", zero alpha" : ""),
131            (properties().hasShadow() ? ", casting shadow" : ""),
132            (isRenderable() ? "" : ", empty"),
133            (properties().getProjectBackwards() ? ", projected" : ""),
134            (mLayer != nullptr ? ", on HW Layer" : ""));
135    ALOGD("%*s%s %d", level * 2, "", "Save", SaveFlags::MatrixClip);
136    properties().debugOutputProperties(level);
137    if (mDisplayList) {
138        // TODO: consider printing the chunk boundaries here
139        for (auto&& op : mDisplayList->getOps()) {
140            op->output(level, DisplayListOp::kOpLogFlag_Recurse);
141        }
142    }
143    ALOGD("%*sDone (%p, %s)", (level - 1) * 2, "", this, getName());
144    }
145#endif
146
147void RenderNode::copyTo(proto::RenderNode *pnode) {
148    pnode->set_id(static_cast<uint64_t>(
149            reinterpret_cast<uintptr_t>(this)));
150    pnode->set_name(mName.string(), mName.length());
151
152    proto::RenderProperties* pprops = pnode->mutable_properties();
153    pprops->set_left(properties().getLeft());
154    pprops->set_top(properties().getTop());
155    pprops->set_right(properties().getRight());
156    pprops->set_bottom(properties().getBottom());
157    pprops->set_clip_flags(properties().getClippingFlags());
158    pprops->set_alpha(properties().getAlpha());
159    pprops->set_translation_x(properties().getTranslationX());
160    pprops->set_translation_y(properties().getTranslationY());
161    pprops->set_translation_z(properties().getTranslationZ());
162    pprops->set_elevation(properties().getElevation());
163    pprops->set_rotation(properties().getRotation());
164    pprops->set_rotation_x(properties().getRotationX());
165    pprops->set_rotation_y(properties().getRotationY());
166    pprops->set_scale_x(properties().getScaleX());
167    pprops->set_scale_y(properties().getScaleY());
168    pprops->set_pivot_x(properties().getPivotX());
169    pprops->set_pivot_y(properties().getPivotY());
170    pprops->set_has_overlapping_rendering(properties().getHasOverlappingRendering());
171    pprops->set_pivot_explicitly_set(properties().isPivotExplicitlySet());
172    pprops->set_project_backwards(properties().getProjectBackwards());
173    pprops->set_projection_receiver(properties().isProjectionReceiver());
174    set(pprops->mutable_clip_bounds(), properties().getClipBounds());
175
176    const Outline& outline = properties().getOutline();
177    if (outline.getType() != Outline::Type::None) {
178        proto::Outline* poutline = pprops->mutable_outline();
179        poutline->clear_path();
180        if (outline.getType() == Outline::Type::Empty) {
181            poutline->set_type(proto::Outline_Type_Empty);
182        } else if (outline.getType() == Outline::Type::ConvexPath) {
183            poutline->set_type(proto::Outline_Type_ConvexPath);
184            if (const SkPath* path = outline.getPath()) {
185                set(poutline->mutable_path(), *path);
186            }
187        } else if (outline.getType() == Outline::Type::RoundRect) {
188            poutline->set_type(proto::Outline_Type_RoundRect);
189        } else {
190            ALOGW("Uknown outline type! %d", static_cast<int>(outline.getType()));
191            poutline->set_type(proto::Outline_Type_None);
192        }
193        poutline->set_should_clip(outline.getShouldClip());
194        poutline->set_alpha(outline.getAlpha());
195        poutline->set_radius(outline.getRadius());
196        set(poutline->mutable_bounds(), outline.getBounds());
197    } else {
198        pprops->clear_outline();
199    }
200
201    const RevealClip& revealClip = properties().getRevealClip();
202    if (revealClip.willClip()) {
203        proto::RevealClip* prevealClip = pprops->mutable_reveal_clip();
204        prevealClip->set_x(revealClip.getX());
205        prevealClip->set_y(revealClip.getY());
206        prevealClip->set_radius(revealClip.getRadius());
207    } else {
208        pprops->clear_reveal_clip();
209    }
210
211    pnode->clear_children();
212    if (mDisplayList) {
213        for (auto&& child : mDisplayList->getChildren()) {
214            child->renderNode->copyTo(pnode->add_children());
215        }
216    }
217}
218
219int RenderNode::getDebugSize() {
220    int size = sizeof(RenderNode);
221    if (mStagingDisplayList) {
222        size += mStagingDisplayList->getUsedSize();
223    }
224    if (mDisplayList && mDisplayList != mStagingDisplayList) {
225        size += mDisplayList->getUsedSize();
226    }
227    return size;
228}
229
230void RenderNode::prepareTree(TreeInfo& info) {
231    ATRACE_CALL();
232    LOG_ALWAYS_FATAL_IF(!info.damageAccumulator, "DamageAccumulator missing");
233
234    // Functors don't correctly handle stencil usage of overdraw debugging - shove 'em in a layer.
235    bool functorsNeedLayer = Properties::debugOverdraw;
236
237    prepareTreeImpl(info, functorsNeedLayer);
238}
239
240void RenderNode::addAnimator(const sp<BaseRenderNodeAnimator>& animator) {
241    mAnimatorManager.addAnimator(animator);
242}
243
244void RenderNode::removeAnimator(const sp<BaseRenderNodeAnimator>& animator) {
245    mAnimatorManager.removeAnimator(animator);
246}
247
248void RenderNode::damageSelf(TreeInfo& info) {
249    if (isRenderable()) {
250        if (properties().getClipDamageToBounds()) {
251            info.damageAccumulator->dirty(0, 0, properties().getWidth(), properties().getHeight());
252        } else {
253            // Hope this is big enough?
254            // TODO: Get this from the display list ops or something
255            info.damageAccumulator->dirty(DIRTY_MIN, DIRTY_MIN, DIRTY_MAX, DIRTY_MAX);
256        }
257    }
258}
259
260void RenderNode::prepareLayer(TreeInfo& info, uint32_t dirtyMask) {
261    LayerType layerType = properties().effectiveLayerType();
262    if (CC_UNLIKELY(layerType == LayerType::RenderLayer)) {
263        // Damage applied so far needs to affect our parent, but does not require
264        // the layer to be updated. So we pop/push here to clear out the current
265        // damage and get a clean state for display list or children updates to
266        // affect, which will require the layer to be updated
267        info.damageAccumulator->popTransform();
268        info.damageAccumulator->pushTransform(this);
269        if (dirtyMask & DISPLAY_LIST) {
270            damageSelf(info);
271        }
272    }
273}
274
275static layer_t* createLayer(RenderState& renderState, uint32_t width, uint32_t height) {
276#if HWUI_NEW_OPS
277    return renderState.layerPool().get(renderState, width, height);
278#else
279    return LayerRenderer::createRenderLayer(renderState, width, height);
280#endif
281}
282
283static void destroyLayer(layer_t* layer) {
284#if HWUI_NEW_OPS
285    RenderState& renderState = layer->renderState;
286    renderState.layerPool().putOrDelete(layer);
287#else
288    LayerRenderer::destroyLayer(layer);
289#endif
290}
291
292static bool layerMatchesWidthAndHeight(layer_t* layer, int width, int height) {
293#if HWUI_NEW_OPS
294    return layer->viewportWidth == (uint32_t) width && layer->viewportHeight == (uint32_t)height;
295#else
296    return layer->layer.getWidth() == width && layer->layer.getHeight() == height;
297#endif
298}
299
300void RenderNode::pushLayerUpdate(TreeInfo& info) {
301    LayerType layerType = properties().effectiveLayerType();
302    // If we are not a layer OR we cannot be rendered (eg, view was detached)
303    // we need to destroy any Layers we may have had previously
304    if (CC_LIKELY(layerType != LayerType::RenderLayer) || CC_UNLIKELY(!isRenderable())) {
305        if (CC_UNLIKELY(mLayer)) {
306            destroyLayer(mLayer);
307            mLayer = nullptr;
308        }
309        return;
310    }
311
312    bool transformUpdateNeeded = false;
313    if (!mLayer) {
314        mLayer = createLayer(info.canvasContext.getRenderState(), getWidth(), getHeight());
315#if !HWUI_NEW_OPS
316        applyLayerPropertiesToLayer(info);
317#endif
318        damageSelf(info);
319        transformUpdateNeeded = true;
320    } else if (!layerMatchesWidthAndHeight(mLayer, getWidth(), getHeight())) {
321#if HWUI_NEW_OPS
322        RenderState& renderState = mLayer->renderState;
323        if (properties().fitsOnLayer()) {
324            mLayer = renderState.layerPool().resize(mLayer, getWidth(), getHeight());
325        } else {
326#else
327        if (!LayerRenderer::resizeLayer(mLayer, getWidth(), getHeight())) {
328#endif
329            destroyLayer(mLayer);
330            mLayer = nullptr;
331        }
332        damageSelf(info);
333        transformUpdateNeeded = true;
334    }
335
336    SkRect dirty;
337    info.damageAccumulator->peekAtDirty(&dirty);
338
339    if (!mLayer) {
340        Caches::getInstance().dumpMemoryUsage();
341        if (info.errorHandler) {
342            std::ostringstream err;
343            err << "Unable to create layer for " << getName();
344            const int maxTextureSize = Caches::getInstance().maxTextureSize;
345            if (getWidth() > maxTextureSize || getHeight() > maxTextureSize) {
346                err << ", size " << getWidth() << "x" << getHeight()
347                        << " exceeds max size " << maxTextureSize;
348            } else {
349                err << ", see logcat for more info";
350            }
351            info.errorHandler->onError(err.str());
352        }
353        return;
354    }
355
356    if (transformUpdateNeeded && mLayer) {
357        // update the transform in window of the layer to reset its origin wrt light source position
358        Matrix4 windowTransform;
359        info.damageAccumulator->computeCurrentTransform(&windowTransform);
360        mLayer->setWindowTransform(windowTransform);
361    }
362
363#if HWUI_NEW_OPS
364    info.layerUpdateQueue->enqueueLayerWithDamage(this, dirty);
365#else
366    if (dirty.intersect(0, 0, getWidth(), getHeight())) {
367        dirty.roundOut(&dirty);
368        mLayer->updateDeferred(this, dirty.fLeft, dirty.fTop, dirty.fRight, dirty.fBottom);
369    }
370    // This is not inside the above if because we may have called
371    // updateDeferred on a previous prepare pass that didn't have a renderer
372    if (info.renderer && mLayer->deferredUpdateScheduled) {
373        info.renderer->pushLayerUpdate(mLayer);
374    }
375#endif
376
377    // There might be prefetched layers that need to be accounted for.
378    // That might be us, so tell CanvasContext that this layer is in the
379    // tree and should not be destroyed.
380    info.canvasContext.markLayerInUse(this);
381}
382
383/**
384 * Traverse down the the draw tree to prepare for a frame.
385 *
386 * MODE_FULL = UI Thread-driven (thus properties must be synced), otherwise RT driven
387 *
388 * While traversing down the tree, functorsNeedLayer flag is set to true if anything that uses the
389 * stencil buffer may be needed. Views that use a functor to draw will be forced onto a layer.
390 */
391void RenderNode::prepareTreeImpl(TreeInfo& info, bool functorsNeedLayer) {
392    info.damageAccumulator->pushTransform(this);
393
394    if (info.mode == TreeInfo::MODE_FULL) {
395        pushStagingPropertiesChanges(info);
396    }
397    uint32_t animatorDirtyMask = 0;
398    if (CC_LIKELY(info.runAnimations)) {
399        animatorDirtyMask = mAnimatorManager.animate(info);
400    }
401
402    bool willHaveFunctor = false;
403    if (info.mode == TreeInfo::MODE_FULL && mStagingDisplayList) {
404        willHaveFunctor = !mStagingDisplayList->getFunctors().empty();
405    } else if (mDisplayList) {
406        willHaveFunctor = !mDisplayList->getFunctors().empty();
407    }
408    bool childFunctorsNeedLayer = mProperties.prepareForFunctorPresence(
409            willHaveFunctor, functorsNeedLayer);
410
411    if (CC_UNLIKELY(mPositionListener.get())) {
412        mPositionListener->onPositionUpdated(*this, info);
413    }
414
415    prepareLayer(info, animatorDirtyMask);
416    if (info.mode == TreeInfo::MODE_FULL) {
417        pushStagingDisplayListChanges(info);
418    }
419    prepareSubTree(info, childFunctorsNeedLayer, mDisplayList);
420    pushLayerUpdate(info);
421
422    info.damageAccumulator->popTransform();
423}
424
425void RenderNode::syncProperties() {
426    mProperties = mStagingProperties;
427}
428
429void RenderNode::pushStagingPropertiesChanges(TreeInfo& info) {
430    // Push the animators first so that setupStartValueIfNecessary() is called
431    // before properties() is trampled by stagingProperties(), as they are
432    // required by some animators.
433    if (CC_LIKELY(info.runAnimations)) {
434        mAnimatorManager.pushStaging();
435    }
436    if (mDirtyPropertyFields) {
437        mDirtyPropertyFields = 0;
438        damageSelf(info);
439        info.damageAccumulator->popTransform();
440        syncProperties();
441#if !HWUI_NEW_OPS
442        applyLayerPropertiesToLayer(info);
443#endif
444        // We could try to be clever and only re-damage if the matrix changed.
445        // However, we don't need to worry about that. The cost of over-damaging
446        // here is only going to be a single additional map rect of this node
447        // plus a rect join(). The parent's transform (and up) will only be
448        // performed once.
449        info.damageAccumulator->pushTransform(this);
450        damageSelf(info);
451    }
452}
453
454#if !HWUI_NEW_OPS
455void RenderNode::applyLayerPropertiesToLayer(TreeInfo& info) {
456    if (CC_LIKELY(!mLayer)) return;
457
458    const LayerProperties& props = properties().layerProperties();
459    mLayer->setAlpha(props.alpha(), props.xferMode());
460    mLayer->setColorFilter(props.colorFilter());
461    mLayer->setBlend(props.needsBlending());
462}
463#endif
464
465void RenderNode::syncDisplayList(TreeObserver* observer) {
466    // Make sure we inc first so that we don't fluctuate between 0 and 1,
467    // which would thrash the layer cache
468    if (mStagingDisplayList) {
469        for (auto&& child : mStagingDisplayList->getChildren()) {
470            child->renderNode->incParentRefCount();
471        }
472    }
473    deleteDisplayList(observer);
474    mDisplayList = mStagingDisplayList;
475    mStagingDisplayList = nullptr;
476    if (mDisplayList) {
477        for (size_t i = 0; i < mDisplayList->getFunctors().size(); i++) {
478            (*mDisplayList->getFunctors()[i])(DrawGlInfo::kModeSync, nullptr);
479        }
480    }
481}
482
483void RenderNode::pushStagingDisplayListChanges(TreeInfo& info) {
484    if (mNeedsDisplayListSync) {
485        mNeedsDisplayListSync = false;
486        // Damage with the old display list first then the new one to catch any
487        // changes in isRenderable or, in the future, bounds
488        damageSelf(info);
489        syncDisplayList(info.observer);
490        damageSelf(info);
491    }
492}
493
494void RenderNode::deleteDisplayList(TreeObserver* observer) {
495    if (mDisplayList) {
496        for (auto&& child : mDisplayList->getChildren()) {
497            child->renderNode->decParentRefCount(observer);
498        }
499    }
500    delete mDisplayList;
501    mDisplayList = nullptr;
502}
503
504void RenderNode::prepareSubTree(TreeInfo& info, bool functorsNeedLayer, DisplayList* subtree) {
505    if (subtree) {
506        TextureCache& cache = Caches::getInstance().textureCache;
507        info.out.hasFunctors |= subtree->getFunctors().size();
508        for (auto&& bitmapResource : subtree->getBitmapResources()) {
509            void* ownerToken = &info.canvasContext;
510            info.prepareTextures = cache.prefetchAndMarkInUse(ownerToken, bitmapResource);
511        }
512        for (auto&& op : subtree->getChildren()) {
513            RenderNode* childNode = op->renderNode;
514#if HWUI_NEW_OPS
515            info.damageAccumulator->pushTransform(&op->localMatrix);
516            bool childFunctorsNeedLayer = functorsNeedLayer; // TODO! || op->mRecordedWithPotentialStencilClip;
517#else
518            info.damageAccumulator->pushTransform(&op->localMatrix);
519            bool childFunctorsNeedLayer = functorsNeedLayer
520                    // Recorded with non-rect clip, or canvas-rotated by parent
521                    || op->mRecordedWithPotentialStencilClip;
522#endif
523            childNode->prepareTreeImpl(info, childFunctorsNeedLayer);
524            info.damageAccumulator->popTransform();
525        }
526    }
527}
528
529void RenderNode::destroyHardwareResources(TreeObserver* observer) {
530    if (mLayer) {
531        destroyLayer(mLayer);
532        mLayer = nullptr;
533    }
534    if (mDisplayList) {
535        for (auto&& child : mDisplayList->getChildren()) {
536            child->renderNode->destroyHardwareResources(observer);
537        }
538        if (mNeedsDisplayListSync) {
539            // Next prepare tree we are going to push a new display list, so we can
540            // drop our current one now
541            deleteDisplayList(observer);
542        }
543    }
544}
545
546void RenderNode::decParentRefCount(TreeObserver* observer) {
547    LOG_ALWAYS_FATAL_IF(!mParentCount, "already 0!");
548    mParentCount--;
549    if (!mParentCount) {
550        if (observer) {
551            observer->onMaybeRemovedFromTree(this);
552        }
553        // If a child of ours is being attached to our parent then this will incorrectly
554        // destroy its hardware resources. However, this situation is highly unlikely
555        // and the failure is "just" that the layer is re-created, so this should
556        // be safe enough
557        destroyHardwareResources(observer);
558    }
559}
560
561/*
562 * For property operations, we pass a savecount of 0, since the operations aren't part of the
563 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in
564 * base saveCount (i.e., how RestoreToCount uses saveCount + properties().getCount())
565 */
566#define PROPERTY_SAVECOUNT 0
567
568template <class T>
569void RenderNode::setViewProperties(OpenGLRenderer& renderer, T& handler) {
570#if DEBUG_DISPLAY_LIST
571    properties().debugOutputProperties(handler.level() + 1);
572#endif
573    if (properties().getLeft() != 0 || properties().getTop() != 0) {
574        renderer.translate(properties().getLeft(), properties().getTop());
575    }
576    if (properties().getStaticMatrix()) {
577        renderer.concatMatrix(*properties().getStaticMatrix());
578    } else if (properties().getAnimationMatrix()) {
579        renderer.concatMatrix(*properties().getAnimationMatrix());
580    }
581    if (properties().hasTransformMatrix()) {
582        if (properties().isTransformTranslateOnly()) {
583            renderer.translate(properties().getTranslationX(), properties().getTranslationY());
584        } else {
585            renderer.concatMatrix(*properties().getTransformMatrix());
586        }
587    }
588    const bool isLayer = properties().effectiveLayerType() != LayerType::None;
589    int clipFlags = properties().getClippingFlags();
590    if (properties().getAlpha() < 1) {
591        if (isLayer) {
592            clipFlags &= ~CLIP_TO_BOUNDS; // bounds clipping done by layer
593        }
594        if (CC_LIKELY(isLayer || !properties().getHasOverlappingRendering())) {
595            // simply scale rendering content's alpha
596            renderer.scaleAlpha(properties().getAlpha());
597        } else {
598            // savelayer needed to create an offscreen buffer
599            Rect layerBounds(0, 0, getWidth(), getHeight());
600            if (clipFlags) {
601                properties().getClippingRectForFlags(clipFlags, &layerBounds);
602                clipFlags = 0; // all clipping done by savelayer
603            }
604            SaveLayerOp* op = new (handler.allocator()) SaveLayerOp(
605                    layerBounds.left, layerBounds.top,
606                    layerBounds.right, layerBounds.bottom,
607                    (int) (properties().getAlpha() * 255),
608                    SaveFlags::HasAlphaLayer | SaveFlags::ClipToLayer);
609            handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
610        }
611
612        if (CC_UNLIKELY(ATRACE_ENABLED() && properties().promotedToLayer())) {
613            // pretend alpha always causes savelayer to warn about
614            // performance problem affecting old versions
615            ATRACE_FORMAT("%s alpha caused saveLayer %dx%d", getName(),
616                    static_cast<int>(getWidth()),
617                    static_cast<int>(getHeight()));
618        }
619    }
620    if (clipFlags) {
621        Rect clipRect;
622        properties().getClippingRectForFlags(clipFlags, &clipRect);
623        ClipRectOp* op = new (handler.allocator()) ClipRectOp(
624                clipRect.left, clipRect.top, clipRect.right, clipRect.bottom,
625                SkRegion::kIntersect_Op);
626        handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
627    }
628
629    // TODO: support nesting round rect clips
630    if (mProperties.getRevealClip().willClip()) {
631        Rect bounds;
632        mProperties.getRevealClip().getBounds(&bounds);
633        renderer.setClippingRoundRect(handler.allocator(), bounds, mProperties.getRevealClip().getRadius());
634    } else if (mProperties.getOutline().willClip()) {
635        renderer.setClippingOutline(handler.allocator(), &(mProperties.getOutline()));
636    }
637}
638
639/**
640 * Apply property-based transformations to input matrix
641 *
642 * If true3dTransform is set to true, the transform applied to the input matrix will use true 4x4
643 * matrix computation instead of the Skia 3x3 matrix + camera hackery.
644 */
645void RenderNode::applyViewPropertyTransforms(mat4& matrix, bool true3dTransform) const {
646    if (properties().getLeft() != 0 || properties().getTop() != 0) {
647        matrix.translate(properties().getLeft(), properties().getTop());
648    }
649    if (properties().getStaticMatrix()) {
650        mat4 stat(*properties().getStaticMatrix());
651        matrix.multiply(stat);
652    } else if (properties().getAnimationMatrix()) {
653        mat4 anim(*properties().getAnimationMatrix());
654        matrix.multiply(anim);
655    }
656
657    bool applyTranslationZ = true3dTransform && !MathUtils::isZero(properties().getZ());
658    if (properties().hasTransformMatrix() || applyTranslationZ) {
659        if (properties().isTransformTranslateOnly()) {
660            matrix.translate(properties().getTranslationX(), properties().getTranslationY(),
661                    true3dTransform ? properties().getZ() : 0.0f);
662        } else {
663            if (!true3dTransform) {
664                matrix.multiply(*properties().getTransformMatrix());
665            } else {
666                mat4 true3dMat;
667                true3dMat.loadTranslate(
668                        properties().getPivotX() + properties().getTranslationX(),
669                        properties().getPivotY() + properties().getTranslationY(),
670                        properties().getZ());
671                true3dMat.rotate(properties().getRotationX(), 1, 0, 0);
672                true3dMat.rotate(properties().getRotationY(), 0, 1, 0);
673                true3dMat.rotate(properties().getRotation(), 0, 0, 1);
674                true3dMat.scale(properties().getScaleX(), properties().getScaleY(), 1);
675                true3dMat.translate(-properties().getPivotX(), -properties().getPivotY());
676
677                matrix.multiply(true3dMat);
678            }
679        }
680    }
681}
682
683/**
684 * Organizes the DisplayList hierarchy to prepare for background projection reordering.
685 *
686 * This should be called before a call to defer() or drawDisplayList()
687 *
688 * Each DisplayList that serves as a 3d root builds its list of composited children,
689 * which are flagged to not draw in the standard draw loop.
690 */
691void RenderNode::computeOrdering() {
692    ATRACE_CALL();
693    mProjectedNodes.clear();
694
695    // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that
696    // transform properties are applied correctly to top level children
697    if (mDisplayList == nullptr) return;
698    for (unsigned int i = 0; i < mDisplayList->getChildren().size(); i++) {
699        renderNodeOp_t* childOp = mDisplayList->getChildren()[i];
700        childOp->renderNode->computeOrderingImpl(childOp, &mProjectedNodes, &mat4::identity());
701    }
702}
703
704void RenderNode::computeOrderingImpl(
705        renderNodeOp_t* opState,
706        std::vector<renderNodeOp_t*>* compositedChildrenOfProjectionSurface,
707        const mat4* transformFromProjectionSurface) {
708    mProjectedNodes.clear();
709    if (mDisplayList == nullptr || mDisplayList->isEmpty()) return;
710
711    // TODO: should avoid this calculation in most cases
712    // TODO: just calculate single matrix, down to all leaf composited elements
713    Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface);
714    localTransformFromProjectionSurface.multiply(opState->localMatrix);
715
716    if (properties().getProjectBackwards()) {
717        // composited projectee, flag for out of order draw, save matrix, and store in proj surface
718        opState->skipInOrderDraw = true;
719        opState->transformFromCompositingAncestor = localTransformFromProjectionSurface;
720        compositedChildrenOfProjectionSurface->push_back(opState);
721    } else {
722        // standard in order draw
723        opState->skipInOrderDraw = false;
724    }
725
726    if (mDisplayList->getChildren().size() > 0) {
727        const bool isProjectionReceiver = mDisplayList->projectionReceiveIndex >= 0;
728        bool haveAppliedPropertiesToProjection = false;
729        for (unsigned int i = 0; i < mDisplayList->getChildren().size(); i++) {
730            renderNodeOp_t* childOp = mDisplayList->getChildren()[i];
731            RenderNode* child = childOp->renderNode;
732
733            std::vector<renderNodeOp_t*>* projectionChildren = nullptr;
734            const mat4* projectionTransform = nullptr;
735            if (isProjectionReceiver && !child->properties().getProjectBackwards()) {
736                // if receiving projections, collect projecting descendant
737
738                // Note that if a direct descendant is projecting backwards, we pass its
739                // grandparent projection collection, since it shouldn't project onto its
740                // parent, where it will already be drawing.
741                projectionChildren = &mProjectedNodes;
742                projectionTransform = &mat4::identity();
743            } else {
744                if (!haveAppliedPropertiesToProjection) {
745                    applyViewPropertyTransforms(localTransformFromProjectionSurface);
746                    haveAppliedPropertiesToProjection = true;
747                }
748                projectionChildren = compositedChildrenOfProjectionSurface;
749                projectionTransform = &localTransformFromProjectionSurface;
750            }
751            child->computeOrderingImpl(childOp, projectionChildren, projectionTransform);
752        }
753    }
754}
755
756class DeferOperationHandler {
757public:
758    DeferOperationHandler(DeferStateStruct& deferStruct, int level)
759        : mDeferStruct(deferStruct), mLevel(level) {}
760    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
761        operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds);
762    }
763    inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); }
764    inline void startMark(const char* name) {} // do nothing
765    inline void endMark() {}
766    inline int level() { return mLevel; }
767    inline int replayFlags() { return mDeferStruct.mReplayFlags; }
768    inline SkPath* allocPathForFrame() { return mDeferStruct.allocPathForFrame(); }
769
770private:
771    DeferStateStruct& mDeferStruct;
772    const int mLevel;
773};
774
775void RenderNode::defer(DeferStateStruct& deferStruct, const int level) {
776    DeferOperationHandler handler(deferStruct, level);
777    issueOperations<DeferOperationHandler>(deferStruct.mRenderer, handler);
778}
779
780class ReplayOperationHandler {
781public:
782    ReplayOperationHandler(ReplayStateStruct& replayStruct, int level)
783        : mReplayStruct(replayStruct), mLevel(level) {}
784    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
785#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS
786        mReplayStruct.mRenderer.eventMark(operation->name());
787#endif
788        operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds);
789    }
790    inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); }
791    inline void startMark(const char* name) {
792        mReplayStruct.mRenderer.startMark(name);
793    }
794    inline void endMark() {
795        mReplayStruct.mRenderer.endMark();
796    }
797    inline int level() { return mLevel; }
798    inline int replayFlags() { return mReplayStruct.mReplayFlags; }
799    inline SkPath* allocPathForFrame() { return mReplayStruct.allocPathForFrame(); }
800
801private:
802    ReplayStateStruct& mReplayStruct;
803    const int mLevel;
804};
805
806void RenderNode::replay(ReplayStateStruct& replayStruct, const int level) {
807    ReplayOperationHandler handler(replayStruct, level);
808    issueOperations<ReplayOperationHandler>(replayStruct.mRenderer, handler);
809}
810
811void RenderNode::buildZSortedChildList(const DisplayList::Chunk& chunk,
812        std::vector<ZDrawRenderNodeOpPair>& zTranslatedNodes) {
813#if !HWUI_NEW_OPS
814    if (chunk.beginChildIndex == chunk.endChildIndex) return;
815
816    for (unsigned int i = chunk.beginChildIndex; i < chunk.endChildIndex; i++) {
817        DrawRenderNodeOp* childOp = mDisplayList->getChildren()[i];
818        RenderNode* child = childOp->renderNode;
819        float childZ = child->properties().getZ();
820
821        if (!MathUtils::isZero(childZ) && chunk.reorderChildren) {
822            zTranslatedNodes.push_back(ZDrawRenderNodeOpPair(childZ, childOp));
823            childOp->skipInOrderDraw = true;
824        } else if (!child->properties().getProjectBackwards()) {
825            // regular, in order drawing DisplayList
826            childOp->skipInOrderDraw = false;
827        }
828    }
829
830    // Z sort any 3d children (stable-ness makes z compare fall back to standard drawing order)
831    std::stable_sort(zTranslatedNodes.begin(), zTranslatedNodes.end());
832#endif
833}
834
835template <class T>
836void RenderNode::issueDrawShadowOperation(const Matrix4& transformFromParent, T& handler) {
837    if (properties().getAlpha() <= 0.0f
838            || properties().getOutline().getAlpha() <= 0.0f
839            || !properties().getOutline().getPath()
840            || properties().getScaleX() == 0
841            || properties().getScaleY() == 0) {
842        // no shadow to draw
843        return;
844    }
845
846    mat4 shadowMatrixXY(transformFromParent);
847    applyViewPropertyTransforms(shadowMatrixXY);
848
849    // Z matrix needs actual 3d transformation, so mapped z values will be correct
850    mat4 shadowMatrixZ(transformFromParent);
851    applyViewPropertyTransforms(shadowMatrixZ, true);
852
853    const SkPath* casterOutlinePath = properties().getOutline().getPath();
854    const SkPath* revealClipPath = properties().getRevealClip().getPath();
855    if (revealClipPath && revealClipPath->isEmpty()) return;
856
857    float casterAlpha = properties().getAlpha() * properties().getOutline().getAlpha();
858
859
860    // holds temporary SkPath to store the result of intersections
861    SkPath* frameAllocatedPath = nullptr;
862    const SkPath* outlinePath = casterOutlinePath;
863
864    // intersect the outline with the reveal clip, if present
865    if (revealClipPath) {
866        frameAllocatedPath = handler.allocPathForFrame();
867
868        Op(*outlinePath, *revealClipPath, kIntersect_SkPathOp, frameAllocatedPath);
869        outlinePath = frameAllocatedPath;
870    }
871
872    // intersect the outline with the clipBounds, if present
873    if (properties().getClippingFlags() & CLIP_TO_CLIP_BOUNDS) {
874        if (!frameAllocatedPath) {
875            frameAllocatedPath = handler.allocPathForFrame();
876        }
877
878        Rect clipBounds;
879        properties().getClippingRectForFlags(CLIP_TO_CLIP_BOUNDS, &clipBounds);
880        SkPath clipBoundsPath;
881        clipBoundsPath.addRect(clipBounds.left, clipBounds.top,
882                clipBounds.right, clipBounds.bottom);
883
884        Op(*outlinePath, clipBoundsPath, kIntersect_SkPathOp, frameAllocatedPath);
885        outlinePath = frameAllocatedPath;
886    }
887
888    DisplayListOp* shadowOp  = new (handler.allocator()) DrawShadowOp(
889            shadowMatrixXY, shadowMatrixZ, casterAlpha, outlinePath);
890    handler(shadowOp, PROPERTY_SAVECOUNT, properties().getClipToBounds());
891}
892
893#define SHADOW_DELTA 0.1f
894
895template <class T>
896void RenderNode::issueOperationsOf3dChildren(ChildrenSelectMode mode,
897        const Matrix4& initialTransform, const std::vector<ZDrawRenderNodeOpPair>& zTranslatedNodes,
898        OpenGLRenderer& renderer, T& handler) {
899    const int size = zTranslatedNodes.size();
900    if (size == 0
901            || (mode == ChildrenSelectMode::NegativeZChildren && zTranslatedNodes[0].key > 0.0f)
902            || (mode == ChildrenSelectMode::PositiveZChildren && zTranslatedNodes[size - 1].key < 0.0f)) {
903        // no 3d children to draw
904        return;
905    }
906
907    // Apply the base transform of the parent of the 3d children. This isolates
908    // 3d children of the current chunk from transformations made in previous chunks.
909    int rootRestoreTo = renderer.save(SaveFlags::Matrix);
910    renderer.setGlobalMatrix(initialTransform);
911
912    /**
913     * Draw shadows and (potential) casters mostly in order, but allow the shadows of casters
914     * with very similar Z heights to draw together.
915     *
916     * This way, if Views A & B have the same Z height and are both casting shadows, the shadows are
917     * underneath both, and neither's shadow is drawn on top of the other.
918     */
919    const size_t nonNegativeIndex = findNonNegativeIndex(zTranslatedNodes);
920    size_t drawIndex, shadowIndex, endIndex;
921    if (mode == ChildrenSelectMode::NegativeZChildren) {
922        drawIndex = 0;
923        endIndex = nonNegativeIndex;
924        shadowIndex = endIndex; // draw no shadows
925    } else {
926        drawIndex = nonNegativeIndex;
927        endIndex = size;
928        shadowIndex = drawIndex; // potentially draw shadow for each pos Z child
929    }
930
931    DISPLAY_LIST_LOGD("%*s%d %s 3d children:", (handler.level() + 1) * 2, "",
932            endIndex - drawIndex, mode == kNegativeZChildren ? "negative" : "positive");
933
934    float lastCasterZ = 0.0f;
935    while (shadowIndex < endIndex || drawIndex < endIndex) {
936        if (shadowIndex < endIndex) {
937            DrawRenderNodeOp* casterOp = zTranslatedNodes[shadowIndex].value;
938            RenderNode* caster = casterOp->renderNode;
939            const float casterZ = zTranslatedNodes[shadowIndex].key;
940            // attempt to render the shadow if the caster about to be drawn is its caster,
941            // OR if its caster's Z value is similar to the previous potential caster
942            if (shadowIndex == drawIndex || casterZ - lastCasterZ < SHADOW_DELTA) {
943                caster->issueDrawShadowOperation(casterOp->localMatrix, handler);
944
945                lastCasterZ = casterZ; // must do this even if current caster not casting a shadow
946                shadowIndex++;
947                continue;
948            }
949        }
950
951        // only the actual child DL draw needs to be in save/restore,
952        // since it modifies the renderer's matrix
953        int restoreTo = renderer.save(SaveFlags::Matrix);
954
955        DrawRenderNodeOp* childOp = zTranslatedNodes[drawIndex].value;
956
957        renderer.concatMatrix(childOp->localMatrix);
958        childOp->skipInOrderDraw = false; // this is horrible, I'm so sorry everyone
959        handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds());
960        childOp->skipInOrderDraw = true;
961
962        renderer.restoreToCount(restoreTo);
963        drawIndex++;
964    }
965    renderer.restoreToCount(rootRestoreTo);
966}
967
968template <class T>
969void RenderNode::issueOperationsOfProjectedChildren(OpenGLRenderer& renderer, T& handler) {
970    DISPLAY_LIST_LOGD("%*s%d projected children:", (handler.level() + 1) * 2, "", mProjectedNodes.size());
971    const SkPath* projectionReceiverOutline = properties().getOutline().getPath();
972    int restoreTo = renderer.getSaveCount();
973
974    LinearAllocator& alloc = handler.allocator();
975    handler(new (alloc) SaveOp(SaveFlags::MatrixClip),
976            PROPERTY_SAVECOUNT, properties().getClipToBounds());
977
978    // Transform renderer to match background we're projecting onto
979    // (by offsetting canvas by translationX/Y of background rendernode, since only those are set)
980    const DisplayListOp* op =
981#if HWUI_NEW_OPS
982            nullptr;
983    LOG_ALWAYS_FATAL("unsupported");
984#else
985            (mDisplayList->getOps()[mDisplayList->projectionReceiveIndex]);
986#endif
987    const DrawRenderNodeOp* backgroundOp = reinterpret_cast<const DrawRenderNodeOp*>(op);
988    const RenderProperties& backgroundProps = backgroundOp->renderNode->properties();
989    renderer.translate(backgroundProps.getTranslationX(), backgroundProps.getTranslationY());
990
991    // If the projection receiver has an outline, we mask projected content to it
992    // (which we know, apriori, are all tessellated paths)
993    renderer.setProjectionPathMask(alloc, projectionReceiverOutline);
994
995    // draw projected nodes
996    for (size_t i = 0; i < mProjectedNodes.size(); i++) {
997        renderNodeOp_t* childOp = mProjectedNodes[i];
998
999        // matrix save, concat, and restore can be done safely without allocating operations
1000        int restoreTo = renderer.save(SaveFlags::Matrix);
1001        renderer.concatMatrix(childOp->transformFromCompositingAncestor);
1002        childOp->skipInOrderDraw = false; // this is horrible, I'm so sorry everyone
1003        handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds());
1004        childOp->skipInOrderDraw = true;
1005        renderer.restoreToCount(restoreTo);
1006    }
1007
1008    handler(new (alloc) RestoreToCountOp(restoreTo),
1009            PROPERTY_SAVECOUNT, properties().getClipToBounds());
1010}
1011
1012/**
1013 * This function serves both defer and replay modes, and will organize the displayList's component
1014 * operations for a single frame:
1015 *
1016 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of
1017 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom
1018 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the
1019 * defer vs replay logic, per operation
1020 */
1021template <class T>
1022void RenderNode::issueOperations(OpenGLRenderer& renderer, T& handler) {
1023    if (mDisplayList->isEmpty()) {
1024        DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", handler.level() * 2, "",
1025                this, getName());
1026        return;
1027    }
1028
1029#if HWUI_NEW_OPS
1030    const bool drawLayer = false;
1031#else
1032    const bool drawLayer = (mLayer && (&renderer != mLayer->renderer.get()));
1033#endif
1034    // If we are updating the contents of mLayer, we don't want to apply any of
1035    // the RenderNode's properties to this issueOperations pass. Those will all
1036    // be applied when the layer is drawn, aka when this is true.
1037    const bool useViewProperties = (!mLayer || drawLayer);
1038    if (useViewProperties) {
1039        const Outline& outline = properties().getOutline();
1040        if (properties().getAlpha() <= 0
1041                || (outline.getShouldClip() && outline.isEmpty())
1042                || properties().getScaleX() == 0
1043                || properties().getScaleY() == 0) {
1044            DISPLAY_LIST_LOGD("%*sRejected display list (%p, %s)", handler.level() * 2, "",
1045                    this, getName());
1046            return;
1047        }
1048    }
1049
1050    handler.startMark(getName());
1051
1052#if DEBUG_DISPLAY_LIST
1053    const Rect& clipRect = renderer.getLocalClipBounds();
1054    DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), localClipBounds: %.0f, %.0f, %.0f, %.0f",
1055            handler.level() * 2, "", this, getName(),
1056            clipRect.left, clipRect.top, clipRect.right, clipRect.bottom);
1057#endif
1058
1059    LinearAllocator& alloc = handler.allocator();
1060    int restoreTo = renderer.getSaveCount();
1061    handler(new (alloc) SaveOp(SaveFlags::MatrixClip),
1062            PROPERTY_SAVECOUNT, properties().getClipToBounds());
1063
1064    DISPLAY_LIST_LOGD("%*sSave %d %d", (handler.level() + 1) * 2, "",
1065            SaveFlags::MatrixClip, restoreTo);
1066
1067    if (useViewProperties) {
1068        setViewProperties<T>(renderer, handler);
1069    }
1070
1071#if HWUI_NEW_OPS
1072    LOG_ALWAYS_FATAL("legacy op traversal not supported");
1073#else
1074    bool quickRejected = properties().getClipToBounds()
1075            && renderer.quickRejectConservative(0, 0, properties().getWidth(), properties().getHeight());
1076    if (!quickRejected) {
1077        Matrix4 initialTransform(*(renderer.currentTransform()));
1078        renderer.setBaseTransform(initialTransform);
1079
1080        if (drawLayer) {
1081            handler(new (alloc) DrawLayerOp(mLayer),
1082                    renderer.getSaveCount() - 1, properties().getClipToBounds());
1083        } else {
1084            const int saveCountOffset = renderer.getSaveCount() - 1;
1085            const int projectionReceiveIndex = mDisplayList->projectionReceiveIndex;
1086            for (size_t chunkIndex = 0; chunkIndex < mDisplayList->getChunks().size(); chunkIndex++) {
1087                const DisplayList::Chunk& chunk = mDisplayList->getChunks()[chunkIndex];
1088
1089                std::vector<ZDrawRenderNodeOpPair> zTranslatedNodes;
1090                buildZSortedChildList(chunk, zTranslatedNodes);
1091
1092                issueOperationsOf3dChildren(ChildrenSelectMode::NegativeZChildren,
1093                        initialTransform, zTranslatedNodes, renderer, handler);
1094
1095                for (size_t opIndex = chunk.beginOpIndex; opIndex < chunk.endOpIndex; opIndex++) {
1096                    DisplayListOp *op = mDisplayList->getOps()[opIndex];
1097#if DEBUG_DISPLAY_LIST
1098                    op->output(handler.level() + 1);
1099#endif
1100                    handler(op, saveCountOffset, properties().getClipToBounds());
1101
1102                    if (CC_UNLIKELY(!mProjectedNodes.empty() && projectionReceiveIndex >= 0 &&
1103                        opIndex == static_cast<size_t>(projectionReceiveIndex))) {
1104                        issueOperationsOfProjectedChildren(renderer, handler);
1105                    }
1106                }
1107
1108                issueOperationsOf3dChildren(ChildrenSelectMode::PositiveZChildren,
1109                        initialTransform, zTranslatedNodes, renderer, handler);
1110            }
1111        }
1112    }
1113#endif
1114
1115    DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (handler.level() + 1) * 2, "", restoreTo);
1116    handler(new (alloc) RestoreToCountOp(restoreTo),
1117            PROPERTY_SAVECOUNT, properties().getClipToBounds());
1118
1119    DISPLAY_LIST_LOGD("%*sDone (%p, %s)", handler.level() * 2, "", this, getName());
1120    handler.endMark();
1121}
1122
1123} /* namespace uirenderer */
1124} /* namespace android */
1125