1 /*
2 * Copyright 2013 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
8 #include "include/core/SkAnnotation.h"
9 #include "include/core/SkBitmap.h"
10 #include "include/core/SkBlendMode.h"
11 #include "include/core/SkCanvas.h"
12 #include "include/core/SkColor.h"
13 #include "include/core/SkColorFilter.h"
14 #include "include/core/SkData.h"
15 #include "include/core/SkDataTable.h"
16 #include "include/core/SkFont.h"
17 #include "include/core/SkFontArguments.h"
18 #include "include/core/SkFontMetrics.h"
19 #include "include/core/SkFontMgr.h"
20 #include "include/core/SkFontStyle.h"
21 #include "include/core/SkImage.h"
22 #include "include/core/SkImageFilter.h"
23 #include "include/core/SkImageInfo.h"
24 #include "include/core/SkMatrix.h"
25 #include "include/core/SkPaint.h"
26 #include "include/core/SkPath.h"
27 #include "include/core/SkPathEffect.h"
28 #include "include/core/SkPicture.h"
29 #include "include/core/SkPictureRecorder.h"
30 #include "include/core/SkPoint.h"
31 #include "include/core/SkPoint3.h"
32 #include "include/core/SkRRect.h"
33 #include "include/core/SkRect.h"
34 #include "include/core/SkRefCnt.h"
35 #include "include/core/SkRegion.h"
36 #include "include/core/SkSamplingOptions.h"
37 #include "include/core/SkScalar.h"
38 #include "include/core/SkSerialProcs.h"
39 #include "include/core/SkStream.h"
40 #include "include/core/SkString.h"
41 #include "include/core/SkSurface.h"
42 #include "include/core/SkTextBlob.h"
43 #include "include/core/SkTypeface.h"
44 #include "include/core/SkTypes.h"
45 #include "include/effects/SkDashPathEffect.h"
46 #include "include/effects/SkImageFilters.h"
47 #include "include/encode/SkPngEncoder.h"
48 #include "include/private/base/SkAlign.h"
49 #include "include/private/base/SkMalloc.h"
50 #include "include/private/base/SkTemplates.h"
51 #include "src/base/SkAutoMalloc.h"
52 #include "src/core/SkAnnotationKeys.h"
53 #include "src/core/SkImageFilter_Base.h"
54 #include "src/core/SkPicturePriv.h"
55 #include "src/core/SkReadBuffer.h"
56 #include "src/core/SkWriteBuffer.h"
57 #include "src/effects/colorfilters/SkColorFilterBase.h"
58 #include "tests/Test.h"
59 #include "tools/Resources.h"
60 #include "tools/ToolUtils.h"
61 #include "tools/fonts/FontToolUtils.h"
62
63 #include <algorithm>
64 #include <array>
65 #include <cstdint>
66 #include <cstring>
67 #include <memory>
68 #include <utility>
69
70 using namespace skia_private;
71
72 static const uint32_t kArraySize = 64;
73 static const int kBitmapSize = 256;
74
75 class SerializationTest {
76 public:
77
78 template<typename T>
TestAlignment(T * testObj,skiatest::Reporter * reporter)79 static void TestAlignment(T* testObj, skiatest::Reporter* reporter) {
80 // Test memory read/write functions directly
81 unsigned char dataWritten[1024];
82 size_t bytesWrittenToMemory = testObj->writeToMemory(dataWritten);
83 REPORTER_ASSERT(reporter, SkAlign4(bytesWrittenToMemory) == bytesWrittenToMemory);
84 size_t bytesReadFromMemory = testObj->readFromMemory(dataWritten, bytesWrittenToMemory);
85 REPORTER_ASSERT(reporter, SkAlign4(bytesReadFromMemory) == bytesReadFromMemory);
86 }
87 };
88
89 template<typename T> struct SerializationUtils {
90 // Generic case for flattenables
WriteSerializationUtils91 static void Write(SkWriteBuffer& writer, const T* flattenable) {
92 writer.writeFlattenable(flattenable);
93 }
ReadSerializationUtils94 static void Read(SkReadBuffer& reader, T** flattenable) {
95 *flattenable = (T*)reader.readFlattenable(T::GetFlattenableType());
96 }
97 };
98
99 template<> struct SerializationUtils<SkMatrix> {
WriteSerializationUtils100 static void Write(SkWriteBuffer& writer, const SkMatrix* matrix) {
101 writer.writeMatrix(*matrix);
102 }
ReadSerializationUtils103 static void Read(SkReadBuffer& reader, SkMatrix* matrix) {
104 reader.readMatrix(matrix);
105 }
106 };
107
108 template<> struct SerializationUtils<SkPath> {
WriteSerializationUtils109 static void Write(SkWriteBuffer& writer, const SkPath* path) {
110 writer.writePath(*path);
111 }
ReadSerializationUtils112 static void Read(SkReadBuffer& reader, SkPath* path) {
113 reader.readPath(path);
114 }
115 };
116
117 template<> struct SerializationUtils<SkRegion> {
WriteSerializationUtils118 static void Write(SkWriteBuffer& writer, const SkRegion* region) {
119 writer.writeRegion(*region);
120 }
ReadSerializationUtils121 static void Read(SkReadBuffer& reader, SkRegion* region) {
122 reader.readRegion(region);
123 }
124 };
125
126 template<> struct SerializationUtils<SkString> {
WriteSerializationUtils127 static void Write(SkWriteBuffer& writer, const SkString* string) {
128 writer.writeString(string->c_str());
129 }
ReadSerializationUtils130 static void Read(SkReadBuffer& reader, SkString* string) {
131 reader.readString(string);
132 }
133 };
134
135 template<> struct SerializationUtils<unsigned char> {
WriteSerializationUtils136 static void Write(SkWriteBuffer& writer, unsigned char* data, uint32_t arraySize) {
137 writer.writeByteArray(data, arraySize);
138 }
ReadSerializationUtils139 static bool Read(SkReadBuffer& reader, unsigned char* data, uint32_t arraySize) {
140 return reader.readByteArray(data, arraySize);
141 }
142 };
143
144 template<> struct SerializationUtils<SkColor> {
WriteSerializationUtils145 static void Write(SkWriteBuffer& writer, SkColor* data, uint32_t arraySize) {
146 writer.writeColorArray(data, arraySize);
147 }
ReadSerializationUtils148 static bool Read(SkReadBuffer& reader, SkColor* data, uint32_t arraySize) {
149 return reader.readColorArray(data, arraySize);
150 }
151 };
152
153 template<> struct SerializationUtils<SkColor4f> {
WriteSerializationUtils154 static void Write(SkWriteBuffer& writer, SkColor4f* data, uint32_t arraySize) {
155 writer.writeColor4fArray(data, arraySize);
156 }
ReadSerializationUtils157 static bool Read(SkReadBuffer& reader, SkColor4f* data, uint32_t arraySize) {
158 return reader.readColor4fArray(data, arraySize);
159 }
160 };
161
162 template<> struct SerializationUtils<int32_t> {
WriteSerializationUtils163 static void Write(SkWriteBuffer& writer, int32_t* data, uint32_t arraySize) {
164 writer.writeIntArray(data, arraySize);
165 }
ReadSerializationUtils166 static bool Read(SkReadBuffer& reader, int32_t* data, uint32_t arraySize) {
167 return reader.readIntArray(data, arraySize);
168 }
169 };
170
171 template<> struct SerializationUtils<SkPoint> {
WriteSerializationUtils172 static void Write(SkWriteBuffer& writer, SkPoint* data, uint32_t arraySize) {
173 writer.writePointArray(data, arraySize);
174 }
ReadSerializationUtils175 static bool Read(SkReadBuffer& reader, SkPoint* data, uint32_t arraySize) {
176 return reader.readPointArray(data, arraySize);
177 }
178 };
179
180 template<> struct SerializationUtils<SkPoint3> {
WriteSerializationUtils181 static void Write(SkWriteBuffer& writer, const SkPoint3* data) {
182 writer.writePoint3(*data);
183 }
ReadSerializationUtils184 static void Read(SkReadBuffer& reader, SkPoint3* data) {
185 reader.readPoint3(data);
186 }
187 };
188
189 template<> struct SerializationUtils<SkScalar> {
WriteSerializationUtils190 static void Write(SkWriteBuffer& writer, SkScalar* data, uint32_t arraySize) {
191 writer.writeScalarArray(data, arraySize);
192 }
ReadSerializationUtils193 static bool Read(SkReadBuffer& reader, SkScalar* data, uint32_t arraySize) {
194 return reader.readScalarArray(data, arraySize);
195 }
196 };
197
198 template<typename T, bool testInvalid> struct SerializationTestUtils {
InvalidateDataSerializationTestUtils199 static void InvalidateData(unsigned char* data) {}
200 };
201
202 template<> struct SerializationTestUtils<SkString, true> {
InvalidateDataSerializationTestUtils203 static void InvalidateData(unsigned char* data) {
204 data[3] |= 0x80; // Reverse sign of 1st integer
205 }
206 };
207
208 template<typename T, bool testInvalid>
TestObjectSerializationNoAlign(T * testObj,skiatest::Reporter * reporter)209 static void TestObjectSerializationNoAlign(T* testObj, skiatest::Reporter* reporter) {
210 SkBinaryWriteBuffer writer({});
211 SerializationUtils<T>::Write(writer, testObj);
212 size_t bytesWritten = writer.bytesWritten();
213 REPORTER_ASSERT(reporter, SkAlign4(bytesWritten) == bytesWritten);
214
215 unsigned char dataWritten[1024];
216 writer.writeToMemory(dataWritten);
217
218 SerializationTestUtils<T, testInvalid>::InvalidateData(dataWritten);
219
220 // Make sure this fails when it should (test with smaller size, but still multiple of 4)
221 SkReadBuffer buffer(dataWritten, bytesWritten - 4);
222 T obj;
223 SerializationUtils<T>::Read(buffer, &obj);
224 REPORTER_ASSERT(reporter, !buffer.isValid());
225
226 // Make sure this succeeds when it should
227 SkReadBuffer buffer2(dataWritten, bytesWritten);
228 size_t offsetBefore = buffer2.offset();
229 T obj2;
230 SerializationUtils<T>::Read(buffer2, &obj2);
231 size_t offsetAfter = buffer2.offset();
232 // This should have succeeded, since there are enough bytes to read this
233 REPORTER_ASSERT(reporter, buffer2.isValid() == !testInvalid);
234 // Note: This following test should always succeed, regardless of whether the buffer is valid,
235 // since if it is invalid, it will simply skip to the end, as if it had read the whole buffer.
236 REPORTER_ASSERT(reporter, offsetAfter - offsetBefore == bytesWritten);
237 }
238
239 template<typename T>
TestObjectSerialization(T * testObj,skiatest::Reporter * reporter)240 static void TestObjectSerialization(T* testObj, skiatest::Reporter* reporter) {
241 TestObjectSerializationNoAlign<T, false>(testObj, reporter);
242 SerializationTest::TestAlignment(testObj, reporter);
243 }
244
245 template<typename T>
TestFlattenableSerialization(T * testObj,bool shouldSucceed,skiatest::Reporter * reporter)246 static T* TestFlattenableSerialization(T* testObj, bool shouldSucceed,
247 skiatest::Reporter* reporter) {
248 SkBinaryWriteBuffer writer({});
249 SerializationUtils<T>::Write(writer, testObj);
250 size_t bytesWritten = writer.bytesWritten();
251 REPORTER_ASSERT(reporter, SkAlign4(bytesWritten) == bytesWritten);
252
253 SkASSERT(bytesWritten <= 4096);
254 unsigned char dataWritten[4096];
255 writer.writeToMemory(dataWritten);
256
257 // Make sure this fails when it should (test with smaller size, but still multiple of 4)
258 SkReadBuffer buffer(dataWritten, bytesWritten - 4);
259 T* obj = nullptr;
260 SerializationUtils<T>::Read(buffer, &obj);
261 REPORTER_ASSERT(reporter, !buffer.isValid());
262 REPORTER_ASSERT(reporter, nullptr == obj);
263
264 // Make sure this succeeds when it should
265 SkReadBuffer buffer2(dataWritten, bytesWritten);
266 const unsigned char* peekBefore = static_cast<const unsigned char*>(buffer2.skip(0));
267 T* obj2 = nullptr;
268 SerializationUtils<T>::Read(buffer2, &obj2);
269 const unsigned char* peekAfter = static_cast<const unsigned char*>(buffer2.skip(0));
270 if (shouldSucceed) {
271 // This should have succeeded, since there are enough bytes to read this
272 REPORTER_ASSERT(reporter, buffer2.isValid());
273 REPORTER_ASSERT(reporter, static_cast<size_t>(peekAfter - peekBefore) == bytesWritten);
274 REPORTER_ASSERT(reporter, obj2);
275 } else {
276 // If the deserialization was supposed to fail, make sure it did
277 REPORTER_ASSERT(reporter, !buffer.isValid());
278 REPORTER_ASSERT(reporter, nullptr == obj2);
279 }
280
281 return obj2; // Return object to perform further validity tests on it
282 }
283
284 template<typename T>
TestArraySerialization(T * data,skiatest::Reporter * reporter)285 static void TestArraySerialization(T* data, skiatest::Reporter* reporter) {
286 SkBinaryWriteBuffer writer({});
287 SerializationUtils<T>::Write(writer, data, kArraySize);
288 size_t bytesWritten = writer.bytesWritten();
289 // This should write the length (in 4 bytes) and the array
290 REPORTER_ASSERT(reporter, (4 + kArraySize * sizeof(T)) == bytesWritten);
291
292 unsigned char dataWritten[2048];
293 writer.writeToMemory(dataWritten);
294
295 // Make sure this fails when it should
296 SkReadBuffer buffer(dataWritten, bytesWritten);
297 T dataRead[kArraySize];
298 bool success = SerializationUtils<T>::Read(buffer, dataRead, kArraySize / 2);
299 // This should have failed, since the provided size was too small
300 REPORTER_ASSERT(reporter, !success);
301
302 // Make sure this succeeds when it should
303 SkReadBuffer buffer2(dataWritten, bytesWritten);
304 success = SerializationUtils<T>::Read(buffer2, dataRead, kArraySize);
305 // This should have succeeded, since there are enough bytes to read this
306 REPORTER_ASSERT(reporter, success);
307 }
308
TestBitmapSerialization(const SkBitmap & validBitmap,const SkBitmap & invalidBitmap,bool shouldSucceed,skiatest::Reporter * reporter)309 static void TestBitmapSerialization(const SkBitmap& validBitmap,
310 const SkBitmap& invalidBitmap,
311 bool shouldSucceed,
312 skiatest::Reporter* reporter) {
313 sk_sp<SkImage> validImage(validBitmap.asImage());
314 sk_sp<SkImageFilter> validBitmapSource(SkImageFilters::Image(std::move(validImage),
315 SkFilterMode::kNearest));
316 sk_sp<SkImage> invalidImage(invalidBitmap.asImage());
317 sk_sp<SkImageFilter> invalidBitmapSource(SkImageFilters::Image(std::move(invalidImage),
318 SkFilterMode::kNearest));
319 sk_sp<SkImageFilter> xfermodeImageFilter(
320 SkImageFilters::Blend(SkBlendMode::kSrcOver,
321 std::move(invalidBitmapSource),
322 std::move(validBitmapSource), nullptr));
323
324 sk_sp<SkImageFilter> deserializedFilter(
325 TestFlattenableSerialization<SkImageFilter_Base>(
326 (SkImageFilter_Base*)xfermodeImageFilter.get(), shouldSucceed, reporter));
327
328 // Try to render a small bitmap using the invalid deserialized filter
329 // to make sure we don't crash while trying to render it
330 if (shouldSucceed) {
331 SkBitmap bitmap;
332 bitmap.allocN32Pixels(24, 24);
333 SkCanvas canvas(bitmap);
334 canvas.clear(0x00000000);
335 SkPaint paint;
336 paint.setImageFilter(deserializedFilter);
337 canvas.clipRect(SkRect::MakeXYWH(0, 0, SkIntToScalar(24), SkIntToScalar(24)));
338 canvas.drawImage(bitmap.asImage(), 0, 0, SkSamplingOptions(), &paint);
339 }
340 }
341
TestColorFilterSerialization(skiatest::Reporter * reporter)342 static void TestColorFilterSerialization(skiatest::Reporter* reporter) {
343 uint8_t table[256];
344 for (int i = 0; i < 256; ++i) {
345 table[i] = (i * 41) % 256;
346 }
347 auto filter = SkColorFilters::Table(table);
348 sk_sp<SkColorFilter> copy(
349 TestFlattenableSerialization(as_CFB(filter.get()), true, reporter));
350 }
351
draw_picture(SkPicture & picture)352 static SkBitmap draw_picture(SkPicture& picture) {
353 SkBitmap bitmap;
354 bitmap.allocN32Pixels(SkScalarCeilToInt(picture.cullRect().width()),
355 SkScalarCeilToInt(picture.cullRect().height()));
356 SkCanvas canvas(bitmap);
357 picture.playback(&canvas);
358 return bitmap;
359 }
360
compare_bitmaps(skiatest::Reporter * reporter,const SkBitmap & b1,const SkBitmap & b2)361 static void compare_bitmaps(skiatest::Reporter* reporter,
362 const SkBitmap& b1, const SkBitmap& b2) {
363 REPORTER_ASSERT(reporter, b1.width() == b2.width());
364 REPORTER_ASSERT(reporter, b1.height() == b2.height());
365
366 if ((b1.width() != b2.width()) ||
367 (b1.height() != b2.height())) {
368 return;
369 }
370
371 int pixelErrors = 0;
372 for (int y = 0; y < b2.height(); ++y) {
373 for (int x = 0; x < b2.width(); ++x) {
374 if (b1.getColor(x, y) != b2.getColor(x, y))
375 ++pixelErrors;
376 }
377 }
378 REPORTER_ASSERT(reporter, 0 == pixelErrors);
379 }
380
serialize_typeface_proc(SkTypeface * typeface,void * ctx)381 static sk_sp<SkData> serialize_typeface_proc(SkTypeface* typeface, void* ctx) {
382 // Write out typeface ID followed by entire typeface.
383 SkDynamicMemoryWStream stream;
384 sk_sp<SkData> data(typeface->serialize(SkTypeface::SerializeBehavior::kDoIncludeData));
385 uint32_t typeface_id = typeface->uniqueID();
386 stream.write(&typeface_id, sizeof(typeface_id));
387 stream.write(data->data(), data->size());
388 return stream.detachAsData();
389 }
390
deserialize_typeface_proc(const void * data,size_t length,void * ctx)391 static sk_sp<SkTypeface> deserialize_typeface_proc(const void* data, size_t length, void* ctx) {
392 SkStream* stream;
393 if (length < sizeof(stream)) {
394 return nullptr;
395 }
396 memcpy(&stream, data, sizeof(stream));
397
398 SkTypefaceID id;
399 if (!stream->read(&id, sizeof(id))) {
400 return nullptr;
401 }
402
403 sk_sp<SkTypeface> typeface = SkTypeface::MakeDeserialize(stream, ToolUtils::TestFontMgr());
404 return typeface;
405 }
406
serialize_and_compare_typeface(sk_sp<SkTypeface> typeface,const char * text,const SkSerialProcs * serial_procs,const SkDeserialProcs * deserial_procs,skiatest::Reporter * reporter)407 static void serialize_and_compare_typeface(sk_sp<SkTypeface> typeface,
408 const char* text,
409 const SkSerialProcs* serial_procs,
410 const SkDeserialProcs* deserial_procs,
411 skiatest::Reporter* reporter) {
412 // Create a font with the typeface.
413 SkPaint paint;
414 paint.setColor(SK_ColorGRAY);
415 SkFont font(std::move(typeface), 30);
416
417 // Paint some text.
418 SkPictureRecorder recorder;
419 SkIRect canvasRect = SkIRect::MakeWH(kBitmapSize, kBitmapSize);
420 SkCanvas* canvas = recorder.beginRecording(SkIntToScalar(canvasRect.width()),
421 SkIntToScalar(canvasRect.height()));
422 canvas->drawColor(SK_ColorWHITE);
423 canvas->drawString(text, 24, 32, font, paint);
424 sk_sp<SkPicture> picture(recorder.finishRecordingAsPicture());
425
426 // Serlialize picture and create its clone from stream.
427 SkDynamicMemoryWStream stream;
428 picture->serialize(&stream, serial_procs);
429 std::unique_ptr<SkStream> inputStream(stream.detachAsStream());
430 sk_sp<SkPicture> loadedPicture(SkPicture::MakeFromStream(inputStream.get(), deserial_procs));
431
432 // Draw both original and clone picture and compare bitmaps -- they should be identical.
433 SkBitmap origBitmap = draw_picture(*picture);
434 SkBitmap destBitmap = draw_picture(*loadedPicture);
435 compare_bitmaps(reporter, origBitmap, destBitmap);
436 }
437
makeDistortableWithNonDefaultAxes(skiatest::Reporter * reporter)438 static sk_sp<SkTypeface> makeDistortableWithNonDefaultAxes(skiatest::Reporter* reporter) {
439 std::unique_ptr<SkStreamAsset> distortable(GetResourceAsStream("fonts/Distortable.ttf"));
440 if (!distortable) {
441 REPORT_FAILURE(reporter, "distortable", SkString());
442 return nullptr;
443 }
444
445 const SkFontArguments::VariationPosition::Coordinate position[] = {
446 { SkSetFourByteTag('w','g','h','t'), SK_ScalarSqrt2 },
447 };
448 SkFontArguments params;
449 params.setVariationDesignPosition({position, std::size(position)});
450
451 sk_sp<SkFontMgr> fm = ToolUtils::TestFontMgr();
452
453 sk_sp<SkTypeface> typeface = fm->makeFromStream(std::move(distortable), params);
454 if (!typeface) {
455 return nullptr; // Not all SkFontMgr can makeFromStream().
456 }
457
458 int count = typeface->getVariationDesignPosition(nullptr, 0);
459 if (count == -1) {
460 return nullptr; // The number of axes is unknown.
461 }
462
463 return typeface;
464 }
465
makeColrWithNonDefaultPalette(skiatest::Reporter * reporter)466 static sk_sp<SkTypeface> makeColrWithNonDefaultPalette(skiatest::Reporter* reporter) {
467 std::unique_ptr<SkStreamAsset> colr(GetResourceAsStream("fonts/colr.ttf"));
468 if (!colr) {
469 REPORT_FAILURE(reporter, "colr", SkString());
470 return nullptr;
471 }
472
473 const SkFontArguments::Palette::Override paletteOverride[] = {
474 { 1, SK_ColorGRAY },
475 };
476 SkFontArguments params;
477 params.setPalette({0, paletteOverride, std::size(paletteOverride)});
478
479 sk_sp<SkFontMgr> fm = ToolUtils::TestFontMgr();
480
481 sk_sp<SkTypeface> typeface = fm->makeFromStream(std::move(colr), params);
482 if (!typeface) {
483 return nullptr; // Not all SkFontMgr can makeFromStream().
484 }
485
486 return typeface;
487 }
488
TestPictureTypefaceSerialization(const SkSerialProcs * serial_procs,const SkDeserialProcs * deserial_procs,skiatest::Reporter * reporter)489 static void TestPictureTypefaceSerialization(const SkSerialProcs* serial_procs,
490 const SkDeserialProcs* deserial_procs,
491 skiatest::Reporter* reporter) {
492 {
493 // Load typeface from file to test CreateFromFile with index.
494 auto typeface = ToolUtils::CreateTypefaceFromResource("fonts/test.ttc", 1);
495 if (!typeface) {
496 INFOF(reporter, "Could not run test because test.ttc not found.");
497 } else {
498 serialize_and_compare_typeface(std::move(typeface), "A!", serial_procs, deserial_procs,
499 reporter);
500 }
501 }
502
503 {
504 // Load typeface as stream to create with axis settings.
505 auto typeface = makeDistortableWithNonDefaultAxes(reporter);
506 if (!typeface) {
507 INFOF(reporter, "Could not run test because Distortable.ttf not created.");
508 } else {
509 serialize_and_compare_typeface(std::move(typeface), "ab", serial_procs,
510 deserial_procs, reporter);
511 }
512 }
513
514 {
515 // Load typeface as stream to create with palette settings.
516 auto typeface = makeColrWithNonDefaultPalette(reporter);
517 if (!typeface) {
518 INFOF(reporter, "Could not run test because colr.ttf not created.");
519 } else {
520 serialize_and_compare_typeface(std::move(typeface), "��♢", serial_procs,
521 deserial_procs, reporter);
522 }
523 }
524 }
525
DumpTypeface(const SkTypeface & typeface)526 SkString DumpTypeface(const SkTypeface& typeface) {
527 int index;
528 std::unique_ptr<SkStreamAsset> typefaceStream = typeface.openStream(&index);
529 if (!typefaceStream) {
530 return SkString("No Stream");
531 }
532 size_t length = typefaceStream->getLength();
533
534 SkString s;
535 s.appendf("Index: %d\n", index);
536 s.appendf("Length: %zu\n", length);
537 return s;
538 }
DumpFontMetrics(const SkFontMetrics & metrics)539 SkString DumpFontMetrics(const SkFontMetrics& metrics) {
540 SkString m("Flags:\n");
541
542 if (metrics.fFlags == 0) {
543 m += " No flags\n";
544 } else {
545 if (metrics.fFlags & SkFontMetrics::kUnderlineThicknessIsValid_Flag) {
546 m += " UnderlineThicknessIsValid\n";
547 }
548 if (metrics.fFlags & SkFontMetrics::kUnderlinePositionIsValid_Flag) {
549 m += " kUnderlinePositionIsValid\n";
550 }
551 if (metrics.fFlags & SkFontMetrics::kStrikeoutThicknessIsValid_Flag) {
552 m += " kStrikeoutThicknessIsValid\n";
553 }
554 if (metrics.fFlags & SkFontMetrics::kStrikeoutPositionIsValid_Flag) {
555 m += " kStrikeoutPositionIsValid\n";
556 }
557 if (metrics.fFlags & SkFontMetrics::kBoundsInvalid_Flag) {
558 m += " kBoundsInvalid\n";
559 }
560 }
561
562 m.appendf("Top: %f\n", metrics.fTop);
563 m.appendf("Ascent: %f\n", metrics.fAscent);
564 m.appendf("Descent: %f\n", metrics.fDescent);
565 m.appendf("Bottom: %f\n", metrics.fBottom);
566 m.appendf("Leading: %f\n", metrics.fLeading);
567 m.appendf("AvgCharWidth: %f\n", metrics.fAvgCharWidth);
568 m.appendf("MaxCharWidth: %f\n", metrics.fMaxCharWidth);
569 m.appendf("XMin: %f\n", metrics.fXMin);
570 m.appendf("XMax: %f\n", metrics.fXMax);
571 m.appendf("XHeight: %f\n", metrics.fXHeight);
572 m.appendf("CapHeight: %f\n", metrics.fCapHeight);
573 m.appendf("UnderlineThickness: %f\n", metrics.fUnderlineThickness);
574 m.appendf("UnderlinePosition: %f\n", metrics.fUnderlinePosition);
575 m.appendf("StrikeoutThickness: %f\n", metrics.fStrikeoutThickness);
576 m.appendf("StrikeoutPosition: %f\n", metrics.fStrikeoutPosition);
577 return m;
578 }
TestTypefaceSerialization(skiatest::Reporter * reporter,const sk_sp<SkTypeface> & typeface)579 static void TestTypefaceSerialization(skiatest::Reporter* reporter,
580 const sk_sp<SkTypeface>& typeface) {
581 SkDynamicMemoryWStream typefaceWStream;
582 typeface->serialize(&typefaceWStream);
583
584 std::unique_ptr<SkStream> typefaceStream = typefaceWStream.detachAsStream();
585 sk_sp<SkTypeface> cloneTypeface =
586 SkTypeface::MakeDeserialize(typefaceStream.get(), ToolUtils::TestFontMgr());
587 SkASSERT(cloneTypeface);
588
589 SkString name, cloneName;
590 typeface->getFamilyName(&name);
591 cloneTypeface->getFamilyName(&cloneName);
592
593 REPORTER_ASSERT(reporter, typeface->countGlyphs() == cloneTypeface->countGlyphs(),
594 "Typeface: \"%s\" CloneTypeface: \"%s\"", name.c_str(), cloneName.c_str());
595 REPORTER_ASSERT(reporter, typeface->fontStyle() == cloneTypeface->fontStyle(),
596 "Typeface: \"%s\" CloneTypeface: \"%s\"", name.c_str(), cloneName.c_str());
597
598 SkFont font(typeface, 12);
599 SkFont clone(cloneTypeface, 12);
600 SkFontMetrics fontMetrics, cloneMetrics;
601 font.getMetrics(&fontMetrics);
602 clone.getMetrics(&cloneMetrics);
603 REPORTER_ASSERT(reporter, fontMetrics == cloneMetrics,
604 "Typeface: \"%s\"\n-Metrics---\n%s-Data---\n%s\n\n"
605 "CloneTypeface: \"%s\"\n-Metrics---\n%s-Data---\n%s",
606 name.c_str(),
607 DumpFontMetrics(fontMetrics).c_str(),
608 DumpTypeface(*typeface).c_str(),
609 cloneName.c_str(),
610 DumpFontMetrics(cloneMetrics).c_str(),
611 DumpTypeface(*cloneTypeface).c_str());
612 }
DEF_TEST(Serialization_Typeface,reporter)613 DEF_TEST(Serialization_Typeface, reporter) {
614 TestTypefaceSerialization(reporter, ToolUtils::DefaultTypeface());
615 TestTypefaceSerialization(reporter, ToolUtils::SampleUserTypeface());
616 }
617
setup_bitmap_for_canvas(SkBitmap * bitmap)618 static void setup_bitmap_for_canvas(SkBitmap* bitmap) {
619 bitmap->allocN32Pixels(kBitmapSize, kBitmapSize);
620 }
621
make_checkerboard_image()622 static sk_sp<SkImage> make_checkerboard_image() {
623 SkBitmap bitmap;
624 setup_bitmap_for_canvas(&bitmap);
625
626 SkCanvas canvas(bitmap);
627 canvas.clear(0x00000000);
628 SkPaint darkPaint;
629 darkPaint.setColor(0xFF804020);
630 SkPaint lightPaint;
631 lightPaint.setColor(0xFF244484);
632 const int i = kBitmapSize / 8;
633 const SkScalar f = SkIntToScalar(i);
634 for (int y = 0; y < kBitmapSize; y += i) {
635 for (int x = 0; x < kBitmapSize; x += i) {
636 canvas.save();
637 canvas.translate(SkIntToScalar(x), SkIntToScalar(y));
638 canvas.drawRect(SkRect::MakeXYWH(0, 0, f, f), darkPaint);
639 canvas.drawRect(SkRect::MakeXYWH(f, 0, f, f), lightPaint);
640 canvas.drawRect(SkRect::MakeXYWH(0, f, f, f), lightPaint);
641 canvas.drawRect(SkRect::MakeXYWH(f, f, f, f), darkPaint);
642 canvas.restore();
643 }
644 }
645 return bitmap.asImage();
646 }
647
draw_something(SkCanvas * canvas)648 static void draw_something(SkCanvas* canvas) {
649 canvas->save();
650 canvas->scale(0.5f, 0.5f);
651 canvas->drawImage(make_checkerboard_image(), 0, 0);
652 canvas->restore();
653
654 SkPaint paint;
655 paint.setAntiAlias(true);
656 paint.setColor(SK_ColorRED);
657 canvas->drawCircle(SkIntToScalar(kBitmapSize/2), SkIntToScalar(kBitmapSize/2), SkIntToScalar(kBitmapSize/3), paint);
658 paint.setColor(SK_ColorBLACK);
659
660 SkFont font = ToolUtils::DefaultFont();
661 font.setSize(kBitmapSize/3);
662 canvas->drawString("Picture", SkIntToScalar(kBitmapSize/2), SkIntToScalar(kBitmapSize/4), font, paint);
663 }
664
render(const SkPicture & p)665 static sk_sp<SkImage> render(const SkPicture& p) {
666 auto surf = SkSurfaces::Raster(SkImageInfo::MakeN32Premul(
667 SkScalarRoundToInt(p.cullRect().width()), SkScalarRoundToInt(p.cullRect().height())));
668 if (!surf) {
669 return nullptr; // bounds are empty?
670 }
671 surf->getCanvas()->clear(SK_ColorWHITE);
672 p.playback(surf->getCanvas());
673 return surf->makeImageSnapshot();
674 }
675
DEF_TEST(Serialization,reporter)676 DEF_TEST(Serialization, reporter) {
677 // Test matrix serialization
678 {
679 SkMatrix matrix = SkMatrix::I();
680 TestObjectSerialization(&matrix, reporter);
681 }
682
683 // Test point3 serialization
684 {
685 SkPoint3 point;
686 TestObjectSerializationNoAlign<SkPoint3, false>(&point, reporter);
687 }
688
689 // Test path serialization
690 {
691 SkPath path;
692 TestObjectSerialization(&path, reporter);
693 }
694
695 // Test region serialization
696 {
697 SkRegion region;
698 TestObjectSerialization(®ion, reporter);
699 }
700
701 // Test color filter serialization
702 {
703 TestColorFilterSerialization(reporter);
704 }
705
706 // Test string serialization
707 {
708 SkString string("string");
709 TestObjectSerializationNoAlign<SkString, false>(&string, reporter);
710 TestObjectSerializationNoAlign<SkString, true>(&string, reporter);
711 }
712
713 // Test rrect serialization
714 {
715 // SkRRect does not initialize anything.
716 // An uninitialized SkRRect can be serialized,
717 // but will branch on uninitialized data when deserialized.
718 SkRRect rrect;
719 SkRect rect = SkRect::MakeXYWH(1, 2, 20, 30);
720 SkVector corners[4] = { {1, 2}, {2, 3}, {3,4}, {4,5} };
721 rrect.setRectRadii(rect, corners);
722 SerializationTest::TestAlignment(&rrect, reporter);
723 }
724
725 // Test readByteArray
726 {
727 unsigned char data[kArraySize] = { 1, 2, 3 };
728 TestArraySerialization(data, reporter);
729 }
730
731 // Test readColorArray
732 {
733 SkColor data[kArraySize] = { SK_ColorBLACK, SK_ColorWHITE, SK_ColorRED };
734 TestArraySerialization(data, reporter);
735 }
736
737 // Test readColor4fArray
738 {
739 SkColor4f data[kArraySize] = {
740 SkColor4f::FromColor(SK_ColorBLACK),
741 SkColor4f::FromColor(SK_ColorWHITE),
742 SkColor4f::FromColor(SK_ColorRED),
743 { 1.f, 2.f, 4.f, 8.f }
744 };
745 TestArraySerialization(data, reporter);
746 }
747
748 // Test readIntArray
749 {
750 int32_t data[kArraySize] = { 1, 2, 4, 8 };
751 TestArraySerialization(data, reporter);
752 }
753
754 // Test readPointArray
755 {
756 SkPoint data[kArraySize] = { {6, 7}, {42, 128} };
757 TestArraySerialization(data, reporter);
758 }
759
760 // Test readScalarArray
761 {
762 SkScalar data[kArraySize] = { SK_Scalar1, SK_ScalarHalf, SK_ScalarMax };
763 TestArraySerialization(data, reporter);
764 }
765
766 // Test skipByteArray
767 {
768 // Valid case with non-empty array:
769 {
770 unsigned char data[kArraySize] = { 1, 2, 3 };
771 SkBinaryWriteBuffer writer({});
772 writer.writeByteArray(data, kArraySize);
773 SkAutoMalloc buf(writer.bytesWritten());
774 writer.writeToMemory(buf.get());
775
776 SkReadBuffer reader(buf.get(), writer.bytesWritten());
777 size_t len = ~0;
778 const void* arr = reader.skipByteArray(&len);
779 REPORTER_ASSERT(reporter, arr);
780 REPORTER_ASSERT(reporter, len == kArraySize);
781 REPORTER_ASSERT(reporter, memcmp(arr, data, len) == 0);
782 }
783
784 // Writing a zero length array (can be detected as valid by non-nullptr return):
785 {
786 SkBinaryWriteBuffer writer({});
787 writer.writeByteArray(nullptr, 0);
788 SkAutoMalloc buf(writer.bytesWritten());
789 writer.writeToMemory(buf.get());
790
791 SkReadBuffer reader(buf.get(), writer.bytesWritten());
792 size_t len = ~0;
793 const void* arr = reader.skipByteArray(&len);
794 REPORTER_ASSERT(reporter, arr);
795 REPORTER_ASSERT(reporter, len == 0);
796 }
797
798 // If the array can't be safely read, should return nullptr:
799 {
800 SkBinaryWriteBuffer writer({});
801 writer.writeUInt(kArraySize);
802 SkAutoMalloc buf(writer.bytesWritten());
803 writer.writeToMemory(buf.get());
804
805 SkReadBuffer reader(buf.get(), writer.bytesWritten());
806 size_t len = ~0;
807 const void* arr = reader.skipByteArray(&len);
808 REPORTER_ASSERT(reporter, !arr);
809 REPORTER_ASSERT(reporter, len == 0);
810 }
811 }
812
813 // Test invalid deserializations
814 {
815 SkImageInfo info = SkImageInfo::MakeN32Premul(kBitmapSize, kBitmapSize);
816
817 SkBitmap validBitmap;
818 validBitmap.setInfo(info);
819
820 // Create a bitmap with a really large height
821 SkBitmap invalidBitmap;
822 invalidBitmap.setInfo(info.makeWH(info.width(), 1000000000));
823
824 // The deserialization should succeed, and the rendering shouldn't crash,
825 // even when the device fails to initialize, due to its size
826 TestBitmapSerialization(validBitmap, invalidBitmap, true, reporter);
827 }
828
829 // Test simple SkPicture serialization
830 {
831 skiatest::ReporterContext subtest(reporter, "simple SkPicture");
832 SkPictureRecorder recorder;
833 draw_something(recorder.beginRecording(SkIntToScalar(kBitmapSize),
834 SkIntToScalar(kBitmapSize)));
835 sk_sp<SkPicture> pict(recorder.finishRecordingAsPicture());
836
837 // Serialize picture. The default typeface proc should result in a non-empty
838 // typeface when deserializing.
839 SkSerialProcs sProcs;
840 sProcs.fImageProc = [](SkImage* img, void*) -> sk_sp<SkData> {
841 return SkPngEncoder::Encode(nullptr, img, SkPngEncoder::Options{});
842 };
843 sk_sp<SkData> data = pict->serialize(&sProcs);
844 REPORTER_ASSERT(reporter, data);
845
846 // Deserialize picture using the default procs.
847 // TODO(kjlubick) Specify a proc for decoding image data.
848 sk_sp<SkPicture> readPict = SkPicture::MakeFromData(data.get());
849 REPORTER_ASSERT(reporter, readPict);
850 sk_sp<SkImage> img0 = render(*pict);
851 sk_sp<SkImage> img1 = render(*readPict);
852 if (img0 && img1) {
853 bool ok = ToolUtils::equal_pixels(img0.get(), img1.get());
854 REPORTER_ASSERT(reporter, ok, "before and after image did not match");
855 if (!ok) {
856 auto left = SkFILEWStream("before_serialize.png");
857 sk_sp<SkData> d = SkPngEncoder::Encode(nullptr, img0.get(), {});
858 left.write(d->data(), d->size());
859 left.fsync();
860 auto right = SkFILEWStream("after_serialize.png");
861 d = SkPngEncoder::Encode(nullptr, img1.get(), {});
862 right.write(d->data(), d->size());
863 right.fsync();
864 }
865 }
866 }
867
868 TestPictureTypefaceSerialization(nullptr, nullptr, reporter);
869
870 SkSerialProcs serial_procs;
871 serial_procs.fTypefaceProc = serialize_typeface_proc;
872 SkDeserialProcs deserial_procs;
873 deserial_procs.fTypefaceProc = deserialize_typeface_proc;
874 TestPictureTypefaceSerialization(&serial_procs, &deserial_procs, reporter);
875 }
876
877 ///////////////////////////////////////////////////////////////////////////////////////////////////
878
copy_picture_via_serialization(SkPicture * src)879 static sk_sp<SkPicture> copy_picture_via_serialization(SkPicture* src) {
880 SkDynamicMemoryWStream wstream;
881 src->serialize(&wstream, nullptr); // default is fine, no SkImages to encode
882 std::unique_ptr<SkStreamAsset> rstream(wstream.detachAsStream());
883 return SkPicture::MakeFromStream(rstream.get());
884 }
885
886 struct AnnotationRec {
887 const SkRect fRect;
888 const char* fKey;
889 sk_sp<SkData> fValue;
890 };
891
892 class TestAnnotationCanvas : public SkCanvas {
893 skiatest::Reporter* fReporter;
894 const AnnotationRec* fRec;
895 int fCount;
896 int fCurrIndex;
897
898 public:
TestAnnotationCanvas(skiatest::Reporter * reporter,const AnnotationRec rec[],int count)899 TestAnnotationCanvas(skiatest::Reporter* reporter, const AnnotationRec rec[], int count)
900 : SkCanvas(100, 100)
901 , fReporter(reporter)
902 , fRec(rec)
903 , fCount(count)
904 , fCurrIndex(0)
905 {}
906
~TestAnnotationCanvas()907 ~TestAnnotationCanvas() override {
908 REPORTER_ASSERT(fReporter, fCount == fCurrIndex);
909 }
910
911 protected:
onDrawAnnotation(const SkRect & rect,const char key[],SkData * value)912 void onDrawAnnotation(const SkRect& rect, const char key[], SkData* value) override {
913 REPORTER_ASSERT(fReporter, fCurrIndex < fCount);
914 REPORTER_ASSERT(fReporter, rect == fRec[fCurrIndex].fRect);
915 REPORTER_ASSERT(fReporter, !strcmp(key, fRec[fCurrIndex].fKey));
916 REPORTER_ASSERT(fReporter, value->equals(fRec[fCurrIndex].fValue.get()));
917 fCurrIndex += 1;
918 }
919 };
920
921 /*
922 * Test the 3 annotation types by recording them into a picture, serializing, and then playing
923 * them back into another canvas.
924 */
DEF_TEST(Annotations,reporter)925 DEF_TEST(Annotations, reporter) {
926 SkPictureRecorder recorder;
927 SkCanvas* recordingCanvas = recorder.beginRecording(SkRect::MakeWH(100, 100));
928
929 const char* str0 = "rect-with-url";
930 const SkRect r0 = SkRect::MakeWH(10, 10);
931 sk_sp<SkData> d0(SkData::MakeWithCString(str0));
932 SkAnnotateRectWithURL(recordingCanvas, r0, d0.get());
933
934 const char* str1 = "named-destination";
935 const SkRect r1 = SkRect::MakeXYWH(5, 5, 0, 0); // collapsed to a point
936 sk_sp<SkData> d1(SkData::MakeWithCString(str1));
937 SkAnnotateNamedDestination(recordingCanvas, {r1.x(), r1.y()}, d1.get());
938
939 const char* str2 = "link-to-destination";
940 const SkRect r2 = SkRect::MakeXYWH(20, 20, 5, 6);
941 sk_sp<SkData> d2(SkData::MakeWithCString(str2));
942 SkAnnotateLinkToDestination(recordingCanvas, r2, d2.get());
943
944 const AnnotationRec recs[] = {
945 { r0, SkAnnotationKeys::URL_Key(), std::move(d0) },
946 { r1, SkAnnotationKeys::Define_Named_Dest_Key(), std::move(d1) },
947 { r2, SkAnnotationKeys::Link_Named_Dest_Key(), std::move(d2) },
948 };
949
950 sk_sp<SkPicture> pict0(recorder.finishRecordingAsPicture());
951 sk_sp<SkPicture> pict1(copy_picture_via_serialization(pict0.get()));
952
953 TestAnnotationCanvas canvas(reporter, recs, std::size(recs));
954 canvas.drawPicture(pict1);
955 }
956
DEF_TEST(WriteBuffer_storage,reporter)957 DEF_TEST(WriteBuffer_storage, reporter) {
958 enum {
959 kSize = 32
960 };
961 int32_t storage[kSize/4];
962 char src[kSize];
963 sk_bzero(src, kSize);
964
965 SkBinaryWriteBuffer writer(storage, kSize, {});
966 REPORTER_ASSERT(reporter, writer.usingInitialStorage());
967 REPORTER_ASSERT(reporter, writer.bytesWritten() == 0);
968 writer.write(src, kSize - 4);
969 REPORTER_ASSERT(reporter, writer.usingInitialStorage());
970 REPORTER_ASSERT(reporter, writer.bytesWritten() == kSize - 4);
971 writer.writeInt(0);
972 REPORTER_ASSERT(reporter, writer.usingInitialStorage());
973 REPORTER_ASSERT(reporter, writer.bytesWritten() == kSize);
974
975 writer.reset(storage, kSize-4);
976 REPORTER_ASSERT(reporter, writer.usingInitialStorage());
977 REPORTER_ASSERT(reporter, writer.bytesWritten() == 0);
978 writer.write(src, kSize - 4);
979 REPORTER_ASSERT(reporter, writer.usingInitialStorage());
980 REPORTER_ASSERT(reporter, writer.bytesWritten() == kSize - 4);
981 writer.writeInt(0);
982 REPORTER_ASSERT(reporter, !writer.usingInitialStorage()); // this is the change
983 REPORTER_ASSERT(reporter, writer.bytesWritten() == kSize);
984 }
985
DEF_TEST(WriteBuffer_external_memory_textblob,reporter)986 DEF_TEST(WriteBuffer_external_memory_textblob, reporter) {
987 SkFont font = ToolUtils::DefaultFont();
988
989 SkTextBlobBuilder builder;
990 int glyph_count = 5;
991 const auto& run = builder.allocRun(font, glyph_count, 1.2f, 2.3f);
992 // allocRun() allocates only the glyph buffer.
993 std::fill(run.glyphs, run.glyphs + glyph_count, 0);
994 auto blob = builder.make();
995 SkSerialProcs procs;
996 AutoTMalloc<uint8_t> storage;
997 size_t blob_size = 0u;
998 size_t storage_size = 0u;
999
1000 blob_size = SkAlign4(blob->serialize(procs)->size());
1001 REPORTER_ASSERT(reporter, blob_size > 4u);
1002 storage_size = blob_size - 4;
1003 storage.realloc(storage_size);
1004 REPORTER_ASSERT(reporter, blob->serialize(procs, storage.get(), storage_size) == 0u);
1005 storage_size = blob_size;
1006 storage.realloc(storage_size);
1007 REPORTER_ASSERT(reporter, blob->serialize(procs, storage.get(), storage_size) != 0u);
1008 }
1009
DEF_TEST(WriteBuffer_external_memory_flattenable,reporter)1010 DEF_TEST(WriteBuffer_external_memory_flattenable, reporter) {
1011 SkScalar intervals[] = {1.f, 1.f};
1012 auto path_effect = SkDashPathEffect::Make(intervals, 2, 0);
1013 size_t path_size = SkAlign4(path_effect->serialize()->size());
1014 REPORTER_ASSERT(reporter, path_size > 4u);
1015 AutoTMalloc<uint8_t> storage;
1016
1017 size_t storage_size = path_size - 4;
1018 storage.realloc(storage_size);
1019 REPORTER_ASSERT(reporter, path_effect->serialize(storage.get(), storage_size) == 0u);
1020
1021 storage_size = path_size;
1022 storage.realloc(storage_size);
1023 REPORTER_ASSERT(reporter, path_effect->serialize(storage.get(), storage_size) != 0u);
1024 }
1025
DEF_TEST(ReadBuffer_empty,reporter)1026 DEF_TEST(ReadBuffer_empty, reporter) {
1027 SkBinaryWriteBuffer writer({});
1028 writer.writeInt(123);
1029 writer.writeDataAsByteArray(SkData::MakeEmpty().get());
1030 writer.writeInt(321);
1031
1032 size_t size = writer.bytesWritten();
1033 SkAutoMalloc storage(size);
1034 writer.writeToMemory(storage.get());
1035
1036 SkReadBuffer reader(storage.get(), size);
1037 REPORTER_ASSERT(reporter, reader.readInt() == 123);
1038 auto data = reader.readByteArrayAsData();
1039 REPORTER_ASSERT(reporter, data->size() == 0);
1040 REPORTER_ASSERT(reporter, reader.readInt() == 321);
1041 }
1042