Alter GM's --mpd option to write out images

gm/gmmain.cpp

 /*
  * Copyright 2011 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 /*
  * Code for the "gm" (Golden Master) rendering comparison tool.
  *
@@ skipping 229 matching lines @@
         SkString filename = make_shortname_plus_config(shortName, configName);
         filename.append(renderModeDescriptor);
         filename.appendUnichar('.');
         filename.append(suffix);
         return SkOSPath::Join(path, filename.c_str());
     }
 
     /**
      * Assemble filename suitable for writing out an SkBitmap.
      */
-    SkString make_bitmap_filename(const char *path,
-                                  const char *shortName,
-                                  const char *configName,
-                                  const char *renderModeDescriptor,
-                                  const GmResultDigest &bitmapDigest) {
+    SkString makeBitmapFilename(const char *path,
+                                const char *shortName,
+                                const char *configName,
+                                const char *renderModeDescriptor,
+                                const GmResultDigest &bitmapDigest) {
         if (fWriteChecksumBasedFilenames) {
             SkString filename;
             filename.append(bitmapDigest.getHashType());
             filename.appendUnichar('_');
             filename.append(shortName);
             filename.appendUnichar('_');
             filename.append(bitmapDigest.getDigestValue());
             filename.appendUnichar('.');
             filename.append(kPNG_FileExtension);
             return SkOSPath::Join(path, filename.c_str());
@@ skipping 24 matching lines @@
 
     static void force_all_opaque_8888(const SkBitmap& bitmap) {
         SkAutoLockPixels lock(bitmap);
         for (int y = 0; y < bitmap.height(); y++) {
             for (int x = 0; x < bitmap.width(); x++) {
                 *bitmap.getAddr32(x, y) |= (SK_A32_MASK << SK_A32_SHIFT);
             }
         }
     }
 
-    static ErrorCombination write_bitmap(const SkString& path, const SkBitmap& bitmap) {
+    static ErrorCombination WriteBitmap(const SkString& path, const SkBitmap& bitmap) {
         // TODO(epoger): Now that we have removed force_all_opaque()
         // from this method, we should be able to get rid of the
         // transformation to 8888 format also.
         SkBitmap copy;
         bitmap.copyTo(&copy, kN32_SkColorType);
         if (!SkImageEncoder::EncodeFile(path.c_str(), copy,
                                         SkImageEncoder::kPNG_Type,
                                         100)) {
             SkDebugf("FAILED to write bitmap: %s\n", path.c_str());
             return ErrorCombination(kWritingReferenceImage_ErrorType);
@@ skipping 18 matching lines @@
             if (modeAsString.startsWith("-")) {
                 modeAsString.remove(0, 1);
             }
             modes.push_back(modeAsString);
         }
     }
 
     /**
      * Returns true if failures on this test should be ignored.
      */
-    bool ShouldIgnoreTest(const char *name) const {
+    bool shouldIgnoreTest(const char *name) const {
         for (int i = 0; i < fIgnorableTestNames.count(); i++) {
             if (fIgnorableTestNames[i].equals(name)) {
                 return true;
             }
         }
         return false;
     }
 
     /**
      * Calls RecordTestResults to record that we skipped a test.
@@ skipping 487 matching lines @@
         completeNameString.append(".");
         completeNameString.append(kPNG_FileExtension);
         const char* completeName = completeNameString.c_str();
 
         if (expectations.empty()) {
             errors.add(kMissingExpectations_ErrorType);
 
             // Write out the "actuals" for any tests without expectations, if we have
             // been directed to do so.
             if (fMissingExpectationsPath) {
-                SkString path = make_bitmap_filename(fMissingExpectationsPath, shortName,
-                                                     configName, renderModeDescriptor,
-                                                     actualBitmapAndDigest.fDigest);
-                write_bitmap(path, actualBitmapAndDigest.fBitmap);
+                SkString path = this->makeBitmapFilename(fMissingExpectationsPath, shortName,
+                                                         configName, renderModeDescriptor,
+                                                         actualBitmapAndDigest.fDigest);
+                WriteBitmap(path, actualBitmapAndDigest.fBitmap);
             }
 
         } else if (!expectations.match(actualBitmapAndDigest.fDigest)) {
             addToJsonSummary = true;
             // The error mode we record depends on whether this was running
             // in a non-standard renderMode.
             if ('\0' == *renderModeDescriptor) {
                 errors.add(kExpectationsMismatch_ErrorType);
             } else {
                 errors.add(kRenderModeMismatch_ErrorType);
             }
 
             // Write out the "actuals" for any mismatches, if we have
             // been directed to do so.
             if (fMismatchPath) {
-                SkString path = make_bitmap_filename(fMismatchPath, shortName, configName,
-                                                     renderModeDescriptor,
-                                                     actualBitmapAndDigest.fDigest);
-                write_bitmap(path, actualBitmapAndDigest.fBitmap);
+                SkString path = this->makeBitmapFilename(fMismatchPath, shortName, configName,
+                                                         renderModeDescriptor,
+                                                         actualBitmapAndDigest.fDigest);
+                WriteBitmap(path, actualBitmapAndDigest.fBitmap);
             }
 
             // If we have access to a single expected bitmap, log more
             // detail about the mismatch.
             const SkBitmap *expectedBitmapPtr = expectations.asBitmap();
             if (expectedBitmapPtr) {
                 report_bitmap_diffs(*expectedBitmapPtr, actualBitmapAndDigest.fBitmap,
                                     completeName);
             }
         }
@@ skipping 58 matching lines @@
 
     /**
      * Compare actualBitmap to expectations stored in this->fExpectationsSource.
      *
      * @param gm which test generated the actualBitmap
      * @param gRec
      * @param configName The config name to look for in the expectation file.
      * @param actualBitmapAndDigest ptr to bitmap generated by this run, or NULL
      *        if we don't have a usable bitmap representation
      */
-    ErrorCombination compare_test_results_to_stored_expectations(
+    ErrorCombination compareTestResultsToStoredExpectations(
         GM* gm, const ConfigData& gRec, const char* configName,
         const BitmapAndDigest* actualBitmapAndDigest) {
         ErrorCombination errors;
 
         if (NULL == actualBitmapAndDigest) {
             // Note that we intentionally skipped validating the results for
             // this test, because we don't know how to generate an SkBitmap
             // version of the output.
             errors.add(ErrorCombination(kIntentionallySkipped_ErrorType));
         } else if (!(gRec.fFlags & kWrite_ConfigFlag)) {
@@ skipping 17 matching lines @@
                  *
                  * TODO(epoger): This relies on the fact that
                  * force_all_opaque() was called on the bitmap before it
                  * was written to disk as a PNG in the first place. If
                  * not, the hash digest returned here may not match the
                  * hash digest of actualBitmap, which *has* been run through
                  * force_all_opaque().
                  * See comments above complete_bitmap() for more detail.
                  */
                 Expectations expectations = expectationsSource->get(nameWithExtension.c_str());
-                if (this->ShouldIgnoreTest(gm->getName())) {
+                if (this->shouldIgnoreTest(gm->getName())) {
                     expectations.setIgnoreFailure(true);
                 }
                 errors.add(compare_to_expectations(expectations, *actualBitmapAndDigest,
                                                    gm->getName(), configName, "", true));
             } else {
                 // If we are running without expectations, we still want to
                 // record the actual results.
                 add_actual_results_to_json_summary(nameWithExtension.c_str(),
                                                    actualBitmapAndDigest->fDigest,
                                                    ErrorCombination(kMissingExpectations_ErrorType),
@@ skipping 69 matching lines @@
     // Test: draw into a bitmap or pdf.
     // Depending on flags, possibly compare to an expected image.
     // If writePath is not NULL, also write images (or documents) to the specified path.
     ErrorCombination test_drawing(GM* gm, const ConfigData& gRec,
                                   const SkTDArray<const PDFRasterizerData*> &pdfRasterizers,
                                   const char writePath [],
                                   GrSurface* gpuTarget,
                                   SkBitmap* bitmap) {
         ErrorCombination errors;
         SkDynamicMemoryWStream document;
-        SkString path;
 
         if (gRec.fBackend == kRaster_Backend ||
             gRec.fBackend == kGPU_Backend) {
             // Early exit if we can't generate the image.
             errors.add(generate_image(gm, gRec, gpuTarget, bitmap, false));
             if (!errors.isEmpty()) {
                 // TODO: Add a test to exercise what the stdout and
                 // JSON look like if we get an "early error" while
                 // trying to generate the image.
                 return errors;
             }
-            BitmapAndDigest bitmapAndDigest(*bitmap);
-            errors.add(compare_test_results_to_stored_expectations(
-                           gm, gRec, gRec.fName, &bitmapAndDigest));
 
-            if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
-                path = make_bitmap_filename(writePath, gm->getName(), gRec.fName,
-                                            "", bitmapAndDigest.fDigest);
-                errors.add(write_bitmap(path, bitmapAndDigest.fBitmap));
-            }
+            errors.add(this->writeBitmap(gm, gRec, gRec.fName, writePath, *bitmap));
         } else if (gRec.fBackend == kPDF_Backend) {
             if (!generate_pdf(gm, document)) {
                 errors.add(kGeneratePdfFailed_ErrorType);
             } else {
                 SkAutoTUnref<SkStreamAsset> documentStream(document.detachAsStream());
                 if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
-                    path = make_filename(writePath, gm->getName(), gRec.fName, "", "pdf");
+                    SkString path = make_filename(writePath, gm->getName(), gRec.fName, "", "pdf");
                     errors.add(write_document(path, documentStream));
                 }
 
                 if (!(gm->getFlags() & GM::kSkipPDFRasterization_Flag)) {
                     for (int i = 0; i < pdfRasterizers.count(); i++) {
                         SkBitmap pdfBitmap;
                         documentStream->rewind();
                         bool success = (*pdfRasterizers[i]->fRasterizerFunction)(
                                 documentStream.get(), &pdfBitmap);
                         if (!success) {
                             SkDebugf("FAILED to render PDF for %s using renderer %s\n",
                                      gm->getName(),
                                      pdfRasterizers[i]->fName);
                             continue;
                         }
 
                         SkString configName(gRec.fName);
                         configName.append("-");
                         configName.append(pdfRasterizers[i]->fName);
 
-                        BitmapAndDigest bitmapAndDigest(pdfBitmap);
-                        errors.add(compare_test_results_to_stored_expectations(
-                                   gm, gRec, configName.c_str(), &bitmapAndDigest));
-
-                        if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
-                            path = make_bitmap_filename(writePath, gm->getName(),
-                                                        configName.c_str(),
-                                                        "", bitmapAndDigest.fDigest);
-                            errors.add(write_bitmap(path, bitmapAndDigest.fBitmap));
-                        }
+                        errors.add(this->writeBitmap(gm, gRec, configName.c_str(),
+                                                     writePath, pdfBitmap));
                     }
                 } else {
                     errors.add(kIntentionallySkipped_ErrorType);
                 }
             }
         } else if (gRec.fBackend == kXPS_Backend) {
             generate_xps(gm, document);
             SkAutoTUnref<SkStreamAsset> documentStream(document.detachAsStream());
 
-            errors.add(compare_test_results_to_stored_expectations(
+            errors.add(this->compareTestResultsToStoredExpectations(
                            gm, gRec, gRec.fName, NULL));
 
             if (writePath && (gRec.fFlags & kWrite_ConfigFlag)) {
-                path = make_filename(writePath, gm->getName(), gRec.fName, "", "xps");
+                SkString path = make_filename(writePath, gm->getName(), gRec.fName, "", "xps");
                 errors.add(write_document(path, documentStream));
             }
         } else {
             SkASSERT(false);
         }
         return errors;
     }
 
     ErrorCombination test_deferred_drawing(GM* gm,
                                            const ConfigData& gRec,
@@ skipping 42 matching lines @@
             uint32_t flags = (config.fFlags & kDFText_ConfigFlag) ?
                                 SkSurfaceProps::kUseDistanceFieldFonts_Flag : 0;
             SkSurfaceProps props(flags, SkSurfaceProps::kLegacyFontHost_InitType);
             return SkSurface::NewRenderTargetDirect(gpuTarget->asRenderTarget(), &props);
         }
 #endif
 
         return NULL;
     }
 
+    ErrorCombination writeBitmap(GM* gm,
+                                 const ConfigData& config,
+                                 const char* configName,
+                                 const char* writePath,
+                                 const SkBitmap& bitmap) {
+        ErrorCombination errors;
+
+        BitmapAndDigest bitmapAndDigest(bitmap);
+        errors.add(this->compareTestResultsToStoredExpectations(gm, config,
+                                                                configName, &bitmapAndDigest));
+
+        if (writePath && (config.fFlags & kWrite_ConfigFlag)) {
+            SkString path;
+
+            path = this->makeBitmapFilename(writePath, gm->getName(), configName,
+                                            "", bitmapAndDigest.fDigest);
+            errors.add(WriteBitmap(path, bitmapAndDigest.fBitmap));
+        }
+
+        return errors;
+    }
+
     ErrorCombination testMPDDrawing(GM* gm,
                                     const ConfigData& config,
+                                    const char* writePath,
                                     GrSurface* gpuTarget,
                                     const SkBitmap& referenceBitmap) {
         SkASSERT(kRaster_Backend == config.fBackend || kGPU_Backend == config.fBackend);
 
         static const uint32_t kMPDFlags = SkPictureRecorder::kComputeSaveLayerInfo_RecordFlag;
 
         SkAutoTUnref<SkPicture> pict(generate_new_picture(gm, kRTree_BbhType, kMPDFlags));
 
         SkAutoTUnref<SkSurface> surf(CreateSurface(config, gm->getISize(), gpuTarget));
 
         DrawPictureToSurface(surf, pict, SK_Scalar1, false, true);
 
         SkBitmap bitmap;
 
         setup_bitmap(config, gm->getISize(), &bitmap);
 
         surf->readPixels(bitmap.info(), bitmap.getPixels(), bitmap.rowBytes(), 0, 0);
         complete_bitmap(&bitmap);
 
-        return compare_test_results_to_reference_bitmap(
-            gm->getName(), config.fName, "-mpd", bitmap, &referenceBitmap);
+        SkString configName(config.fName);
+        configName.append("-mpd");
+
+        return this->writeBitmap(gm, config, configName.c_str(), writePath, bitmap);
     }
 
     ErrorCombination test_pipe_playback(GM* gm, const ConfigData& gRec,
                                         const SkBitmap& referenceBitmap, bool simulateFailure) {
         const SkString shortNamePlusConfig = make_shortname_plus_config(gm->getName(),
                                                                         gRec.fName);
         ErrorCombination errors;
         for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
             SkString renderModeDescriptor("-pipe");
             renderModeDescriptor.append(gPipeWritingFlagCombos[i].name);
@@ skipping 649 matching lines @@
         }
 
         if (FLAGS_mpd && (kGPU_Backend == config.fBackend || kRaster_Backend == config.fBackend)) {
 
             if (gmFlags & GM::kSkipPicture_Flag) {
                 gmmain.RecordSkippedTest(shortNamePlusConfig,
                                          renderModeDescriptor,
                                          config.fBackend);
                 errorsForThisConfig.add(kIntentionallySkipped_ErrorType);
             } else if (!(gmFlags & GM::kGPUOnly_Flag)) {
-                errorsForThisConfig.add(gmmain.testMPDDrawing(gm, config, gpuTarget,
+                errorsForThisConfig.add(gmmain.testMPDDrawing(gm, config, 
+                                                              writePath, gpuTarget,
                                                               comparisonBitmap));
             }
         }
 
         errorsForAllConfigs.add(errorsForThisConfig);
     }
     return errorsForAllConfigs;
 }
 
 
@@ skipping 658 matching lines @@
     if (FLAGS_forceBWtext) {
         canvas->setDrawFilter(SkNEW(BWTextDrawFilter))->unref();
     }
 }
 
 #if !defined(SK_BUILD_FOR_IOS) && !defined(SK_BUILD_FOR_NACL)
 int main(int argc, char * const argv[]) {
     return tool_main(argc, (char**) argv);
 }
 #endif