blob: dcd6bda62076fa3aa53621bab04f0a474afb5477 [file] [log] [blame]
John Reck113e0822014-03-18 09:22:59 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define ATRACE_TAG ATRACE_TAG_VIEW
18
19#include "RenderNode.h"
20
John Recke45b1fd2014-04-15 09:50:16 -070021#include <algorithm>
22
John Reck113e0822014-03-18 09:22:59 -070023#include <SkCanvas.h>
24#include <algorithm>
25
26#include <utils/Trace.h>
27
28#include "Debug.h"
29#include "DisplayListOp.h"
30#include "DisplayListLogBuffer.h"
Chris Craike0bb87d2014-04-22 17:55:41 -070031#include "utils/MathUtils.h"
John Reck113e0822014-03-18 09:22:59 -070032
33namespace android {
34namespace uirenderer {
35
36void RenderNode::outputLogBuffer(int fd) {
37 DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
38 if (logBuffer.isEmpty()) {
39 return;
40 }
41
42 FILE *file = fdopen(fd, "a");
43
44 fprintf(file, "\nRecent DisplayList operations\n");
45 logBuffer.outputCommands(file);
46
47 String8 cachesLog;
48 Caches::getInstance().dumpMemoryUsage(cachesLog);
49 fprintf(file, "\nCaches:\n%s", cachesLog.string());
50 fprintf(file, "\n");
51
52 fflush(file);
53}
54
John Reck8de65a82014-04-09 15:23:38 -070055RenderNode::RenderNode()
Chris Craik143912f2014-04-11 13:47:36 -070056 : mNeedsPropertiesSync(false)
John Reck8de65a82014-04-09 15:23:38 -070057 , mNeedsDisplayListDataSync(false)
58 , mDisplayListData(0)
John Recke45b1fd2014-04-15 09:50:16 -070059 , mStagingDisplayListData(0)
60 , mNeedsAnimatorsSync(false) {
John Reck113e0822014-03-18 09:22:59 -070061}
62
63RenderNode::~RenderNode() {
John Reck113e0822014-03-18 09:22:59 -070064 delete mDisplayListData;
John Reck8de65a82014-04-09 15:23:38 -070065 delete mStagingDisplayListData;
John Reck113e0822014-03-18 09:22:59 -070066}
67
John Reck8de65a82014-04-09 15:23:38 -070068void RenderNode::setStagingDisplayList(DisplayListData* data) {
69 mNeedsDisplayListDataSync = true;
70 delete mStagingDisplayListData;
71 mStagingDisplayListData = data;
72 if (mStagingDisplayListData) {
73 Caches::getInstance().registerFunctors(mStagingDisplayListData->functorCount);
John Reck113e0822014-03-18 09:22:59 -070074 }
75}
76
77/**
78 * This function is a simplified version of replay(), where we simply retrieve and log the
79 * display list. This function should remain in sync with the replay() function.
80 */
81void RenderNode::output(uint32_t level) {
82 ALOGD("%*sStart display list (%p, %s, render=%d)", (level - 1) * 2, "", this,
Chris Craik3f0854292014-04-15 16:18:08 -070083 getName(), isRenderable());
John Reck113e0822014-03-18 09:22:59 -070084 ALOGD("%*s%s %d", level * 2, "", "Save",
85 SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag);
86
John Reckd0a0b2a2014-03-20 16:28:56 -070087 properties().debugOutputProperties(level);
John Reck113e0822014-03-18 09:22:59 -070088 int flags = DisplayListOp::kOpLogFlag_Recurse;
89 for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) {
90 mDisplayListData->displayListOps[i]->output(level, flags);
91 }
92
Chris Craik3f0854292014-04-15 16:18:08 -070093 ALOGD("%*sDone (%p, %s)", (level - 1) * 2, "", this, getName());
John Reck113e0822014-03-18 09:22:59 -070094}
95
John Reckf4198b72014-04-09 17:00:04 -070096void RenderNode::prepareTree(TreeInfo& info) {
97 ATRACE_CALL();
98
99 prepareTreeImpl(info);
100}
101
102void RenderNode::prepareTreeImpl(TreeInfo& info) {
John Recke45b1fd2014-04-15 09:50:16 -0700103 if (info.performStagingPush) {
104 pushStagingChanges(info);
105 }
106 if (info.evaluateAnimations) {
107 evaluateAnimations(info);
108 }
John Reckf4198b72014-04-09 17:00:04 -0700109 prepareSubTree(info, mDisplayListData);
110}
111
John Recke45b1fd2014-04-15 09:50:16 -0700112static bool is_finished(const sp<RenderPropertyAnimator>& animator) {
113 return animator->isFinished();
114}
115
John Reckf4198b72014-04-09 17:00:04 -0700116void RenderNode::pushStagingChanges(TreeInfo& info) {
John Reckd0a0b2a2014-03-20 16:28:56 -0700117 if (mNeedsPropertiesSync) {
118 mNeedsPropertiesSync = false;
119 mProperties = mStagingProperties;
John Reck113e0822014-03-18 09:22:59 -0700120 }
John Recke45b1fd2014-04-15 09:50:16 -0700121 if (mNeedsAnimatorsSync) {
122 mAnimators.reserve(mStagingAnimators.size());
123 std::vector< sp<RenderPropertyAnimator> >::iterator it;
124 // hint: this means copy_if_not()
125 it = std::remove_copy_if(mStagingAnimators.begin(), mStagingAnimators.end(),
126 mAnimators.begin(), is_finished);
127 mAnimators.resize(std::distance(mAnimators.begin(), it));
128 }
John Reck8de65a82014-04-09 15:23:38 -0700129 if (mNeedsDisplayListDataSync) {
130 mNeedsDisplayListDataSync = false;
131 // Do a push pass on the old tree to handle freeing DisplayListData
132 // that are no longer used
John Reck860d1552014-04-11 19:15:05 -0700133 TreeInfo oldTreeInfo;
John Reckf4198b72014-04-09 17:00:04 -0700134 prepareSubTree(oldTreeInfo, mDisplayListData);
135 // TODO: The damage for the old tree should be accounted for
John Reck8de65a82014-04-09 15:23:38 -0700136 delete mDisplayListData;
137 mDisplayListData = mStagingDisplayListData;
138 mStagingDisplayListData = 0;
139 }
John Reck8de65a82014-04-09 15:23:38 -0700140}
141
John Recke45b1fd2014-04-15 09:50:16 -0700142class AnimateFunctor {
143public:
144 AnimateFunctor(RenderProperties* target, TreeInfo& info)
145 : mTarget(target), mInfo(info) {}
146
147 bool operator() (sp<RenderPropertyAnimator>& animator) {
148 bool finished = animator->animate(mTarget, mInfo);
149 if (finished && mInfo.animationListener) {
150 mInfo.animationListener->onAnimationFinished(animator);
151 }
152 return finished;
153 }
154private:
155 RenderProperties* mTarget;
156 TreeInfo& mInfo;
157};
158
159void RenderNode::evaluateAnimations(TreeInfo& info) {
160 if (!mAnimators.size()) return;
161
162 AnimateFunctor functor(&mProperties, info);
163 std::vector< sp<RenderPropertyAnimator> >::iterator newEnd;
164 newEnd = std::remove_if(mAnimators.begin(), mAnimators.end(), functor);
165 mAnimators.erase(newEnd, mAnimators.end());
166 mProperties.updateMatrix();
167 info.hasAnimations |= mAnimators.size();
168}
169
John Reckf4198b72014-04-09 17:00:04 -0700170void RenderNode::prepareSubTree(TreeInfo& info, DisplayListData* subtree) {
John Reck8de65a82014-04-09 15:23:38 -0700171 if (subtree) {
John Reck860d1552014-04-11 19:15:05 -0700172 TextureCache& cache = Caches::getInstance().textureCache;
173 info.hasFunctors |= subtree->functorCount;
174 // TODO: Fix ownedBitmapResources to not require disabling prepareTextures
175 // and thus falling out of async drawing path.
176 if (subtree->ownedBitmapResources.size()) {
177 info.prepareTextures = false;
178 }
179 for (size_t i = 0; info.prepareTextures && i < subtree->bitmapResources.size(); i++) {
180 info.prepareTextures = cache.prefetchAndMarkInUse(subtree->bitmapResources[i]);
John Reckf4198b72014-04-09 17:00:04 -0700181 }
John Reck8de65a82014-04-09 15:23:38 -0700182 for (size_t i = 0; i < subtree->children().size(); i++) {
183 RenderNode* childNode = subtree->children()[i]->mDisplayList;
John Reckf4198b72014-04-09 17:00:04 -0700184 childNode->prepareTreeImpl(info);
John Reck5bf11bb2014-03-25 10:22:09 -0700185 }
John Reck113e0822014-03-18 09:22:59 -0700186 }
187}
188
189/*
190 * For property operations, we pass a savecount of 0, since the operations aren't part of the
191 * displaylist, and thus don't have to compensate for the record-time/playback-time discrepancy in
John Reckd0a0b2a2014-03-20 16:28:56 -0700192 * base saveCount (i.e., how RestoreToCount uses saveCount + properties().getCount())
John Reck113e0822014-03-18 09:22:59 -0700193 */
194#define PROPERTY_SAVECOUNT 0
195
196template <class T>
Chris Craikb265e2c2014-03-27 15:50:09 -0700197void RenderNode::setViewProperties(OpenGLRenderer& renderer, T& handler) {
John Reck113e0822014-03-18 09:22:59 -0700198#if DEBUG_DISPLAY_LIST
Chris Craikb265e2c2014-03-27 15:50:09 -0700199 properties().debugOutputProperties(handler.level() + 1);
John Reck113e0822014-03-18 09:22:59 -0700200#endif
John Reckd0a0b2a2014-03-20 16:28:56 -0700201 if (properties().getLeft() != 0 || properties().getTop() != 0) {
202 renderer.translate(properties().getLeft(), properties().getTop());
John Reck113e0822014-03-18 09:22:59 -0700203 }
John Reckd0a0b2a2014-03-20 16:28:56 -0700204 if (properties().getStaticMatrix()) {
205 renderer.concatMatrix(properties().getStaticMatrix());
206 } else if (properties().getAnimationMatrix()) {
207 renderer.concatMatrix(properties().getAnimationMatrix());
John Reck113e0822014-03-18 09:22:59 -0700208 }
John Reckf7483e32014-04-11 08:54:47 -0700209 if (properties().hasTransformMatrix()) {
210 if (properties().isTransformTranslateOnly()) {
John Reckd0a0b2a2014-03-20 16:28:56 -0700211 renderer.translate(properties().getTranslationX(), properties().getTranslationY());
John Reck113e0822014-03-18 09:22:59 -0700212 } else {
John Reckd0a0b2a2014-03-20 16:28:56 -0700213 renderer.concatMatrix(*properties().getTransformMatrix());
John Reck113e0822014-03-18 09:22:59 -0700214 }
215 }
John Reckd0a0b2a2014-03-20 16:28:56 -0700216 bool clipToBoundsNeeded = properties().getCaching() ? false : properties().getClipToBounds();
217 if (properties().getAlpha() < 1) {
218 if (properties().getCaching()) {
219 renderer.setOverrideLayerAlpha(properties().getAlpha());
220 } else if (!properties().getHasOverlappingRendering()) {
221 renderer.scaleAlpha(properties().getAlpha());
John Reck113e0822014-03-18 09:22:59 -0700222 } else {
223 // TODO: should be able to store the size of a DL at record time and not
224 // have to pass it into this call. In fact, this information might be in the
225 // location/size info that we store with the new native transform data.
226 int saveFlags = SkCanvas::kHasAlphaLayer_SaveFlag;
227 if (clipToBoundsNeeded) {
228 saveFlags |= SkCanvas::kClipToLayer_SaveFlag;
229 clipToBoundsNeeded = false; // clipping done by saveLayer
230 }
231
232 SaveLayerOp* op = new (handler.allocator()) SaveLayerOp(
Chris Craik8c271ca2014-03-25 10:33:01 -0700233 0, 0, properties().getWidth(), properties().getHeight(),
234 properties().getAlpha() * 255, saveFlags);
John Reckd0a0b2a2014-03-20 16:28:56 -0700235 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700236 }
237 }
238 if (clipToBoundsNeeded) {
Chris Craik8c271ca2014-03-25 10:33:01 -0700239 ClipRectOp* op = new (handler.allocator()) ClipRectOp(
240 0, 0, properties().getWidth(), properties().getHeight(), SkRegion::kIntersect_Op);
John Reckd0a0b2a2014-03-20 16:28:56 -0700241 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700242 }
Chris Craik8c271ca2014-03-25 10:33:01 -0700243
244 if (CC_UNLIKELY(properties().hasClippingPath())) {
245 // TODO: optimize for round rect/circle clipping
246 const SkPath* path = properties().getClippingPath();
247 ClipPathOp* op = new (handler.allocator()) ClipPathOp(path, SkRegion::kIntersect_Op);
John Reckd0a0b2a2014-03-20 16:28:56 -0700248 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700249 }
250}
251
252/**
253 * Apply property-based transformations to input matrix
254 *
255 * If true3dTransform is set to true, the transform applied to the input matrix will use true 4x4
256 * matrix computation instead of the Skia 3x3 matrix + camera hackery.
257 */
258void RenderNode::applyViewPropertyTransforms(mat4& matrix, bool true3dTransform) {
John Reckd0a0b2a2014-03-20 16:28:56 -0700259 if (properties().getLeft() != 0 || properties().getTop() != 0) {
260 matrix.translate(properties().getLeft(), properties().getTop());
John Reck113e0822014-03-18 09:22:59 -0700261 }
John Reckd0a0b2a2014-03-20 16:28:56 -0700262 if (properties().getStaticMatrix()) {
263 mat4 stat(*properties().getStaticMatrix());
John Reck113e0822014-03-18 09:22:59 -0700264 matrix.multiply(stat);
John Reckd0a0b2a2014-03-20 16:28:56 -0700265 } else if (properties().getAnimationMatrix()) {
266 mat4 anim(*properties().getAnimationMatrix());
John Reck113e0822014-03-18 09:22:59 -0700267 matrix.multiply(anim);
268 }
Chris Craike0bb87d2014-04-22 17:55:41 -0700269
Chris Craikcc39e162014-04-25 18:34:11 -0700270 bool applyTranslationZ = true3dTransform && !MathUtils::isZero(properties().getZ());
Chris Craike0bb87d2014-04-22 17:55:41 -0700271 if (properties().hasTransformMatrix() || applyTranslationZ) {
John Reckf7483e32014-04-11 08:54:47 -0700272 if (properties().isTransformTranslateOnly()) {
John Reckd0a0b2a2014-03-20 16:28:56 -0700273 matrix.translate(properties().getTranslationX(), properties().getTranslationY(),
Chris Craikcc39e162014-04-25 18:34:11 -0700274 true3dTransform ? properties().getZ() : 0.0f);
John Reck113e0822014-03-18 09:22:59 -0700275 } else {
276 if (!true3dTransform) {
John Reckd0a0b2a2014-03-20 16:28:56 -0700277 matrix.multiply(*properties().getTransformMatrix());
John Reck113e0822014-03-18 09:22:59 -0700278 } else {
279 mat4 true3dMat;
280 true3dMat.loadTranslate(
John Reckd0a0b2a2014-03-20 16:28:56 -0700281 properties().getPivotX() + properties().getTranslationX(),
282 properties().getPivotY() + properties().getTranslationY(),
Chris Craikcc39e162014-04-25 18:34:11 -0700283 properties().getZ());
John Reckd0a0b2a2014-03-20 16:28:56 -0700284 true3dMat.rotate(properties().getRotationX(), 1, 0, 0);
285 true3dMat.rotate(properties().getRotationY(), 0, 1, 0);
286 true3dMat.rotate(properties().getRotation(), 0, 0, 1);
287 true3dMat.scale(properties().getScaleX(), properties().getScaleY(), 1);
288 true3dMat.translate(-properties().getPivotX(), -properties().getPivotY());
John Reck113e0822014-03-18 09:22:59 -0700289
290 matrix.multiply(true3dMat);
291 }
292 }
293 }
294}
295
296/**
297 * Organizes the DisplayList hierarchy to prepare for background projection reordering.
298 *
299 * This should be called before a call to defer() or drawDisplayList()
300 *
301 * Each DisplayList that serves as a 3d root builds its list of composited children,
302 * which are flagged to not draw in the standard draw loop.
303 */
304void RenderNode::computeOrdering() {
305 ATRACE_CALL();
306 mProjectedNodes.clear();
307
308 // TODO: create temporary DDLOp and call computeOrderingImpl on top DisplayList so that
309 // transform properties are applied correctly to top level children
310 if (mDisplayListData == NULL) return;
John Reck087bc0c2014-04-04 16:20:08 -0700311 for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) {
312 DrawDisplayListOp* childOp = mDisplayListData->children()[i];
John Reck113e0822014-03-18 09:22:59 -0700313 childOp->mDisplayList->computeOrderingImpl(childOp,
Chris Craik3f0854292014-04-15 16:18:08 -0700314 properties().getOutline().getPath(), &mProjectedNodes, &mat4::identity());
John Reck113e0822014-03-18 09:22:59 -0700315 }
316}
317
318void RenderNode::computeOrderingImpl(
319 DrawDisplayListOp* opState,
Chris Craik3f0854292014-04-15 16:18:08 -0700320 const SkPath* outlineOfProjectionSurface,
John Reck113e0822014-03-18 09:22:59 -0700321 Vector<DrawDisplayListOp*>* compositedChildrenOfProjectionSurface,
322 const mat4* transformFromProjectionSurface) {
323 mProjectedNodes.clear();
324 if (mDisplayListData == NULL || mDisplayListData->isEmpty()) return;
325
326 // TODO: should avoid this calculation in most cases
327 // TODO: just calculate single matrix, down to all leaf composited elements
328 Matrix4 localTransformFromProjectionSurface(*transformFromProjectionSurface);
329 localTransformFromProjectionSurface.multiply(opState->mTransformFromParent);
330
John Reckd0a0b2a2014-03-20 16:28:56 -0700331 if (properties().getProjectBackwards()) {
John Reck113e0822014-03-18 09:22:59 -0700332 // composited projectee, flag for out of order draw, save matrix, and store in proj surface
333 opState->mSkipInOrderDraw = true;
334 opState->mTransformFromCompositingAncestor.load(localTransformFromProjectionSurface);
335 compositedChildrenOfProjectionSurface->add(opState);
336 } else {
337 // standard in order draw
338 opState->mSkipInOrderDraw = false;
339 }
340
John Reck087bc0c2014-04-04 16:20:08 -0700341 if (mDisplayListData->children().size() > 0) {
John Reck113e0822014-03-18 09:22:59 -0700342 const bool isProjectionReceiver = mDisplayListData->projectionReceiveIndex >= 0;
343 bool haveAppliedPropertiesToProjection = false;
John Reck087bc0c2014-04-04 16:20:08 -0700344 for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) {
345 DrawDisplayListOp* childOp = mDisplayListData->children()[i];
John Reck113e0822014-03-18 09:22:59 -0700346 RenderNode* child = childOp->mDisplayList;
347
Chris Craik3f0854292014-04-15 16:18:08 -0700348 const SkPath* projectionOutline = NULL;
John Reck113e0822014-03-18 09:22:59 -0700349 Vector<DrawDisplayListOp*>* projectionChildren = NULL;
350 const mat4* projectionTransform = NULL;
John Reckd0a0b2a2014-03-20 16:28:56 -0700351 if (isProjectionReceiver && !child->properties().getProjectBackwards()) {
John Reck113e0822014-03-18 09:22:59 -0700352 // if receiving projections, collect projecting descendent
353
354 // Note that if a direct descendent is projecting backwards, we pass it's
355 // grandparent projection collection, since it shouldn't project onto it's
356 // parent, where it will already be drawing.
Chris Craik3f0854292014-04-15 16:18:08 -0700357 projectionOutline = properties().getOutline().getPath();
John Reck113e0822014-03-18 09:22:59 -0700358 projectionChildren = &mProjectedNodes;
359 projectionTransform = &mat4::identity();
360 } else {
361 if (!haveAppliedPropertiesToProjection) {
362 applyViewPropertyTransforms(localTransformFromProjectionSurface);
363 haveAppliedPropertiesToProjection = true;
364 }
Chris Craik3f0854292014-04-15 16:18:08 -0700365 projectionOutline = outlineOfProjectionSurface;
John Reck113e0822014-03-18 09:22:59 -0700366 projectionChildren = compositedChildrenOfProjectionSurface;
367 projectionTransform = &localTransformFromProjectionSurface;
368 }
Chris Craik3f0854292014-04-15 16:18:08 -0700369 child->computeOrderingImpl(childOp,
370 projectionOutline, projectionChildren, projectionTransform);
John Reck113e0822014-03-18 09:22:59 -0700371 }
372 }
John Reck113e0822014-03-18 09:22:59 -0700373}
374
375class DeferOperationHandler {
376public:
377 DeferOperationHandler(DeferStateStruct& deferStruct, int level)
378 : mDeferStruct(deferStruct), mLevel(level) {}
379 inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
380 operation->defer(mDeferStruct, saveCount, mLevel, clipToBounds);
381 }
382 inline LinearAllocator& allocator() { return *(mDeferStruct.mAllocator); }
Chris Craikb265e2c2014-03-27 15:50:09 -0700383 inline void startMark(const char* name) {} // do nothing
384 inline void endMark() {}
385 inline int level() { return mLevel; }
386 inline int replayFlags() { return mDeferStruct.mReplayFlags; }
John Reck113e0822014-03-18 09:22:59 -0700387
388private:
389 DeferStateStruct& mDeferStruct;
390 const int mLevel;
391};
392
Chris Craikb265e2c2014-03-27 15:50:09 -0700393void RenderNode::deferNodeTree(DeferStateStruct& deferStruct) {
394 DeferOperationHandler handler(deferStruct, 0);
Chris Craikcc39e162014-04-25 18:34:11 -0700395 if (MathUtils::isPositive(properties().getZ())) {
396 issueDrawShadowOperation(Matrix4::identity(), handler);
397 }
Chris Craikb265e2c2014-03-27 15:50:09 -0700398 issueOperations<DeferOperationHandler>(deferStruct.mRenderer, handler);
399}
400
401void RenderNode::deferNodeInParent(DeferStateStruct& deferStruct, const int level) {
John Reck113e0822014-03-18 09:22:59 -0700402 DeferOperationHandler handler(deferStruct, level);
Chris Craikb265e2c2014-03-27 15:50:09 -0700403 issueOperations<DeferOperationHandler>(deferStruct.mRenderer, handler);
John Reck113e0822014-03-18 09:22:59 -0700404}
405
406class ReplayOperationHandler {
407public:
408 ReplayOperationHandler(ReplayStateStruct& replayStruct, int level)
409 : mReplayStruct(replayStruct), mLevel(level) {}
410 inline void operator()(DisplayListOp* operation, int saveCount, bool clipToBounds) {
411#if DEBUG_DISPLAY_LIST_OPS_AS_EVENTS
Chris Craik3f0854292014-04-15 16:18:08 -0700412 mReplayStruct.mRenderer.eventMark(operation->name());
John Reck113e0822014-03-18 09:22:59 -0700413#endif
414 operation->replay(mReplayStruct, saveCount, mLevel, clipToBounds);
415 }
416 inline LinearAllocator& allocator() { return *(mReplayStruct.mAllocator); }
Chris Craikb265e2c2014-03-27 15:50:09 -0700417 inline void startMark(const char* name) {
418 mReplayStruct.mRenderer.startMark(name);
419 }
420 inline void endMark() {
421 mReplayStruct.mRenderer.endMark();
Chris Craikb265e2c2014-03-27 15:50:09 -0700422 }
423 inline int level() { return mLevel; }
424 inline int replayFlags() { return mReplayStruct.mReplayFlags; }
John Reck113e0822014-03-18 09:22:59 -0700425
426private:
427 ReplayStateStruct& mReplayStruct;
428 const int mLevel;
429};
430
Chris Craikb265e2c2014-03-27 15:50:09 -0700431void RenderNode::replayNodeTree(ReplayStateStruct& replayStruct) {
432 ReplayOperationHandler handler(replayStruct, 0);
Chris Craikcc39e162014-04-25 18:34:11 -0700433 if (MathUtils::isPositive(properties().getZ())) {
434 issueDrawShadowOperation(Matrix4::identity(), handler);
435 }
Chris Craikb265e2c2014-03-27 15:50:09 -0700436 issueOperations<ReplayOperationHandler>(replayStruct.mRenderer, handler);
437}
438
439void RenderNode::replayNodeInParent(ReplayStateStruct& replayStruct, const int level) {
John Reck113e0822014-03-18 09:22:59 -0700440 ReplayOperationHandler handler(replayStruct, level);
Chris Craikb265e2c2014-03-27 15:50:09 -0700441 issueOperations<ReplayOperationHandler>(replayStruct.mRenderer, handler);
John Reck113e0822014-03-18 09:22:59 -0700442}
443
444void RenderNode::buildZSortedChildList(Vector<ZDrawDisplayListOpPair>& zTranslatedNodes) {
John Reck087bc0c2014-04-04 16:20:08 -0700445 if (mDisplayListData == NULL || mDisplayListData->children().size() == 0) return;
John Reck113e0822014-03-18 09:22:59 -0700446
John Reck087bc0c2014-04-04 16:20:08 -0700447 for (unsigned int i = 0; i < mDisplayListData->children().size(); i++) {
448 DrawDisplayListOp* childOp = mDisplayListData->children()[i];
John Reck113e0822014-03-18 09:22:59 -0700449 RenderNode* child = childOp->mDisplayList;
Chris Craikcc39e162014-04-25 18:34:11 -0700450 float childZ = child->properties().getZ();
John Reck113e0822014-03-18 09:22:59 -0700451
Chris Craike0bb87d2014-04-22 17:55:41 -0700452 if (!MathUtils::isZero(childZ)) {
John Reck113e0822014-03-18 09:22:59 -0700453 zTranslatedNodes.add(ZDrawDisplayListOpPair(childZ, childOp));
454 childOp->mSkipInOrderDraw = true;
John Reckd0a0b2a2014-03-20 16:28:56 -0700455 } else if (!child->properties().getProjectBackwards()) {
John Reck113e0822014-03-18 09:22:59 -0700456 // regular, in order drawing DisplayList
457 childOp->mSkipInOrderDraw = false;
458 }
459 }
460
461 // Z sort 3d children (stable-ness makes z compare fall back to standard drawing order)
462 std::stable_sort(zTranslatedNodes.begin(), zTranslatedNodes.end());
463}
464
Chris Craikb265e2c2014-03-27 15:50:09 -0700465template <class T>
466void RenderNode::issueDrawShadowOperation(const Matrix4& transformFromParent, T& handler) {
467 if (properties().getAlpha() <= 0.0f) return;
468
469 mat4 shadowMatrixXY(transformFromParent);
470 applyViewPropertyTransforms(shadowMatrixXY);
471
472 // Z matrix needs actual 3d transformation, so mapped z values will be correct
473 mat4 shadowMatrixZ(transformFromParent);
474 applyViewPropertyTransforms(shadowMatrixZ, true);
475
476 const SkPath* outlinePath = properties().getOutline().getPath();
477 const RevealClip& revealClip = properties().getRevealClip();
478 const SkPath* revealClipPath = revealClip.hasConvexClip()
479 ? revealClip.getPath() : NULL; // only pass the reveal clip's path if it's convex
480
481 /**
482 * The drawing area of the caster is always the same as the its perimeter (which
483 * the shadow system uses) *except* in the inverse clip case. Inform the shadow
484 * system that the caster's drawing area (as opposed to its perimeter) has been
485 * clipped, so that it knows the caster can't be opaque.
486 */
487 bool casterUnclipped = !revealClip.willClip() || revealClip.hasConvexClip();
488
489 DisplayListOp* shadowOp = new (handler.allocator()) DrawShadowOp(
490 shadowMatrixXY, shadowMatrixZ,
491 properties().getAlpha(), casterUnclipped,
492 properties().getWidth(), properties().getHeight(),
493 outlinePath, revealClipPath);
494 handler(shadowOp, PROPERTY_SAVECOUNT, properties().getClipToBounds());
495}
496
John Reck113e0822014-03-18 09:22:59 -0700497#define SHADOW_DELTA 0.1f
498
499template <class T>
Chris Craikb265e2c2014-03-27 15:50:09 -0700500void RenderNode::issueOperationsOf3dChildren(const Vector<ZDrawDisplayListOpPair>& zTranslatedNodes,
John Reck113e0822014-03-18 09:22:59 -0700501 ChildrenSelectMode mode, OpenGLRenderer& renderer, T& handler) {
502 const int size = zTranslatedNodes.size();
503 if (size == 0
504 || (mode == kNegativeZChildren && zTranslatedNodes[0].key > 0.0f)
505 || (mode == kPositiveZChildren && zTranslatedNodes[size - 1].key < 0.0f)) {
506 // no 3d children to draw
507 return;
508 }
509
John Reck113e0822014-03-18 09:22:59 -0700510 /**
511 * Draw shadows and (potential) casters mostly in order, but allow the shadows of casters
512 * with very similar Z heights to draw together.
513 *
514 * This way, if Views A & B have the same Z height and are both casting shadows, the shadows are
515 * underneath both, and neither's shadow is drawn on top of the other.
516 */
517 const size_t nonNegativeIndex = findNonNegativeIndex(zTranslatedNodes);
518 size_t drawIndex, shadowIndex, endIndex;
519 if (mode == kNegativeZChildren) {
520 drawIndex = 0;
521 endIndex = nonNegativeIndex;
522 shadowIndex = endIndex; // draw no shadows
523 } else {
524 drawIndex = nonNegativeIndex;
525 endIndex = size;
526 shadowIndex = drawIndex; // potentially draw shadow for each pos Z child
527 }
Chris Craik3f0854292014-04-15 16:18:08 -0700528
529 DISPLAY_LIST_LOGD("%*s%d %s 3d children:", (handler.level() + 1) * 2, "",
530 endIndex - drawIndex, mode == kNegativeZChildren ? "negative" : "positive");
531
John Reck113e0822014-03-18 09:22:59 -0700532 float lastCasterZ = 0.0f;
533 while (shadowIndex < endIndex || drawIndex < endIndex) {
534 if (shadowIndex < endIndex) {
535 DrawDisplayListOp* casterOp = zTranslatedNodes[shadowIndex].value;
536 RenderNode* caster = casterOp->mDisplayList;
537 const float casterZ = zTranslatedNodes[shadowIndex].key;
538 // attempt to render the shadow if the caster about to be drawn is its caster,
539 // OR if its caster's Z value is similar to the previous potential caster
540 if (shadowIndex == drawIndex || casterZ - lastCasterZ < SHADOW_DELTA) {
Chris Craikb265e2c2014-03-27 15:50:09 -0700541 caster->issueDrawShadowOperation(casterOp->mTransformFromParent, handler);
John Reck113e0822014-03-18 09:22:59 -0700542
543 lastCasterZ = casterZ; // must do this even if current caster not casting a shadow
544 shadowIndex++;
545 continue;
546 }
547 }
548
549 // only the actual child DL draw needs to be in save/restore,
550 // since it modifies the renderer's matrix
551 int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
552
553 DrawDisplayListOp* childOp = zTranslatedNodes[drawIndex].value;
554 RenderNode* child = childOp->mDisplayList;
555
556 renderer.concatMatrix(childOp->mTransformFromParent);
557 childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
John Reckd0a0b2a2014-03-20 16:28:56 -0700558 handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700559 childOp->mSkipInOrderDraw = true;
560
561 renderer.restoreToCount(restoreTo);
562 drawIndex++;
563 }
John Reck113e0822014-03-18 09:22:59 -0700564}
565
566template <class T>
Chris Craikb265e2c2014-03-27 15:50:09 -0700567void RenderNode::issueOperationsOfProjectedChildren(OpenGLRenderer& renderer, T& handler) {
Chris Craik3f0854292014-04-15 16:18:08 -0700568 DISPLAY_LIST_LOGD("%*s%d projected children:", (handler.level() + 1) * 2, "", mProjectedNodes.size());
569 const SkPath* projectionReceiverOutline = properties().getOutline().getPath();
570 bool maskProjecteesWithPath = projectionReceiverOutline != NULL
571 && !projectionReceiverOutline->isRect(NULL);
572 int restoreTo = renderer.getSaveCount();
573
574 // If the projection reciever has an outline, we mask each of the projected rendernodes to it
575 // Either with clipRect, or special saveLayer masking
576 LinearAllocator& alloc = handler.allocator();
577 if (projectionReceiverOutline != NULL) {
578 const SkRect& outlineBounds = projectionReceiverOutline->getBounds();
579 if (projectionReceiverOutline->isRect(NULL)) {
580 // mask to the rect outline simply with clipRect
581 handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag),
582 PROPERTY_SAVECOUNT, properties().getClipToBounds());
583 ClipRectOp* clipOp = new (alloc) ClipRectOp(
584 outlineBounds.left(), outlineBounds.top(),
585 outlineBounds.right(), outlineBounds.bottom(), SkRegion::kIntersect_Op);
586 handler(clipOp, PROPERTY_SAVECOUNT, properties().getClipToBounds());
587 } else {
588 // wrap the projected RenderNodes with a SaveLayer that will mask to the outline
589 SaveLayerOp* op = new (alloc) SaveLayerOp(
590 outlineBounds.left(), outlineBounds.top(),
591 outlineBounds.right(), outlineBounds.bottom(),
592 255, SkCanvas::kARGB_ClipLayer_SaveFlag);
593 op->setMask(projectionReceiverOutline);
594 handler(op, PROPERTY_SAVECOUNT, properties().getClipToBounds());
595
596 /* TODO: add optimizations here to take advantage of placement/size of projected
597 * children (which may shrink saveLayer area significantly). This is dependent on
598 * passing actual drawing/dirtying bounds of projected content down to native.
599 */
600 }
601 }
602
603 // draw projected nodes
John Reck113e0822014-03-18 09:22:59 -0700604 for (size_t i = 0; i < mProjectedNodes.size(); i++) {
605 DrawDisplayListOp* childOp = mProjectedNodes[i];
606
607 // matrix save, concat, and restore can be done safely without allocating operations
608 int restoreTo = renderer.save(SkCanvas::kMatrix_SaveFlag);
609 renderer.concatMatrix(childOp->mTransformFromCompositingAncestor);
610 childOp->mSkipInOrderDraw = false; // this is horrible, I'm so sorry everyone
John Reckd0a0b2a2014-03-20 16:28:56 -0700611 handler(childOp, renderer.getSaveCount() - 1, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700612 childOp->mSkipInOrderDraw = true;
613 renderer.restoreToCount(restoreTo);
614 }
Chris Craik3f0854292014-04-15 16:18:08 -0700615
616 if (projectionReceiverOutline != NULL) {
617 handler(new (alloc) RestoreToCountOp(restoreTo),
618 PROPERTY_SAVECOUNT, properties().getClipToBounds());
619 }
John Reck113e0822014-03-18 09:22:59 -0700620}
621
622/**
623 * This function serves both defer and replay modes, and will organize the displayList's component
624 * operations for a single frame:
625 *
626 * Every 'simple' state operation that affects just the matrix and alpha (or other factors of
627 * DeferredDisplayState) may be issued directly to the renderer, but complex operations (with custom
628 * defer logic) and operations in displayListOps are issued through the 'handler' which handles the
629 * defer vs replay logic, per operation
630 */
631template <class T>
Chris Craikb265e2c2014-03-27 15:50:09 -0700632void RenderNode::issueOperations(OpenGLRenderer& renderer, T& handler) {
633 const int level = handler.level();
John Reckd0a0b2a2014-03-20 16:28:56 -0700634 if (mDisplayListData->isEmpty() || properties().getAlpha() <= 0) {
Chris Craik3f0854292014-04-15 16:18:08 -0700635 DISPLAY_LIST_LOGD("%*sEmpty display list (%p, %s)", level * 2, "", this, getName());
John Reck113e0822014-03-18 09:22:59 -0700636 return;
637 }
638
Chris Craik3f0854292014-04-15 16:18:08 -0700639 handler.startMark(getName());
Chris Craikb265e2c2014-03-27 15:50:09 -0700640
John Reck113e0822014-03-18 09:22:59 -0700641#if DEBUG_DISPLAY_LIST
Chris Craik3f0854292014-04-15 16:18:08 -0700642 const Rect& clipRect = renderer.getLocalClipBounds();
643 DISPLAY_LIST_LOGD("%*sStart display list (%p, %s), localClipBounds: %.0f, %.0f, %.0f, %.0f",
644 level * 2, "", this, getName(),
645 clipRect.left, clipRect.top, clipRect.right, clipRect.bottom);
John Reck113e0822014-03-18 09:22:59 -0700646#endif
647
648 LinearAllocator& alloc = handler.allocator();
649 int restoreTo = renderer.getSaveCount();
650 handler(new (alloc) SaveOp(SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag),
John Reckd0a0b2a2014-03-20 16:28:56 -0700651 PROPERTY_SAVECOUNT, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700652
653 DISPLAY_LIST_LOGD("%*sSave %d %d", (level + 1) * 2, "",
654 SkCanvas::kMatrix_SaveFlag | SkCanvas::kClip_SaveFlag, restoreTo);
655
Chris Craikb265e2c2014-03-27 15:50:09 -0700656 setViewProperties<T>(renderer, handler);
John Reck113e0822014-03-18 09:22:59 -0700657
Chris Craik8c271ca2014-03-25 10:33:01 -0700658 bool quickRejected = properties().getClipToBounds()
659 && renderer.quickRejectConservative(0, 0, properties().getWidth(), properties().getHeight());
John Reck113e0822014-03-18 09:22:59 -0700660 if (!quickRejected) {
661 Vector<ZDrawDisplayListOpPair> zTranslatedNodes;
662 buildZSortedChildList(zTranslatedNodes);
663
664 // for 3d root, draw children with negative z values
Chris Craikb265e2c2014-03-27 15:50:09 -0700665 issueOperationsOf3dChildren(zTranslatedNodes, kNegativeZChildren, renderer, handler);
John Reck113e0822014-03-18 09:22:59 -0700666
667 DisplayListLogBuffer& logBuffer = DisplayListLogBuffer::getInstance();
668 const int saveCountOffset = renderer.getSaveCount() - 1;
669 const int projectionReceiveIndex = mDisplayListData->projectionReceiveIndex;
670 for (unsigned int i = 0; i < mDisplayListData->displayListOps.size(); i++) {
671 DisplayListOp *op = mDisplayListData->displayListOps[i];
672
673#if DEBUG_DISPLAY_LIST
674 op->output(level + 1);
675#endif
John Reck113e0822014-03-18 09:22:59 -0700676 logBuffer.writeCommand(level, op->name());
John Reckd0a0b2a2014-03-20 16:28:56 -0700677 handler(op, saveCountOffset, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700678
679 if (CC_UNLIKELY(i == projectionReceiveIndex && mProjectedNodes.size() > 0)) {
Chris Craikb265e2c2014-03-27 15:50:09 -0700680 issueOperationsOfProjectedChildren(renderer, handler);
John Reck113e0822014-03-18 09:22:59 -0700681 }
682 }
683
684 // for 3d root, draw children with positive z values
Chris Craikb265e2c2014-03-27 15:50:09 -0700685 issueOperationsOf3dChildren(zTranslatedNodes, kPositiveZChildren, renderer, handler);
John Reck113e0822014-03-18 09:22:59 -0700686 }
687
688 DISPLAY_LIST_LOGD("%*sRestoreToCount %d", (level + 1) * 2, "", restoreTo);
689 handler(new (alloc) RestoreToCountOp(restoreTo),
John Reckd0a0b2a2014-03-20 16:28:56 -0700690 PROPERTY_SAVECOUNT, properties().getClipToBounds());
John Reck113e0822014-03-18 09:22:59 -0700691 renderer.setOverrideLayerAlpha(1.0f);
Chris Craikb265e2c2014-03-27 15:50:09 -0700692
Chris Craik3f0854292014-04-15 16:18:08 -0700693 DISPLAY_LIST_LOGD("%*sDone (%p, %s)", level * 2, "", this, getName());
Chris Craikb265e2c2014-03-27 15:50:09 -0700694 handler.endMark();
John Reck113e0822014-03-18 09:22:59 -0700695}
696
697} /* namespace uirenderer */
698} /* namespace android */