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