DisplayList.cpp revision 1df26446b7eac7050767c38ca977fde03a41a033 
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        if (!mTransformMatrix) {
304            mTransformMatrix = new SkMatrix();
305        }
306        if (mMatrixFlags == 0 || mMatrixFlags == TRANSLATION) {
307            mTransformMatrix->reset();
308        } else {
309            if (!mPivotExplicitlySet) {
310                if (mWidth != mPrevWidth || mHeight != mPrevHeight) {
311                    mPrevWidth = mWidth;
312                    mPrevHeight = mHeight;
313                    mPivotX = mPrevWidth / 2.0f;
314                    mPivotY = mPrevHeight / 2.0f;
315                }
316            }
317            if (!Caches::getInstance().propertyEnable3d && (mMatrixFlags & ROTATION_3D) == 0) {
318                mTransformMatrix->setTranslate(mTranslationX, mTranslationY);
319                mTransformMatrix->preRotate(mRotation, mPivotX, mPivotY);
320                mTransformMatrix->preScale(mScaleX, mScaleY, mPivotX, mPivotY);
321            } else {
322                if (Caches::getInstance().propertyEnable3d) {
323                    mTransform.loadTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY,
324                            mTranslationZ);
325                    mTransform.rotate(mRotationX, 1, 0, 0);
326                    mTransform.rotate(mRotationY, 0, 1, 0);
327                    mTransform.rotate(mRotation, 0, 0, 1);
328                    mTransform.scale(mScaleX, mScaleY, 1);
329                    mTransform.translate(-mPivotX, -mPivotY);
330                } else {
331                    /* TODO: support this old transform approach, based on API level */
332                    if (!mTransformCamera) {
333                        mTransformCamera = new Sk3DView();
334                        mTransformMatrix3D = new SkMatrix();
335                    }
336                    mTransformMatrix->reset();
337                    mTransformCamera->save();
338                    mTransformMatrix->preScale(mScaleX, mScaleY, mPivotX, mPivotY);
339                    mTransformCamera->rotateX(mRotationX);
340                    mTransformCamera->rotateY(mRotationY);
341                    mTransformCamera->rotateZ(-mRotation);
342                    mTransformCamera->getMatrix(mTransformMatrix3D);
343                    mTransformMatrix3D->preTranslate(-mPivotX, -mPivotY);
344                    mTransformMatrix3D->postTranslate(mPivotX + mTranslationX,
345                            mPivotY + mTranslationY);
346                    mTransformMatrix->postConcat(*mTransformMatrix3D);
347                    mTransformCamera->restore();
348                }
349            }
350        }
351        mMatrixDirty = false;
352    }
353}
354
355void DisplayList::outputViewProperties(const int level) {
356    updateMatrix();
357    if (mLeft != 0 || mTop != 0) {
358        ALOGD("%*sTranslate (left, top) %d, %d", level * 2, "", mLeft, mTop);
359    }
360    if (mStaticMatrix) {
361        ALOGD("%*sConcatMatrix (static) %p: " MATRIX_STRING,
362                level * 2, "", mStaticMatrix, MATRIX_ARGS(mStaticMatrix));
363    }
364    if (mAnimationMatrix) {
365        ALOGD("%*sConcatMatrix (animation) %p: " MATRIX_STRING,
366                level * 2, "", mAnimationMatrix, MATRIX_ARGS(mAnimationMatrix));
367    }
368    if (mMatrixFlags != 0) {
369        if (mMatrixFlags == TRANSLATION) {
370            ALOGD("%*sTranslate %f, %f", level * 2, "", mTranslationX, mTranslationY);
371        } else {
372            ALOGD("%*sConcatMatrix %p: " MATRIX_STRING,
373                    level * 2, "", mTransformMatrix, MATRIX_ARGS(mTransformMatrix));
374        }
375    }
376
377    bool clipToBoundsNeeded = mCaching ? false : mClipToBounds;
378    if (mAlpha < 1) {
379        if (mCaching) {
380            ALOGD("%*sSetOverrideLayerAlpha %.2f", level * 2, "", mAlpha);
381        } else if (!mHasOverlappingRendering) {
382            ALOGD("%*sScaleAlpha %.2f", level * 2, "", mAlpha);
383        } else {
384            int flags = SkCanvas::kHasAlphaLayer_SaveFlag;
385            if (clipToBoundsNeeded) {
386                flags |= SkCanvas::kClipToLayer_SaveFlag;
387                clipToBoundsNeeded = false; // clipping done by save layer
388            }
389            ALOGD("%*sSaveLayerAlpha %.2f, %.2f, %.2f, %.2f, %d, 0x%x", level * 2, "",
390                    (float) 0, (float) 0, (float) mRight - mLeft, (float) mBottom - mTop,
391                    (int)(mAlpha * 255), flags);
392        }
393    }
394    if (clipToBoundsNeeded) {
395        ALOGD("%*sClipRect %.2f, %.2f, %.2f, %.2f", level * 2, "", 0.0f, 0.0f,
396                (float) mRight - mLeft, (float) mBottom - mTop);
397    }
398}
399
400/*
401 * For property operations, we pass a savecount of 0, since the operations aren't part of the
402 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in
403 * base saveCount (i.e., how RestoreToCount uses saveCount + mCount)
404 */
405#define PROPERTY_SAVECOUNT 0
406
407template <class T>
408void DisplayList::setViewProperties(OpenGLRenderer& renderer, T& handler,
409        const int level) {
410#if DEBUG_DISPLAY_LIST
411    outputViewProperties(level);
412#endif
413    updateMatrix();
414    if (mLeft != 0 || mTop != 0) {
415        renderer.translate(mLeft, mTop);
416    }
417    if (mStaticMatrix) {
418        renderer.concatMatrix(mStaticMatrix);
419    } else if (mAnimationMatrix) {
420        renderer.concatMatrix(mAnimationMatrix);
421    }
422    if (mMatrixFlags != 0) {
423        if (Caches::getInstance().propertyEnable3d) {
424            if (mMatrixFlags == TRANSLATION) {
425                renderer.translate(mTranslationX, mTranslationY, mTranslationZ);
426            } else {
427                renderer.concatMatrix(mTransform);
428            }
429        } else {
430            // avoid setting translationZ, use SkMatrix
431            if (mMatrixFlags == TRANSLATION) {
432                renderer.translate(mTranslationX, mTranslationY, 0);
433            } else {
434                renderer.concatMatrix(mTransformMatrix);
435            }
436        }
437    }
438    bool clipToBoundsNeeded = mCaching ? false : mClipToBounds;
439    if (mAlpha < 1) {
440        if (mCaching) {
441            renderer.setOverrideLayerAlpha(mAlpha);
442        } else if (!mHasOverlappingRendering) {
443            renderer.scaleAlpha(mAlpha);
444        } else {
445            // TODO: should be able to store the size of a DL at record time and not
446            // have to pass it into this call. In fact, this information might be in the
447            // location/size info that we store with the new native transform data.
448            int saveFlags = SkCanvas::kHasAlphaLayer_SaveFlag;
449            if (clipToBoundsNeeded) {
450                saveFlags |= SkCanvas::kClipToLayer_SaveFlag;
451                clipToBoundsNeeded = false; // clipping done by saveLayer
452            }
453
454            SaveLayerOp* op = new (handler.allocator()) SaveLayerOp(
455                    0, 0, mRight - mLeft, mBottom - mTop,
456                    mAlpha * 255, SkXfermode::kSrcOver_Mode, saveFlags);
457            handler(op, PROPERTY_SAVECOUNT, mClipToBounds);
458        }
459    }
460    if (clipToBoundsNeeded) {
461        ClipRectOp* op = new (handler.allocator()) ClipRectOp(0, 0,
462                mRight - mLeft, mBottom - mTop, SkRegion::kIntersect_Op);
463        handler(op, PROPERTY_SAVECOUNT, mClipToBounds);
464    }
465}
466
467/**
468 * Apply property-based transformations to input matrix
469 */
470void DisplayList::applyViewPropertyTransforms(mat4& matrix) {
471    if (mLeft != 0 || mTop != 0) {
472        matrix.translate(mLeft, mTop);
473    }
474    if (mStaticMatrix) {
475        mat4 stat(*mStaticMatrix);
476        matrix.multiply(stat);
477    } else if (mAnimationMatrix) {
478        mat4 anim(*mAnimationMatrix);
479        matrix.multiply(anim);
480    }
481    if (mMatrixFlags != 0) {
482        updateMatrix();
483        if (mMatrixFlags == TRANSLATION) {
484            matrix.translate(mTranslationX, mTranslationY, mTranslationZ);
485        } else {
486            if (Caches::getInstance().propertyEnable3d) {
487                matrix.multiply(mTransform);
488            } else {
489                mat4 temp(*mTransformMatrix);
490                matrix.multiply(temp);
491            }
492        }
493    }
494}
495
496/**
497 * Organizes the DisplayList hierarchy to prepare for Z-based draw order.
498 *
499 * This should be called before a call to defer() or drawDisplayList()
500 *
501 * Each DisplayList that serves as a 3d root builds its list of composited children,
502 * which are flagged to not draw in the standard draw loop.
503 */
504void DisplayList::computeOrdering() {
505    ATRACE_CALL();
506    m3dNodes.clear();
507    mProjectedNodes.clear();
508
509    // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that
510    // transform properties are applied correctly to top level children
511    if (mDisplayListData == NULL) return;
512    for (unsigned int i = 0; i < mDisplayListData->children.size(); i++) {
513        DrawDisplayListOp* childOp = mDisplayListData->children[i];
514        childOp->mDisplayList->computeOrderingImpl(childOp,
515                &m3dNodes, &mat4::identity(),
516                &mProjectedNodes, &mat4::identity());
517    }
518}
519
520void DisplayList::computeOrderingImpl(
521        DrawDisplayListOp* opState,
522        Vector<ZDrawDisplayListOpPair>* compositedChildrenOf3dRoot,
523        const mat4* transformFrom3dRoot,
524        Vector<DrawDisplayListOp*>* compositedChildrenOfProjectionSurface,
525        const mat4* transformFromProjectionSurface) {
526    m3dNodes.clear();
527    mProjectedNodes.clear();
528    if (mDisplayListData == NULL || mSize == 0) return;
529
530    // TODO: should avoid this calculation in most cases
531    // TODO: just calculate single matrix, down to all leaf composited elements
532    Matrix4 localTransformFrom3dRoot(*transformFrom3dRoot);
533    localTransformFrom3dRoot.multiply(opState->mTransformFromParent);
534    Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface);
535    localTransformFromProjectionSurface.multiply(opState->mTransformFromParent);
536
537    if (mTranslationZ != 0.0f) { // TODO: other signals for 3d compositing, such as custom matrix4
538        // composited 3d layer, flag for out of order draw and save matrix...
539        opState->mSkipInOrderDraw = true;
540        opState->mTransformFromCompositingAncestor.load(localTransformFrom3dRoot);
541
542        // ... and insert into current 3d root, keyed with pivot z for later sorting
543        Vector3 pivot(mPivotX, mPivotY, 0.0f);
544        mat4 totalTransform(localTransformFrom3dRoot);
545        applyViewPropertyTransforms(totalTransform);
546        totalTransform.mapPoint3d(pivot);
547        compositedChildrenOf3dRoot->add(ZDrawDisplayListOpPair(pivot.z, opState));
548    } else if (mProjectBackwards) {
549        // composited projectee, flag for out of order draw, save matrix, and store in proj surface
550        opState->mSkipInOrderDraw = true;
551        opState->mTransformFromCompositingAncestor.load(localTransformFromProjectionSurface);
552        compositedChildrenOfProjectionSurface->add(opState);
553    } else {
554        // standard in order draw
555        opState->mSkipInOrderDraw = false;
556    }
557
558    if (mDisplayListData->children.size() > 0) {
559        if (mIsolatedZVolume) {
560            // create a new 3d space for descendents by collecting them
561            compositedChildrenOf3dRoot = &m3dNodes;
562            transformFrom3dRoot = &mat4::identity();
563        } else {
564            applyViewPropertyTransforms(localTransformFrom3dRoot);
565            transformFrom3dRoot = &localTransformFrom3dRoot;
566        }
567
568        const bool isProjectionReceiver = mDisplayListData->projectionReceiveIndex >= 0;
569        bool haveAppliedPropertiesToProjection = false;
570        for (unsigned int i = 0; i < mDisplayListData->children.size(); i++) {
571            DrawDisplayListOp* childOp = mDisplayListData->children[i];
572            DisplayList* child = childOp->mDisplayList;
573
574            Vector<DrawDisplayListOp*>* projectionChildren = NULL;
575            const mat4* projectionTransform = NULL;
576            if (isProjectionReceiver && !child->mProjectBackwards) {
577                // if receiving projections, collect projecting descendent
578
579                // Note that if a direct descendent is projecting backwards, we pass it's
580                // grandparent projection collection, since it shouldn't project onto it's
581                // parent, where it will already be drawing.
582                projectionChildren = &mProjectedNodes;
583                projectionTransform = &mat4::identity();
584            } else {
585                if (!haveAppliedPropertiesToProjection) {
586                    applyViewPropertyTransforms(localTransformFromProjectionSurface);
587                    haveAppliedPropertiesToProjection = true;
588                }
589                projectionChildren = compositedChildrenOfProjectionSurface;
590                projectionTransform = &localTransformFromProjectionSurface;
591            }
592            child->computeOrderingImpl(childOp,
593                    compositedChildrenOf3dRoot, transformFrom3dRoot,
594                    projectionChildren, projectionTransform);
595        }
596    }
597
598}
599
600class DeferOperationHandler {
601public:
602    DeferOperationHandler(DeferStateStruct& deferStruct, int level)
603        : mDeferStruct(deferStruct), mLevel(level) {}
604    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
605        operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds);
606    }
607    inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); }
608
609private:
610    DeferStateStruct& mDeferStruct;
611    const int mLevel;
612};
613
614void DisplayList::defer(DeferStateStruct& deferStruct, const int level) {
615    DeferOperationHandler handler(deferStruct, level);
616    iterate<DeferOperationHandler>(deferStruct.mRenderer, handler, level);
617}
618
619class ReplayOperationHandler {
620public:
621    ReplayOperationHandler(ReplayStateStruct& replayStruct, int level)
622        : mReplayStruct(replayStruct), mLevel(level) {}
623    inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
624#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS
625        mReplayStruct.mRenderer.eventMark(operation->name());
626#endif
627        operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds);
628    }
629    inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); }
630
631private:
632    ReplayStateStruct& mReplayStruct;
633    const int mLevel;
634};
635
636void DisplayList::replay(ReplayStateStruct& replayStruct, const int level) {
637    ReplayOperationHandler handler(replayStruct, level);
638
639    replayStruct.mRenderer.startMark(mName.string());
640    iterate<ReplayOperationHandler>(replayStruct.mRenderer, handler, level);
641    replayStruct.mRenderer.endMark();
642
643    DISPLAY_LIST_LOGD("%*sDone (%p, %s), returning %d", level * 2, "", this, mName.string(),
644            replayStruct.mDrawGlStatus);
645}
646
647template <class T>
648void DisplayList::iterate3dChildren(ChildrenSelectMode mode, OpenGLRenderer& renderer,
649        T& handler, const int level) {
650    if (m3dNodes.size() == 0 ||
651            (mode == kNegativeZChildren && m3dNodes[0].key > 0.0f) ||
652            (mode == kPositiveZChildren && m3dNodes[m3dNodes.size() - 1].key < 0.0f)) {
653        // no 3d children to draw
654        return;
655    }
656
657    int rootRestoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
658    LinearAllocator& alloc = handler.allocator();
659    ClipRectOp* clipOp = new (alloc) ClipRectOp(0, 0, mWidth, mHeight,
660            SkRegion::kIntersect_Op); // clip to 3d root bounds for now
661    handler(clipOp, PROPERTY_SAVECOUNT, mClipToBounds);
662
663    for (size_t i = 0; i < m3dNodes.size(); i++) {
664        const float zValue = m3dNodes[i].key;
665        DrawDisplayListOp* childOp = m3dNodes[i].value;
666
667        if (mode == kPositiveZChildren && zValue < 0.0f) continue;
668        if (mode == kNegativeZChildren && zValue > 0.0f) break;
669
670        if (mode == kPositiveZChildren && zValue > 0.0f) {
671            /* draw shadow with parent matrix applied, passing in the child's total matrix
672             *
673             * TODO:
674             * -view must opt-in to shadows
675             * -consider depth in more complex scenarios (neg z, added shadow depth)
676             */
677            mat4 shadowMatrix(childOp->mTransformFromCompositingAncestor);
678            childOp->mDisplayList->applyViewPropertyTransforms(shadowMatrix);
679            DisplayList* child = childOp->mDisplayList;
680
681            DisplayListOp* shadowOp  = new (alloc) DrawShadowOp(shadowMatrix,
682                    child->mAlpha, &(child->mOutline), child->mWidth, child->mHeight);
683            handler(shadowOp, PROPERTY_SAVECOUNT, mClipToBounds);
684        }
685
686        renderer.concatMatrix(childOp->mTransformFromCompositingAncestor);
687        childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
688        handler(childOp, renderer.getSaveCount() - 1, mClipToBounds);
689        childOp->mSkipInOrderDraw = true;
690    }
691    handler(new (alloc) RestoreToCountOp(rootRestoreTo), PROPERTY_SAVECOUNT, mClipToBounds);
692}
693
694template <class T>
695void DisplayList::iterateProjectedChildren(OpenGLRenderer& renderer, T& handler, const int level) {
696    int rootRestoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
697    LinearAllocator& alloc = handler.allocator();
698    ClipRectOp* clipOp = new (alloc) ClipRectOp(0, 0, mWidth, mHeight,
699            SkRegion::kReplace_Op); // clip to projection surface root bounds
700    handler(clipOp, PROPERTY_SAVECOUNT, mClipToBounds);
701
702    for (size_t i = 0; i < mProjectedNodes.size(); i++) {
703        DrawDisplayListOp* childOp = mProjectedNodes[i];
704
705        // matrix save, concat, and restore can be done safely without allocating operations
706        int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
707        renderer.concatMatrix(childOp->mTransformFromCompositingAncestor);
708        childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
709        handler(childOp, renderer.getSaveCount() - 1, mClipToBounds);
710        childOp->mSkipInOrderDraw = true;
711        renderer.restoreToCount(restoreTo);
712    }
713    handler(new (alloc) RestoreToCountOp(rootRestoreTo), PROPERTY_SAVECOUNT, mClipToBounds);
714}
715
716/**
717 * This function serves both defer and replay modes, and will organize the displayList's component
718 * operations for a single frame:
719 *
720 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of
721 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom
722 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the
723 * defer vs replay logic, per operation
724 */
725template <class T>
726void DisplayList::iterate(OpenGLRenderer& renderer, T& handler, const int level) {
727    if (CC_UNLIKELY(mDestroyed)) { // temporary debug logging
728        ALOGW("Error: %s is drawing after destruction, size %d", getName(), mSize);
729        CRASH();
730    }
731    if (mSize == 0 || mAlpha <= 0) {
732        DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", level * 2, "", this, mName.string());
733        return;
734    }
735
736#if DEBUG_DISPLAY_LIST
737    Rect* clipRect = renderer.getClipRect();
738    DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), clipRect: %.0f, %.0f, %.0f, %.0f",
739            level * 2, "", this, mName.string(), clipRect->left, clipRect->top,
740            clipRect->right, clipRect->bottom);
741#endif
742
743    LinearAllocator& alloc = handler.allocator();
744    int restoreTo = renderer.getSaveCount();
745    handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag),
746            PROPERTY_SAVECOUNT, mClipToBounds);
747
748    DISPLAY_LIST_LOGD("%*sSave %d %d", (level + 1) * 2, "",
749            SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag, restoreTo);
750
751    setViewProperties<T>(renderer, handler, level + 1);
752
753    bool quickRejected = mClipToBounds && renderer.quickRejectConservative(0, 0, mWidth, mHeight);
754    if (!quickRejected) {
755        // Z sort 3d children (stable-ness makes z compare fall back to standard drawing order)
756        std::stable_sort(m3dNodes.begin(), m3dNodes.end());
757
758        // for 3d root, draw children with negative z values
759        iterate3dChildren(kNegativeZChildren, renderer, handler, level);
760
761        DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
762        const int saveCountOffset = renderer.getSaveCount() - 1;
763        const int projectionReceiveIndex = mDisplayListData->projectionReceiveIndex;
764        for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) {
765            DisplayListOp *op = mDisplayListData->displayListOps[i];
766
767#if DEBUG_DISPLAY_LIST
768            op->output(level + 1);
769#endif
770
771            logBuffer.writeCommand(level, op->name());
772            handler(op, saveCountOffset, mClipToBounds);
773
774            if (CC_UNLIKELY(i == projectionReceiveIndex && mProjectedNodes.size() > 0)) {
775                iterateProjectedChildren(renderer, handler, level);
776            }
777        }
778
779        // for 3d root, draw children with positive z values
780        iterate3dChildren(kPositiveZChildren, renderer, handler, level);
781    }
782
783    DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (level + 1) * 2, "", restoreTo);
784    handler(new (alloc) RestoreToCountOp(restoreTo),
785            PROPERTY_SAVECOUNT, mClipToBounds);
786    renderer.setOverrideLayerAlpha(1.0f);
787}
788
789}; // namespace uirenderer
790}; // namespace android
791