Test decoding and output failures to JSON in get_images_from_skps

tools/get_images_from_skps.cpp

 /*
  * Copyright 2016 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
+#include "SkBitmap.h"
 #include "SkCodec.h"
 #include "SkCommandLineFlags.h"
 #include "SkData.h"
+#include "SkJSONCPP.h"
 #include "SkMD5.h"
 #include "SkOSFile.h"
 #include "SkPicture.h"
 #include "SkPixelSerializer.h"
 #include "SkStream.h"
 #include "SkTHash.h"
 
+
+#include <map>
+
 DEFINE_string2(skps, s, "skps", "A path to a directory of skps.");
 DEFINE_string2(out, o, "img-out", "A path to an output directory.");
+DEFINE_bool(testDecode, false, "Indicates if we want to test that the images decode successfully.");
+DEFINE_bool(writeImages, true, "Indicates if we want to write out images.");
+DEFINE_string2(failuresJsonPath, j, "",
+               "Dump SKP and count of unknown images to the specified JSON file. Wll not be "

[msarett, 2016/04/25 15:29:53]

nit: *Will

[rmistry, 2016/04/25 17:11:45]

Oops. Done.

+               "written anywhere if empty.");
 
 static int gKnown;
-static int gUnknown;
 static const char* gOutputDir;
+static std::map<std::string, unsigned int> gSkpToUnknownCount = {};
 
 static SkTHashSet<SkMD5::Digest> gSeen;
 
 struct Sniffer : public SkPixelSerializer {
 
+    std::string skpName;
+
+    Sniffer(std::string name) {
+        skpName = name;
+    }
+
     void sniff(const void* ptr, size_t len) {
         SkMD5 md5;
         md5.write(ptr, len);
         SkMD5::Digest digest;
         md5.finish(digest);
 
         if (gSeen.contains(digest)) {
             return;
         }
         gSeen.add(digest);
 
         SkAutoTUnref<SkData> data(SkData::NewWithoutCopy(ptr, len));
         SkAutoTDelete<SkCodec> codec(SkCodec::NewFromData(data));
         if (!codec) {
-            gUnknown++;
+            SkDebugf("Codec could not be created for %s\n", skpName.c_str());

[msarett, 2016/04/25 15:29:53]

I believe this is unreachable...  Looks like we create an empty generator if we
fail to create a codec.
https://code.google.com/p/chromium/codesearch#chromium/src/third_party/skia/s...

Still I think your change is correct.  Maybe add a FIXME though?

[rmistry, 2016/04/25 17:11:45]

Done.

+            gSkpToUnknownCount[skpName]++;
             return;
         }
         SkString ext;
         switch (codec->getEncodedFormat()) {
             case SkEncodedFormat::kBMP_SkEncodedFormat:  ext =  "bmp"; break;
             case SkEncodedFormat::kGIF_SkEncodedFormat:  ext =  "gif"; break;
             case SkEncodedFormat::kICO_SkEncodedFormat:  ext =  "ico"; break;
             case SkEncodedFormat::kJPEG_SkEncodedFormat: ext =  "jpg"; break;
             case SkEncodedFormat::kPNG_SkEncodedFormat:  ext =  "png"; break;
             case SkEncodedFormat::kDNG_SkEncodedFormat:  ext =  "dng"; break;
             case SkEncodedFormat::kWBMP_SkEncodedFormat: ext = "wbmp"; break;
             case SkEncodedFormat::kWEBP_SkEncodedFormat: ext = "webp"; break;
-            default: gUnknown++; return;
+            default:
+                SkDebugf("Unrecognized encoded format for %s\n", skpName.c_str());

[msarett, 2016/04/25 15:29:53]

I think this is also unreachable - just because we can't create a codec if we
don't know the image type.

I realize this issue was not caused by your change, but maybe SkASSERT(false)
here?

[rmistry, 2016/04/25 17:11:45]

Done.

+                gSkpToUnknownCount[skpName]++;
+                return;
         }
 
-        SkString path;
-        path.appendf("%s/%d.%s", gOutputDir, gKnown++, ext.c_str());
+        if (FLAGS_testDecode) {
+            SkBitmap bitmap;
+            SkImageInfo info = codec->getInfo().makeColorType(kN32_SkColorType);
+            bitmap.allocPixels(info);
+            if (SkCodec::kSuccess != codec->getPixels(info, bitmap.getPixels(),  bitmap.rowBytes()))

[msarett, 2016/04/25 15:29:53]

Our dm tests treat kSuccess and kIncompleteInput as "successes" because we test
on incomplete images.

I think this is good as is for now - I'm not sure how many incomplete images are
in our skps.  But if incomplete images are causing failures, we may need to
modify this.

[rmistry, 2016/04/25 17:11:45]

k, lets leave this in for now. I am guessing we will end up running into this
once we test on 10,000 SKPs.

+            {
+                SkDebugf("Decoding failed for %s\n", skpName.c_str());
+                gSkpToUnknownCount[skpName]++;
+                return;
+            }
+        }
 
-        SkFILEWStream file(path.c_str());
-        file.write(ptr, len);
+        if (FLAGS_writeImages) {
+            SkString path;
+            path.appendf("%s/%d.%s", gOutputDir, gKnown, ext.c_str());
 
-        SkDebugf("%s\n", path.c_str());
+            SkFILEWStream file(path.c_str());
+            file.write(ptr, len);
+
+            SkDebugf("%s\n", path.c_str());
+        }
+        gKnown++;
     }
 
     bool onUseEncodedData(const void* ptr, size_t len) override {
         this->sniff(ptr, len);
         return true;
     }
     SkData* onEncode(const SkPixmap&) override { return nullptr; }
 };
 
 
 int main(int argc, char** argv) {
     SkCommandLineFlags::SetUsage(
-            "Usage: get_images_from_skps -s <dir of skps> -o <dir for output images>\n");
+            "Usage: get_images_from_skps -s <dir of skps> -o <dir for output images> --testDecode "
+            "-j <output JSON path>\n");
 
     SkCommandLineFlags::Parse(argc, argv);
     const char* inputs = FLAGS_skps[0];
     gOutputDir = FLAGS_out[0];
 
     if (!sk_isdir(inputs) || !sk_isdir(gOutputDir)) {
         SkCommandLineFlags::PrintUsage();
         return 1;
     }
 
     SkOSFile::Iter iter(inputs, "skp");
     for (SkString file; iter.next(&file); ) {
         SkAutoTDelete<SkStream> stream =
                 SkStream::NewFromFile(SkOSPath::Join(inputs, file.c_str()).c_str());
         sk_sp<SkPicture> picture(SkPicture::MakeFromStream(stream));
 
         SkDynamicMemoryWStream scratch;
-        Sniffer sniff;
+        Sniffer sniff(file.c_str());
         picture->serialize(&scratch, &sniff);
     }
-    SkDebugf("%d known, %d unknown\n", gKnown, gUnknown);
+    int totalUnknowns = 0;
+    /**
+     JSON results are written out in the following format:
+     {
+       "failures": {
+         "skp1": 12,
+         "skp4": 2,
+         ...
+       },
+       "totalFailures": 32,
+       "totalSuccesses": 21,
+     }
+     */
+    Json::Value fRoot;
+    for(auto it = gSkpToUnknownCount.cbegin(); it != gSkpToUnknownCount.cend(); ++it)
+    {
+        SkDebugf("%s %d\n", it->first.c_str(), it->second);
+        totalUnknowns += it->second;
+        fRoot["failures"][it->first.c_str()] = it->second;
+    }
+    SkDebugf("%d known, %d unknown\n", gKnown, totalUnknowns);
+    fRoot["totalFailures"] = totalUnknowns;
+    fRoot["totalSuccesses"] = gKnown;
+    if (totalUnknowns > 0 && !FLAGS_failuresJsonPath.isEmpty()) {
+        SkDebugf("Writing failures to %s\n", FLAGS_failuresJsonPath[0]);
+        SkFILEWStream stream(FLAGS_failuresJsonPath[0]);
+        stream.writeText(Json::StyledWriter().write(fRoot).c_str());
+        stream.flush();
+    }
 
     return 0;
 }