DisplayList.cpp revision 8852ab4357ffb653bafb36f3b9272866834f7a72 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define ATRACE_TAG ATRACE_TAG_VIEW
18
19#include <SkCanvas.h>
20#include <algorithm>
21
22#include <utils/Trace.h>
23
24#include "Debug.h"
25#include "DisplayList.h"
26#include "DisplayListOp.h"
27#include "DisplayListLogBuffer.h"
28
29namespace android {
30namespace uirenderer {
31
32void DisplayList::outputLogBuffer(int fd) {
33    DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
34    if (logBuffer.isEmpty()) {
35        return;
36    }
37
38    FILE *file = fdopen(fd, "a");
39
40    fprintf(file, "\nRecent DisplayList operations\n");
41    logBuffer.outputCommands(file);
42
43    String8 cachesLog;
44    Caches::getInstance().dumpMemoryUsage(cachesLog);
45    fprintf(file, "\nCaches:\n%s", cachesLog.string());
46    fprintf(file, "\n");
47
48    fflush(file);
49}
50
51DisplayList::DisplayList(const DisplayListRenderer& recorder) :
52    mDestroyed(false), mTransformMatrix(NULL), mTransformCamera(NULL), mTransformMatrix3D(NULL),
53    mStaticMatrix(NULL), mAnimationMatrix(NULL) {
54
55    initFromDisplayListRenderer(recorder);
56}
57
58DisplayList::~DisplayList() {
59    mDestroyed = true;
60    clearResources();
61}
62
63void DisplayList::destroyDisplayListDeferred(DisplayList* displayList) {
64    if (displayList) {
65        DISPLAY_LIST_LOGD("Deferring display list destruction");
66        Caches::getInstance().deleteDisplayListDeferred(displayList);
67    }
68}
69
70void DisplayList::clearResources() {
71    mDisplayListData = NULL;
72
73    delete mTransformMatrix;
74    delete mTransformCamera;
75    delete mTransformMatrix3D;
76    delete mStaticMatrix;
77    delete mAnimationMatrix;
78
79    mTransformMatrix = NULL;
80    mTransformCamera = NULL;
81    mTransformMatrix3D = NULL;
82    mStaticMatrix = NULL;
83    mAnimationMatrix = NULL;
84
85    Caches& caches = Caches::getInstance();
86    caches.unregisterFunctors(mFunctorCount);
87    caches.resourceCache.lock();
88
89    for (size_t i = 0; i < mBitmapResources.size(); i++) {
90        caches.resourceCache.decrementRefcountLocked(mBitmapResources.itemAt(i));
91    }
92
93    for (size_t i = 0; i < mOwnedBitmapResources.size(); i++) {
94        const SkBitmap* bitmap = mOwnedBitmapResources.itemAt(i);
95        caches.resourceCache.decrementRefcountLocked(bitmap);
96        caches.resourceCache.destructorLocked(bitmap);
97    }
98
99    for (size_t i = 0; i < mFilterResources.size(); i++) {
100        caches.resourceCache.decrementRefcountLocked(mFilterResources.itemAt(i));
101    }
102
103    for (size_t i = 0; i < mPatchResources.size(); i++) {
104        caches.resourceCache.decrementRefcountLocked(mPatchResources.itemAt(i));
105    }
106
107    for (size_t i = 0; i < mShaders.size(); i++) {
108        caches.resourceCache.decrementRefcountLocked(mShaders.itemAt(i));
109        caches.resourceCache.destructorLocked(mShaders.itemAt(i));
110    }
111
112    for (size_t i = 0; i < mSourcePaths.size(); i++) {
113        caches.resourceCache.decrementRefcountLocked(mSourcePaths.itemAt(i));
114    }
115
116    for (size_t i = 0; i < mLayers.size(); i++) {
117        caches.resourceCache.decrementRefcountLocked(mLayers.itemAt(i));
118    }
119
120    caches.resourceCache.unlock();
121
122    for (size_t i = 0; i < mPaints.size(); i++) {
123        delete mPaints.itemAt(i);
124    }
125
126    for (size_t i = 0; i < mRegions.size(); i++) {
127        delete mRegions.itemAt(i);
128    }
129
130    for (size_t i = 0; i < mPaths.size(); i++) {
131        delete mPaths.itemAt(i);
132    }
133
134    for (size_t i = 0; i < mMatrices.size(); i++) {
135        delete mMatrices.itemAt(i);
136    }
137
138    mBitmapResources.clear();
139    mOwnedBitmapResources.clear();
140    mFilterResources.clear();
141    mPatchResources.clear();
142    mShaders.clear();
143    mSourcePaths.clear();
144    mPaints.clear();
145    mRegions.clear();
146    mPaths.clear();
147    mMatrices.clear();
148    mLayers.clear();
149}
150
151void DisplayList::reset() {
152    clearResources();
153    init();
154}
155
156void DisplayList::initFromDisplayListRenderer(const DisplayListRenderer& recorder, bool reusing) {
157    if (reusing) {
158        // re-using display list - clear out previous allocations
159        clearResources();
160    }
161
162    init();
163
164    mDisplayListData = recorder.getDisplayListData();
165    mSize = mDisplayListData->allocator.usedSize();
166
167    if (mSize == 0) {
168        return;
169    }
170
171    mFunctorCount = recorder.getFunctorCount();
172
173    Caches& caches = Caches::getInstance();
174    caches.registerFunctors(mFunctorCount);
175    caches.resourceCache.lock();
176
177    const Vector<const SkBitmap*>& bitmapResources = recorder.getBitmapResources();
178    for (size_t i = 0; i < bitmapResources.size(); i++) {
179        const SkBitmap* resource = bitmapResources.itemAt(i);
180        mBitmapResources.add(resource);
181        caches.resourceCache.incrementRefcountLocked(resource);
182    }
183
184    const Vector<const SkBitmap*>& ownedBitmapResources = recorder.getOwnedBitmapResources();
185    for (size_t i = 0; i < ownedBitmapResources.size(); i++) {
186        const SkBitmap* resource = ownedBitmapResources.itemAt(i);
187        mOwnedBitmapResources.add(resource);
188        caches.resourceCache.incrementRefcountLocked(resource);
189    }
190
191    const Vector<SkiaColorFilter*>& filterResources = recorder.getFilterResources();
192    for (size_t i = 0; i < filterResources.size(); i++) {
193        SkiaColorFilter* resource = filterResources.itemAt(i);
194        mFilterResources.add(resource);
195        caches.resourceCache.incrementRefcountLocked(resource);
196    }
197
198    const Vector<const Res_png_9patch*>& patchResources = recorder.getPatchResources();
199    for (size_t i = 0; i < patchResources.size(); i++) {
200        const Res_png_9patch* resource = patchResources.itemAt(i);
201        mPatchResources.add(resource);
202        caches.resourceCache.incrementRefcountLocked(resource);
203    }
204
205    const Vector<SkiaShader*>& shaders = recorder.getShaders();
206    for (size_t i = 0; i < shaders.size(); i++) {
207        SkiaShader* resource = shaders.itemAt(i);
208        mShaders.add(resource);
209        caches.resourceCache.incrementRefcountLocked(resource);
210    }
211
212    const SortedVector<const SkPath*>& sourcePaths = recorder.getSourcePaths();
213    for (size_t i = 0; i < sourcePaths.size(); i++) {
214        mSourcePaths.add(sourcePaths.itemAt(i));
215        caches.resourceCache.incrementRefcountLocked(sourcePaths.itemAt(i));
216    }
217
218    const Vector<Layer*>& layers = recorder.getLayers();
219    for (size_t i = 0; i < layers.size(); i++) {
220        mLayers.add(layers.itemAt(i));
221        caches.resourceCache.incrementRefcountLocked(layers.itemAt(i));
222    }
223
224    caches.resourceCache.unlock();
225
226    mPaints.appendVector(recorder.getPaints());
227    mRegions.appendVector(recorder.getRegions());
228    mPaths.appendVector(recorder.getPaths());
229    mMatrices.appendVector(recorder.getMatrices());
230}
231
232void DisplayList::init() {
233    mSize = 0;
234    mIsRenderable = true;
235    mFunctorCount = 0;
236    mLeft = 0;
237    mTop = 0;
238    mRight = 0;
239    mBottom = 0;
240    mClipToBounds = true;
241    mIsolatedZVolume = true;
242    mProjectBackwards = false;
243    mProjectionReceiver = false;
244    mOutline.rewind();
245    mAlpha = 1;
246    mHasOverlappingRendering = true;
247    mTranslationX = 0;
248    mTranslationY = 0;
249    mTranslationZ = 0;
250    mRotation = 0;
251    mRotationX = 0;
252    mRotationY= 0;
253    mScaleX = 1;
254    mScaleY = 1;
255    mPivotX = 0;
256    mPivotY = 0;
257    mCameraDistance = 0;
258    mMatrixDirty = false;
259    mMatrixFlags = 0;
260    mPrevWidth = -1;
261    mPrevHeight = -1;
262    mWidth = 0;
263    mHeight = 0;
264    mPivotExplicitlySet = false;
265    mCaching = false;
266}
267
268size_t DisplayList::getSize() {
269    return mSize;
270}
271
272/**
273 * This function is a simplified version of replay(), where we simply retrieve and log the
274 * display list. This function should remain in sync with the replay() function.
275 */
276void DisplayList::output(uint32_t level) {
277    ALOGD("%*sStart display list (%p, %s, render=%d)", (level - 1) * 2, "", this,
278            mName.string(), isRenderable());
279    ALOGD("%*s%s %d", level * 2, "", "Save",
280            SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
281
282    outputViewProperties(level);
283    int flags = DisplayListOp::kOpLogFlag_Recurse;
284    for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) {
285        mDisplayListData->displayListOps[i]->output(level, flags);
286    }
287
288    ALOGD("%*sDone (%p, %s)", (level - 1) * 2, "", this, mName.string());
289}
290
291float DisplayList::getPivotX() {
292    updateMatrix();
293    return mPivotX;
294}
295
296float DisplayList::getPivotY() {
297    updateMatrix();
298    return mPivotY;
299}
300
301void DisplayList::updateMatrix() {
302    if (mMatrixDirty) {
303        // NOTE: mTransformMatrix won't be up to date if a DisplayList goes from a complex transform
304        // to a pure translate. This is safe because the matrix isn't read in pure translate cases.
305        if (mMatrixFlags && mMatrixFlags != TRANSLATION) {
306            if (!mTransformMatrix) {
307                // only allocate a matrix if we have a complex transform
308                mTransformMatrix = new Matrix4();
309            }
310            if (!mPivotExplicitlySet) {
311                if (mWidth != mPrevWidth || mHeight != mPrevHeight) {
312                    mPrevWidth = mWidth;
313                    mPrevHeight = mHeight;
314                    mPivotX = mPrevWidth / 2.0f;
315                    mPivotY = mPrevHeight / 2.0f;
316                }
317            }
318            const bool perspectiveEnabled = Caches::getInstance().propertyEnable3d;
319            if (!perspectiveEnabled && (mMatrixFlags & ROTATION_3D) == 0) {
320                mTransformMatrix->loadTranslate(
321                        mPivotX + mTranslationX,
322                        mPivotY + mTranslationY,
323                        0);
324                mTransformMatrix->rotate(mRotation, 0, 0, 1);
325                mTransformMatrix->scale(mScaleX, mScaleY, 1);
326                mTransformMatrix->translate(-mPivotX, -mPivotY);
327            } else {
328                if (perspectiveEnabled) {
329                    mTransformMatrix->loadTranslate(
330                            mPivotX + mTranslationX,
331                            mPivotY + mTranslationY,
332                            mTranslationZ);
333                    mTransformMatrix->rotate(mRotationX, 1, 0, 0);
334                    mTransformMatrix->rotate(mRotationY, 0, 1, 0);
335                    mTransformMatrix->rotate(mRotation, 0, 0, 1);
336                    mTransformMatrix->scale(mScaleX, mScaleY, 1);
337                    mTransformMatrix->translate(-mPivotX, -mPivotY);
338                } else {
339                    /* TODO: support this old transform approach, based on API level */
340                    if (!mTransformCamera) {
341                        mTransformCamera = new Sk3DView();
342                        mTransformMatrix3D = new SkMatrix();
343                    }
344                    SkMatrix transformMatrix;
345                    transformMatrix.reset();
346                    mTransformCamera->save();
347                    transformMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
348                    mTransformCamera->rotateX(mRotationX);
349                    mTransformCamera->rotateY(mRotationY);
350                    mTransformCamera->rotateZ(-mRotation);
351                    mTransformCamera->getMatrix(mTransformMatrix3D);
352                    mTransformMatrix3D->preTranslate(-mPivotX, -mPivotY);
353                    mTransformMatrix3D->postTranslate(mPivotX + mTranslationX,
354                            mPivotY + mTranslationY);
355                    transformMatrix.postConcat(*mTransformMatrix3D);
356                    mTransformCamera->restore();
357
358                    mTransformMatrix->load(transformMatrix);
359                }
360            }
361        }
362        mMatrixDirty = false;
363    }
364}
365
366void DisplayList::outputViewProperties(const int level) {
367    updateMatrix();
368    if (mLeft != 0 || mTop != 0) {
369        ALOGD("%*sTranslate (left, top) %d, %d", level * 2, "", mLeft, mTop);
370    }
371    if (mStaticMatrix) {
372        ALOGD("%*sConcatMatrix (static) %p: " SK_MATRIX_STRING,
373                level * 2, "", mStaticMatrix, SK_MATRIX_ARGS(mStaticMatrix));
374    }
375    if (mAnimationMatrix) {
376        ALOGD("%*sConcatMatrix (animation) %p: " SK_MATRIX_STRING,
377                level * 2, "", mAnimationMatrix, SK_MATRIX_ARGS(mAnimationMatrix));
378    }
379    if (mMatrixFlags != 0) {
380        if (mMatrixFlags == TRANSLATION) {
381            ALOGD("%*sTranslate %.2f, %.2f, %.2f",
382                    level * 2, "", mTranslationX, mTranslationY, mTranslationZ);
383        } else {
384            ALOGD("%*sConcatMatrix %p: " MATRIX_4_STRING,
385                    level * 2, "", mTransformMatrix, MATRIX_4_ARGS(mTransformMatrix));
386        }
387    }
388
389    bool clipToBoundsNeeded = mCaching ? false : mClipToBounds;
390    if (mAlpha < 1) {
391        if (mCaching) {
392            ALOGD("%*sSetOverrideLayerAlpha %.2f", level * 2, "", mAlpha);
393        } else if (!mHasOverlappingRendering) {
394            ALOGD("%*sScaleAlpha %.2f", level * 2, "", mAlpha);
395        } else {
396            int flags = SkCanvas::kHasAlphaLayer_SaveFlag;
397            if (clipToBoundsNeeded) {
398                flags |= SkCanvas::kClipToLayer_SaveFlag;
399                clipToBoundsNeeded = false; // clipping done by save layer
400            }
401            ALOGD("%*sSaveLayerAlpha %.2f, %.2f, %.2f, %.2f, %d, 0x%x", level * 2, "",
402                    (float) 0, (float) 0, (float) mRight - mLeft, (float) mBottom - mTop,
403                    (int)(mAlpha * 255), flags);
404        }
405    }
406    if (clipToBoundsNeeded) {
407        ALOGD("%*sClipRect %.2f, %.2f, %.2f, %.2f", level * 2, "", 0.0f, 0.0f,
408                (float) mRight - mLeft, (float) mBottom - mTop);
409    }
410}
411
412/*
413 * For property operations, we pass a savecount of 0, since the operations aren't part of the
414 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in
415 * base saveCount (i.e., how RestoreToCount uses saveCount + mCount)
416 */
417#define PROPERTY_SAVECOUNT 0
418
419template <class T>
420void DisplayList::setViewProperties(OpenGLRenderer& renderer, T& handler,
421        const int level) {
422#if DEBUG_DISPLAY_LIST
423    outputViewProperties(level);
424#endif
425    updateMatrix();
426    if (mLeft != 0 || mTop != 0) {
427        renderer.translate(mLeft, mTop);
428    }
429    if (mStaticMatrix) {
430        renderer.concatMatrix(mStaticMatrix);
431    } else if (mAnimationMatrix) {
432        renderer.concatMatrix(mAnimationMatrix);
433    }
434    if (mMatrixFlags != 0) {
435        if (mMatrixFlags == TRANSLATION) {
436            renderer.translate(mTranslationX, mTranslationY,
437                    Caches::getInstance().propertyEnable3d ? mTranslationZ : 0.0f); // TODO: necessary?
438        } else {
439            renderer.concatMatrix(*mTransformMatrix);
440        }
441    }
442    bool clipToBoundsNeeded = mCaching ? false : mClipToBounds;
443    if (mAlpha < 1) {
444        if (mCaching) {
445            renderer.setOverrideLayerAlpha(mAlpha);
446        } else if (!mHasOverlappingRendering) {
447            renderer.scaleAlpha(mAlpha);
448        } else {
449            // TODO: should be able to store the size of a DL at record time and not
450            // have to pass it into this call. In fact, this information might be in the
451            // location/size info that we store with the new native transform data.
452            int saveFlags = SkCanvas::kHasAlphaLayer_SaveFlag;
453            if (clipToBoundsNeeded) {
454                saveFlags |= SkCanvas::kClipToLayer_SaveFlag;
455                clipToBoundsNeeded = false; // clipping done by saveLayer
456            }
457
458            SaveLayerOp* op = new (handler.allocator()) SaveLayerOp(
459                    0, 0, mRight - mLeft, mBottom - mTop, mAlpha * 255, saveFlags);
460            handler(op, PROPERTY_SAVECOUNT, mClipToBounds);
461        }
462    }
463    if (clipToBoundsNeeded) {
464        ClipRectOp* op = new (handler.allocator()) ClipRectOp(0, 0,
465                mRight - mLeft, mBottom - mTop, SkRegion::kIntersect_Op);
466        handler(op, PROPERTY_SAVECOUNT, mClipToBounds);
467    }
468}
469
470/**
471 * Apply property-based transformations to input matrix
472 */
473void DisplayList::applyViewPropertyTransforms(mat4& matrix) {
474    if (mLeft != 0 || mTop != 0) {
475        matrix.translate(mLeft, mTop);
476    }
477    if (mStaticMatrix) {
478        mat4 stat(*mStaticMatrix);
479        matrix.multiply(stat);
480    } else if (mAnimationMatrix) {
481        mat4 anim(*mAnimationMatrix);
482        matrix.multiply(anim);
483    }
484    if (mMatrixFlags != 0) {
485        updateMatrix();
486        if (mMatrixFlags == TRANSLATION) {
487            matrix.translate(mTranslationX, mTranslationY, mTranslationZ);
488        } else {
489            matrix.multiply(*mTransformMatrix);
490        }
491    }
492}
493
494/**
495 * Organizes the DisplayList hierarchy to prepare for Z-based draw order.
496 *
497 * This should be called before a call to defer() or drawDisplayList()
498 *
499 * Each DisplayList that serves as a 3d root builds its list of composited children,
500 * which are flagged to not draw in the standard draw loop.
501 */
502void DisplayList::computeOrdering() {
503    ATRACE_CALL();
504    m3dNodes.clear();
505    mProjectedNodes.clear();
506
507    // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that
508    // transform properties are applied correctly to top level children
509    if (mDisplayListData == NULL) return;
510    for (unsigned int i = 0; i < mDisplayListData->children.size(); i++) {
511        DrawDisplayListOp* childOp = mDisplayListData->children[i];
512        childOp->mDisplayList->computeOrderingImpl(childOp,
513                &m3dNodes, &mat4::identity(),
514                &mProjectedNodes, &mat4::identity());
515    }
516}
517
518void DisplayList::computeOrderingImpl(
519        DrawDisplayListOp* opState,
520        Vector<ZDrawDisplayListOpPair>* compositedChildrenOf3dRoot,
521        const mat4* transformFrom3dRoot,
522        Vector<DrawDisplayListOp*>* compositedChildrenOfProjectionSurface,
523        const mat4* transformFromProjectionSurface) {
524    m3dNodes.clear();
525    mProjectedNodes.clear();
526    if (mDisplayListData == NULL || mSize == 0) return;
527
528    // TODO: should avoid this calculation in most cases
529    // TODO: just calculate single matrix, down to all leaf composited elements
530    Matrix4 localTransformFrom3dRoot(*transformFrom3dRoot);
531    localTransformFrom3dRoot.multiply(opState->mTransformFromParent);
532    Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface);
533    localTransformFromProjectionSurface.multiply(opState->mTransformFromParent);
534
535    if (mTranslationZ != 0.0f) { // TODO: other signals for 3d compositing, such as custom matrix4
536        // composited 3d layer, flag for out of order draw and save matrix...
537        opState->mSkipInOrderDraw = true;
538        opState->mTransformFromCompositingAncestor.load(localTransformFrom3dRoot);
539
540        // ... and insert into current 3d root, keyed with pivot z for later sorting
541        Vector3 pivot(mPivotX, mPivotY, 0.0f);
542        mat4 totalTransform(localTransformFrom3dRoot);
543        applyViewPropertyTransforms(totalTransform);
544        totalTransform.mapPoint3d(pivot);
545        compositedChildrenOf3dRoot->add(ZDrawDisplayListOpPair(pivot.z, opState));
546    } else if (mProjectBackwards) {
547        // composited projectee, flag for out of order draw, save matrix, and store in proj surface
548        opState->mSkipInOrderDraw = true;
549        opState->mTransformFromCompositingAncestor.load(localTransformFromProjectionSurface);
550        compositedChildrenOfProjectionSurface->add(opState);
551    } else {
552        // standard in order draw
553        opState->mSkipInOrderDraw = false;
554    }
555
556    if (mDisplayListData->children.size() > 0) {
557        if (mIsolatedZVolume) {
558            // create a new 3d space for descendents by collecting them
559            compositedChildrenOf3dRoot = &m3dNodes;
560            transformFrom3dRoot = &mat4::identity();
561        } else {
562            applyViewPropertyTransforms(localTransformFrom3dRoot);
563            transformFrom3dRoot = &localTransformFrom3dRoot;
564        }
565
566        const bool isProjectionReceiver = mDisplayListData->projectionReceiveIndex >= 0;
567        bool haveAppliedPropertiesToProjection = false;
568        for (unsigned int i = 0; i < mDisplayListData->children.size(); i++) {
569            DrawDisplayListOp* childOp = mDisplayListData->children[i];
570            DisplayList* child = childOp->mDisplayList;
571
572            Vector<DrawDisplayListOp*>* projectionChildren = NULL;
573            const mat4* projectionTransform = NULL;
574            if (isProjectionReceiver && !child->mProjectBackwards) {
575                // if receiving projections, collect projecting descendent
576
577                // Note that if a direct descendent is projecting backwards, we pass it's
578                // grandparent projection collection, since it shouldn't project onto it's
579                // parent, where it will already be drawing.
580                projectionChildren = &mProjectedNodes;
581                projectionTransform = &mat4::identity();
582            } else {
583                if (!haveAppliedPropertiesToProjection) {
584                    applyViewPropertyTransforms(localTransformFromProjectionSurface);
585                    haveAppliedPropertiesToProjection = true;
586                }
587                projectionChildren = compositedChildrenOfProjectionSurface;
588                projectionTransform = &localTransformFromProjectionSurface;
589            }
590            child->computeOrderingImpl(childOp,
591                    compositedChildrenOf3dRoot, transformFrom3dRoot,
592                    projectionChildren, projectionTransform);
593        }
594    }
595
596}
597
598class DeferOperationHandler {
599public:
600    DeferOperationHandler(DeferStateStruct& deferStruct, int level)
601        : mDeferStruct(deferStruct), mLevel(level) {}
602    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
603        operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds);
604    }
605    inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); }
606
607private:
608    DeferStateStruct& mDeferStruct;
609    const int mLevel;
610};
611
612void DisplayList::defer(DeferStateStruct& deferStruct, const int level) {
613    DeferOperationHandler handler(deferStruct, level);
614    iterate<DeferOperationHandler>(deferStruct.mRenderer, handler, level);
615}
616
617class ReplayOperationHandler {
618public:
619    ReplayOperationHandler(ReplayStateStruct& replayStruct, int level)
620        : mReplayStruct(replayStruct), mLevel(level) {}
621    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
622#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS
623        mReplayStruct.mRenderer.eventMark(operation->name());
624#endif
625        operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds);
626    }
627    inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); }
628
629private:
630    ReplayStateStruct& mReplayStruct;
631    const int mLevel;
632};
633
634void DisplayList::replay(ReplayStateStruct& replayStruct, const int level) {
635    ReplayOperationHandler handler(replayStruct, level);
636
637    replayStruct.mRenderer.startMark(mName.string());
638    iterate<ReplayOperationHandler>(replayStruct.mRenderer, handler, level);
639    replayStruct.mRenderer.endMark();
640
641    DISPLAY_LIST_LOGD("%*sDone (%p, %s), returning %d", level * 2, "", this, mName.string(),
642            replayStruct.mDrawGlStatus);
643}
644
645template <class T>
646void DisplayList::iterate3dChildren(ChildrenSelectMode mode, OpenGLRenderer& renderer,
647        T& handler, const int level) {
648    if (m3dNodes.size() == 0 ||
649            (mode == kNegativeZChildren && m3dNodes[0].key > 0.0f) ||
650            (mode == kPositiveZChildren && m3dNodes[m3dNodes.size() - 1].key < 0.0f)) {
651        // no 3d children to draw
652        return;
653    }
654
655    int rootRestoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
656    LinearAllocator& alloc = handler.allocator();
657    ClipRectOp* clipOp = new (alloc) ClipRectOp(0, 0, mWidth, mHeight,
658            SkRegion::kIntersect_Op); // clip to 3d root bounds for now
659    handler(clipOp, PROPERTY_SAVECOUNT, mClipToBounds);
660
661    for (size_t i = 0; i < m3dNodes.size(); i++) {
662        const float zValue = m3dNodes[i].key;
663        DrawDisplayListOp* childOp = m3dNodes[i].value;
664
665        if (mode == kPositiveZChildren && zValue < 0.0f) continue;
666        if (mode == kNegativeZChildren && zValue > 0.0f) break;
667
668        if (mode == kPositiveZChildren && zValue > 0.0f) {
669            /* draw shadow with parent matrix applied, passing in the child's total matrix
670             *
671             * TODO:
672             * -view must opt-in to shadows
673             * -consider depth in more complex scenarios (neg z, added shadow depth)
674             */
675            mat4 shadowMatrix(childOp->mTransformFromCompositingAncestor);
676            childOp->mDisplayList->applyViewPropertyTransforms(shadowMatrix);
677            DisplayList* child = childOp->mDisplayList;
678
679            DisplayListOp* shadowOp  = new (alloc) DrawShadowOp(shadowMatrix,
680                    child->mAlpha, &(child->mOutline), child->mWidth, child->mHeight);
681            handler(shadowOp, PROPERTY_SAVECOUNT, mClipToBounds);
682        }
683
684        renderer.concatMatrix(childOp->mTransformFromCompositingAncestor);
685        childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
686        handler(childOp, renderer.getSaveCount() - 1, mClipToBounds);
687        childOp->mSkipInOrderDraw = true;
688    }
689    handler(new (alloc) RestoreToCountOp(rootRestoreTo), PROPERTY_SAVECOUNT, mClipToBounds);
690}
691
692template <class T>
693void DisplayList::iterateProjectedChildren(OpenGLRenderer& renderer, T& handler, const int level) {
694    int rootRestoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
695    LinearAllocator& alloc = handler.allocator();
696    ClipRectOp* clipOp = new (alloc) ClipRectOp(0, 0, mWidth, mHeight,
697            SkRegion::kReplace_Op); // clip to projection surface root bounds
698    handler(clipOp, PROPERTY_SAVECOUNT, mClipToBounds);
699
700    for (size_t i = 0; i < mProjectedNodes.size(); i++) {
701        DrawDisplayListOp* childOp = mProjectedNodes[i];
702
703        // matrix save, concat, and restore can be done safely without allocating operations
704        int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
705        renderer.concatMatrix(childOp->mTransformFromCompositingAncestor);
706        childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
707        handler(childOp, renderer.getSaveCount() - 1, mClipToBounds);
708        childOp->mSkipInOrderDraw = true;
709        renderer.restoreToCount(restoreTo);
710    }
711    handler(new (alloc) RestoreToCountOp(rootRestoreTo), PROPERTY_SAVECOUNT, mClipToBounds);
712}
713
714/**
715 * This function serves both defer and replay modes, and will organize the displayList's component
716 * operations for a single frame:
717 *
718 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of
719 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom
720 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the
721 * defer vs replay logic, per operation
722 */
723template <class T>
724void DisplayList::iterate(OpenGLRenderer& renderer, T& handler, const int level) {
725    if (CC_UNLIKELY(mDestroyed)) { // temporary debug logging
726        ALOGW("Error: %s is drawing after destruction, size %d", getName(), mSize);
727        CRASH();
728    }
729    if (mSize == 0 || mAlpha <= 0) {
730        DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", level * 2, "", this, mName.string());
731        return;
732    }
733
734#if DEBUG_DISPLAY_LIST
735    Rect* clipRect = renderer.getClipRect();
736    DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), clipRect: %.0f, %.0f, %.0f, %.0f",
737            level * 2, "", this, mName.string(), clipRect->left, clipRect->top,
738            clipRect->right, clipRect->bottom);
739#endif
740
741    LinearAllocator& alloc = handler.allocator();
742    int restoreTo = renderer.getSaveCount();
743    handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag),
744            PROPERTY_SAVECOUNT, mClipToBounds);
745
746    DISPLAY_LIST_LOGD("%*sSave %d %d", (level + 1) * 2, "",
747            SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag, restoreTo);
748
749    setViewProperties<T>(renderer, handler, level + 1);
750
751    bool quickRejected = mClipToBounds && renderer.quickRejectConservative(0, 0, mWidth, mHeight);
752    if (!quickRejected) {
753        // Z sort 3d children (stable-ness makes z compare fall back to standard drawing order)
754        std::stable_sort(m3dNodes.begin(), m3dNodes.end());
755
756        // for 3d root, draw children with negative z values
757        iterate3dChildren(kNegativeZChildren, renderer, handler, level);
758
759        DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
760        const int saveCountOffset = renderer.getSaveCount() - 1;
761        const int projectionReceiveIndex = mDisplayListData->projectionReceiveIndex;
762        for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) {
763            DisplayListOp *op = mDisplayListData->displayListOps[i];
764
765#if DEBUG_DISPLAY_LIST
766            op->output(level + 1);
767#endif
768
769            logBuffer.writeCommand(level, op->name());
770            handler(op, saveCountOffset, mClipToBounds);
771
772            if (CC_UNLIKELY(i == projectionReceiveIndex && mProjectedNodes.size() > 0)) {
773                iterateProjectedChildren(renderer, handler, level);
774            }
775        }
776
777        // for 3d root, draw children with positive z values
778        iterate3dChildren(kPositiveZChildren, renderer, handler, level);
779    }
780
781    DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (level + 1) * 2, "", restoreTo);
782    handler(new (alloc) RestoreToCountOp(restoreTo),
783            PROPERTY_SAVECOUNT, mClipToBounds);
784    renderer.setOverrideLayerAlpha(1.0f);
785}
786
787}; // namespace uirenderer
788}; // namespace android
789