epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | /* |
| 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 | */ |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 7 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 8 | #include "gm_expectations.h" |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 9 | #include "SkBitmap.h" |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 10 | #include "SkColorPriv.h" |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 11 | #include "SkCommandLineFlags.h" |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 12 | #include "SkData.h" |
scroggo@google.com | 7def5e1 | 2013-05-31 14:00:10 +0000 | [diff] [blame] | 13 | #include "SkForceLinking.h" |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 14 | #include "SkGraphics.h" |
| 15 | #include "SkImageDecoder.h" |
| 16 | #include "SkImageEncoder.h" |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 17 | #include "SkOSFile.h" |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 18 | #include "SkRandom.h" |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 19 | #include "SkStream.h" |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 20 | #include "SkTArray.h" |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 21 | #include "SkTemplates.h" |
| 22 | |
scroggo@google.com | 7def5e1 | 2013-05-31 14:00:10 +0000 | [diff] [blame] | 23 | __SK_FORCE_IMAGE_DECODER_LINKING; |
| 24 | |
scroggo@google.com | 6d99de1 | 2013-08-06 18:56:53 +0000 | [diff] [blame] | 25 | DEFINE_string(config, "None", "Preferred config to decode into. [None|8888|565|A8]"); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 26 | DEFINE_string(createExpectationsPath, "", "Path to write JSON expectations."); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 27 | DEFINE_string(mismatchPath, "", "Folder to write mismatched images to."); |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 28 | DEFINE_string2(readPath, r, "", "Folder(s) and files to decode images. Required."); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 29 | DEFINE_string(readExpectationsPath, "", "Path to read JSON expectations from."); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 30 | DEFINE_bool(reencode, true, "Reencode the images to test encoding."); |
commit-bot@chromium.org | dac4a1d | 2013-10-08 19:40:18 +0000 | [diff] [blame] | 31 | DEFINE_int32(sampleSize, 1, "Set the sampleSize for decoding."); |
| 32 | DEFINE_bool(skip, false, "Skip writing zeroes."); |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 33 | DEFINE_bool(testSubsetDecoding, true, "Test decoding subsets of images."); |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 34 | DEFINE_bool(writeChecksumBasedFilenames, false, "When writing out actual images, use checksum-" |
| 35 | "based filenames, as rebaseline.py will use when downloading them from Google Storage"); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 36 | DEFINE_string2(writePath, w, "", "Write rendered images into this directory."); |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 37 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 38 | struct Format { |
| 39 | SkImageEncoder::Type fType; |
| 40 | SkImageDecoder::Format fFormat; |
| 41 | const char* fSuffix; |
| 42 | }; |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 43 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 44 | static const Format gFormats[] = { |
| 45 | { SkImageEncoder::kBMP_Type, SkImageDecoder::kBMP_Format, ".bmp" }, |
| 46 | { SkImageEncoder::kGIF_Type, SkImageDecoder::kGIF_Format, ".gif" }, |
| 47 | { SkImageEncoder::kICO_Type, SkImageDecoder::kICO_Format, ".ico" }, |
| 48 | { SkImageEncoder::kJPEG_Type, SkImageDecoder::kJPEG_Format, ".jpg" }, |
| 49 | { SkImageEncoder::kPNG_Type, SkImageDecoder::kPNG_Format, ".png" }, |
| 50 | { SkImageEncoder::kWBMP_Type, SkImageDecoder::kWBMP_Format, ".wbmp" }, |
| 51 | { SkImageEncoder::kWEBP_Type, SkImageDecoder::kWEBP_Format, ".webp" } |
| 52 | }; |
| 53 | |
| 54 | static SkImageEncoder::Type format_to_type(SkImageDecoder::Format format) { |
| 55 | for (size_t i = 0; i < SK_ARRAY_COUNT(gFormats); i++) { |
| 56 | if (gFormats[i].fFormat == format) { |
| 57 | return gFormats[i].fType; |
| 58 | } |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 59 | } |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 60 | return SkImageEncoder::kUnknown_Type; |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 61 | } |
| 62 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 63 | static const char* suffix_for_type(SkImageEncoder::Type type) { |
| 64 | for (size_t i = 0; i < SK_ARRAY_COUNT(gFormats); i++) { |
| 65 | if (gFormats[i].fType == type) { |
| 66 | return gFormats[i].fSuffix; |
| 67 | } |
| 68 | } |
| 69 | return ""; |
| 70 | } |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 71 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 72 | static SkImageDecoder::Format guess_format_from_suffix(const char suffix[]) { |
| 73 | for (size_t i = 0; i < SK_ARRAY_COUNT(gFormats); i++) { |
| 74 | if (strcmp(suffix, gFormats[i].fSuffix) == 0) { |
| 75 | return gFormats[i].fFormat; |
| 76 | } |
| 77 | } |
| 78 | return SkImageDecoder::kUnknown_Format; |
| 79 | } |
| 80 | |
| 81 | static void make_outname(SkString* dst, const char outDir[], const char src[], |
| 82 | const char suffix[]) { |
scroggo@google.com | ccd7afb | 2013-05-28 16:45:07 +0000 | [diff] [blame] | 83 | SkString basename = SkOSPath::SkBasename(src); |
| 84 | dst->set(SkOSPath::SkPathJoin(outDir, basename.c_str())); |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 85 | dst->append(suffix); |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 86 | } |
| 87 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 88 | // Store the names of the filenames to report later which ones failed, succeeded, and were |
| 89 | // invalid. |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 90 | // FIXME: Add more arrays, for more specific types of errors, and make the output simpler. |
| 91 | // If each array holds one type of error, the output can change from: |
| 92 | // |
| 93 | // Failures: |
| 94 | // <image> failed for such and such reason |
| 95 | // <image> failed for some different reason |
| 96 | // |
| 97 | // to: |
| 98 | // |
| 99 | // Such and such failures: |
| 100 | // <image> |
| 101 | // |
| 102 | // Different reason failures: |
| 103 | // <image> |
| 104 | // |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 105 | static SkTArray<SkString, false> gInvalidStreams; |
| 106 | static SkTArray<SkString, false> gMissingCodecs; |
| 107 | static SkTArray<SkString, false> gDecodeFailures; |
| 108 | static SkTArray<SkString, false> gEncodeFailures; |
| 109 | static SkTArray<SkString, false> gSuccessfulDecodes; |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 110 | static SkTArray<SkString, false> gSuccessfulSubsetDecodes; |
| 111 | static SkTArray<SkString, false> gFailedSubsetDecodes; |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 112 | // Files/subsets that do not have expectations. Not reported as a failure of the test so |
| 113 | // the bots will not turn red with each new image test. |
| 114 | static SkTArray<SkString, false> gMissingExpectations; |
| 115 | static SkTArray<SkString, false> gMissingSubsetExpectations; |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 116 | // For files that are expected to fail. |
| 117 | static SkTArray<SkString, false> gKnownFailures; |
| 118 | static SkTArray<SkString, false> gKnownSubsetFailures; |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 119 | |
scroggo@google.com | 6d99de1 | 2013-08-06 18:56:53 +0000 | [diff] [blame] | 120 | static SkBitmap::Config gPrefConfig(SkBitmap::kNo_Config); |
| 121 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 122 | // Expections read from a file specified by readExpectationsPath. The expectations must have been |
| 123 | // previously written using createExpectationsPath. |
| 124 | SkAutoTUnref<skiagm::JsonExpectationsSource> gJsonExpectations; |
| 125 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 126 | /** |
| 127 | * Encode the bitmap to a file, written one of two ways, depending on |
| 128 | * FLAGS_writeChecksumBasedFilenames. If true, the final image will be |
| 129 | * written to: |
| 130 | * outDir/hashType/src/digestValue.png |
| 131 | * If false, the final image will be written out to: |
| 132 | * outDir/src.png |
| 133 | * The function returns whether the file was successfully written. |
| 134 | */ |
| 135 | static bool write_bitmap(const char outDir[], const char src[], |
| 136 | const skiagm::BitmapAndDigest& bitmapAndDigest) { |
| 137 | SkString filename; |
| 138 | if (FLAGS_writeChecksumBasedFilenames) { |
| 139 | // First create the directory for the hashtype. |
| 140 | const SkString hashType = bitmapAndDigest.fDigest.getHashType(); |
| 141 | const SkString hashDir = SkOSPath::SkPathJoin(outDir, hashType.c_str()); |
| 142 | if (!sk_mkdir(hashDir.c_str())) { |
| 143 | return false; |
| 144 | } |
| 145 | |
| 146 | // Now create the name of the folder specific to this image. |
| 147 | SkString basename = SkOSPath::SkBasename(src); |
| 148 | const SkString imageDir = SkOSPath::SkPathJoin(hashDir.c_str(), basename.c_str()); |
| 149 | if (!sk_mkdir(imageDir.c_str())) { |
| 150 | return false; |
| 151 | } |
| 152 | |
| 153 | // Name the file <digest>.png |
| 154 | SkString checksumBasedName = bitmapAndDigest.fDigest.getDigestValue(); |
| 155 | checksumBasedName.append(".png"); |
| 156 | |
| 157 | filename = SkOSPath::SkPathJoin(imageDir.c_str(), checksumBasedName.c_str()); |
| 158 | } else { |
| 159 | make_outname(&filename, outDir, src, ".png"); |
| 160 | } |
| 161 | |
| 162 | const SkBitmap& bm = bitmapAndDigest.fBitmap; |
| 163 | if (SkImageEncoder::EncodeFile(filename.c_str(), bm, SkImageEncoder::kPNG_Type, 100)) { |
scroggo@google.com | de09af3 | 2013-10-07 16:56:01 +0000 | [diff] [blame] | 164 | return true; |
commit-bot@chromium.org | 546f70c | 2013-10-03 17:13:38 +0000 | [diff] [blame] | 165 | } |
scroggo@google.com | de09af3 | 2013-10-07 16:56:01 +0000 | [diff] [blame] | 166 | |
commit-bot@chromium.org | 149e9a1 | 2014-04-09 20:45:29 +0000 | [diff] [blame] | 167 | if (bm.colorType() == kN32_SkColorType) { |
scroggo@google.com | de09af3 | 2013-10-07 16:56:01 +0000 | [diff] [blame] | 168 | // First attempt at encoding failed, and the bitmap was already 8888. Making |
| 169 | // a copy is not going to help. |
| 170 | return false; |
| 171 | } |
| 172 | |
| 173 | // Encoding failed. Copy to 8888 and try again. |
| 174 | SkBitmap bm8888; |
commit-bot@chromium.org | 149e9a1 | 2014-04-09 20:45:29 +0000 | [diff] [blame] | 175 | if (!bm.copyTo(&bm8888, kN32_SkColorType)) { |
scroggo@google.com | de09af3 | 2013-10-07 16:56:01 +0000 | [diff] [blame] | 176 | return false; |
| 177 | } |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 178 | return SkImageEncoder::EncodeFile(filename.c_str(), bm8888, SkImageEncoder::kPNG_Type, 100); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 179 | } |
| 180 | |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 181 | /** |
| 182 | * Return a random SkIRect inside the range specified. |
| 183 | * @param rand Random number generator. |
| 184 | * @param maxX Exclusive maximum x-coordinate. SkIRect's fLeft and fRight will be |
| 185 | * in the range [0, maxX) |
| 186 | * @param maxY Exclusive maximum y-coordinate. SkIRect's fTop and fBottom will be |
| 187 | * in the range [0, maxY) |
| 188 | * @return SkIRect Non-empty, non-degenerate rectangle. |
| 189 | */ |
| 190 | static SkIRect generate_random_rect(SkRandom* rand, int32_t maxX, int32_t maxY) { |
| 191 | SkASSERT(maxX > 1 && maxY > 1); |
| 192 | int32_t left = rand->nextULessThan(maxX); |
| 193 | int32_t right = rand->nextULessThan(maxX); |
| 194 | int32_t top = rand->nextULessThan(maxY); |
| 195 | int32_t bottom = rand->nextULessThan(maxY); |
| 196 | SkIRect rect = SkIRect::MakeLTRB(left, top, right, bottom); |
| 197 | rect.sort(); |
| 198 | // Make sure rect is not empty. |
| 199 | if (rect.fLeft == rect.fRight) { |
| 200 | if (rect.fLeft > 0) { |
| 201 | rect.fLeft--; |
| 202 | } else { |
| 203 | rect.fRight++; |
| 204 | // This branch is only taken if 0 == rect.fRight, and |
| 205 | // maxX must be at least 2, so it must still be in |
| 206 | // range. |
| 207 | SkASSERT(rect.fRight < maxX); |
| 208 | } |
| 209 | } |
| 210 | if (rect.fTop == rect.fBottom) { |
| 211 | if (rect.fTop > 0) { |
| 212 | rect.fTop--; |
| 213 | } else { |
| 214 | rect.fBottom++; |
| 215 | // Again, this must be in range. |
| 216 | SkASSERT(rect.fBottom < maxY); |
| 217 | } |
| 218 | } |
| 219 | return rect; |
| 220 | } |
| 221 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 222 | /** |
| 223 | * Return a string which includes the name of the file and the preferred config, |
| 224 | * as specified by "--config". The resulting string will match the pattern of |
| 225 | * gm_json.py's IMAGE_FILENAME_PATTERN: "filename_config.png" |
| 226 | */ |
| 227 | static SkString create_json_key(const char* filename) { |
| 228 | SkASSERT(FLAGS_config.count() == 1); |
| 229 | return SkStringPrintf("%s_%s.png", filename, FLAGS_config[0]); |
| 230 | } |
| 231 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 232 | // Stored expectations to be written to a file if createExpectationsPath is specified. |
| 233 | static Json::Value gExpectationsToWrite; |
| 234 | |
| 235 | /** |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 236 | * If expectations are to be recorded, record the bitmap expectations into the global |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 237 | * expectations array. |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 238 | * As is the case with reading expectations, the key used will combine the filename |
| 239 | * parameter with the preferred config, as specified by "--config", matching the |
| 240 | * pattern of gm_json.py's IMAGE_FILENAME_PATTERN: "filename_config.png" |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 241 | */ |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 242 | static void write_expectations(const skiagm::BitmapAndDigest& bitmapAndDigest, |
| 243 | const char* filename) { |
| 244 | const SkString name_config = create_json_key(filename); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 245 | if (!FLAGS_createExpectationsPath.isEmpty()) { |
| 246 | // Creates an Expectations object, and add it to the list to write. |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 247 | skiagm::Expectations expectation(bitmapAndDigest); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 248 | Json::Value value = expectation.asJsonValue(); |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 249 | gExpectationsToWrite[name_config.c_str()] = value; |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 250 | } |
| 251 | } |
| 252 | |
| 253 | /** |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 254 | * If --readExpectationsPath is set, compare this bitmap to the json expectations |
| 255 | * provided. |
| 256 | * |
| 257 | * @param digest GmResultDigest, computed from the decoded bitmap, to compare to |
| 258 | * the existing expectation. |
| 259 | * @param filename String used to find the expected value. Will be combined with the |
| 260 | * preferred config, as specified by "--config", to match the pattern of |
| 261 | * gm_json.py's IMAGE_FILENAME_PATTERN: "filename_config.png". The resulting |
| 262 | * key will be used to find the proper expectations. |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 263 | * @param failureArray Array to add a failure message to on failure. |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 264 | * @param missingArray Array to add failure message to when missing image |
| 265 | * expectation. |
| 266 | * @param ignoreArray Array to add failure message to when the image does not match |
| 267 | * the expectation, but this is a failure we can ignore. |
scroggo@google.com | 6ca30ca | 2013-05-14 17:30:17 +0000 | [diff] [blame] | 268 | * @return bool True in any of these cases: |
| 269 | * - the bitmap matches the expectation. |
scroggo@google.com | 6ca30ca | 2013-05-14 17:30:17 +0000 | [diff] [blame] | 270 | * False in any of these cases: |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 271 | * - there is no expectations file. |
scroggo@google.com | 6ca30ca | 2013-05-14 17:30:17 +0000 | [diff] [blame] | 272 | * - there is an expectations file, but no expectation for this bitmap. |
| 273 | * - there is an expectation for this bitmap, but it did not match. |
| 274 | * - expectation could not be computed from the bitmap. |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 275 | */ |
scroggo@google.com | cd7a73c | 2013-08-28 18:33:31 +0000 | [diff] [blame] | 276 | static bool compare_to_expectations_if_necessary(const skiagm::GmResultDigest& digest, |
| 277 | const char* filename, |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 278 | SkTArray<SkString, false>* failureArray, |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 279 | SkTArray<SkString, false>* missingArray, |
| 280 | SkTArray<SkString, false>* ignoreArray) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 281 | // For both writing and reading, the key for this entry will include the name |
| 282 | // of the file and the pref config, matching the pattern of gm_json.py's |
| 283 | // IMAGE_FILENAME_PATTERN: "name_config.png" |
| 284 | const SkString name_config = create_json_key(filename); |
| 285 | |
scroggo@google.com | cd7a73c | 2013-08-28 18:33:31 +0000 | [diff] [blame] | 286 | if (!digest.isValid()) { |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 287 | if (failureArray != NULL) { |
| 288 | failureArray->push_back().printf("decoded %s, but could not create a GmResultDigest.", |
| 289 | filename); |
| 290 | } |
| 291 | return false; |
| 292 | } |
| 293 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 294 | if (NULL == gJsonExpectations.get()) { |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 295 | return false; |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 296 | } |
| 297 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 298 | skiagm::Expectations jsExpectation = gJsonExpectations->get(name_config.c_str()); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 299 | if (jsExpectation.empty()) { |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 300 | if (missingArray != NULL) { |
| 301 | missingArray->push_back().printf("decoded %s, but could not find expectation.", |
scroggo@google.com | 6ca30ca | 2013-05-14 17:30:17 +0000 | [diff] [blame] | 302 | filename); |
| 303 | } |
| 304 | return false; |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 305 | } |
| 306 | |
scroggo@google.com | cd7a73c | 2013-08-28 18:33:31 +0000 | [diff] [blame] | 307 | if (jsExpectation.match(digest)) { |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 308 | return true; |
| 309 | } |
| 310 | |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 311 | if (jsExpectation.ignoreFailure()) { |
| 312 | ignoreArray->push_back().printf("%s does not match expectation, but this is known.", |
| 313 | filename); |
| 314 | } else if (failureArray != NULL) { |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 315 | failureArray->push_back().printf("decoded %s, but the result does not match " |
| 316 | "expectations.", |
| 317 | filename); |
| 318 | } |
| 319 | return false; |
| 320 | } |
| 321 | |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 322 | /** |
| 323 | * Helper function to write a bitmap subset to a file. Only called if subsets were created |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 324 | * and a writePath was provided. Behaves differently depending on |
| 325 | * FLAGS_writeChecksumBasedFilenames. If true: |
| 326 | * Writes the image to a PNG file named according to the digest hash, as described in |
| 327 | * write_bitmap. |
| 328 | * If false: |
| 329 | * Creates a subdirectory called 'subsets' and writes a PNG to that directory. Also |
| 330 | * creates a subdirectory called 'extracted' and writes a bitmap created using |
| 331 | * extractSubset to a PNG in that directory. Both files will represent the same |
| 332 | * subrectangle and have the same name for convenient comparison. In this case, the |
| 333 | * digest is ignored. |
| 334 | * |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 335 | * @param writePath Parent directory to hold the folders for the PNG files to write. Must |
| 336 | * not be NULL. |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 337 | * @param subsetName Basename of the original file, with the dimensions of the subset tacked |
| 338 | * on. Used to name the new file/folder. |
| 339 | * @param bitmapAndDigestFromDecodeSubset SkBitmap (with digest) created by |
| 340 | * SkImageDecoder::DecodeSubset, using rect as the area to decode. |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 341 | * @param rect Rectangle of the area decoded into bitmapFromDecodeSubset. Used to call |
| 342 | * extractSubset on originalBitmap to create a bitmap with the same dimensions/pixels as |
| 343 | * bitmapFromDecodeSubset (assuming decodeSubset worked properly). |
| 344 | * @param originalBitmap SkBitmap decoded from the same stream as bitmapFromDecodeSubset, |
| 345 | * using SkImageDecoder::decode to get the entire image. Used to create a PNG file for |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 346 | * comparison to the PNG created by bitmapAndDigestFromDecodeSubset's bitmap. |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 347 | * @return bool Whether the function succeeded at drawing the decoded subset and the extracted |
| 348 | * subset to files. |
| 349 | */ |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 350 | static bool write_subset(const char* writePath, const SkString& subsetName, |
| 351 | const skiagm::BitmapAndDigest bitmapAndDigestFromDecodeSubset, |
| 352 | SkIRect rect, const SkBitmap& originalBitmap) { |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 353 | // All parameters must be valid. |
| 354 | SkASSERT(writePath != NULL); |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 355 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 356 | SkString subsetPath; |
| 357 | if (FLAGS_writeChecksumBasedFilenames) { |
| 358 | subsetPath.set(writePath); |
| 359 | } else { |
| 360 | // Create a subdirectory to hold the results of decodeSubset. |
| 361 | subsetPath = SkOSPath::SkPathJoin(writePath, "subsets"); |
| 362 | if (!sk_mkdir(subsetPath.c_str())) { |
| 363 | gFailedSubsetDecodes.push_back().printf("Successfully decoded subset %s, but " |
| 364 | "failed to create a directory to write to.", |
| 365 | subsetName.c_str()); |
| 366 | return false; |
| 367 | } |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 368 | } |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 369 | SkAssertResult(write_bitmap(subsetPath.c_str(), subsetName.c_str(), |
| 370 | bitmapAndDigestFromDecodeSubset)); |
| 371 | gSuccessfulSubsetDecodes.push_back().printf("\twrote %s", subsetName.c_str()); |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 372 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 373 | if (!FLAGS_writeChecksumBasedFilenames) { |
| 374 | // FIXME: The goal of extracting the subset is for visual comparison/using skdiff/skpdiff. |
| 375 | // Currently disabling for writeChecksumBasedFilenames since it will be trickier to |
| 376 | // determine which files to compare. |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 377 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 378 | // Also use extractSubset from the original for visual comparison. |
| 379 | // Write the result to a file in a separate subdirectory. |
| 380 | SkBitmap extractedSubset; |
| 381 | if (!originalBitmap.extractSubset(&extractedSubset, rect)) { |
| 382 | gFailedSubsetDecodes.push_back().printf("Successfully decoded subset %s, but failed " |
| 383 | "to extract a similar subset for comparison.", |
| 384 | subsetName.c_str()); |
| 385 | return false; |
| 386 | } |
| 387 | |
| 388 | SkString dirExtracted = SkOSPath::SkPathJoin(writePath, "extracted"); |
| 389 | if (!sk_mkdir(dirExtracted.c_str())) { |
| 390 | gFailedSubsetDecodes.push_back().printf("Successfully decoded subset%s, but failed " |
| 391 | "to create a directory for extractSubset " |
| 392 | "comparison.", |
| 393 | subsetName.c_str()); |
| 394 | return false; |
| 395 | } |
| 396 | |
| 397 | skiagm::BitmapAndDigest bitmapAndDigestFromExtractSubset(extractedSubset); |
| 398 | SkAssertResult(write_bitmap(dirExtracted.c_str(), subsetName.c_str(), |
| 399 | bitmapAndDigestFromExtractSubset)); |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 400 | } |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 401 | return true; |
| 402 | } |
| 403 | |
scroggo@google.com | cd7a73c | 2013-08-28 18:33:31 +0000 | [diff] [blame] | 404 | // FIXME: This test could be run on windows/mac once we remove their dependence on |
| 405 | // getLength. See https://code.google.com/p/skia/issues/detail?id=1570 |
| 406 | #if defined(SK_BUILD_FOR_ANDROID) || defined(SK_BUILD_FOR_UNIX) |
| 407 | |
| 408 | /** |
| 409 | * Dummy class for testing to ensure that a stream without a length decodes the same |
| 410 | * as a stream with a length. |
| 411 | */ |
| 412 | class FILEStreamWithoutLength : public SkFILEStream { |
| 413 | public: |
| 414 | FILEStreamWithoutLength(const char path[]) |
| 415 | : INHERITED(path) {} |
| 416 | |
| 417 | virtual bool hasLength() const SK_OVERRIDE { |
| 418 | return false; |
| 419 | } |
| 420 | |
| 421 | private: |
| 422 | typedef SkFILEStream INHERITED; |
| 423 | }; |
| 424 | |
| 425 | /** |
| 426 | * Test that decoding a stream which reports to not have a length still results in the |
| 427 | * same image as if it did report to have a length. Assumes that codec was used to |
| 428 | * successfully decode the file using SkFILEStream. |
| 429 | * @param srcPath The path to the file, for recreating the length-less stream. |
| 430 | * @param codec The SkImageDecoder originally used to decode srcPath, which will be used |
| 431 | * again to decode the length-less stream. |
| 432 | * @param digest GmResultDigest computed from decoding the stream the first time. |
| 433 | * Decoding the length-less stream is expected to result in a matching digest. |
| 434 | */ |
| 435 | static void test_stream_without_length(const char srcPath[], SkImageDecoder* codec, |
| 436 | const skiagm::GmResultDigest& digest) { |
| 437 | if (!digest.isValid()) { |
| 438 | // An error was already reported. |
| 439 | return; |
| 440 | } |
| 441 | SkASSERT(srcPath); |
| 442 | SkASSERT(codec); |
| 443 | FILEStreamWithoutLength stream(srcPath); |
| 444 | // This will only be called after a successful decode. Creating a stream from the same |
| 445 | // path should never fail. |
| 446 | SkASSERT(stream.isValid()); |
| 447 | SkBitmap bm; |
| 448 | if (!codec->decode(&stream, &bm, gPrefConfig, SkImageDecoder::kDecodePixels_Mode)) { |
| 449 | gDecodeFailures.push_back().appendf("Without using getLength, %s failed to decode\n", |
| 450 | srcPath); |
| 451 | return; |
| 452 | } |
| 453 | skiagm::GmResultDigest lengthLessDigest(bm); |
| 454 | if (!lengthLessDigest.isValid()) { |
| 455 | gDecodeFailures.push_back().appendf("Without using getLength, %s failed to build " |
| 456 | "a digest\n", srcPath); |
| 457 | return; |
| 458 | } |
| 459 | if (!lengthLessDigest.equals(digest)) { |
| 460 | gDecodeFailures.push_back().appendf("Without using getLength, %s did not match digest " |
| 461 | "that uses getLength\n", srcPath); |
| 462 | } |
| 463 | } |
| 464 | #endif // defined(SK_BUILD_FOR_ANDROID) || defined(SK_BUILD_FOR_UNIX) |
| 465 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 466 | /** |
commit-bot@chromium.org | 24c568c | 2014-04-10 15:39:02 +0000 | [diff] [blame] | 467 | * Replaces all instances of oldChar with newChar in str. |
| 468 | * |
| 469 | * TODO: This function appears here and in picture_utils.[cpp|h] ; |
| 470 | * we should add the implementation to src/core/SkString.cpp, write tests for it, |
| 471 | * and remove it from elsewhere. |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 472 | */ |
| 473 | static void replace_char(SkString* str, const char oldChar, const char newChar) { |
| 474 | if (NULL == str) { |
| 475 | return; |
| 476 | } |
| 477 | for (size_t i = 0; i < str->size(); ++i) { |
| 478 | if (oldChar == str->operator[](i)) { |
| 479 | str->operator[](i) = newChar; |
| 480 | } |
| 481 | } |
| 482 | } |
| 483 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 484 | static void decodeFileAndWrite(const char srcPath[], const SkString* writePath) { |
| 485 | SkBitmap bitmap; |
| 486 | SkFILEStream stream(srcPath); |
| 487 | if (!stream.isValid()) { |
| 488 | gInvalidStreams.push_back().set(srcPath); |
| 489 | return; |
| 490 | } |
| 491 | |
| 492 | SkImageDecoder* codec = SkImageDecoder::Factory(&stream); |
| 493 | if (NULL == codec) { |
| 494 | gMissingCodecs.push_back().set(srcPath); |
| 495 | return; |
| 496 | } |
| 497 | |
| 498 | SkAutoTDelete<SkImageDecoder> ad(codec); |
| 499 | |
scroggo@google.com | 8d23924 | 2013-10-01 17:27:15 +0000 | [diff] [blame] | 500 | codec->setSkipWritingZeroes(FLAGS_skip); |
commit-bot@chromium.org | dac4a1d | 2013-10-08 19:40:18 +0000 | [diff] [blame] | 501 | codec->setSampleSize(FLAGS_sampleSize); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 502 | stream.rewind(); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 503 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 504 | // Create a string representing just the filename itself, for use in json expectations. |
scroggo@google.com | ccd7afb | 2013-05-28 16:45:07 +0000 | [diff] [blame] | 505 | SkString basename = SkOSPath::SkBasename(srcPath); |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 506 | // Replace '_' with '-', so that the names can fit gm_json.py's IMAGE_FILENAME_PATTERN |
| 507 | replace_char(&basename, '_', '-'); |
| 508 | // Replace '.' with '-', so the output filename can still retain the original file extension, |
| 509 | // but still end up with only one '.', which denotes the actual extension of the final file. |
| 510 | replace_char(&basename, '.', '-'); |
scroggo@google.com | ccd7afb | 2013-05-28 16:45:07 +0000 | [diff] [blame] | 511 | const char* filename = basename.c_str(); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 512 | |
scroggo@google.com | 6d99de1 | 2013-08-06 18:56:53 +0000 | [diff] [blame] | 513 | if (!codec->decode(&stream, &bitmap, gPrefConfig, |
scroggo@google.com | bc91e8b | 2013-06-27 20:21:01 +0000 | [diff] [blame] | 514 | SkImageDecoder::kDecodePixels_Mode)) { |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 515 | if (NULL != gJsonExpectations.get()) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 516 | const SkString name_config = create_json_key(filename); |
| 517 | skiagm::Expectations jsExpectations = gJsonExpectations->get(name_config.c_str()); |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 518 | if (jsExpectations.ignoreFailure()) { |
| 519 | // This is a known failure. |
| 520 | gKnownFailures.push_back().appendf( |
| 521 | "failed to decode %s, which is a known failure.", srcPath); |
| 522 | return; |
| 523 | } |
| 524 | if (jsExpectations.empty()) { |
| 525 | // This is a failure, but it is a new file. Mark it as missing, with |
| 526 | // a note that it should be marked failing. |
| 527 | gMissingExpectations.push_back().appendf( |
| 528 | "new file %s (with no expectations) FAILED to decode.", srcPath); |
| 529 | return; |
| 530 | } |
scroggo@google.com | bc91e8b | 2013-06-27 20:21:01 +0000 | [diff] [blame] | 531 | } |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 532 | |
| 533 | // If there was a failure, and either there was no expectations file, or |
| 534 | // the expectations file listed a valid expectation, report the failure. |
| 535 | gDecodeFailures.push_back().set(srcPath); |
scroggo@google.com | bc91e8b | 2013-06-27 20:21:01 +0000 | [diff] [blame] | 536 | return; |
| 537 | } |
| 538 | |
scroggo@google.com | 6f67b3b | 2013-07-18 20:08:26 +0000 | [diff] [blame] | 539 | // Test decoding just the bounds. The bounds should always match. |
| 540 | { |
| 541 | stream.rewind(); |
| 542 | SkBitmap dim; |
| 543 | if (!codec->decode(&stream, &dim, SkImageDecoder::kDecodeBounds_Mode)) { |
| 544 | SkString failure = SkStringPrintf("failed to decode bounds for %s", srcPath); |
| 545 | gDecodeFailures.push_back() = failure; |
| 546 | } else { |
| 547 | // Now check that the bounds match: |
| 548 | if (dim.width() != bitmap.width() || dim.height() != bitmap.height()) { |
| 549 | SkString failure = SkStringPrintf("bounds do not match for %s", srcPath); |
| 550 | gDecodeFailures.push_back() = failure; |
| 551 | } |
| 552 | } |
| 553 | } |
| 554 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 555 | skiagm::BitmapAndDigest bitmapAndDigest(bitmap); |
| 556 | if (compare_to_expectations_if_necessary(bitmapAndDigest.fDigest, filename, &gDecodeFailures, |
| 557 | &gMissingExpectations, &gKnownFailures)) { |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 558 | gSuccessfulDecodes.push_back().printf("%s [%d %d]", srcPath, bitmap.width(), |
| 559 | bitmap.height()); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 560 | } else if (!FLAGS_mismatchPath.isEmpty()) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 561 | if (write_bitmap(FLAGS_mismatchPath[0], filename, bitmapAndDigest)) { |
| 562 | gSuccessfulDecodes.push_back().appendf("\twrote %s", filename); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 563 | } else { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 564 | gEncodeFailures.push_back().set(filename); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 565 | } |
| 566 | } |
| 567 | |
scroggo@google.com | cd7a73c | 2013-08-28 18:33:31 +0000 | [diff] [blame] | 568 | // FIXME: This test could be run on windows/mac once we remove their dependence on |
| 569 | // getLength. See https://code.google.com/p/skia/issues/detail?id=1570 |
| 570 | #if defined(SK_BUILD_FOR_ANDROID) || defined(SK_BUILD_FOR_UNIX) |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 571 | test_stream_without_length(srcPath, codec, bitmapAndDigest.fDigest); |
scroggo@google.com | cd7a73c | 2013-08-28 18:33:31 +0000 | [diff] [blame] | 572 | #endif |
| 573 | |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 574 | if (writePath != NULL) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 575 | if (write_bitmap(writePath->c_str(), filename, bitmapAndDigest)) { |
| 576 | gSuccessfulDecodes.push_back().appendf("\twrote %s", filename); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 577 | } else { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 578 | gEncodeFailures.push_back().set(filename); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 579 | } |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 580 | } |
| 581 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 582 | write_expectations(bitmapAndDigest, filename); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 583 | |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 584 | if (FLAGS_testSubsetDecoding) { |
scroggo@google.com | 0018f75 | 2013-05-03 20:39:22 +0000 | [diff] [blame] | 585 | SkDEBUGCODE(bool couldRewind =) stream.rewind(); |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 586 | SkASSERT(couldRewind); |
| 587 | int width, height; |
| 588 | // Build the tile index for decoding subsets. If the image is 1x1, skip subset |
| 589 | // decoding since there are no smaller subsets. |
| 590 | if (codec->buildTileIndex(&stream, &width, &height) && width > 1 && height > 1) { |
| 591 | SkASSERT(bitmap.width() == width && bitmap.height() == height); |
| 592 | // Call decodeSubset multiple times: |
| 593 | SkRandom rand(0); |
| 594 | for (int i = 0; i < 5; i++) { |
| 595 | SkBitmap bitmapFromDecodeSubset; |
| 596 | // FIXME: Come up with a more representative set of rectangles. |
| 597 | SkIRect rect = generate_random_rect(&rand, width, height); |
| 598 | SkString subsetDim = SkStringPrintf("[%d,%d,%d,%d]", rect.fLeft, rect.fTop, |
| 599 | rect.fRight, rect.fBottom); |
scroggo@google.com | 6d99de1 | 2013-08-06 18:56:53 +0000 | [diff] [blame] | 600 | if (codec->decodeSubset(&bitmapFromDecodeSubset, rect, gPrefConfig)) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 601 | SkString subsetName = SkStringPrintf("%s-%s", filename, subsetDim.c_str()); |
| 602 | skiagm::BitmapAndDigest subsetBitmapAndDigest(bitmapFromDecodeSubset); |
| 603 | if (compare_to_expectations_if_necessary(subsetBitmapAndDigest.fDigest, |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 604 | subsetName.c_str(), |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 605 | &gFailedSubsetDecodes, |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 606 | &gMissingSubsetExpectations, |
| 607 | &gKnownSubsetFailures)) { |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 608 | gSuccessfulSubsetDecodes.push_back().printf("Decoded subset %s from %s", |
| 609 | subsetDim.c_str(), srcPath); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 610 | } else if (!FLAGS_mismatchPath.isEmpty()) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 611 | write_subset(FLAGS_mismatchPath[0], subsetName, |
| 612 | subsetBitmapAndDigest, rect, bitmap); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 613 | } |
| 614 | |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 615 | write_expectations(subsetBitmapAndDigest, subsetName.c_str()); |
| 616 | |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 617 | if (writePath != NULL) { |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 618 | write_subset(writePath->c_str(), subsetName, |
| 619 | subsetBitmapAndDigest, rect, bitmap); |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 620 | } |
| 621 | } else { |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 622 | gFailedSubsetDecodes.push_back().printf("Failed to decode region %s from %s", |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 623 | subsetDim.c_str(), srcPath); |
| 624 | } |
| 625 | } |
| 626 | } |
| 627 | } |
scroggo@google.com | 9da0e1d | 2013-05-15 18:14:36 +0000 | [diff] [blame] | 628 | |
commit-bot@chromium.org | 546f70c | 2013-10-03 17:13:38 +0000 | [diff] [blame] | 629 | // Do not attempt to re-encode A8, since our image encoders do not support encoding to A8. |
| 630 | if (FLAGS_reencode && bitmap.config() != SkBitmap::kA8_Config) { |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 631 | // Encode to the format the file was originally in, or PNG if the encoder for the same |
| 632 | // format is unavailable. |
| 633 | SkImageDecoder::Format format = codec->getFormat(); |
| 634 | if (SkImageDecoder::kUnknown_Format == format) { |
| 635 | if (stream.rewind()) { |
| 636 | format = SkImageDecoder::GetStreamFormat(&stream); |
| 637 | } |
| 638 | if (SkImageDecoder::kUnknown_Format == format) { |
| 639 | const char* dot = strrchr(srcPath, '.'); |
| 640 | if (NULL != dot) { |
| 641 | format = guess_format_from_suffix(dot); |
| 642 | } |
| 643 | if (SkImageDecoder::kUnknown_Format == format) { |
| 644 | SkDebugf("Could not determine type for '%s'\n", srcPath); |
| 645 | format = SkImageDecoder::kPNG_Format; |
| 646 | } |
| 647 | |
| 648 | } |
| 649 | } else { |
| 650 | SkASSERT(!stream.rewind() || SkImageDecoder::GetStreamFormat(&stream) == format); |
| 651 | } |
| 652 | SkImageEncoder::Type type = format_to_type(format); |
| 653 | // format should never be kUnknown_Format, so type should never be kUnknown_Type. |
| 654 | SkASSERT(type != SkImageEncoder::kUnknown_Type); |
| 655 | |
| 656 | SkImageEncoder* encoder = SkImageEncoder::Create(type); |
| 657 | if (NULL == encoder) { |
| 658 | type = SkImageEncoder::kPNG_Type; |
| 659 | encoder = SkImageEncoder::Create(type); |
| 660 | SkASSERT(encoder); |
| 661 | } |
| 662 | SkAutoTDelete<SkImageEncoder> ade(encoder); |
| 663 | // Encode to a stream. |
| 664 | SkDynamicMemoryWStream wStream; |
| 665 | if (!encoder->encodeStream(&wStream, bitmap, 100)) { |
| 666 | gEncodeFailures.push_back().printf("Failed to reencode %s to type '%s'", srcPath, |
| 667 | suffix_for_type(type)); |
| 668 | return; |
| 669 | } |
| 670 | |
| 671 | SkAutoTUnref<SkData> data(wStream.copyToData()); |
| 672 | if (writePath != NULL && type != SkImageEncoder::kPNG_Type) { |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 673 | // Write the encoded data to a file. Do not write to PNG, which was already written. |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 674 | SkString outPath; |
scroggo@google.com | 5187c43 | 2013-10-22 00:42:46 +0000 | [diff] [blame] | 675 | make_outname(&outPath, writePath->c_str(), filename, suffix_for_type(type)); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 676 | SkFILEWStream file(outPath.c_str()); |
| 677 | if(file.write(data->data(), data->size())) { |
| 678 | gSuccessfulDecodes.push_back().appendf("\twrote %s", outPath.c_str()); |
| 679 | } else { |
| 680 | gEncodeFailures.push_back().printf("Failed to write %s", outPath.c_str()); |
| 681 | } |
| 682 | } |
| 683 | // Ensure that the reencoded data can still be decoded. |
| 684 | SkMemoryStream memStream(data); |
| 685 | SkBitmap redecodedBitmap; |
| 686 | SkImageDecoder::Format formatOnSecondDecode; |
scroggo@google.com | 6d99de1 | 2013-08-06 18:56:53 +0000 | [diff] [blame] | 687 | if (SkImageDecoder::DecodeStream(&memStream, &redecodedBitmap, gPrefConfig, |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 688 | SkImageDecoder::kDecodePixels_Mode, |
| 689 | &formatOnSecondDecode)) { |
| 690 | SkASSERT(format_to_type(formatOnSecondDecode) == type); |
| 691 | } else { |
| 692 | gDecodeFailures.push_back().printf("Failed to redecode %s after reencoding to '%s'", |
| 693 | srcPath, suffix_for_type(type)); |
| 694 | } |
| 695 | } |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 696 | } |
| 697 | |
| 698 | /////////////////////////////////////////////////////////////////////////////// |
| 699 | |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 700 | // If strings is not empty, print title, followed by each string on its own line starting |
| 701 | // with a tab. |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 702 | // @return bool True if strings had at least one entry. |
| 703 | static bool print_strings(const char* title, const SkTArray<SkString, false>& strings) { |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 704 | if (strings.count() > 0) { |
| 705 | SkDebugf("%s:\n", title); |
| 706 | for (int i = 0; i < strings.count(); i++) { |
| 707 | SkDebugf("\t%s\n", strings[i].c_str()); |
| 708 | } |
| 709 | SkDebugf("\n"); |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 710 | return true; |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 711 | } |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 712 | return false; |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 713 | } |
| 714 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 715 | /** |
| 716 | * If directory is non null and does not end with a path separator, append one. |
| 717 | * @param directory SkString representing the path to a directory. If the last character is not a |
| 718 | * path separator (specific to the current OS), append one. |
| 719 | */ |
| 720 | static void append_path_separator_if_necessary(SkString* directory) { |
| 721 | if (directory != NULL && directory->c_str()[directory->size() - 1] != SkPATH_SEPARATOR) { |
| 722 | directory->appendf("%c", SkPATH_SEPARATOR); |
| 723 | } |
| 724 | } |
| 725 | |
scroggo@google.com | 925cdca | 2013-06-28 20:04:42 +0000 | [diff] [blame] | 726 | /** |
| 727 | * Return true if the filename represents an image. |
| 728 | */ |
| 729 | static bool is_image_file(const char* filename) { |
| 730 | const char* gImageExtensions[] = { |
| 731 | ".png", ".PNG", ".jpg", ".JPG", ".jpeg", ".JPEG", ".bmp", ".BMP", |
| 732 | ".webp", ".WEBP", ".ico", ".ICO", ".wbmp", ".WBMP", ".gif", ".GIF" |
| 733 | }; |
| 734 | for (size_t i = 0; i < SK_ARRAY_COUNT(gImageExtensions); ++i) { |
| 735 | if (SkStrEndsWith(filename, gImageExtensions[i])) { |
| 736 | return true; |
| 737 | } |
| 738 | } |
| 739 | return false; |
| 740 | } |
| 741 | |
caryclark@google.com | 5987f58 | 2012-10-02 18:33:14 +0000 | [diff] [blame] | 742 | int tool_main(int argc, char** argv); |
| 743 | int tool_main(int argc, char** argv) { |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 744 | SkCommandLineFlags::SetUsage("Decode files, and optionally write the results to files."); |
| 745 | SkCommandLineFlags::Parse(argc, argv); |
| 746 | |
| 747 | if (FLAGS_readPath.count() < 1) { |
| 748 | SkDebugf("Folder(s) or image(s) to decode are required.\n"); |
| 749 | return -1; |
| 750 | } |
| 751 | |
| 752 | |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 753 | SkAutoGraphics ag; |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 754 | |
scroggo@google.com | 3832da1 | 2013-06-19 19:12:53 +0000 | [diff] [blame] | 755 | if (!FLAGS_readExpectationsPath.isEmpty() && sk_exists(FLAGS_readExpectationsPath[0])) { |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 756 | gJsonExpectations.reset(SkNEW_ARGS(skiagm::JsonExpectationsSource, |
| 757 | (FLAGS_readExpectationsPath[0]))); |
| 758 | } |
| 759 | |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 760 | SkString outDir; |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 761 | SkString* outDirPtr; |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 762 | |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 763 | if (FLAGS_writePath.count() == 1) { |
| 764 | outDir.set(FLAGS_writePath[0]); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 765 | append_path_separator_if_necessary(&outDir); |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 766 | outDirPtr = &outDir; |
| 767 | } else { |
| 768 | outDirPtr = NULL; |
| 769 | } |
| 770 | |
scroggo@google.com | 6d99de1 | 2013-08-06 18:56:53 +0000 | [diff] [blame] | 771 | if (FLAGS_config.count() == 1) { |
| 772 | // Only consider the first config specified on the command line. |
| 773 | const char* config = FLAGS_config[0]; |
| 774 | if (0 == strcmp(config, "8888")) { |
| 775 | gPrefConfig = SkBitmap::kARGB_8888_Config; |
| 776 | } else if (0 == strcmp(config, "565")) { |
| 777 | gPrefConfig = SkBitmap::kRGB_565_Config; |
| 778 | } else if (0 == strcmp(config, "A8")) { |
| 779 | gPrefConfig = SkBitmap::kA8_Config; |
| 780 | } else if (0 != strcmp(config, "None")) { |
| 781 | SkDebugf("Invalid preferred config\n"); |
| 782 | return -1; |
| 783 | } |
| 784 | } |
| 785 | |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 786 | for (int i = 0; i < FLAGS_readPath.count(); i++) { |
scroggo@google.com | 2b9424b | 2013-06-21 19:12:47 +0000 | [diff] [blame] | 787 | const char* readPath = FLAGS_readPath[i]; |
| 788 | if (strlen(readPath) < 1) { |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 789 | break; |
| 790 | } |
scroggo@google.com | 2b9424b | 2013-06-21 19:12:47 +0000 | [diff] [blame] | 791 | if (sk_isdir(readPath)) { |
| 792 | const char* dir = readPath; |
| 793 | SkOSFile::Iter iter(dir); |
| 794 | SkString filename; |
| 795 | while (iter.next(&filename)) { |
scroggo@google.com | 925cdca | 2013-06-28 20:04:42 +0000 | [diff] [blame] | 796 | if (!is_image_file(filename.c_str())) { |
| 797 | continue; |
| 798 | } |
scroggo@google.com | 2b9424b | 2013-06-21 19:12:47 +0000 | [diff] [blame] | 799 | SkString fullname = SkOSPath::SkPathJoin(dir, filename.c_str()); |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 800 | decodeFileAndWrite(fullname.c_str(), outDirPtr); |
scroggo@google.com | 2b9424b | 2013-06-21 19:12:47 +0000 | [diff] [blame] | 801 | } |
scroggo@google.com | 925cdca | 2013-06-28 20:04:42 +0000 | [diff] [blame] | 802 | } else if (sk_exists(readPath) && is_image_file(readPath)) { |
scroggo@google.com | 2b9424b | 2013-06-21 19:12:47 +0000 | [diff] [blame] | 803 | decodeFileAndWrite(readPath, outDirPtr); |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 804 | } |
| 805 | } |
| 806 | |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 807 | if (!FLAGS_createExpectationsPath.isEmpty()) { |
| 808 | // Use an empty value for everything besides expectations, since the reader only cares |
| 809 | // about the expectations. |
| 810 | Json::Value nullValue; |
| 811 | Json::Value root = skiagm::CreateJsonTree(gExpectationsToWrite, nullValue, nullValue, |
| 812 | nullValue, nullValue); |
| 813 | std::string jsonStdString = root.toStyledString(); |
scroggo@google.com | cf5eb6a | 2013-06-07 12:43:15 +0000 | [diff] [blame] | 814 | SkFILEWStream stream(FLAGS_createExpectationsPath[0]); |
scroggo@google.com | 6843bdb | 2013-05-08 19:14:23 +0000 | [diff] [blame] | 815 | stream.write(jsonStdString.c_str(), jsonStdString.length()); |
| 816 | } |
scroggo@google.com | b41ff95 | 2013-04-11 15:53:35 +0000 | [diff] [blame] | 817 | // Add some space, since codecs may print warnings without newline. |
| 818 | SkDebugf("\n\n"); |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 819 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 820 | bool failed = print_strings("Invalid files", gInvalidStreams); |
| 821 | failed |= print_strings("Missing codec", gMissingCodecs); |
| 822 | failed |= print_strings("Failed to decode", gDecodeFailures); |
| 823 | failed |= print_strings("Failed to encode", gEncodeFailures); |
| 824 | print_strings("Decoded", gSuccessfulDecodes); |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 825 | print_strings("Missing expectations", gMissingExpectations); |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 826 | |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 827 | if (FLAGS_testSubsetDecoding) { |
| 828 | failed |= print_strings("Failed subset decodes", gFailedSubsetDecodes); |
| 829 | print_strings("Decoded subsets", gSuccessfulSubsetDecodes); |
scroggo@google.com | e339eb0 | 2013-08-06 18:51:30 +0000 | [diff] [blame] | 830 | print_strings("Missing subset expectations", gMissingSubsetExpectations); |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 831 | print_strings("Known subset failures", gKnownSubsetFailures); |
scroggo@google.com | 7e6fcee | 2013-05-03 20:14:28 +0000 | [diff] [blame] | 832 | } |
| 833 | |
scroggo@google.com | 36c5bdb | 2013-10-15 20:29:37 +0000 | [diff] [blame] | 834 | print_strings("Known failures", gKnownFailures); |
| 835 | |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 836 | return failed ? -1 : 0; |
reed@android.com | af45979 | 2009-04-24 19:52:53 +0000 | [diff] [blame] | 837 | } |
| 838 | |
caryclark@google.com | 5987f58 | 2012-10-02 18:33:14 +0000 | [diff] [blame] | 839 | #if !defined SK_BUILD_FOR_IOS |
| 840 | int main(int argc, char * const argv[]) { |
| 841 | return tool_main(argc, (char**) argv); |
| 842 | } |
| 843 | #endif |