blob: 674cab9dc0fe8cc2f3e0a25edc1f9ba7d717d74b [file] [log] [blame]
epoger@google.comec3ed6a2011-07-28 14:26:00 +00001/*
2 * Copyright 2011 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 */
bsalomon@google.com971d0c82011-08-19 17:22:05 +00007
epoger@google.com57f7abc2012-11-13 03:41:55 +00008/*
9 * Code for the "gm" (Golden Master) rendering comparison tool.
10 *
11 * If you make changes to this, re-run the self-tests at gm/tests/run.sh
12 * to make sure they still pass... you may need to change the expected
13 * results of the self-test.
14 */
15
bungeman@google.comb29c8832011-10-10 13:19:10 +000016#include "gm.h"
epoger@google.com6f6568b2013-03-22 17:29:46 +000017#include "gm_error.h"
epoger@google.com37269602013-01-19 04:21:27 +000018#include "gm_expectations.h"
epoger@google.com7bc13a62012-02-14 14:53:59 +000019#include "system_preferences.h"
mtklein30e6e2a2014-06-18 11:44:15 -070020#include "CrashHandler.h"
mtkleinafb43792014-08-19 15:55:55 -070021#include "ProcStats.h"
tfarinabcbc1782014-06-18 14:32:48 -070022#include "Resources.h"
23#include "SamplePipeControllers.h"
epoger@google.com5f6a0072013-01-31 16:30:55 +000024#include "SkBitmap.h"
reed@android.comb9b9a182009-07-08 02:54:47 +000025#include "SkColorPriv.h"
scroggo@google.comd9ba9a02013-03-21 19:43:15 +000026#include "SkCommandLineFlags.h"
reed@google.com8a85d0c2011-06-24 19:12:12 +000027#include "SkData.h"
junov@google.com4370aed2012-01-18 16:21:08 +000028#include "SkDeferredCanvas.h"
bsalomon@google.com971d0c82011-08-19 17:22:05 +000029#include "SkDevice.h"
commit-bot@chromium.org5e009892013-10-14 13:42:12 +000030#include "SkDocument.h"
epoger@google.comde961632012-10-26 18:56:36 +000031#include "SkDrawFilter.h"
commit-bot@chromium.orgc41295d2013-06-18 20:06:36 +000032#include "SkForceLinking.h"
scroggo@google.com5af9b202012-06-04 17:17:36 +000033#include "SkGPipe.h"
reed@android.com8015dd82009-06-21 00:49:18 +000034#include "SkGraphics.h"
35#include "SkImageDecoder.h"
36#include "SkImageEncoder.h"
commit-bot@chromium.orge3bb3bc2013-12-03 18:16:48 +000037#include "SkJSONCPP.h"
epoger@google.come8ebeb12012-10-29 16:42:11 +000038#include "SkOSFile.h"
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +000039#include "SkPDFRasterizer.h"
tomhudson@google.com9875dd12011-04-25 15:49:53 +000040#include "SkPicture.h"
robertphillips@google.com770963f2014-04-18 18:04:41 +000041#include "SkPictureRecorder.h"
robertphillips@google.com977b9c82012-06-05 19:35:09 +000042#include "SkRefCnt.h"
commit-bot@chromium.org5e009892013-10-14 13:42:12 +000043#include "SkScalar.h"
scroggo@google.com72c96722012-06-06 21:07:10 +000044#include "SkStream.h"
epoger@google.comf711f322013-10-18 14:55:47 +000045#include "SkString.h"
reed@google.com11db6fa2014-02-04 15:30:57 +000046#include "SkSurface.h"
bsalomon@google.com2a48c3a2012-08-03 14:54:45 +000047#include "SkTArray.h"
epoger@google.com310478e2013-04-03 18:00:39 +000048#include "SkTDict.h"
reed@google.com07700442010-12-20 19:46:07 +000049
commit-bot@chromium.org515dcd32013-08-28 14:17:03 +000050#ifdef SK_DEBUG
51static const bool kDebugOnly = true;
commit-bot@chromium.org8065ec52014-03-11 15:57:40 +000052#define GR_DUMP_FONT_CACHE 0
commit-bot@chromium.org515dcd32013-08-28 14:17:03 +000053#else
54static const bool kDebugOnly = false;
55#endif
56
epoger@google.comed5eb4e2013-07-23 17:56:20 +000057__SK_FORCE_IMAGE_DECODER_LINKING;
58
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000059#if SK_SUPPORT_GPU
60#include "GrContextFactory.h"
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000061#include "SkGpuDevice.h"
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000062typedef GrContextFactory::GLContextType GLContextType;
epoger@google.com6f6568b2013-03-22 17:29:46 +000063#define DEFAULT_CACHE_VALUE -1
64static int gGpuCacheSizeBytes;
65static int gGpuCacheSizeCount;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000066#else
epoger@google.com80724df2013-03-21 13:49:54 +000067class GrContextFactory;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000068class GrContext;
bsalomon@google.com123ac1d2013-03-28 19:18:12 +000069class GrSurface;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000070typedef int GLContextType;
kkinnunen80549fc2014-06-30 06:36:31 -070071typedef int GrGLStandard;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000072#endif
73
epoger@google.com76c913d2013-04-26 15:06:44 +000074#define DEBUGFAIL_SEE_STDERR SkDEBUGFAIL("see stderr for message")
75
commit-bot@chromium.org5e009892013-10-14 13:42:12 +000076DECLARE_bool(useDocumentInsteadOfDevice);
reed@google.com8923c6c2011-11-08 14:59:38 +000077
reed@google.com07700442010-12-20 19:46:07 +000078#ifdef SK_SUPPORT_PDF
tomhudson@google.com9875dd12011-04-25 15:49:53 +000079 #include "SkPDFDevice.h"
80 #include "SkPDFDocument.h"
reed@google.com07700442010-12-20 19:46:07 +000081#endif
reed@android.com00dae862009-06-10 15:38:48 +000082
epoger@google.come3cc2eb2012-01-18 20:11:13 +000083// Until we resolve http://code.google.com/p/skia/issues/detail?id=455 ,
84// stop writing out XPS-format image baselines in gm.
85#undef SK_SUPPORT_XPS
bungeman@google.comb29c8832011-10-10 13:19:10 +000086#ifdef SK_SUPPORT_XPS
87 #include "SkXPSDevice.h"
88#endif
89
reed@google.com46cce912011-06-29 12:54:46 +000090#ifdef SK_BUILD_FOR_MAC
91 #include "SkCGUtils.h"
reed@google.com46cce912011-06-29 12:54:46 +000092#endif
93
reed@android.com00dae862009-06-10 15:38:48 +000094using namespace skiagm;
95
reed@android.com00dae862009-06-10 15:38:48 +000096class Iter {
97public:
98 Iter() {
bsalomon@google.com39149582011-06-13 21:55:32 +000099 this->reset();
100 }
101
102 void reset() {
reed@android.comdd0ac282009-06-20 02:38:16 +0000103 fReg = GMRegistry::Head();
reed@android.com00dae862009-06-10 15:38:48 +0000104 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000105
reed@android.comdd0ac282009-06-20 02:38:16 +0000106 GM* next() {
reed@android.com00dae862009-06-10 15:38:48 +0000107 if (fReg) {
reed@android.comdd0ac282009-06-20 02:38:16 +0000108 GMRegistry::Factory fact = fReg->factory();
reed@android.com00dae862009-06-10 15:38:48 +0000109 fReg = fReg->next();
reed@android.comdd0ac282009-06-20 02:38:16 +0000110 return fact(0);
reed@android.com00dae862009-06-10 15:38:48 +0000111 }
112 return NULL;
113 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000114
reed@android.com00dae862009-06-10 15:38:48 +0000115 static int Count() {
reed@android.comdd0ac282009-06-20 02:38:16 +0000116 const GMRegistry* reg = GMRegistry::Head();
reed@android.com00dae862009-06-10 15:38:48 +0000117 int count = 0;
118 while (reg) {
119 count += 1;
120 reg = reg->next();
121 }
122 return count;
123 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000124
reed@android.com00dae862009-06-10 15:38:48 +0000125private:
126 const GMRegistry* fReg;
127};
128
epoger@google.comce057fe2013-05-14 15:17:46 +0000129// TODO(epoger): Right now, various places in this code assume that all the
130// image files read/written by GM use this file extension.
131// Search for references to this constant to find these assumptions.
132const static char kPNG_FileExtension[] = "png";
133
vandebo@chromium.org686abdf2011-02-03 23:00:40 +0000134enum Backend {
junov@chromium.org3cb834b2012-12-13 16:39:53 +0000135 kRaster_Backend,
136 kGPU_Backend,
137 kPDF_Backend,
138 kXPS_Backend,
139};
140
141enum BbhType {
142 kNone_BbhType,
143 kRTree_BbhType,
144 kTileGrid_BbhType,
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +0000145 kQuadTree_BbhType
vandebo@chromium.org686abdf2011-02-03 23:00:40 +0000146};
147
bsalomon@google.com7361f542012-04-19 19:15:35 +0000148enum ConfigFlags {
149 kNone_ConfigFlag = 0x0,
150 /* Write GM images if a write path is provided. */
151 kWrite_ConfigFlag = 0x1,
epoger@google.comf28dd8a2012-10-25 16:27:34 +0000152 /* Read reference GM images if a read path is provided. */
bsalomon@google.com7361f542012-04-19 19:15:35 +0000153 kRead_ConfigFlag = 0x2,
154 kRW_ConfigFlag = (kWrite_ConfigFlag | kRead_ConfigFlag),
155};
156
tomhudson@google.com9875dd12011-04-25 15:49:53 +0000157struct ConfigData {
reedddd014e2014-06-05 08:51:20 -0700158 SkColorType fColorType;
bsalomon@google.com7361f542012-04-19 19:15:35 +0000159 Backend fBackend;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +0000160 GLContextType fGLContextType; // GPU backend only
bsalomon@google.com7361f542012-04-19 19:15:35 +0000161 int fSampleCnt; // GPU backend only
162 ConfigFlags fFlags;
163 const char* fName;
bsalomon@google.com4c75f242013-03-19 18:58:43 +0000164 bool fRunByDefault;
tomhudson@google.com9875dd12011-04-25 15:49:53 +0000165};
166
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000167struct PDFRasterizerData {
168 bool (*fRasterizerFunction)(SkStream*, SkBitmap*);
169 const char* fName;
170 bool fRunByDefault;
171};
172
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000173class BWTextDrawFilter : public SkDrawFilter {
174public:
reed@google.com971aca72012-11-26 20:26:54 +0000175 virtual bool filter(SkPaint*, Type) SK_OVERRIDE;
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000176};
reed@google.com971aca72012-11-26 20:26:54 +0000177bool BWTextDrawFilter::filter(SkPaint* p, Type t) {
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000178 if (kText_Type == t) {
179 p->setAntiAlias(false);
180 }
reed@google.com971aca72012-11-26 20:26:54 +0000181 return true;
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000182}
183
scroggo@google.com565254b2012-06-28 15:41:32 +0000184struct PipeFlagComboData {
185 const char* name;
186 uint32_t flags;
187};
188
189static PipeFlagComboData gPipeWritingFlagCombos[] = {
190 { "", 0 },
191 { " cross-process", SkGPipeWriter::kCrossProcess_Flag },
scroggob3c0f482012-07-02 19:07:57 +0000192 { " cross-process, shared address", SkGPipeWriter::kCrossProcess_Flag
scroggo@google.com15011ee2012-07-26 20:03:32 +0000193 | SkGPipeWriter::kSharedAddressSpace_Flag }
scroggo@google.com565254b2012-06-28 15:41:32 +0000194};
195
commit-bot@chromium.org608ea652013-10-03 19:29:21 +0000196static SkData* encode_to_dct_data(size_t* pixelRefOffset, const SkBitmap& bitmap);
edisonn@google.com73a7ea32013-11-11 20:55:15 +0000197DECLARE_int32(pdfRasterDpi);
edisonn@google.comd9dfa182013-04-24 13:01:01 +0000198
epoger@google.com5079d2c2013-04-12 14:11:21 +0000199const static ErrorCombination kDefaultIgnorableErrorTypes = ErrorCombination()
200 .plus(kMissingExpectations_ErrorType)
201 .plus(kIntentionallySkipped_ErrorType);
202
epoger@google.comde961632012-10-26 18:56:36 +0000203class GMMain {
204public:
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000205 GMMain() : fUseFileHierarchy(false), fWriteChecksumBasedFilenames(false),
206 fIgnorableErrorTypes(kDefaultIgnorableErrorTypes),
epoger@google.com5f995452013-06-21 18:16:47 +0000207 fMismatchPath(NULL), fMissingExpectationsPath(NULL), fTestsRun(0),
208 fRenderModesEncountered(1) {}
epoger@google.come8ebeb12012-10-29 16:42:11 +0000209
epoger@google.com659c8c02013-05-21 15:45:45 +0000210 /**
211 * Assemble shortNamePlusConfig from (surprise!) shortName and configName.
212 *
213 * The method for doing so depends on whether we are using hierarchical naming.
214 * For example, shortName "selftest1" and configName "8888" could be assembled into
215 * either "selftest1_8888" or "8888/selftest1".
216 */
217 SkString make_shortname_plus_config(const char *shortName, const char *configName) {
epoger@google.come8ebeb12012-10-29 16:42:11 +0000218 SkString name;
epoger@google.com57f7abc2012-11-13 03:41:55 +0000219 if (0 == strlen(configName)) {
220 name.append(shortName);
221 } else if (fUseFileHierarchy) {
epoger@google.come8ebeb12012-10-29 16:42:11 +0000222 name.appendf("%s%c%s", configName, SkPATH_SEPARATOR, shortName);
223 } else {
224 name.appendf("%s_%s", shortName, configName);
225 }
epoger@google.comde961632012-10-26 18:56:36 +0000226 return name;
227 }
228
epoger@google.com659c8c02013-05-21 15:45:45 +0000229 /**
230 * Assemble filename, suitable for writing out the results of a particular test.
231 */
232 SkString make_filename(const char *path,
233 const char *shortName,
234 const char *configName,
235 const char *renderModeDescriptor,
236 const char *suffix) {
237 SkString filename = make_shortname_plus_config(shortName, configName);
238 filename.append(renderModeDescriptor);
239 filename.appendUnichar('.');
240 filename.append(suffix);
tfarinaa8e2e152014-07-28 19:26:58 -0700241 return SkOSPath::Join(path, filename.c_str());
epoger@google.com659c8c02013-05-21 15:45:45 +0000242 }
243
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000244 /**
245 * Assemble filename suitable for writing out an SkBitmap.
246 */
247 SkString make_bitmap_filename(const char *path,
248 const char *shortName,
249 const char *configName,
250 const char *renderModeDescriptor,
251 const GmResultDigest &bitmapDigest) {
252 if (fWriteChecksumBasedFilenames) {
253 SkString filename;
254 filename.append(bitmapDigest.getHashType());
255 filename.appendUnichar('_');
256 filename.append(shortName);
257 filename.appendUnichar('_');
258 filename.append(bitmapDigest.getDigestValue());
259 filename.appendUnichar('.');
260 filename.append(kPNG_FileExtension);
tfarinaa8e2e152014-07-28 19:26:58 -0700261 return SkOSPath::Join(path, filename.c_str());
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000262 } else {
263 return make_filename(path, shortName, configName, renderModeDescriptor,
264 kPNG_FileExtension);
265 }
266 }
267
epoger@google.com5f6a0072013-01-31 16:30:55 +0000268 /* since PNG insists on unpremultiplying our alpha, we take no
269 precision chances and force all pixels to be 100% opaque,
270 otherwise on compare we may not get a perfect match.
271 */
272 static void force_all_opaque(const SkBitmap& bitmap) {
commit-bot@chromium.orgdac52252014-02-17 21:21:46 +0000273 SkColorType colorType = bitmap.colorType();
274 switch (colorType) {
commit-bot@chromium.org28fcae22014-04-11 17:15:40 +0000275 case kN32_SkColorType:
epoger@google.com5f6a0072013-01-31 16:30:55 +0000276 force_all_opaque_8888(bitmap);
277 break;
commit-bot@chromium.orgdac52252014-02-17 21:21:46 +0000278 case kRGB_565_SkColorType:
epoger@google.com5f6a0072013-01-31 16:30:55 +0000279 // nothing to do here; 565 bitmaps are inherently opaque
280 break;
281 default:
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000282 SkDebugf("unsupported bitmap colorType %d\n", colorType);
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000283 DEBUGFAIL_SEE_STDERR;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000284 }
285 }
286
287 static void force_all_opaque_8888(const SkBitmap& bitmap) {
288 SkAutoLockPixels lock(bitmap);
289 for (int y = 0; y < bitmap.height(); y++) {
290 for (int x = 0; x < bitmap.width(); x++) {
291 *bitmap.getAddr32(x, y) |= (SK_A32_MASK << SK_A32_SHIFT);
292 }
293 }
294 }
295
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000296 static ErrorCombination write_bitmap(const SkString& path, const SkBitmap& bitmap) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000297 // TODO(epoger): Now that we have removed force_all_opaque()
298 // from this method, we should be able to get rid of the
299 // transformation to 8888 format also.
300 SkBitmap copy;
commit-bot@chromium.org28fcae22014-04-11 17:15:40 +0000301 bitmap.copyTo(&copy, kN32_SkColorType);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000302 if (!SkImageEncoder::EncodeFile(path.c_str(), copy,
303 SkImageEncoder::kPNG_Type,
304 100)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000305 SkDebugf("FAILED to write bitmap: %s\n", path.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000306 return ErrorCombination(kWritingReferenceImage_ErrorType);
307 }
308 return kEmpty_ErrorCombination;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000309 }
310
epoger@google.com6f6568b2013-03-22 17:29:46 +0000311 /**
epoger@google.com310478e2013-04-03 18:00:39 +0000312 * Add all render modes encountered thus far to the "modes" array.
epoger@google.com6f6568b2013-03-22 17:29:46 +0000313 */
epoger@google.com310478e2013-04-03 18:00:39 +0000314 void GetRenderModesEncountered(SkTArray<SkString> &modes) {
315 SkTDict<int>::Iter iter(this->fRenderModesEncountered);
316 const char* mode;
317 while ((mode = iter.next(NULL)) != NULL) {
318 SkString modeAsString = SkString(mode);
319 // TODO(epoger): It seems a bit silly that all of these modes were
320 // recorded with a leading "-" which we have to remove here
321 // (except for mode "", which means plain old original mode).
322 // But that's how renderModeDescriptor has been passed into
323 // compare_test_results_to_reference_bitmap() historically,
324 // and changing that now may affect other parts of our code.
325 if (modeAsString.startsWith("-")) {
326 modeAsString.remove(0, 1);
epoger@google.com310478e2013-04-03 18:00:39 +0000327 }
commit-bot@chromium.org85195482014-01-13 18:27:59 +0000328 modes.push_back(modeAsString);
epoger@google.com310478e2013-04-03 18:00:39 +0000329 }
330 }
331
332 /**
epoger@google.com3a882dd2013-10-07 18:55:09 +0000333 * Returns true if failures on this test should be ignored.
334 */
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +0000335 bool ShouldIgnoreTest(const char *name) const {
336 for (int i = 0; i < fIgnorableTestNames.count(); i++) {
337 if (fIgnorableTestNames[i].equals(name)) {
epoger@google.com3a882dd2013-10-07 18:55:09 +0000338 return true;
339 }
340 }
341 return false;
342 }
343
344 /**
commit-bot@chromium.org85195482014-01-13 18:27:59 +0000345 * Calls RecordTestResults to record that we skipped a test.
346 *
347 * Depending on the backend, this may mean that we skipped a single rendermode, or all
348 * rendermodes; see http://skbug.com/1994 and https://codereview.chromium.org/129203002/
349 */
350 void RecordSkippedTest(const SkString& shortNamePlusConfig,
351 const char renderModeDescriptor [], Backend backend) {
352 if (kRaster_Backend == backend) {
353 // Skipping a test on kRaster_Backend means that we will skip ALL renderModes
354 // (as opposed to other backends, on which we only run the default renderMode).
355 //
356 // We cannot call RecordTestResults yet, because we won't know the full set of
357 // renderModes until we have run all tests.
358 fTestsSkippedOnAllRenderModes.push_back(shortNamePlusConfig);
359 } else {
360 this->RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
361 renderModeDescriptor);
362 }
363 }
364
365 /**
epoger@google.com310478e2013-04-03 18:00:39 +0000366 * Records the results of this test in fTestsRun and fFailedTests.
367 *
368 * We even record successes, and errors that we regard as
369 * "ignorable"; we can filter them out later.
370 */
epoger@google.com659c8c02013-05-21 15:45:45 +0000371 void RecordTestResults(const ErrorCombination& errorCombination,
372 const SkString& shortNamePlusConfig,
epoger@google.com310478e2013-04-03 18:00:39 +0000373 const char renderModeDescriptor []) {
374 // Things to do regardless of errorCombination.
375 fTestsRun++;
376 int renderModeCount = 0;
377 this->fRenderModesEncountered.find(renderModeDescriptor, &renderModeCount);
378 renderModeCount++;
379 this->fRenderModesEncountered.set(renderModeDescriptor, renderModeCount);
380
epoger@google.com6f6568b2013-03-22 17:29:46 +0000381 if (errorCombination.isEmpty()) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000382 return;
epoger@google.comeb066362013-03-08 09:39:36 +0000383 }
384
epoger@google.com310478e2013-04-03 18:00:39 +0000385 // Things to do only if there is some error condition.
epoger@google.com659c8c02013-05-21 15:45:45 +0000386 SkString fullName = shortNamePlusConfig;
epoger@google.comcaac3db2013-04-04 19:23:11 +0000387 fullName.append(renderModeDescriptor);
epoger@google.com310478e2013-04-03 18:00:39 +0000388 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
389 ErrorType type = static_cast<ErrorType>(typeInt);
390 if (errorCombination.includes(type)) {
391 fFailedTests[type].push_back(fullName);
epoger@google.comf60494b2013-04-03 17:02:53 +0000392 }
epoger@google.comf60494b2013-04-03 17:02:53 +0000393 }
epoger@google.comf60494b2013-04-03 17:02:53 +0000394 }
395
epoger@google.com310478e2013-04-03 18:00:39 +0000396 /**
397 * Return the number of significant (non-ignorable) errors we have
398 * encountered so far.
399 */
400 int NumSignificantErrors() {
401 int significantErrors = 0;
402 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
403 ErrorType type = static_cast<ErrorType>(typeInt);
epoger@google.com5079d2c2013-04-12 14:11:21 +0000404 if (!fIgnorableErrorTypes.includes(type)) {
epoger@google.com310478e2013-04-03 18:00:39 +0000405 significantErrors += fFailedTests[type].count();
406 }
407 }
408 return significantErrors;
409 }
410
411 /**
epoger@google.com51dbabe2013-04-10 15:24:53 +0000412 * Display the summary of results with this ErrorType.
413 *
414 * @param type which ErrorType
415 * @param verbose whether to be all verbose about it
epoger@google.com310478e2013-04-03 18:00:39 +0000416 */
epoger@google.com51dbabe2013-04-10 15:24:53 +0000417 void DisplayResultTypeSummary(ErrorType type, bool verbose) {
epoger@google.com5079d2c2013-04-12 14:11:21 +0000418 bool isIgnorableType = fIgnorableErrorTypes.includes(type);
epoger@google.com51dbabe2013-04-10 15:24:53 +0000419
420 SkString line;
421 if (isIgnorableType) {
422 line.append("[ ] ");
423 } else {
424 line.append("[*] ");
425 }
426
427 SkTArray<SkString> *failedTestsOfThisType = &fFailedTests[type];
428 int count = failedTestsOfThisType->count();
429 line.appendf("%d %s", count, getErrorTypeName(type));
430 if (!isIgnorableType || verbose) {
431 line.append(":");
432 for (int i = 0; i < count; ++i) {
433 line.append(" ");
434 line.append((*failedTestsOfThisType)[i]);
435 }
436 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000437 SkDebugf("%s\n", line.c_str());
epoger@google.com51dbabe2013-04-10 15:24:53 +0000438 }
439
440 /**
441 * List contents of fFailedTests to stdout.
442 *
443 * @param verbose whether to be all verbose about it
444 */
445 void ListErrors(bool verbose) {
epoger@google.com310478e2013-04-03 18:00:39 +0000446 // First, print a single summary line.
447 SkString summary;
448 summary.appendf("Ran %d tests:", fTestsRun);
449 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
450 ErrorType type = static_cast<ErrorType>(typeInt);
451 summary.appendf(" %s=%d", getErrorTypeName(type), fFailedTests[type].count());
452 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000453 SkDebugf("%s\n", summary.c_str());
epoger@google.com310478e2013-04-03 18:00:39 +0000454
455 // Now, for each failure type, list the tests that failed that way.
456 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
epoger@google.com51dbabe2013-04-10 15:24:53 +0000457 this->DisplayResultTypeSummary(static_cast<ErrorType>(typeInt), verbose);
epoger@google.com310478e2013-04-03 18:00:39 +0000458 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000459 SkDebugf("(results marked with [*] will cause nonzero return value)\n");
epoger@google.com310478e2013-04-03 18:00:39 +0000460 }
461
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000462 static ErrorCombination write_document(const SkString& path, SkStreamAsset* asset) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000463 SkFILEWStream stream(path.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000464 if (!stream.writeStream(asset, asset->getLength())) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000465 SkDebugf("FAILED to write document: %s\n", path.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000466 return ErrorCombination(kWritingReferenceImage_ErrorType);
467 }
468 return kEmpty_ErrorCombination;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000469 }
470
epoger@google.com37269602013-01-19 04:21:27 +0000471 /**
epoger@google.com5f6a0072013-01-31 16:30:55 +0000472 * Prepare an SkBitmap to render a GM into.
473 *
474 * After you've rendered the GM into the SkBitmap, you must call
475 * complete_bitmap()!
476 *
477 * @todo thudson 22 April 2011 - could refactor this to take in
478 * a factory to generate the context, always call readPixels()
479 * (logically a noop for rasters, if wasted time), and thus collapse the
480 * GPU special case and also let this be used for SkPicture testing.
481 */
482 static void setup_bitmap(const ConfigData& gRec, SkISize& size,
483 SkBitmap* bitmap) {
reedddd014e2014-06-05 08:51:20 -0700484 bitmap->allocPixels(SkImageInfo::Make(size.width(), size.height(),
485 gRec.fColorType, kPremul_SkAlphaType));
epoger@google.com5f6a0072013-01-31 16:30:55 +0000486 bitmap->eraseColor(SK_ColorTRANSPARENT);
487 }
488
489 /**
490 * Any finalization steps we need to perform on the SkBitmap after
491 * we have rendered the GM into it.
epoger@google.com37269602013-01-19 04:21:27 +0000492 *
493 * It's too bad that we are throwing away alpha channel data
494 * we could otherwise be examining, but this had always been happening
495 * before... it was buried within the compare() method at
496 * https://code.google.com/p/skia/source/browse/trunk/gm/gmmain.cpp?r=7289#305 .
497 *
498 * Apparently we need this, at least for bitmaps that are either:
499 * (a) destined to be written out as PNG files, or
500 * (b) compared against bitmaps read in from PNG files
501 * for the reasons described just above the force_all_opaque() method.
502 *
503 * Neglecting to do this led to the difficult-to-diagnose
504 * http://code.google.com/p/skia/issues/detail?id=1079 ('gm generating
505 * spurious pixel_error messages as of r7258')
506 *
507 * TODO(epoger): Come up with a better solution that allows us to
508 * compare full pixel data, including alpha channel, while still being
509 * robust in the face of transformations to/from PNG files.
510 * Options include:
511 *
512 * 1. Continue to call force_all_opaque(), but ONLY for bitmaps that
513 * will be written to, or compared against, PNG files.
514 * PRO: Preserve/compare alpha channel info for the non-PNG cases
515 * (comparing different renderModes in-memory)
epoger@google.com908f5832013-04-12 02:23:55 +0000516 * CON: The bitmaps (and hash digests) for these non-PNG cases would be
epoger@google.com37269602013-01-19 04:21:27 +0000517 * different than those for the PNG-compared cases, and in the
518 * case of a failed renderMode comparison, how would we write the
519 * image to disk for examination?
520 *
epoger@google.com908f5832013-04-12 02:23:55 +0000521 * 2. Always compute image hash digests from PNG format (either
epoger@google.com37269602013-01-19 04:21:27 +0000522 * directly from the the bytes of a PNG file, or capturing the
523 * bytes we would have written to disk if we were writing the
524 * bitmap out as a PNG).
525 * PRO: I think this would allow us to never force opaque, and to
526 * the extent that alpha channel data can be preserved in a PNG
527 * file, we could observe it.
epoger@google.com908f5832013-04-12 02:23:55 +0000528 * CON: If we read a bitmap from disk, we need to take its hash digest
epoger@google.com37269602013-01-19 04:21:27 +0000529 * from the source PNG (we can't compute it from the bitmap we
530 * read out of the PNG, because we will have already premultiplied
531 * the alpha).
532 * CON: Seems wasteful to convert a bitmap to PNG format just to take
epoger@google.com908f5832013-04-12 02:23:55 +0000533 * its hash digest. (Although we're wasting lots of effort already
epoger@google.com37269602013-01-19 04:21:27 +0000534 * calling force_all_opaque().)
535 *
536 * 3. Make the alpha premultiply/unpremultiply routines 100% consistent,
537 * so we can transform images back and forth without fear of off-by-one
538 * errors.
539 * CON: Math is hard.
540 *
541 * 4. Perform a "close enough" comparison of bitmaps (+/- 1 bit in each
542 * channel), rather than demanding absolute equality.
epoger@google.com908f5832013-04-12 02:23:55 +0000543 * CON: Can't do this with hash digests.
epoger@google.com37269602013-01-19 04:21:27 +0000544 */
epoger@google.com5f6a0072013-01-31 16:30:55 +0000545 static void complete_bitmap(SkBitmap* bitmap) {
546 force_all_opaque(*bitmap);
epoger@google.comde961632012-10-26 18:56:36 +0000547 }
548
scroggo@google.com09fd4d22013-03-20 14:20:18 +0000549 static void installFilter(SkCanvas* canvas);
epoger@google.comde961632012-10-26 18:56:36 +0000550
reed@google.comaef73612012-11-16 13:41:45 +0000551 static void invokeGM(GM* gm, SkCanvas* canvas, bool isPDF, bool isDeferred) {
epoger@google.comde961632012-10-26 18:56:36 +0000552 SkAutoCanvasRestore acr(canvas, true);
553
554 if (!isPDF) {
555 canvas->concat(gm->getInitialTransform());
556 }
557 installFilter(canvas);
reed@google.comaef73612012-11-16 13:41:45 +0000558 gm->setCanvasIsDeferred(isDeferred);
epoger@google.comde961632012-10-26 18:56:36 +0000559 gm->draw(canvas);
560 canvas->setDrawFilter(NULL);
561 }
562
epoger@google.com6f6568b2013-03-22 17:29:46 +0000563 static ErrorCombination generate_image(GM* gm, const ConfigData& gRec,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +0000564 GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +0000565 SkBitmap* bitmap,
566 bool deferred) {
epoger@google.comde961632012-10-26 18:56:36 +0000567 SkISize size (gm->getISize());
568 setup_bitmap(gRec, size, bitmap);
commit-bot@chromium.org466f5f32014-05-27 21:30:37 +0000569 const SkImageInfo info = bitmap->info();
epoger@google.comde961632012-10-26 18:56:36 +0000570
reed@google.com11db6fa2014-02-04 15:30:57 +0000571 SkAutoTUnref<SkSurface> surface;
epoger@google.comde961632012-10-26 18:56:36 +0000572 SkAutoTUnref<SkCanvas> canvas;
573
574 if (gRec.fBackend == kRaster_Backend) {
reed@google.com11db6fa2014-02-04 15:30:57 +0000575 surface.reset(SkSurface::NewRasterDirect(info,
576 bitmap->getPixels(),
577 bitmap->rowBytes()));
epoger@google.comde961632012-10-26 18:56:36 +0000578 if (deferred) {
reed@google.com11db6fa2014-02-04 15:30:57 +0000579 canvas.reset(SkDeferredCanvas::Create(surface));
epoger@google.comde961632012-10-26 18:56:36 +0000580 } else {
reed@google.com11db6fa2014-02-04 15:30:57 +0000581 canvas.reset(SkRef(surface->getCanvas()));
epoger@google.comde961632012-10-26 18:56:36 +0000582 }
reed@google.comaef73612012-11-16 13:41:45 +0000583 invokeGM(gm, canvas, false, deferred);
epoger@google.comde961632012-10-26 18:56:36 +0000584 canvas->flush();
585 }
586#if SK_SUPPORT_GPU
587 else { // GPU
reed@google.com11db6fa2014-02-04 15:30:57 +0000588 surface.reset(SkSurface::NewRenderTargetDirect(gpuTarget->asRenderTarget()));
epoger@google.comde961632012-10-26 18:56:36 +0000589 if (deferred) {
reed@google.com11db6fa2014-02-04 15:30:57 +0000590 canvas.reset(SkDeferredCanvas::Create(surface));
epoger@google.comde961632012-10-26 18:56:36 +0000591 } else {
reed@google.com11db6fa2014-02-04 15:30:57 +0000592 canvas.reset(SkRef(surface->getCanvas()));
epoger@google.comde961632012-10-26 18:56:36 +0000593 }
reed@google.comaef73612012-11-16 13:41:45 +0000594 invokeGM(gm, canvas, false, deferred);
epoger@google.comde961632012-10-26 18:56:36 +0000595 // the device is as large as the current rendertarget, so
596 // we explicitly only readback the amount we expect (in
597 // size) overwrite our previous allocation
commit-bot@chromium.orga3264e52014-05-30 13:26:10 +0000598 bitmap->setInfo(SkImageInfo::MakeN32Premul(size.fWidth, size.fHeight));
epoger@google.comde961632012-10-26 18:56:36 +0000599 canvas->readPixels(bitmap, 0, 0);
600 }
601#endif
epoger@google.com5f6a0072013-01-31 16:30:55 +0000602 complete_bitmap(bitmap);
epoger@google.com6f6568b2013-03-22 17:29:46 +0000603 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +0000604 }
605
606 static void generate_image_from_picture(GM* gm, const ConfigData& gRec,
junov@chromium.orgc938c482012-12-19 15:24:38 +0000607 SkPicture* pict, SkBitmap* bitmap,
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000608 SkScalar scale = SK_Scalar1,
609 bool tile = false) {
epoger@google.comde961632012-10-26 18:56:36 +0000610 SkISize size = gm->getISize();
611 setup_bitmap(gRec, size, bitmap);
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000612
613 if (tile) {
614 // Generate the result image by rendering to tiles and accumulating
615 // the results in 'bitmap'
616
skia.committer@gmail.com041e2db2013-04-03 07:01:14 +0000617 // This 16x16 tiling matches the settings applied to 'pict' in
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000618 // 'generate_new_picture'
619 SkISize tileSize = SkISize::Make(16, 16);
620
621 SkBitmap tileBM;
622 setup_bitmap(gRec, tileSize, &tileBM);
623 SkCanvas tileCanvas(tileBM);
624 installFilter(&tileCanvas);
625
626 SkCanvas bmpCanvas(*bitmap);
627 SkPaint bmpPaint;
628 bmpPaint.setXfermodeMode(SkXfermode::kSrc_Mode);
629
630 for (int yTile = 0; yTile < (size.height()+15)/16; ++yTile) {
631 for (int xTile = 0; xTile < (size.width()+15)/16; ++xTile) {
632 int saveCount = tileCanvas.save();
633 SkMatrix mat(tileCanvas.getTotalMatrix());
skia.committer@gmail.com041e2db2013-04-03 07:01:14 +0000634 mat.postTranslate(SkIntToScalar(-xTile*tileSize.width()),
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000635 SkIntToScalar(-yTile*tileSize.height()));
636 tileCanvas.setMatrix(mat);
637 pict->draw(&tileCanvas);
638 tileCanvas.flush();
639 tileCanvas.restoreToCount(saveCount);
skia.committer@gmail.com041e2db2013-04-03 07:01:14 +0000640 bmpCanvas.drawBitmap(tileBM,
641 SkIntToScalar(xTile * tileSize.width()),
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000642 SkIntToScalar(yTile * tileSize.height()),
643 &bmpPaint);
644 }
645 }
646 } else {
647 SkCanvas canvas(*bitmap);
648 installFilter(&canvas);
649 canvas.scale(scale, scale);
robertphillips9b14f262014-06-04 05:40:44 -0700650 canvas.drawPicture(pict);
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000651 complete_bitmap(bitmap);
652 }
epoger@google.comde961632012-10-26 18:56:36 +0000653 }
654
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000655 static bool generate_pdf(GM* gm, SkDynamicMemoryWStream& pdf) {
epoger@google.comde961632012-10-26 18:56:36 +0000656#ifdef SK_SUPPORT_PDF
657 SkMatrix initialTransform = gm->getInitialTransform();
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000658 if (FLAGS_useDocumentInsteadOfDevice) {
659 SkISize pageISize = gm->getISize();
edisonn@google.com73a7ea32013-11-11 20:55:15 +0000660 SkAutoTUnref<SkDocument> pdfDoc(
661 SkDocument::CreatePDF(&pdf, NULL,
662 encode_to_dct_data,
663 SkIntToScalar(FLAGS_pdfRasterDpi)));
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000664
665 if (!pdfDoc.get()) {
666 return false;
667 }
668
669 SkCanvas* canvas = NULL;
670 canvas = pdfDoc->beginPage(SkIntToScalar(pageISize.width()),
671 SkIntToScalar(pageISize.height()));
672 canvas->concat(initialTransform);
673
674 invokeGM(gm, canvas, true, false);
675
676 return pdfDoc->close();
epoger@google.comde961632012-10-26 18:56:36 +0000677 } else {
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000678 SkISize pageSize = gm->getISize();
679 SkPDFDevice* dev = NULL;
680 if (initialTransform.isIdentity()) {
681 dev = new SkPDFDevice(pageSize, pageSize, initialTransform);
682 } else {
683 SkRect content = SkRect::MakeWH(SkIntToScalar(pageSize.width()),
684 SkIntToScalar(pageSize.height()));
685 initialTransform.mapRect(&content);
686 content.intersect(0, 0, SkIntToScalar(pageSize.width()),
687 SkIntToScalar(pageSize.height()));
688 SkISize contentSize =
689 SkISize::Make(SkScalarRoundToInt(content.width()),
690 SkScalarRoundToInt(content.height()));
691 dev = new SkPDFDevice(pageSize, contentSize, initialTransform);
692 }
693 dev->setDCTEncoder(encode_to_dct_data);
edisonn@google.com73a7ea32013-11-11 20:55:15 +0000694 dev->setRasterDpi(SkIntToScalar(FLAGS_pdfRasterDpi));
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000695 SkAutoUnref aur(dev);
696 SkCanvas c(dev);
697 invokeGM(gm, &c, true, false);
698 SkPDFDocument doc;
699 doc.appendPage(dev);
700 doc.emitPDF(&pdf);
epoger@google.comde961632012-10-26 18:56:36 +0000701 }
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000702#endif // SK_SUPPORT_PDF
703 return true; // Do not report failure if pdf is not supported.
epoger@google.comde961632012-10-26 18:56:36 +0000704 }
705
706 static void generate_xps(GM* gm, SkDynamicMemoryWStream& xps) {
707#ifdef SK_SUPPORT_XPS
708 SkISize size = gm->getISize();
709
710 SkSize trimSize = SkSize::Make(SkIntToScalar(size.width()),
711 SkIntToScalar(size.height()));
712 static const SkScalar inchesPerMeter = SkScalarDiv(10000, 254);
713 static const SkScalar upm = 72 * inchesPerMeter;
714 SkVector unitsPerMeter = SkPoint::Make(upm, upm);
715 static const SkScalar ppm = 200 * inchesPerMeter;
716 SkVector pixelsPerMeter = SkPoint::Make(ppm, ppm);
717
718 SkXPSDevice* dev = new SkXPSDevice();
719 SkAutoUnref aur(dev);
720
721 SkCanvas c(dev);
722 dev->beginPortfolio(&xps);
723 dev->beginSheet(unitsPerMeter, pixelsPerMeter, trimSize);
reed@google.comaef73612012-11-16 13:41:45 +0000724 invokeGM(gm, &c, false, false);
epoger@google.comde961632012-10-26 18:56:36 +0000725 dev->endSheet();
726 dev->endPortfolio();
727
728#endif
729 }
730
epoger@google.com37269602013-01-19 04:21:27 +0000731 /**
epoger@google.com84a18022013-02-01 20:39:15 +0000732 * Log more detail about the mistmatch between expectedBitmap and
733 * actualBitmap.
734 */
735 void report_bitmap_diffs(const SkBitmap& expectedBitmap, const SkBitmap& actualBitmap,
736 const char *testName) {
737 const int expectedWidth = expectedBitmap.width();
738 const int expectedHeight = expectedBitmap.height();
739 const int width = actualBitmap.width();
740 const int height = actualBitmap.height();
741 if ((expectedWidth != width) || (expectedHeight != height)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000742 SkDebugf("---- %s: dimension mismatch -- expected [%d %d], actual [%d %d]\n",
743 testName, expectedWidth, expectedHeight, width, height);
epoger@google.com84a18022013-02-01 20:39:15 +0000744 return;
745 }
746
commit-bot@chromium.org28fcae22014-04-11 17:15:40 +0000747 if ((kN32_SkColorType != expectedBitmap.colorType()) ||
748 (kN32_SkColorType != actualBitmap.colorType())) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000749 SkDebugf("---- %s: not computing max per-channel pixel mismatch because non-8888\n",
750 testName);
epoger@google.com84a18022013-02-01 20:39:15 +0000751 return;
752 }
753
754 SkAutoLockPixels alp0(expectedBitmap);
755 SkAutoLockPixels alp1(actualBitmap);
756 int errR = 0;
757 int errG = 0;
758 int errB = 0;
759 int errA = 0;
760 int differingPixels = 0;
761
762 for (int y = 0; y < height; ++y) {
763 const SkPMColor* expectedPixelPtr = expectedBitmap.getAddr32(0, y);
764 const SkPMColor* actualPixelPtr = actualBitmap.getAddr32(0, y);
765 for (int x = 0; x < width; ++x) {
766 SkPMColor expectedPixel = *expectedPixelPtr++;
767 SkPMColor actualPixel = *actualPixelPtr++;
768 if (expectedPixel != actualPixel) {
769 differingPixels++;
770 errR = SkMax32(errR, SkAbs32((int)SkGetPackedR32(expectedPixel) -
771 (int)SkGetPackedR32(actualPixel)));
772 errG = SkMax32(errG, SkAbs32((int)SkGetPackedG32(expectedPixel) -
773 (int)SkGetPackedG32(actualPixel)));
774 errB = SkMax32(errB, SkAbs32((int)SkGetPackedB32(expectedPixel) -
775 (int)SkGetPackedB32(actualPixel)));
776 errA = SkMax32(errA, SkAbs32((int)SkGetPackedA32(expectedPixel) -
777 (int)SkGetPackedA32(actualPixel)));
778 }
779 }
780 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000781 SkDebugf("---- %s: %d (of %d) differing pixels, "
782 "max per-channel mismatch R=%d G=%d B=%d A=%d\n",
783 testName, differingPixels, width*height, errR, errG, errB, errA);
epoger@google.com84a18022013-02-01 20:39:15 +0000784 }
785
786 /**
epoger@google.com908f5832013-04-12 02:23:55 +0000787 * Compares actual hash digest to expectations, returning the set of errors
epoger@google.com6f6568b2013-03-22 17:29:46 +0000788 * (if any) that we saw along the way.
epoger@google.com37269602013-01-19 04:21:27 +0000789 *
790 * If fMismatchPath has been set, and there are pixel diffs, then the
791 * actual bitmap will be written out to a file within fMismatchPath.
epoger@google.com5f995452013-06-21 18:16:47 +0000792 * And similarly for fMissingExpectationsPath...
epoger@google.com37269602013-01-19 04:21:27 +0000793 *
794 * @param expectations what expectations to compare actualBitmap against
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000795 * @param actualBitmapAndDigest the SkBitmap we actually generated, and its GmResultDigest
epoger@google.com659c8c02013-05-21 15:45:45 +0000796 * @param shortName name of test, e.g. "selftest1"
797 * @param configName name of config, e.g. "8888"
epoger@google.com37269602013-01-19 04:21:27 +0000798 * @param renderModeDescriptor e.g., "-rtree", "-deferred"
799 * @param addToJsonSummary whether to add these results (both actual and
epoger@google.comcaac3db2013-04-04 19:23:11 +0000800 * expected) to the JSON summary. Regardless of this setting, if
801 * we find an image mismatch in this test, we will write these
802 * results to the JSON summary. (This is so that we will always
803 * report errors across rendering modes, such as pipe vs tiled.
804 * See https://codereview.chromium.org/13650002/ )
epoger@google.com37269602013-01-19 04:21:27 +0000805 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000806 ErrorCombination compare_to_expectations(Expectations expectations,
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000807 const BitmapAndDigest& actualBitmapAndDigest,
epoger@google.com659c8c02013-05-21 15:45:45 +0000808 const char *shortName, const char *configName,
809 const char *renderModeDescriptor,
epoger@google.comcaac3db2013-04-04 19:23:11 +0000810 bool addToJsonSummary) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000811 ErrorCombination errors;
epoger@google.com659c8c02013-05-21 15:45:45 +0000812 SkString shortNamePlusConfig = make_shortname_plus_config(shortName, configName);
813 SkString completeNameString(shortNamePlusConfig);
epoger@google.com37269602013-01-19 04:21:27 +0000814 completeNameString.append(renderModeDescriptor);
epoger@google.comce057fe2013-05-14 15:17:46 +0000815 completeNameString.append(".");
816 completeNameString.append(kPNG_FileExtension);
epoger@google.com37269602013-01-19 04:21:27 +0000817 const char* completeName = completeNameString.c_str();
epoger@google.comee8a8e32012-12-18 19:13:49 +0000818
epoger@google.com37269602013-01-19 04:21:27 +0000819 if (expectations.empty()) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000820 errors.add(kMissingExpectations_ErrorType);
epoger@google.com5f995452013-06-21 18:16:47 +0000821
822 // Write out the "actuals" for any tests without expectations, if we have
823 // been directed to do so.
824 if (fMissingExpectationsPath) {
825 SkString path = make_bitmap_filename(fMissingExpectationsPath, shortName,
826 configName, renderModeDescriptor,
827 actualBitmapAndDigest.fDigest);
828 write_bitmap(path, actualBitmapAndDigest.fBitmap);
829 }
830
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000831 } else if (!expectations.match(actualBitmapAndDigest.fDigest)) {
epoger@google.comcaac3db2013-04-04 19:23:11 +0000832 addToJsonSummary = true;
833 // The error mode we record depends on whether this was running
834 // in a non-standard renderMode.
835 if ('\0' == *renderModeDescriptor) {
836 errors.add(kExpectationsMismatch_ErrorType);
837 } else {
838 errors.add(kRenderModeMismatch_ErrorType);
839 }
epoger@google.com84a18022013-02-01 20:39:15 +0000840
841 // Write out the "actuals" for any mismatches, if we have
842 // been directed to do so.
epoger@google.com37269602013-01-19 04:21:27 +0000843 if (fMismatchPath) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000844 SkString path = make_bitmap_filename(fMismatchPath, shortName, configName,
845 renderModeDescriptor,
846 actualBitmapAndDigest.fDigest);
847 write_bitmap(path, actualBitmapAndDigest.fBitmap);
epoger@google.com37269602013-01-19 04:21:27 +0000848 }
epoger@google.com84a18022013-02-01 20:39:15 +0000849
850 // If we have access to a single expected bitmap, log more
851 // detail about the mismatch.
852 const SkBitmap *expectedBitmapPtr = expectations.asBitmap();
853 if (NULL != expectedBitmapPtr) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000854 report_bitmap_diffs(*expectedBitmapPtr, actualBitmapAndDigest.fBitmap,
855 completeName);
epoger@google.com84a18022013-02-01 20:39:15 +0000856 }
epoger@google.coma243b222013-01-17 17:54:28 +0000857 }
epoger@google.coma243b222013-01-17 17:54:28 +0000858
epoger@google.com37269602013-01-19 04:21:27 +0000859 if (addToJsonSummary) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000860 add_actual_results_to_json_summary(completeName, actualBitmapAndDigest.fDigest, errors,
epoger@google.com37269602013-01-19 04:21:27 +0000861 expectations.ignoreFailure());
862 add_expected_results_to_json_summary(completeName, expectations);
863 }
epoger@google.coma243b222013-01-17 17:54:28 +0000864
epoger@google.com6f6568b2013-03-22 17:29:46 +0000865 return errors;
epoger@google.com06b8a192013-01-15 19:10:16 +0000866 }
867
epoger@google.com37269602013-01-19 04:21:27 +0000868 /**
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000869 * Add this result to the appropriate JSON collection of actual results (but just ONE),
epoger@google.com76c913d2013-04-26 15:06:44 +0000870 * depending on errors encountered.
epoger@google.com37269602013-01-19 04:21:27 +0000871 */
872 void add_actual_results_to_json_summary(const char testName[],
epoger@google.comd4993ff2013-05-24 14:33:28 +0000873 const GmResultDigest &actualResultDigest,
epoger@google.com76c913d2013-04-26 15:06:44 +0000874 ErrorCombination errors,
epoger@google.com37269602013-01-19 04:21:27 +0000875 bool ignoreFailure) {
epoger@google.comd4993ff2013-05-24 14:33:28 +0000876 Json::Value jsonActualResults = actualResultDigest.asJsonTypeValuePair();
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000877 Json::Value *resultCollection = NULL;
878
epoger@google.com76c913d2013-04-26 15:06:44 +0000879 if (errors.isEmpty()) {
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000880 resultCollection = &this->fJsonActualResults_Succeeded;
881 } else if (errors.includes(kRenderModeMismatch_ErrorType)) {
882 resultCollection = &this->fJsonActualResults_Failed;
883 } else if (errors.includes(kExpectationsMismatch_ErrorType)) {
epoger@google.com37269602013-01-19 04:21:27 +0000884 if (ignoreFailure) {
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000885 resultCollection = &this->fJsonActualResults_FailureIgnored;
epoger@google.com37269602013-01-19 04:21:27 +0000886 } else {
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000887 resultCollection = &this->fJsonActualResults_Failed;
epoger@google.com37269602013-01-19 04:21:27 +0000888 }
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000889 } else if (errors.includes(kMissingExpectations_ErrorType)) {
890 // TODO: What about the case where there IS an expected
891 // image hash digest, but that gm test doesn't actually
892 // run? For now, those cases will always be ignored,
893 // because gm only looks at expectations that correspond
894 // to gm tests that were actually run.
895 //
896 // Once we have the ability to express expectations as a
897 // JSON file, we should fix this (and add a test case for
898 // which an expectation is given but the test is never
899 // run).
900 resultCollection = &this->fJsonActualResults_NoComparison;
901 }
902
903 // If none of the above cases match, we don't add it to ANY tally of actual results.
904 if (resultCollection) {
905 (*resultCollection)[testName] = jsonActualResults;
epoger@google.com37269602013-01-19 04:21:27 +0000906 }
907 }
908
909 /**
910 * Add this test to the JSON collection of expected results.
911 */
912 void add_expected_results_to_json_summary(const char testName[],
913 Expectations expectations) {
epoger@google.com76c913d2013-04-26 15:06:44 +0000914 this->fJsonExpectedResults[testName] = expectations.asJsonValue();
epoger@google.com37269602013-01-19 04:21:27 +0000915 }
916
917 /**
918 * Compare actualBitmap to expectations stored in this->fExpectationsSource.
919 *
920 * @param gm which test generated the actualBitmap
921 * @param gRec
vandebo@chromium.org8fc37662013-08-21 18:04:09 +0000922 * @param configName The config name to look for in the expectation file.
epoger@google.come33e1372013-07-08 19:13:33 +0000923 * @param actualBitmapAndDigest ptr to bitmap generated by this run, or NULL
924 * if we don't have a usable bitmap representation
epoger@google.com37269602013-01-19 04:21:27 +0000925 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000926 ErrorCombination compare_test_results_to_stored_expectations(
vandebo@chromium.org8fc37662013-08-21 18:04:09 +0000927 GM* gm, const ConfigData& gRec, const char* configName,
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000928 const BitmapAndDigest* actualBitmapAndDigest) {
epoger@google.com659c8c02013-05-21 15:45:45 +0000929 ErrorCombination errors;
epoger@google.come33e1372013-07-08 19:13:33 +0000930
931 if (NULL == actualBitmapAndDigest) {
932 // Note that we intentionally skipped validating the results for
933 // this test, because we don't know how to generate an SkBitmap
934 // version of the output.
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000935 errors.add(ErrorCombination(kIntentionallySkipped_ErrorType));
epoger@google.comc824c832013-07-12 15:52:59 +0000936 } else if (!(gRec.fFlags & kWrite_ConfigFlag)) {
937 // We don't record the results for this test or compare them
938 // against any expectations, because the output image isn't
939 // meaningful.
940 // See https://code.google.com/p/skia/issues/detail?id=1410 ('some
941 // GM result images not available for download from Google Storage')
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000942 errors.add(ErrorCombination(kIntentionallySkipped_ErrorType));
epoger@google.come33e1372013-07-08 19:13:33 +0000943 } else {
944 ExpectationsSource *expectationsSource = this->fExpectationsSource.get();
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +0000945 SkString nameWithExtension = make_shortname_plus_config(gm->getName(), configName);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000946 nameWithExtension.append(".");
947 nameWithExtension.append(kPNG_FileExtension);
948
epoger@google.come33e1372013-07-08 19:13:33 +0000949 if (expectationsSource && (gRec.fFlags & kRead_ConfigFlag)) {
950 /*
951 * Get the expected results for this test, as one or more allowed
952 * hash digests. The current implementation of expectationsSource
953 * get this by computing the hash digest of a single PNG file on disk.
954 *
955 * TODO(epoger): This relies on the fact that
956 * force_all_opaque() was called on the bitmap before it
957 * was written to disk as a PNG in the first place. If
958 * not, the hash digest returned here may not match the
959 * hash digest of actualBitmap, which *has* been run through
960 * force_all_opaque().
961 * See comments above complete_bitmap() for more detail.
962 */
963 Expectations expectations = expectationsSource->get(nameWithExtension.c_str());
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +0000964 if (this->ShouldIgnoreTest(gm->getName())) {
epoger@google.comdefc4872013-09-19 06:18:27 +0000965 expectations.setIgnoreFailure(true);
966 }
epoger@google.come33e1372013-07-08 19:13:33 +0000967 errors.add(compare_to_expectations(expectations, *actualBitmapAndDigest,
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +0000968 gm->getName(), configName, "", true));
epoger@google.come33e1372013-07-08 19:13:33 +0000969 } else {
970 // If we are running without expectations, we still want to
971 // record the actual results.
972 add_actual_results_to_json_summary(nameWithExtension.c_str(),
973 actualBitmapAndDigest->fDigest,
974 ErrorCombination(kMissingExpectations_ErrorType),
975 false);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000976 errors.add(ErrorCombination(kMissingExpectations_ErrorType));
epoger@google.come33e1372013-07-08 19:13:33 +0000977 }
epoger@google.com9ef89ce2013-01-18 21:45:42 +0000978 }
epoger@google.com6f6568b2013-03-22 17:29:46 +0000979 return errors;
epoger@google.coma243b222013-01-17 17:54:28 +0000980 }
981
epoger@google.com37269602013-01-19 04:21:27 +0000982 /**
983 * Compare actualBitmap to referenceBitmap.
984 *
epoger@google.com659c8c02013-05-21 15:45:45 +0000985 * @param shortName test name, e.g. "selftest1"
986 * @param configName configuration name, e.g. "8888"
epoger@google.com37269602013-01-19 04:21:27 +0000987 * @param renderModeDescriptor
988 * @param actualBitmap actual bitmap generated by this run
989 * @param referenceBitmap bitmap we expected to be generated
990 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000991 ErrorCombination compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +0000992 const char *shortName, const char *configName, const char *renderModeDescriptor,
epoger@google.com37269602013-01-19 04:21:27 +0000993 SkBitmap& actualBitmap, const SkBitmap* referenceBitmap) {
994
995 SkASSERT(referenceBitmap);
epoger@google.com84a18022013-02-01 20:39:15 +0000996 Expectations expectations(*referenceBitmap);
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000997 BitmapAndDigest actualBitmapAndDigest(actualBitmap);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000998
999 // TODO: Eliminate RecordTestResults from here.
1000 // Results recording code for the test_drawing path has been refactored so that
1001 // RecordTestResults is only called once, at the topmost level. However, the
1002 // other paths have not yet been refactored, and RecordTestResults has been added
1003 // here to maintain proper behavior for calls not coming from the test_drawing path.
1004 ErrorCombination errors;
1005 errors.add(compare_to_expectations(expectations, actualBitmapAndDigest, shortName,
1006 configName, renderModeDescriptor, false));
1007 SkString shortNamePlusConfig = make_shortname_plus_config(shortName, configName);
1008 RecordTestResults(errors, shortNamePlusConfig, renderModeDescriptor);
1009
1010 return errors;
epoger@google.com37269602013-01-19 04:21:27 +00001011 }
1012
junov@chromium.org20bd04e2013-01-16 18:43:36 +00001013 static SkPicture* generate_new_picture(GM* gm, BbhType bbhType, uint32_t recordFlags,
1014 SkScalar scale = SK_Scalar1) {
junov@chromium.org706ff2f2012-12-19 15:55:40 +00001015 int width = SkScalarCeilToInt(SkScalarMul(SkIntToScalar(gm->getISize().width()), scale));
1016 int height = SkScalarCeilToInt(SkScalarMul(SkIntToScalar(gm->getISize().height()), scale));
skia.committer@gmail.comd8b27992012-12-20 02:01:41 +00001017
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001018 SkAutoTDelete<SkBBHFactory> factory;
junov@chromium.org3cb834b2012-12-13 16:39:53 +00001019 if (kTileGrid_BbhType == bbhType) {
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001020 SkTileGridFactory::TileGridInfo info;
junov@chromium.org29b19e52013-02-27 18:35:16 +00001021 info.fMargin.setEmpty();
1022 info.fOffset.setZero();
1023 info.fTileInterval.set(16, 16);
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001024 factory.reset(SkNEW_ARGS(SkTileGridFactory, (info)));
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001025 } else if (kQuadTree_BbhType == bbhType) {
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001026 factory.reset(SkNEW(SkQuadTreeFactory));
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001027 } else if (kRTree_BbhType == bbhType) {
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001028 factory.reset(SkNEW(SkRTreeFactory));
junov@chromium.org20bd04e2013-01-16 18:43:36 +00001029 }
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001030 SkPictureRecorder recorder;
1031 SkCanvas* cv = recorder.beginRecording(width, height, factory.get(), recordFlags);
junov@chromium.orgc938c482012-12-19 15:24:38 +00001032 cv->scale(scale, scale);
reed@google.comaef73612012-11-16 13:41:45 +00001033 invokeGM(gm, cv, false, false);
robertphillips@google.com84b18c72014-04-13 19:09:42 +00001034 return recorder.endRecording();
epoger@google.comde961632012-10-26 18:56:36 +00001035 }
1036
1037 static SkPicture* stream_to_new_picture(const SkPicture& src) {
epoger@google.comde961632012-10-26 18:56:36 +00001038 SkDynamicMemoryWStream storage;
reed@google.com672588b2014-01-08 15:42:01 +00001039 src.serialize(&storage, NULL);
bungeman@google.comc29f3d82013-07-19 22:32:11 +00001040 SkAutoTUnref<SkStreamAsset> pictReadback(storage.detachAsStream());
commit-bot@chromium.org805df1a2013-08-16 19:18:12 +00001041 SkPicture* retval = SkPicture::CreateFromStream(pictReadback,
1042 &SkImageDecoder::DecodeMemory);
epoger@google.comde961632012-10-26 18:56:36 +00001043 return retval;
1044 }
1045
1046 // Test: draw into a bitmap or pdf.
epoger@google.com15655b22013-01-08 18:47:31 +00001047 // Depending on flags, possibly compare to an expected image.
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001048 // If writePath is not NULL, also write images (or documents) to the specified path.
1049 ErrorCombination test_drawing(GM* gm, const ConfigData& gRec,
1050 const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001051 const char writePath [],
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001052 GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001053 SkBitmap* bitmap) {
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001054 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001055 SkDynamicMemoryWStream document;
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001056 SkString path;
epoger@google.comde961632012-10-26 18:56:36 +00001057
1058 if (gRec.fBackend == kRaster_Backend ||
1059 gRec.fBackend == kGPU_Backend) {
1060 // Early exit if we can't generate the image.
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001061 errors.add(generate_image(gm, gRec, gpuTarget, bitmap, false));
epoger@google.com6f6568b2013-03-22 17:29:46 +00001062 if (!errors.isEmpty()) {
epoger@google.com37269602013-01-19 04:21:27 +00001063 // TODO: Add a test to exercise what the stdout and
1064 // JSON look like if we get an "early error" while
1065 // trying to generate the image.
epoger@google.comde961632012-10-26 18:56:36 +00001066 return errors;
1067 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001068 BitmapAndDigest bitmapAndDigest(*bitmap);
1069 errors.add(compare_test_results_to_stored_expectations(
vandebo@chromium.org8fc37662013-08-21 18:04:09 +00001070 gm, gRec, gRec.fName, &bitmapAndDigest));
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001071
1072 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001073 path = make_bitmap_filename(writePath, gm->getName(), gRec.fName,
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001074 "", bitmapAndDigest.fDigest);
1075 errors.add(write_bitmap(path, bitmapAndDigest.fBitmap));
1076 }
epoger@google.comde961632012-10-26 18:56:36 +00001077 } else if (gRec.fBackend == kPDF_Backend) {
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001078 if (!generate_pdf(gm, document)) {
1079 errors.add(kGeneratePdfFailed_ErrorType);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001080 } else {
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001081 SkAutoTUnref<SkStreamAsset> documentStream(document.detachAsStream());
1082 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001083 path = make_filename(writePath, gm->getName(), gRec.fName, "", "pdf");
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001084 errors.add(write_document(path, documentStream));
1085 }
1086
1087 if (!(gm->getFlags() & GM::kSkipPDFRasterization_Flag)) {
1088 for (int i = 0; i < pdfRasterizers.count(); i++) {
1089 SkBitmap pdfBitmap;
vandebo@chromium.org969967e2013-12-09 23:22:15 +00001090 documentStream->rewind();
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001091 bool success = (*pdfRasterizers[i]->fRasterizerFunction)(
1092 documentStream.get(), &pdfBitmap);
1093 if (!success) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001094 SkDebugf("FAILED to render PDF for %s using renderer %s\n",
1095 gm->getName(),
1096 pdfRasterizers[i]->fName);
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001097 continue;
1098 }
1099
1100 SkString configName(gRec.fName);
1101 configName.append("-");
1102 configName.append(pdfRasterizers[i]->fName);
1103
1104 BitmapAndDigest bitmapAndDigest(pdfBitmap);
1105 errors.add(compare_test_results_to_stored_expectations(
1106 gm, gRec, configName.c_str(), &bitmapAndDigest));
1107
1108 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001109 path = make_bitmap_filename(writePath, gm->getName(),
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001110 configName.c_str(),
1111 "", bitmapAndDigest.fDigest);
1112 errors.add(write_bitmap(path, bitmapAndDigest.fBitmap));
1113 }
1114 }
1115 } else {
1116 errors.add(kIntentionallySkipped_ErrorType);
1117 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001118 }
epoger@google.comde961632012-10-26 18:56:36 +00001119 } else if (gRec.fBackend == kXPS_Backend) {
1120 generate_xps(gm, document);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001121 SkAutoTUnref<SkStreamAsset> documentStream(document.detachAsStream());
epoger@google.come33e1372013-07-08 19:13:33 +00001122
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001123 errors.add(compare_test_results_to_stored_expectations(
vandebo@chromium.org8fc37662013-08-21 18:04:09 +00001124 gm, gRec, gRec.fName, NULL));
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001125
1126 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001127 path = make_filename(writePath, gm->getName(), gRec.fName, "", "xps");
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001128 errors.add(write_document(path, documentStream));
1129 }
epoger@google.come33e1372013-07-08 19:13:33 +00001130 } else {
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001131 SkASSERT(false);
epoger@google.come33e1372013-07-08 19:13:33 +00001132 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001133 return errors;
epoger@google.comde961632012-10-26 18:56:36 +00001134 }
1135
epoger@google.com6f6568b2013-03-22 17:29:46 +00001136 ErrorCombination test_deferred_drawing(GM* gm,
1137 const ConfigData& gRec,
1138 const SkBitmap& referenceBitmap,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001139 GrSurface* gpuTarget) {
epoger@google.comde961632012-10-26 18:56:36 +00001140 if (gRec.fBackend == kRaster_Backend ||
1141 gRec.fBackend == kGPU_Backend) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001142 const char renderModeDescriptor[] = "-deferred";
epoger@google.comde961632012-10-26 18:56:36 +00001143 SkBitmap bitmap;
1144 // Early exit if we can't generate the image, but this is
1145 // expected in some cases, so don't report a test failure.
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001146 ErrorCombination errors = generate_image(gm, gRec, gpuTarget, &bitmap, true);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001147 // TODO(epoger): This logic is the opposite of what is
1148 // described above... if we succeeded in generating the
1149 // -deferred image, we exit early! We should fix this
1150 // ASAP, because it is hiding -deferred errors... but for
1151 // now, I'm leaving the logic as it is so that the
1152 // refactoring change
1153 // https://codereview.chromium.org/12992003/ is unblocked.
1154 //
1155 // Filed as https://code.google.com/p/skia/issues/detail?id=1180
1156 // ('image-surface gm test is failing in "deferred" mode,
1157 // and gm is not reporting the failure')
1158 if (errors.isEmpty()) {
epoger@google.com310478e2013-04-03 18:00:39 +00001159 // TODO(epoger): Report this as a new ErrorType,
1160 // something like kImageGeneration_ErrorType?
epoger@google.com6f6568b2013-03-22 17:29:46 +00001161 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +00001162 }
epoger@google.com37269602013-01-19 04:21:27 +00001163 return compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001164 gm->getName(), gRec.fName, renderModeDescriptor, bitmap, &referenceBitmap);
epoger@google.comde961632012-10-26 18:56:36 +00001165 }
epoger@google.com6f6568b2013-03-22 17:29:46 +00001166 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +00001167 }
1168
epoger@google.comcaac3db2013-04-04 19:23:11 +00001169 ErrorCombination test_pipe_playback(GM* gm, const ConfigData& gRec,
1170 const SkBitmap& referenceBitmap, bool simulateFailure) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001171 const SkString shortNamePlusConfig = make_shortname_plus_config(gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001172 gRec.fName);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001173 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001174 for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001175 SkString renderModeDescriptor("-pipe");
1176 renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
1177
commit-bot@chromium.org805df1a2013-08-16 19:18:12 +00001178 if (gm->getFlags() & GM::kSkipPipe_Flag
1179 || (gPipeWritingFlagCombos[i].flags == SkGPipeWriter::kCrossProcess_Flag
1180 && gm->getFlags() & GM::kSkipPipeCrossProcess_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001181 RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001182 renderModeDescriptor.c_str());
1183 errors.add(kIntentionallySkipped_ErrorType);
1184 } else {
1185 SkBitmap bitmap;
1186 SkISize size = gm->getISize();
1187 setup_bitmap(gRec, size, &bitmap);
1188 SkCanvas canvas(bitmap);
1189 installFilter(&canvas);
scroggo@google.com74b7ffd2013-04-30 02:32:41 +00001190 // Pass a decoding function so the factory GM (which has an SkBitmap
1191 // with encoded data) will not fail playback.
1192 PipeController pipeController(&canvas, &SkImageDecoder::DecodeMemory);
epoger@google.comc8263e72013-04-10 12:17:34 +00001193 SkGPipeWriter writer;
1194 SkCanvas* pipeCanvas = writer.startRecording(&pipeController,
scroggo@google.comaef2d3b2013-04-10 18:10:41 +00001195 gPipeWritingFlagCombos[i].flags,
1196 size.width(), size.height());
epoger@google.comc8263e72013-04-10 12:17:34 +00001197 if (!simulateFailure) {
1198 invokeGM(gm, pipeCanvas, false, false);
1199 }
1200 complete_bitmap(&bitmap);
1201 writer.endRecording();
1202 errors.add(compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001203 gm->getName(), gRec.fName, renderModeDescriptor.c_str(), bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001204 &referenceBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001205 if (!errors.isEmpty()) {
1206 break;
1207 }
epoger@google.comde961632012-10-26 18:56:36 +00001208 }
1209 }
1210 return errors;
1211 }
1212
epoger@google.com6f6568b2013-03-22 17:29:46 +00001213 ErrorCombination test_tiled_pipe_playback(GM* gm, const ConfigData& gRec,
1214 const SkBitmap& referenceBitmap) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001215 const SkString shortNamePlusConfig = make_shortname_plus_config(gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001216 gRec.fName);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001217 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001218 for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001219 SkString renderModeDescriptor("-tiled pipe");
1220 renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
1221
1222 if ((gm->getFlags() & GM::kSkipPipe_Flag) ||
1223 (gm->getFlags() & GM::kSkipTiled_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001224 RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001225 renderModeDescriptor.c_str());
1226 errors.add(kIntentionallySkipped_ErrorType);
1227 } else {
1228 SkBitmap bitmap;
1229 SkISize size = gm->getISize();
1230 setup_bitmap(gRec, size, &bitmap);
1231 SkCanvas canvas(bitmap);
1232 installFilter(&canvas);
scroggo@google.com74b7ffd2013-04-30 02:32:41 +00001233 TiledPipeController pipeController(bitmap, &SkImageDecoder::DecodeMemory);
epoger@google.comc8263e72013-04-10 12:17:34 +00001234 SkGPipeWriter writer;
1235 SkCanvas* pipeCanvas = writer.startRecording(&pipeController,
scroggo@google.comaef2d3b2013-04-10 18:10:41 +00001236 gPipeWritingFlagCombos[i].flags,
1237 size.width(), size.height());
epoger@google.comc8263e72013-04-10 12:17:34 +00001238 invokeGM(gm, pipeCanvas, false, false);
1239 complete_bitmap(&bitmap);
1240 writer.endRecording();
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001241 errors.add(compare_test_results_to_reference_bitmap(gm->getName(), gRec.fName,
epoger@google.comc8263e72013-04-10 12:17:34 +00001242 renderModeDescriptor.c_str(),
1243 bitmap, &referenceBitmap));
1244 if (!errors.isEmpty()) {
1245 break;
1246 }
epoger@google.comde961632012-10-26 18:56:36 +00001247 }
1248 }
1249 return errors;
1250 }
epoger@google.come8ebeb12012-10-29 16:42:11 +00001251
1252 //
1253 // member variables.
1254 // They are public for now, to allow easier setting by tool_main().
1255 //
1256
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001257 bool fUseFileHierarchy, fWriteChecksumBasedFilenames;
epoger@google.com5079d2c2013-04-12 14:11:21 +00001258 ErrorCombination fIgnorableErrorTypes;
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00001259 SkTArray<SkString> fIgnorableTestNames;
epoger@google.come8ebeb12012-10-29 16:42:11 +00001260
junov@chromium.org95146eb2013-01-11 21:04:40 +00001261 const char* fMismatchPath;
epoger@google.com5f995452013-06-21 18:16:47 +00001262 const char* fMissingExpectationsPath;
junov@chromium.org95146eb2013-01-11 21:04:40 +00001263
epoger@google.com310478e2013-04-03 18:00:39 +00001264 // collection of tests that have failed with each ErrorType
1265 SkTArray<SkString> fFailedTests[kLast_ErrorType+1];
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001266 SkTArray<SkString> fTestsSkippedOnAllRenderModes;
epoger@google.com310478e2013-04-03 18:00:39 +00001267 int fTestsRun;
1268 SkTDict<int> fRenderModesEncountered;
epoger@google.com57f7abc2012-11-13 03:41:55 +00001269
epoger@google.com908f5832013-04-12 02:23:55 +00001270 // Where to read expectations (expected image hash digests, etc.) from.
epoger@google.com37269602013-01-19 04:21:27 +00001271 // If unset, we don't do comparisons.
1272 SkAutoTUnref<ExpectationsSource> fExpectationsSource;
1273
1274 // JSON summaries that we generate as we go (just for output).
epoger@google.comee8a8e32012-12-18 19:13:49 +00001275 Json::Value fJsonExpectedResults;
1276 Json::Value fJsonActualResults_Failed;
1277 Json::Value fJsonActualResults_FailureIgnored;
epoger@google.com9c56a8d2012-12-20 18:34:29 +00001278 Json::Value fJsonActualResults_NoComparison;
epoger@google.comee8a8e32012-12-18 19:13:49 +00001279 Json::Value fJsonActualResults_Succeeded;
epoger@google.comde961632012-10-26 18:56:36 +00001280}; // end of GMMain class definition
scroggo@google.com72c96722012-06-06 21:07:10 +00001281
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001282#if SK_SUPPORT_GPU
1283static const GLContextType kDontCare_GLContextType = GrContextFactory::kNative_GLContextType;
1284#else
1285static const GLContextType kDontCare_GLContextType = 0;
1286#endif
bsalomon@google.com7361f542012-04-19 19:15:35 +00001287
tomhudson@google.com9875dd12011-04-25 15:49:53 +00001288static const ConfigData gRec[] = {
reedddd014e2014-06-05 08:51:20 -07001289 { kN32_SkColorType, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "8888", true },
1290 { kRGB_565_SkColorType, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "565", true },
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001291#if SK_SUPPORT_GPU
reedddd014e2014-06-05 08:51:20 -07001292 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 0, kRW_ConfigFlag, "gpu", true },
1293 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 16, kRW_ConfigFlag, "msaa16", false},
1294 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 4, kRW_ConfigFlag, "msaa4", false},
1295 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNVPR_GLContextType, 4, kRW_ConfigFlag, "nvprmsaa4", true },
1296 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNVPR_GLContextType, 16, kRW_ConfigFlag, "nvprmsaa16", false},
epoger@google.comc824c832013-07-12 15:52:59 +00001297 /* The gpudebug context does not generate meaningful images, so don't record
1298 * the images it generates! We only run it to look for asserts. */
reedddd014e2014-06-05 08:51:20 -07001299 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kDebug_GLContextType, 0, kNone_ConfigFlag, "gpudebug", kDebugOnly},
robertphillips@google.comd6543e52013-07-18 17:39:14 +00001300 /* The gpunull context does the least amount of work possible and doesn't
1301 generate meaninful images, so don't record them!. It can be run to
1302 isolate the CPU-side processing expense from the GPU-side.
1303 */
reedddd014e2014-06-05 08:51:20 -07001304 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNull_GLContextType, 0, kNone_ConfigFlag, "gpunull", kDebugOnly},
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001305#if SK_ANGLE
reedddd014e2014-06-05 08:51:20 -07001306 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kANGLE_GLContextType, 0, kRW_ConfigFlag, "angle", true },
1307 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kANGLE_GLContextType, 16, kRW_ConfigFlag, "anglemsaa16", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001308#endif // SK_ANGLE
1309#ifdef SK_MESA
reedddd014e2014-06-05 08:51:20 -07001310 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kMESA_GLContextType, 0, kRW_ConfigFlag, "mesa", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001311#endif // SK_MESA
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001312#endif // SK_SUPPORT_GPU
bungeman@google.comb29c8832011-10-10 13:19:10 +00001313#ifdef SK_SUPPORT_XPS
bsalomon@google.com7361f542012-04-19 19:15:35 +00001314 /* At present we have no way of comparing XPS files (either natively or by converting to PNG). */
reedddd014e2014-06-05 08:51:20 -07001315 { kN32_SkColorType, kXPS_Backend, kDontCare_GLContextType, 0, kWrite_ConfigFlag, "xps", true },
robertphillips@google.coma73e8602012-08-02 17:56:02 +00001316#endif // SK_SUPPORT_XPS
bsalomon@google.com7361f542012-04-19 19:15:35 +00001317#ifdef SK_SUPPORT_PDF
reedddd014e2014-06-05 08:51:20 -07001318 { kN32_SkColorType, kPDF_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "pdf", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001319#endif // SK_SUPPORT_PDF
reed@android.com00dae862009-06-10 15:38:48 +00001320};
1321
bungeman@google.com5d20cae2014-05-09 15:22:41 +00001322static bool SkNoRasterizePDF(SkStream*, SkBitmap*) { return false; }
1323
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001324static const PDFRasterizerData kPDFRasterizers[] = {
1325#ifdef SK_BUILD_FOR_MAC
1326 { &SkPDFDocumentToBitmap, "mac", true },
1327#endif
1328#ifdef SK_BUILD_POPPLER
1329 { &SkPopplerRasterizePDF, "poppler", true },
1330#endif
commit-bot@chromium.orgffd178c2013-11-11 15:10:47 +00001331#ifdef SK_BUILD_NATIVE_PDF_RENDERER
1332 { &SkNativeRasterizePDF, "native", true },
1333#endif // SK_BUILD_NATIVE_PDF_RENDERER
bungeman@google.com5d20cae2014-05-09 15:22:41 +00001334 // The following exists so that this array is never zero length.
1335 { &SkNoRasterizePDF, "none", false},
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001336};
1337
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001338static const char kDefaultsConfigStr[] = "defaults";
1339static const char kExcludeConfigChar = '~';
kkinnunen80549fc2014-06-30 06:36:31 -07001340#if SK_SUPPORT_GPU
1341static const char kGpuAPINameGL[] = "gl";
1342static const char kGpuAPINameGLES[] = "gles";
1343#endif
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001344
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001345static SkString configUsage() {
scroggo@google.com0f567c62013-03-20 15:35:08 +00001346 SkString result;
1347 result.appendf("Space delimited list of which configs to run. Possible options: [");
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001348 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001349 SkASSERT(gRec[i].fName != kDefaultsConfigStr);
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001350 if (i > 0) {
scroggo@google.com0f567c62013-03-20 15:35:08 +00001351 result.append("|");
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001352 }
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001353 result.appendf("%s", gRec[i].fName);
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001354 }
scroggo@google.com0f567c62013-03-20 15:35:08 +00001355 result.append("]\n");
1356 result.appendf("The default value is: \"");
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001357 SkString firstDefault;
1358 SkString allButFirstDefaults;
1359 SkString nonDefault;
scroggo@google.com0f567c62013-03-20 15:35:08 +00001360 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
1361 if (gRec[i].fRunByDefault) {
1362 if (i > 0) {
1363 result.append(" ");
1364 }
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001365 result.append(gRec[i].fName);
1366 if (firstDefault.isEmpty()) {
1367 firstDefault = gRec[i].fName;
1368 } else {
1369 if (!allButFirstDefaults.isEmpty()) {
1370 allButFirstDefaults.append(" ");
1371 }
1372 allButFirstDefaults.append(gRec[i].fName);
1373 }
1374 } else {
1375 nonDefault = gRec[i].fName;
scroggo@google.com0f567c62013-03-20 15:35:08 +00001376 }
1377 }
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001378 result.append("\"\n");
1379 result.appendf("\"%s\" evaluates to the default set of configs.\n", kDefaultsConfigStr);
1380 result.appendf("Prepending \"%c\" on a config name excludes it from the set of configs to run.\n"
1381 "Exclusions always override inclusions regardless of order.\n",
1382 kExcludeConfigChar);
1383 result.appendf("E.g. \"--config %s %c%s %s\" will run these configs:\n\t%s %s",
1384 kDefaultsConfigStr,
1385 kExcludeConfigChar,
1386 firstDefault.c_str(),
1387 nonDefault.c_str(),
1388 allButFirstDefaults.c_str(),
1389 nonDefault.c_str());
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001390 return result;
scroggo@google.com0b735632013-03-19 17:38:50 +00001391}
scroggo@google.com7d519302013-03-19 17:28:10 +00001392
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001393static SkString pdfRasterizerUsage() {
1394 SkString result;
1395 result.appendf("Space delimited list of which PDF rasterizers to run. Possible options: [");
1396 // For this (and further) loops through kPDFRasterizers, there is a typecast to int to avoid
1397 // the compiler giving an "comparison of unsigned expression < 0 is always false" warning
1398 // and turning it into a build-breaking error.
1399 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); ++i) {
1400 if (i > 0) {
1401 result.append(" ");
1402 }
1403 result.append(kPDFRasterizers[i].fName);
1404 }
1405 result.append("]\n");
1406 result.append("The default value is: \"");
1407 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); ++i) {
1408 if (kPDFRasterizers[i].fRunByDefault) {
1409 if (i > 0) {
1410 result.append(" ");
1411 }
1412 result.append(kPDFRasterizers[i].fName);
1413 }
1414 }
1415 result.append("\"");
1416 return result;
1417}
1418
epoger@google.com6f6568b2013-03-22 17:29:46 +00001419// Macro magic to convert a numeric preprocessor token into a string.
1420// Adapted from http://stackoverflow.com/questions/240353/convert-a-preprocessor-token-to-a-string
1421// This should probably be moved into one of our common headers...
1422#define TOSTRING_INTERNAL(x) #x
1423#define TOSTRING(x) TOSTRING_INTERNAL(x)
1424
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001425// Alphabetized ignoring "no" prefix ("readPath", "noreplay", "resourcePath").
scroggo@google.com0f567c62013-03-20 15:35:08 +00001426DEFINE_string(config, "", configUsage().c_str());
bsalomon69456182014-07-07 10:46:58 -07001427DEFINE_bool(cpu, true, "Allows non-GPU configs to be run. Applied after --config.");
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00001428DEFINE_string(pdfRasterizers, "default", pdfRasterizerUsage().c_str());
epoger@google.com5e497382013-09-30 07:01:55 +00001429DEFINE_bool(deferred, false, "Exercise the deferred rendering test pass.");
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00001430DEFINE_bool(dryRun, false, "Don't actually run the tests, just print what would have been done.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001431DEFINE_string(excludeConfig, "", "Space delimited list of configs to skip.");
1432DEFINE_bool(forceBWtext, false, "Disable text anti-aliasing.");
1433#if SK_SUPPORT_GPU
kkinnunen80549fc2014-06-30 06:36:31 -07001434DEFINE_string(gpuAPI, "", "Force use of specific gpu API. Using \"gl\" "
1435 "forces OpenGL API. Using \"gles\" forces OpenGL ES API. "
1436 "Defaults to empty string, which selects the API native to the "
1437 "system.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001438DEFINE_string(gpuCacheSize, "", "<bytes> <count>: Limit the gpu cache to byte size or "
epoger@google.com6f6568b2013-03-22 17:29:46 +00001439 "object count. " TOSTRING(DEFAULT_CACHE_VALUE) " for either value means "
1440 "use the default. 0 for either disables the cache.");
bsalomon69456182014-07-07 10:46:58 -07001441DEFINE_bool(gpu, true, "Allows GPU configs to be run. Applied after --config.");
krajcevski12b35442014-08-13 12:06:26 -07001442DEFINE_bool(gpuCompressAlphaMasks, false, "Compress masks generated from falling back to "
1443 "software path rendering.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001444#endif
1445DEFINE_bool(hierarchy, false, "Whether to use multilevel directory structure "
1446 "when reading/writing files.");
epoger@google.com5079d2c2013-04-12 14:11:21 +00001447DEFINE_string(ignoreErrorTypes, kDefaultIgnorableErrorTypes.asString(" ").c_str(),
1448 "Space-separated list of ErrorTypes that should be ignored. If any *other* error "
1449 "types are encountered, the tool will exit with a nonzero return value.");
epoger@google.comf711f322013-10-18 14:55:47 +00001450DEFINE_string(ignoreFailuresFile, "", "Path to file containing a list of tests for which we "
1451 "should ignore failures.\n"
1452 "The file should list one test per line, except for comment lines starting with #");
commit-bot@chromium.org6dda8272014-01-23 17:21:19 +00001453DEFINE_bool2(leaks, l, false, "show leaked ref cnt'd objects.");
caryclark@google.com512c9b62013-05-10 15:16:13 +00001454DEFINE_string(match, "", "[~][^]substring[$] [...] of test name to run.\n"
1455 "Multiple matches may be separated by spaces.\n"
1456 "~ causes a matching test to always be skipped\n"
1457 "^ requires the start of the test to match\n"
1458 "$ requires the end of the test to match\n"
1459 "^ and $ requires an exact match\n"
1460 "If a test does not match any list entry,\n"
1461 "it is skipped unless some list entry starts with ~");
epoger@google.com5f995452013-06-21 18:16:47 +00001462DEFINE_string(missingExpectationsPath, "", "Write images for tests without expectations "
1463 "into this directory.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001464DEFINE_string(mismatchPath, "", "Write images for tests that failed due to "
1465 "pixel mismatches into this directory.");
1466DEFINE_string(modulo, "", "[--modulo <remainder> <divisor>]: only run tests for which "
1467 "testIndex %% divisor == remainder.");
epoger@google.com5e497382013-09-30 07:01:55 +00001468DEFINE_bool(pipe, false, "Exercise the SkGPipe replay test pass.");
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001469DEFINE_bool(quadtree, false, "Exercise the QuadTree variant of SkPicture test pass.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001470DEFINE_string2(readPath, r, "", "Read reference images from this dir, and report "
1471 "any differences between those and the newly generated ones.");
epoger@google.com5e497382013-09-30 07:01:55 +00001472DEFINE_bool(replay, false, "Exercise the SkPicture replay test pass.");
djsollen@google.comac8f3a42013-10-04 14:57:00 +00001473#if SK_SUPPORT_GPU
1474DEFINE_bool(resetGpuContext, false, "Reset the GrContext prior to running each GM.");
1475#endif
epoger@google.com5e497382013-09-30 07:01:55 +00001476DEFINE_bool(rtree, false, "Exercise the R-Tree variant of SkPicture test pass.");
1477DEFINE_bool(serialize, false, "Exercise the SkPicture serialization & deserialization test pass.");
epoger@google.comcaac3db2013-04-04 19:23:11 +00001478DEFINE_bool(simulatePipePlaybackFailure, false, "Simulate a rendering failure in pipe mode only.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001479DEFINE_bool(tiledPipe, false, "Exercise tiled SkGPipe replay.");
epoger@google.com5e497382013-09-30 07:01:55 +00001480DEFINE_bool(tileGrid, false, "Exercise the tile grid variant of SkPicture.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001481DEFINE_string(tileGridReplayScales, "", "Space separated list of floating-point scale "
1482 "factors to be used for tileGrid playback testing. Default value: 1.0");
epoger@google.comb0f8b432013-04-10 18:46:25 +00001483DEFINE_bool2(verbose, v, false, "Give more detail (e.g. list all GMs run, more info about "
1484 "each test).");
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001485DEFINE_bool(writeChecksumBasedFilenames, false, "When writing out actual images, use checksum-"
1486 "based filenames, as rebaseline.py will use when downloading them from Google Storage");
1487DEFINE_string(writeJsonSummaryPath, "", "Write a JSON-formatted result summary to this file.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001488DEFINE_string2(writePath, w, "", "Write rendered images into this directory.");
scroggo@google.com604e0c22013-04-09 21:25:46 +00001489DEFINE_string2(writePicturePath, p, "", "Write .skp files into this directory.");
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001490DEFINE_int32(pdfJpegQuality, -1, "Encodes images in JPEG at quality level N, "
1491 "which can be in range 0-100). N = -1 will disable JPEG compression. "
1492 "Default is N = 100, maximum quality.");
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +00001493// TODO(edisonn): pass a matrix instead of forcePerspectiveMatrix
1494// Either the 9 numbers defining the matrix
1495// or probably more readable would be to replace it with a set of a few predicates
1496// Like --prerotate 100 200 10 --posttranslate 10, 10
1497// Probably define spacial names like centerx, centery, top, bottom, left, right
1498// then we can write something reabable like --rotate centerx centery 90
1499DEFINE_bool(forcePerspectiveMatrix, false, "Force a perspective matrix.");
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001500DEFINE_bool(useDocumentInsteadOfDevice, false, "Use SkDocument::CreateFoo instead of SkFooDevice.");
edisonn@google.com73a7ea32013-11-11 20:55:15 +00001501DEFINE_int32(pdfRasterDpi, 72, "Scale at which at which the non suported "
1502 "features in PDF are rasterized. Must be be in range 0-10000. "
1503 "Default is 72. N = 0 will disable rasterizing features like "
1504 "text shadows or perspective bitmaps.");
reed@google.com672588b2014-01-08 15:42:01 +00001505static SkData* encode_to_dct_data(size_t*, const SkBitmap& bitmap) {
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001506 // Filter output of warnings that JPEG is not available for the image.
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001507 if (bitmap.width() >= 65500 || bitmap.height() >= 65500) return NULL;
1508 if (FLAGS_pdfJpegQuality == -1) return NULL;
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001509
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001510 SkBitmap bm = bitmap;
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001511#if defined(SK_BUILD_FOR_MAC)
1512 // Workaround bug #1043 where bitmaps with referenced pixels cause
1513 // CGImageDestinationFinalize to crash
1514 SkBitmap copy;
commit-bot@chromium.orgd5f032d2014-02-24 18:51:43 +00001515 bitmap.deepCopyTo(&copy);
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001516 bm = copy;
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001517#endif
1518
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001519 SkPixelRef* pr = bm.pixelRef();
1520 if (pr != NULL) {
1521 SkData* data = pr->refEncodedData();
1522 if (data != NULL) {
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001523 return data;
1524 }
1525 }
1526
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001527 return SkImageEncoder::EncodeData(bm,
1528 SkImageEncoder::kJPEG_Type,
1529 FLAGS_pdfJpegQuality);
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001530}
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001531
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001532static int findConfig(const char config[]) {
1533 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); i++) {
1534 if (!strcmp(config, gRec[i].fName)) {
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001535 return (int) i;
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001536 }
1537 }
1538 return -1;
1539}
1540
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001541static const PDFRasterizerData* findPDFRasterizer(const char rasterizer[]) {
1542 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); i++) {
1543 if (!strcmp(rasterizer, kPDFRasterizers[i].fName)) {
1544 return &kPDFRasterizers[i];
1545 }
1546 }
1547 return NULL;
1548}
1549
reed@google.comfb2cd422013-01-04 14:43:03 +00001550template <typename T> void appendUnique(SkTDArray<T>* array, const T& value) {
1551 int index = array->find(value);
1552 if (index < 0) {
1553 *array->append() = value;
1554 }
1555}
1556
epoger@google.com80724df2013-03-21 13:49:54 +00001557/**
epoger@google.com80724df2013-03-21 13:49:54 +00001558 * Run this test in a number of different drawing modes (pipe,
1559 * deferred, tiled, etc.), confirming that the resulting bitmaps all
1560 * *exactly* match comparisonBitmap.
1561 *
1562 * Returns all errors encountered while doing so.
1563 */
epoger@google.com6f6568b2013-03-22 17:29:46 +00001564ErrorCombination run_multiple_modes(GMMain &gmmain, GM *gm, const ConfigData &compareConfig,
1565 const SkBitmap &comparisonBitmap,
1566 const SkTDArray<SkScalar> &tileGridReplayScales);
1567ErrorCombination run_multiple_modes(GMMain &gmmain, GM *gm, const ConfigData &compareConfig,
1568 const SkBitmap &comparisonBitmap,
1569 const SkTDArray<SkScalar> &tileGridReplayScales) {
1570 ErrorCombination errorsForAllModes;
epoger@google.com80724df2013-03-21 13:49:54 +00001571 uint32_t gmFlags = gm->getFlags();
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001572 const SkString shortNamePlusConfig = gmmain.make_shortname_plus_config(gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001573 compareConfig.fName);
epoger@google.com80724df2013-03-21 13:49:54 +00001574
epoger@google.comc8263e72013-04-10 12:17:34 +00001575 SkPicture* pict = gmmain.generate_new_picture(gm, kNone_BbhType, 0);
1576 SkAutoUnref aur(pict);
1577 if (FLAGS_replay) {
1578 const char renderModeDescriptor[] = "-replay";
1579 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001580 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1581 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001582 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1583 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001584 SkBitmap bitmap;
1585 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap);
epoger@google.comc8263e72013-04-10 12:17:34 +00001586 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001587 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001588 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001589 }
epoger@google.comc8263e72013-04-10 12:17:34 +00001590 }
epoger@google.com80724df2013-03-21 13:49:54 +00001591
epoger@google.comc8263e72013-04-10 12:17:34 +00001592 if (FLAGS_serialize) {
1593 const char renderModeDescriptor[] = "-serialize";
1594 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001595 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1596 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001597 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1598 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001599 SkPicture* repict = gmmain.stream_to_new_picture(*pict);
1600 SkAutoUnref aurr(repict);
epoger@google.com80724df2013-03-21 13:49:54 +00001601 SkBitmap bitmap;
1602 gmmain.generate_image_from_picture(gm, compareConfig, repict, &bitmap);
epoger@google.comc8263e72013-04-10 12:17:34 +00001603 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001604 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001605 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001606 }
epoger@google.com80724df2013-03-21 13:49:54 +00001607 }
1608
epoger@google.comc8263e72013-04-10 12:17:34 +00001609 if ((1 == FLAGS_writePicturePath.count()) &&
1610 !(gmFlags & GM::kSkipPicture_Flag)) {
1611 const char* pictureSuffix = "skp";
epoger@google.com659c8c02013-05-21 15:45:45 +00001612 // TODO(epoger): Make sure this still works even though the
1613 // filename now contains the config name (it used to contain
1614 // just the shortName). I think this is actually an
1615 // *improvement*, because now runs with different configs will
1616 // write out their SkPictures to separate files rather than
1617 // overwriting each other. But we should make sure it doesn't
1618 // break anybody.
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001619 SkString path = gmmain.make_filename(FLAGS_writePicturePath[0], gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001620 compareConfig.fName, "", pictureSuffix);
epoger@google.comc8263e72013-04-10 12:17:34 +00001621 SkFILEWStream stream(path.c_str());
1622 pict->serialize(&stream);
epoger@google.com80724df2013-03-21 13:49:54 +00001623 }
1624
epoger@google.comc8263e72013-04-10 12:17:34 +00001625 if (FLAGS_rtree) {
1626 const char renderModeDescriptor[] = "-rtree";
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001627 if ((gmFlags & GM::kSkipPicture_Flag) || (gmFlags & GM::kSkipTiled_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001628 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1629 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001630 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1631 } else {
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001632 SkPicture* pict = gmmain.generate_new_picture(gm, kRTree_BbhType, 0);
1633 SkAutoUnref aur(pict);
1634 SkBitmap bitmap;
1635 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap);
1636 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
1637 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
1638 &comparisonBitmap));
1639 }
1640 }
1641
1642 if (FLAGS_quadtree) {
1643 const char renderModeDescriptor[] = "-quadtree";
1644 if ((gmFlags & GM::kSkipPicture_Flag) || (gmFlags & GM::kSkipTiled_Flag)) {
1645 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1646 renderModeDescriptor);
1647 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1648 } else {
1649 SkPicture* pict = gmmain.generate_new_picture(gm, kQuadTree_BbhType, 0);
epoger@google.com80724df2013-03-21 13:49:54 +00001650 SkAutoUnref aur(pict);
1651 SkBitmap bitmap;
epoger@google.comc8263e72013-04-10 12:17:34 +00001652 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001653 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001654 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001655 &comparisonBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001656 }
1657 }
1658
1659 if (FLAGS_tileGrid) {
1660 for(int scaleIndex = 0; scaleIndex < tileGridReplayScales.count(); ++scaleIndex) {
1661 SkScalar replayScale = tileGridReplayScales[scaleIndex];
1662 SkString renderModeDescriptor("-tilegrid");
1663 if (SK_Scalar1 != replayScale) {
1664 renderModeDescriptor += "-scale-";
1665 renderModeDescriptor.appendScalar(replayScale);
1666 }
1667
1668 if ((gmFlags & GM::kSkipPicture_Flag) ||
senorblanco@chromium.orgd4d44f02014-02-20 17:17:57 +00001669 (gmFlags & GM::kSkipTiled_Flag) ||
epoger@google.comc8263e72013-04-10 12:17:34 +00001670 ((gmFlags & GM::kSkipScaledReplay_Flag) && replayScale != 1)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001671 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001672 renderModeDescriptor.c_str());
1673 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1674 } else {
1675 // We record with the reciprocal scale to obtain a replay
1676 // result that can be validated against comparisonBitmap.
1677 SkScalar recordScale = SkScalarInvert(replayScale);
1678 SkPicture* pict = gmmain.generate_new_picture(
robertphillips9f1c2412014-06-09 06:25:34 -07001679 gm, kTileGrid_BbhType, 0, recordScale);
epoger@google.comc8263e72013-04-10 12:17:34 +00001680 SkAutoUnref aur(pict);
1681 SkBitmap bitmap;
1682 // We cannot yet pass 'true' to generate_image_from_picture to
1683 // perform actual tiled rendering (see Issue 1198 -
1684 // https://code.google.com/p/skia/issues/detail?id=1198)
1685 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap,
1686 replayScale /*, true */);
1687 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001688 gm->getName(), compareConfig.fName, renderModeDescriptor.c_str(), bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001689 &comparisonBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001690 }
epoger@google.com80724df2013-03-21 13:49:54 +00001691 }
1692 }
1693
1694 // run the pipe centric GM steps
epoger@google.comc8263e72013-04-10 12:17:34 +00001695 if (FLAGS_pipe) {
1696 errorsForAllModes.add(gmmain.test_pipe_playback(gm, compareConfig, comparisonBitmap,
1697 FLAGS_simulatePipePlaybackFailure));
1698 if (FLAGS_tiledPipe) {
1699 errorsForAllModes.add(gmmain.test_tiled_pipe_playback(gm, compareConfig,
1700 comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001701 }
epoger@google.com80724df2013-03-21 13:49:54 +00001702 }
1703 return errorsForAllModes;
1704}
1705
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001706
1707/**
1708 * Run this test in a number of different configs (8888, 565, PDF,
1709 * etc.), confirming that the resulting bitmaps match expectations
1710 * (which may be different for each config).
1711 *
1712 * Returns all errors encountered while doing so.
1713 */
1714ErrorCombination run_multiple_configs(GMMain &gmmain, GM *gm,
1715 const SkTDArray<size_t> &configs,
1716 const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
1717 const SkTDArray<SkScalar> &tileGridReplayScales,
kkinnunen80549fc2014-06-30 06:36:31 -07001718 GrContextFactory *grFactory,
1719 GrGLStandard gpuAPI);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001720ErrorCombination run_multiple_configs(GMMain &gmmain, GM *gm,
1721 const SkTDArray<size_t> &configs,
1722 const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
1723 const SkTDArray<SkScalar> &tileGridReplayScales,
kkinnunen80549fc2014-06-30 06:36:31 -07001724 GrContextFactory *grFactory,
1725 GrGLStandard gpuAPI) {
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001726 const char renderModeDescriptor[] = "";
1727 ErrorCombination errorsForAllConfigs;
1728 uint32_t gmFlags = gm->getFlags();
1729
1730 for (int i = 0; i < configs.count(); i++) {
1731 ConfigData config = gRec[configs[i]];
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001732 const SkString shortNamePlusConfig = gmmain.make_shortname_plus_config(gm->getName(),
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001733 config.fName);
1734
1735 // Skip any tests that we don't even need to try.
1736 // If any of these were skipped on a per-GM basis, record them as
1737 // kIntentionallySkipped.
1738 if (kPDF_Backend == config.fBackend) {
1739 if (gmFlags & GM::kSkipPDF_Flag) {
1740 gmmain.RecordSkippedTest(shortNamePlusConfig,
1741 renderModeDescriptor,
1742 config.fBackend);
1743 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1744 continue;
1745 }
1746 }
1747 if ((gmFlags & GM::kSkip565_Flag) &&
1748 (kRaster_Backend == config.fBackend) &&
reedddd014e2014-06-05 08:51:20 -07001749 (kRGB_565_SkColorType == config.fColorType)) {
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001750 gmmain.RecordSkippedTest(shortNamePlusConfig,
1751 renderModeDescriptor,
1752 config.fBackend);
1753 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1754 continue;
1755 }
1756 if (((gmFlags & GM::kSkipGPU_Flag) && kGPU_Backend == config.fBackend) ||
1757 ((gmFlags & GM::kGPUOnly_Flag) && kGPU_Backend != config.fBackend)) {
1758 gmmain.RecordSkippedTest(shortNamePlusConfig,
1759 renderModeDescriptor,
1760 config.fBackend);
1761 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1762 continue;
1763 }
1764
1765 // Now we know that we want to run this test and record its
1766 // success or failure.
1767 ErrorCombination errorsForThisConfig;
1768 GrSurface* gpuTarget = NULL;
1769#if SK_SUPPORT_GPU
1770 SkAutoTUnref<GrSurface> auGpuTarget;
1771 if ((errorsForThisConfig.isEmpty()) && (kGPU_Backend == config.fBackend)) {
1772 if (FLAGS_resetGpuContext) {
1773 grFactory->destroyContexts();
1774 }
kkinnunen80549fc2014-06-30 06:36:31 -07001775 GrContext* gr = grFactory->get(config.fGLContextType, gpuAPI);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001776 bool grSuccess = false;
1777 if (gr) {
1778 // create a render target to back the device
1779 GrTextureDesc desc;
1780 desc.fConfig = kSkia8888_GrPixelConfig;
1781 desc.fFlags = kRenderTarget_GrTextureFlagBit;
1782 desc.fWidth = gm->getISize().width();
1783 desc.fHeight = gm->getISize().height();
1784 desc.fSampleCnt = config.fSampleCnt;
1785 auGpuTarget.reset(gr->createUncachedTexture(desc, NULL, 0));
1786 if (NULL != auGpuTarget) {
1787 gpuTarget = auGpuTarget;
1788 grSuccess = true;
1789 // Set the user specified cache limits if non-default.
1790 size_t bytes;
1791 int count;
commit-bot@chromium.org95c20032014-05-09 14:29:32 +00001792 gr->getResourceCacheLimits(&count, &bytes);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001793 if (DEFAULT_CACHE_VALUE != gGpuCacheSizeBytes) {
1794 bytes = static_cast<size_t>(gGpuCacheSizeBytes);
1795 }
1796 if (DEFAULT_CACHE_VALUE != gGpuCacheSizeCount) {
1797 count = gGpuCacheSizeCount;
1798 }
commit-bot@chromium.org95c20032014-05-09 14:29:32 +00001799 gr->setResourceCacheLimits(count, bytes);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001800 }
1801 }
1802 if (!grSuccess) {
1803 errorsForThisConfig.add(kNoGpuContext_ErrorType);
1804 }
1805 }
1806#endif
1807
1808 SkBitmap comparisonBitmap;
1809
1810 const char* writePath;
1811 if (FLAGS_writePath.count() == 1) {
1812 writePath = FLAGS_writePath[0];
1813 } else {
1814 writePath = NULL;
1815 }
1816
1817 if (errorsForThisConfig.isEmpty()) {
1818 errorsForThisConfig.add(gmmain.test_drawing(gm, config, pdfRasterizers,
1819 writePath, gpuTarget,
1820 &comparisonBitmap));
1821 gmmain.RecordTestResults(errorsForThisConfig, shortNamePlusConfig, "");
1822 }
1823
1824 // TODO: run only if gmmain.test_drawing succeeded.
1825 if (kRaster_Backend == config.fBackend) {
1826 run_multiple_modes(gmmain, gm, config, comparisonBitmap, tileGridReplayScales);
1827 }
1828
1829 if (FLAGS_deferred && errorsForThisConfig.isEmpty() &&
1830 (kGPU_Backend == config.fBackend || kRaster_Backend == config.fBackend)) {
1831 errorsForThisConfig.add(gmmain.test_deferred_drawing(gm, config, comparisonBitmap,
1832 gpuTarget));
1833 }
1834
1835 errorsForAllConfigs.add(errorsForThisConfig);
1836 }
1837 return errorsForAllConfigs;
1838}
1839
1840
epoger@google.com310478e2013-04-03 18:00:39 +00001841/**
epoger@google.comf711f322013-10-18 14:55:47 +00001842 * Read individual lines from a file, pushing them into the given array.
1843 *
1844 * @param filename path to the file to read
1845 * @param lines array of strings to add the lines to
1846 * @returns true if able to read lines from the file
1847 */
1848static bool read_lines_from_file(const char* filename, SkTArray<SkString> &lines) {
1849 SkAutoTUnref<SkStream> streamWrapper(SkStream::NewFromFile(filename));
1850 SkStream *stream = streamWrapper.get();
1851 if (!stream) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001852 SkDebugf("unable to read file '%s'\n", filename);
epoger@google.comf711f322013-10-18 14:55:47 +00001853 return false;
1854 }
1855
1856 char c;
1857 SkString line;
1858 while (1 == stream->read(&c, 1)) {
1859 // If we hit either CR or LF, we've completed a line.
1860 //
1861 // TODO: If the file uses both CR and LF, this will return an extra blank
1862 // line for each line of the file. Which is OK for current purposes...
1863 //
1864 // TODO: Does this properly handle unicode? It doesn't matter for
1865 // current purposes...
1866 if ((c == 0x0d) || (c == 0x0a)) {
1867 lines.push_back(line);
1868 line.reset();
1869 } else {
1870 line.append(&c, 1);
1871 }
1872 }
1873 lines.push_back(line);
1874 return true;
1875}
1876
1877/**
epoger@google.com310478e2013-04-03 18:00:39 +00001878 * Return a list of all entries in an array of strings as a single string
1879 * of this form:
1880 * "item1", "item2", "item3"
1881 */
1882SkString list_all(const SkTArray<SkString> &stringArray);
1883SkString list_all(const SkTArray<SkString> &stringArray) {
1884 SkString total;
1885 for (int i = 0; i < stringArray.count(); i++) {
1886 if (i > 0) {
1887 total.append(", ");
1888 }
1889 total.append("\"");
1890 total.append(stringArray[i]);
1891 total.append("\"");
1892 }
1893 return total;
1894}
1895
1896/**
1897 * Return a list of configuration names, as a single string of this form:
1898 * "item1", "item2", "item3"
1899 *
1900 * @param configs configurations, as a list of indices into gRec
1901 */
1902SkString list_all_config_names(const SkTDArray<size_t> &configs);
1903SkString list_all_config_names(const SkTDArray<size_t> &configs) {
1904 SkString total;
1905 for (int i = 0; i < configs.count(); i++) {
1906 if (i > 0) {
1907 total.append(", ");
1908 }
1909 total.append("\"");
1910 total.append(gRec[configs[i]].fName);
1911 total.append("\"");
1912 }
1913 return total;
1914}
1915
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001916static bool prepare_subdirectories(const char *root, bool useFileHierarchy,
1917 const SkTDArray<size_t> &configs,
1918 const SkTDArray<const PDFRasterizerData*>& pdfRasterizers) {
epoger@google.comfdea3252013-05-02 18:24:03 +00001919 if (!sk_mkdir(root)) {
1920 return false;
1921 }
1922 if (useFileHierarchy) {
1923 for (int i = 0; i < configs.count(); i++) {
1924 ConfigData config = gRec[configs[i]];
1925 SkString subdir;
1926 subdir.appendf("%s%c%s", root, SkPATH_SEPARATOR, config.fName);
1927 if (!sk_mkdir(subdir.c_str())) {
1928 return false;
1929 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001930
1931 if (config.fBackend == kPDF_Backend) {
1932 for (int j = 0; j < pdfRasterizers.count(); j++) {
1933 SkString pdfSubdir = subdir;
vandebo@chromium.org8fc37662013-08-21 18:04:09 +00001934 pdfSubdir.appendf("-%s", pdfRasterizers[j]->fName);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001935 if (!sk_mkdir(pdfSubdir.c_str())) {
1936 return false;
1937 }
1938 }
1939 }
epoger@google.comfdea3252013-05-02 18:24:03 +00001940 }
1941 }
1942 return true;
1943}
1944
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001945static bool parse_flags_configs(SkTDArray<size_t>* outConfigs,
kkinnunen80549fc2014-06-30 06:36:31 -07001946 GrContextFactory* grFactory, GrGLStandard gpuAPI) {
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001947 SkTDArray<size_t> excludeConfigs;
1948
1949 for (int i = 0; i < FLAGS_config.count(); i++) {
1950 const char* config = FLAGS_config[i];
1951 bool exclude = false;
1952 if (*config == kExcludeConfigChar) {
1953 exclude = true;
1954 config += 1;
1955 }
1956 int index = findConfig(config);
1957 if (index >= 0) {
1958 if (exclude) {
1959 *excludeConfigs.append() = index;
1960 } else {
1961 appendUnique<size_t>(outConfigs, index);
1962 }
1963 } else if (0 == strcmp(kDefaultsConfigStr, config)) {
1964 if (exclude) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001965 SkDebugf("%c%s is not allowed.\n",
1966 kExcludeConfigChar, kDefaultsConfigStr);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001967 return false;
1968 }
1969 for (size_t c = 0; c < SK_ARRAY_COUNT(gRec); ++c) {
1970 if (gRec[c].fRunByDefault) {
1971 appendUnique<size_t>(outConfigs, c);
1972 }
1973 }
1974 } else {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001975 SkDebugf("unrecognized config %s\n", config);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001976 return false;
1977 }
1978 }
1979
1980 for (int i = 0; i < FLAGS_excludeConfig.count(); i++) {
1981 int index = findConfig(FLAGS_excludeConfig[i]);
1982 if (index >= 0) {
1983 *excludeConfigs.append() = index;
1984 } else {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001985 SkDebugf("unrecognized excludeConfig %s\n", FLAGS_excludeConfig[i]);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001986 return false;
1987 }
1988 }
1989
1990 if (outConfigs->count() == 0) {
1991 // if no config is specified by user, add the defaults
1992 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
1993 if (gRec[i].fRunByDefault) {
1994 *outConfigs->append() = i;
1995 }
1996 }
1997 }
1998 // now remove any explicitly excluded configs
1999 for (int i = 0; i < excludeConfigs.count(); ++i) {
2000 int index = outConfigs->find(excludeConfigs[i]);
2001 if (index >= 0) {
2002 outConfigs->remove(index);
2003 // now assert that there was only one copy in configs[]
2004 SkASSERT(outConfigs->find(excludeConfigs[i]) < 0);
2005 }
2006 }
2007
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002008 for (int i = 0; i < outConfigs->count(); ++i) {
2009 size_t index = (*outConfigs)[i];
2010 if (kGPU_Backend == gRec[index].fBackend) {
bsalomon69456182014-07-07 10:46:58 -07002011#if SK_SUPPORT_GPU
2012 if (!FLAGS_gpu) {
2013 outConfigs->remove(i);
2014 --i;
2015 continue;
2016 }
2017#endif
2018 } else if (!FLAGS_cpu) {
2019 outConfigs->remove(i);
2020 --i;
2021 continue;
2022 }
2023#if SK_SUPPORT_GPU
2024 SkASSERT(grFactory != NULL);
2025 if (kGPU_Backend == gRec[index].fBackend) {
kkinnunen80549fc2014-06-30 06:36:31 -07002026 GrContext* ctx = grFactory->get(gRec[index].fGLContextType, gpuAPI);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002027 if (NULL == ctx) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002028 SkDebugf("GrContext could not be created for config %s. Config will be skipped.\n",
2029 gRec[index].fName);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002030 outConfigs->remove(i);
2031 --i;
2032 continue;
2033 }
2034 if (gRec[index].fSampleCnt > ctx->getMaxSampleCount()) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002035 SkDebugf("Sample count (%d) of config %s is not supported."
2036 " Config will be skipped.\n",
2037 gRec[index].fSampleCnt, gRec[index].fName);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002038 outConfigs->remove(i);
2039 --i;
2040 }
2041 }
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002042#endif
bsalomon69456182014-07-07 10:46:58 -07002043 }
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002044
2045 if (outConfigs->isEmpty()) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002046 SkDebugf("No configs to run.");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002047 return false;
2048 }
2049
2050 // now show the user the set of configs that will be run.
2051 SkString configStr("These configs will be run:");
2052 // show the user the config that will run.
2053 for (int i = 0; i < outConfigs->count(); ++i) {
2054 configStr.appendf(" %s", gRec[(*outConfigs)[i]].fName);
2055 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002056 SkDebugf("%s\n", configStr.c_str());
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002057
2058 return true;
2059}
2060
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002061static bool parse_flags_pdf_rasterizers(const SkTDArray<size_t>& configs,
2062 SkTDArray<const PDFRasterizerData*>* outRasterizers) {
2063 // No need to run this check (and display the PDF rasterizers message)
2064 // if no PDF backends are in the configs.
2065 bool configHasPDF = false;
2066 for (int i = 0; i < configs.count(); i++) {
2067 if (gRec[configs[i]].fBackend == kPDF_Backend) {
2068 configHasPDF = true;
2069 break;
2070 }
2071 }
2072 if (!configHasPDF) {
2073 return true;
2074 }
2075
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00002076 if (FLAGS_pdfRasterizers.count() == 1 &&
2077 !strcmp(FLAGS_pdfRasterizers[0], "default")) {
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002078 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); ++i) {
2079 if (kPDFRasterizers[i].fRunByDefault) {
2080 *outRasterizers->append() = &kPDFRasterizers[i];
2081 }
2082 }
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00002083 } else {
2084 for (int i = 0; i < FLAGS_pdfRasterizers.count(); i++) {
2085 const char* rasterizer = FLAGS_pdfRasterizers[i];
2086 const PDFRasterizerData* rasterizerPtr =
2087 findPDFRasterizer(rasterizer);
2088 if (rasterizerPtr == NULL) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002089 SkDebugf("unrecognized rasterizer %s\n", rasterizer);
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00002090 return false;
2091 }
2092 appendUnique<const PDFRasterizerData*>(outRasterizers,
2093 rasterizerPtr);
2094 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002095 }
2096
2097 // now show the user the set of configs that will be run.
2098 SkString configStr("These PDF rasterizers will be run:");
2099 // show the user the config that will run.
2100 for (int i = 0; i < outRasterizers->count(); ++i) {
2101 configStr.appendf(" %s", (*outRasterizers)[i]->fName);
2102 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002103 SkDebugf("%s\n", configStr.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002104
2105 return true;
2106}
2107
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002108static bool parse_flags_ignore_error_types(ErrorCombination* outErrorTypes) {
2109 if (FLAGS_ignoreErrorTypes.count() > 0) {
2110 *outErrorTypes = ErrorCombination();
2111 for (int i = 0; i < FLAGS_ignoreErrorTypes.count(); i++) {
2112 ErrorType type;
2113 const char *name = FLAGS_ignoreErrorTypes[i];
2114 if (!getErrorTypeByName(name, &type)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002115 SkDebugf("cannot find ErrorType with name '%s'\n", name);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002116 return false;
2117 } else {
2118 outErrorTypes->add(type);
2119 }
2120 }
2121 }
2122 return true;
2123}
2124
epoger@google.com3a882dd2013-10-07 18:55:09 +00002125/**
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002126 * Replace contents of ignoreTestNames with a list of test names, indicating
epoger@google.com3a882dd2013-10-07 18:55:09 +00002127 * which tests' failures should be ignored.
2128 */
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002129static bool parse_flags_ignore_tests(SkTArray<SkString> &ignoreTestNames) {
2130 ignoreTestNames.reset();
epoger@google.comf711f322013-10-18 14:55:47 +00002131
epoger@google.comf711f322013-10-18 14:55:47 +00002132 // Parse --ignoreFailuresFile
2133 for (int i = 0; i < FLAGS_ignoreFailuresFile.count(); i++) {
2134 SkTArray<SkString> linesFromFile;
2135 if (!read_lines_from_file(FLAGS_ignoreFailuresFile[i], linesFromFile)) {
2136 return false;
2137 } else {
2138 for (int j = 0; j < linesFromFile.count(); j++) {
2139 SkString thisLine = linesFromFile[j];
2140 if (thisLine.isEmpty() || thisLine.startsWith('#')) {
2141 // skip this line
2142 } else {
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002143 ignoreTestNames.push_back(thisLine);
epoger@google.comf711f322013-10-18 14:55:47 +00002144 }
2145 }
2146 }
2147 }
2148
epoger@google.com3a882dd2013-10-07 18:55:09 +00002149 return true;
2150}
2151
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002152static bool parse_flags_modulo(int* moduloRemainder, int* moduloDivisor) {
2153 if (FLAGS_modulo.count() == 2) {
2154 *moduloRemainder = atoi(FLAGS_modulo[0]);
2155 *moduloDivisor = atoi(FLAGS_modulo[1]);
2156 if (*moduloRemainder < 0 || *moduloDivisor <= 0 ||
2157 *moduloRemainder >= *moduloDivisor) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002158 SkDebugf("invalid modulo values.");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002159 return false;
2160 }
2161 }
2162 return true;
2163}
2164
2165#if SK_SUPPORT_GPU
2166static bool parse_flags_gpu_cache(int* sizeBytes, int* sizeCount) {
2167 if (FLAGS_gpuCacheSize.count() > 0) {
2168 if (FLAGS_gpuCacheSize.count() != 2) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002169 SkDebugf("--gpuCacheSize requires two arguments\n");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002170 return false;
2171 }
2172 *sizeBytes = atoi(FLAGS_gpuCacheSize[0]);
2173 *sizeCount = atoi(FLAGS_gpuCacheSize[1]);
2174 } else {
2175 *sizeBytes = DEFAULT_CACHE_VALUE;
2176 *sizeCount = DEFAULT_CACHE_VALUE;
2177 }
2178 return true;
2179}
kkinnunen80549fc2014-06-30 06:36:31 -07002180
2181static bool parse_flags_gl_standard(GrGLStandard* gpuAPI) {
2182 if (0 == FLAGS_gpuAPI.count()) {
2183 *gpuAPI = kNone_GrGLStandard;
2184 return true;
2185 }
2186 if (1 == FLAGS_gpuAPI.count()) {
2187 if (FLAGS_gpuAPI.contains(kGpuAPINameGL)) {
2188 *gpuAPI = kGL_GrGLStandard;
2189 return true;
2190 }
2191 if (FLAGS_gpuAPI.contains(kGpuAPINameGLES)) {
2192 *gpuAPI = kGLES_GrGLStandard;
2193 return true;
2194 }
2195 }
2196 SkDebugf("--gpuAPI invalid api value");
2197 return false;
2198}
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002199#endif
2200
2201static bool parse_flags_tile_grid_replay_scales(SkTDArray<SkScalar>* outScales) {
2202 *outScales->append() = SK_Scalar1; // By default only test at scale 1.0
2203 if (FLAGS_tileGridReplayScales.count() > 0) {
2204 outScales->reset();
2205 for (int i = 0; i < FLAGS_tileGridReplayScales.count(); i++) {
2206 double val = atof(FLAGS_tileGridReplayScales[i]);
2207 if (0 < val) {
2208 *outScales->append() = SkDoubleToScalar(val);
2209 }
2210 }
2211 if (0 == outScales->count()) {
2212 // Should have at least one scale
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002213 SkDebugf("--tileGridReplayScales requires at least one scale.\n");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002214 return false;
2215 }
2216 }
2217 return true;
2218}
2219
2220static bool parse_flags_gmmain_paths(GMMain* gmmain) {
2221 gmmain->fUseFileHierarchy = FLAGS_hierarchy;
2222 gmmain->fWriteChecksumBasedFilenames = FLAGS_writeChecksumBasedFilenames;
2223
2224 if (FLAGS_mismatchPath.count() == 1) {
2225 gmmain->fMismatchPath = FLAGS_mismatchPath[0];
2226 }
2227
2228 if (FLAGS_missingExpectationsPath.count() == 1) {
2229 gmmain->fMissingExpectationsPath = FLAGS_missingExpectationsPath[0];
2230 }
2231
2232 if (FLAGS_readPath.count() == 1) {
2233 const char* readPath = FLAGS_readPath[0];
2234 if (!sk_exists(readPath)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002235 SkDebugf("readPath %s does not exist!\n", readPath);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002236 return false;
2237 }
2238 if (sk_isdir(readPath)) {
2239 if (FLAGS_verbose) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002240 SkDebugf("reading from %s\n", readPath);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002241 }
2242 gmmain->fExpectationsSource.reset(SkNEW_ARGS(
2243 IndividualImageExpectationsSource, (readPath)));
2244 } else {
2245 if (FLAGS_verbose) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002246 SkDebugf("reading expectations from JSON summary file %s\n", readPath);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002247 }
2248 gmmain->fExpectationsSource.reset(SkNEW_ARGS(JsonExpectationsSource, (readPath)));
2249 }
2250 }
2251 return true;
2252}
2253
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002254static bool parse_flags_jpeg_quality() {
2255 if (FLAGS_pdfJpegQuality < -1 || FLAGS_pdfJpegQuality > 100) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002256 SkDebugf("%s\n", "pdfJpegQuality must be in [-1 .. 100] range.");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002257 return false;
2258 }
2259 return true;
2260}
2261
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002262int tool_main(int argc, char** argv);
2263int tool_main(int argc, char** argv) {
mtklein30e6e2a2014-06-18 11:44:15 -07002264 SetupCrashHandler();
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002265
commit-bot@chromium.org6dda8272014-01-23 17:21:19 +00002266 SkString usage;
2267 usage.printf("Run the golden master tests.\n");
2268 SkCommandLineFlags::SetUsage(usage.c_str());
2269 SkCommandLineFlags::Parse(argc, argv);
2270
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002271#if SK_ENABLE_INST_COUNT
commit-bot@chromium.org6dda8272014-01-23 17:21:19 +00002272 if (FLAGS_leaks) {
2273 gPrintInstCount = true;
2274 }
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002275#endif
2276
2277 SkGraphics::Init();
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002278
2279 setSystemPreferences();
2280 GMMain gmmain;
2281
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002282 SkTDArray<size_t> configs;
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002283
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002284 int moduloRemainder = -1;
2285 int moduloDivisor = -1;
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002286 SkTDArray<const PDFRasterizerData*> pdfRasterizers;
epoger@google.com6f6568b2013-03-22 17:29:46 +00002287 SkTDArray<SkScalar> tileGridReplayScales;
bsalomon@google.com4c75f242013-03-19 18:58:43 +00002288#if SK_SUPPORT_GPU
kkinnunen80549fc2014-06-30 06:36:31 -07002289 GrGLStandard gpuAPI = kNone_GrGLStandard;
krajcevski12b35442014-08-13 12:06:26 -07002290 GrContext::Options grContextOpts;
2291 grContextOpts.fDrawPathToCompressedTexture = FLAGS_gpuCompressAlphaMasks;
2292 GrContextFactory* grFactory = new GrContextFactory(grContextOpts);
epoger@google.com80724df2013-03-21 13:49:54 +00002293#else
kkinnunen80549fc2014-06-30 06:36:31 -07002294 GrGLStandard gpuAPI = 0;
epoger@google.com80724df2013-03-21 13:49:54 +00002295 GrContextFactory* grFactory = NULL;
bsalomon@google.com4c75f242013-03-19 18:58:43 +00002296#endif
2297
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002298 if (FLAGS_dryRun) {
2299 SkDebugf( "Doing a dry run; no tests will actually be executed.\n");
2300 }
2301
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002302 if (!parse_flags_modulo(&moduloRemainder, &moduloDivisor) ||
2303 !parse_flags_ignore_error_types(&gmmain.fIgnorableErrorTypes) ||
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002304 !parse_flags_ignore_tests(gmmain.fIgnorableTestNames) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002305#if SK_SUPPORT_GPU
2306 !parse_flags_gpu_cache(&gGpuCacheSizeBytes, &gGpuCacheSizeCount) ||
kkinnunen80549fc2014-06-30 06:36:31 -07002307 !parse_flags_gl_standard(&gpuAPI) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002308#endif
2309 !parse_flags_tile_grid_replay_scales(&tileGridReplayScales) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002310 !parse_flags_jpeg_quality() ||
kkinnunen80549fc2014-06-30 06:36:31 -07002311 !parse_flags_configs(&configs, grFactory, gpuAPI) ||
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002312 !parse_flags_pdf_rasterizers(configs, &pdfRasterizers) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002313 !parse_flags_gmmain_paths(&gmmain)) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00002314 return -1;
2315 }
2316
epoger@google.comb0f8b432013-04-10 18:46:25 +00002317 if (FLAGS_verbose) {
2318 if (FLAGS_writePath.count() == 1) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002319 SkDebugf("writing to %s\n", FLAGS_writePath[0]);
epoger@google.comb0f8b432013-04-10 18:46:25 +00002320 }
epoger@google.comfdea3252013-05-02 18:24:03 +00002321 if (NULL != gmmain.fMismatchPath) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002322 SkDebugf("writing mismatches to %s\n", gmmain.fMismatchPath);
epoger@google.comfdea3252013-05-02 18:24:03 +00002323 }
epoger@google.com5f995452013-06-21 18:16:47 +00002324 if (NULL != gmmain.fMissingExpectationsPath) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002325 SkDebugf("writing images without expectations to %s\n",
2326 gmmain.fMissingExpectationsPath);
epoger@google.com5f995452013-06-21 18:16:47 +00002327 }
epoger@google.comb0f8b432013-04-10 18:46:25 +00002328 if (FLAGS_writePicturePath.count() == 1) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002329 SkDebugf("writing pictures to %s\n", FLAGS_writePicturePath[0]);
epoger@google.comb0f8b432013-04-10 18:46:25 +00002330 }
tfarinabcbc1782014-06-18 14:32:48 -07002331 if (!GetResourcePath().isEmpty()) {
2332 SkDebugf("reading resources from %s\n", GetResourcePath().c_str());
epoger@google.comb0f8b432013-04-10 18:46:25 +00002333 }
robertphillips@google.com8570b5c2012-03-20 17:40:58 +00002334 }
2335
epoger@google.com310478e2013-04-03 18:00:39 +00002336 int gmsRun = 0;
reed@google.comae7b8f32012-10-18 21:30:57 +00002337 int gmIndex = -1;
2338 SkString moduloStr;
2339
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002340 if (!FLAGS_dryRun) {
2341 // If we will be writing out files, prepare subdirectories.
2342 if (FLAGS_writePath.count() == 1) {
2343 if (!prepare_subdirectories(FLAGS_writePath[0], gmmain.fUseFileHierarchy,
2344 configs, pdfRasterizers)) {
2345 return -1;
2346 }
2347 }
2348 if (NULL != gmmain.fMismatchPath) {
2349 if (!prepare_subdirectories(gmmain.fMismatchPath, gmmain.fUseFileHierarchy,
2350 configs, pdfRasterizers)) {
2351 return -1;
2352 }
2353 }
2354 if (NULL != gmmain.fMissingExpectationsPath) {
2355 if (!prepare_subdirectories(gmmain.fMissingExpectationsPath, gmmain.fUseFileHierarchy,
2356 configs, pdfRasterizers)) {
2357 return -1;
2358 }
epoger@google.come8ebeb12012-10-29 16:42:11 +00002359 }
epoger@google.comfdea3252013-05-02 18:24:03 +00002360 }
bsalomon@google.com7361f542012-04-19 19:15:35 +00002361 Iter iter;
2362 GM* gm;
reed@android.com00dae862009-06-10 15:38:48 +00002363 while ((gm = iter.next()) != NULL) {
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +00002364 if (FLAGS_forcePerspectiveMatrix) {
2365 SkMatrix perspective;
2366 perspective.setIdentity();
2367 perspective.setPerspY(SkScalarDiv(SK_Scalar1, SkIntToScalar(1000)));
2368 perspective.setSkewX(SkScalarDiv(SkIntToScalar(8),
2369 SkIntToScalar(25)));
2370
2371 gm->setStarterMatrix(perspective);
skia.committer@gmail.com65caeaf2013-09-27 07:01:29 +00002372 }
scroggo@google.com7fd2d702013-04-16 19:11:14 +00002373 SkAutoTDelete<GM> adgm(gm);
reed@google.comae7b8f32012-10-18 21:30:57 +00002374 ++gmIndex;
epoger@google.com82cb65b2012-10-29 18:59:17 +00002375 if (moduloRemainder >= 0) {
2376 if ((gmIndex % moduloDivisor) != moduloRemainder) {
reed@google.comae7b8f32012-10-18 21:30:57 +00002377 continue;
2378 }
epoger@google.com82cb65b2012-10-29 18:59:17 +00002379 moduloStr.printf("[%d.%d] ", gmIndex, moduloDivisor);
reed@google.comae7b8f32012-10-18 21:30:57 +00002380 }
2381
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00002382 const char* shortName = gm->getName();
sglez@google.com586db932013-07-24 17:24:23 +00002383
commit-bot@chromium.orga6f37e72013-08-30 15:52:46 +00002384 if (SkCommandLineFlags::ShouldSkip(FLAGS_match, shortName)) {
reed@google.comece2b022011-07-25 14:28:57 +00002385 continue;
2386 }
2387
epoger@google.com310478e2013-04-03 18:00:39 +00002388 gmsRun++;
tomhudson@google.com9875dd12011-04-25 15:49:53 +00002389 SkISize size = gm->getISize();
mtkleinafb43792014-08-19 15:55:55 -07002390 SkDebugf("%4dM %sdrawing... %s [%d %d]\n",
2391 sk_tools::getMaxResidentSetSizeMB(), moduloStr.c_str(), shortName,
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002392 size.width(), size.height());
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002393 if (!FLAGS_dryRun)
mtkleinafb43792014-08-19 15:55:55 -07002394 run_multiple_configs(gmmain, gm, configs, pdfRasterizers, tileGridReplayScales,
kkinnunen80549fc2014-06-30 06:36:31 -07002395 grFactory, gpuAPI);
reed@android.com00dae862009-06-10 15:38:48 +00002396 }
epoger@google.com310478e2013-04-03 18:00:39 +00002397
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002398 if (FLAGS_dryRun)
2399 return 0;
2400
epoger@google.com310478e2013-04-03 18:00:39 +00002401 SkTArray<SkString> modes;
2402 gmmain.GetRenderModesEncountered(modes);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00002403 int modeCount = modes.count();
2404
2405 // Now that we have run all the tests and thus know the full set of renderModes that we
2406 // tried to run, we can call RecordTestResults() to record the cases in which we skipped
2407 // ALL renderModes.
2408 // See http://skbug.com/1994 and https://codereview.chromium.org/129203002/
2409 int testCount = gmmain.fTestsSkippedOnAllRenderModes.count();
2410 for (int testNum = 0; testNum < testCount; ++testNum) {
2411 const SkString &shortNamePlusConfig = gmmain.fTestsSkippedOnAllRenderModes[testNum];
2412 for (int modeNum = 0; modeNum < modeCount; ++modeNum) {
2413 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
2414 modes[modeNum].c_str());
2415 }
2416 }
2417
epoger@google.comc8263e72013-04-10 12:17:34 +00002418 bool reportError = false;
2419 if (gmmain.NumSignificantErrors() > 0) {
2420 reportError = true;
2421 }
commit-bot@chromium.org85195482014-01-13 18:27:59 +00002422
2423 // We test every GM against every config, and for every raster config also test every mode.
2424 int rasterConfigs = 0;
2425 for (int i = 0; i < configs.count(); i++) {
2426 if (gRec[configs[i]].fBackend == kRaster_Backend) {
2427 rasterConfigs++;
2428 }
2429 }
2430 // For raster configs, we run all renderModes; for non-raster configs, just default renderMode
2431 const int expectedNumberOfTests = rasterConfigs * gmsRun * modeCount
2432 + (configs.count() - rasterConfigs) * gmsRun;
epoger@google.com310478e2013-04-03 18:00:39 +00002433
2434 // Output summary to stdout.
epoger@google.com51dbabe2013-04-10 15:24:53 +00002435 if (FLAGS_verbose) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002436 SkDebugf("Ran %d GMs\n", gmsRun);
2437 SkDebugf("... over %2d configs [%s]\n", configs.count(),
2438 list_all_config_names(configs).c_str());
2439 SkDebugf("... and %2d modes [%s]\n", modeCount, list_all(modes).c_str());
2440 SkDebugf("... so there should be a total of %d tests.\n", expectedNumberOfTests);
epoger@google.com51dbabe2013-04-10 15:24:53 +00002441 }
2442 gmmain.ListErrors(FLAGS_verbose);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002443
epoger@google.com07947d92013-04-11 15:41:02 +00002444 // TODO(epoger): Enable this check for Android, too, once we resolve
2445 // https://code.google.com/p/skia/issues/detail?id=1222
2446 // ('GM is unexpectedly skipping tests on Android')
2447#ifndef SK_BUILD_FOR_ANDROID
epoger@google.comc8263e72013-04-10 12:17:34 +00002448 if (expectedNumberOfTests != gmmain.fTestsRun) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002449 SkDebugf("expected %d tests, but ran or skipped %d tests\n",
2450 expectedNumberOfTests, gmmain.fTestsRun);
epoger@google.comc8263e72013-04-10 12:17:34 +00002451 reportError = true;
2452 }
2453#endif
2454
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002455 if (FLAGS_writeJsonSummaryPath.count() == 1) {
epoger@google.com76c913d2013-04-26 15:06:44 +00002456 Json::Value root = CreateJsonTree(
2457 gmmain.fJsonExpectedResults,
2458 gmmain.fJsonActualResults_Failed, gmmain.fJsonActualResults_FailureIgnored,
2459 gmmain.fJsonActualResults_NoComparison, gmmain.fJsonActualResults_Succeeded);
epoger@google.comee8a8e32012-12-18 19:13:49 +00002460 std::string jsonStdString = root.toStyledString();
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002461 SkFILEWStream stream(FLAGS_writeJsonSummaryPath[0]);
epoger@google.comee8a8e32012-12-18 19:13:49 +00002462 stream.write(jsonStdString.c_str(), jsonStdString.length());
2463 }
2464
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00002465#if SK_SUPPORT_GPU
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002466
robertphillips@google.com59552022012-08-31 13:07:37 +00002467#if GR_CACHE_STATS
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002468 for (int i = 0; i < configs.count(); i++) {
2469 ConfigData config = gRec[configs[i]];
2470
epoger@google.comb0f8b432013-04-10 18:46:25 +00002471 if (FLAGS_verbose && (kGPU_Backend == config.fBackend)) {
kkinnunen80549fc2014-06-30 06:36:31 -07002472 GrContext* gr = grFactory->get(config.fGLContextType, gpuAPI);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002473
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002474 SkDebugf("config: %s %x\n", config.fName, gr);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002475 gr->printCacheStats();
2476 }
2477 }
2478#endif
2479
commit-bot@chromium.org8065ec52014-03-11 15:57:40 +00002480#if GR_DUMP_FONT_CACHE
2481 for (int i = 0; i < configs.count(); i++) {
2482 ConfigData config = gRec[configs[i]];
2483
2484 if (kGPU_Backend == config.fBackend) {
kkinnunen80549fc2014-06-30 06:36:31 -07002485 GrContext* gr = grFactory->get(config.fGLContextType, gpuAPI);
commit-bot@chromium.org8065ec52014-03-11 15:57:40 +00002486
2487 gr->dumpFontCache();
2488 }
2489 }
2490#endif
2491
robertphillips@google.com977b9c82012-06-05 19:35:09 +00002492 delete grFactory;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00002493#endif
robertphillips@google.com977b9c82012-06-05 19:35:09 +00002494 SkGraphics::Term();
2495
epoger@google.comc8263e72013-04-10 12:17:34 +00002496 return (reportError) ? -1 : 0;
reed@android.com00dae862009-06-10 15:38:48 +00002497}
caryclark@google.com5987f582012-10-02 18:33:14 +00002498
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002499void GMMain::installFilter(SkCanvas* canvas) {
2500 if (FLAGS_forceBWtext) {
2501 canvas->setDrawFilter(SkNEW(BWTextDrawFilter))->unref();
2502 }
2503}
2504
borenet@google.com7158e6a2012-11-01 17:43:44 +00002505#if !defined(SK_BUILD_FOR_IOS) && !defined(SK_BUILD_FOR_NACL)
caryclark@google.com5987f582012-10-02 18:33:14 +00002506int main(int argc, char * const argv[]) {
2507 return tool_main(argc, (char**) argv);
2508}
2509#endif