blob: b8c8891471b60175820d30f34211ef092891bbb9 [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"
robertphillips8c508b42014-12-11 13:10:23 -080038#include "SkMultiPictureDraw.h"
epoger@google.come8ebeb12012-10-29 16:42:11 +000039#include "SkOSFile.h"
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +000040#include "SkPDFRasterizer.h"
tomhudson@google.com9875dd12011-04-25 15:49:53 +000041#include "SkPicture.h"
robertphillips@google.com770963f2014-04-18 18:04:41 +000042#include "SkPictureRecorder.h"
robertphillips@google.com977b9c82012-06-05 19:35:09 +000043#include "SkRefCnt.h"
commit-bot@chromium.org5e009892013-10-14 13:42:12 +000044#include "SkScalar.h"
scroggo@google.com72c96722012-06-06 21:07:10 +000045#include "SkStream.h"
epoger@google.comf711f322013-10-18 14:55:47 +000046#include "SkString.h"
reed@google.com11db6fa2014-02-04 15:30:57 +000047#include "SkSurface.h"
bsalomon@google.com2a48c3a2012-08-03 14:54:45 +000048#include "SkTArray.h"
epoger@google.com310478e2013-04-03 18:00:39 +000049#include "SkTDict.h"
reed@google.com07700442010-12-20 19:46:07 +000050
commit-bot@chromium.org515dcd32013-08-28 14:17:03 +000051#ifdef SK_DEBUG
52static const bool kDebugOnly = true;
commit-bot@chromium.org8065ec52014-03-11 15:57:40 +000053#define GR_DUMP_FONT_CACHE 0
commit-bot@chromium.org515dcd32013-08-28 14:17:03 +000054#else
55static const bool kDebugOnly = false;
56#endif
57
epoger@google.comed5eb4e2013-07-23 17:56:20 +000058__SK_FORCE_IMAGE_DECODER_LINKING;
59
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000060#if SK_SUPPORT_GPU
61#include "GrContextFactory.h"
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000062#include "SkGpuDevice.h"
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000063typedef GrContextFactory::GLContextType GLContextType;
epoger@google.com6f6568b2013-03-22 17:29:46 +000064#define DEFAULT_CACHE_VALUE -1
65static int gGpuCacheSizeBytes;
66static int gGpuCacheSizeCount;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000067#else
epoger@google.com80724df2013-03-21 13:49:54 +000068class GrContextFactory;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000069class GrContext;
bsalomon@google.com123ac1d2013-03-28 19:18:12 +000070class GrSurface;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000071typedef int GLContextType;
kkinnunen80549fc2014-06-30 06:36:31 -070072typedef int GrGLStandard;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000073#endif
74
epoger@google.com76c913d2013-04-26 15:06:44 +000075#define DEBUGFAIL_SEE_STDERR SkDEBUGFAIL("see stderr for message")
76
epoger@google.come3cc2eb2012-01-18 20:11:13 +000077// Until we resolve http://code.google.com/p/skia/issues/detail?id=455 ,
78// stop writing out XPS-format image baselines in gm.
79#undef SK_SUPPORT_XPS
bungeman@google.comb29c8832011-10-10 13:19:10 +000080#ifdef SK_SUPPORT_XPS
81 #include "SkXPSDevice.h"
82#endif
83
reed@google.com46cce912011-06-29 12:54:46 +000084#ifdef SK_BUILD_FOR_MAC
85 #include "SkCGUtils.h"
reed@google.com46cce912011-06-29 12:54:46 +000086#endif
87
reed@android.com00dae862009-06-10 15:38:48 +000088using namespace skiagm;
89
reed@android.com00dae862009-06-10 15:38:48 +000090class Iter {
91public:
92 Iter() {
bsalomon@google.com39149582011-06-13 21:55:32 +000093 this->reset();
94 }
95
96 void reset() {
reed@android.comdd0ac282009-06-20 02:38:16 +000097 fReg = GMRegistry::Head();
reed@android.com00dae862009-06-10 15:38:48 +000098 }
reed@google.comd4dfd102011-01-18 21:05:42 +000099
reed@android.comdd0ac282009-06-20 02:38:16 +0000100 GM* next() {
reed@android.com00dae862009-06-10 15:38:48 +0000101 if (fReg) {
reed@android.comdd0ac282009-06-20 02:38:16 +0000102 GMRegistry::Factory fact = fReg->factory();
reed@android.com00dae862009-06-10 15:38:48 +0000103 fReg = fReg->next();
reed@android.comdd0ac282009-06-20 02:38:16 +0000104 return fact(0);
reed@android.com00dae862009-06-10 15:38:48 +0000105 }
106 return NULL;
107 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000108
reed@android.com00dae862009-06-10 15:38:48 +0000109 static int Count() {
reed@android.comdd0ac282009-06-20 02:38:16 +0000110 const GMRegistry* reg = GMRegistry::Head();
reed@android.com00dae862009-06-10 15:38:48 +0000111 int count = 0;
112 while (reg) {
113 count += 1;
114 reg = reg->next();
115 }
116 return count;
117 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000118
reed@android.com00dae862009-06-10 15:38:48 +0000119private:
120 const GMRegistry* fReg;
121};
122
epoger@google.comce057fe2013-05-14 15:17:46 +0000123// TODO(epoger): Right now, various places in this code assume that all the
124// image files read/written by GM use this file extension.
125// Search for references to this constant to find these assumptions.
126const static char kPNG_FileExtension[] = "png";
127
vandebo@chromium.org686abdf2011-02-03 23:00:40 +0000128enum Backend {
junov@chromium.org3cb834b2012-12-13 16:39:53 +0000129 kRaster_Backend,
130 kGPU_Backend,
131 kPDF_Backend,
132 kXPS_Backend,
133};
134
135enum BbhType {
136 kNone_BbhType,
137 kRTree_BbhType,
138 kTileGrid_BbhType,
vandebo@chromium.org686abdf2011-02-03 23:00:40 +0000139};
140
bsalomon@google.com7361f542012-04-19 19:15:35 +0000141enum ConfigFlags {
142 kNone_ConfigFlag = 0x0,
143 /* Write GM images if a write path is provided. */
144 kWrite_ConfigFlag = 0x1,
epoger@google.comf28dd8a2012-10-25 16:27:34 +0000145 /* Read reference GM images if a read path is provided. */
bsalomon@google.com7361f542012-04-19 19:15:35 +0000146 kRead_ConfigFlag = 0x2,
147 kRW_ConfigFlag = (kWrite_ConfigFlag | kRead_ConfigFlag),
jvanverth4736e142014-11-07 07:12:46 -0800148 /* Use distance fields for rendering text */
149 kDFText_ConfigFlag = 0x4,
150 kRWDFT_ConfigFlag = (kRW_ConfigFlag | kDFText_ConfigFlag),
bsalomon@google.com7361f542012-04-19 19:15:35 +0000151};
152
tomhudson@google.com9875dd12011-04-25 15:49:53 +0000153struct ConfigData {
reedddd014e2014-06-05 08:51:20 -0700154 SkColorType fColorType;
bsalomon@google.com7361f542012-04-19 19:15:35 +0000155 Backend fBackend;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +0000156 GLContextType fGLContextType; // GPU backend only
bsalomon@google.com7361f542012-04-19 19:15:35 +0000157 int fSampleCnt; // GPU backend only
158 ConfigFlags fFlags;
159 const char* fName;
bsalomon@google.com4c75f242013-03-19 18:58:43 +0000160 bool fRunByDefault;
tomhudson@google.com9875dd12011-04-25 15:49:53 +0000161};
162
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000163struct PDFRasterizerData {
164 bool (*fRasterizerFunction)(SkStream*, SkBitmap*);
165 const char* fName;
166 bool fRunByDefault;
167};
168
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000169class BWTextDrawFilter : public SkDrawFilter {
170public:
reed@google.com971aca72012-11-26 20:26:54 +0000171 virtual bool filter(SkPaint*, Type) SK_OVERRIDE;
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000172};
reed@google.com971aca72012-11-26 20:26:54 +0000173bool BWTextDrawFilter::filter(SkPaint* p, Type t) {
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000174 if (kText_Type == t) {
175 p->setAntiAlias(false);
176 }
reed@google.com971aca72012-11-26 20:26:54 +0000177 return true;
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000178}
179
scroggo@google.com565254b2012-06-28 15:41:32 +0000180struct PipeFlagComboData {
181 const char* name;
182 uint32_t flags;
183};
184
185static PipeFlagComboData gPipeWritingFlagCombos[] = {
186 { "", 0 },
187 { " cross-process", SkGPipeWriter::kCrossProcess_Flag },
scroggob3c0f482012-07-02 19:07:57 +0000188 { " cross-process, shared address", SkGPipeWriter::kCrossProcess_Flag
scroggo@google.com15011ee2012-07-26 20:03:32 +0000189 | SkGPipeWriter::kSharedAddressSpace_Flag }
scroggo@google.com565254b2012-06-28 15:41:32 +0000190};
191
commit-bot@chromium.org608ea652013-10-03 19:29:21 +0000192static SkData* encode_to_dct_data(size_t* pixelRefOffset, const SkBitmap& bitmap);
edisonn@google.com73a7ea32013-11-11 20:55:15 +0000193DECLARE_int32(pdfRasterDpi);
edisonn@google.comd9dfa182013-04-24 13:01:01 +0000194
epoger@google.com5079d2c2013-04-12 14:11:21 +0000195const static ErrorCombination kDefaultIgnorableErrorTypes = ErrorCombination()
196 .plus(kMissingExpectations_ErrorType)
197 .plus(kIntentionallySkipped_ErrorType);
198
epoger@google.comde961632012-10-26 18:56:36 +0000199class GMMain {
200public:
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000201 GMMain() : fUseFileHierarchy(false), fWriteChecksumBasedFilenames(false),
202 fIgnorableErrorTypes(kDefaultIgnorableErrorTypes),
epoger@google.com5f995452013-06-21 18:16:47 +0000203 fMismatchPath(NULL), fMissingExpectationsPath(NULL), fTestsRun(0),
204 fRenderModesEncountered(1) {}
epoger@google.come8ebeb12012-10-29 16:42:11 +0000205
epoger@google.com659c8c02013-05-21 15:45:45 +0000206 /**
207 * Assemble shortNamePlusConfig from (surprise!) shortName and configName.
208 *
209 * The method for doing so depends on whether we are using hierarchical naming.
210 * For example, shortName "selftest1" and configName "8888" could be assembled into
211 * either "selftest1_8888" or "8888/selftest1".
212 */
213 SkString make_shortname_plus_config(const char *shortName, const char *configName) {
epoger@google.come8ebeb12012-10-29 16:42:11 +0000214 SkString name;
epoger@google.com57f7abc2012-11-13 03:41:55 +0000215 if (0 == strlen(configName)) {
216 name.append(shortName);
217 } else if (fUseFileHierarchy) {
epoger@google.come8ebeb12012-10-29 16:42:11 +0000218 name.appendf("%s%c%s", configName, SkPATH_SEPARATOR, shortName);
219 } else {
220 name.appendf("%s_%s", shortName, configName);
221 }
epoger@google.comde961632012-10-26 18:56:36 +0000222 return name;
223 }
224
epoger@google.com659c8c02013-05-21 15:45:45 +0000225 /**
226 * Assemble filename, suitable for writing out the results of a particular test.
227 */
228 SkString make_filename(const char *path,
229 const char *shortName,
230 const char *configName,
231 const char *renderModeDescriptor,
232 const char *suffix) {
233 SkString filename = make_shortname_plus_config(shortName, configName);
234 filename.append(renderModeDescriptor);
235 filename.appendUnichar('.');
236 filename.append(suffix);
tfarinaa8e2e152014-07-28 19:26:58 -0700237 return SkOSPath::Join(path, filename.c_str());
epoger@google.com659c8c02013-05-21 15:45:45 +0000238 }
239
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000240 /**
241 * Assemble filename suitable for writing out an SkBitmap.
242 */
robertphillipsed313432014-12-16 09:31:42 -0800243 SkString makeBitmapFilename(const char *path,
244 const char *shortName,
245 const char *configName,
246 const char *renderModeDescriptor,
247 const GmResultDigest &bitmapDigest) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000248 if (fWriteChecksumBasedFilenames) {
249 SkString filename;
250 filename.append(bitmapDigest.getHashType());
251 filename.appendUnichar('_');
252 filename.append(shortName);
253 filename.appendUnichar('_');
254 filename.append(bitmapDigest.getDigestValue());
255 filename.appendUnichar('.');
256 filename.append(kPNG_FileExtension);
tfarinaa8e2e152014-07-28 19:26:58 -0700257 return SkOSPath::Join(path, filename.c_str());
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000258 } else {
259 return make_filename(path, shortName, configName, renderModeDescriptor,
260 kPNG_FileExtension);
261 }
262 }
263
epoger@google.com5f6a0072013-01-31 16:30:55 +0000264 /* since PNG insists on unpremultiplying our alpha, we take no
265 precision chances and force all pixels to be 100% opaque,
266 otherwise on compare we may not get a perfect match.
267 */
268 static void force_all_opaque(const SkBitmap& bitmap) {
commit-bot@chromium.orgdac52252014-02-17 21:21:46 +0000269 SkColorType colorType = bitmap.colorType();
270 switch (colorType) {
commit-bot@chromium.org28fcae22014-04-11 17:15:40 +0000271 case kN32_SkColorType:
epoger@google.com5f6a0072013-01-31 16:30:55 +0000272 force_all_opaque_8888(bitmap);
273 break;
commit-bot@chromium.orgdac52252014-02-17 21:21:46 +0000274 case kRGB_565_SkColorType:
epoger@google.com5f6a0072013-01-31 16:30:55 +0000275 // nothing to do here; 565 bitmaps are inherently opaque
276 break;
277 default:
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000278 SkDebugf("unsupported bitmap colorType %d\n", colorType);
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000279 DEBUGFAIL_SEE_STDERR;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000280 }
281 }
282
283 static void force_all_opaque_8888(const SkBitmap& bitmap) {
284 SkAutoLockPixels lock(bitmap);
285 for (int y = 0; y < bitmap.height(); y++) {
286 for (int x = 0; x < bitmap.width(); x++) {
287 *bitmap.getAddr32(x, y) |= (SK_A32_MASK << SK_A32_SHIFT);
288 }
289 }
290 }
291
robertphillipsed313432014-12-16 09:31:42 -0800292 static ErrorCombination WriteBitmap(const SkString& path, const SkBitmap& bitmap) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000293 // TODO(epoger): Now that we have removed force_all_opaque()
294 // from this method, we should be able to get rid of the
295 // transformation to 8888 format also.
296 SkBitmap copy;
commit-bot@chromium.org28fcae22014-04-11 17:15:40 +0000297 bitmap.copyTo(&copy, kN32_SkColorType);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000298 if (!SkImageEncoder::EncodeFile(path.c_str(), copy,
299 SkImageEncoder::kPNG_Type,
300 100)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000301 SkDebugf("FAILED to write bitmap: %s\n", path.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000302 return ErrorCombination(kWritingReferenceImage_ErrorType);
303 }
304 return kEmpty_ErrorCombination;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000305 }
306
epoger@google.com6f6568b2013-03-22 17:29:46 +0000307 /**
epoger@google.com310478e2013-04-03 18:00:39 +0000308 * Add all render modes encountered thus far to the "modes" array.
epoger@google.com6f6568b2013-03-22 17:29:46 +0000309 */
epoger@google.com310478e2013-04-03 18:00:39 +0000310 void GetRenderModesEncountered(SkTArray<SkString> &modes) {
311 SkTDict<int>::Iter iter(this->fRenderModesEncountered);
312 const char* mode;
313 while ((mode = iter.next(NULL)) != NULL) {
314 SkString modeAsString = SkString(mode);
315 // TODO(epoger): It seems a bit silly that all of these modes were
316 // recorded with a leading "-" which we have to remove here
317 // (except for mode "", which means plain old original mode).
318 // But that's how renderModeDescriptor has been passed into
319 // compare_test_results_to_reference_bitmap() historically,
320 // and changing that now may affect other parts of our code.
321 if (modeAsString.startsWith("-")) {
322 modeAsString.remove(0, 1);
epoger@google.com310478e2013-04-03 18:00:39 +0000323 }
commit-bot@chromium.org85195482014-01-13 18:27:59 +0000324 modes.push_back(modeAsString);
epoger@google.com310478e2013-04-03 18:00:39 +0000325 }
326 }
327
328 /**
epoger@google.com3a882dd2013-10-07 18:55:09 +0000329 * Returns true if failures on this test should be ignored.
330 */
robertphillipsed313432014-12-16 09:31:42 -0800331 bool shouldIgnoreTest(const char *name) const {
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +0000332 for (int i = 0; i < fIgnorableTestNames.count(); i++) {
333 if (fIgnorableTestNames[i].equals(name)) {
epoger@google.com3a882dd2013-10-07 18:55:09 +0000334 return true;
335 }
336 }
337 return false;
338 }
339
340 /**
commit-bot@chromium.org85195482014-01-13 18:27:59 +0000341 * Calls RecordTestResults to record that we skipped a test.
342 *
343 * Depending on the backend, this may mean that we skipped a single rendermode, or all
344 * rendermodes; see http://skbug.com/1994 and https://codereview.chromium.org/129203002/
345 */
346 void RecordSkippedTest(const SkString& shortNamePlusConfig,
347 const char renderModeDescriptor [], Backend backend) {
348 if (kRaster_Backend == backend) {
349 // Skipping a test on kRaster_Backend means that we will skip ALL renderModes
350 // (as opposed to other backends, on which we only run the default renderMode).
351 //
352 // We cannot call RecordTestResults yet, because we won't know the full set of
353 // renderModes until we have run all tests.
354 fTestsSkippedOnAllRenderModes.push_back(shortNamePlusConfig);
355 } else {
356 this->RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
357 renderModeDescriptor);
358 }
359 }
360
361 /**
epoger@google.com310478e2013-04-03 18:00:39 +0000362 * Records the results of this test in fTestsRun and fFailedTests.
363 *
364 * We even record successes, and errors that we regard as
365 * "ignorable"; we can filter them out later.
366 */
epoger@google.com659c8c02013-05-21 15:45:45 +0000367 void RecordTestResults(const ErrorCombination& errorCombination,
368 const SkString& shortNamePlusConfig,
epoger@google.com310478e2013-04-03 18:00:39 +0000369 const char renderModeDescriptor []) {
370 // Things to do regardless of errorCombination.
371 fTestsRun++;
372 int renderModeCount = 0;
373 this->fRenderModesEncountered.find(renderModeDescriptor, &renderModeCount);
374 renderModeCount++;
375 this->fRenderModesEncountered.set(renderModeDescriptor, renderModeCount);
376
epoger@google.com6f6568b2013-03-22 17:29:46 +0000377 if (errorCombination.isEmpty()) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000378 return;
epoger@google.comeb066362013-03-08 09:39:36 +0000379 }
380
epoger@google.com310478e2013-04-03 18:00:39 +0000381 // Things to do only if there is some error condition.
epoger@google.com659c8c02013-05-21 15:45:45 +0000382 SkString fullName = shortNamePlusConfig;
epoger@google.comcaac3db2013-04-04 19:23:11 +0000383 fullName.append(renderModeDescriptor);
epoger@google.com310478e2013-04-03 18:00:39 +0000384 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
385 ErrorType type = static_cast<ErrorType>(typeInt);
386 if (errorCombination.includes(type)) {
387 fFailedTests[type].push_back(fullName);
epoger@google.comf60494b2013-04-03 17:02:53 +0000388 }
epoger@google.comf60494b2013-04-03 17:02:53 +0000389 }
epoger@google.comf60494b2013-04-03 17:02:53 +0000390 }
391
epoger@google.com310478e2013-04-03 18:00:39 +0000392 /**
393 * Return the number of significant (non-ignorable) errors we have
394 * encountered so far.
395 */
396 int NumSignificantErrors() {
397 int significantErrors = 0;
398 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
399 ErrorType type = static_cast<ErrorType>(typeInt);
epoger@google.com5079d2c2013-04-12 14:11:21 +0000400 if (!fIgnorableErrorTypes.includes(type)) {
epoger@google.com310478e2013-04-03 18:00:39 +0000401 significantErrors += fFailedTests[type].count();
402 }
403 }
404 return significantErrors;
405 }
406
407 /**
epoger@google.com51dbabe2013-04-10 15:24:53 +0000408 * Display the summary of results with this ErrorType.
409 *
410 * @param type which ErrorType
411 * @param verbose whether to be all verbose about it
epoger@google.com310478e2013-04-03 18:00:39 +0000412 */
epoger@google.com51dbabe2013-04-10 15:24:53 +0000413 void DisplayResultTypeSummary(ErrorType type, bool verbose) {
epoger@google.com5079d2c2013-04-12 14:11:21 +0000414 bool isIgnorableType = fIgnorableErrorTypes.includes(type);
epoger@google.com51dbabe2013-04-10 15:24:53 +0000415
416 SkString line;
417 if (isIgnorableType) {
418 line.append("[ ] ");
419 } else {
420 line.append("[*] ");
421 }
422
423 SkTArray<SkString> *failedTestsOfThisType = &fFailedTests[type];
424 int count = failedTestsOfThisType->count();
425 line.appendf("%d %s", count, getErrorTypeName(type));
426 if (!isIgnorableType || verbose) {
427 line.append(":");
428 for (int i = 0; i < count; ++i) {
429 line.append(" ");
430 line.append((*failedTestsOfThisType)[i]);
431 }
432 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000433 SkDebugf("%s\n", line.c_str());
epoger@google.com51dbabe2013-04-10 15:24:53 +0000434 }
435
436 /**
437 * List contents of fFailedTests to stdout.
438 *
439 * @param verbose whether to be all verbose about it
440 */
441 void ListErrors(bool verbose) {
epoger@google.com310478e2013-04-03 18:00:39 +0000442 // First, print a single summary line.
443 SkString summary;
444 summary.appendf("Ran %d tests:", fTestsRun);
445 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
446 ErrorType type = static_cast<ErrorType>(typeInt);
447 summary.appendf(" %s=%d", getErrorTypeName(type), fFailedTests[type].count());
448 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000449 SkDebugf("%s\n", summary.c_str());
epoger@google.com310478e2013-04-03 18:00:39 +0000450
451 // Now, for each failure type, list the tests that failed that way.
452 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
epoger@google.com51dbabe2013-04-10 15:24:53 +0000453 this->DisplayResultTypeSummary(static_cast<ErrorType>(typeInt), verbose);
epoger@google.com310478e2013-04-03 18:00:39 +0000454 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000455 SkDebugf("(results marked with [*] will cause nonzero return value)\n");
epoger@google.com310478e2013-04-03 18:00:39 +0000456 }
457
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000458 static ErrorCombination write_document(const SkString& path, SkStreamAsset* asset) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000459 SkFILEWStream stream(path.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000460 if (!stream.writeStream(asset, asset->getLength())) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000461 SkDebugf("FAILED to write document: %s\n", path.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000462 return ErrorCombination(kWritingReferenceImage_ErrorType);
463 }
464 return kEmpty_ErrorCombination;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000465 }
466
epoger@google.com37269602013-01-19 04:21:27 +0000467 /**
epoger@google.com5f6a0072013-01-31 16:30:55 +0000468 * Prepare an SkBitmap to render a GM into.
469 *
470 * After you've rendered the GM into the SkBitmap, you must call
471 * complete_bitmap()!
472 *
473 * @todo thudson 22 April 2011 - could refactor this to take in
474 * a factory to generate the context, always call readPixels()
475 * (logically a noop for rasters, if wasted time), and thus collapse the
476 * GPU special case and also let this be used for SkPicture testing.
477 */
robertphillips8c508b42014-12-11 13:10:23 -0800478 static void setup_bitmap(const ConfigData& gRec, const SkISize& size,
epoger@google.com5f6a0072013-01-31 16:30:55 +0000479 SkBitmap* bitmap) {
reedddd014e2014-06-05 08:51:20 -0700480 bitmap->allocPixels(SkImageInfo::Make(size.width(), size.height(),
481 gRec.fColorType, kPremul_SkAlphaType));
epoger@google.com5f6a0072013-01-31 16:30:55 +0000482 bitmap->eraseColor(SK_ColorTRANSPARENT);
483 }
484
485 /**
486 * Any finalization steps we need to perform on the SkBitmap after
487 * we have rendered the GM into it.
epoger@google.com37269602013-01-19 04:21:27 +0000488 *
489 * It's too bad that we are throwing away alpha channel data
490 * we could otherwise be examining, but this had always been happening
491 * before... it was buried within the compare() method at
492 * https://code.google.com/p/skia/source/browse/trunk/gm/gmmain.cpp?r=7289#305 .
493 *
494 * Apparently we need this, at least for bitmaps that are either:
495 * (a) destined to be written out as PNG files, or
496 * (b) compared against bitmaps read in from PNG files
497 * for the reasons described just above the force_all_opaque() method.
498 *
499 * Neglecting to do this led to the difficult-to-diagnose
500 * http://code.google.com/p/skia/issues/detail?id=1079 ('gm generating
501 * spurious pixel_error messages as of r7258')
502 *
503 * TODO(epoger): Come up with a better solution that allows us to
504 * compare full pixel data, including alpha channel, while still being
505 * robust in the face of transformations to/from PNG files.
506 * Options include:
507 *
508 * 1. Continue to call force_all_opaque(), but ONLY for bitmaps that
509 * will be written to, or compared against, PNG files.
510 * PRO: Preserve/compare alpha channel info for the non-PNG cases
511 * (comparing different renderModes in-memory)
epoger@google.com908f5832013-04-12 02:23:55 +0000512 * CON: The bitmaps (and hash digests) for these non-PNG cases would be
epoger@google.com37269602013-01-19 04:21:27 +0000513 * different than those for the PNG-compared cases, and in the
514 * case of a failed renderMode comparison, how would we write the
515 * image to disk for examination?
516 *
epoger@google.com908f5832013-04-12 02:23:55 +0000517 * 2. Always compute image hash digests from PNG format (either
epoger@google.com37269602013-01-19 04:21:27 +0000518 * directly from the the bytes of a PNG file, or capturing the
519 * bytes we would have written to disk if we were writing the
520 * bitmap out as a PNG).
521 * PRO: I think this would allow us to never force opaque, and to
522 * the extent that alpha channel data can be preserved in a PNG
523 * file, we could observe it.
epoger@google.com908f5832013-04-12 02:23:55 +0000524 * CON: If we read a bitmap from disk, we need to take its hash digest
epoger@google.com37269602013-01-19 04:21:27 +0000525 * from the source PNG (we can't compute it from the bitmap we
526 * read out of the PNG, because we will have already premultiplied
527 * the alpha).
528 * CON: Seems wasteful to convert a bitmap to PNG format just to take
epoger@google.com908f5832013-04-12 02:23:55 +0000529 * its hash digest. (Although we're wasting lots of effort already
epoger@google.com37269602013-01-19 04:21:27 +0000530 * calling force_all_opaque().)
531 *
532 * 3. Make the alpha premultiply/unpremultiply routines 100% consistent,
533 * so we can transform images back and forth without fear of off-by-one
534 * errors.
535 * CON: Math is hard.
536 *
537 * 4. Perform a "close enough" comparison of bitmaps (+/- 1 bit in each
538 * channel), rather than demanding absolute equality.
epoger@google.com908f5832013-04-12 02:23:55 +0000539 * CON: Can't do this with hash digests.
epoger@google.com37269602013-01-19 04:21:27 +0000540 */
epoger@google.com5f6a0072013-01-31 16:30:55 +0000541 static void complete_bitmap(SkBitmap* bitmap) {
542 force_all_opaque(*bitmap);
epoger@google.comde961632012-10-26 18:56:36 +0000543 }
544
robertphillips8c508b42014-12-11 13:10:23 -0800545 static void InstallFilter(SkCanvas* canvas);
epoger@google.comde961632012-10-26 18:56:36 +0000546
reed@google.comaef73612012-11-16 13:41:45 +0000547 static void invokeGM(GM* gm, SkCanvas* canvas, bool isPDF, bool isDeferred) {
epoger@google.comde961632012-10-26 18:56:36 +0000548 SkAutoCanvasRestore acr(canvas, true);
549
550 if (!isPDF) {
551 canvas->concat(gm->getInitialTransform());
552 }
robertphillips8c508b42014-12-11 13:10:23 -0800553 InstallFilter(canvas);
reed@google.comaef73612012-11-16 13:41:45 +0000554 gm->setCanvasIsDeferred(isDeferred);
epoger@google.comde961632012-10-26 18:56:36 +0000555 gm->draw(canvas);
556 canvas->setDrawFilter(NULL);
557 }
558
epoger@google.com6f6568b2013-03-22 17:29:46 +0000559 static ErrorCombination generate_image(GM* gm, const ConfigData& gRec,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +0000560 GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +0000561 SkBitmap* bitmap,
562 bool deferred) {
robertphillips8c508b42014-12-11 13:10:23 -0800563 const SkISize size (gm->getISize());
epoger@google.comde961632012-10-26 18:56:36 +0000564
robertphillips8c508b42014-12-11 13:10:23 -0800565 SkAutoTUnref<SkSurface> surface(CreateSurface(gRec, size, gpuTarget));
epoger@google.comde961632012-10-26 18:56:36 +0000566 SkAutoTUnref<SkCanvas> canvas;
567
robertphillips8c508b42014-12-11 13:10:23 -0800568 if (deferred) {
569 canvas.reset(SkDeferredCanvas::Create(surface));
570 } else {
571 canvas.reset(SkRef(surface->getCanvas()));
epoger@google.comde961632012-10-26 18:56:36 +0000572 }
robertphillips8c508b42014-12-11 13:10:23 -0800573 invokeGM(gm, canvas, false, deferred);
574 canvas->flush();
575
576 setup_bitmap(gRec, size, bitmap);
577 surface->readPixels(bitmap->info(), bitmap->getPixels(), bitmap->rowBytes(), 0, 0);
epoger@google.com5f6a0072013-01-31 16:30:55 +0000578 complete_bitmap(bitmap);
epoger@google.com6f6568b2013-03-22 17:29:46 +0000579 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +0000580 }
581
robertphillips8c508b42014-12-11 13:10:23 -0800582 static void DrawPictureToSurface(SkSurface* surf,
583 const SkPicture* pict,
584 SkScalar scale,
585 bool tile,
586 bool useMPD) {
587 SkASSERT(surf->width() == pict->cullRect().width() &&
588 surf->height() == pict->cullRect().height());
589
590 if (tile) {
591 SkMultiPictureDraw mpd;
592 SkTDArray<SkSurface*> surfaces;
593
594 const SkISize tileSize = SkISize::Make(16, 16);
595
596 const SkImageInfo ii = surf->getCanvas()->imageInfo().makeWH(tileSize.width(),
597 tileSize.height());
598
599 for (int tileY = 0; tileY < pict->cullRect().height(); tileY += tileSize.height()) {
600 for (int tileX = 0; tileX < pict->cullRect().width(); tileX += tileSize.width()) {
601
602 *surfaces.append() = surf->getCanvas()->newSurface(ii);
603
604 InstallFilter(surfaces.top()->getCanvas());
605
606 SkMatrix matrix;
607 matrix.setTranslate(-pict->cullRect().fLeft, -pict->cullRect().fTop);
608 matrix.postTranslate(-SkIntToScalar(tileX), -SkIntToScalar(tileY));
609 matrix.postScale(scale, scale);
610
611 if (useMPD) {
612 mpd.add(surfaces.top()->getCanvas(), pict, &matrix, NULL);
613 } else {
614 surfaces.top()->getCanvas()->drawPicture(pict, &matrix, NULL);
615 }
616 }
617 }
618
619 mpd.draw();
620
621 SkPaint gatherPaint;
622 gatherPaint.setXfermodeMode(SkXfermode::kSrc_Mode);
623
624 int tileIndex = 0;
625 for (int tileY = 0; tileY < pict->cullRect().height(); tileY += tileSize.height()) {
626 for (int tileX = 0; tileX < pict->cullRect().width(); tileX += tileSize.width()) {
627 surf->getCanvas()->drawImage(surfaces[tileIndex]->newImageSnapshot(),
628 SkIntToScalar(tileX), SkIntToScalar(tileY),
629 &gatherPaint);
630 surfaces[tileIndex]->unref();
631 tileIndex++;
632 }
633 }
634 } else {
635 InstallFilter(surf->getCanvas());
636
637 SkMatrix matrix;
638 matrix.setTranslate(-pict->cullRect().fLeft, -pict->cullRect().fTop);
639 matrix.postScale(scale, scale);
640
641 if (useMPD) {
642 SkMultiPictureDraw mpd;
643 mpd.add(surf->getCanvas(), pict, &matrix, NULL);
644 mpd.draw();
645 } else {
646 surf->getCanvas()->drawPicture(pict, &matrix, NULL);
647 }
648 }
649 }
650
robertphillips478dd722014-12-16 08:25:55 -0800651 static void generate_image_from_picture(GM* gm, const ConfigData& config,
652 GrSurface* gpuTarget,
junov@chromium.orgc938c482012-12-19 15:24:38 +0000653 SkPicture* pict, SkBitmap* bitmap,
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000654 SkScalar scale = SK_Scalar1,
655 bool tile = false) {
robertphillips478dd722014-12-16 08:25:55 -0800656 const SkISize size = gm->getISize();
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000657
robertphillips478dd722014-12-16 08:25:55 -0800658 SkAutoTUnref<SkSurface> surf(CreateSurface(config, size, gpuTarget));
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000659
robertphillips8c508b42014-12-11 13:10:23 -0800660 DrawPictureToSurface(surf, pict, scale, tile, false);
robertphillips478dd722014-12-16 08:25:55 -0800661
662 setup_bitmap(config, size, bitmap);
663
664 surf->readPixels(bitmap->info(), bitmap->getPixels(), bitmap->rowBytes(), 0, 0);
665
robertphillips8c508b42014-12-11 13:10:23 -0800666 complete_bitmap(bitmap);
epoger@google.comde961632012-10-26 18:56:36 +0000667 }
668
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000669 static bool generate_pdf(GM* gm, SkDynamicMemoryWStream& pdf) {
epoger@google.comde961632012-10-26 18:56:36 +0000670#ifdef SK_SUPPORT_PDF
halcanary66b29a62015-01-06 15:13:49 -0800671 SkAutoTUnref<SkDocument> pdfDoc(
672 SkDocument::CreatePDF(&pdf, NULL, encode_to_dct_data,
673 SkIntToScalar(FLAGS_pdfRasterDpi)));
674 if (!pdfDoc) {
675 return false;
epoger@google.comde961632012-10-26 18:56:36 +0000676 }
halcanary66b29a62015-01-06 15:13:49 -0800677
678 SkCanvas* canvas = NULL;
679 canvas = pdfDoc->beginPage(gm->width(), gm->height());
680 canvas->concat(gm->getInitialTransform());
681
682 invokeGM(gm, canvas, true, false);
683
684 return pdfDoc->close();
685
686#else // SK_SUPPORT_PDF
687 return true; // Do not report failure if pdf is not supported.
commit-bot@chromium.org5e009892013-10-14 13:42:12 +0000688#endif // SK_SUPPORT_PDF
epoger@google.comde961632012-10-26 18:56:36 +0000689 }
690
691 static void generate_xps(GM* gm, SkDynamicMemoryWStream& xps) {
692#ifdef SK_SUPPORT_XPS
693 SkISize size = gm->getISize();
694
695 SkSize trimSize = SkSize::Make(SkIntToScalar(size.width()),
696 SkIntToScalar(size.height()));
697 static const SkScalar inchesPerMeter = SkScalarDiv(10000, 254);
698 static const SkScalar upm = 72 * inchesPerMeter;
699 SkVector unitsPerMeter = SkPoint::Make(upm, upm);
700 static const SkScalar ppm = 200 * inchesPerMeter;
701 SkVector pixelsPerMeter = SkPoint::Make(ppm, ppm);
702
703 SkXPSDevice* dev = new SkXPSDevice();
704 SkAutoUnref aur(dev);
705
706 SkCanvas c(dev);
707 dev->beginPortfolio(&xps);
708 dev->beginSheet(unitsPerMeter, pixelsPerMeter, trimSize);
reed@google.comaef73612012-11-16 13:41:45 +0000709 invokeGM(gm, &c, false, false);
epoger@google.comde961632012-10-26 18:56:36 +0000710 dev->endSheet();
711 dev->endPortfolio();
712
713#endif
714 }
715
epoger@google.com37269602013-01-19 04:21:27 +0000716 /**
epoger@google.com84a18022013-02-01 20:39:15 +0000717 * Log more detail about the mistmatch between expectedBitmap and
718 * actualBitmap.
719 */
720 void report_bitmap_diffs(const SkBitmap& expectedBitmap, const SkBitmap& actualBitmap,
721 const char *testName) {
722 const int expectedWidth = expectedBitmap.width();
723 const int expectedHeight = expectedBitmap.height();
724 const int width = actualBitmap.width();
725 const int height = actualBitmap.height();
726 if ((expectedWidth != width) || (expectedHeight != height)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000727 SkDebugf("---- %s: dimension mismatch -- expected [%d %d], actual [%d %d]\n",
728 testName, expectedWidth, expectedHeight, width, height);
epoger@google.com84a18022013-02-01 20:39:15 +0000729 return;
730 }
731
commit-bot@chromium.org28fcae22014-04-11 17:15:40 +0000732 if ((kN32_SkColorType != expectedBitmap.colorType()) ||
733 (kN32_SkColorType != actualBitmap.colorType())) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000734 SkDebugf("---- %s: not computing max per-channel pixel mismatch because non-8888\n",
735 testName);
epoger@google.com84a18022013-02-01 20:39:15 +0000736 return;
737 }
738
739 SkAutoLockPixels alp0(expectedBitmap);
740 SkAutoLockPixels alp1(actualBitmap);
741 int errR = 0;
742 int errG = 0;
743 int errB = 0;
744 int errA = 0;
745 int differingPixels = 0;
746
747 for (int y = 0; y < height; ++y) {
748 const SkPMColor* expectedPixelPtr = expectedBitmap.getAddr32(0, y);
749 const SkPMColor* actualPixelPtr = actualBitmap.getAddr32(0, y);
750 for (int x = 0; x < width; ++x) {
751 SkPMColor expectedPixel = *expectedPixelPtr++;
752 SkPMColor actualPixel = *actualPixelPtr++;
753 if (expectedPixel != actualPixel) {
754 differingPixels++;
755 errR = SkMax32(errR, SkAbs32((int)SkGetPackedR32(expectedPixel) -
756 (int)SkGetPackedR32(actualPixel)));
757 errG = SkMax32(errG, SkAbs32((int)SkGetPackedG32(expectedPixel) -
758 (int)SkGetPackedG32(actualPixel)));
759 errB = SkMax32(errB, SkAbs32((int)SkGetPackedB32(expectedPixel) -
760 (int)SkGetPackedB32(actualPixel)));
761 errA = SkMax32(errA, SkAbs32((int)SkGetPackedA32(expectedPixel) -
762 (int)SkGetPackedA32(actualPixel)));
763 }
764 }
765 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +0000766 SkDebugf("---- %s: %d (of %d) differing pixels, "
767 "max per-channel mismatch R=%d G=%d B=%d A=%d\n",
768 testName, differingPixels, width*height, errR, errG, errB, errA);
epoger@google.com84a18022013-02-01 20:39:15 +0000769 }
770
771 /**
epoger@google.com908f5832013-04-12 02:23:55 +0000772 * Compares actual hash digest to expectations, returning the set of errors
epoger@google.com6f6568b2013-03-22 17:29:46 +0000773 * (if any) that we saw along the way.
epoger@google.com37269602013-01-19 04:21:27 +0000774 *
775 * If fMismatchPath has been set, and there are pixel diffs, then the
776 * actual bitmap will be written out to a file within fMismatchPath.
epoger@google.com5f995452013-06-21 18:16:47 +0000777 * And similarly for fMissingExpectationsPath...
epoger@google.com37269602013-01-19 04:21:27 +0000778 *
779 * @param expectations what expectations to compare actualBitmap against
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000780 * @param actualBitmapAndDigest the SkBitmap we actually generated, and its GmResultDigest
epoger@google.com659c8c02013-05-21 15:45:45 +0000781 * @param shortName name of test, e.g. "selftest1"
782 * @param configName name of config, e.g. "8888"
epoger@google.com37269602013-01-19 04:21:27 +0000783 * @param renderModeDescriptor e.g., "-rtree", "-deferred"
784 * @param addToJsonSummary whether to add these results (both actual and
epoger@google.comcaac3db2013-04-04 19:23:11 +0000785 * expected) to the JSON summary. Regardless of this setting, if
786 * we find an image mismatch in this test, we will write these
787 * results to the JSON summary. (This is so that we will always
788 * report errors across rendering modes, such as pipe vs tiled.
789 * See https://codereview.chromium.org/13650002/ )
epoger@google.com37269602013-01-19 04:21:27 +0000790 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000791 ErrorCombination compare_to_expectations(Expectations expectations,
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000792 const BitmapAndDigest& actualBitmapAndDigest,
epoger@google.com659c8c02013-05-21 15:45:45 +0000793 const char *shortName, const char *configName,
794 const char *renderModeDescriptor,
epoger@google.comcaac3db2013-04-04 19:23:11 +0000795 bool addToJsonSummary) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000796 ErrorCombination errors;
epoger@google.com659c8c02013-05-21 15:45:45 +0000797 SkString shortNamePlusConfig = make_shortname_plus_config(shortName, configName);
798 SkString completeNameString(shortNamePlusConfig);
epoger@google.com37269602013-01-19 04:21:27 +0000799 completeNameString.append(renderModeDescriptor);
epoger@google.comce057fe2013-05-14 15:17:46 +0000800 completeNameString.append(".");
801 completeNameString.append(kPNG_FileExtension);
epoger@google.com37269602013-01-19 04:21:27 +0000802 const char* completeName = completeNameString.c_str();
epoger@google.comee8a8e32012-12-18 19:13:49 +0000803
epoger@google.com37269602013-01-19 04:21:27 +0000804 if (expectations.empty()) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000805 errors.add(kMissingExpectations_ErrorType);
epoger@google.com5f995452013-06-21 18:16:47 +0000806
807 // Write out the "actuals" for any tests without expectations, if we have
808 // been directed to do so.
809 if (fMissingExpectationsPath) {
robertphillipsed313432014-12-16 09:31:42 -0800810 SkString path = this->makeBitmapFilename(fMissingExpectationsPath, shortName,
811 configName, renderModeDescriptor,
812 actualBitmapAndDigest.fDigest);
813 WriteBitmap(path, actualBitmapAndDigest.fBitmap);
epoger@google.com5f995452013-06-21 18:16:47 +0000814 }
815
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000816 } else if (!expectations.match(actualBitmapAndDigest.fDigest)) {
epoger@google.comcaac3db2013-04-04 19:23:11 +0000817 addToJsonSummary = true;
818 // The error mode we record depends on whether this was running
819 // in a non-standard renderMode.
820 if ('\0' == *renderModeDescriptor) {
821 errors.add(kExpectationsMismatch_ErrorType);
822 } else {
823 errors.add(kRenderModeMismatch_ErrorType);
824 }
epoger@google.com84a18022013-02-01 20:39:15 +0000825
826 // Write out the "actuals" for any mismatches, if we have
827 // been directed to do so.
epoger@google.com37269602013-01-19 04:21:27 +0000828 if (fMismatchPath) {
robertphillipsed313432014-12-16 09:31:42 -0800829 SkString path = this->makeBitmapFilename(fMismatchPath, shortName, configName,
830 renderModeDescriptor,
831 actualBitmapAndDigest.fDigest);
832 WriteBitmap(path, actualBitmapAndDigest.fBitmap);
epoger@google.com37269602013-01-19 04:21:27 +0000833 }
epoger@google.com84a18022013-02-01 20:39:15 +0000834
835 // If we have access to a single expected bitmap, log more
836 // detail about the mismatch.
837 const SkBitmap *expectedBitmapPtr = expectations.asBitmap();
bsalomon49f085d2014-09-05 13:34:00 -0700838 if (expectedBitmapPtr) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000839 report_bitmap_diffs(*expectedBitmapPtr, actualBitmapAndDigest.fBitmap,
840 completeName);
epoger@google.com84a18022013-02-01 20:39:15 +0000841 }
epoger@google.coma243b222013-01-17 17:54:28 +0000842 }
epoger@google.coma243b222013-01-17 17:54:28 +0000843
epoger@google.com37269602013-01-19 04:21:27 +0000844 if (addToJsonSummary) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000845 add_actual_results_to_json_summary(completeName, actualBitmapAndDigest.fDigest, errors,
epoger@google.com37269602013-01-19 04:21:27 +0000846 expectations.ignoreFailure());
847 add_expected_results_to_json_summary(completeName, expectations);
848 }
epoger@google.coma243b222013-01-17 17:54:28 +0000849
epoger@google.com6f6568b2013-03-22 17:29:46 +0000850 return errors;
epoger@google.com06b8a192013-01-15 19:10:16 +0000851 }
852
epoger@google.com37269602013-01-19 04:21:27 +0000853 /**
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000854 * Add this result to the appropriate JSON collection of actual results (but just ONE),
epoger@google.com76c913d2013-04-26 15:06:44 +0000855 * depending on errors encountered.
epoger@google.com37269602013-01-19 04:21:27 +0000856 */
857 void add_actual_results_to_json_summary(const char testName[],
epoger@google.comd4993ff2013-05-24 14:33:28 +0000858 const GmResultDigest &actualResultDigest,
epoger@google.com76c913d2013-04-26 15:06:44 +0000859 ErrorCombination errors,
epoger@google.com37269602013-01-19 04:21:27 +0000860 bool ignoreFailure) {
epoger@google.comd4993ff2013-05-24 14:33:28 +0000861 Json::Value jsonActualResults = actualResultDigest.asJsonTypeValuePair();
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000862 Json::Value *resultCollection = NULL;
863
epoger@google.com76c913d2013-04-26 15:06:44 +0000864 if (errors.isEmpty()) {
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000865 resultCollection = &this->fJsonActualResults_Succeeded;
866 } else if (errors.includes(kRenderModeMismatch_ErrorType)) {
867 resultCollection = &this->fJsonActualResults_Failed;
868 } else if (errors.includes(kExpectationsMismatch_ErrorType)) {
epoger@google.com37269602013-01-19 04:21:27 +0000869 if (ignoreFailure) {
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000870 resultCollection = &this->fJsonActualResults_FailureIgnored;
epoger@google.com37269602013-01-19 04:21:27 +0000871 } else {
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000872 resultCollection = &this->fJsonActualResults_Failed;
epoger@google.com37269602013-01-19 04:21:27 +0000873 }
epoger@google.com1ddfbc22013-10-10 17:24:20 +0000874 } else if (errors.includes(kMissingExpectations_ErrorType)) {
875 // TODO: What about the case where there IS an expected
876 // image hash digest, but that gm test doesn't actually
877 // run? For now, those cases will always be ignored,
878 // because gm only looks at expectations that correspond
879 // to gm tests that were actually run.
880 //
881 // Once we have the ability to express expectations as a
882 // JSON file, we should fix this (and add a test case for
883 // which an expectation is given but the test is never
884 // run).
885 resultCollection = &this->fJsonActualResults_NoComparison;
886 }
887
888 // If none of the above cases match, we don't add it to ANY tally of actual results.
889 if (resultCollection) {
890 (*resultCollection)[testName] = jsonActualResults;
epoger@google.com37269602013-01-19 04:21:27 +0000891 }
892 }
893
894 /**
895 * Add this test to the JSON collection of expected results.
896 */
897 void add_expected_results_to_json_summary(const char testName[],
898 Expectations expectations) {
epoger@google.com76c913d2013-04-26 15:06:44 +0000899 this->fJsonExpectedResults[testName] = expectations.asJsonValue();
epoger@google.com37269602013-01-19 04:21:27 +0000900 }
901
902 /**
903 * Compare actualBitmap to expectations stored in this->fExpectationsSource.
904 *
905 * @param gm which test generated the actualBitmap
906 * @param gRec
vandebo@chromium.org8fc37662013-08-21 18:04:09 +0000907 * @param configName The config name to look for in the expectation file.
epoger@google.come33e1372013-07-08 19:13:33 +0000908 * @param actualBitmapAndDigest ptr to bitmap generated by this run, or NULL
909 * if we don't have a usable bitmap representation
epoger@google.com37269602013-01-19 04:21:27 +0000910 */
robertphillipsed313432014-12-16 09:31:42 -0800911 ErrorCombination compareTestResultsToStoredExpectations(
vandebo@chromium.org8fc37662013-08-21 18:04:09 +0000912 GM* gm, const ConfigData& gRec, const char* configName,
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000913 const BitmapAndDigest* actualBitmapAndDigest) {
epoger@google.com659c8c02013-05-21 15:45:45 +0000914 ErrorCombination errors;
epoger@google.come33e1372013-07-08 19:13:33 +0000915
916 if (NULL == actualBitmapAndDigest) {
917 // Note that we intentionally skipped validating the results for
918 // this test, because we don't know how to generate an SkBitmap
919 // version of the output.
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000920 errors.add(ErrorCombination(kIntentionallySkipped_ErrorType));
epoger@google.comc824c832013-07-12 15:52:59 +0000921 } else if (!(gRec.fFlags & kWrite_ConfigFlag)) {
922 // We don't record the results for this test or compare them
923 // against any expectations, because the output image isn't
924 // meaningful.
925 // See https://code.google.com/p/skia/issues/detail?id=1410 ('some
926 // GM result images not available for download from Google Storage')
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000927 errors.add(ErrorCombination(kIntentionallySkipped_ErrorType));
epoger@google.come33e1372013-07-08 19:13:33 +0000928 } else {
929 ExpectationsSource *expectationsSource = this->fExpectationsSource.get();
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +0000930 SkString nameWithExtension = make_shortname_plus_config(gm->getName(), configName);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000931 nameWithExtension.append(".");
932 nameWithExtension.append(kPNG_FileExtension);
933
epoger@google.come33e1372013-07-08 19:13:33 +0000934 if (expectationsSource && (gRec.fFlags & kRead_ConfigFlag)) {
935 /*
936 * Get the expected results for this test, as one or more allowed
937 * hash digests. The current implementation of expectationsSource
938 * get this by computing the hash digest of a single PNG file on disk.
939 *
940 * TODO(epoger): This relies on the fact that
941 * force_all_opaque() was called on the bitmap before it
942 * was written to disk as a PNG in the first place. If
943 * not, the hash digest returned here may not match the
944 * hash digest of actualBitmap, which *has* been run through
945 * force_all_opaque().
946 * See comments above complete_bitmap() for more detail.
947 */
948 Expectations expectations = expectationsSource->get(nameWithExtension.c_str());
robertphillipsed313432014-12-16 09:31:42 -0800949 if (this->shouldIgnoreTest(gm->getName())) {
epoger@google.comdefc4872013-09-19 06:18:27 +0000950 expectations.setIgnoreFailure(true);
951 }
epoger@google.come33e1372013-07-08 19:13:33 +0000952 errors.add(compare_to_expectations(expectations, *actualBitmapAndDigest,
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +0000953 gm->getName(), configName, "", true));
epoger@google.come33e1372013-07-08 19:13:33 +0000954 } else {
955 // If we are running without expectations, we still want to
956 // record the actual results.
957 add_actual_results_to_json_summary(nameWithExtension.c_str(),
958 actualBitmapAndDigest->fDigest,
959 ErrorCombination(kMissingExpectations_ErrorType),
960 false);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000961 errors.add(ErrorCombination(kMissingExpectations_ErrorType));
epoger@google.come33e1372013-07-08 19:13:33 +0000962 }
epoger@google.com9ef89ce2013-01-18 21:45:42 +0000963 }
epoger@google.com6f6568b2013-03-22 17:29:46 +0000964 return errors;
epoger@google.coma243b222013-01-17 17:54:28 +0000965 }
966
epoger@google.com37269602013-01-19 04:21:27 +0000967 /**
968 * Compare actualBitmap to referenceBitmap.
969 *
epoger@google.com659c8c02013-05-21 15:45:45 +0000970 * @param shortName test name, e.g. "selftest1"
971 * @param configName configuration name, e.g. "8888"
epoger@google.com37269602013-01-19 04:21:27 +0000972 * @param renderModeDescriptor
973 * @param actualBitmap actual bitmap generated by this run
974 * @param referenceBitmap bitmap we expected to be generated
975 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000976 ErrorCombination compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +0000977 const char *shortName, const char *configName, const char *renderModeDescriptor,
epoger@google.com37269602013-01-19 04:21:27 +0000978 SkBitmap& actualBitmap, const SkBitmap* referenceBitmap) {
979
980 SkASSERT(referenceBitmap);
epoger@google.com84a18022013-02-01 20:39:15 +0000981 Expectations expectations(*referenceBitmap);
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000982 BitmapAndDigest actualBitmapAndDigest(actualBitmap);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +0000983
984 // TODO: Eliminate RecordTestResults from here.
985 // Results recording code for the test_drawing path has been refactored so that
986 // RecordTestResults is only called once, at the topmost level. However, the
987 // other paths have not yet been refactored, and RecordTestResults has been added
988 // here to maintain proper behavior for calls not coming from the test_drawing path.
989 ErrorCombination errors;
990 errors.add(compare_to_expectations(expectations, actualBitmapAndDigest, shortName,
991 configName, renderModeDescriptor, false));
992 SkString shortNamePlusConfig = make_shortname_plus_config(shortName, configName);
993 RecordTestResults(errors, shortNamePlusConfig, renderModeDescriptor);
994
995 return errors;
epoger@google.com37269602013-01-19 04:21:27 +0000996 }
997
junov@chromium.org20bd04e2013-01-16 18:43:36 +0000998 static SkPicture* generate_new_picture(GM* gm, BbhType bbhType, uint32_t recordFlags,
999 SkScalar scale = SK_Scalar1) {
robertphillipsa8d7f0b2014-08-29 08:03:56 -07001000 SkScalar width = SkScalarMul(SkIntToScalar(gm->getISize().width()), scale);
1001 SkScalar height = SkScalarMul(SkIntToScalar(gm->getISize().height()), scale);
skia.committer@gmail.comd8b27992012-12-20 02:01:41 +00001002
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001003 SkAutoTDelete<SkBBHFactory> factory;
junov@chromium.org3cb834b2012-12-13 16:39:53 +00001004 if (kTileGrid_BbhType == bbhType) {
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001005 SkTileGridFactory::TileGridInfo info;
junov@chromium.org29b19e52013-02-27 18:35:16 +00001006 info.fMargin.setEmpty();
1007 info.fOffset.setZero();
1008 info.fTileInterval.set(16, 16);
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001009 factory.reset(SkNEW_ARGS(SkTileGridFactory, (info)));
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001010 } else if (kRTree_BbhType == bbhType) {
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001011 factory.reset(SkNEW(SkRTreeFactory));
junov@chromium.org20bd04e2013-01-16 18:43:36 +00001012 }
commit-bot@chromium.org5fb2ce32014-04-17 23:35:06 +00001013 SkPictureRecorder recorder;
1014 SkCanvas* cv = recorder.beginRecording(width, height, factory.get(), recordFlags);
junov@chromium.orgc938c482012-12-19 15:24:38 +00001015 cv->scale(scale, scale);
reed@google.comaef73612012-11-16 13:41:45 +00001016 invokeGM(gm, cv, false, false);
robertphillips@google.com84b18c72014-04-13 19:09:42 +00001017 return recorder.endRecording();
epoger@google.comde961632012-10-26 18:56:36 +00001018 }
1019
1020 static SkPicture* stream_to_new_picture(const SkPicture& src) {
epoger@google.comde961632012-10-26 18:56:36 +00001021 SkDynamicMemoryWStream storage;
scroggo895c43b2014-12-11 10:53:58 -08001022 src.serialize(&storage);
bungeman@google.comc29f3d82013-07-19 22:32:11 +00001023 SkAutoTUnref<SkStreamAsset> pictReadback(storage.detachAsStream());
commit-bot@chromium.org805df1a2013-08-16 19:18:12 +00001024 SkPicture* retval = SkPicture::CreateFromStream(pictReadback,
1025 &SkImageDecoder::DecodeMemory);
epoger@google.comde961632012-10-26 18:56:36 +00001026 return retval;
1027 }
1028
1029 // Test: draw into a bitmap or pdf.
epoger@google.com15655b22013-01-08 18:47:31 +00001030 // Depending on flags, possibly compare to an expected image.
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001031 // If writePath is not NULL, also write images (or documents) to the specified path.
1032 ErrorCombination test_drawing(GM* gm, const ConfigData& gRec,
1033 const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001034 const char writePath [],
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001035 GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001036 SkBitmap* bitmap) {
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001037 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001038 SkDynamicMemoryWStream document;
1039
1040 if (gRec.fBackend == kRaster_Backend ||
1041 gRec.fBackend == kGPU_Backend) {
1042 // Early exit if we can't generate the image.
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001043 errors.add(generate_image(gm, gRec, gpuTarget, bitmap, false));
epoger@google.com6f6568b2013-03-22 17:29:46 +00001044 if (!errors.isEmpty()) {
epoger@google.com37269602013-01-19 04:21:27 +00001045 // TODO: Add a test to exercise what the stdout and
1046 // JSON look like if we get an "early error" while
1047 // trying to generate the image.
epoger@google.comde961632012-10-26 18:56:36 +00001048 return errors;
1049 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001050
robertphillipsed313432014-12-16 09:31:42 -08001051 errors.add(this->writeBitmap(gm, gRec, gRec.fName, writePath, *bitmap));
epoger@google.comde961632012-10-26 18:56:36 +00001052 } else if (gRec.fBackend == kPDF_Backend) {
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001053 if (!generate_pdf(gm, document)) {
1054 errors.add(kGeneratePdfFailed_ErrorType);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001055 } else {
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001056 SkAutoTUnref<SkStreamAsset> documentStream(document.detachAsStream());
1057 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
robertphillipsed313432014-12-16 09:31:42 -08001058 SkString path = make_filename(writePath, gm->getName(), gRec.fName, "", "pdf");
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001059 errors.add(write_document(path, documentStream));
1060 }
1061
1062 if (!(gm->getFlags() & GM::kSkipPDFRasterization_Flag)) {
1063 for (int i = 0; i < pdfRasterizers.count(); i++) {
1064 SkBitmap pdfBitmap;
vandebo@chromium.org969967e2013-12-09 23:22:15 +00001065 documentStream->rewind();
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001066 bool success = (*pdfRasterizers[i]->fRasterizerFunction)(
1067 documentStream.get(), &pdfBitmap);
1068 if (!success) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001069 SkDebugf("FAILED to render PDF for %s using renderer %s\n",
1070 gm->getName(),
1071 pdfRasterizers[i]->fName);
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001072 continue;
1073 }
1074
1075 SkString configName(gRec.fName);
1076 configName.append("-");
1077 configName.append(pdfRasterizers[i]->fName);
1078
robertphillipsed313432014-12-16 09:31:42 -08001079 errors.add(this->writeBitmap(gm, gRec, configName.c_str(),
1080 writePath, pdfBitmap));
commit-bot@chromium.org5e009892013-10-14 13:42:12 +00001081 }
1082 } else {
1083 errors.add(kIntentionallySkipped_ErrorType);
1084 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001085 }
epoger@google.comde961632012-10-26 18:56:36 +00001086 } else if (gRec.fBackend == kXPS_Backend) {
1087 generate_xps(gm, document);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001088 SkAutoTUnref<SkStreamAsset> documentStream(document.detachAsStream());
epoger@google.come33e1372013-07-08 19:13:33 +00001089
robertphillipsed313432014-12-16 09:31:42 -08001090 errors.add(this->compareTestResultsToStoredExpectations(
vandebo@chromium.org8fc37662013-08-21 18:04:09 +00001091 gm, gRec, gRec.fName, NULL));
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001092
1093 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
robertphillipsed313432014-12-16 09:31:42 -08001094 SkString path = make_filename(writePath, gm->getName(), gRec.fName, "", "xps");
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001095 errors.add(write_document(path, documentStream));
1096 }
epoger@google.come33e1372013-07-08 19:13:33 +00001097 } else {
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001098 SkASSERT(false);
epoger@google.come33e1372013-07-08 19:13:33 +00001099 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001100 return errors;
epoger@google.comde961632012-10-26 18:56:36 +00001101 }
1102
epoger@google.com6f6568b2013-03-22 17:29:46 +00001103 ErrorCombination test_deferred_drawing(GM* gm,
1104 const ConfigData& gRec,
1105 const SkBitmap& referenceBitmap,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001106 GrSurface* gpuTarget) {
epoger@google.comde961632012-10-26 18:56:36 +00001107 if (gRec.fBackend == kRaster_Backend ||
1108 gRec.fBackend == kGPU_Backend) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001109 const char renderModeDescriptor[] = "-deferred";
epoger@google.comde961632012-10-26 18:56:36 +00001110 SkBitmap bitmap;
1111 // Early exit if we can't generate the image, but this is
1112 // expected in some cases, so don't report a test failure.
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001113 ErrorCombination errors = generate_image(gm, gRec, gpuTarget, &bitmap, true);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001114 // TODO(epoger): This logic is the opposite of what is
1115 // described above... if we succeeded in generating the
1116 // -deferred image, we exit early! We should fix this
1117 // ASAP, because it is hiding -deferred errors... but for
1118 // now, I'm leaving the logic as it is so that the
1119 // refactoring change
1120 // https://codereview.chromium.org/12992003/ is unblocked.
1121 //
1122 // Filed as https://code.google.com/p/skia/issues/detail?id=1180
1123 // ('image-surface gm test is failing in "deferred" mode,
1124 // and gm is not reporting the failure')
1125 if (errors.isEmpty()) {
epoger@google.com310478e2013-04-03 18:00:39 +00001126 // TODO(epoger): Report this as a new ErrorType,
1127 // something like kImageGeneration_ErrorType?
epoger@google.com6f6568b2013-03-22 17:29:46 +00001128 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +00001129 }
epoger@google.com37269602013-01-19 04:21:27 +00001130 return compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001131 gm->getName(), gRec.fName, renderModeDescriptor, bitmap, &referenceBitmap);
epoger@google.comde961632012-10-26 18:56:36 +00001132 }
epoger@google.com6f6568b2013-03-22 17:29:46 +00001133 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +00001134 }
1135
robertphillips8c508b42014-12-11 13:10:23 -08001136 static SkSurface* CreateSurface(const ConfigData& config,
1137 const SkISize& size,
1138 GrSurface* gpuTarget) {
1139 if (config.fBackend == kRaster_Backend) {
1140 SkImageInfo ii = SkImageInfo::Make(size.width(), size.height(),
1141 config.fColorType, kPremul_SkAlphaType);
1142
1143 return SkSurface::NewRaster(ii);
1144 }
1145#if SK_SUPPORT_GPU
1146 else {
1147 uint32_t flags = (config.fFlags & kDFText_ConfigFlag) ?
1148 SkSurfaceProps::kUseDistanceFieldFonts_Flag : 0;
1149 SkSurfaceProps props(flags, SkSurfaceProps::kLegacyFontHost_InitType);
1150 return SkSurface::NewRenderTargetDirect(gpuTarget->asRenderTarget(), &props);
1151 }
1152#endif
1153
1154 return NULL;
1155 }
1156
robertphillipsed313432014-12-16 09:31:42 -08001157 ErrorCombination writeBitmap(GM* gm,
1158 const ConfigData& config,
1159 const char* configName,
1160 const char* writePath,
1161 const SkBitmap& bitmap) {
1162 ErrorCombination errors;
1163
1164 BitmapAndDigest bitmapAndDigest(bitmap);
1165 errors.add(this->compareTestResultsToStoredExpectations(gm, config,
1166 configName, &bitmapAndDigest));
1167
1168 if (writePath && (config.fFlags & kWrite_ConfigFlag)) {
1169 SkString path;
1170
1171 path = this->makeBitmapFilename(writePath, gm->getName(), configName,
1172 "", bitmapAndDigest.fDigest);
1173 errors.add(WriteBitmap(path, bitmapAndDigest.fBitmap));
1174 }
1175
1176 return errors;
1177 }
1178
robertphillips8c508b42014-12-11 13:10:23 -08001179 ErrorCombination testMPDDrawing(GM* gm,
1180 const ConfigData& config,
robertphillipsed313432014-12-16 09:31:42 -08001181 const char* writePath,
robertphillips8c508b42014-12-11 13:10:23 -08001182 GrSurface* gpuTarget,
1183 const SkBitmap& referenceBitmap) {
1184 SkASSERT(kRaster_Backend == config.fBackend || kGPU_Backend == config.fBackend);
1185
1186 static const uint32_t kMPDFlags = SkPictureRecorder::kComputeSaveLayerInfo_RecordFlag;
1187
1188 SkAutoTUnref<SkPicture> pict(generate_new_picture(gm, kRTree_BbhType, kMPDFlags));
1189
1190 SkAutoTUnref<SkSurface> surf(CreateSurface(config, gm->getISize(), gpuTarget));
1191
1192 DrawPictureToSurface(surf, pict, SK_Scalar1, false, true);
1193
1194 SkBitmap bitmap;
1195
1196 setup_bitmap(config, gm->getISize(), &bitmap);
1197
1198 surf->readPixels(bitmap.info(), bitmap.getPixels(), bitmap.rowBytes(), 0, 0);
1199 complete_bitmap(&bitmap);
1200
robertphillipsed313432014-12-16 09:31:42 -08001201 SkString configName(config.fName);
1202 configName.append("-mpd");
1203
1204 return this->writeBitmap(gm, config, configName.c_str(), writePath, bitmap);
robertphillips8c508b42014-12-11 13:10:23 -08001205 }
1206
epoger@google.comcaac3db2013-04-04 19:23:11 +00001207 ErrorCombination test_pipe_playback(GM* gm, const ConfigData& gRec,
1208 const SkBitmap& referenceBitmap, bool simulateFailure) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001209 const SkString shortNamePlusConfig = make_shortname_plus_config(gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001210 gRec.fName);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001211 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001212 for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001213 SkString renderModeDescriptor("-pipe");
1214 renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
1215
commit-bot@chromium.org805df1a2013-08-16 19:18:12 +00001216 if (gm->getFlags() & GM::kSkipPipe_Flag
1217 || (gPipeWritingFlagCombos[i].flags == SkGPipeWriter::kCrossProcess_Flag
1218 && gm->getFlags() & GM::kSkipPipeCrossProcess_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001219 RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001220 renderModeDescriptor.c_str());
1221 errors.add(kIntentionallySkipped_ErrorType);
1222 } else {
1223 SkBitmap bitmap;
1224 SkISize size = gm->getISize();
1225 setup_bitmap(gRec, size, &bitmap);
1226 SkCanvas canvas(bitmap);
robertphillips8c508b42014-12-11 13:10:23 -08001227 InstallFilter(&canvas);
scroggo@google.com74b7ffd2013-04-30 02:32:41 +00001228 // Pass a decoding function so the factory GM (which has an SkBitmap
1229 // with encoded data) will not fail playback.
1230 PipeController pipeController(&canvas, &SkImageDecoder::DecodeMemory);
epoger@google.comc8263e72013-04-10 12:17:34 +00001231 SkGPipeWriter writer;
1232 SkCanvas* pipeCanvas = writer.startRecording(&pipeController,
scroggo@google.comaef2d3b2013-04-10 18:10:41 +00001233 gPipeWritingFlagCombos[i].flags,
1234 size.width(), size.height());
epoger@google.comc8263e72013-04-10 12:17:34 +00001235 if (!simulateFailure) {
1236 invokeGM(gm, pipeCanvas, false, false);
1237 }
1238 complete_bitmap(&bitmap);
1239 writer.endRecording();
1240 errors.add(compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001241 gm->getName(), gRec.fName, renderModeDescriptor.c_str(), bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001242 &referenceBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001243 if (!errors.isEmpty()) {
1244 break;
1245 }
epoger@google.comde961632012-10-26 18:56:36 +00001246 }
1247 }
1248 return errors;
1249 }
1250
epoger@google.com6f6568b2013-03-22 17:29:46 +00001251 ErrorCombination test_tiled_pipe_playback(GM* gm, const ConfigData& gRec,
1252 const SkBitmap& referenceBitmap) {
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001253 const SkString shortNamePlusConfig = make_shortname_plus_config(gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001254 gRec.fName);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001255 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001256 for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001257 SkString renderModeDescriptor("-tiled pipe");
1258 renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
1259
1260 if ((gm->getFlags() & GM::kSkipPipe_Flag) ||
1261 (gm->getFlags() & GM::kSkipTiled_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001262 RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001263 renderModeDescriptor.c_str());
1264 errors.add(kIntentionallySkipped_ErrorType);
1265 } else {
1266 SkBitmap bitmap;
1267 SkISize size = gm->getISize();
1268 setup_bitmap(gRec, size, &bitmap);
1269 SkCanvas canvas(bitmap);
robertphillips8c508b42014-12-11 13:10:23 -08001270 InstallFilter(&canvas);
scroggo@google.com74b7ffd2013-04-30 02:32:41 +00001271 TiledPipeController pipeController(bitmap, &SkImageDecoder::DecodeMemory);
epoger@google.comc8263e72013-04-10 12:17:34 +00001272 SkGPipeWriter writer;
1273 SkCanvas* pipeCanvas = writer.startRecording(&pipeController,
scroggo@google.comaef2d3b2013-04-10 18:10:41 +00001274 gPipeWritingFlagCombos[i].flags,
1275 size.width(), size.height());
epoger@google.comc8263e72013-04-10 12:17:34 +00001276 invokeGM(gm, pipeCanvas, false, false);
1277 complete_bitmap(&bitmap);
1278 writer.endRecording();
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001279 errors.add(compare_test_results_to_reference_bitmap(gm->getName(), gRec.fName,
epoger@google.comc8263e72013-04-10 12:17:34 +00001280 renderModeDescriptor.c_str(),
1281 bitmap, &referenceBitmap));
1282 if (!errors.isEmpty()) {
1283 break;
1284 }
epoger@google.comde961632012-10-26 18:56:36 +00001285 }
1286 }
1287 return errors;
1288 }
epoger@google.come8ebeb12012-10-29 16:42:11 +00001289
1290 //
1291 // member variables.
1292 // They are public for now, to allow easier setting by tool_main().
1293 //
1294
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001295 bool fUseFileHierarchy, fWriteChecksumBasedFilenames;
epoger@google.com5079d2c2013-04-12 14:11:21 +00001296 ErrorCombination fIgnorableErrorTypes;
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00001297 SkTArray<SkString> fIgnorableTestNames;
epoger@google.come8ebeb12012-10-29 16:42:11 +00001298
junov@chromium.org95146eb2013-01-11 21:04:40 +00001299 const char* fMismatchPath;
epoger@google.com5f995452013-06-21 18:16:47 +00001300 const char* fMissingExpectationsPath;
junov@chromium.org95146eb2013-01-11 21:04:40 +00001301
epoger@google.com310478e2013-04-03 18:00:39 +00001302 // collection of tests that have failed with each ErrorType
1303 SkTArray<SkString> fFailedTests[kLast_ErrorType+1];
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001304 SkTArray<SkString> fTestsSkippedOnAllRenderModes;
epoger@google.com310478e2013-04-03 18:00:39 +00001305 int fTestsRun;
1306 SkTDict<int> fRenderModesEncountered;
epoger@google.com57f7abc2012-11-13 03:41:55 +00001307
epoger@google.com908f5832013-04-12 02:23:55 +00001308 // Where to read expectations (expected image hash digests, etc.) from.
epoger@google.com37269602013-01-19 04:21:27 +00001309 // If unset, we don't do comparisons.
1310 SkAutoTUnref<ExpectationsSource> fExpectationsSource;
1311
1312 // JSON summaries that we generate as we go (just for output).
epoger@google.comee8a8e32012-12-18 19:13:49 +00001313 Json::Value fJsonExpectedResults;
1314 Json::Value fJsonActualResults_Failed;
1315 Json::Value fJsonActualResults_FailureIgnored;
epoger@google.com9c56a8d2012-12-20 18:34:29 +00001316 Json::Value fJsonActualResults_NoComparison;
epoger@google.comee8a8e32012-12-18 19:13:49 +00001317 Json::Value fJsonActualResults_Succeeded;
epoger@google.comde961632012-10-26 18:56:36 +00001318}; // end of GMMain class definition
scroggo@google.com72c96722012-06-06 21:07:10 +00001319
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001320#if SK_SUPPORT_GPU
1321static const GLContextType kDontCare_GLContextType = GrContextFactory::kNative_GLContextType;
1322#else
1323static const GLContextType kDontCare_GLContextType = 0;
1324#endif
bsalomon@google.com7361f542012-04-19 19:15:35 +00001325
tomhudson@google.com9875dd12011-04-25 15:49:53 +00001326static const ConfigData gRec[] = {
reedddd014e2014-06-05 08:51:20 -07001327 { kN32_SkColorType, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "8888", true },
1328 { kRGB_565_SkColorType, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "565", true },
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001329#if SK_SUPPORT_GPU
reedddd014e2014-06-05 08:51:20 -07001330 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 0, kRW_ConfigFlag, "gpu", true },
1331 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 16, kRW_ConfigFlag, "msaa16", false},
1332 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 4, kRW_ConfigFlag, "msaa4", false},
1333 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNVPR_GLContextType, 4, kRW_ConfigFlag, "nvprmsaa4", true },
1334 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNVPR_GLContextType, 16, kRW_ConfigFlag, "nvprmsaa16", false},
jvanverth2b074432014-11-07 13:49:49 -08001335 /* Not quite ready to turn on distance field text baselines */
1336 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNative_GLContextType, 0, kRWDFT_ConfigFlag, "gpudft", false },
epoger@google.comc824c832013-07-12 15:52:59 +00001337 /* The gpudebug context does not generate meaningful images, so don't record
1338 * the images it generates! We only run it to look for asserts. */
reedddd014e2014-06-05 08:51:20 -07001339 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kDebug_GLContextType, 0, kNone_ConfigFlag, "gpudebug", kDebugOnly},
robertphillips@google.comd6543e52013-07-18 17:39:14 +00001340 /* The gpunull context does the least amount of work possible and doesn't
1341 generate meaninful images, so don't record them!. It can be run to
1342 isolate the CPU-side processing expense from the GPU-side.
1343 */
reedddd014e2014-06-05 08:51:20 -07001344 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kNull_GLContextType, 0, kNone_ConfigFlag, "gpunull", kDebugOnly},
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001345#if SK_ANGLE
reedddd014e2014-06-05 08:51:20 -07001346 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kANGLE_GLContextType, 0, kRW_ConfigFlag, "angle", true },
1347 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kANGLE_GLContextType, 16, kRW_ConfigFlag, "anglemsaa16", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001348#endif // SK_ANGLE
1349#ifdef SK_MESA
reedddd014e2014-06-05 08:51:20 -07001350 { kN32_SkColorType, kGPU_Backend, GrContextFactory::kMESA_GLContextType, 0, kRW_ConfigFlag, "mesa", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001351#endif // SK_MESA
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001352#endif // SK_SUPPORT_GPU
bungeman@google.comb29c8832011-10-10 13:19:10 +00001353#ifdef SK_SUPPORT_XPS
bsalomon@google.com7361f542012-04-19 19:15:35 +00001354 /* At present we have no way of comparing XPS files (either natively or by converting to PNG). */
reedddd014e2014-06-05 08:51:20 -07001355 { kN32_SkColorType, kXPS_Backend, kDontCare_GLContextType, 0, kWrite_ConfigFlag, "xps", true },
robertphillips@google.coma73e8602012-08-02 17:56:02 +00001356#endif // SK_SUPPORT_XPS
bsalomon@google.com7361f542012-04-19 19:15:35 +00001357#ifdef SK_SUPPORT_PDF
reedddd014e2014-06-05 08:51:20 -07001358 { kN32_SkColorType, kPDF_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "pdf", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001359#endif // SK_SUPPORT_PDF
reed@android.com00dae862009-06-10 15:38:48 +00001360};
1361
bungeman@google.com5d20cae2014-05-09 15:22:41 +00001362static bool SkNoRasterizePDF(SkStream*, SkBitmap*) { return false; }
1363
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001364static const PDFRasterizerData kPDFRasterizers[] = {
1365#ifdef SK_BUILD_FOR_MAC
1366 { &SkPDFDocumentToBitmap, "mac", true },
1367#endif
1368#ifdef SK_BUILD_POPPLER
1369 { &SkPopplerRasterizePDF, "poppler", true },
1370#endif
commit-bot@chromium.orgffd178c2013-11-11 15:10:47 +00001371#ifdef SK_BUILD_NATIVE_PDF_RENDERER
1372 { &SkNativeRasterizePDF, "native", true },
1373#endif // SK_BUILD_NATIVE_PDF_RENDERER
bungeman@google.com5d20cae2014-05-09 15:22:41 +00001374 // The following exists so that this array is never zero length.
1375 { &SkNoRasterizePDF, "none", false},
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001376};
1377
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001378static const char kDefaultsConfigStr[] = "defaults";
1379static const char kExcludeConfigChar = '~';
kkinnunen80549fc2014-06-30 06:36:31 -07001380#if SK_SUPPORT_GPU
1381static const char kGpuAPINameGL[] = "gl";
1382static const char kGpuAPINameGLES[] = "gles";
1383#endif
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001384
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001385static SkString configUsage() {
scroggo@google.com0f567c62013-03-20 15:35:08 +00001386 SkString result;
1387 result.appendf("Space delimited list of which configs to run. Possible options: [");
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001388 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001389 SkASSERT(gRec[i].fName != kDefaultsConfigStr);
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001390 if (i > 0) {
scroggo@google.com0f567c62013-03-20 15:35:08 +00001391 result.append("|");
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001392 }
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001393 result.appendf("%s", gRec[i].fName);
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001394 }
scroggo@google.com0f567c62013-03-20 15:35:08 +00001395 result.append("]\n");
1396 result.appendf("The default value is: \"");
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001397 SkString firstDefault;
1398 SkString allButFirstDefaults;
1399 SkString nonDefault;
scroggo@google.com0f567c62013-03-20 15:35:08 +00001400 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
1401 if (gRec[i].fRunByDefault) {
1402 if (i > 0) {
1403 result.append(" ");
1404 }
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001405 result.append(gRec[i].fName);
1406 if (firstDefault.isEmpty()) {
1407 firstDefault = gRec[i].fName;
1408 } else {
1409 if (!allButFirstDefaults.isEmpty()) {
1410 allButFirstDefaults.append(" ");
1411 }
1412 allButFirstDefaults.append(gRec[i].fName);
1413 }
1414 } else {
1415 nonDefault = gRec[i].fName;
scroggo@google.com0f567c62013-03-20 15:35:08 +00001416 }
1417 }
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001418 result.append("\"\n");
1419 result.appendf("\"%s\" evaluates to the default set of configs.\n", kDefaultsConfigStr);
1420 result.appendf("Prepending \"%c\" on a config name excludes it from the set of configs to run.\n"
1421 "Exclusions always override inclusions regardless of order.\n",
1422 kExcludeConfigChar);
1423 result.appendf("E.g. \"--config %s %c%s %s\" will run these configs:\n\t%s %s",
1424 kDefaultsConfigStr,
1425 kExcludeConfigChar,
1426 firstDefault.c_str(),
1427 nonDefault.c_str(),
1428 allButFirstDefaults.c_str(),
1429 nonDefault.c_str());
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001430 return result;
scroggo@google.com0b735632013-03-19 17:38:50 +00001431}
scroggo@google.com7d519302013-03-19 17:28:10 +00001432
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001433static SkString pdfRasterizerUsage() {
1434 SkString result;
1435 result.appendf("Space delimited list of which PDF rasterizers to run. Possible options: [");
1436 // For this (and further) loops through kPDFRasterizers, there is a typecast to int to avoid
1437 // the compiler giving an "comparison of unsigned expression < 0 is always false" warning
1438 // and turning it into a build-breaking error.
1439 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); ++i) {
1440 if (i > 0) {
1441 result.append(" ");
1442 }
1443 result.append(kPDFRasterizers[i].fName);
1444 }
1445 result.append("]\n");
1446 result.append("The default value is: \"");
1447 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); ++i) {
1448 if (kPDFRasterizers[i].fRunByDefault) {
1449 if (i > 0) {
1450 result.append(" ");
1451 }
1452 result.append(kPDFRasterizers[i].fName);
1453 }
1454 }
1455 result.append("\"");
1456 return result;
1457}
1458
epoger@google.com6f6568b2013-03-22 17:29:46 +00001459// Macro magic to convert a numeric preprocessor token into a string.
1460// Adapted from http://stackoverflow.com/questions/240353/convert-a-preprocessor-token-to-a-string
1461// This should probably be moved into one of our common headers...
1462#define TOSTRING_INTERNAL(x) #x
1463#define TOSTRING(x) TOSTRING_INTERNAL(x)
1464
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001465// Alphabetized ignoring "no" prefix ("readPath", "noreplay", "resourcePath").
scroggo@google.com0f567c62013-03-20 15:35:08 +00001466DEFINE_string(config, "", configUsage().c_str());
bsalomon69456182014-07-07 10:46:58 -07001467DEFINE_bool(cpu, true, "Allows non-GPU configs to be run. Applied after --config.");
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00001468DEFINE_string(pdfRasterizers, "default", pdfRasterizerUsage().c_str());
epoger@google.com5e497382013-09-30 07:01:55 +00001469DEFINE_bool(deferred, false, "Exercise the deferred rendering test pass.");
robertphillips8c508b42014-12-11 13:10:23 -08001470DEFINE_bool(mpd, false, "Exercise MultiPictureDraw.");
1471
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00001472DEFINE_bool(dryRun, false, "Don't actually run the tests, just print what would have been done.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001473DEFINE_string(excludeConfig, "", "Space delimited list of configs to skip.");
1474DEFINE_bool(forceBWtext, false, "Disable text anti-aliasing.");
1475#if SK_SUPPORT_GPU
kkinnunen80549fc2014-06-30 06:36:31 -07001476DEFINE_string(gpuAPI, "", "Force use of specific gpu API. Using \"gl\" "
1477 "forces OpenGL API. Using \"gles\" forces OpenGL ES API. "
1478 "Defaults to empty string, which selects the API native to the "
1479 "system.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001480DEFINE_string(gpuCacheSize, "", "<bytes> <count>: Limit the gpu cache to byte size or "
epoger@google.com6f6568b2013-03-22 17:29:46 +00001481 "object count. " TOSTRING(DEFAULT_CACHE_VALUE) " for either value means "
1482 "use the default. 0 for either disables the cache.");
bsalomon69456182014-07-07 10:46:58 -07001483DEFINE_bool(gpu, true, "Allows GPU configs to be run. Applied after --config.");
krajcevski12b35442014-08-13 12:06:26 -07001484DEFINE_bool(gpuCompressAlphaMasks, false, "Compress masks generated from falling back to "
1485 "software path rendering.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001486#endif
1487DEFINE_bool(hierarchy, false, "Whether to use multilevel directory structure "
1488 "when reading/writing files.");
epoger@google.com5079d2c2013-04-12 14:11:21 +00001489DEFINE_string(ignoreErrorTypes, kDefaultIgnorableErrorTypes.asString(" ").c_str(),
1490 "Space-separated list of ErrorTypes that should be ignored. If any *other* error "
1491 "types are encountered, the tool will exit with a nonzero return value.");
epoger@google.comf711f322013-10-18 14:55:47 +00001492DEFINE_string(ignoreFailuresFile, "", "Path to file containing a list of tests for which we "
1493 "should ignore failures.\n"
1494 "The file should list one test per line, except for comment lines starting with #");
commit-bot@chromium.org6dda8272014-01-23 17:21:19 +00001495DEFINE_bool2(leaks, l, false, "show leaked ref cnt'd objects.");
caryclark@google.com512c9b62013-05-10 15:16:13 +00001496DEFINE_string(match, "", "[~][^]substring[$] [...] of test name to run.\n"
1497 "Multiple matches may be separated by spaces.\n"
1498 "~ causes a matching test to always be skipped\n"
1499 "^ requires the start of the test to match\n"
1500 "$ requires the end of the test to match\n"
1501 "^ and $ requires an exact match\n"
1502 "If a test does not match any list entry,\n"
1503 "it is skipped unless some list entry starts with ~");
epoger@google.com5f995452013-06-21 18:16:47 +00001504DEFINE_string(missingExpectationsPath, "", "Write images for tests without expectations "
1505 "into this directory.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001506DEFINE_string(mismatchPath, "", "Write images for tests that failed due to "
1507 "pixel mismatches into this directory.");
1508DEFINE_string(modulo, "", "[--modulo <remainder> <divisor>]: only run tests for which "
1509 "testIndex %% divisor == remainder.");
epoger@google.com5e497382013-09-30 07:01:55 +00001510DEFINE_bool(pipe, false, "Exercise the SkGPipe replay test pass.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001511DEFINE_string2(readPath, r, "", "Read reference images from this dir, and report "
1512 "any differences between those and the newly generated ones.");
epoger@google.com5e497382013-09-30 07:01:55 +00001513DEFINE_bool(replay, false, "Exercise the SkPicture replay test pass.");
bsalomonb82b9d52014-10-08 08:17:11 -07001514
1515#ifdef SK_BUILD_FOR_ANDROID
1516DEFINE_bool(resetGpuContext, true, "Reset the GrContext prior to running each GM.");
1517#else
djsollen@google.comac8f3a42013-10-04 14:57:00 +00001518DEFINE_bool(resetGpuContext, false, "Reset the GrContext prior to running each GM.");
1519#endif
bsalomonb82b9d52014-10-08 08:17:11 -07001520
epoger@google.com5e497382013-09-30 07:01:55 +00001521DEFINE_bool(rtree, false, "Exercise the R-Tree variant of SkPicture test pass.");
1522DEFINE_bool(serialize, false, "Exercise the SkPicture serialization & deserialization test pass.");
epoger@google.comcaac3db2013-04-04 19:23:11 +00001523DEFINE_bool(simulatePipePlaybackFailure, false, "Simulate a rendering failure in pipe mode only.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001524DEFINE_bool(tiledPipe, false, "Exercise tiled SkGPipe replay.");
epoger@google.com5e497382013-09-30 07:01:55 +00001525DEFINE_bool(tileGrid, false, "Exercise the tile grid variant of SkPicture.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001526DEFINE_string(tileGridReplayScales, "", "Space separated list of floating-point scale "
1527 "factors to be used for tileGrid playback testing. Default value: 1.0");
epoger@google.comb0f8b432013-04-10 18:46:25 +00001528DEFINE_bool2(verbose, v, false, "Give more detail (e.g. list all GMs run, more info about "
1529 "each test).");
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001530DEFINE_bool(writeChecksumBasedFilenames, false, "When writing out actual images, use checksum-"
1531 "based filenames, as rebaseline.py will use when downloading them from Google Storage");
1532DEFINE_string(writeJsonSummaryPath, "", "Write a JSON-formatted result summary to this file.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001533DEFINE_string2(writePath, w, "", "Write rendered images into this directory.");
scroggo@google.com604e0c22013-04-09 21:25:46 +00001534DEFINE_string2(writePicturePath, p, "", "Write .skp files into this directory.");
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001535DEFINE_int32(pdfJpegQuality, -1, "Encodes images in JPEG at quality level N, "
1536 "which can be in range 0-100). N = -1 will disable JPEG compression. "
1537 "Default is N = 100, maximum quality.");
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +00001538// TODO(edisonn): pass a matrix instead of forcePerspectiveMatrix
1539// Either the 9 numbers defining the matrix
1540// or probably more readable would be to replace it with a set of a few predicates
1541// Like --prerotate 100 200 10 --posttranslate 10, 10
1542// Probably define spacial names like centerx, centery, top, bottom, left, right
1543// then we can write something reabable like --rotate centerx centery 90
1544DEFINE_bool(forcePerspectiveMatrix, false, "Force a perspective matrix.");
edisonn@google.com73a7ea32013-11-11 20:55:15 +00001545DEFINE_int32(pdfRasterDpi, 72, "Scale at which at which the non suported "
1546 "features in PDF are rasterized. Must be be in range 0-10000. "
1547 "Default is 72. N = 0 will disable rasterizing features like "
1548 "text shadows or perspective bitmaps.");
reed@google.com672588b2014-01-08 15:42:01 +00001549static SkData* encode_to_dct_data(size_t*, const SkBitmap& bitmap) {
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001550 // Filter output of warnings that JPEG is not available for the image.
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001551 if (bitmap.width() >= 65500 || bitmap.height() >= 65500) return NULL;
1552 if (FLAGS_pdfJpegQuality == -1) return NULL;
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001553
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001554 SkBitmap bm = bitmap;
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001555#if defined(SK_BUILD_FOR_MAC)
1556 // Workaround bug #1043 where bitmaps with referenced pixels cause
1557 // CGImageDestinationFinalize to crash
1558 SkBitmap copy;
commit-bot@chromium.orgd5f032d2014-02-24 18:51:43 +00001559 bitmap.deepCopyTo(&copy);
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001560 bm = copy;
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001561#endif
1562
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001563 SkPixelRef* pr = bm.pixelRef();
1564 if (pr != NULL) {
1565 SkData* data = pr->refEncodedData();
1566 if (data != NULL) {
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001567 return data;
1568 }
1569 }
1570
commit-bot@chromium.org608ea652013-10-03 19:29:21 +00001571 return SkImageEncoder::EncodeData(bm,
1572 SkImageEncoder::kJPEG_Type,
1573 FLAGS_pdfJpegQuality);
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001574}
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001575
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001576static int findConfig(const char config[]) {
1577 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); i++) {
1578 if (!strcmp(config, gRec[i].fName)) {
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001579 return (int) i;
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001580 }
1581 }
1582 return -1;
1583}
1584
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001585static const PDFRasterizerData* findPDFRasterizer(const char rasterizer[]) {
1586 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); i++) {
1587 if (!strcmp(rasterizer, kPDFRasterizers[i].fName)) {
1588 return &kPDFRasterizers[i];
1589 }
1590 }
1591 return NULL;
1592}
1593
reed@google.comfb2cd422013-01-04 14:43:03 +00001594template <typename T> void appendUnique(SkTDArray<T>* array, const T& value) {
1595 int index = array->find(value);
1596 if (index < 0) {
1597 *array->append() = value;
1598 }
1599}
1600
epoger@google.com80724df2013-03-21 13:49:54 +00001601/**
epoger@google.com80724df2013-03-21 13:49:54 +00001602 * Run this test in a number of different drawing modes (pipe,
1603 * deferred, tiled, etc.), confirming that the resulting bitmaps all
1604 * *exactly* match comparisonBitmap.
1605 *
1606 * Returns all errors encountered while doing so.
1607 */
robertphillips478dd722014-12-16 08:25:55 -08001608ErrorCombination run_multiple_modes(GMMain &gmmain, GM *gm,
1609 const ConfigData &compareConfig, GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001610 const SkBitmap &comparisonBitmap,
1611 const SkTDArray<SkScalar> &tileGridReplayScales);
robertphillips478dd722014-12-16 08:25:55 -08001612ErrorCombination run_multiple_modes(GMMain &gmmain, GM *gm,
1613 const ConfigData &compareConfig, GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001614 const SkBitmap &comparisonBitmap,
1615 const SkTDArray<SkScalar> &tileGridReplayScales) {
1616 ErrorCombination errorsForAllModes;
epoger@google.com80724df2013-03-21 13:49:54 +00001617 uint32_t gmFlags = gm->getFlags();
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001618 const SkString shortNamePlusConfig = gmmain.make_shortname_plus_config(gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001619 compareConfig.fName);
epoger@google.com80724df2013-03-21 13:49:54 +00001620
epoger@google.comc8263e72013-04-10 12:17:34 +00001621 SkPicture* pict = gmmain.generate_new_picture(gm, kNone_BbhType, 0);
mtklein08d1fcc2014-11-20 09:18:31 -08001622 SkAutoTUnref<SkPicture> aur(pict);
epoger@google.comc8263e72013-04-10 12:17:34 +00001623 if (FLAGS_replay) {
1624 const char renderModeDescriptor[] = "-replay";
1625 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001626 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1627 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001628 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1629 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001630 SkBitmap bitmap;
robertphillips478dd722014-12-16 08:25:55 -08001631 gmmain.generate_image_from_picture(gm, compareConfig, gpuTarget, pict, &bitmap);
1632
epoger@google.comc8263e72013-04-10 12:17:34 +00001633 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001634 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001635 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001636 }
epoger@google.comc8263e72013-04-10 12:17:34 +00001637 }
epoger@google.com80724df2013-03-21 13:49:54 +00001638
epoger@google.comc8263e72013-04-10 12:17:34 +00001639 if (FLAGS_serialize) {
1640 const char renderModeDescriptor[] = "-serialize";
1641 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001642 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1643 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001644 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1645 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001646 SkPicture* repict = gmmain.stream_to_new_picture(*pict);
mtklein08d1fcc2014-11-20 09:18:31 -08001647 SkAutoTUnref<SkPicture> aurr(repict);
epoger@google.com80724df2013-03-21 13:49:54 +00001648 SkBitmap bitmap;
robertphillips478dd722014-12-16 08:25:55 -08001649 gmmain.generate_image_from_picture(gm, compareConfig, gpuTarget, repict, &bitmap);
epoger@google.comc8263e72013-04-10 12:17:34 +00001650 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001651 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001652 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001653 }
epoger@google.com80724df2013-03-21 13:49:54 +00001654 }
1655
epoger@google.comc8263e72013-04-10 12:17:34 +00001656 if ((1 == FLAGS_writePicturePath.count()) &&
1657 !(gmFlags & GM::kSkipPicture_Flag)) {
1658 const char* pictureSuffix = "skp";
epoger@google.com659c8c02013-05-21 15:45:45 +00001659 // TODO(epoger): Make sure this still works even though the
1660 // filename now contains the config name (it used to contain
1661 // just the shortName). I think this is actually an
1662 // *improvement*, because now runs with different configs will
1663 // write out their SkPictures to separate files rather than
1664 // overwriting each other. But we should make sure it doesn't
1665 // break anybody.
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001666 SkString path = gmmain.make_filename(FLAGS_writePicturePath[0], gm->getName(),
epoger@google.com659c8c02013-05-21 15:45:45 +00001667 compareConfig.fName, "", pictureSuffix);
epoger@google.comc8263e72013-04-10 12:17:34 +00001668 SkFILEWStream stream(path.c_str());
1669 pict->serialize(&stream);
epoger@google.com80724df2013-03-21 13:49:54 +00001670 }
1671
epoger@google.comc8263e72013-04-10 12:17:34 +00001672 if (FLAGS_rtree) {
1673 const char renderModeDescriptor[] = "-rtree";
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001674 if ((gmFlags & GM::kSkipPicture_Flag) || (gmFlags & GM::kSkipTiled_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001675 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1676 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001677 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1678 } else {
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001679 SkPicture* pict = gmmain.generate_new_picture(gm, kRTree_BbhType, 0);
mtklein08d1fcc2014-11-20 09:18:31 -08001680 SkAutoTUnref<SkPicture> aur(pict);
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001681 SkBitmap bitmap;
robertphillips478dd722014-12-16 08:25:55 -08001682 gmmain.generate_image_from_picture(gm, compareConfig, gpuTarget, pict, &bitmap);
commit-bot@chromium.orgd393b172014-04-16 16:02:10 +00001683 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
1684 gm->getName(), compareConfig.fName, renderModeDescriptor, bitmap,
1685 &comparisonBitmap));
1686 }
1687 }
1688
epoger@google.comc8263e72013-04-10 12:17:34 +00001689 if (FLAGS_tileGrid) {
1690 for(int scaleIndex = 0; scaleIndex < tileGridReplayScales.count(); ++scaleIndex) {
1691 SkScalar replayScale = tileGridReplayScales[scaleIndex];
1692 SkString renderModeDescriptor("-tilegrid");
1693 if (SK_Scalar1 != replayScale) {
1694 renderModeDescriptor += "-scale-";
1695 renderModeDescriptor.appendScalar(replayScale);
1696 }
1697
1698 if ((gmFlags & GM::kSkipPicture_Flag) ||
senorblanco@chromium.orgd4d44f02014-02-20 17:17:57 +00001699 (gmFlags & GM::kSkipTiled_Flag) ||
epoger@google.comc8263e72013-04-10 12:17:34 +00001700 ((gmFlags & GM::kSkipScaledReplay_Flag) && replayScale != 1)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001701 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001702 renderModeDescriptor.c_str());
1703 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1704 } else {
1705 // We record with the reciprocal scale to obtain a replay
1706 // result that can be validated against comparisonBitmap.
1707 SkScalar recordScale = SkScalarInvert(replayScale);
1708 SkPicture* pict = gmmain.generate_new_picture(
robertphillips9f1c2412014-06-09 06:25:34 -07001709 gm, kTileGrid_BbhType, 0, recordScale);
mtklein08d1fcc2014-11-20 09:18:31 -08001710 SkAutoTUnref<SkPicture> aur(pict);
epoger@google.comc8263e72013-04-10 12:17:34 +00001711 SkBitmap bitmap;
1712 // We cannot yet pass 'true' to generate_image_from_picture to
1713 // perform actual tiled rendering (see Issue 1198 -
1714 // https://code.google.com/p/skia/issues/detail?id=1198)
robertphillips478dd722014-12-16 08:25:55 -08001715 gmmain.generate_image_from_picture(gm, compareConfig, gpuTarget, pict, &bitmap,
epoger@google.comc8263e72013-04-10 12:17:34 +00001716 replayScale /*, true */);
1717 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001718 gm->getName(), compareConfig.fName, renderModeDescriptor.c_str(), bitmap,
epoger@google.com659c8c02013-05-21 15:45:45 +00001719 &comparisonBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001720 }
epoger@google.com80724df2013-03-21 13:49:54 +00001721 }
1722 }
1723
1724 // run the pipe centric GM steps
epoger@google.comc8263e72013-04-10 12:17:34 +00001725 if (FLAGS_pipe) {
1726 errorsForAllModes.add(gmmain.test_pipe_playback(gm, compareConfig, comparisonBitmap,
1727 FLAGS_simulatePipePlaybackFailure));
1728 if (FLAGS_tiledPipe) {
1729 errorsForAllModes.add(gmmain.test_tiled_pipe_playback(gm, compareConfig,
1730 comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001731 }
epoger@google.com80724df2013-03-21 13:49:54 +00001732 }
1733 return errorsForAllModes;
1734}
1735
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001736
1737/**
1738 * Run this test in a number of different configs (8888, 565, PDF,
1739 * etc.), confirming that the resulting bitmaps match expectations
1740 * (which may be different for each config).
1741 *
1742 * Returns all errors encountered while doing so.
1743 */
1744ErrorCombination run_multiple_configs(GMMain &gmmain, GM *gm,
1745 const SkTDArray<size_t> &configs,
1746 const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
1747 const SkTDArray<SkScalar> &tileGridReplayScales,
kkinnunen80549fc2014-06-30 06:36:31 -07001748 GrContextFactory *grFactory,
1749 GrGLStandard gpuAPI);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001750ErrorCombination run_multiple_configs(GMMain &gmmain, GM *gm,
1751 const SkTDArray<size_t> &configs,
1752 const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
1753 const SkTDArray<SkScalar> &tileGridReplayScales,
kkinnunen80549fc2014-06-30 06:36:31 -07001754 GrContextFactory *grFactory,
1755 GrGLStandard gpuAPI) {
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001756 const char renderModeDescriptor[] = "";
1757 ErrorCombination errorsForAllConfigs;
1758 uint32_t gmFlags = gm->getFlags();
1759
1760 for (int i = 0; i < configs.count(); i++) {
1761 ConfigData config = gRec[configs[i]];
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00001762 const SkString shortNamePlusConfig = gmmain.make_shortname_plus_config(gm->getName(),
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001763 config.fName);
1764
1765 // Skip any tests that we don't even need to try.
1766 // If any of these were skipped on a per-GM basis, record them as
1767 // kIntentionallySkipped.
1768 if (kPDF_Backend == config.fBackend) {
1769 if (gmFlags & GM::kSkipPDF_Flag) {
1770 gmmain.RecordSkippedTest(shortNamePlusConfig,
1771 renderModeDescriptor,
1772 config.fBackend);
1773 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1774 continue;
1775 }
1776 }
1777 if ((gmFlags & GM::kSkip565_Flag) &&
1778 (kRaster_Backend == config.fBackend) &&
reedddd014e2014-06-05 08:51:20 -07001779 (kRGB_565_SkColorType == config.fColorType)) {
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001780 gmmain.RecordSkippedTest(shortNamePlusConfig,
1781 renderModeDescriptor,
1782 config.fBackend);
1783 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1784 continue;
1785 }
1786 if (((gmFlags & GM::kSkipGPU_Flag) && kGPU_Backend == config.fBackend) ||
1787 ((gmFlags & GM::kGPUOnly_Flag) && kGPU_Backend != config.fBackend)) {
1788 gmmain.RecordSkippedTest(shortNamePlusConfig,
1789 renderModeDescriptor,
1790 config.fBackend);
1791 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1792 continue;
1793 }
1794
1795 // Now we know that we want to run this test and record its
1796 // success or failure.
1797 ErrorCombination errorsForThisConfig;
1798 GrSurface* gpuTarget = NULL;
1799#if SK_SUPPORT_GPU
1800 SkAutoTUnref<GrSurface> auGpuTarget;
1801 if ((errorsForThisConfig.isEmpty()) && (kGPU_Backend == config.fBackend)) {
1802 if (FLAGS_resetGpuContext) {
1803 grFactory->destroyContexts();
1804 }
kkinnunen80549fc2014-06-30 06:36:31 -07001805 GrContext* gr = grFactory->get(config.fGLContextType, gpuAPI);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001806 bool grSuccess = false;
1807 if (gr) {
1808 // create a render target to back the device
bsalomonf2703d82014-10-28 14:33:06 -07001809 GrSurfaceDesc desc;
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001810 desc.fConfig = kSkia8888_GrPixelConfig;
bsalomonf2703d82014-10-28 14:33:06 -07001811 desc.fFlags = kRenderTarget_GrSurfaceFlag;
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001812 desc.fWidth = gm->getISize().width();
1813 desc.fHeight = gm->getISize().height();
1814 desc.fSampleCnt = config.fSampleCnt;
1815 auGpuTarget.reset(gr->createUncachedTexture(desc, NULL, 0));
bsalomon49f085d2014-09-05 13:34:00 -07001816 if (auGpuTarget) {
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001817 gpuTarget = auGpuTarget;
1818 grSuccess = true;
1819 // Set the user specified cache limits if non-default.
1820 size_t bytes;
1821 int count;
commit-bot@chromium.org95c20032014-05-09 14:29:32 +00001822 gr->getResourceCacheLimits(&count, &bytes);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001823 if (DEFAULT_CACHE_VALUE != gGpuCacheSizeBytes) {
1824 bytes = static_cast<size_t>(gGpuCacheSizeBytes);
1825 }
1826 if (DEFAULT_CACHE_VALUE != gGpuCacheSizeCount) {
1827 count = gGpuCacheSizeCount;
1828 }
commit-bot@chromium.org95c20032014-05-09 14:29:32 +00001829 gr->setResourceCacheLimits(count, bytes);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001830 }
1831 }
1832 if (!grSuccess) {
1833 errorsForThisConfig.add(kNoGpuContext_ErrorType);
1834 }
1835 }
1836#endif
1837
1838 SkBitmap comparisonBitmap;
1839
1840 const char* writePath;
1841 if (FLAGS_writePath.count() == 1) {
1842 writePath = FLAGS_writePath[0];
1843 } else {
1844 writePath = NULL;
1845 }
1846
1847 if (errorsForThisConfig.isEmpty()) {
1848 errorsForThisConfig.add(gmmain.test_drawing(gm, config, pdfRasterizers,
1849 writePath, gpuTarget,
1850 &comparisonBitmap));
1851 gmmain.RecordTestResults(errorsForThisConfig, shortNamePlusConfig, "");
1852 }
1853
1854 // TODO: run only if gmmain.test_drawing succeeded.
1855 if (kRaster_Backend == config.fBackend) {
robertphillips478dd722014-12-16 08:25:55 -08001856 run_multiple_modes(gmmain, gm, config, gpuTarget, comparisonBitmap, tileGridReplayScales);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001857 }
1858
1859 if (FLAGS_deferred && errorsForThisConfig.isEmpty() &&
1860 (kGPU_Backend == config.fBackend || kRaster_Backend == config.fBackend)) {
1861 errorsForThisConfig.add(gmmain.test_deferred_drawing(gm, config, comparisonBitmap,
1862 gpuTarget));
1863 }
1864
robertphillips8c508b42014-12-11 13:10:23 -08001865 if (FLAGS_mpd && (kGPU_Backend == config.fBackend || kRaster_Backend == config.fBackend)) {
1866
1867 if (gmFlags & GM::kSkipPicture_Flag) {
1868 gmmain.RecordSkippedTest(shortNamePlusConfig,
1869 renderModeDescriptor,
1870 config.fBackend);
1871 errorsForThisConfig.add(kIntentionallySkipped_ErrorType);
1872 } else if (!(gmFlags & GM::kGPUOnly_Flag)) {
robertphillipsed313432014-12-16 09:31:42 -08001873 errorsForThisConfig.add(gmmain.testMPDDrawing(gm, config,
1874 writePath, gpuTarget,
robertphillips8c508b42014-12-11 13:10:23 -08001875 comparisonBitmap));
1876 }
1877 }
1878
commit-bot@chromium.org85195482014-01-13 18:27:59 +00001879 errorsForAllConfigs.add(errorsForThisConfig);
1880 }
1881 return errorsForAllConfigs;
1882}
1883
1884
epoger@google.com310478e2013-04-03 18:00:39 +00001885/**
epoger@google.comf711f322013-10-18 14:55:47 +00001886 * Read individual lines from a file, pushing them into the given array.
1887 *
1888 * @param filename path to the file to read
1889 * @param lines array of strings to add the lines to
1890 * @returns true if able to read lines from the file
1891 */
1892static bool read_lines_from_file(const char* filename, SkTArray<SkString> &lines) {
1893 SkAutoTUnref<SkStream> streamWrapper(SkStream::NewFromFile(filename));
1894 SkStream *stream = streamWrapper.get();
1895 if (!stream) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00001896 SkDebugf("unable to read file '%s'\n", filename);
epoger@google.comf711f322013-10-18 14:55:47 +00001897 return false;
1898 }
1899
1900 char c;
1901 SkString line;
1902 while (1 == stream->read(&c, 1)) {
1903 // If we hit either CR or LF, we've completed a line.
1904 //
1905 // TODO: If the file uses both CR and LF, this will return an extra blank
1906 // line for each line of the file. Which is OK for current purposes...
1907 //
1908 // TODO: Does this properly handle unicode? It doesn't matter for
1909 // current purposes...
1910 if ((c == 0x0d) || (c == 0x0a)) {
1911 lines.push_back(line);
1912 line.reset();
1913 } else {
1914 line.append(&c, 1);
1915 }
1916 }
1917 lines.push_back(line);
1918 return true;
1919}
1920
1921/**
epoger@google.com310478e2013-04-03 18:00:39 +00001922 * Return a list of all entries in an array of strings as a single string
1923 * of this form:
1924 * "item1", "item2", "item3"
1925 */
1926SkString list_all(const SkTArray<SkString> &stringArray);
1927SkString list_all(const SkTArray<SkString> &stringArray) {
1928 SkString total;
1929 for (int i = 0; i < stringArray.count(); i++) {
1930 if (i > 0) {
1931 total.append(", ");
1932 }
1933 total.append("\"");
1934 total.append(stringArray[i]);
1935 total.append("\"");
1936 }
1937 return total;
1938}
1939
1940/**
1941 * Return a list of configuration names, as a single string of this form:
1942 * "item1", "item2", "item3"
1943 *
1944 * @param configs configurations, as a list of indices into gRec
1945 */
1946SkString list_all_config_names(const SkTDArray<size_t> &configs);
1947SkString list_all_config_names(const SkTDArray<size_t> &configs) {
1948 SkString total;
1949 for (int i = 0; i < configs.count(); i++) {
1950 if (i > 0) {
1951 total.append(", ");
1952 }
1953 total.append("\"");
1954 total.append(gRec[configs[i]].fName);
1955 total.append("\"");
1956 }
1957 return total;
1958}
1959
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001960static bool prepare_subdirectories(const char *root, bool useFileHierarchy,
1961 const SkTDArray<size_t> &configs,
1962 const SkTDArray<const PDFRasterizerData*>& pdfRasterizers) {
epoger@google.comfdea3252013-05-02 18:24:03 +00001963 if (!sk_mkdir(root)) {
1964 return false;
1965 }
1966 if (useFileHierarchy) {
1967 for (int i = 0; i < configs.count(); i++) {
1968 ConfigData config = gRec[configs[i]];
1969 SkString subdir;
1970 subdir.appendf("%s%c%s", root, SkPATH_SEPARATOR, config.fName);
1971 if (!sk_mkdir(subdir.c_str())) {
1972 return false;
1973 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001974
1975 if (config.fBackend == kPDF_Backend) {
1976 for (int j = 0; j < pdfRasterizers.count(); j++) {
1977 SkString pdfSubdir = subdir;
vandebo@chromium.org8fc37662013-08-21 18:04:09 +00001978 pdfSubdir.appendf("-%s", pdfRasterizers[j]->fName);
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00001979 if (!sk_mkdir(pdfSubdir.c_str())) {
1980 return false;
1981 }
1982 }
1983 }
epoger@google.comfdea3252013-05-02 18:24:03 +00001984 }
1985 }
1986 return true;
1987}
1988
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001989static bool parse_flags_configs(SkTDArray<size_t>* outConfigs,
kkinnunen80549fc2014-06-30 06:36:31 -07001990 GrContextFactory* grFactory, GrGLStandard gpuAPI) {
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00001991 SkTDArray<size_t> excludeConfigs;
1992
1993 for (int i = 0; i < FLAGS_config.count(); i++) {
1994 const char* config = FLAGS_config[i];
1995 bool exclude = false;
1996 if (*config == kExcludeConfigChar) {
1997 exclude = true;
1998 config += 1;
1999 }
2000 int index = findConfig(config);
2001 if (index >= 0) {
2002 if (exclude) {
2003 *excludeConfigs.append() = index;
2004 } else {
2005 appendUnique<size_t>(outConfigs, index);
2006 }
2007 } else if (0 == strcmp(kDefaultsConfigStr, config)) {
2008 if (exclude) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002009 SkDebugf("%c%s is not allowed.\n",
2010 kExcludeConfigChar, kDefaultsConfigStr);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002011 return false;
2012 }
2013 for (size_t c = 0; c < SK_ARRAY_COUNT(gRec); ++c) {
2014 if (gRec[c].fRunByDefault) {
2015 appendUnique<size_t>(outConfigs, c);
2016 }
2017 }
2018 } else {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002019 SkDebugf("unrecognized config %s\n", config);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002020 return false;
2021 }
2022 }
2023
2024 for (int i = 0; i < FLAGS_excludeConfig.count(); i++) {
2025 int index = findConfig(FLAGS_excludeConfig[i]);
2026 if (index >= 0) {
2027 *excludeConfigs.append() = index;
2028 } else {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002029 SkDebugf("unrecognized excludeConfig %s\n", FLAGS_excludeConfig[i]);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002030 return false;
2031 }
2032 }
2033
2034 if (outConfigs->count() == 0) {
2035 // if no config is specified by user, add the defaults
2036 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
2037 if (gRec[i].fRunByDefault) {
2038 *outConfigs->append() = i;
2039 }
2040 }
2041 }
2042 // now remove any explicitly excluded configs
2043 for (int i = 0; i < excludeConfigs.count(); ++i) {
2044 int index = outConfigs->find(excludeConfigs[i]);
2045 if (index >= 0) {
2046 outConfigs->remove(index);
2047 // now assert that there was only one copy in configs[]
2048 SkASSERT(outConfigs->find(excludeConfigs[i]) < 0);
2049 }
2050 }
2051
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002052 for (int i = 0; i < outConfigs->count(); ++i) {
2053 size_t index = (*outConfigs)[i];
2054 if (kGPU_Backend == gRec[index].fBackend) {
bsalomon69456182014-07-07 10:46:58 -07002055#if SK_SUPPORT_GPU
2056 if (!FLAGS_gpu) {
2057 outConfigs->remove(i);
2058 --i;
2059 continue;
2060 }
2061#endif
2062 } else if (!FLAGS_cpu) {
2063 outConfigs->remove(i);
2064 --i;
2065 continue;
2066 }
2067#if SK_SUPPORT_GPU
2068 SkASSERT(grFactory != NULL);
2069 if (kGPU_Backend == gRec[index].fBackend) {
kkinnunen80549fc2014-06-30 06:36:31 -07002070 GrContext* ctx = grFactory->get(gRec[index].fGLContextType, gpuAPI);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002071 if (NULL == ctx) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002072 SkDebugf("GrContext could not be created for config %s. Config will be skipped.\n",
2073 gRec[index].fName);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002074 outConfigs->remove(i);
2075 --i;
2076 continue;
2077 }
2078 if (gRec[index].fSampleCnt > ctx->getMaxSampleCount()) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002079 SkDebugf("Sample count (%d) of config %s is not supported."
2080 " Config will be skipped.\n",
2081 gRec[index].fSampleCnt, gRec[index].fName);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002082 outConfigs->remove(i);
2083 --i;
2084 }
2085 }
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002086#endif
bsalomon69456182014-07-07 10:46:58 -07002087 }
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002088
2089 if (outConfigs->isEmpty()) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002090 SkDebugf("No configs to run.");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002091 return false;
2092 }
2093
2094 // now show the user the set of configs that will be run.
2095 SkString configStr("These configs will be run:");
2096 // show the user the config that will run.
2097 for (int i = 0; i < outConfigs->count(); ++i) {
2098 configStr.appendf(" %s", gRec[(*outConfigs)[i]].fName);
2099 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002100 SkDebugf("%s\n", configStr.c_str());
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002101
2102 return true;
2103}
2104
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002105static bool parse_flags_pdf_rasterizers(const SkTDArray<size_t>& configs,
2106 SkTDArray<const PDFRasterizerData*>* outRasterizers) {
2107 // No need to run this check (and display the PDF rasterizers message)
2108 // if no PDF backends are in the configs.
2109 bool configHasPDF = false;
2110 for (int i = 0; i < configs.count(); i++) {
2111 if (gRec[configs[i]].fBackend == kPDF_Backend) {
2112 configHasPDF = true;
2113 break;
2114 }
2115 }
2116 if (!configHasPDF) {
2117 return true;
2118 }
2119
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00002120 if (FLAGS_pdfRasterizers.count() == 1 &&
2121 !strcmp(FLAGS_pdfRasterizers[0], "default")) {
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002122 for (int i = 0; i < (int)SK_ARRAY_COUNT(kPDFRasterizers); ++i) {
2123 if (kPDFRasterizers[i].fRunByDefault) {
2124 *outRasterizers->append() = &kPDFRasterizers[i];
2125 }
2126 }
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00002127 } else {
2128 for (int i = 0; i < FLAGS_pdfRasterizers.count(); i++) {
2129 const char* rasterizer = FLAGS_pdfRasterizers[i];
2130 const PDFRasterizerData* rasterizerPtr =
2131 findPDFRasterizer(rasterizer);
2132 if (rasterizerPtr == NULL) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002133 SkDebugf("unrecognized rasterizer %s\n", rasterizer);
vandebo@chromium.orgf8afb2b2013-11-06 16:32:15 +00002134 return false;
2135 }
2136 appendUnique<const PDFRasterizerData*>(outRasterizers,
2137 rasterizerPtr);
2138 }
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002139 }
2140
2141 // now show the user the set of configs that will be run.
2142 SkString configStr("These PDF rasterizers will be run:");
2143 // show the user the config that will run.
2144 for (int i = 0; i < outRasterizers->count(); ++i) {
2145 configStr.appendf(" %s", (*outRasterizers)[i]->fName);
2146 }
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002147 SkDebugf("%s\n", configStr.c_str());
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002148
2149 return true;
2150}
2151
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002152static bool parse_flags_ignore_error_types(ErrorCombination* outErrorTypes) {
2153 if (FLAGS_ignoreErrorTypes.count() > 0) {
2154 *outErrorTypes = ErrorCombination();
2155 for (int i = 0; i < FLAGS_ignoreErrorTypes.count(); i++) {
2156 ErrorType type;
2157 const char *name = FLAGS_ignoreErrorTypes[i];
2158 if (!getErrorTypeByName(name, &type)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002159 SkDebugf("cannot find ErrorType with name '%s'\n", name);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002160 return false;
2161 } else {
2162 outErrorTypes->add(type);
2163 }
2164 }
2165 }
2166 return true;
2167}
2168
epoger@google.com3a882dd2013-10-07 18:55:09 +00002169/**
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002170 * Replace contents of ignoreTestNames with a list of test names, indicating
epoger@google.com3a882dd2013-10-07 18:55:09 +00002171 * which tests' failures should be ignored.
2172 */
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002173static bool parse_flags_ignore_tests(SkTArray<SkString> &ignoreTestNames) {
2174 ignoreTestNames.reset();
epoger@google.comf711f322013-10-18 14:55:47 +00002175
epoger@google.comf711f322013-10-18 14:55:47 +00002176 // Parse --ignoreFailuresFile
2177 for (int i = 0; i < FLAGS_ignoreFailuresFile.count(); i++) {
2178 SkTArray<SkString> linesFromFile;
2179 if (!read_lines_from_file(FLAGS_ignoreFailuresFile[i], linesFromFile)) {
2180 return false;
2181 } else {
2182 for (int j = 0; j < linesFromFile.count(); j++) {
2183 SkString thisLine = linesFromFile[j];
2184 if (thisLine.isEmpty() || thisLine.startsWith('#')) {
2185 // skip this line
2186 } else {
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002187 ignoreTestNames.push_back(thisLine);
epoger@google.comf711f322013-10-18 14:55:47 +00002188 }
2189 }
2190 }
2191 }
2192
epoger@google.com3a882dd2013-10-07 18:55:09 +00002193 return true;
2194}
2195
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002196static bool parse_flags_modulo(int* moduloRemainder, int* moduloDivisor) {
2197 if (FLAGS_modulo.count() == 2) {
2198 *moduloRemainder = atoi(FLAGS_modulo[0]);
2199 *moduloDivisor = atoi(FLAGS_modulo[1]);
2200 if (*moduloRemainder < 0 || *moduloDivisor <= 0 ||
2201 *moduloRemainder >= *moduloDivisor) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002202 SkDebugf("invalid modulo values.");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002203 return false;
2204 }
2205 }
2206 return true;
2207}
2208
2209#if SK_SUPPORT_GPU
2210static bool parse_flags_gpu_cache(int* sizeBytes, int* sizeCount) {
2211 if (FLAGS_gpuCacheSize.count() > 0) {
2212 if (FLAGS_gpuCacheSize.count() != 2) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002213 SkDebugf("--gpuCacheSize requires two arguments\n");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002214 return false;
2215 }
2216 *sizeBytes = atoi(FLAGS_gpuCacheSize[0]);
2217 *sizeCount = atoi(FLAGS_gpuCacheSize[1]);
2218 } else {
2219 *sizeBytes = DEFAULT_CACHE_VALUE;
2220 *sizeCount = DEFAULT_CACHE_VALUE;
2221 }
2222 return true;
2223}
kkinnunen80549fc2014-06-30 06:36:31 -07002224
2225static bool parse_flags_gl_standard(GrGLStandard* gpuAPI) {
2226 if (0 == FLAGS_gpuAPI.count()) {
2227 *gpuAPI = kNone_GrGLStandard;
2228 return true;
2229 }
2230 if (1 == FLAGS_gpuAPI.count()) {
2231 if (FLAGS_gpuAPI.contains(kGpuAPINameGL)) {
2232 *gpuAPI = kGL_GrGLStandard;
2233 return true;
2234 }
2235 if (FLAGS_gpuAPI.contains(kGpuAPINameGLES)) {
2236 *gpuAPI = kGLES_GrGLStandard;
2237 return true;
2238 }
2239 }
2240 SkDebugf("--gpuAPI invalid api value");
2241 return false;
2242}
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002243#endif
2244
2245static bool parse_flags_tile_grid_replay_scales(SkTDArray<SkScalar>* outScales) {
2246 *outScales->append() = SK_Scalar1; // By default only test at scale 1.0
2247 if (FLAGS_tileGridReplayScales.count() > 0) {
2248 outScales->reset();
2249 for (int i = 0; i < FLAGS_tileGridReplayScales.count(); i++) {
2250 double val = atof(FLAGS_tileGridReplayScales[i]);
2251 if (0 < val) {
2252 *outScales->append() = SkDoubleToScalar(val);
2253 }
2254 }
2255 if (0 == outScales->count()) {
2256 // Should have at least one scale
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002257 SkDebugf("--tileGridReplayScales requires at least one scale.\n");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002258 return false;
2259 }
2260 }
2261 return true;
2262}
2263
2264static bool parse_flags_gmmain_paths(GMMain* gmmain) {
2265 gmmain->fUseFileHierarchy = FLAGS_hierarchy;
2266 gmmain->fWriteChecksumBasedFilenames = FLAGS_writeChecksumBasedFilenames;
2267
2268 if (FLAGS_mismatchPath.count() == 1) {
2269 gmmain->fMismatchPath = FLAGS_mismatchPath[0];
2270 }
2271
2272 if (FLAGS_missingExpectationsPath.count() == 1) {
2273 gmmain->fMissingExpectationsPath = FLAGS_missingExpectationsPath[0];
2274 }
2275
2276 if (FLAGS_readPath.count() == 1) {
2277 const char* readPath = FLAGS_readPath[0];
2278 if (!sk_exists(readPath)) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002279 SkDebugf("readPath %s does not exist!\n", readPath);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002280 return false;
2281 }
2282 if (sk_isdir(readPath)) {
2283 if (FLAGS_verbose) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002284 SkDebugf("reading from %s\n", readPath);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002285 }
2286 gmmain->fExpectationsSource.reset(SkNEW_ARGS(
2287 IndividualImageExpectationsSource, (readPath)));
2288 } else {
2289 if (FLAGS_verbose) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002290 SkDebugf("reading expectations from JSON summary file %s\n", readPath);
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002291 }
2292 gmmain->fExpectationsSource.reset(SkNEW_ARGS(JsonExpectationsSource, (readPath)));
2293 }
2294 }
2295 return true;
2296}
2297
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002298static bool parse_flags_jpeg_quality() {
2299 if (FLAGS_pdfJpegQuality < -1 || FLAGS_pdfJpegQuality > 100) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002300 SkDebugf("%s\n", "pdfJpegQuality must be in [-1 .. 100] range.");
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002301 return false;
2302 }
2303 return true;
2304}
2305
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002306int tool_main(int argc, char** argv);
2307int tool_main(int argc, char** argv) {
mtklein30e6e2a2014-06-18 11:44:15 -07002308 SetupCrashHandler();
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002309
commit-bot@chromium.org6dda8272014-01-23 17:21:19 +00002310 SkString usage;
2311 usage.printf("Run the golden master tests.\n");
2312 SkCommandLineFlags::SetUsage(usage.c_str());
2313 SkCommandLineFlags::Parse(argc, argv);
2314
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002315#if SK_ENABLE_INST_COUNT
commit-bot@chromium.org6dda8272014-01-23 17:21:19 +00002316 if (FLAGS_leaks) {
2317 gPrintInstCount = true;
2318 }
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002319#endif
2320
tfarinaa71d3af2014-11-07 06:12:30 -08002321 SkAutoGraphics ag;
epoger@google.com0b62b3d2013-03-20 17:59:28 +00002322
2323 setSystemPreferences();
2324 GMMain gmmain;
2325
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002326 SkTDArray<size_t> configs;
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002327
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002328 int moduloRemainder = -1;
2329 int moduloDivisor = -1;
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002330 SkTDArray<const PDFRasterizerData*> pdfRasterizers;
epoger@google.com6f6568b2013-03-22 17:29:46 +00002331 SkTDArray<SkScalar> tileGridReplayScales;
bsalomon@google.com4c75f242013-03-19 18:58:43 +00002332#if SK_SUPPORT_GPU
kkinnunen80549fc2014-06-30 06:36:31 -07002333 GrGLStandard gpuAPI = kNone_GrGLStandard;
krajcevski12b35442014-08-13 12:06:26 -07002334 GrContext::Options grContextOpts;
2335 grContextOpts.fDrawPathToCompressedTexture = FLAGS_gpuCompressAlphaMasks;
2336 GrContextFactory* grFactory = new GrContextFactory(grContextOpts);
epoger@google.com80724df2013-03-21 13:49:54 +00002337#else
kkinnunen80549fc2014-06-30 06:36:31 -07002338 GrGLStandard gpuAPI = 0;
epoger@google.com80724df2013-03-21 13:49:54 +00002339 GrContextFactory* grFactory = NULL;
bsalomon@google.com4c75f242013-03-19 18:58:43 +00002340#endif
2341
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002342 if (FLAGS_dryRun) {
2343 SkDebugf( "Doing a dry run; no tests will actually be executed.\n");
2344 }
2345
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002346 if (!parse_flags_modulo(&moduloRemainder, &moduloDivisor) ||
2347 !parse_flags_ignore_error_types(&gmmain.fIgnorableErrorTypes) ||
commit-bot@chromium.org3e62ebf2014-01-14 02:54:11 +00002348 !parse_flags_ignore_tests(gmmain.fIgnorableTestNames) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002349#if SK_SUPPORT_GPU
2350 !parse_flags_gpu_cache(&gGpuCacheSizeBytes, &gGpuCacheSizeCount) ||
kkinnunen80549fc2014-06-30 06:36:31 -07002351 !parse_flags_gl_standard(&gpuAPI) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002352#endif
2353 !parse_flags_tile_grid_replay_scales(&tileGridReplayScales) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002354 !parse_flags_jpeg_quality() ||
kkinnunen80549fc2014-06-30 06:36:31 -07002355 !parse_flags_configs(&configs, grFactory, gpuAPI) ||
vandebo@chromium.org0dcbece2013-08-20 23:08:40 +00002356 !parse_flags_pdf_rasterizers(configs, &pdfRasterizers) ||
commit-bot@chromium.orgab882bf2013-08-14 21:56:47 +00002357 !parse_flags_gmmain_paths(&gmmain)) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00002358 return -1;
2359 }
2360
epoger@google.comb0f8b432013-04-10 18:46:25 +00002361 if (FLAGS_verbose) {
2362 if (FLAGS_writePath.count() == 1) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002363 SkDebugf("writing to %s\n", FLAGS_writePath[0]);
epoger@google.comb0f8b432013-04-10 18:46:25 +00002364 }
bsalomon49f085d2014-09-05 13:34:00 -07002365 if (gmmain.fMismatchPath) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002366 SkDebugf("writing mismatches to %s\n", gmmain.fMismatchPath);
epoger@google.comfdea3252013-05-02 18:24:03 +00002367 }
bsalomon49f085d2014-09-05 13:34:00 -07002368 if (gmmain.fMissingExpectationsPath) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002369 SkDebugf("writing images without expectations to %s\n",
2370 gmmain.fMissingExpectationsPath);
epoger@google.com5f995452013-06-21 18:16:47 +00002371 }
epoger@google.comb0f8b432013-04-10 18:46:25 +00002372 if (FLAGS_writePicturePath.count() == 1) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002373 SkDebugf("writing pictures to %s\n", FLAGS_writePicturePath[0]);
epoger@google.comb0f8b432013-04-10 18:46:25 +00002374 }
tfarinabcbc1782014-06-18 14:32:48 -07002375 if (!GetResourcePath().isEmpty()) {
2376 SkDebugf("reading resources from %s\n", GetResourcePath().c_str());
epoger@google.comb0f8b432013-04-10 18:46:25 +00002377 }
robertphillips@google.com8570b5c2012-03-20 17:40:58 +00002378 }
2379
epoger@google.com310478e2013-04-03 18:00:39 +00002380 int gmsRun = 0;
reed@google.comae7b8f32012-10-18 21:30:57 +00002381 int gmIndex = -1;
2382 SkString moduloStr;
2383
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002384 if (!FLAGS_dryRun) {
2385 // If we will be writing out files, prepare subdirectories.
2386 if (FLAGS_writePath.count() == 1) {
2387 if (!prepare_subdirectories(FLAGS_writePath[0], gmmain.fUseFileHierarchy,
2388 configs, pdfRasterizers)) {
2389 return -1;
2390 }
2391 }
bsalomon49f085d2014-09-05 13:34:00 -07002392 if (gmmain.fMismatchPath) {
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002393 if (!prepare_subdirectories(gmmain.fMismatchPath, gmmain.fUseFileHierarchy,
2394 configs, pdfRasterizers)) {
2395 return -1;
2396 }
2397 }
bsalomon49f085d2014-09-05 13:34:00 -07002398 if (gmmain.fMissingExpectationsPath) {
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002399 if (!prepare_subdirectories(gmmain.fMissingExpectationsPath, gmmain.fUseFileHierarchy,
2400 configs, pdfRasterizers)) {
2401 return -1;
2402 }
epoger@google.come8ebeb12012-10-29 16:42:11 +00002403 }
epoger@google.comfdea3252013-05-02 18:24:03 +00002404 }
bsalomon@google.com7361f542012-04-19 19:15:35 +00002405 Iter iter;
2406 GM* gm;
reed@android.com00dae862009-06-10 15:38:48 +00002407 while ((gm = iter.next()) != NULL) {
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +00002408 if (FLAGS_forcePerspectiveMatrix) {
2409 SkMatrix perspective;
2410 perspective.setIdentity();
2411 perspective.setPerspY(SkScalarDiv(SK_Scalar1, SkIntToScalar(1000)));
2412 perspective.setSkewX(SkScalarDiv(SkIntToScalar(8),
2413 SkIntToScalar(25)));
2414
2415 gm->setStarterMatrix(perspective);
skia.committer@gmail.com65caeaf2013-09-27 07:01:29 +00002416 }
scroggo@google.com7fd2d702013-04-16 19:11:14 +00002417 SkAutoTDelete<GM> adgm(gm);
reed@google.comae7b8f32012-10-18 21:30:57 +00002418 ++gmIndex;
epoger@google.com82cb65b2012-10-29 18:59:17 +00002419 if (moduloRemainder >= 0) {
2420 if ((gmIndex % moduloDivisor) != moduloRemainder) {
reed@google.comae7b8f32012-10-18 21:30:57 +00002421 continue;
2422 }
epoger@google.com82cb65b2012-10-29 18:59:17 +00002423 moduloStr.printf("[%d.%d] ", gmIndex, moduloDivisor);
reed@google.comae7b8f32012-10-18 21:30:57 +00002424 }
2425
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +00002426 const char* shortName = gm->getName();
sglez@google.com586db932013-07-24 17:24:23 +00002427
commit-bot@chromium.orga6f37e72013-08-30 15:52:46 +00002428 if (SkCommandLineFlags::ShouldSkip(FLAGS_match, shortName)) {
reed@google.comece2b022011-07-25 14:28:57 +00002429 continue;
2430 }
2431
epoger@google.com310478e2013-04-03 18:00:39 +00002432 gmsRun++;
tomhudson@google.com9875dd12011-04-25 15:49:53 +00002433 SkISize size = gm->getISize();
mtkleinafb43792014-08-19 15:55:55 -07002434 SkDebugf("%4dM %sdrawing... %s [%d %d]\n",
2435 sk_tools::getMaxResidentSetSizeMB(), moduloStr.c_str(), shortName,
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002436 size.width(), size.height());
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002437 if (!FLAGS_dryRun)
mtkleinafb43792014-08-19 15:55:55 -07002438 run_multiple_configs(gmmain, gm, configs, pdfRasterizers, tileGridReplayScales,
kkinnunen80549fc2014-06-30 06:36:31 -07002439 grFactory, gpuAPI);
reed@android.com00dae862009-06-10 15:38:48 +00002440 }
epoger@google.com310478e2013-04-03 18:00:39 +00002441
commit-bot@chromium.orgb17ccc92014-03-13 16:16:36 +00002442 if (FLAGS_dryRun)
2443 return 0;
2444
epoger@google.com310478e2013-04-03 18:00:39 +00002445 SkTArray<SkString> modes;
2446 gmmain.GetRenderModesEncountered(modes);
commit-bot@chromium.org85195482014-01-13 18:27:59 +00002447 int modeCount = modes.count();
2448
2449 // Now that we have run all the tests and thus know the full set of renderModes that we
2450 // tried to run, we can call RecordTestResults() to record the cases in which we skipped
2451 // ALL renderModes.
2452 // See http://skbug.com/1994 and https://codereview.chromium.org/129203002/
2453 int testCount = gmmain.fTestsSkippedOnAllRenderModes.count();
2454 for (int testNum = 0; testNum < testCount; ++testNum) {
2455 const SkString &shortNamePlusConfig = gmmain.fTestsSkippedOnAllRenderModes[testNum];
2456 for (int modeNum = 0; modeNum < modeCount; ++modeNum) {
2457 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
2458 modes[modeNum].c_str());
2459 }
2460 }
2461
epoger@google.comc8263e72013-04-10 12:17:34 +00002462 bool reportError = false;
2463 if (gmmain.NumSignificantErrors() > 0) {
2464 reportError = true;
2465 }
commit-bot@chromium.org85195482014-01-13 18:27:59 +00002466
2467 // We test every GM against every config, and for every raster config also test every mode.
2468 int rasterConfigs = 0;
2469 for (int i = 0; i < configs.count(); i++) {
2470 if (gRec[configs[i]].fBackend == kRaster_Backend) {
2471 rasterConfigs++;
2472 }
2473 }
2474 // For raster configs, we run all renderModes; for non-raster configs, just default renderMode
2475 const int expectedNumberOfTests = rasterConfigs * gmsRun * modeCount
2476 + (configs.count() - rasterConfigs) * gmsRun;
epoger@google.com310478e2013-04-03 18:00:39 +00002477
2478 // Output summary to stdout.
epoger@google.com51dbabe2013-04-10 15:24:53 +00002479 if (FLAGS_verbose) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002480 SkDebugf("Ran %d GMs\n", gmsRun);
2481 SkDebugf("... over %2d configs [%s]\n", configs.count(),
2482 list_all_config_names(configs).c_str());
2483 SkDebugf("... and %2d modes [%s]\n", modeCount, list_all(modes).c_str());
2484 SkDebugf("... so there should be a total of %d tests.\n", expectedNumberOfTests);
epoger@google.com51dbabe2013-04-10 15:24:53 +00002485 }
2486 gmmain.ListErrors(FLAGS_verbose);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002487
epoger@google.com07947d92013-04-11 15:41:02 +00002488 // TODO(epoger): Enable this check for Android, too, once we resolve
2489 // https://code.google.com/p/skia/issues/detail?id=1222
2490 // ('GM is unexpectedly skipping tests on Android')
2491#ifndef SK_BUILD_FOR_ANDROID
epoger@google.comc8263e72013-04-10 12:17:34 +00002492 if (expectedNumberOfTests != gmmain.fTestsRun) {
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002493 SkDebugf("expected %d tests, but ran or skipped %d tests\n",
2494 expectedNumberOfTests, gmmain.fTestsRun);
epoger@google.comc8263e72013-04-10 12:17:34 +00002495 reportError = true;
2496 }
2497#endif
2498
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002499 if (FLAGS_writeJsonSummaryPath.count() == 1) {
epoger@google.com76c913d2013-04-26 15:06:44 +00002500 Json::Value root = CreateJsonTree(
2501 gmmain.fJsonExpectedResults,
2502 gmmain.fJsonActualResults_Failed, gmmain.fJsonActualResults_FailureIgnored,
2503 gmmain.fJsonActualResults_NoComparison, gmmain.fJsonActualResults_Succeeded);
epoger@google.comee8a8e32012-12-18 19:13:49 +00002504 std::string jsonStdString = root.toStyledString();
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002505 SkFILEWStream stream(FLAGS_writeJsonSummaryPath[0]);
epoger@google.comee8a8e32012-12-18 19:13:49 +00002506 stream.write(jsonStdString.c_str(), jsonStdString.length());
2507 }
2508
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00002509#if SK_SUPPORT_GPU
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002510
robertphillips@google.com59552022012-08-31 13:07:37 +00002511#if GR_CACHE_STATS
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002512 for (int i = 0; i < configs.count(); i++) {
2513 ConfigData config = gRec[configs[i]];
2514
epoger@google.comb0f8b432013-04-10 18:46:25 +00002515 if (FLAGS_verbose && (kGPU_Backend == config.fBackend)) {
kkinnunen80549fc2014-06-30 06:36:31 -07002516 GrContext* gr = grFactory->get(config.fGLContextType, gpuAPI);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002517
commit-bot@chromium.org2b3a2042014-02-27 18:45:26 +00002518 SkDebugf("config: %s %x\n", config.fName, gr);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002519 gr->printCacheStats();
2520 }
2521 }
2522#endif
2523
commit-bot@chromium.org8065ec52014-03-11 15:57:40 +00002524#if GR_DUMP_FONT_CACHE
2525 for (int i = 0; i < configs.count(); i++) {
2526 ConfigData config = gRec[configs[i]];
2527
2528 if (kGPU_Backend == config.fBackend) {
kkinnunen80549fc2014-06-30 06:36:31 -07002529 GrContext* gr = grFactory->get(config.fGLContextType, gpuAPI);
commit-bot@chromium.org8065ec52014-03-11 15:57:40 +00002530
2531 gr->dumpFontCache();
2532 }
2533 }
2534#endif
2535
robertphillips@google.com977b9c82012-06-05 19:35:09 +00002536 delete grFactory;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00002537#endif
robertphillips@google.com977b9c82012-06-05 19:35:09 +00002538
epoger@google.comc8263e72013-04-10 12:17:34 +00002539 return (reportError) ? -1 : 0;
reed@android.com00dae862009-06-10 15:38:48 +00002540}
caryclark@google.com5987f582012-10-02 18:33:14 +00002541
robertphillips8c508b42014-12-11 13:10:23 -08002542void GMMain::InstallFilter(SkCanvas* canvas) {
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002543 if (FLAGS_forceBWtext) {
2544 canvas->setDrawFilter(SkNEW(BWTextDrawFilter))->unref();
2545 }
2546}
2547
borenet@google.com7158e6a2012-11-01 17:43:44 +00002548#if !defined(SK_BUILD_FOR_IOS) && !defined(SK_BUILD_FOR_NACL)
caryclark@google.com5987f582012-10-02 18:33:14 +00002549int main(int argc, char * const argv[]) {
2550 return tool_main(argc, (char**) argv);
2551}
2552#endif