blob: ab8053e1314007964b15c7d9a25212ad4fd5035d [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"
epoger@google.com5f6a0072013-01-31 16:30:55 +000020#include "SkBitmap.h"
reed@android.comb9b9a182009-07-08 02:54:47 +000021#include "SkColorPriv.h"
scroggo@google.comd9ba9a02013-03-21 19:43:15 +000022#include "SkCommandLineFlags.h"
reed@google.com8a85d0c2011-06-24 19:12:12 +000023#include "SkData.h"
junov@google.com4370aed2012-01-18 16:21:08 +000024#include "SkDeferredCanvas.h"
bsalomon@google.com971d0c82011-08-19 17:22:05 +000025#include "SkDevice.h"
epoger@google.comde961632012-10-26 18:56:36 +000026#include "SkDrawFilter.h"
commit-bot@chromium.orgc41295d2013-06-18 20:06:36 +000027#include "SkForceLinking.h"
scroggo@google.com5af9b202012-06-04 17:17:36 +000028#include "SkGPipe.h"
reed@android.com8015dd82009-06-21 00:49:18 +000029#include "SkGraphics.h"
30#include "SkImageDecoder.h"
31#include "SkImageEncoder.h"
epoger@google.come8ebeb12012-10-29 16:42:11 +000032#include "SkOSFile.h"
tomhudson@google.com9875dd12011-04-25 15:49:53 +000033#include "SkPicture.h"
robertphillips@google.com977b9c82012-06-05 19:35:09 +000034#include "SkRefCnt.h"
scroggo@google.com72c96722012-06-06 21:07:10 +000035#include "SkStream.h"
bsalomon@google.com2a48c3a2012-08-03 14:54:45 +000036#include "SkTArray.h"
epoger@google.com310478e2013-04-03 18:00:39 +000037#include "SkTDict.h"
junov@chromium.org3cb834b2012-12-13 16:39:53 +000038#include "SkTileGridPicture.h"
scroggo@google.com72c96722012-06-06 21:07:10 +000039#include "SamplePipeControllers.h"
reed@google.com07700442010-12-20 19:46:07 +000040
commit-bot@chromium.orgc41295d2013-06-18 20:06:36 +000041__SK_FORCE_IMAGE_DECODER_LINKING;
42
bsalomon@google.com50c79d82013-01-08 20:31:53 +000043#ifdef SK_BUILD_FOR_WIN
44 // json includes xlocale which generates warning 4530 because we're compiling without
epoger@google.com37269602013-01-19 04:21:27 +000045 // exceptions; see https://code.google.com/p/skia/issues/detail?id=1067
bsalomon@google.com50c79d82013-01-08 20:31:53 +000046 #pragma warning(push)
47 #pragma warning(disable : 4530)
48#endif
epoger@google.comee8a8e32012-12-18 19:13:49 +000049#include "json/value.h"
bsalomon@google.com50c79d82013-01-08 20:31:53 +000050#ifdef SK_BUILD_FOR_WIN
51 #pragma warning(pop)
52#endif
epoger@google.comee8a8e32012-12-18 19:13:49 +000053
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000054#if SK_SUPPORT_GPU
55#include "GrContextFactory.h"
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000056#include "SkGpuDevice.h"
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000057typedef GrContextFactory::GLContextType GLContextType;
epoger@google.com6f6568b2013-03-22 17:29:46 +000058#define DEFAULT_CACHE_VALUE -1
59static int gGpuCacheSizeBytes;
60static int gGpuCacheSizeCount;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000061#else
epoger@google.com80724df2013-03-21 13:49:54 +000062class GrContextFactory;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000063class GrContext;
bsalomon@google.com123ac1d2013-03-28 19:18:12 +000064class GrSurface;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +000065typedef int GLContextType;
66#endif
67
epoger@google.com76c913d2013-04-26 15:06:44 +000068#define DEBUGFAIL_SEE_STDERR SkDEBUGFAIL("see stderr for message")
69
reed@google.com8923c6c2011-11-08 14:59:38 +000070extern bool gSkSuppressFontCachePurgeSpew;
71
reed@google.com07700442010-12-20 19:46:07 +000072#ifdef SK_SUPPORT_PDF
tomhudson@google.com9875dd12011-04-25 15:49:53 +000073 #include "SkPDFDevice.h"
74 #include "SkPDFDocument.h"
reed@google.com07700442010-12-20 19:46:07 +000075#endif
reed@android.com00dae862009-06-10 15:38:48 +000076
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"
bsalomon@google.com0a09eef2011-06-29 19:42:58 +000086 #define CAN_IMAGE_PDF 1
reed@google.com46cce912011-06-29 12:54:46 +000087#else
bsalomon@google.com0a09eef2011-06-29 19:42:58 +000088 #define CAN_IMAGE_PDF 0
reed@google.com46cce912011-06-29 12:54:46 +000089#endif
90
reed@android.com00dae862009-06-10 15:38:48 +000091using namespace skiagm;
92
reed@android.com00dae862009-06-10 15:38:48 +000093class Iter {
94public:
95 Iter() {
bsalomon@google.com39149582011-06-13 21:55:32 +000096 this->reset();
97 }
98
99 void reset() {
reed@android.comdd0ac282009-06-20 02:38:16 +0000100 fReg = GMRegistry::Head();
reed@android.com00dae862009-06-10 15:38:48 +0000101 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000102
reed@android.comdd0ac282009-06-20 02:38:16 +0000103 GM* next() {
reed@android.com00dae862009-06-10 15:38:48 +0000104 if (fReg) {
reed@android.comdd0ac282009-06-20 02:38:16 +0000105 GMRegistry::Factory fact = fReg->factory();
reed@android.com00dae862009-06-10 15:38:48 +0000106 fReg = fReg->next();
reed@android.comdd0ac282009-06-20 02:38:16 +0000107 return fact(0);
reed@android.com00dae862009-06-10 15:38:48 +0000108 }
109 return NULL;
110 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000111
reed@android.com00dae862009-06-10 15:38:48 +0000112 static int Count() {
reed@android.comdd0ac282009-06-20 02:38:16 +0000113 const GMRegistry* reg = GMRegistry::Head();
reed@android.com00dae862009-06-10 15:38:48 +0000114 int count = 0;
115 while (reg) {
116 count += 1;
117 reg = reg->next();
118 }
119 return count;
120 }
reed@google.comd4dfd102011-01-18 21:05:42 +0000121
reed@android.com00dae862009-06-10 15:38:48 +0000122private:
123 const GMRegistry* fReg;
124};
125
epoger@google.comce057fe2013-05-14 15:17:46 +0000126// TODO(epoger): Right now, various places in this code assume that all the
127// image files read/written by GM use this file extension.
128// Search for references to this constant to find these assumptions.
129const static char kPNG_FileExtension[] = "png";
130
vandebo@chromium.org686abdf2011-02-03 23:00:40 +0000131enum Backend {
junov@chromium.org3cb834b2012-12-13 16:39:53 +0000132 kRaster_Backend,
133 kGPU_Backend,
134 kPDF_Backend,
135 kXPS_Backend,
136};
137
138enum BbhType {
139 kNone_BbhType,
140 kRTree_BbhType,
141 kTileGrid_BbhType,
vandebo@chromium.org686abdf2011-02-03 23:00:40 +0000142};
143
bsalomon@google.com7361f542012-04-19 19:15:35 +0000144enum ConfigFlags {
145 kNone_ConfigFlag = 0x0,
146 /* Write GM images if a write path is provided. */
147 kWrite_ConfigFlag = 0x1,
epoger@google.comf28dd8a2012-10-25 16:27:34 +0000148 /* Read reference GM images if a read path is provided. */
bsalomon@google.com7361f542012-04-19 19:15:35 +0000149 kRead_ConfigFlag = 0x2,
150 kRW_ConfigFlag = (kWrite_ConfigFlag | kRead_ConfigFlag),
151};
152
tomhudson@google.com9875dd12011-04-25 15:49:53 +0000153struct ConfigData {
bsalomon@google.com7361f542012-04-19 19:15:35 +0000154 SkBitmap::Config fConfig;
155 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
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000163class BWTextDrawFilter : public SkDrawFilter {
164public:
reed@google.com971aca72012-11-26 20:26:54 +0000165 virtual bool filter(SkPaint*, Type) SK_OVERRIDE;
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000166};
reed@google.com971aca72012-11-26 20:26:54 +0000167bool BWTextDrawFilter::filter(SkPaint* p, Type t) {
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000168 if (kText_Type == t) {
169 p->setAntiAlias(false);
170 }
reed@google.com971aca72012-11-26 20:26:54 +0000171 return true;
mike@reedtribe.org10afbef2011-12-30 16:02:53 +0000172}
173
scroggo@google.com565254b2012-06-28 15:41:32 +0000174struct PipeFlagComboData {
175 const char* name;
176 uint32_t flags;
177};
178
179static PipeFlagComboData gPipeWritingFlagCombos[] = {
180 { "", 0 },
181 { " cross-process", SkGPipeWriter::kCrossProcess_Flag },
scroggob3c0f482012-07-02 19:07:57 +0000182 { " cross-process, shared address", SkGPipeWriter::kCrossProcess_Flag
scroggo@google.com15011ee2012-07-26 20:03:32 +0000183 | SkGPipeWriter::kSharedAddressSpace_Flag }
scroggo@google.com565254b2012-06-28 15:41:32 +0000184};
185
edisonn@google.comd9dfa182013-04-24 13:01:01 +0000186static bool encode_to_dct_stream(SkWStream* stream, const SkBitmap& bitmap, const SkIRect& rect);
187
epoger@google.com5079d2c2013-04-12 14:11:21 +0000188const static ErrorCombination kDefaultIgnorableErrorTypes = ErrorCombination()
189 .plus(kMissingExpectations_ErrorType)
190 .plus(kIntentionallySkipped_ErrorType);
191
epoger@google.comde961632012-10-26 18:56:36 +0000192class GMMain {
193public:
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000194 GMMain() : fUseFileHierarchy(false), fWriteChecksumBasedFilenames(false),
195 fIgnorableErrorTypes(kDefaultIgnorableErrorTypes),
epoger@google.com5f995452013-06-21 18:16:47 +0000196 fMismatchPath(NULL), fMissingExpectationsPath(NULL), fTestsRun(0),
197 fRenderModesEncountered(1) {}
epoger@google.come8ebeb12012-10-29 16:42:11 +0000198
epoger@google.com659c8c02013-05-21 15:45:45 +0000199 /**
200 * Assemble shortNamePlusConfig from (surprise!) shortName and configName.
201 *
202 * The method for doing so depends on whether we are using hierarchical naming.
203 * For example, shortName "selftest1" and configName "8888" could be assembled into
204 * either "selftest1_8888" or "8888/selftest1".
205 */
206 SkString make_shortname_plus_config(const char *shortName, const char *configName) {
epoger@google.come8ebeb12012-10-29 16:42:11 +0000207 SkString name;
epoger@google.com57f7abc2012-11-13 03:41:55 +0000208 if (0 == strlen(configName)) {
209 name.append(shortName);
210 } else if (fUseFileHierarchy) {
epoger@google.come8ebeb12012-10-29 16:42:11 +0000211 name.appendf("%s%c%s", configName, SkPATH_SEPARATOR, shortName);
212 } else {
213 name.appendf("%s_%s", shortName, configName);
214 }
epoger@google.comde961632012-10-26 18:56:36 +0000215 return name;
216 }
217
epoger@google.com659c8c02013-05-21 15:45:45 +0000218 /**
219 * Assemble filename, suitable for writing out the results of a particular test.
220 */
221 SkString make_filename(const char *path,
222 const char *shortName,
223 const char *configName,
224 const char *renderModeDescriptor,
225 const char *suffix) {
226 SkString filename = make_shortname_plus_config(shortName, configName);
227 filename.append(renderModeDescriptor);
228 filename.appendUnichar('.');
229 filename.append(suffix);
scroggo@google.comccd7afb2013-05-28 16:45:07 +0000230 return SkOSPath::SkPathJoin(path, filename.c_str());
epoger@google.com659c8c02013-05-21 15:45:45 +0000231 }
232
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000233 /**
234 * Assemble filename suitable for writing out an SkBitmap.
235 */
236 SkString make_bitmap_filename(const char *path,
237 const char *shortName,
238 const char *configName,
239 const char *renderModeDescriptor,
240 const GmResultDigest &bitmapDigest) {
241 if (fWriteChecksumBasedFilenames) {
242 SkString filename;
243 filename.append(bitmapDigest.getHashType());
244 filename.appendUnichar('_');
245 filename.append(shortName);
246 filename.appendUnichar('_');
247 filename.append(bitmapDigest.getDigestValue());
248 filename.appendUnichar('.');
249 filename.append(kPNG_FileExtension);
250 return SkOSPath::SkPathJoin(path, filename.c_str());
251 } else {
252 return make_filename(path, shortName, configName, renderModeDescriptor,
253 kPNG_FileExtension);
254 }
255 }
256
epoger@google.com5f6a0072013-01-31 16:30:55 +0000257 /* since PNG insists on unpremultiplying our alpha, we take no
258 precision chances and force all pixels to be 100% opaque,
259 otherwise on compare we may not get a perfect match.
260 */
261 static void force_all_opaque(const SkBitmap& bitmap) {
262 SkBitmap::Config config = bitmap.config();
263 switch (config) {
264 case SkBitmap::kARGB_8888_Config:
265 force_all_opaque_8888(bitmap);
266 break;
267 case SkBitmap::kRGB_565_Config:
268 // nothing to do here; 565 bitmaps are inherently opaque
269 break;
270 default:
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000271 gm_fprintf(stderr, "unsupported bitmap config %d\n", config);
272 DEBUGFAIL_SEE_STDERR;
epoger@google.com5f6a0072013-01-31 16:30:55 +0000273 }
274 }
275
276 static void force_all_opaque_8888(const SkBitmap& bitmap) {
277 SkAutoLockPixels lock(bitmap);
278 for (int y = 0; y < bitmap.height(); y++) {
279 for (int x = 0; x < bitmap.width(); x++) {
280 *bitmap.getAddr32(x, y) |= (SK_A32_MASK << SK_A32_SHIFT);
281 }
282 }
283 }
284
285 static bool write_bitmap(const SkString& path, const SkBitmap& bitmap) {
286 // TODO(epoger): Now that we have removed force_all_opaque()
287 // from this method, we should be able to get rid of the
288 // transformation to 8888 format also.
289 SkBitmap copy;
290 bitmap.copyTo(&copy, SkBitmap::kARGB_8888_Config);
291 return SkImageEncoder::EncodeFile(path.c_str(), copy,
292 SkImageEncoder::kPNG_Type, 100);
293 }
294
epoger@google.com6f6568b2013-03-22 17:29:46 +0000295 /**
epoger@google.com310478e2013-04-03 18:00:39 +0000296 * Add all render modes encountered thus far to the "modes" array.
epoger@google.com6f6568b2013-03-22 17:29:46 +0000297 */
epoger@google.com310478e2013-04-03 18:00:39 +0000298 void GetRenderModesEncountered(SkTArray<SkString> &modes) {
299 SkTDict<int>::Iter iter(this->fRenderModesEncountered);
300 const char* mode;
301 while ((mode = iter.next(NULL)) != NULL) {
302 SkString modeAsString = SkString(mode);
303 // TODO(epoger): It seems a bit silly that all of these modes were
304 // recorded with a leading "-" which we have to remove here
305 // (except for mode "", which means plain old original mode).
306 // But that's how renderModeDescriptor has been passed into
307 // compare_test_results_to_reference_bitmap() historically,
308 // and changing that now may affect other parts of our code.
309 if (modeAsString.startsWith("-")) {
310 modeAsString.remove(0, 1);
311 modes.push_back(modeAsString);
312 }
313 }
314 }
315
316 /**
317 * Records the results of this test in fTestsRun and fFailedTests.
318 *
319 * We even record successes, and errors that we regard as
320 * "ignorable"; we can filter them out later.
321 */
epoger@google.com659c8c02013-05-21 15:45:45 +0000322 void RecordTestResults(const ErrorCombination& errorCombination,
323 const SkString& shortNamePlusConfig,
epoger@google.com310478e2013-04-03 18:00:39 +0000324 const char renderModeDescriptor []) {
325 // Things to do regardless of errorCombination.
326 fTestsRun++;
327 int renderModeCount = 0;
328 this->fRenderModesEncountered.find(renderModeDescriptor, &renderModeCount);
329 renderModeCount++;
330 this->fRenderModesEncountered.set(renderModeDescriptor, renderModeCount);
331
epoger@google.com6f6568b2013-03-22 17:29:46 +0000332 if (errorCombination.isEmpty()) {
epoger@google.com5f6a0072013-01-31 16:30:55 +0000333 return;
epoger@google.comeb066362013-03-08 09:39:36 +0000334 }
335
epoger@google.com310478e2013-04-03 18:00:39 +0000336 // Things to do only if there is some error condition.
epoger@google.com659c8c02013-05-21 15:45:45 +0000337 SkString fullName = shortNamePlusConfig;
epoger@google.comcaac3db2013-04-04 19:23:11 +0000338 fullName.append(renderModeDescriptor);
epoger@google.com310478e2013-04-03 18:00:39 +0000339 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
340 ErrorType type = static_cast<ErrorType>(typeInt);
341 if (errorCombination.includes(type)) {
342 fFailedTests[type].push_back(fullName);
epoger@google.comf60494b2013-04-03 17:02:53 +0000343 }
epoger@google.comf60494b2013-04-03 17:02:53 +0000344 }
epoger@google.comf60494b2013-04-03 17:02:53 +0000345 }
346
epoger@google.com310478e2013-04-03 18:00:39 +0000347 /**
348 * Return the number of significant (non-ignorable) errors we have
349 * encountered so far.
350 */
351 int NumSignificantErrors() {
352 int significantErrors = 0;
353 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
354 ErrorType type = static_cast<ErrorType>(typeInt);
epoger@google.com5079d2c2013-04-12 14:11:21 +0000355 if (!fIgnorableErrorTypes.includes(type)) {
epoger@google.com310478e2013-04-03 18:00:39 +0000356 significantErrors += fFailedTests[type].count();
357 }
358 }
359 return significantErrors;
360 }
361
362 /**
epoger@google.com51dbabe2013-04-10 15:24:53 +0000363 * Display the summary of results with this ErrorType.
364 *
365 * @param type which ErrorType
366 * @param verbose whether to be all verbose about it
epoger@google.com310478e2013-04-03 18:00:39 +0000367 */
epoger@google.com51dbabe2013-04-10 15:24:53 +0000368 void DisplayResultTypeSummary(ErrorType type, bool verbose) {
epoger@google.com5079d2c2013-04-12 14:11:21 +0000369 bool isIgnorableType = fIgnorableErrorTypes.includes(type);
epoger@google.com51dbabe2013-04-10 15:24:53 +0000370
371 SkString line;
372 if (isIgnorableType) {
373 line.append("[ ] ");
374 } else {
375 line.append("[*] ");
376 }
377
378 SkTArray<SkString> *failedTestsOfThisType = &fFailedTests[type];
379 int count = failedTestsOfThisType->count();
380 line.appendf("%d %s", count, getErrorTypeName(type));
381 if (!isIgnorableType || verbose) {
382 line.append(":");
383 for (int i = 0; i < count; ++i) {
384 line.append(" ");
385 line.append((*failedTestsOfThisType)[i]);
386 }
387 }
388 gm_fprintf(stdout, "%s\n", line.c_str());
389 }
390
391 /**
392 * List contents of fFailedTests to stdout.
393 *
394 * @param verbose whether to be all verbose about it
395 */
396 void ListErrors(bool verbose) {
epoger@google.com310478e2013-04-03 18:00:39 +0000397 // First, print a single summary line.
398 SkString summary;
399 summary.appendf("Ran %d tests:", fTestsRun);
400 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
401 ErrorType type = static_cast<ErrorType>(typeInt);
402 summary.appendf(" %s=%d", getErrorTypeName(type), fFailedTests[type].count());
403 }
404 gm_fprintf(stdout, "%s\n", summary.c_str());
405
406 // Now, for each failure type, list the tests that failed that way.
407 for (int typeInt = 0; typeInt <= kLast_ErrorType; typeInt++) {
epoger@google.com51dbabe2013-04-10 15:24:53 +0000408 this->DisplayResultTypeSummary(static_cast<ErrorType>(typeInt), verbose);
epoger@google.com310478e2013-04-03 18:00:39 +0000409 }
410 gm_fprintf(stdout, "(results marked with [*] will cause nonzero return value)\n");
411 }
412
epoger@google.com5f6a0072013-01-31 16:30:55 +0000413 static bool write_document(const SkString& path,
414 const SkDynamicMemoryWStream& document) {
415 SkFILEWStream stream(path.c_str());
416 SkAutoDataUnref data(document.copyToData());
bungeman@google.com1ca36ec2013-05-06 14:28:43 +0000417 return stream.write(data->data(), data->size());
epoger@google.com5f6a0072013-01-31 16:30:55 +0000418 }
419
epoger@google.com37269602013-01-19 04:21:27 +0000420 /**
epoger@google.com5f6a0072013-01-31 16:30:55 +0000421 * Prepare an SkBitmap to render a GM into.
422 *
423 * After you've rendered the GM into the SkBitmap, you must call
424 * complete_bitmap()!
425 *
426 * @todo thudson 22 April 2011 - could refactor this to take in
427 * a factory to generate the context, always call readPixels()
428 * (logically a noop for rasters, if wasted time), and thus collapse the
429 * GPU special case and also let this be used for SkPicture testing.
430 */
431 static void setup_bitmap(const ConfigData& gRec, SkISize& size,
432 SkBitmap* bitmap) {
433 bitmap->setConfig(gRec.fConfig, size.width(), size.height());
434 bitmap->allocPixels();
435 bitmap->eraseColor(SK_ColorTRANSPARENT);
436 }
437
438 /**
439 * Any finalization steps we need to perform on the SkBitmap after
440 * we have rendered the GM into it.
epoger@google.com37269602013-01-19 04:21:27 +0000441 *
442 * It's too bad that we are throwing away alpha channel data
443 * we could otherwise be examining, but this had always been happening
444 * before... it was buried within the compare() method at
445 * https://code.google.com/p/skia/source/browse/trunk/gm/gmmain.cpp?r=7289#305 .
446 *
447 * Apparently we need this, at least for bitmaps that are either:
448 * (a) destined to be written out as PNG files, or
449 * (b) compared against bitmaps read in from PNG files
450 * for the reasons described just above the force_all_opaque() method.
451 *
452 * Neglecting to do this led to the difficult-to-diagnose
453 * http://code.google.com/p/skia/issues/detail?id=1079 ('gm generating
454 * spurious pixel_error messages as of r7258')
455 *
456 * TODO(epoger): Come up with a better solution that allows us to
457 * compare full pixel data, including alpha channel, while still being
458 * robust in the face of transformations to/from PNG files.
459 * Options include:
460 *
461 * 1. Continue to call force_all_opaque(), but ONLY for bitmaps that
462 * will be written to, or compared against, PNG files.
463 * PRO: Preserve/compare alpha channel info for the non-PNG cases
464 * (comparing different renderModes in-memory)
epoger@google.com908f5832013-04-12 02:23:55 +0000465 * CON: The bitmaps (and hash digests) for these non-PNG cases would be
epoger@google.com37269602013-01-19 04:21:27 +0000466 * different than those for the PNG-compared cases, and in the
467 * case of a failed renderMode comparison, how would we write the
468 * image to disk for examination?
469 *
epoger@google.com908f5832013-04-12 02:23:55 +0000470 * 2. Always compute image hash digests from PNG format (either
epoger@google.com37269602013-01-19 04:21:27 +0000471 * directly from the the bytes of a PNG file, or capturing the
472 * bytes we would have written to disk if we were writing the
473 * bitmap out as a PNG).
474 * PRO: I think this would allow us to never force opaque, and to
475 * the extent that alpha channel data can be preserved in a PNG
476 * file, we could observe it.
epoger@google.com908f5832013-04-12 02:23:55 +0000477 * CON: If we read a bitmap from disk, we need to take its hash digest
epoger@google.com37269602013-01-19 04:21:27 +0000478 * from the source PNG (we can't compute it from the bitmap we
479 * read out of the PNG, because we will have already premultiplied
480 * the alpha).
481 * CON: Seems wasteful to convert a bitmap to PNG format just to take
epoger@google.com908f5832013-04-12 02:23:55 +0000482 * its hash digest. (Although we're wasting lots of effort already
epoger@google.com37269602013-01-19 04:21:27 +0000483 * calling force_all_opaque().)
484 *
485 * 3. Make the alpha premultiply/unpremultiply routines 100% consistent,
486 * so we can transform images back and forth without fear of off-by-one
487 * errors.
488 * CON: Math is hard.
489 *
490 * 4. Perform a "close enough" comparison of bitmaps (+/- 1 bit in each
491 * channel), rather than demanding absolute equality.
epoger@google.com908f5832013-04-12 02:23:55 +0000492 * CON: Can't do this with hash digests.
epoger@google.com37269602013-01-19 04:21:27 +0000493 */
epoger@google.com5f6a0072013-01-31 16:30:55 +0000494 static void complete_bitmap(SkBitmap* bitmap) {
495 force_all_opaque(*bitmap);
epoger@google.comde961632012-10-26 18:56:36 +0000496 }
497
scroggo@google.com09fd4d22013-03-20 14:20:18 +0000498 static void installFilter(SkCanvas* canvas);
epoger@google.comde961632012-10-26 18:56:36 +0000499
reed@google.comaef73612012-11-16 13:41:45 +0000500 static void invokeGM(GM* gm, SkCanvas* canvas, bool isPDF, bool isDeferred) {
epoger@google.comde961632012-10-26 18:56:36 +0000501 SkAutoCanvasRestore acr(canvas, true);
502
503 if (!isPDF) {
504 canvas->concat(gm->getInitialTransform());
505 }
506 installFilter(canvas);
reed@google.comaef73612012-11-16 13:41:45 +0000507 gm->setCanvasIsDeferred(isDeferred);
epoger@google.comde961632012-10-26 18:56:36 +0000508 gm->draw(canvas);
509 canvas->setDrawFilter(NULL);
510 }
511
epoger@google.com6f6568b2013-03-22 17:29:46 +0000512 static ErrorCombination generate_image(GM* gm, const ConfigData& gRec,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +0000513 GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +0000514 SkBitmap* bitmap,
515 bool deferred) {
epoger@google.comde961632012-10-26 18:56:36 +0000516 SkISize size (gm->getISize());
517 setup_bitmap(gRec, size, bitmap);
518
519 SkAutoTUnref<SkCanvas> canvas;
520
521 if (gRec.fBackend == kRaster_Backend) {
junov@chromium.org66070a52013-05-28 17:39:08 +0000522 SkAutoTUnref<SkDevice> device(SkNEW_ARGS(SkDevice, (*bitmap)));
epoger@google.comde961632012-10-26 18:56:36 +0000523 if (deferred) {
junov@chromium.org66070a52013-05-28 17:39:08 +0000524#if SK_DEFERRED_CANVAS_USES_FACTORIES
525 canvas.reset(SkDeferredCanvas::Create(device));
526#else
527 canvas.reset(SkNEW_ARGS(SkDeferredCanvas, (device)));
528#endif
epoger@google.comde961632012-10-26 18:56:36 +0000529 } else {
junov@chromium.org66070a52013-05-28 17:39:08 +0000530 canvas.reset(SkNEW_ARGS(SkCanvas, (device)));
epoger@google.comde961632012-10-26 18:56:36 +0000531 }
reed@google.comaef73612012-11-16 13:41:45 +0000532 invokeGM(gm, canvas, false, deferred);
epoger@google.comde961632012-10-26 18:56:36 +0000533 canvas->flush();
534 }
535#if SK_SUPPORT_GPU
536 else { // GPU
bsalomon@google.com123ac1d2013-03-28 19:18:12 +0000537 SkAutoTUnref<SkDevice> device(SkGpuDevice::Create(gpuTarget));
epoger@google.comde961632012-10-26 18:56:36 +0000538 if (deferred) {
junov@chromium.org66070a52013-05-28 17:39:08 +0000539#if SK_DEFERRED_CANVAS_USES_FACTORIES
540 canvas.reset(SkDeferredCanvas::Create(device));
541#else
542 canvas.reset(SkNEW_ARGS(SkDeferredCanvas, (device)));
543#endif
epoger@google.comde961632012-10-26 18:56:36 +0000544 } else {
junov@chromium.org66070a52013-05-28 17:39:08 +0000545 canvas.reset(SkNEW_ARGS(SkCanvas, (device)));
epoger@google.comde961632012-10-26 18:56:36 +0000546 }
reed@google.comaef73612012-11-16 13:41:45 +0000547 invokeGM(gm, canvas, false, deferred);
epoger@google.comde961632012-10-26 18:56:36 +0000548 // the device is as large as the current rendertarget, so
549 // we explicitly only readback the amount we expect (in
550 // size) overwrite our previous allocation
551 bitmap->setConfig(SkBitmap::kARGB_8888_Config, size.fWidth,
552 size.fHeight);
553 canvas->readPixels(bitmap, 0, 0);
554 }
555#endif
epoger@google.com5f6a0072013-01-31 16:30:55 +0000556 complete_bitmap(bitmap);
epoger@google.com6f6568b2013-03-22 17:29:46 +0000557 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +0000558 }
559
560 static void generate_image_from_picture(GM* gm, const ConfigData& gRec,
junov@chromium.orgc938c482012-12-19 15:24:38 +0000561 SkPicture* pict, SkBitmap* bitmap,
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000562 SkScalar scale = SK_Scalar1,
563 bool tile = false) {
epoger@google.comde961632012-10-26 18:56:36 +0000564 SkISize size = gm->getISize();
565 setup_bitmap(gRec, size, bitmap);
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000566
567 if (tile) {
568 // Generate the result image by rendering to tiles and accumulating
569 // the results in 'bitmap'
570
skia.committer@gmail.com041e2db2013-04-03 07:01:14 +0000571 // This 16x16 tiling matches the settings applied to 'pict' in
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000572 // 'generate_new_picture'
573 SkISize tileSize = SkISize::Make(16, 16);
574
575 SkBitmap tileBM;
576 setup_bitmap(gRec, tileSize, &tileBM);
577 SkCanvas tileCanvas(tileBM);
578 installFilter(&tileCanvas);
579
580 SkCanvas bmpCanvas(*bitmap);
581 SkPaint bmpPaint;
582 bmpPaint.setXfermodeMode(SkXfermode::kSrc_Mode);
583
584 for (int yTile = 0; yTile < (size.height()+15)/16; ++yTile) {
585 for (int xTile = 0; xTile < (size.width()+15)/16; ++xTile) {
586 int saveCount = tileCanvas.save();
587 SkMatrix mat(tileCanvas.getTotalMatrix());
skia.committer@gmail.com041e2db2013-04-03 07:01:14 +0000588 mat.postTranslate(SkIntToScalar(-xTile*tileSize.width()),
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000589 SkIntToScalar(-yTile*tileSize.height()));
590 tileCanvas.setMatrix(mat);
591 pict->draw(&tileCanvas);
592 tileCanvas.flush();
593 tileCanvas.restoreToCount(saveCount);
skia.committer@gmail.com041e2db2013-04-03 07:01:14 +0000594 bmpCanvas.drawBitmap(tileBM,
595 SkIntToScalar(xTile * tileSize.width()),
robertphillips@google.com5a7d0292013-04-02 15:18:41 +0000596 SkIntToScalar(yTile * tileSize.height()),
597 &bmpPaint);
598 }
599 }
600 } else {
601 SkCanvas canvas(*bitmap);
602 installFilter(&canvas);
603 canvas.scale(scale, scale);
604 canvas.drawPicture(*pict);
605 complete_bitmap(bitmap);
606 }
epoger@google.comde961632012-10-26 18:56:36 +0000607 }
608
609 static void generate_pdf(GM* gm, SkDynamicMemoryWStream& pdf) {
610#ifdef SK_SUPPORT_PDF
611 SkMatrix initialTransform = gm->getInitialTransform();
612 SkISize pageSize = gm->getISize();
613 SkPDFDevice* dev = NULL;
614 if (initialTransform.isIdentity()) {
615 dev = new SkPDFDevice(pageSize, pageSize, initialTransform);
616 } else {
617 SkRect content = SkRect::MakeWH(SkIntToScalar(pageSize.width()),
618 SkIntToScalar(pageSize.height()));
619 initialTransform.mapRect(&content);
620 content.intersect(0, 0, SkIntToScalar(pageSize.width()),
621 SkIntToScalar(pageSize.height()));
622 SkISize contentSize =
623 SkISize::Make(SkScalarRoundToInt(content.width()),
624 SkScalarRoundToInt(content.height()));
625 dev = new SkPDFDevice(pageSize, contentSize, initialTransform);
626 }
edisonn@google.comd9dfa182013-04-24 13:01:01 +0000627 dev->setDCTEncoder(encode_to_dct_stream);
epoger@google.comde961632012-10-26 18:56:36 +0000628 SkAutoUnref aur(dev);
629
630 SkCanvas c(dev);
reed@google.comaef73612012-11-16 13:41:45 +0000631 invokeGM(gm, &c, true, false);
epoger@google.comde961632012-10-26 18:56:36 +0000632
633 SkPDFDocument doc;
634 doc.appendPage(dev);
635 doc.emitPDF(&pdf);
636#endif
637 }
638
639 static void generate_xps(GM* gm, SkDynamicMemoryWStream& xps) {
640#ifdef SK_SUPPORT_XPS
641 SkISize size = gm->getISize();
642
643 SkSize trimSize = SkSize::Make(SkIntToScalar(size.width()),
644 SkIntToScalar(size.height()));
645 static const SkScalar inchesPerMeter = SkScalarDiv(10000, 254);
646 static const SkScalar upm = 72 * inchesPerMeter;
647 SkVector unitsPerMeter = SkPoint::Make(upm, upm);
648 static const SkScalar ppm = 200 * inchesPerMeter;
649 SkVector pixelsPerMeter = SkPoint::Make(ppm, ppm);
650
651 SkXPSDevice* dev = new SkXPSDevice();
652 SkAutoUnref aur(dev);
653
654 SkCanvas c(dev);
655 dev->beginPortfolio(&xps);
656 dev->beginSheet(unitsPerMeter, pixelsPerMeter, trimSize);
reed@google.comaef73612012-11-16 13:41:45 +0000657 invokeGM(gm, &c, false, false);
epoger@google.comde961632012-10-26 18:56:36 +0000658 dev->endSheet();
659 dev->endPortfolio();
660
661#endif
662 }
663
epoger@google.com6f6568b2013-03-22 17:29:46 +0000664 ErrorCombination write_reference_image(const ConfigData& gRec, const char writePath [],
epoger@google.com659c8c02013-05-21 15:45:45 +0000665 const char renderModeDescriptor [],
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000666 const char *shortName,
epoger@google.come33e1372013-07-08 19:13:33 +0000667 const BitmapAndDigest* bitmapAndDigest,
epoger@google.com659c8c02013-05-21 15:45:45 +0000668 SkDynamicMemoryWStream* document) {
epoger@google.comde961632012-10-26 18:56:36 +0000669 SkString path;
670 bool success = false;
671 if (gRec.fBackend == kRaster_Backend ||
672 gRec.fBackend == kGPU_Backend ||
673 (gRec.fBackend == kPDF_Backend && CAN_IMAGE_PDF)) {
674
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000675 path = make_bitmap_filename(writePath, shortName, gRec.fName, renderModeDescriptor,
epoger@google.come33e1372013-07-08 19:13:33 +0000676 bitmapAndDigest->fDigest);
677 success = write_bitmap(path, bitmapAndDigest->fBitmap);
epoger@google.comde961632012-10-26 18:56:36 +0000678 }
679 if (kPDF_Backend == gRec.fBackend) {
epoger@google.com659c8c02013-05-21 15:45:45 +0000680 path = make_filename(writePath, shortName, gRec.fName, renderModeDescriptor,
epoger@google.com37269602013-01-19 04:21:27 +0000681 "pdf");
epoger@google.comde961632012-10-26 18:56:36 +0000682 success = write_document(path, *document);
683 }
684 if (kXPS_Backend == gRec.fBackend) {
epoger@google.com659c8c02013-05-21 15:45:45 +0000685 path = make_filename(writePath, shortName, gRec.fName, renderModeDescriptor,
epoger@google.com37269602013-01-19 04:21:27 +0000686 "xps");
epoger@google.comde961632012-10-26 18:56:36 +0000687 success = write_document(path, *document);
688 }
689 if (success) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000690 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +0000691 } else {
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000692 gm_fprintf(stderr, "FAILED to write %s\n", path.c_str());
epoger@google.com6f6568b2013-03-22 17:29:46 +0000693 ErrorCombination errors(kWritingReferenceImage_ErrorType);
epoger@google.com310478e2013-04-03 18:00:39 +0000694 // TODO(epoger): Don't call RecordTestResults() here...
695 // Instead, we should make sure to call RecordTestResults
696 // exactly ONCE per test. (Otherwise, gmmain.fTestsRun
697 // will be incremented twice for this test: once in
698 // compare_test_results_to_stored_expectations() before
699 // that method calls this one, and again here.)
700 //
701 // When we make that change, we should probably add a
702 // WritingReferenceImage test to the gm self-tests.)
epoger@google.com659c8c02013-05-21 15:45:45 +0000703 RecordTestResults(errors, make_shortname_plus_config(shortName, gRec.fName),
704 renderModeDescriptor);
epoger@google.com6f6568b2013-03-22 17:29:46 +0000705 return errors;
epoger@google.comde961632012-10-26 18:56:36 +0000706 }
707 }
708
epoger@google.com37269602013-01-19 04:21:27 +0000709 /**
epoger@google.com84a18022013-02-01 20:39:15 +0000710 * Log more detail about the mistmatch between expectedBitmap and
711 * actualBitmap.
712 */
713 void report_bitmap_diffs(const SkBitmap& expectedBitmap, const SkBitmap& actualBitmap,
714 const char *testName) {
715 const int expectedWidth = expectedBitmap.width();
716 const int expectedHeight = expectedBitmap.height();
717 const int width = actualBitmap.width();
718 const int height = actualBitmap.height();
719 if ((expectedWidth != width) || (expectedHeight != height)) {
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000720 gm_fprintf(stderr, "---- %s: dimension mismatch --"
721 " expected [%d %d], actual [%d %d]\n",
722 testName, expectedWidth, expectedHeight, width, height);
epoger@google.com84a18022013-02-01 20:39:15 +0000723 return;
724 }
725
726 if ((SkBitmap::kARGB_8888_Config != expectedBitmap.config()) ||
727 (SkBitmap::kARGB_8888_Config != actualBitmap.config())) {
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000728 gm_fprintf(stderr, "---- %s: not computing max per-channel"
729 " pixel mismatch because non-8888\n", testName);
epoger@google.com84a18022013-02-01 20:39:15 +0000730 return;
731 }
732
733 SkAutoLockPixels alp0(expectedBitmap);
734 SkAutoLockPixels alp1(actualBitmap);
735 int errR = 0;
736 int errG = 0;
737 int errB = 0;
738 int errA = 0;
739 int differingPixels = 0;
740
741 for (int y = 0; y < height; ++y) {
742 const SkPMColor* expectedPixelPtr = expectedBitmap.getAddr32(0, y);
743 const SkPMColor* actualPixelPtr = actualBitmap.getAddr32(0, y);
744 for (int x = 0; x < width; ++x) {
745 SkPMColor expectedPixel = *expectedPixelPtr++;
746 SkPMColor actualPixel = *actualPixelPtr++;
747 if (expectedPixel != actualPixel) {
748 differingPixels++;
749 errR = SkMax32(errR, SkAbs32((int)SkGetPackedR32(expectedPixel) -
750 (int)SkGetPackedR32(actualPixel)));
751 errG = SkMax32(errG, SkAbs32((int)SkGetPackedG32(expectedPixel) -
752 (int)SkGetPackedG32(actualPixel)));
753 errB = SkMax32(errB, SkAbs32((int)SkGetPackedB32(expectedPixel) -
754 (int)SkGetPackedB32(actualPixel)));
755 errA = SkMax32(errA, SkAbs32((int)SkGetPackedA32(expectedPixel) -
756 (int)SkGetPackedA32(actualPixel)));
757 }
758 }
759 }
epoger@google.com5efdd0c2013-03-13 14:18:40 +0000760 gm_fprintf(stderr, "---- %s: %d (of %d) differing pixels,"
761 " max per-channel mismatch R=%d G=%d B=%d A=%d\n",
762 testName, differingPixels, width*height, errR, errG, errB, errA);
epoger@google.com84a18022013-02-01 20:39:15 +0000763 }
764
765 /**
epoger@google.com908f5832013-04-12 02:23:55 +0000766 * Compares actual hash digest to expectations, returning the set of errors
epoger@google.com6f6568b2013-03-22 17:29:46 +0000767 * (if any) that we saw along the way.
epoger@google.com37269602013-01-19 04:21:27 +0000768 *
769 * If fMismatchPath has been set, and there are pixel diffs, then the
770 * actual bitmap will be written out to a file within fMismatchPath.
epoger@google.com5f995452013-06-21 18:16:47 +0000771 * And similarly for fMissingExpectationsPath...
epoger@google.com37269602013-01-19 04:21:27 +0000772 *
773 * @param expectations what expectations to compare actualBitmap against
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000774 * @param actualBitmapAndDigest the SkBitmap we actually generated, and its GmResultDigest
epoger@google.com659c8c02013-05-21 15:45:45 +0000775 * @param shortName name of test, e.g. "selftest1"
776 * @param configName name of config, e.g. "8888"
epoger@google.com37269602013-01-19 04:21:27 +0000777 * @param renderModeDescriptor e.g., "-rtree", "-deferred"
778 * @param addToJsonSummary whether to add these results (both actual and
epoger@google.comcaac3db2013-04-04 19:23:11 +0000779 * expected) to the JSON summary. Regardless of this setting, if
780 * we find an image mismatch in this test, we will write these
781 * results to the JSON summary. (This is so that we will always
782 * report errors across rendering modes, such as pipe vs tiled.
783 * See https://codereview.chromium.org/13650002/ )
epoger@google.com37269602013-01-19 04:21:27 +0000784 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000785 ErrorCombination compare_to_expectations(Expectations expectations,
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000786 const BitmapAndDigest& actualBitmapAndDigest,
epoger@google.com659c8c02013-05-21 15:45:45 +0000787 const char *shortName, const char *configName,
788 const char *renderModeDescriptor,
epoger@google.comcaac3db2013-04-04 19:23:11 +0000789 bool addToJsonSummary) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000790 ErrorCombination errors;
epoger@google.com659c8c02013-05-21 15:45:45 +0000791 SkString shortNamePlusConfig = make_shortname_plus_config(shortName, configName);
792 SkString completeNameString(shortNamePlusConfig);
epoger@google.com37269602013-01-19 04:21:27 +0000793 completeNameString.append(renderModeDescriptor);
epoger@google.comce057fe2013-05-14 15:17:46 +0000794 completeNameString.append(".");
795 completeNameString.append(kPNG_FileExtension);
epoger@google.com37269602013-01-19 04:21:27 +0000796 const char* completeName = completeNameString.c_str();
epoger@google.comee8a8e32012-12-18 19:13:49 +0000797
epoger@google.com37269602013-01-19 04:21:27 +0000798 if (expectations.empty()) {
epoger@google.com6f6568b2013-03-22 17:29:46 +0000799 errors.add(kMissingExpectations_ErrorType);
epoger@google.com5f995452013-06-21 18:16:47 +0000800
801 // Write out the "actuals" for any tests without expectations, if we have
802 // been directed to do so.
803 if (fMissingExpectationsPath) {
804 SkString path = make_bitmap_filename(fMissingExpectationsPath, shortName,
805 configName, renderModeDescriptor,
806 actualBitmapAndDigest.fDigest);
807 write_bitmap(path, actualBitmapAndDigest.fBitmap);
808 }
809
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000810 } else if (!expectations.match(actualBitmapAndDigest.fDigest)) {
epoger@google.comcaac3db2013-04-04 19:23:11 +0000811 addToJsonSummary = true;
812 // The error mode we record depends on whether this was running
813 // in a non-standard renderMode.
814 if ('\0' == *renderModeDescriptor) {
815 errors.add(kExpectationsMismatch_ErrorType);
816 } else {
817 errors.add(kRenderModeMismatch_ErrorType);
818 }
epoger@google.com84a18022013-02-01 20:39:15 +0000819
820 // Write out the "actuals" for any mismatches, if we have
821 // been directed to do so.
epoger@google.com37269602013-01-19 04:21:27 +0000822 if (fMismatchPath) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000823 SkString path = make_bitmap_filename(fMismatchPath, shortName, configName,
824 renderModeDescriptor,
825 actualBitmapAndDigest.fDigest);
826 write_bitmap(path, actualBitmapAndDigest.fBitmap);
epoger@google.com37269602013-01-19 04:21:27 +0000827 }
epoger@google.com84a18022013-02-01 20:39:15 +0000828
829 // If we have access to a single expected bitmap, log more
830 // detail about the mismatch.
831 const SkBitmap *expectedBitmapPtr = expectations.asBitmap();
832 if (NULL != expectedBitmapPtr) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000833 report_bitmap_diffs(*expectedBitmapPtr, actualBitmapAndDigest.fBitmap,
834 completeName);
epoger@google.com84a18022013-02-01 20:39:15 +0000835 }
epoger@google.coma243b222013-01-17 17:54:28 +0000836 }
epoger@google.com659c8c02013-05-21 15:45:45 +0000837 RecordTestResults(errors, shortNamePlusConfig, renderModeDescriptor);
epoger@google.coma243b222013-01-17 17:54:28 +0000838
epoger@google.com37269602013-01-19 04:21:27 +0000839 if (addToJsonSummary) {
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000840 add_actual_results_to_json_summary(completeName, actualBitmapAndDigest.fDigest, errors,
epoger@google.com37269602013-01-19 04:21:27 +0000841 expectations.ignoreFailure());
842 add_expected_results_to_json_summary(completeName, expectations);
843 }
epoger@google.coma243b222013-01-17 17:54:28 +0000844
epoger@google.com6f6568b2013-03-22 17:29:46 +0000845 return errors;
epoger@google.com06b8a192013-01-15 19:10:16 +0000846 }
847
epoger@google.com37269602013-01-19 04:21:27 +0000848 /**
849 * Add this result to the appropriate JSON collection of actual results,
epoger@google.com76c913d2013-04-26 15:06:44 +0000850 * depending on errors encountered.
epoger@google.com37269602013-01-19 04:21:27 +0000851 */
852 void add_actual_results_to_json_summary(const char testName[],
epoger@google.comd4993ff2013-05-24 14:33:28 +0000853 const GmResultDigest &actualResultDigest,
epoger@google.com76c913d2013-04-26 15:06:44 +0000854 ErrorCombination errors,
epoger@google.com37269602013-01-19 04:21:27 +0000855 bool ignoreFailure) {
epoger@google.comd4993ff2013-05-24 14:33:28 +0000856 Json::Value jsonActualResults = actualResultDigest.asJsonTypeValuePair();
epoger@google.com76c913d2013-04-26 15:06:44 +0000857 if (errors.isEmpty()) {
858 this->fJsonActualResults_Succeeded[testName] = jsonActualResults;
epoger@google.com37269602013-01-19 04:21:27 +0000859 } else {
860 if (ignoreFailure) {
861 // TODO: Once we have added the ability to compare
862 // actual results against expectations in a JSON file
863 // (where we can set ignore-failure to either true or
epoger@google.com84a18022013-02-01 20:39:15 +0000864 // false), add test cases that exercise ignored
epoger@google.com6f6568b2013-03-22 17:29:46 +0000865 // failures (both for kMissingExpectations_ErrorType
epoger@google.comcaac3db2013-04-04 19:23:11 +0000866 // and kExpectationsMismatch_ErrorType).
epoger@google.com37269602013-01-19 04:21:27 +0000867 this->fJsonActualResults_FailureIgnored[testName] =
epoger@google.com76c913d2013-04-26 15:06:44 +0000868 jsonActualResults;
epoger@google.com37269602013-01-19 04:21:27 +0000869 } else {
epoger@google.com76c913d2013-04-26 15:06:44 +0000870 if (errors.includes(kMissingExpectations_ErrorType)) {
epoger@google.com37269602013-01-19 04:21:27 +0000871 // TODO: What about the case where there IS an
epoger@google.com908f5832013-04-12 02:23:55 +0000872 // expected image hash digest, but that gm test
epoger@google.com37269602013-01-19 04:21:27 +0000873 // doesn't actually run? For now, those cases
874 // will always be ignored, because gm only looks
875 // at expectations that correspond to gm tests
876 // that were actually run.
877 //
878 // Once we have the ability to express
879 // expectations as a JSON file, we should fix this
880 // (and add a test case for which an expectation
881 // is given but the test is never run).
882 this->fJsonActualResults_NoComparison[testName] =
epoger@google.com76c913d2013-04-26 15:06:44 +0000883 jsonActualResults;
epoger@google.comeb066362013-03-08 09:39:36 +0000884 }
epoger@google.com76c913d2013-04-26 15:06:44 +0000885 if (errors.includes(kExpectationsMismatch_ErrorType) ||
886 errors.includes(kRenderModeMismatch_ErrorType)) {
887 this->fJsonActualResults_Failed[testName] = jsonActualResults;
epoger@google.com37269602013-01-19 04:21:27 +0000888 }
889 }
890 }
891 }
892
893 /**
894 * Add this test to the JSON collection of expected results.
895 */
896 void add_expected_results_to_json_summary(const char testName[],
897 Expectations expectations) {
epoger@google.com76c913d2013-04-26 15:06:44 +0000898 this->fJsonExpectedResults[testName] = expectations.asJsonValue();
epoger@google.com37269602013-01-19 04:21:27 +0000899 }
900
901 /**
902 * Compare actualBitmap to expectations stored in this->fExpectationsSource.
903 *
904 * @param gm which test generated the actualBitmap
905 * @param gRec
906 * @param writePath unless this is NULL, write out actual images into this
907 * directory
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
910 * @param document pdf or xps representation, if appropriate
epoger@google.com37269602013-01-19 04:21:27 +0000911 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000912 ErrorCombination compare_test_results_to_stored_expectations(
epoger@google.com37269602013-01-19 04:21:27 +0000913 GM* gm, const ConfigData& gRec, const char writePath[],
epoger@google.come33e1372013-07-08 19:13:33 +0000914 const BitmapAndDigest* actualBitmapAndDigest, SkDynamicMemoryWStream* document) {
epoger@google.com37269602013-01-19 04:21:27 +0000915
epoger@google.com659c8c02013-05-21 15:45:45 +0000916 SkString shortNamePlusConfig = make_shortname_plus_config(gm->shortName(), gRec.fName);
917 SkString nameWithExtension(shortNamePlusConfig);
918 nameWithExtension.append(".");
919 nameWithExtension.append(kPNG_FileExtension);
epoger@google.com9ef89ce2013-01-18 21:45:42 +0000920
epoger@google.com659c8c02013-05-21 15:45:45 +0000921 ErrorCombination errors;
epoger@google.come33e1372013-07-08 19:13:33 +0000922
923 if (NULL == actualBitmapAndDigest) {
924 // Note that we intentionally skipped validating the results for
925 // this test, because we don't know how to generate an SkBitmap
926 // version of the output.
927 RecordTestResults(ErrorCombination(kIntentionallySkipped_ErrorType),
epoger@google.com659c8c02013-05-21 15:45:45 +0000928 shortNamePlusConfig, "");
epoger@google.come33e1372013-07-08 19:13:33 +0000929 } else {
930 ExpectationsSource *expectationsSource = this->fExpectationsSource.get();
931 if (expectationsSource && (gRec.fFlags & kRead_ConfigFlag)) {
932 /*
933 * Get the expected results for this test, as one or more allowed
934 * hash digests. The current implementation of expectationsSource
935 * get this by computing the hash digest of a single PNG file on disk.
936 *
937 * TODO(epoger): This relies on the fact that
938 * force_all_opaque() was called on the bitmap before it
939 * was written to disk as a PNG in the first place. If
940 * not, the hash digest returned here may not match the
941 * hash digest of actualBitmap, which *has* been run through
942 * force_all_opaque().
943 * See comments above complete_bitmap() for more detail.
944 */
945 Expectations expectations = expectationsSource->get(nameWithExtension.c_str());
946 errors.add(compare_to_expectations(expectations, *actualBitmapAndDigest,
947 gm->shortName(), gRec.fName, "", true));
948 } else {
949 // If we are running without expectations, we still want to
950 // record the actual results.
951 add_actual_results_to_json_summary(nameWithExtension.c_str(),
952 actualBitmapAndDigest->fDigest,
953 ErrorCombination(kMissingExpectations_ErrorType),
954 false);
955 RecordTestResults(ErrorCombination(kMissingExpectations_ErrorType),
956 shortNamePlusConfig, "");
957 }
epoger@google.com9ef89ce2013-01-18 21:45:42 +0000958 }
epoger@google.com37269602013-01-19 04:21:27 +0000959
960 // TODO: Consider moving this into compare_to_expectations(),
961 // similar to fMismatchPath... for now, we don't do that, because
962 // we don't want to write out the actual bitmaps for all
963 // renderModes of all tests! That would be a lot of files.
epoger@google.com9ef89ce2013-01-18 21:45:42 +0000964 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +0000965 errors.add(write_reference_image(gRec, writePath, "", gm->shortName(),
epoger@google.come33e1372013-07-08 19:13:33 +0000966 actualBitmapAndDigest, document));
epoger@google.com9ef89ce2013-01-18 21:45:42 +0000967 }
epoger@google.com37269602013-01-19 04:21:27 +0000968
epoger@google.com6f6568b2013-03-22 17:29:46 +0000969 return errors;
epoger@google.coma243b222013-01-17 17:54:28 +0000970 }
971
epoger@google.com37269602013-01-19 04:21:27 +0000972 /**
973 * Compare actualBitmap to referenceBitmap.
974 *
epoger@google.com659c8c02013-05-21 15:45:45 +0000975 * @param shortName test name, e.g. "selftest1"
976 * @param configName configuration name, e.g. "8888"
epoger@google.com37269602013-01-19 04:21:27 +0000977 * @param renderModeDescriptor
978 * @param actualBitmap actual bitmap generated by this run
979 * @param referenceBitmap bitmap we expected to be generated
980 */
epoger@google.com6f6568b2013-03-22 17:29:46 +0000981 ErrorCombination compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +0000982 const char *shortName, const char *configName, const char *renderModeDescriptor,
epoger@google.com37269602013-01-19 04:21:27 +0000983 SkBitmap& actualBitmap, const SkBitmap* referenceBitmap) {
984
985 SkASSERT(referenceBitmap);
epoger@google.com84a18022013-02-01 20:39:15 +0000986 Expectations expectations(*referenceBitmap);
epoger@google.com6f7f14d2013-06-19 18:28:31 +0000987 BitmapAndDigest actualBitmapAndDigest(actualBitmap);
988 return compare_to_expectations(expectations, actualBitmapAndDigest, shortName,
epoger@google.com659c8c02013-05-21 15:45:45 +0000989 configName, renderModeDescriptor, false);
epoger@google.com37269602013-01-19 04:21:27 +0000990 }
991
junov@chromium.org20bd04e2013-01-16 18:43:36 +0000992 static SkPicture* generate_new_picture(GM* gm, BbhType bbhType, uint32_t recordFlags,
993 SkScalar scale = SK_Scalar1) {
epoger@google.comde961632012-10-26 18:56:36 +0000994 // Pictures are refcounted so must be on heap
junov@chromium.org3cb834b2012-12-13 16:39:53 +0000995 SkPicture* pict;
junov@chromium.org706ff2f2012-12-19 15:55:40 +0000996 int width = SkScalarCeilToInt(SkScalarMul(SkIntToScalar(gm->getISize().width()), scale));
997 int height = SkScalarCeilToInt(SkScalarMul(SkIntToScalar(gm->getISize().height()), scale));
skia.committer@gmail.comd8b27992012-12-20 02:01:41 +0000998
junov@chromium.org3cb834b2012-12-13 16:39:53 +0000999 if (kTileGrid_BbhType == bbhType) {
junov@chromium.org29b19e52013-02-27 18:35:16 +00001000 SkTileGridPicture::TileGridInfo info;
1001 info.fMargin.setEmpty();
1002 info.fOffset.setZero();
1003 info.fTileInterval.set(16, 16);
1004 pict = new SkTileGridPicture(width, height, info);
junov@chromium.org3cb834b2012-12-13 16:39:53 +00001005 } else {
1006 pict = new SkPicture;
1007 }
junov@chromium.org20bd04e2013-01-16 18:43:36 +00001008 if (kNone_BbhType != bbhType) {
1009 recordFlags |= SkPicture::kOptimizeForClippedPlayback_RecordingFlag;
1010 }
junov@chromium.org706ff2f2012-12-19 15:55:40 +00001011 SkCanvas* cv = pict->beginRecording(width, height, recordFlags);
junov@chromium.orgc938c482012-12-19 15:24:38 +00001012 cv->scale(scale, scale);
reed@google.comaef73612012-11-16 13:41:45 +00001013 invokeGM(gm, cv, false, false);
epoger@google.comde961632012-10-26 18:56:36 +00001014 pict->endRecording();
1015
1016 return pict;
1017 }
1018
1019 static SkPicture* stream_to_new_picture(const SkPicture& src) {
1020
1021 // To do in-memory commiunications with a stream, we need to:
1022 // * create a dynamic memory stream
1023 // * copy it into a buffer
1024 // * create a read stream from it
1025 // ?!?!
1026
1027 SkDynamicMemoryWStream storage;
1028 src.serialize(&storage);
1029
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001030 size_t streamSize = storage.getOffset();
epoger@google.comde961632012-10-26 18:56:36 +00001031 SkAutoMalloc dstStorage(streamSize);
1032 void* dst = dstStorage.get();
1033 //char* dst = new char [streamSize];
1034 //@todo thudson 22 April 2011 when can we safely delete [] dst?
1035 storage.copyTo(dst);
1036 SkMemoryStream pictReadback(dst, streamSize);
scroggo@google.comf1754ec2013-06-28 21:32:00 +00001037 SkPicture* retval = SkPicture::CreateFromStream(&pictReadback);
epoger@google.comde961632012-10-26 18:56:36 +00001038 return retval;
1039 }
1040
1041 // Test: draw into a bitmap or pdf.
epoger@google.com15655b22013-01-08 18:47:31 +00001042 // Depending on flags, possibly compare to an expected image.
epoger@google.com6f6568b2013-03-22 17:29:46 +00001043 ErrorCombination test_drawing(GM* gm,
1044 const ConfigData& gRec,
1045 const char writePath [],
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001046 GrSurface* gpuTarget,
epoger@google.com6f6568b2013-03-22 17:29:46 +00001047 SkBitmap* bitmap) {
epoger@google.comde961632012-10-26 18:56:36 +00001048 SkDynamicMemoryWStream document;
1049
1050 if (gRec.fBackend == kRaster_Backend ||
1051 gRec.fBackend == kGPU_Backend) {
1052 // Early exit if we can't generate the image.
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001053 ErrorCombination errors = generate_image(gm, gRec, gpuTarget, bitmap, false);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001054 if (!errors.isEmpty()) {
epoger@google.com37269602013-01-19 04:21:27 +00001055 // TODO: Add a test to exercise what the stdout and
1056 // JSON look like if we get an "early error" while
1057 // trying to generate the image.
epoger@google.comde961632012-10-26 18:56:36 +00001058 return errors;
1059 }
1060 } else if (gRec.fBackend == kPDF_Backend) {
1061 generate_pdf(gm, document);
1062#if CAN_IMAGE_PDF
1063 SkAutoDataUnref data(document.copyToData());
1064 SkMemoryStream stream(data->data(), data->size());
1065 SkPDFDocumentToBitmap(&stream, bitmap);
epoger@google.come33e1372013-07-08 19:13:33 +00001066#else
1067 bitmap = NULL; // we don't generate a bitmap rendering of the PDF file
epoger@google.comde961632012-10-26 18:56:36 +00001068#endif
1069 } else if (gRec.fBackend == kXPS_Backend) {
1070 generate_xps(gm, document);
epoger@google.come33e1372013-07-08 19:13:33 +00001071 bitmap = NULL; // we don't generate a bitmap rendering of the XPS file
epoger@google.comde961632012-10-26 18:56:36 +00001072 }
epoger@google.come33e1372013-07-08 19:13:33 +00001073
1074 if (NULL == bitmap) {
1075 return compare_test_results_to_stored_expectations(
1076 gm, gRec, writePath, NULL, &document);
1077 } else {
1078 BitmapAndDigest bitmapAndDigest(*bitmap);
1079 return compare_test_results_to_stored_expectations(
1080 gm, gRec, writePath, &bitmapAndDigest, &document);
1081 }
epoger@google.comde961632012-10-26 18:56:36 +00001082 }
1083
epoger@google.com6f6568b2013-03-22 17:29:46 +00001084 ErrorCombination test_deferred_drawing(GM* gm,
1085 const ConfigData& gRec,
1086 const SkBitmap& referenceBitmap,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001087 GrSurface* gpuTarget) {
epoger@google.comde961632012-10-26 18:56:36 +00001088 SkDynamicMemoryWStream document;
1089
1090 if (gRec.fBackend == kRaster_Backend ||
1091 gRec.fBackend == kGPU_Backend) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001092 const char renderModeDescriptor[] = "-deferred";
epoger@google.comde961632012-10-26 18:56:36 +00001093 SkBitmap bitmap;
1094 // Early exit if we can't generate the image, but this is
1095 // expected in some cases, so don't report a test failure.
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001096 ErrorCombination errors = generate_image(gm, gRec, gpuTarget, &bitmap, true);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001097 // TODO(epoger): This logic is the opposite of what is
1098 // described above... if we succeeded in generating the
1099 // -deferred image, we exit early! We should fix this
1100 // ASAP, because it is hiding -deferred errors... but for
1101 // now, I'm leaving the logic as it is so that the
1102 // refactoring change
1103 // https://codereview.chromium.org/12992003/ is unblocked.
1104 //
1105 // Filed as https://code.google.com/p/skia/issues/detail?id=1180
1106 // ('image-surface gm test is failing in "deferred" mode,
1107 // and gm is not reporting the failure')
1108 if (errors.isEmpty()) {
epoger@google.com310478e2013-04-03 18:00:39 +00001109 // TODO(epoger): Report this as a new ErrorType,
1110 // something like kImageGeneration_ErrorType?
epoger@google.com6f6568b2013-03-22 17:29:46 +00001111 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +00001112 }
epoger@google.com37269602013-01-19 04:21:27 +00001113 return compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +00001114 gm->shortName(), gRec.fName, renderModeDescriptor, bitmap, &referenceBitmap);
epoger@google.comde961632012-10-26 18:56:36 +00001115 }
epoger@google.com6f6568b2013-03-22 17:29:46 +00001116 return kEmpty_ErrorCombination;
epoger@google.comde961632012-10-26 18:56:36 +00001117 }
1118
epoger@google.comcaac3db2013-04-04 19:23:11 +00001119 ErrorCombination test_pipe_playback(GM* gm, const ConfigData& gRec,
1120 const SkBitmap& referenceBitmap, bool simulateFailure) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001121 const SkString shortNamePlusConfig = make_shortname_plus_config(gm->shortName(),
1122 gRec.fName);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001123 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001124 for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001125 SkString renderModeDescriptor("-pipe");
1126 renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
1127
1128 if (gm->getFlags() & GM::kSkipPipe_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001129 RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001130 renderModeDescriptor.c_str());
1131 errors.add(kIntentionallySkipped_ErrorType);
1132 } else {
1133 SkBitmap bitmap;
1134 SkISize size = gm->getISize();
1135 setup_bitmap(gRec, size, &bitmap);
1136 SkCanvas canvas(bitmap);
1137 installFilter(&canvas);
scroggo@google.com74b7ffd2013-04-30 02:32:41 +00001138 // Pass a decoding function so the factory GM (which has an SkBitmap
1139 // with encoded data) will not fail playback.
1140 PipeController pipeController(&canvas, &SkImageDecoder::DecodeMemory);
epoger@google.comc8263e72013-04-10 12:17:34 +00001141 SkGPipeWriter writer;
1142 SkCanvas* pipeCanvas = writer.startRecording(&pipeController,
scroggo@google.comaef2d3b2013-04-10 18:10:41 +00001143 gPipeWritingFlagCombos[i].flags,
1144 size.width(), size.height());
epoger@google.comc8263e72013-04-10 12:17:34 +00001145 if (!simulateFailure) {
1146 invokeGM(gm, pipeCanvas, false, false);
1147 }
1148 complete_bitmap(&bitmap);
1149 writer.endRecording();
1150 errors.add(compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +00001151 gm->shortName(), gRec.fName, renderModeDescriptor.c_str(), bitmap,
1152 &referenceBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001153 if (!errors.isEmpty()) {
1154 break;
1155 }
epoger@google.comde961632012-10-26 18:56:36 +00001156 }
1157 }
1158 return errors;
1159 }
1160
epoger@google.com6f6568b2013-03-22 17:29:46 +00001161 ErrorCombination test_tiled_pipe_playback(GM* gm, const ConfigData& gRec,
1162 const SkBitmap& referenceBitmap) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001163 const SkString shortNamePlusConfig = make_shortname_plus_config(gm->shortName(),
1164 gRec.fName);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001165 ErrorCombination errors;
epoger@google.comde961632012-10-26 18:56:36 +00001166 for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001167 SkString renderModeDescriptor("-tiled pipe");
1168 renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
1169
1170 if ((gm->getFlags() & GM::kSkipPipe_Flag) ||
1171 (gm->getFlags() & GM::kSkipTiled_Flag)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001172 RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001173 renderModeDescriptor.c_str());
1174 errors.add(kIntentionallySkipped_ErrorType);
1175 } else {
1176 SkBitmap bitmap;
1177 SkISize size = gm->getISize();
1178 setup_bitmap(gRec, size, &bitmap);
1179 SkCanvas canvas(bitmap);
1180 installFilter(&canvas);
scroggo@google.com74b7ffd2013-04-30 02:32:41 +00001181 TiledPipeController pipeController(bitmap, &SkImageDecoder::DecodeMemory);
epoger@google.comc8263e72013-04-10 12:17:34 +00001182 SkGPipeWriter writer;
1183 SkCanvas* pipeCanvas = writer.startRecording(&pipeController,
scroggo@google.comaef2d3b2013-04-10 18:10:41 +00001184 gPipeWritingFlagCombos[i].flags,
1185 size.width(), size.height());
epoger@google.comc8263e72013-04-10 12:17:34 +00001186 invokeGM(gm, pipeCanvas, false, false);
1187 complete_bitmap(&bitmap);
1188 writer.endRecording();
epoger@google.com659c8c02013-05-21 15:45:45 +00001189 errors.add(compare_test_results_to_reference_bitmap(gm->shortName(), gRec.fName,
epoger@google.comc8263e72013-04-10 12:17:34 +00001190 renderModeDescriptor.c_str(),
1191 bitmap, &referenceBitmap));
1192 if (!errors.isEmpty()) {
1193 break;
1194 }
epoger@google.comde961632012-10-26 18:56:36 +00001195 }
1196 }
1197 return errors;
1198 }
epoger@google.come8ebeb12012-10-29 16:42:11 +00001199
1200 //
1201 // member variables.
1202 // They are public for now, to allow easier setting by tool_main().
1203 //
1204
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001205 bool fUseFileHierarchy, fWriteChecksumBasedFilenames;
epoger@google.com5079d2c2013-04-12 14:11:21 +00001206 ErrorCombination fIgnorableErrorTypes;
epoger@google.come8ebeb12012-10-29 16:42:11 +00001207
junov@chromium.org95146eb2013-01-11 21:04:40 +00001208 const char* fMismatchPath;
epoger@google.com5f995452013-06-21 18:16:47 +00001209 const char* fMissingExpectationsPath;
junov@chromium.org95146eb2013-01-11 21:04:40 +00001210
epoger@google.com310478e2013-04-03 18:00:39 +00001211 // collection of tests that have failed with each ErrorType
1212 SkTArray<SkString> fFailedTests[kLast_ErrorType+1];
1213 int fTestsRun;
1214 SkTDict<int> fRenderModesEncountered;
epoger@google.com57f7abc2012-11-13 03:41:55 +00001215
epoger@google.com908f5832013-04-12 02:23:55 +00001216 // Where to read expectations (expected image hash digests, etc.) from.
epoger@google.com37269602013-01-19 04:21:27 +00001217 // If unset, we don't do comparisons.
1218 SkAutoTUnref<ExpectationsSource> fExpectationsSource;
1219
1220 // JSON summaries that we generate as we go (just for output).
epoger@google.comee8a8e32012-12-18 19:13:49 +00001221 Json::Value fJsonExpectedResults;
1222 Json::Value fJsonActualResults_Failed;
1223 Json::Value fJsonActualResults_FailureIgnored;
epoger@google.com9c56a8d2012-12-20 18:34:29 +00001224 Json::Value fJsonActualResults_NoComparison;
epoger@google.comee8a8e32012-12-18 19:13:49 +00001225 Json::Value fJsonActualResults_Succeeded;
1226
epoger@google.comde961632012-10-26 18:56:36 +00001227}; // end of GMMain class definition
scroggo@google.com72c96722012-06-06 21:07:10 +00001228
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001229#if SK_SUPPORT_GPU
1230static const GLContextType kDontCare_GLContextType = GrContextFactory::kNative_GLContextType;
1231#else
1232static const GLContextType kDontCare_GLContextType = 0;
1233#endif
bsalomon@google.com7361f542012-04-19 19:15:35 +00001234
1235// If the platform does not support writing PNGs of PDFs then there will be no
epoger@google.comf28dd8a2012-10-25 16:27:34 +00001236// reference images to read. However, we can always write the .pdf files
bsalomon@google.com7361f542012-04-19 19:15:35 +00001237static const ConfigFlags kPDFConfigFlags = CAN_IMAGE_PDF ? kRW_ConfigFlag :
1238 kWrite_ConfigFlag;
1239
tomhudson@google.com9875dd12011-04-25 15:49:53 +00001240static const ConfigData gRec[] = {
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001241 { SkBitmap::kARGB_8888_Config, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "8888", true },
reed@google.com69dc4ff2012-11-29 21:21:54 +00001242#if 0 // stop testing this (for now at least) since we want to remove support for it (soon please!!!)
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001243 { SkBitmap::kARGB_4444_Config, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "4444", true },
reed@google.com69dc4ff2012-11-29 21:21:54 +00001244#endif
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001245 { SkBitmap::kRGB_565_Config, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "565", true },
1246#if SK_SUPPORT_GPU
1247 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kNative_GLContextType, 0, kRW_ConfigFlag, "gpu", true },
robertphillips@google.com7bb28a12013-06-06 21:29:39 +00001248 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kNative_GLContextType, 16, kRW_ConfigFlag, "msaa16", false},
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001249 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kNative_GLContextType, 4, kRW_ConfigFlag, "msaa4", false},
bsalomon@google.com7361f542012-04-19 19:15:35 +00001250 /* The debug context does not generate images */
scroggo@google.com0f567c62013-03-20 15:35:08 +00001251 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kDebug_GLContextType, 0, kNone_ConfigFlag, "gpudebug", GR_DEBUG},
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001252#if SK_ANGLE
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001253 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kANGLE_GLContextType, 0, kRW_ConfigFlag, "angle", true },
1254 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kANGLE_GLContextType, 16, kRW_ConfigFlag, "anglemsaa16", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001255#endif // SK_ANGLE
1256#ifdef SK_MESA
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001257 { SkBitmap::kARGB_8888_Config, kGPU_Backend, GrContextFactory::kMESA_GLContextType, 0, kRW_ConfigFlag, "mesa", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001258#endif // SK_MESA
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001259#endif // SK_SUPPORT_GPU
bungeman@google.comb29c8832011-10-10 13:19:10 +00001260#ifdef SK_SUPPORT_XPS
bsalomon@google.com7361f542012-04-19 19:15:35 +00001261 /* At present we have no way of comparing XPS files (either natively or by converting to PNG). */
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001262 { SkBitmap::kARGB_8888_Config, kXPS_Backend, kDontCare_GLContextType, 0, kWrite_ConfigFlag, "xps", true },
robertphillips@google.coma73e8602012-08-02 17:56:02 +00001263#endif // SK_SUPPORT_XPS
bsalomon@google.com7361f542012-04-19 19:15:35 +00001264#ifdef SK_SUPPORT_PDF
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001265 { SkBitmap::kARGB_8888_Config, kPDF_Backend, kDontCare_GLContextType, 0, kPDFConfigFlags, "pdf", true },
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001266#endif // SK_SUPPORT_PDF
reed@android.com00dae862009-06-10 15:38:48 +00001267};
1268
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001269static const char kDefaultsConfigStr[] = "defaults";
1270static const char kExcludeConfigChar = '~';
1271
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001272static SkString configUsage() {
scroggo@google.com0f567c62013-03-20 15:35:08 +00001273 SkString result;
1274 result.appendf("Space delimited list of which configs to run. Possible options: [");
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001275 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001276 SkASSERT(gRec[i].fName != kDefaultsConfigStr);
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001277 if (i > 0) {
scroggo@google.com0f567c62013-03-20 15:35:08 +00001278 result.append("|");
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001279 }
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001280 result.appendf("%s", gRec[i].fName);
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001281 }
scroggo@google.com0f567c62013-03-20 15:35:08 +00001282 result.append("]\n");
1283 result.appendf("The default value is: \"");
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001284 SkString firstDefault;
1285 SkString allButFirstDefaults;
1286 SkString nonDefault;
scroggo@google.com0f567c62013-03-20 15:35:08 +00001287 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
1288 if (gRec[i].fRunByDefault) {
1289 if (i > 0) {
1290 result.append(" ");
1291 }
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001292 result.append(gRec[i].fName);
1293 if (firstDefault.isEmpty()) {
1294 firstDefault = gRec[i].fName;
1295 } else {
1296 if (!allButFirstDefaults.isEmpty()) {
1297 allButFirstDefaults.append(" ");
1298 }
1299 allButFirstDefaults.append(gRec[i].fName);
1300 }
1301 } else {
1302 nonDefault = gRec[i].fName;
scroggo@google.com0f567c62013-03-20 15:35:08 +00001303 }
1304 }
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001305 result.append("\"\n");
1306 result.appendf("\"%s\" evaluates to the default set of configs.\n", kDefaultsConfigStr);
1307 result.appendf("Prepending \"%c\" on a config name excludes it from the set of configs to run.\n"
1308 "Exclusions always override inclusions regardless of order.\n",
1309 kExcludeConfigChar);
1310 result.appendf("E.g. \"--config %s %c%s %s\" will run these configs:\n\t%s %s",
1311 kDefaultsConfigStr,
1312 kExcludeConfigChar,
1313 firstDefault.c_str(),
1314 nonDefault.c_str(),
1315 allButFirstDefaults.c_str(),
1316 nonDefault.c_str());
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001317 return result;
scroggo@google.com0b735632013-03-19 17:38:50 +00001318}
scroggo@google.com7d519302013-03-19 17:28:10 +00001319
epoger@google.com6f6568b2013-03-22 17:29:46 +00001320// Macro magic to convert a numeric preprocessor token into a string.
1321// Adapted from http://stackoverflow.com/questions/240353/convert-a-preprocessor-token-to-a-string
1322// This should probably be moved into one of our common headers...
1323#define TOSTRING_INTERNAL(x) #x
1324#define TOSTRING(x) TOSTRING_INTERNAL(x)
1325
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001326// Alphabetized ignoring "no" prefix ("readPath", "noreplay", "resourcePath").
scroggo@google.com0f567c62013-03-20 15:35:08 +00001327DEFINE_string(config, "", configUsage().c_str());
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001328DEFINE_bool(deferred, true, "Exercise the deferred rendering test pass.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001329DEFINE_string(excludeConfig, "", "Space delimited list of configs to skip.");
1330DEFINE_bool(forceBWtext, false, "Disable text anti-aliasing.");
1331#if SK_SUPPORT_GPU
1332DEFINE_string(gpuCacheSize, "", "<bytes> <count>: Limit the gpu cache to byte size or "
epoger@google.com6f6568b2013-03-22 17:29:46 +00001333 "object count. " TOSTRING(DEFAULT_CACHE_VALUE) " for either value means "
1334 "use the default. 0 for either disables the cache.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001335#endif
1336DEFINE_bool(hierarchy, false, "Whether to use multilevel directory structure "
1337 "when reading/writing files.");
epoger@google.com5079d2c2013-04-12 14:11:21 +00001338DEFINE_string(ignoreErrorTypes, kDefaultIgnorableErrorTypes.asString(" ").c_str(),
1339 "Space-separated list of ErrorTypes that should be ignored. If any *other* error "
1340 "types are encountered, the tool will exit with a nonzero return value.");
caryclark@google.com512c9b62013-05-10 15:16:13 +00001341DEFINE_string(match, "", "[~][^]substring[$] [...] of test name to run.\n"
1342 "Multiple matches may be separated by spaces.\n"
1343 "~ causes a matching test to always be skipped\n"
1344 "^ requires the start of the test to match\n"
1345 "$ requires the end of the test to match\n"
1346 "^ and $ requires an exact match\n"
1347 "If a test does not match any list entry,\n"
1348 "it is skipped unless some list entry starts with ~");
epoger@google.com5f995452013-06-21 18:16:47 +00001349DEFINE_string(missingExpectationsPath, "", "Write images for tests without expectations "
1350 "into this directory.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001351DEFINE_string(mismatchPath, "", "Write images for tests that failed due to "
1352 "pixel mismatches into this directory.");
1353DEFINE_string(modulo, "", "[--modulo <remainder> <divisor>]: only run tests for which "
1354 "testIndex %% divisor == remainder.");
1355DEFINE_bool(pdf, true, "Exercise the pdf rendering test pass.");
1356DEFINE_bool(pipe, true, "Exercise the SkGPipe replay test pass.");
1357DEFINE_string2(readPath, r, "", "Read reference images from this dir, and report "
1358 "any differences between those and the newly generated ones.");
1359DEFINE_bool(replay, true, "Exercise the SkPicture replay test pass.");
1360DEFINE_string2(resourcePath, i, "", "Directory that stores image resources.");
1361DEFINE_bool(rtree, true, "Exercise the R-Tree variant of SkPicture test pass.");
1362DEFINE_bool(serialize, true, "Exercise the SkPicture serialization & deserialization test pass.");
epoger@google.comcaac3db2013-04-04 19:23:11 +00001363DEFINE_bool(simulatePipePlaybackFailure, false, "Simulate a rendering failure in pipe mode only.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001364DEFINE_bool(tiledPipe, false, "Exercise tiled SkGPipe replay.");
1365DEFINE_bool(tileGrid, true, "Exercise the tile grid variant of SkPicture.");
1366DEFINE_string(tileGridReplayScales, "", "Space separated list of floating-point scale "
1367 "factors to be used for tileGrid playback testing. Default value: 1.0");
epoger@google.comb0f8b432013-04-10 18:46:25 +00001368DEFINE_bool2(verbose, v, false, "Give more detail (e.g. list all GMs run, more info about "
1369 "each test).");
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001370DEFINE_bool(writeChecksumBasedFilenames, false, "When writing out actual images, use checksum-"
1371 "based filenames, as rebaseline.py will use when downloading them from Google Storage");
1372DEFINE_string(writeJsonSummaryPath, "", "Write a JSON-formatted result summary to this file.");
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001373DEFINE_string2(writePath, w, "", "Write rendered images into this directory.");
scroggo@google.com604e0c22013-04-09 21:25:46 +00001374DEFINE_string2(writePicturePath, p, "", "Write .skp files into this directory.");
edisonn@google.comd9dfa182013-04-24 13:01:01 +00001375DEFINE_int32(pdfJpegQuality, -1, "Encodes images in JPEG at quality level N, "
1376 "which can be in range 0-100). N = -1 will disable JPEG compression. "
1377 "Default is N = 100, maximum quality.");
1378
1379static bool encode_to_dct_stream(SkWStream* stream, const SkBitmap& bitmap, const SkIRect& rect) {
1380 // Filter output of warnings that JPEG is not available for the image.
1381 if (bitmap.width() >= 65500 || bitmap.height() >= 65500) return false;
1382 if (FLAGS_pdfJpegQuality == -1) return false;
1383
1384 SkIRect bitmapBounds;
1385 SkBitmap subset;
1386 const SkBitmap* bitmapToUse = &bitmap;
1387 bitmap.getBounds(&bitmapBounds);
1388 if (rect != bitmapBounds) {
1389 SkAssertResult(bitmap.extractSubset(&subset, rect));
1390 bitmapToUse = &subset;
1391 }
1392
1393#if defined(SK_BUILD_FOR_MAC)
1394 // Workaround bug #1043 where bitmaps with referenced pixels cause
1395 // CGImageDestinationFinalize to crash
1396 SkBitmap copy;
1397 bitmapToUse->deepCopyTo(&copy, bitmapToUse->config());
1398 bitmapToUse = &copy;
1399#endif
1400
1401 return SkImageEncoder::EncodeStream(stream,
1402 *bitmapToUse,
1403 SkImageEncoder::kJPEG_Type,
1404 FLAGS_pdfJpegQuality);
1405}
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001406
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001407static int findConfig(const char config[]) {
1408 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); i++) {
1409 if (!strcmp(config, gRec[i].fName)) {
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001410 return (int) i;
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001411 }
1412 }
1413 return -1;
1414}
1415
scroggo@google.comb7dbf632013-04-23 15:38:09 +00001416static bool skip_name(SkCommandLineFlags::StringArray array, const char name[]) {
caryclark@google.com512c9b62013-05-10 15:16:13 +00001417 // FIXME: this duplicates the logic in test/skia_test.cpp -- consolidate
1418 int count = array.count();
1419 size_t testLen = strlen(name);
1420 bool anyExclude = count == 0;
reed@google.comb2a51622011-10-31 16:30:04 +00001421 for (int i = 0; i < array.count(); ++i) {
caryclark@google.com512c9b62013-05-10 15:16:13 +00001422 const char* matchName = array[i];
1423 size_t matchLen = strlen(matchName);
1424 bool matchExclude, matchStart, matchEnd;
1425 if ((matchExclude = matchName[0] == '~')) {
1426 anyExclude = true;
1427 matchName++;
1428 matchLen--;
1429 }
1430 if ((matchStart = matchName[0] == '^')) {
1431 matchName++;
1432 matchLen--;
1433 }
1434 if ((matchEnd = matchName[matchLen - 1] == '$')) {
1435 matchLen--;
1436 }
1437 if (matchStart ? (!matchEnd || matchLen == testLen)
1438 && strncmp(name, matchName, matchLen) == 0
1439 : matchEnd ? matchLen <= testLen
1440 && strncmp(name + testLen - matchLen, matchName, matchLen) == 0
1441 : strstr(name, matchName) != 0) {
1442 return matchExclude;
reed@google.comb2a51622011-10-31 16:30:04 +00001443 }
1444 }
caryclark@google.com512c9b62013-05-10 15:16:13 +00001445 return !anyExclude;
reed@google.comb2a51622011-10-31 16:30:04 +00001446}
1447
bsalomon@google.comd9f826c2011-07-18 15:25:04 +00001448namespace skiagm {
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001449#if SK_SUPPORT_GPU
bsalomon@google.com7361f542012-04-19 19:15:35 +00001450SkAutoTUnref<GrContext> gGrContext;
1451/**
bsalomon@google.comc7a24d22012-11-01 18:03:48 +00001452 * Sets the global GrContext, accessible by individual GMs
bsalomon@google.com7361f542012-04-19 19:15:35 +00001453 */
caryclark@google.com13130862012-06-06 12:10:45 +00001454static void SetGr(GrContext* grContext) {
bsalomon@google.com7361f542012-04-19 19:15:35 +00001455 SkSafeRef(grContext);
1456 gGrContext.reset(grContext);
bsalomon@google.comd9f826c2011-07-18 15:25:04 +00001457}
bsalomon@google.com7361f542012-04-19 19:15:35 +00001458
1459/**
1460 * Gets the global GrContext, can be called by GM tests.
1461 */
caryclark@google.com13130862012-06-06 12:10:45 +00001462GrContext* GetGr();
bsalomon@google.com7361f542012-04-19 19:15:35 +00001463GrContext* GetGr() {
1464 return gGrContext.get();
1465}
1466
1467/**
1468 * Sets the global GrContext and then resets it to its previous value at
1469 * destruction.
1470 */
1471class AutoResetGr : SkNoncopyable {
1472public:
1473 AutoResetGr() : fOld(NULL) {}
1474 void set(GrContext* context) {
1475 SkASSERT(NULL == fOld);
1476 fOld = GetGr();
1477 SkSafeRef(fOld);
1478 SetGr(context);
1479 }
1480 ~AutoResetGr() { SetGr(fOld); SkSafeUnref(fOld); }
1481private:
1482 GrContext* fOld;
1483};
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001484#else
epoger@google.com80724df2013-03-21 13:49:54 +00001485GrContext* GetGr();
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00001486GrContext* GetGr() { return NULL; }
1487#endif
bsalomon@google.comd9f826c2011-07-18 15:25:04 +00001488}
1489
reed@google.comfb2cd422013-01-04 14:43:03 +00001490template <typename T> void appendUnique(SkTDArray<T>* array, const T& value) {
1491 int index = array->find(value);
1492 if (index < 0) {
1493 *array->append() = value;
1494 }
1495}
1496
epoger@google.com80724df2013-03-21 13:49:54 +00001497/**
1498 * Run this test in a number of different configs (8888, 565, PDF,
1499 * etc.), confirming that the resulting bitmaps match expectations
1500 * (which may be different for each config).
1501 *
1502 * Returns all errors encountered while doing so.
1503 */
epoger@google.com6f6568b2013-03-22 17:29:46 +00001504ErrorCombination run_multiple_configs(GMMain &gmmain, GM *gm, const SkTDArray<size_t> &configs,
1505 GrContextFactory *grFactory);
1506ErrorCombination run_multiple_configs(GMMain &gmmain, GM *gm, const SkTDArray<size_t> &configs,
1507 GrContextFactory *grFactory) {
epoger@google.comc8263e72013-04-10 12:17:34 +00001508 const char renderModeDescriptor[] = "";
epoger@google.com6f6568b2013-03-22 17:29:46 +00001509 ErrorCombination errorsForAllConfigs;
epoger@google.com80724df2013-03-21 13:49:54 +00001510 uint32_t gmFlags = gm->getFlags();
1511
epoger@google.com80724df2013-03-21 13:49:54 +00001512 for (int i = 0; i < configs.count(); i++) {
1513 ConfigData config = gRec[configs[i]];
epoger@google.com659c8c02013-05-21 15:45:45 +00001514 const SkString shortNamePlusConfig = gmmain.make_shortname_plus_config(gm->shortName(),
1515 config.fName);
epoger@google.com80724df2013-03-21 13:49:54 +00001516
1517 // Skip any tests that we don't even need to try.
epoger@google.comc8263e72013-04-10 12:17:34 +00001518 // If any of these were skipped on a per-GM basis, record them as
1519 // kIntentionallySkipped.
1520 if (kPDF_Backend == config.fBackend) {
1521 if (!FLAGS_pdf) {
epoger@google.com80724df2013-03-21 13:49:54 +00001522 continue;
1523 }
epoger@google.comc8263e72013-04-10 12:17:34 +00001524 if (gmFlags & GM::kSkipPDF_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001525 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001526 renderModeDescriptor);
1527 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
1528 continue;
1529 }
1530 }
epoger@google.com80724df2013-03-21 13:49:54 +00001531 if ((gmFlags & GM::kSkip565_Flag) &&
1532 (kRaster_Backend == config.fBackend) &&
1533 (SkBitmap::kRGB_565_Config == config.fConfig)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001534 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001535 renderModeDescriptor);
1536 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
epoger@google.com80724df2013-03-21 13:49:54 +00001537 continue;
1538 }
1539 if ((gmFlags & GM::kSkipGPU_Flag) &&
1540 kGPU_Backend == config.fBackend) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001541 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001542 renderModeDescriptor);
1543 errorsForAllConfigs.add(kIntentionallySkipped_ErrorType);
epoger@google.com80724df2013-03-21 13:49:54 +00001544 continue;
1545 }
1546
1547 // Now we know that we want to run this test and record its
1548 // success or failure.
epoger@google.com6f6568b2013-03-22 17:29:46 +00001549 ErrorCombination errorsForThisConfig;
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001550 GrSurface* gpuTarget = NULL;
epoger@google.com80724df2013-03-21 13:49:54 +00001551#if SK_SUPPORT_GPU
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001552 SkAutoTUnref<GrSurface> auGpuTarget;
epoger@google.com80724df2013-03-21 13:49:54 +00001553 AutoResetGr autogr;
epoger@google.com6f6568b2013-03-22 17:29:46 +00001554 if ((errorsForThisConfig.isEmpty()) && (kGPU_Backend == config.fBackend)) {
epoger@google.com80724df2013-03-21 13:49:54 +00001555 GrContext* gr = grFactory->get(config.fGLContextType);
1556 bool grSuccess = false;
1557 if (gr) {
1558 // create a render target to back the device
1559 GrTextureDesc desc;
1560 desc.fConfig = kSkia8888_GrPixelConfig;
1561 desc.fFlags = kRenderTarget_GrTextureFlagBit;
1562 desc.fWidth = gm->getISize().width();
1563 desc.fHeight = gm->getISize().height();
1564 desc.fSampleCnt = config.fSampleCnt;
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001565 auGpuTarget.reset(gr->createUncachedTexture(desc, NULL, 0));
1566 if (NULL != auGpuTarget) {
1567 gpuTarget = auGpuTarget;
1568 grSuccess = true;
epoger@google.com80724df2013-03-21 13:49:54 +00001569 autogr.set(gr);
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001570 // Set the user specified cache limits if non-default.
1571 size_t bytes;
1572 int count;
1573 gr->getTextureCacheLimits(&count, &bytes);
1574 if (DEFAULT_CACHE_VALUE != gGpuCacheSizeBytes) {
1575 bytes = static_cast<size_t>(gGpuCacheSizeBytes);
1576 }
1577 if (DEFAULT_CACHE_VALUE != gGpuCacheSizeCount) {
1578 count = gGpuCacheSizeCount;
1579 }
1580 gr->setTextureCacheLimits(count, bytes);
epoger@google.com80724df2013-03-21 13:49:54 +00001581 }
epoger@google.com80724df2013-03-21 13:49:54 +00001582 }
1583 if (!grSuccess) {
epoger@google.com6f6568b2013-03-22 17:29:46 +00001584 errorsForThisConfig.add(kNoGpuContext_ErrorType);
epoger@google.com80724df2013-03-21 13:49:54 +00001585 }
1586 }
1587#endif
1588
1589 SkBitmap comparisonBitmap;
1590
1591 const char* writePath;
1592 if (FLAGS_writePath.count() == 1) {
1593 writePath = FLAGS_writePath[0];
1594 } else {
1595 writePath = NULL;
1596 }
epoger@google.com6f6568b2013-03-22 17:29:46 +00001597 if (errorsForThisConfig.isEmpty()) {
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001598 errorsForThisConfig.add(gmmain.test_drawing(gm,config, writePath, gpuTarget,
1599 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001600 }
1601
epoger@google.com6f6568b2013-03-22 17:29:46 +00001602 if (FLAGS_deferred && errorsForThisConfig.isEmpty() &&
1603 (kGPU_Backend == config.fBackend || kRaster_Backend == config.fBackend)) {
1604 errorsForThisConfig.add(gmmain.test_deferred_drawing(gm, config, comparisonBitmap,
bsalomon@google.com123ac1d2013-03-28 19:18:12 +00001605 gpuTarget));
epoger@google.com80724df2013-03-21 13:49:54 +00001606 }
1607
epoger@google.com6f6568b2013-03-22 17:29:46 +00001608 errorsForAllConfigs.add(errorsForThisConfig);
epoger@google.com80724df2013-03-21 13:49:54 +00001609 }
1610 return errorsForAllConfigs;
1611}
1612
1613/**
1614 * Run this test in a number of different drawing modes (pipe,
1615 * deferred, tiled, etc.), confirming that the resulting bitmaps all
1616 * *exactly* match comparisonBitmap.
1617 *
1618 * Returns all errors encountered while doing so.
1619 */
epoger@google.com6f6568b2013-03-22 17:29:46 +00001620ErrorCombination run_multiple_modes(GMMain &gmmain, GM *gm, const ConfigData &compareConfig,
1621 const SkBitmap &comparisonBitmap,
1622 const SkTDArray<SkScalar> &tileGridReplayScales);
1623ErrorCombination run_multiple_modes(GMMain &gmmain, GM *gm, const ConfigData &compareConfig,
1624 const SkBitmap &comparisonBitmap,
1625 const SkTDArray<SkScalar> &tileGridReplayScales) {
1626 ErrorCombination errorsForAllModes;
epoger@google.com80724df2013-03-21 13:49:54 +00001627 uint32_t gmFlags = gm->getFlags();
epoger@google.com659c8c02013-05-21 15:45:45 +00001628 const SkString shortNamePlusConfig = gmmain.make_shortname_plus_config(gm->shortName(),
1629 compareConfig.fName);
epoger@google.com80724df2013-03-21 13:49:54 +00001630
epoger@google.comc8263e72013-04-10 12:17:34 +00001631 SkPicture* pict = gmmain.generate_new_picture(gm, kNone_BbhType, 0);
1632 SkAutoUnref aur(pict);
1633 if (FLAGS_replay) {
1634 const char renderModeDescriptor[] = "-replay";
1635 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001636 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1637 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001638 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1639 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001640 SkBitmap bitmap;
1641 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap);
epoger@google.comc8263e72013-04-10 12:17:34 +00001642 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +00001643 gm->shortName(), compareConfig.fName, renderModeDescriptor, bitmap,
1644 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001645 }
epoger@google.comc8263e72013-04-10 12:17:34 +00001646 }
epoger@google.com80724df2013-03-21 13:49:54 +00001647
epoger@google.comc8263e72013-04-10 12:17:34 +00001648 if (FLAGS_serialize) {
1649 const char renderModeDescriptor[] = "-serialize";
1650 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001651 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1652 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001653 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1654 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001655 SkPicture* repict = gmmain.stream_to_new_picture(*pict);
1656 SkAutoUnref aurr(repict);
epoger@google.com80724df2013-03-21 13:49:54 +00001657 SkBitmap bitmap;
1658 gmmain.generate_image_from_picture(gm, compareConfig, repict, &bitmap);
epoger@google.comc8263e72013-04-10 12:17:34 +00001659 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +00001660 gm->shortName(), compareConfig.fName, renderModeDescriptor, bitmap,
1661 &comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001662 }
epoger@google.com80724df2013-03-21 13:49:54 +00001663 }
1664
epoger@google.comc8263e72013-04-10 12:17:34 +00001665 if ((1 == FLAGS_writePicturePath.count()) &&
1666 !(gmFlags & GM::kSkipPicture_Flag)) {
1667 const char* pictureSuffix = "skp";
epoger@google.com659c8c02013-05-21 15:45:45 +00001668 // TODO(epoger): Make sure this still works even though the
1669 // filename now contains the config name (it used to contain
1670 // just the shortName). I think this is actually an
1671 // *improvement*, because now runs with different configs will
1672 // write out their SkPictures to separate files rather than
1673 // overwriting each other. But we should make sure it doesn't
1674 // break anybody.
1675 SkString path = gmmain.make_filename(FLAGS_writePicturePath[0], gm->shortName(),
1676 compareConfig.fName, "", pictureSuffix);
epoger@google.comc8263e72013-04-10 12:17:34 +00001677 SkFILEWStream stream(path.c_str());
1678 pict->serialize(&stream);
epoger@google.com80724df2013-03-21 13:49:54 +00001679 }
1680
epoger@google.comc8263e72013-04-10 12:17:34 +00001681 if (FLAGS_rtree) {
1682 const char renderModeDescriptor[] = "-rtree";
1683 if (gmFlags & GM::kSkipPicture_Flag) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001684 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
1685 renderModeDescriptor);
epoger@google.comc8263e72013-04-10 12:17:34 +00001686 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1687 } else {
epoger@google.com80724df2013-03-21 13:49:54 +00001688 SkPicture* pict = gmmain.generate_new_picture(
epoger@google.comc8263e72013-04-10 12:17:34 +00001689 gm, kRTree_BbhType, SkPicture::kUsePathBoundsForClip_RecordingFlag);
epoger@google.com80724df2013-03-21 13:49:54 +00001690 SkAutoUnref aur(pict);
1691 SkBitmap bitmap;
epoger@google.comc8263e72013-04-10 12:17:34 +00001692 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap);
epoger@google.com6f6568b2013-03-22 17:29:46 +00001693 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +00001694 gm->shortName(), compareConfig.fName, renderModeDescriptor, bitmap,
1695 &comparisonBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001696 }
1697 }
1698
1699 if (FLAGS_tileGrid) {
1700 for(int scaleIndex = 0; scaleIndex < tileGridReplayScales.count(); ++scaleIndex) {
1701 SkScalar replayScale = tileGridReplayScales[scaleIndex];
1702 SkString renderModeDescriptor("-tilegrid");
1703 if (SK_Scalar1 != replayScale) {
1704 renderModeDescriptor += "-scale-";
1705 renderModeDescriptor.appendScalar(replayScale);
1706 }
1707
1708 if ((gmFlags & GM::kSkipPicture_Flag) ||
1709 ((gmFlags & GM::kSkipScaledReplay_Flag) && replayScale != 1)) {
epoger@google.com659c8c02013-05-21 15:45:45 +00001710 gmmain.RecordTestResults(kIntentionallySkipped_ErrorType, shortNamePlusConfig,
epoger@google.comc8263e72013-04-10 12:17:34 +00001711 renderModeDescriptor.c_str());
1712 errorsForAllModes.add(kIntentionallySkipped_ErrorType);
1713 } else {
1714 // We record with the reciprocal scale to obtain a replay
1715 // result that can be validated against comparisonBitmap.
1716 SkScalar recordScale = SkScalarInvert(replayScale);
1717 SkPicture* pict = gmmain.generate_new_picture(
1718 gm, kTileGrid_BbhType, SkPicture::kUsePathBoundsForClip_RecordingFlag,
1719 recordScale);
1720 SkAutoUnref aur(pict);
1721 SkBitmap bitmap;
1722 // We cannot yet pass 'true' to generate_image_from_picture to
1723 // perform actual tiled rendering (see Issue 1198 -
1724 // https://code.google.com/p/skia/issues/detail?id=1198)
1725 gmmain.generate_image_from_picture(gm, compareConfig, pict, &bitmap,
1726 replayScale /*, true */);
1727 errorsForAllModes.add(gmmain.compare_test_results_to_reference_bitmap(
epoger@google.com659c8c02013-05-21 15:45:45 +00001728 gm->shortName(), compareConfig.fName, renderModeDescriptor.c_str(), bitmap,
1729 &comparisonBitmap));
epoger@google.comc8263e72013-04-10 12:17:34 +00001730 }
epoger@google.com80724df2013-03-21 13:49:54 +00001731 }
1732 }
1733
1734 // run the pipe centric GM steps
epoger@google.comc8263e72013-04-10 12:17:34 +00001735 if (FLAGS_pipe) {
1736 errorsForAllModes.add(gmmain.test_pipe_playback(gm, compareConfig, comparisonBitmap,
1737 FLAGS_simulatePipePlaybackFailure));
1738 if (FLAGS_tiledPipe) {
1739 errorsForAllModes.add(gmmain.test_tiled_pipe_playback(gm, compareConfig,
1740 comparisonBitmap));
epoger@google.com80724df2013-03-21 13:49:54 +00001741 }
epoger@google.com80724df2013-03-21 13:49:54 +00001742 }
1743 return errorsForAllModes;
1744}
1745
epoger@google.com310478e2013-04-03 18:00:39 +00001746/**
1747 * Return a list of all entries in an array of strings as a single string
1748 * of this form:
1749 * "item1", "item2", "item3"
1750 */
1751SkString list_all(const SkTArray<SkString> &stringArray);
1752SkString list_all(const SkTArray<SkString> &stringArray) {
1753 SkString total;
1754 for (int i = 0; i < stringArray.count(); i++) {
1755 if (i > 0) {
1756 total.append(", ");
1757 }
1758 total.append("\"");
1759 total.append(stringArray[i]);
1760 total.append("\"");
1761 }
1762 return total;
1763}
1764
1765/**
1766 * Return a list of configuration names, as a single string of this form:
1767 * "item1", "item2", "item3"
1768 *
1769 * @param configs configurations, as a list of indices into gRec
1770 */
1771SkString list_all_config_names(const SkTDArray<size_t> &configs);
1772SkString list_all_config_names(const SkTDArray<size_t> &configs) {
1773 SkString total;
1774 for (int i = 0; i < configs.count(); i++) {
1775 if (i > 0) {
1776 total.append(", ");
1777 }
1778 total.append("\"");
1779 total.append(gRec[configs[i]].fName);
1780 total.append("\"");
1781 }
1782 return total;
1783}
1784
epoger@google.comfdea3252013-05-02 18:24:03 +00001785bool prepare_subdirectories(const char *root, bool useFileHierarchy,
1786 const SkTDArray<size_t> &configs);
1787bool prepare_subdirectories(const char *root, bool useFileHierarchy,
1788 const SkTDArray<size_t> &configs) {
1789 if (!sk_mkdir(root)) {
1790 return false;
1791 }
1792 if (useFileHierarchy) {
1793 for (int i = 0; i < configs.count(); i++) {
1794 ConfigData config = gRec[configs[i]];
1795 SkString subdir;
1796 subdir.appendf("%s%c%s", root, SkPATH_SEPARATOR, config.fName);
1797 if (!sk_mkdir(subdir.c_str())) {
1798 return false;
1799 }
1800 }
1801 }
1802 return true;
1803}
1804
epoger@google.com0b62b3d2013-03-20 17:59:28 +00001805int tool_main(int argc, char** argv);
1806int tool_main(int argc, char** argv) {
1807
1808#if SK_ENABLE_INST_COUNT
1809 gPrintInstCount = true;
1810#endif
1811
1812 SkGraphics::Init();
1813 // we don't need to see this during a run
1814 gSkSuppressFontCachePurgeSpew = true;
1815
1816 setSystemPreferences();
1817 GMMain gmmain;
1818
1819 SkTDArray<size_t> configs;
1820 SkTDArray<size_t> excludeConfigs;
1821 bool userConfig = false;
1822
1823 SkString usage;
1824 usage.printf("Run the golden master tests.\n");
scroggo@google.comd9ba9a02013-03-21 19:43:15 +00001825 SkCommandLineFlags::SetUsage(usage.c_str());
1826 SkCommandLineFlags::Parse(argc, argv);
epoger@google.com0b62b3d2013-03-20 17:59:28 +00001827
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001828 gmmain.fUseFileHierarchy = FLAGS_hierarchy;
epoger@google.com6f7f14d2013-06-19 18:28:31 +00001829 gmmain.fWriteChecksumBasedFilenames = FLAGS_writeChecksumBasedFilenames;
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001830 if (FLAGS_mismatchPath.count() == 1) {
1831 gmmain.fMismatchPath = FLAGS_mismatchPath[0];
1832 }
epoger@google.com5f995452013-06-21 18:16:47 +00001833 if (FLAGS_missingExpectationsPath.count() == 1) {
1834 gmmain.fMissingExpectationsPath = FLAGS_missingExpectationsPath[0];
1835 }
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001836
1837 for (int i = 0; i < FLAGS_config.count(); i++) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001838 const char* config = FLAGS_config[i];
1839 userConfig = true;
1840 bool exclude = false;
1841 if (*config == kExcludeConfigChar) {
1842 exclude = true;
1843 config += 1;
1844 }
1845 int index = findConfig(config);
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001846 if (index >= 0) {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001847 if (exclude) {
1848 *excludeConfigs.append() = index;
1849 } else {
1850 appendUnique<size_t>(&configs, index);
1851 }
1852 } else if (0 == strcmp(kDefaultsConfigStr, config)) {
1853 for (size_t c = 0; c < SK_ARRAY_COUNT(gRec); ++c) {
1854 if (gRec[c].fRunByDefault) {
1855 if (exclude) {
1856 gm_fprintf(stderr, "%c%s is not allowed.\n",
1857 kExcludeConfigChar, kDefaultsConfigStr);
1858 return -1;
1859 } else {
1860 appendUnique<size_t>(&configs, c);
1861 }
1862 }
1863 }
scroggo@google.com0b735632013-03-19 17:38:50 +00001864 } else {
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001865 gm_fprintf(stderr, "unrecognized config %s\n", config);
scroggo@google.com7d519302013-03-19 17:28:10 +00001866 return -1;
1867 }
1868 }
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001869
1870 for (int i = 0; i < FLAGS_excludeConfig.count(); i++) {
1871 int index = findConfig(FLAGS_excludeConfig[i]);
1872 if (index >= 0) {
1873 *excludeConfigs.append() = index;
1874 } else {
1875 gm_fprintf(stderr, "unrecognized excludeConfig %s\n", FLAGS_excludeConfig[i]);
1876 return -1;
1877 }
1878 }
1879
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001880 int moduloRemainder = -1;
1881 int moduloDivisor = -1;
1882
1883 if (FLAGS_modulo.count() == 2) {
1884 moduloRemainder = atoi(FLAGS_modulo[0]);
1885 moduloDivisor = atoi(FLAGS_modulo[1]);
1886 if (moduloRemainder < 0 || moduloDivisor <= 0 || moduloRemainder >= moduloDivisor) {
1887 gm_fprintf(stderr, "invalid modulo values.");
1888 return -1;
1889 }
tomhudson@google.com9875dd12011-04-25 15:49:53 +00001890 }
reed@google.com873cb1e2010-12-23 15:00:45 +00001891
epoger@google.com5079d2c2013-04-12 14:11:21 +00001892 if (FLAGS_ignoreErrorTypes.count() > 0) {
1893 gmmain.fIgnorableErrorTypes = ErrorCombination();
1894 for (int i = 0; i < FLAGS_ignoreErrorTypes.count(); i++) {
1895 ErrorType type;
1896 const char *name = FLAGS_ignoreErrorTypes[i];
1897 if (!getErrorTypeByName(name, &type)) {
1898 gm_fprintf(stderr, "cannot find ErrorType with name '%s'\n", name);
1899 return -1;
1900 } else {
1901 gmmain.fIgnorableErrorTypes.add(type);
1902 }
1903 }
1904 }
1905
epoger@google.com6f6568b2013-03-22 17:29:46 +00001906#if SK_SUPPORT_GPU
1907 if (FLAGS_gpuCacheSize.count() > 0) {
1908 if (FLAGS_gpuCacheSize.count() != 2) {
1909 gm_fprintf(stderr, "--gpuCacheSize requires two arguments\n");
1910 return -1;
1911 }
1912 gGpuCacheSizeBytes = atoi(FLAGS_gpuCacheSize[0]);
1913 gGpuCacheSizeCount = atoi(FLAGS_gpuCacheSize[1]);
1914 } else {
1915 gGpuCacheSizeBytes = DEFAULT_CACHE_VALUE;
1916 gGpuCacheSizeCount = DEFAULT_CACHE_VALUE;
1917 }
1918#endif
1919
1920 SkTDArray<SkScalar> tileGridReplayScales;
1921 *tileGridReplayScales.append() = SK_Scalar1; // By default only test at scale 1.0
1922 if (FLAGS_tileGridReplayScales.count() > 0) {
1923 tileGridReplayScales.reset();
1924 for (int i = 0; i < FLAGS_tileGridReplayScales.count(); i++) {
1925 double val = atof(FLAGS_tileGridReplayScales[i]);
1926 if (0 < val) {
1927 *tileGridReplayScales.append() = SkDoubleToScalar(val);
1928 }
1929 }
1930 if (0 == tileGridReplayScales.count()) {
1931 // Should have at least one scale
1932 gm_fprintf(stderr, "--tileGridReplayScales requires at least one scale.\n");
1933 return -1;
1934 }
1935 }
1936
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001937 if (!userConfig) {
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001938 // if no config is specified by user, add the defaults
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001939 for (size_t i = 0; i < SK_ARRAY_COUNT(gRec); ++i) {
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001940 if (gRec[i].fRunByDefault) {
1941 *configs.append() = i;
1942 }
scroggo@google.com5867c0f2012-06-07 17:39:48 +00001943 }
1944 }
reed@google.comfb2cd422013-01-04 14:43:03 +00001945 // now remove any explicitly excluded configs
1946 for (int i = 0; i < excludeConfigs.count(); ++i) {
1947 int index = configs.find(excludeConfigs[i]);
1948 if (index >= 0) {
1949 configs.remove(index);
1950 // now assert that there was only one copy in configs[]
1951 SkASSERT(configs.find(excludeConfigs[i]) < 0);
1952 }
1953 }
1954
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001955#if SK_SUPPORT_GPU
1956 GrContextFactory* grFactory = new GrContextFactory;
1957 for (int i = 0; i < configs.count(); ++i) {
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001958 size_t index = configs[i];
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001959 if (kGPU_Backend == gRec[index].fBackend) {
1960 GrContext* ctx = grFactory->get(gRec[index].fGLContextType);
1961 if (NULL == ctx) {
epoger@google.comb0f8b432013-04-10 18:46:25 +00001962 gm_fprintf(stderr, "GrContext could not be created for config %s."
1963 " Config will be skipped.\n", gRec[index].fName);
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001964 configs.remove(i);
1965 --i;
bsalomon@google.com42db2e42013-06-11 19:22:44 +00001966 continue;
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001967 }
1968 if (gRec[index].fSampleCnt > ctx->getMaxSampleCount()) {
epoger@google.comb0f8b432013-04-10 18:46:25 +00001969 gm_fprintf(stderr, "Sample count (%d) of config %s is not supported."
1970 " Config will be skipped.\n", gRec[index].fSampleCnt, gRec[index].fName);
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001971 configs.remove(i);
1972 --i;
1973 }
1974 }
1975 }
epoger@google.com80724df2013-03-21 13:49:54 +00001976#else
1977 GrContextFactory* grFactory = NULL;
bsalomon@google.com4c75f242013-03-19 18:58:43 +00001978#endif
1979
bsalomon@google.comdd8e3532013-04-24 18:07:11 +00001980 if (configs.isEmpty()) {
1981 gm_fprintf(stderr, "No configs to run.");
1982 return -1;
1983 }
1984
1985 // now show the user the set of configs that will be run.
1986 SkString configStr("These configs will be run: ");
1987 // show the user the config that will run.
1988 for (int i = 0; i < configs.count(); ++i) {
1989 configStr.appendf("%s%s", gRec[configs[i]].fName, (i == configs.count() - 1) ? "\n" : " ");
1990 }
1991 gm_fprintf(stdout, "%s", configStr.c_str());
1992
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001993 if (FLAGS_resourcePath.count() == 1) {
1994 GM::SetResourcePath(FLAGS_resourcePath[0]);
1995 }
robertphillips@google.com8570b5c2012-03-20 17:40:58 +00001996
scroggo@google.com09fd4d22013-03-20 14:20:18 +00001997 if (FLAGS_readPath.count() == 1) {
1998 const char* readPath = FLAGS_readPath[0];
epoger@google.com37269602013-01-19 04:21:27 +00001999 if (!sk_exists(readPath)) {
epoger@google.com5efdd0c2013-03-13 14:18:40 +00002000 gm_fprintf(stderr, "readPath %s does not exist!\n", readPath);
epoger@google.com37269602013-01-19 04:21:27 +00002001 return -1;
2002 }
2003 if (sk_isdir(readPath)) {
epoger@google.comb0f8b432013-04-10 18:46:25 +00002004 if (FLAGS_verbose) {
2005 gm_fprintf(stdout, "reading from %s\n", readPath);
2006 }
epoger@google.com37269602013-01-19 04:21:27 +00002007 gmmain.fExpectationsSource.reset(SkNEW_ARGS(
epoger@google.comb0f8b432013-04-10 18:46:25 +00002008 IndividualImageExpectationsSource, (readPath)));
epoger@google.com37269602013-01-19 04:21:27 +00002009 } else {
epoger@google.comb0f8b432013-04-10 18:46:25 +00002010 if (FLAGS_verbose) {
2011 gm_fprintf(stdout, "reading expectations from JSON summary file %s\n", readPath);
2012 }
epoger@google.comd271d242013-02-13 18:14:48 +00002013 gmmain.fExpectationsSource.reset(SkNEW_ARGS(
2014 JsonExpectationsSource, (readPath)));
epoger@google.com37269602013-01-19 04:21:27 +00002015 }
chudy@google.comf32f6e82012-07-12 15:42:37 +00002016 }
epoger@google.comb0f8b432013-04-10 18:46:25 +00002017 if (FLAGS_verbose) {
2018 if (FLAGS_writePath.count() == 1) {
2019 gm_fprintf(stdout, "writing to %s\n", FLAGS_writePath[0]);
2020 }
epoger@google.comfdea3252013-05-02 18:24:03 +00002021 if (NULL != gmmain.fMismatchPath) {
2022 gm_fprintf(stdout, "writing mismatches to %s\n", gmmain.fMismatchPath);
2023 }
epoger@google.com5f995452013-06-21 18:16:47 +00002024 if (NULL != gmmain.fMissingExpectationsPath) {
2025 gm_fprintf(stdout, "writing images without expectations to %s\n",
2026 gmmain.fMissingExpectationsPath);
2027 }
epoger@google.comb0f8b432013-04-10 18:46:25 +00002028 if (FLAGS_writePicturePath.count() == 1) {
2029 gm_fprintf(stdout, "writing pictures to %s\n", FLAGS_writePicturePath[0]);
2030 }
2031 if (FLAGS_resourcePath.count() == 1) {
2032 gm_fprintf(stdout, "reading resources from %s\n", FLAGS_resourcePath[0]);
2033 }
robertphillips@google.com8570b5c2012-03-20 17:40:58 +00002034 }
2035
epoger@google.com82cb65b2012-10-29 18:59:17 +00002036 if (moduloDivisor <= 0) {
2037 moduloRemainder = -1;
reed@google.comae7b8f32012-10-18 21:30:57 +00002038 }
epoger@google.com82cb65b2012-10-29 18:59:17 +00002039 if (moduloRemainder < 0 || moduloRemainder >= moduloDivisor) {
2040 moduloRemainder = -1;
reed@google.comae7b8f32012-10-18 21:30:57 +00002041 }
2042
epoger@google.com310478e2013-04-03 18:00:39 +00002043 int gmsRun = 0;
reed@google.comae7b8f32012-10-18 21:30:57 +00002044 int gmIndex = -1;
2045 SkString moduloStr;
2046
epoger@google.come8ebeb12012-10-29 16:42:11 +00002047 // If we will be writing out files, prepare subdirectories.
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002048 if (FLAGS_writePath.count() == 1) {
epoger@google.comfdea3252013-05-02 18:24:03 +00002049 if (!prepare_subdirectories(FLAGS_writePath[0], gmmain.fUseFileHierarchy, configs)) {
epoger@google.come8ebeb12012-10-29 16:42:11 +00002050 return -1;
2051 }
epoger@google.comfdea3252013-05-02 18:24:03 +00002052 }
2053 if (NULL != gmmain.fMismatchPath) {
2054 if (!prepare_subdirectories(gmmain.fMismatchPath, gmmain.fUseFileHierarchy, configs)) {
2055 return -1;
epoger@google.come8ebeb12012-10-29 16:42:11 +00002056 }
2057 }
epoger@google.com5f995452013-06-21 18:16:47 +00002058 if (NULL != gmmain.fMissingExpectationsPath) {
2059 if (!prepare_subdirectories(gmmain.fMissingExpectationsPath, gmmain.fUseFileHierarchy,
2060 configs)) {
2061 return -1;
2062 }
2063 }
epoger@google.come8ebeb12012-10-29 16:42:11 +00002064
edisonn@google.comd9dfa182013-04-24 13:01:01 +00002065 if (FLAGS_pdfJpegQuality < -1 || FLAGS_pdfJpegQuality > 100) {
2066 gm_fprintf(stderr, "%s\n", "pdfJpegQuality must be in [-1 .. 100] range.");
2067 }
2068
bsalomon@google.com7361f542012-04-19 19:15:35 +00002069 Iter iter;
2070 GM* gm;
reed@android.com00dae862009-06-10 15:38:48 +00002071 while ((gm = iter.next()) != NULL) {
scroggo@google.com7fd2d702013-04-16 19:11:14 +00002072 SkAutoTDelete<GM> adgm(gm);
reed@google.comae7b8f32012-10-18 21:30:57 +00002073 ++gmIndex;
epoger@google.com82cb65b2012-10-29 18:59:17 +00002074 if (moduloRemainder >= 0) {
2075 if ((gmIndex % moduloDivisor) != moduloRemainder) {
reed@google.comae7b8f32012-10-18 21:30:57 +00002076 continue;
2077 }
epoger@google.com82cb65b2012-10-29 18:59:17 +00002078 moduloStr.printf("[%d.%d] ", gmIndex, moduloDivisor);
reed@google.comae7b8f32012-10-18 21:30:57 +00002079 }
2080
reed@google.comece2b022011-07-25 14:28:57 +00002081 const char* shortName = gm->shortName();
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002082 if (skip_name(FLAGS_match, shortName)) {
reed@google.comece2b022011-07-25 14:28:57 +00002083 continue;
2084 }
2085
epoger@google.com310478e2013-04-03 18:00:39 +00002086 gmsRun++;
tomhudson@google.com9875dd12011-04-25 15:49:53 +00002087 SkISize size = gm->getISize();
epoger@google.combcbf5aa2013-04-12 02:11:54 +00002088 gm_fprintf(stdout, "%sdrawing... %s [%d %d]\n", moduloStr.c_str(), shortName,
2089 size.width(), size.height());
djsollen@google.comebce16d2012-10-26 14:07:13 +00002090
epoger@google.com310478e2013-04-03 18:00:39 +00002091 run_multiple_configs(gmmain, gm, configs, grFactory);
djsollen@google.comebce16d2012-10-26 14:07:13 +00002092
2093 SkBitmap comparisonBitmap;
2094 const ConfigData compareConfig =
bsalomon@google.com4c75f242013-03-19 18:58:43 +00002095 { SkBitmap::kARGB_8888_Config, kRaster_Backend, kDontCare_GLContextType, 0, kRW_ConfigFlag, "comparison", false };
epoger@google.com310478e2013-04-03 18:00:39 +00002096 gmmain.generate_image(gm, compareConfig, NULL, &comparisonBitmap, false);
djsollen@google.comebce16d2012-10-26 14:07:13 +00002097
epoger@google.com80724df2013-03-21 13:49:54 +00002098 // TODO(epoger): only run this if gmmain.generate_image() succeeded?
2099 // Otherwise, what are we comparing against?
epoger@google.com310478e2013-04-03 18:00:39 +00002100 run_multiple_modes(gmmain, gm, compareConfig, comparisonBitmap, tileGridReplayScales);
reed@android.com00dae862009-06-10 15:38:48 +00002101 }
epoger@google.com310478e2013-04-03 18:00:39 +00002102
2103 SkTArray<SkString> modes;
2104 gmmain.GetRenderModesEncountered(modes);
epoger@google.comc8263e72013-04-10 12:17:34 +00002105 bool reportError = false;
2106 if (gmmain.NumSignificantErrors() > 0) {
2107 reportError = true;
2108 }
epoger@google.com51dbabe2013-04-10 15:24:53 +00002109 int expectedNumberOfTests = gmsRun * (configs.count() + modes.count());
epoger@google.com310478e2013-04-03 18:00:39 +00002110
2111 // Output summary to stdout.
epoger@google.com51dbabe2013-04-10 15:24:53 +00002112 if (FLAGS_verbose) {
2113 gm_fprintf(stdout, "Ran %d GMs\n", gmsRun);
2114 gm_fprintf(stdout, "... over %2d configs [%s]\n", configs.count(),
2115 list_all_config_names(configs).c_str());
2116 gm_fprintf(stdout, "... and %2d modes [%s]\n", modes.count(), list_all(modes).c_str());
2117 gm_fprintf(stdout, "... so there should be a total of %d tests.\n", expectedNumberOfTests);
2118 }
2119 gmmain.ListErrors(FLAGS_verbose);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002120
epoger@google.com07947d92013-04-11 15:41:02 +00002121 // TODO(epoger): Enable this check for Android, too, once we resolve
2122 // https://code.google.com/p/skia/issues/detail?id=1222
2123 // ('GM is unexpectedly skipping tests on Android')
2124#ifndef SK_BUILD_FOR_ANDROID
epoger@google.comc8263e72013-04-10 12:17:34 +00002125 if (expectedNumberOfTests != gmmain.fTestsRun) {
2126 gm_fprintf(stderr, "expected %d tests, but ran or skipped %d tests\n",
2127 expectedNumberOfTests, gmmain.fTestsRun);
2128 reportError = true;
2129 }
2130#endif
2131
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002132 if (FLAGS_writeJsonSummaryPath.count() == 1) {
epoger@google.com76c913d2013-04-26 15:06:44 +00002133 Json::Value root = CreateJsonTree(
2134 gmmain.fJsonExpectedResults,
2135 gmmain.fJsonActualResults_Failed, gmmain.fJsonActualResults_FailureIgnored,
2136 gmmain.fJsonActualResults_NoComparison, gmmain.fJsonActualResults_Succeeded);
epoger@google.comee8a8e32012-12-18 19:13:49 +00002137 std::string jsonStdString = root.toStyledString();
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002138 SkFILEWStream stream(FLAGS_writeJsonSummaryPath[0]);
epoger@google.comee8a8e32012-12-18 19:13:49 +00002139 stream.write(jsonStdString.c_str(), jsonStdString.length());
2140 }
2141
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00002142#if SK_SUPPORT_GPU
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002143
robertphillips@google.com59552022012-08-31 13:07:37 +00002144#if GR_CACHE_STATS
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002145 for (int i = 0; i < configs.count(); i++) {
2146 ConfigData config = gRec[configs[i]];
2147
epoger@google.comb0f8b432013-04-10 18:46:25 +00002148 if (FLAGS_verbose && (kGPU_Backend == config.fBackend)) {
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002149 GrContext* gr = grFactory->get(config.fGLContextType);
2150
epoger@google.com5efdd0c2013-03-13 14:18:40 +00002151 gm_fprintf(stdout, "config: %s %x\n", config.fName, gr);
robertphillips@google.com5f9f2f52012-08-22 10:57:05 +00002152 gr->printCacheStats();
2153 }
2154 }
2155#endif
2156
robertphillips@google.com977b9c82012-06-05 19:35:09 +00002157 delete grFactory;
bsalomon@google.comcf8fb1f2012-08-02 14:03:32 +00002158#endif
robertphillips@google.com977b9c82012-06-05 19:35:09 +00002159 SkGraphics::Term();
2160
epoger@google.comc8263e72013-04-10 12:17:34 +00002161 return (reportError) ? -1 : 0;
reed@android.com00dae862009-06-10 15:38:48 +00002162}
caryclark@google.com5987f582012-10-02 18:33:14 +00002163
scroggo@google.com09fd4d22013-03-20 14:20:18 +00002164void GMMain::installFilter(SkCanvas* canvas) {
2165 if (FLAGS_forceBWtext) {
2166 canvas->setDrawFilter(SkNEW(BWTextDrawFilter))->unref();
2167 }
2168}
2169
borenet@google.com7158e6a2012-11-01 17:43:44 +00002170#if !defined(SK_BUILD_FOR_IOS) && !defined(SK_BUILD_FOR_NACL)
caryclark@google.com5987f582012-10-02 18:33:14 +00002171int main(int argc, char * const argv[]) {
2172 return tool_main(argc, (char**) argv);
2173}
2174#endif