blob: d8ca48d7969c0904275bad925fc62fe1a9d6a07d [file] [log] [blame]
commit-bot@chromium.orgc4b21e62014-04-11 18:33:31 +00001/*
2 * Copyright 2014 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
commit-bot@chromium.orgd9ce2be2014-04-09 23:30:28 +00008#include "Test.h"
commit-bot@chromium.org0a98d872014-05-19 15:15:24 +00009#include "RecordTestUtils.h"
commit-bot@chromium.orgd9ce2be2014-04-09 23:30:28 +000010
11#include "SkDebugCanvas.h"
Mike Klein271a0302014-09-23 15:28:38 -040012#include "SkDropShadowImageFilter.h"
piotaixr65151752014-10-16 11:58:39 -070013#include "SkImagePriv.h"
commit-bot@chromium.orgd9ce2be2014-04-09 23:30:28 +000014#include "SkRecord.h"
commit-bot@chromium.orgd9ce2be2014-04-09 23:30:28 +000015#include "SkRecordDraw.h"
Mike Klein271a0302014-09-23 15:28:38 -040016#include "SkRecordOpts.h"
commit-bot@chromium.orgd9ce2be2014-04-09 23:30:28 +000017#include "SkRecorder.h"
18#include "SkRecords.h"
piotaixr65151752014-10-16 11:58:39 -070019#include "SkSurface.h"
commit-bot@chromium.orgd9ce2be2014-04-09 23:30:28 +000020
21static const int W = 1920, H = 1080;
22
robertphillips783fe162015-01-07 07:28:41 -080023class JustOneDraw : public SkPicture::AbortCallback {
Mike Kleinc11530e2014-06-24 11:29:06 -040024public:
25 JustOneDraw() : fCalls(0) {}
26
mtklein36352bf2015-03-25 18:17:31 -070027 bool abort() override { return fCalls++ > 0; }
Mike Kleinc11530e2014-06-24 11:29:06 -040028private:
29 int fCalls;
30};
31
reed2ff1fce2014-12-11 07:07:37 -080032DEF_TEST(RecordDraw_LazySaves, r) {
33 // Record two commands.
34 SkRecord record;
35 SkRecorder recorder(&record, W, H);
36
37 REPORTER_ASSERT(r, 0 == record.count());
38 recorder.save();
39 REPORTER_ASSERT(r, 0 == record.count()); // the save was not recorded (yet)
40 recorder.drawColor(SK_ColorRED);
41 REPORTER_ASSERT(r, 1 == record.count());
42 recorder.scale(2, 2);
43 REPORTER_ASSERT(r, 3 == record.count()); // now we see the save
44 recorder.restore();
45 REPORTER_ASSERT(r, 4 == record.count());
46
47 assert_type<SkRecords::DrawPaint>(r, record, 0);
48 assert_type<SkRecords::Save> (r, record, 1);
49 assert_type<SkRecords::SetMatrix>(r, record, 2);
50 assert_type<SkRecords::Restore> (r, record, 3);
51
52 recorder.save();
53 recorder.save();
54 recorder.restore();
55 recorder.restore();
56 REPORTER_ASSERT(r, 4 == record.count());
57}
58
Mike Kleinc11530e2014-06-24 11:29:06 -040059DEF_TEST(RecordDraw_Abort, r) {
60 // Record two commands.
61 SkRecord record;
62 SkRecorder recorder(&record, W, H);
63 recorder.drawRect(SkRect::MakeWH(200, 300), SkPaint());
64 recorder.clipRect(SkRect::MakeWH(100, 200));
65
66 SkRecord rerecord;
67 SkRecorder canvas(&rerecord, W, H);
68
69 JustOneDraw callback;
halcanary96fcdcc2015-08-27 07:41:13 -070070 SkRecordDraw(record, &canvas, nullptr, nullptr, 0, nullptr/*bbh*/, &callback);
Mike Kleinc11530e2014-06-24 11:29:06 -040071
reed2ff1fce2014-12-11 07:07:37 -080072 REPORTER_ASSERT(r, 1 == count_instances_of_type<SkRecords::DrawRect>(rerecord));
73 REPORTER_ASSERT(r, 0 == count_instances_of_type<SkRecords::ClipRect>(rerecord));
Mike Kleinc11530e2014-06-24 11:29:06 -040074}
75
76DEF_TEST(RecordDraw_Unbalanced, r) {
77 SkRecord record;
78 SkRecorder recorder(&record, W, H);
79 recorder.save(); // We won't balance this, but SkRecordDraw will for us.
reed2ff1fce2014-12-11 07:07:37 -080080 recorder.scale(2, 2);
Mike Kleinc11530e2014-06-24 11:29:06 -040081
82 SkRecord rerecord;
83 SkRecorder canvas(&rerecord, W, H);
halcanary96fcdcc2015-08-27 07:41:13 -070084 SkRecordDraw(record, &canvas, nullptr, nullptr, 0, nullptr/*bbh*/, nullptr/*callback*/);
Mike Kleinc11530e2014-06-24 11:29:06 -040085
reed2ff1fce2014-12-11 07:07:37 -080086 int save_count = count_instances_of_type<SkRecords::Save>(rerecord);
87 int restore_count = count_instances_of_type<SkRecords::Save>(rerecord);
88 REPORTER_ASSERT(r, save_count == restore_count);
Mike Kleinc11530e2014-06-24 11:29:06 -040089}
90
commit-bot@chromium.org0a98d872014-05-19 15:15:24 +000091DEF_TEST(RecordDraw_SetMatrixClobber, r) {
92 // Set up an SkRecord that just scales by 2x,3x.
93 SkRecord scaleRecord;
commit-bot@chromium.orga0950412014-05-29 16:52:40 +000094 SkRecorder scaleCanvas(&scaleRecord, W, H);
commit-bot@chromium.org0a98d872014-05-19 15:15:24 +000095 SkMatrix scale;
96 scale.setScale(2, 3);
97 scaleCanvas.setMatrix(scale);
98
99 // Set up an SkRecord with an initial +20, +20 translate.
100 SkRecord translateRecord;
commit-bot@chromium.orga0950412014-05-29 16:52:40 +0000101 SkRecorder translateCanvas(&translateRecord, W, H);
commit-bot@chromium.org0a98d872014-05-19 15:15:24 +0000102 SkMatrix translate;
103 translate.setTranslate(20, 20);
104 translateCanvas.setMatrix(translate);
105
halcanary96fcdcc2015-08-27 07:41:13 -0700106 SkRecordDraw(scaleRecord, &translateCanvas, nullptr, nullptr, 0, nullptr/*bbh*/, nullptr/*callback*/);
Mike Kleinc11530e2014-06-24 11:29:06 -0400107 REPORTER_ASSERT(r, 4 == translateRecord.count());
108 assert_type<SkRecords::SetMatrix>(r, translateRecord, 0);
109 assert_type<SkRecords::Save> (r, translateRecord, 1);
110 assert_type<SkRecords::SetMatrix>(r, translateRecord, 2);
111 assert_type<SkRecords::Restore> (r, translateRecord, 3);
commit-bot@chromium.org0a98d872014-05-19 15:15:24 +0000112
113 // When we look at translateRecord now, it should have its first +20,+20 translate,
114 // then a 2x,3x scale that's been concatted with that +20,+20 translate.
115 const SkRecords::SetMatrix* setMatrix;
116 setMatrix = assert_type<SkRecords::SetMatrix>(r, translateRecord, 0);
117 REPORTER_ASSERT(r, setMatrix->matrix == translate);
118
Mike Kleinc11530e2014-06-24 11:29:06 -0400119 setMatrix = assert_type<SkRecords::SetMatrix>(r, translateRecord, 2);
commit-bot@chromium.org0a98d872014-05-19 15:15:24 +0000120 SkMatrix expected = scale;
121 expected.postConcat(translate);
122 REPORTER_ASSERT(r, setMatrix->matrix == expected);
123}
mtkleina723b572014-08-15 11:49:49 -0700124
125struct TestBBH : public SkBBoxHierarchy {
mtklein36352bf2015-03-25 18:17:31 -0700126 void insert(const SkRect boundsArray[], int N) override {
mtklein4477c3c2014-10-27 10:27:10 -0700127 fEntries.setCount(N);
128 for (int i = 0; i < N; i++) {
mtkleinc6ad06a2015-08-19 09:51:00 -0700129 Entry e = { i, boundsArray[i] };
mtklein4477c3c2014-10-27 10:27:10 -0700130 fEntries[i] = e;
131 }
mtkleina723b572014-08-15 11:49:49 -0700132 }
mtkleina723b572014-08-15 11:49:49 -0700133
mtkleinc6ad06a2015-08-19 09:51:00 -0700134 void search(const SkRect& query, SkTDArray<int>* results) const override {}
mtklein36352bf2015-03-25 18:17:31 -0700135 size_t bytesUsed() const override { return 0; }
136 SkRect getRootBound() const override { return SkRect::MakeEmpty(); }
mtkleina723b572014-08-15 11:49:49 -0700137
138 struct Entry {
mtkleinc6ad06a2015-08-19 09:51:00 -0700139 int opIndex;
mtklein533eb782014-08-27 10:39:42 -0700140 SkRect bounds;
mtkleina723b572014-08-15 11:49:49 -0700141 };
mtklein6bd41962014-10-02 07:41:56 -0700142 SkTDArray<Entry> fEntries;
mtkleina723b572014-08-15 11:49:49 -0700143};
144
mtklein937c9c72014-09-02 15:19:48 -0700145// Like a==b, with a little slop recognizing that float equality can be weird.
146static bool sloppy_rect_eq(SkRect a, SkRect b) {
147 SkRect inset(a), outset(a);
148 inset.inset(1, 1);
149 outset.outset(1, 1);
150 return outset.contains(b) && !inset.contains(b);
151}
152
mtkleina723b572014-08-15 11:49:49 -0700153// This test is not meant to make total sense yet. It's testing the status quo
154// of SkRecordFillBounds(), which itself doesn't make total sense yet.
155DEF_TEST(RecordDraw_BBH, r) {
mtkleina723b572014-08-15 11:49:49 -0700156 SkRecord record;
mtkleina723b572014-08-15 11:49:49 -0700157 SkRecorder recorder(&record, W, H);
158 recorder.save();
159 recorder.clipRect(SkRect::MakeWH(400, 500));
160 recorder.scale(2, 2);
161 recorder.drawRect(SkRect::MakeWH(320, 240), SkPaint());
162 recorder.restore();
163
mtklein937c9c72014-09-02 15:19:48 -0700164 TestBBH bbh;
robertphillips4d52afe2014-11-03 08:19:44 -0800165 SkRecordFillBounds(SkRect::MakeWH(SkIntToScalar(W), SkIntToScalar(H)), record, &bbh);
mtkleina723b572014-08-15 11:49:49 -0700166
mtklein6bd41962014-10-02 07:41:56 -0700167 REPORTER_ASSERT(r, bbh.fEntries.count() == 5);
168 for (int i = 0; i < bbh.fEntries.count(); i++) {
mtkleinc6ad06a2015-08-19 09:51:00 -0700169 REPORTER_ASSERT(r, bbh.fEntries[i].opIndex == i);
mtkleina723b572014-08-15 11:49:49 -0700170
mtklein6bd41962014-10-02 07:41:56 -0700171 REPORTER_ASSERT(r, sloppy_rect_eq(SkRect::MakeWH(400, 480), bbh.fEntries[i].bounds));
mtkleina723b572014-08-15 11:49:49 -0700172 }
173}
mtklein00f30bd2014-09-02 12:03:31 -0700174
mtklein937c9c72014-09-02 15:19:48 -0700175// A regression test for crbug.com/409110.
176DEF_TEST(RecordDraw_TextBounds, r) {
177 SkRecord record;
178 SkRecorder recorder(&record, W, H);
179
180 // Two Chinese characters in UTF-8.
181 const char text[] = { '\xe6', '\xbc', '\xa2', '\xe5', '\xad', '\x97' };
182 const size_t bytes = SK_ARRAY_COUNT(text);
183
184 const SkScalar xpos[] = { 10, 20 };
185 recorder.drawPosTextH(text, bytes, xpos, 30, SkPaint());
186
187 const SkPoint pos[] = { {40, 50}, {60, 70} };
188 recorder.drawPosText(text, bytes, pos, SkPaint());
189
190 TestBBH bbh;
robertphillips4d52afe2014-11-03 08:19:44 -0800191 SkRecordFillBounds(SkRect::MakeWH(SkIntToScalar(W), SkIntToScalar(H)), record, &bbh);
mtklein6bd41962014-10-02 07:41:56 -0700192 REPORTER_ASSERT(r, bbh.fEntries.count() == 2);
mtklein937c9c72014-09-02 15:19:48 -0700193
mtklein9a5380d2014-12-16 06:31:01 -0800194 // We can make these next assertions confidently because SkRecordFillBounds
195 // builds its bounds by overestimating font metrics in a platform-independent way.
196 // If that changes, these tests will need to be more flexible.
197 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[0].bounds, SkRect::MakeLTRB(0, 0, 140, 60)));
198 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[1].bounds, SkRect::MakeLTRB(0, 20, 180, 100)));
mtklein937c9c72014-09-02 15:19:48 -0700199}
200
mtklein00f30bd2014-09-02 12:03:31 -0700201// Base test to ensure start/stop range is respected
202DEF_TEST(RecordDraw_PartialStartStop, r) {
203 static const int kWidth = 10, kHeight = 10;
204
205 SkRect r1 = { 0, 0, kWidth, kHeight };
206 SkRect r2 = { 0, 0, kWidth, kHeight/2 };
207 SkRect r3 = { 0, 0, kWidth/2, kHeight };
208 SkPaint p;
209
210 SkRecord record;
211 SkRecorder recorder(&record, kWidth, kHeight);
212 recorder.drawRect(r1, p);
213 recorder.drawRect(r2, p);
214 recorder.drawRect(r3, p);
215
216 SkRecord rerecord;
217 SkRecorder canvas(&rerecord, kWidth, kHeight);
halcanary96fcdcc2015-08-27 07:41:13 -0700218 SkRecordPartialDraw(record, &canvas, nullptr, 0, 1, 2, SkMatrix::I()); // replay just drawRect of r2
mtklein00f30bd2014-09-02 12:03:31 -0700219
reed2ff1fce2014-12-11 07:07:37 -0800220 REPORTER_ASSERT(r, 1 == count_instances_of_type<SkRecords::DrawRect>(rerecord));
221 int index = find_first_instances_of_type<SkRecords::DrawRect>(rerecord);
222 const SkRecords::DrawRect* drawRect = assert_type<SkRecords::DrawRect>(r, rerecord, index);
mtklein00f30bd2014-09-02 12:03:31 -0700223 REPORTER_ASSERT(r, drawRect->rect == r2);
224}
225
Mike Klein271a0302014-09-23 15:28:38 -0400226// A regression test for crbug.com/415468 and skbug.com/2957.
mtklein8e393bf2014-10-01 12:48:58 -0700227//
228// This also now serves as a regression test for crbug.com/418417. We used to adjust the
229// bounds for the saveLayer, clip, and restore to be greater than the bounds of the picture.
230// (We were applying the saveLayer paint to the bounds after restore, which makes no sense.)
Mike Klein271a0302014-09-23 15:28:38 -0400231DEF_TEST(RecordDraw_SaveLayerAffectsClipBounds, r) {
232 SkRecord record;
233 SkRecorder recorder(&record, 50, 50);
234
235 // We draw a rectangle with a long drop shadow. We used to not update the clip
236 // bounds based on SaveLayer paints, so the drop shadow could be cut off.
237 SkPaint paint;
sugoi234f0362014-10-23 13:59:52 -0700238 paint.setImageFilter(SkDropShadowImageFilter::Create(20, 0, 0, 0, SK_ColorBLACK,
239 SkDropShadowImageFilter::kDrawShadowAndForeground_ShadowMode))->unref();
Mike Klein271a0302014-09-23 15:28:38 -0400240
halcanary96fcdcc2015-08-27 07:41:13 -0700241 recorder.saveLayer(nullptr, &paint);
Mike Klein271a0302014-09-23 15:28:38 -0400242 recorder.clipRect(SkRect::MakeWH(20, 40));
243 recorder.drawRect(SkRect::MakeWH(20, 40), SkPaint());
244 recorder.restore();
245
mtklein8e393bf2014-10-01 12:48:58 -0700246 // Under the original bug, the right edge value of the drawRect would be 20 less than asserted
247 // here because we intersected it with a clip that had not been adjusted for the drop shadow.
248 //
249 // The second bug showed up as adjusting the picture bounds (0,0,50,50) by the drop shadow too.
250 // The saveLayer, clipRect, and restore bounds were incorrectly (0,0,70,50).
Mike Klein271a0302014-09-23 15:28:38 -0400251 TestBBH bbh;
robertphillips4d52afe2014-11-03 08:19:44 -0800252 SkRecordFillBounds(SkRect::MakeWH(50, 50), record, &bbh);
mtklein6bd41962014-10-02 07:41:56 -0700253 REPORTER_ASSERT(r, bbh.fEntries.count() == 4);
254 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[0].bounds, SkRect::MakeLTRB(0, 0, 50, 50)));
255 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[1].bounds, SkRect::MakeLTRB(0, 0, 50, 50)));
256 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[2].bounds, SkRect::MakeLTRB(0, 0, 40, 40)));
257 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[3].bounds, SkRect::MakeLTRB(0, 0, 50, 50)));
Mike Klein271a0302014-09-23 15:28:38 -0400258}
piotaixr65151752014-10-16 11:58:39 -0700259
robertphillips4d52afe2014-11-03 08:19:44 -0800260// When a saveLayer provides an explicit bound and has a complex paint (e.g., one that
261// affects transparent black), that bound should serve to shrink the area of the required
262// backing store.
263DEF_TEST(RecordDraw_SaveLayerBoundsAffectsClipBounds, r) {
264 SkRecord record;
265 SkRecorder recorder(&record, 50, 50);
266
267 SkPaint p;
268 p.setXfermodeMode(SkXfermode::kSrc_Mode);
269
270 SkRect bounds = SkRect::MakeLTRB(10, 10, 40, 40);
271 recorder.saveLayer(&bounds, &p);
272 recorder.drawRect(SkRect::MakeLTRB(20, 20, 30, 30), SkPaint());
273 recorder.restore();
274
275 TestBBH bbh;
276 SkRecordFillBounds(SkRect::MakeWH(50, 50), record, &bbh);
277 REPORTER_ASSERT(r, bbh.fEntries.count() == 3);
reedd990e2f2014-12-22 11:58:30 -0800278 if (!SkCanvas::Internal_Private_GetIgnoreSaveLayerBounds()) {
279 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[0].bounds, SkRect::MakeLTRB(10, 10, 40, 40)));
280 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[1].bounds, SkRect::MakeLTRB(20, 20, 30, 30)));
281 REPORTER_ASSERT(r, sloppy_rect_eq(bbh.fEntries[2].bounds, SkRect::MakeLTRB(10, 10, 40, 40)));
282 }
robertphillips4d52afe2014-11-03 08:19:44 -0800283}
284
piotaixr65151752014-10-16 11:58:39 -0700285DEF_TEST(RecordDraw_drawImage, r){
286 class SkCanvasMock : public SkCanvas {
287 public:
mtkleinad8aa1d2014-11-11 18:52:02 -0800288 SkCanvasMock(int width, int height) : SkCanvas(width, height) {
piotaixr65151752014-10-16 11:58:39 -0700289 this->resetTestValues();
290 }
piotaixr65151752014-10-16 11:58:39 -0700291
reed41af9662015-01-05 07:49:08 -0800292 void onDrawImage(const SkImage* image, SkScalar left, SkScalar top,
mtklein36352bf2015-03-25 18:17:31 -0700293 const SkPaint* paint) override {
piotaixr65151752014-10-16 11:58:39 -0700294 fDrawImageCalled = true;
295 }
296
reed41af9662015-01-05 07:49:08 -0800297 void onDrawImageRect(const SkImage* image, const SkRect* src, const SkRect& dst,
reed562fe472015-07-28 07:35:14 -0700298 const SkPaint* paint, SrcRectConstraint) override {
piotaixr65151752014-10-16 11:58:39 -0700299 fDrawImageRectCalled = true;
300 }
301
302 void resetTestValues() {
303 fDrawImageCalled = fDrawImageRectCalled = false;
304 }
305
306 bool fDrawImageCalled;
307 bool fDrawImageRectCalled;
piotaixr65151752014-10-16 11:58:39 -0700308 };
309
reed3054be12014-12-10 07:24:28 -0800310 SkAutoTUnref<SkSurface> surface(SkSurface::NewRasterN32Premul(10, 10));
piotaixr65151752014-10-16 11:58:39 -0700311 surface->getCanvas()->clear(SK_ColorGREEN);
312 SkAutoTUnref<SkImage> image(surface->newImageSnapshot());
313
314 SkCanvasMock canvas(10, 10);
315
316 {
317 SkRecord record;
318 SkRecorder recorder(&record, 10, 10);
319 recorder.drawImage(image, 0, 0);
halcanary96fcdcc2015-08-27 07:41:13 -0700320 SkRecordDraw(record, &canvas, nullptr, nullptr, 0, nullptr, 0);
piotaixr65151752014-10-16 11:58:39 -0700321 }
322 REPORTER_ASSERT(r, canvas.fDrawImageCalled);
323 canvas.resetTestValues();
324
325 {
326 SkRecord record;
327 SkRecorder recorder(&record, 10, 10);
reede47829b2015-08-06 10:02:53 -0700328 recorder.drawImageRect(image, SkRect::MakeWH(10, 10), nullptr);
halcanary96fcdcc2015-08-27 07:41:13 -0700329 SkRecordDraw(record, &canvas, nullptr, nullptr, 0, nullptr, 0);
piotaixr65151752014-10-16 11:58:39 -0700330 }
331 REPORTER_ASSERT(r, canvas.fDrawImageRectCalled);
332
333}