Test region decoding in skimage, plus fixes.

tools/skimage_main.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.
  */
 
 #include "SkBitmap.h"
 #include "SkColorPriv.h"
 #include "SkCommandLineFlags.h"
 #include "SkData.h"
 #include "SkGraphics.h"
 #include "SkImageDecoder.h"
 #include "SkImageEncoder.h"
 #include "SkOSFile.h"
+#include "SkRandom.h"
 #include "SkStream.h"
 #include "SkTArray.h"
 #include "SkTemplates.h"
 
 DEFINE_string2(readPath, r, "", "Folder(s) and files to decode images. Required.");
 DEFINE_string2(writePath, w, "",  "Write rendered images into this directory.");
 DEFINE_bool(reencode, true, "Reencode the images to test encoding.");
+DEFINE_bool(testSubsetDecoding, true, "Test decoding subsets of images.");
 
 struct Format {
     SkImageEncoder::Type    fType;
     SkImageDecoder::Format  fFormat;
     const char*             fSuffix;
 };
 
 static const Format gFormats[] = {
     { SkImageEncoder::kBMP_Type, SkImageDecoder::kBMP_Format, ".bmp" },
     { SkImageEncoder::kGIF_Type, SkImageDecoder::kGIF_Format, ".gif" },
@@ skipping 52 matching lines @@
     }
 }
 
 // Store the names of the filenames to report later which ones failed, succeeded, and were
 // invalid.
 static SkTArray<SkString, false> gInvalidStreams;
 static SkTArray<SkString, false> gMissingCodecs;
 static SkTArray<SkString, false> gDecodeFailures;
 static SkTArray<SkString, false> gEncodeFailures;
 static SkTArray<SkString, false> gSuccessfulDecodes;
+static SkTArray<SkString, false> gSuccessfulSubsetDecodes;
+static SkTArray<SkString, false> gFailedSubsetDecodes;
 
 static bool write_bitmap(const char outName[], SkBitmap* bm) {
     SkBitmap bitmap8888;
     if (SkBitmap::kARGB_8888_Config != bm->config()) {
         if (!bm->copyTo(&bitmap8888, SkBitmap::kARGB_8888_Config)) {
             return false;
         }
         bm = &bitmap8888;
     }
     // FIXME: This forces all pixels to be opaque, like the many implementations
     // of force_all_opaque. These should be unified if they cannot be eliminated.
     SkAutoLockPixels lock(*bm);
     for (int y = 0; y < bm->height(); y++) {
         for (int x = 0; x < bm->width(); x++) {
             *bm->getAddr32(x, y) |= (SK_A32_MASK << SK_A32_SHIFT);
         }
     }
     return SkImageEncoder::EncodeFile(outName, *bm, SkImageEncoder::kPNG_Type, 100);
 }
 
+static SkRandom gRand;
+
+static SkIRect generate_random_rect(int32_t maxX, int32_t maxY) {

[djsollen, 2013/05/03 13:50:29]

can you document that this function never returns a degenerate rect, but may
return an empty rect.

[scroggo, 2013/05/03 17:09:24]

Actually, it's probably better to not return an empty rect. I've modified the
code to reflect that.

In a separate CL I'll add a unit test that tests for empty, to make sure it is
handled gracefully.

+    int32_t left = gRand.nextULessThan(maxX);
+    int32_t right = gRand.nextULessThan(maxX);
+    int32_t top = gRand.nextULessThan(maxY);
+    int32_t bottom = gRand.nextULessThan(maxY);
+    SkIRect rect = SkIRect::MakeLTRB(left, top, right, bottom);
+    rect.sort();
+    return rect;
+}
+
 static void decodeFileAndWrite(const char srcPath[], const SkString* writePath) {
     SkBitmap bitmap;
     SkFILEStream stream(srcPath);
     if (!stream.isValid()) {
         gInvalidStreams.push_back().set(srcPath);
         return;
     }
 
     SkImageDecoder* codec = SkImageDecoder::Factory(&stream);
     if (NULL == codec) {
         gMissingCodecs.push_back().set(srcPath);
         return;
     }
 
     SkAutoTDelete<SkImageDecoder> ad(codec);
 
     stream.rewind();
     if (!codec->decode(&stream, &bitmap, SkBitmap::kARGB_8888_Config,
                        SkImageDecoder::kDecodePixels_Mode)) {
         gDecodeFailures.push_back().set(srcPath);
         return;
     }
 
     gSuccessfulDecodes.push_back().printf("%s [%d %d]", srcPath, bitmap.width(), bitmap.height());
 
+    if (FLAGS_testSubsetDecoding) {
+        bool couldRewind = stream.rewind();
+        SkASSERT(couldRewind);
+        int width, height;
+        if (codec->buildTileIndex(&stream, &width, &height) && width > 1 && height > 1) {
+            SkASSERT(bitmap.width() == width && bitmap.height() == height);
+            SkBitmap bitmapFromDecodeSubset;
+            // Call decodeSubset multiple times:
+            for (int i = 0; i < 5; i++) {
+                // FIXME: Come up with a good set of rectangles to use so the results can be
+                // compared against earlier results.

[djsollen, 2013/05/03 13:50:29]

do you have any ideas on how to make this consistent? It seems at a high level
you could reset your random number generator for each image and get comparable
results.

[scroggo, 2013/05/03 17:09:24]

Yeah, that was what I was thinking, although I hoped I might be able to come up
with some solution that might be more representative of actual use cases.
Consistently random is probably good enough though.

+                SkIRect rect = generate_random_rect(width, height);
+                SkString subsetDim = SkStringPrintf("[%d,%d,%d,%d]", rect.fLeft, rect.fTop,
+                                                    rect.fRight, rect.fBottom);
+                if (codec->decodeSubset(&bitmapFromDecodeSubset, rect, SkBitmap::kNo_Config)) {
+                    gSuccessfulSubsetDecodes.push_back().printf("Decoded subset %s from %s",
+                                                          subsetDim.c_str(), srcPath);
+                    if (writePath != NULL) {
+                        // Write the region to a file whose name includes the dimensions.
+                        SkString suffix = SkStringPrintf("_%s.png", subsetDim.c_str());
+                        SkString outPath;
+                        make_outname(&outPath, writePath->c_str(), srcPath, suffix.c_str());
+                        bool success = write_bitmap(outPath.c_str(), &bitmapFromDecodeSubset);
+                        SkASSERT(success);
+                        gSuccessfulSubsetDecodes.push_back().printf("\twrote %s", outPath.c_str());
+                        // Also use extractSubset from the original for visual comparison.

[djsollen, 2013/05/03 13:50:29]

does a pixel compare at this stage fail?

[scroggo, 2013/05/03 17:09:24]

Yes. I do not yet know whether that is due to bugs or the nature of subset
decoding.

+                        SkBitmap extractedSubset;
+                        if (bitmap.extractSubset(&extractedSubset, rect)) {
+                            suffix.printf("_%s_extracted.png", subsetDim.c_str());
+                            make_outname(&outPath, writePath->c_str(), srcPath, suffix.c_str());
+                            success = write_bitmap(outPath.c_str(), &extractedSubset);
+                            SkASSERT(success);
+                        }
+                    }
+                } else {
+                    gFailedSubsetDecodes.push_back().printf("Failed to decode region %s from %s\n",
+                                                            subsetDim.c_str(), srcPath);
+                }
+            }
+        }
+    }
     if (FLAGS_reencode) {
         // Encode to the format the file was originally in, or PNG if the encoder for the same
         // format is unavailable.
         SkImageDecoder::Format format = codec->getFormat();
         if (SkImageDecoder::kUnknown_Format == format) {
             if (stream.rewind()) {
                 format = SkImageDecoder::GetStreamFormat(&stream);
             }
             if (SkImageDecoder::kUnknown_Format == format) {
                 const char* dot = strrchr(srcPath, '.');
@@ skipping 132 matching lines @@
 
     // Add some space, since codecs may print warnings without newline.
     SkDebugf("\n\n");
 
     bool failed = print_strings("Invalid files", gInvalidStreams);
     failed |= print_strings("Missing codec", gMissingCodecs);
     failed |= print_strings("Failed to decode", gDecodeFailures);
     failed |= print_strings("Failed to encode", gEncodeFailures);
     print_strings("Decoded", gSuccessfulDecodes);
 
+    if (FLAGS_testSubsetDecoding) {
+        failed |= print_strings("Failed subset decodes", gFailedSubsetDecodes);
+        print_strings("Decoded subsets", gSuccessfulSubsetDecodes);
+    }
+
     return failed ? -1 : 0;
 }
 
 #if !defined SK_BUILD_FOR_IOS
 int main(int argc, char * const argv[]) {
     return tool_main(argc, (char**) argv);
 }
 #endif