skia2/tests/GifTest.cpp
scroggo 19b91531e9 Add support for multiple frames in SkCodec
Add an interface to decode frames beyond the first in SkCodec, and
add an implementation for SkGifCodec.

Add getFrameData to SkCodec. This method reads ahead in the stream
to return a vector containing meta data about each frame in the image.
This is not required in order to decode frames beyond the first, but
it allows a client to learn extra information:
- how long the frame should be displayed
- whether a frame should be blended with a prior frame, allowing the
  client to provide the prior frame to speed up decoding

Add a new fields to SkCodec::Options:
- fFrameIndex
- fHasPriorFrame

The API is designed so that SkCodec never caches frames. If a
client wants a frame beyond the first, they specify the frame in
Options.fFrameIndex. If the client does not have the
frame's required frame (the frame that this frame must be blended on
top of) cached, they pass false for
Options.fHasPriorFrame. Unless the frame is
independent, the codec will then recursively decode all frames
necessary to decode fFrameIndex. If the client has the required frame
cached, they can put it in the dst they pass to the codec, and the
codec will only draw fFrameIndex onto it.

Replace SkGifCodec's scanline decoding support with progressive
decoding, and update the tests accordingly.

Implement new APIs in SkGifCodec. Instead of using gif_lib, use
GIFImageReader, imported from Chromium (along with its copyright
headers) with the following changes:
- SkGifCodec is now the client
- Replace blink types
- Combine GIFColorMap::buildTable and ::getTable into a method that
  creates and returns an SkColorTable
- Input comes from an SkStream, instead of a SegmentReader. Add
  SkStreamBuffer, which buffers the (potentially partial) stream in
  order to decode progressively.
  (FIXME: This requires copying data that previously was read directly
  from the SegmentReader. Does this hurt performance? If so, can we
  fix it?)
- Remove UMA code
- Instead of reporting screen width and height to the client, allow the
  client to query for it
- Fail earlier if the first frame AND screen have size of zero
- Compute required previous frame when adding a new one
- Move GIFParseQuery from GIFImageDecoder to GIFImageReader
- Allow parsing up to a specific frame (to skip parsing the rest of the
  stream if a client only wants the first frame)
- Compute whether the first frame has alpha and supports index 8, to
  create the SkImageInfo. This happens before reporting that the size
  has been decoded.

Add GIFImageDecoder::haveDecodedRow to SkGifCodec, imported from
Chromium (along with its copyright header), with the following changes:
- Add support for sampling
- Use the swizzler
- Keep track of the rows decoded
- Do *not* keep track of whether we've seen alpha

Remove SkCodec::kOutOfOrder_SkScanlineOrder, which was only used by GIF
scanline decoding.

Call onRewind even if there is no stream (SkGifCodec needs to clear its
decoded state so it will decode from the beginning).

Add a method to SkSwizzler to access the offset into the dst, taking
subsetting into account.

Add a GM that animates a GIF.
Add tests for the new APIs.

*** Behavior changes:
* Previously, we reported that an image with a subset frame and no transparent
index was opaque and used the background index (if present) to fill the
background. This is necessary in order to support index 8, but it does not
match viewers/browsers I have seen. Examples:
- Chromium and Gimp render the background transparent
- Firefox, Safari, Linux Image Viewer, Safari Preview clip to the frame (for
  a single frame image)
This CL matches Chromium's behavior and renders the background transparent.
This allows us to have consistent behavior across products and simplifies
the code (relative to what we would have to do to continue the old behavior
on Android). It also means that we will no longer support index 8 for some
GIFs.
* Stop checking for GIFSTAMP - all GIFs should be either 89a or 87a.
This matches Chromium. I suspect that bugs would have been reported if valid
GIFs started with "GIFVER" instead of "GIF89a" or "GIF87a" (but did not decode
in Chromium).

*** Future work not included in this CL:
* Move some checks out of haveDecodedRow, since they are the same for the
  entire frame e.g.
- intersecting the frameRect with the full image size
- whether there is a color table
* Change when we write transparent pixels
- In some cases, Chromium deemed this unnecessary, but I suspect it is slower
  than the fallback case. There will continue to be cases where we should
  *not* write them, but for e.g. the first pass where we have already
  cleared to transparent (which we may also be able to skip) writing the
  transparent pixels will not make anything incorrect.
* Report color type and alpha type per frame
- Depending on alpha values, disposal methods, frame rects, etc, subsequent
  frames may have different properties than the first.
* Skip copies of the encoded data
- We copy the encoded data in case the stream is one that cannot be rewound,
  so we can parse and then decode (possibly not immediately). For some input
  streams, this is unnecessary.
  - I was concerned this cause a performance regression, but on average the
    new code is faster than the old for the images I tested [1].
  - It may cause a performance regression for Chromium, though, where we can
    always move back in the stream, so this should be addressed.

Design doc:
https://docs.google.com/a/google.com/document/d/12Qhf9T92MWfdWujQwCIjhCO3sw6pTJB5pJBwDM1T7Kc/

[1] https://docs.google.com/a/google.com/spreadsheets/d/19V-t9BfbFw5eiwBTKA1qOBkZbchjlTC5EIz6HFy-6RI/

GOLD_TRYBOT_URL= https://gold.skia.org/search2?unt=true&query=source_type%3Dgm&master=false&issue=2045293002

Review-Url: https://codereview.chromium.org/2045293002
2016-10-24 09:03:26 -07:00

230 lines
9.2 KiB
C++

/*
* Copyright 2013 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "CodecPriv.h"
#include "Resources.h"
#include "SkAndroidCodec.h"
#include "SkBitmap.h"
#include "SkData.h"
#include "SkImage.h"
#include "SkStream.h"
#include "SkTypes.h"
#include "Test.h"
static unsigned char gGIFData[] = {
0x47, 0x49, 0x46, 0x38, 0x37, 0x61, 0x03, 0x00, 0x03, 0x00, 0xe3, 0x08,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0xff, 0x00,
0xff, 0x80, 0x80, 0x80, 0x00, 0xff, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff,
0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0x2c, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x03, 0x00, 0x00, 0x04,
0x07, 0x50, 0x1c, 0x43, 0x40, 0x41, 0x23, 0x44, 0x00, 0x3b
};
static unsigned char gGIFDataNoColormap[] = {
0x47, 0x49, 0x46, 0x38, 0x39, 0x61, 0x01, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
0x21, 0xf9, 0x04, 0x01, 0x0a, 0x00, 0x01, 0x00, 0x2c, 0x00, 0x00, 0x00, 0x00,
0x01, 0x00, 0x01, 0x00, 0x00, 0x02, 0x02, 0x4c, 0x01, 0x00, 0x3b
};
static unsigned char gInterlacedGIF[] = {
0x47, 0x49, 0x46, 0x38, 0x37, 0x61, 0x09, 0x00, 0x09, 0x00, 0xe3, 0x08, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0xff, 0x00, 0xff, 0x80,
0x80, 0x80, 0x00, 0xff, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0x00, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x2c, 0x00, 0x00, 0x00,
0x00, 0x09, 0x00, 0x09, 0x00, 0x40, 0x04, 0x1b, 0x50, 0x1c, 0x23, 0xe9, 0x44,
0x23, 0x60, 0x9d, 0x09, 0x28, 0x1e, 0xf8, 0x6d, 0x64, 0x56, 0x9d, 0x53, 0xa8,
0x7e, 0xa8, 0x65, 0x94, 0x5c, 0xb0, 0x8a, 0x45, 0x04, 0x00, 0x3b
};
static void test_gif_data_no_colormap(skiatest::Reporter* r,
void* data,
size_t size) {
SkBitmap bm;
bool imageDecodeSuccess = decode_memory(data, size, &bm);
REPORTER_ASSERT(r, imageDecodeSuccess);
REPORTER_ASSERT(r, bm.width() == 1);
REPORTER_ASSERT(r, bm.height() == 1);
REPORTER_ASSERT(r, !(bm.empty()));
if (!(bm.empty())) {
REPORTER_ASSERT(r, bm.getColor(0, 0) == 0x00000000);
}
}
static void test_gif_data(skiatest::Reporter* r, void* data, size_t size) {
SkBitmap bm;
bool imageDecodeSuccess = decode_memory(data, size, &bm);
REPORTER_ASSERT(r, imageDecodeSuccess);
REPORTER_ASSERT(r, bm.width() == 3);
REPORTER_ASSERT(r, bm.height() == 3);
REPORTER_ASSERT(r, !(bm.empty()));
if (!(bm.empty())) {
REPORTER_ASSERT(r, bm.getColor(0, 0) == 0xffff0000);
REPORTER_ASSERT(r, bm.getColor(1, 0) == 0xffffff00);
REPORTER_ASSERT(r, bm.getColor(2, 0) == 0xff00ffff);
REPORTER_ASSERT(r, bm.getColor(0, 1) == 0xff808080);
REPORTER_ASSERT(r, bm.getColor(1, 1) == 0xff000000);
REPORTER_ASSERT(r, bm.getColor(2, 1) == 0xff00ff00);
REPORTER_ASSERT(r, bm.getColor(0, 2) == 0xffffffff);
REPORTER_ASSERT(r, bm.getColor(1, 2) == 0xffff00ff);
REPORTER_ASSERT(r, bm.getColor(2, 2) == 0xff0000ff);
}
}
static void test_gif_data_dims(skiatest::Reporter* r, void* data, size_t size, int width,
int height) {
SkBitmap bm;
bool imageDecodeSuccess = decode_memory(data, size, &bm);
REPORTER_ASSERT(r, imageDecodeSuccess);
REPORTER_ASSERT(r, bm.width() == width);
REPORTER_ASSERT(r, bm.height() == height);
REPORTER_ASSERT(r, !(bm.empty()));
}
static void test_interlaced_gif_data(skiatest::Reporter* r,
void* data,
size_t size) {
SkBitmap bm;
bool imageDecodeSuccess = decode_memory(data, size, &bm);
REPORTER_ASSERT(r, imageDecodeSuccess);
REPORTER_ASSERT(r, bm.width() == 9);
REPORTER_ASSERT(r, bm.height() == 9);
REPORTER_ASSERT(r, !(bm.empty()));
if (!(bm.empty())) {
REPORTER_ASSERT(r, bm.getColor(0, 0) == 0xffff0000);
REPORTER_ASSERT(r, bm.getColor(1, 0) == 0xffffff00);
REPORTER_ASSERT(r, bm.getColor(2, 0) == 0xff00ffff);
REPORTER_ASSERT(r, bm.getColor(0, 2) == 0xffffffff);
REPORTER_ASSERT(r, bm.getColor(1, 2) == 0xffff00ff);
REPORTER_ASSERT(r, bm.getColor(2, 2) == 0xff0000ff);
REPORTER_ASSERT(r, bm.getColor(0, 4) == 0xff808080);
REPORTER_ASSERT(r, bm.getColor(1, 4) == 0xff000000);
REPORTER_ASSERT(r, bm.getColor(2, 4) == 0xff00ff00);
REPORTER_ASSERT(r, bm.getColor(0, 6) == 0xffff0000);
REPORTER_ASSERT(r, bm.getColor(1, 6) == 0xffffff00);
REPORTER_ASSERT(r, bm.getColor(2, 6) == 0xff00ffff);
REPORTER_ASSERT(r, bm.getColor(0, 8) == 0xffffffff);
REPORTER_ASSERT(r, bm.getColor(1, 8) == 0xffff00ff);
REPORTER_ASSERT(r, bm.getColor(2, 8) == 0xff0000ff);
}
}
static void test_gif_data_short(skiatest::Reporter* r,
void* data,
size_t size) {
SkBitmap bm;
bool imageDecodeSuccess = decode_memory(data, size, &bm);
REPORTER_ASSERT(r, imageDecodeSuccess);
REPORTER_ASSERT(r, bm.width() == 3);
REPORTER_ASSERT(r, bm.height() == 3);
REPORTER_ASSERT(r, !(bm.empty()));
if (!(bm.empty())) {
REPORTER_ASSERT(r, bm.getColor(0, 0) == 0xffff0000);
REPORTER_ASSERT(r, bm.getColor(1, 0) == 0xffffff00);
REPORTER_ASSERT(r, bm.getColor(2, 0) == 0xff00ffff);
REPORTER_ASSERT(r, bm.getColor(0, 1) == 0xff808080);
REPORTER_ASSERT(r, bm.getColor(1, 1) == 0xff000000);
REPORTER_ASSERT(r, bm.getColor(2, 1) == 0xff00ff00);
}
}
/**
This test will test the ability of the SkCodec to deal with
GIF files which have been mangled somehow. We want to display as
much of the GIF as possible.
*/
DEF_TEST(Gif, reporter) {
// test perfectly good images.
test_gif_data(reporter, static_cast<void *>(gGIFData), sizeof(gGIFData));
test_interlaced_gif_data(reporter, static_cast<void *>(gInterlacedGIF),
sizeof(gInterlacedGIF));
unsigned char badData[sizeof(gGIFData)];
memcpy(badData, gGIFData, sizeof(gGIFData));
badData[6] = 0x01; // image too wide
test_gif_data(reporter, static_cast<void *>(badData), sizeof(gGIFData));
// "libgif warning [image too wide, expanding output to size]"
memcpy(badData, gGIFData, sizeof(gGIFData));
badData[8] = 0x01; // image too tall
test_gif_data(reporter, static_cast<void *>(badData), sizeof(gGIFData));
// "libgif warning [image too tall, expanding output to size]"
memcpy(badData, gGIFData, sizeof(gGIFData));
badData[62] = 0x01; // image shifted right
test_gif_data_dims(reporter, static_cast<void *>(badData), sizeof(gGIFData), 4, 3);
memcpy(badData, gGIFData, sizeof(gGIFData));
badData[64] = 0x01; // image shifted down
test_gif_data_dims(reporter, static_cast<void *>(badData), sizeof(gGIFData), 3, 4);
memcpy(badData, gGIFData, sizeof(gGIFData));
badData[62] = 0xff; // image shifted right
badData[63] = 0xff;
test_gif_data_dims(reporter, static_cast<void *>(badData), sizeof(gGIFData), 3 + 0xFFFF, 3);
memcpy(badData, gGIFData, sizeof(gGIFData));
badData[64] = 0xff; // image shifted down
badData[65] = 0xff;
test_gif_data_dims(reporter, static_cast<void *>(badData), sizeof(gGIFData), 3, 3 + 0xFFFF);
test_gif_data_no_colormap(reporter, static_cast<void *>(gGIFDataNoColormap),
sizeof(gGIFDataNoColormap));
// "libgif warning [missing colormap]"
// test short Gif. 80 is missing a few bytes.
test_gif_data_short(reporter, static_cast<void *>(gGIFData), 80);
// "libgif warning [DGifGetLine]"
test_interlaced_gif_data(reporter, static_cast<void *>(gInterlacedGIF),
100); // 100 is missing a few bytes
// "libgif warning [interlace DGifGetLine]"
}
// Regression test for decoding a gif image with sampleSize of 4, which was
// previously crashing.
DEF_TEST(Gif_Sampled, r) {
SkAutoTDelete<SkFILEStream> stream(
new SkFILEStream(GetResourcePath("test640x479.gif").c_str()));
REPORTER_ASSERT(r, stream->isValid());
if (!stream->isValid()) {
return;
}
SkAutoTDelete<SkAndroidCodec> codec(SkAndroidCodec::NewFromStream(stream.release()));
REPORTER_ASSERT(r, codec);
if (!codec) {
return;
}
// Construct a color table for the decode if necessary
SkAutoTUnref<SkColorTable> colorTable(nullptr);
SkPMColor* colorPtr = nullptr;
int* colorCountPtr = nullptr;
int maxColors = 256;
if (kIndex_8_SkColorType == codec->getInfo().colorType()) {
SkPMColor colors[256];
colorTable.reset(new SkColorTable(colors, maxColors));
colorPtr = const_cast<SkPMColor*>(colorTable->readColors());
colorCountPtr = &maxColors;
}
SkAndroidCodec::AndroidOptions options;
options.fSampleSize = 4;
options.fColorPtr = colorPtr;
options.fColorCount = colorCountPtr;
SkBitmap bm;
bm.allocPixels(codec->getInfo(), nullptr, colorTable.get());
const SkCodec::Result result = codec->getAndroidPixels(codec->getInfo(), bm.getPixels(),
bm.rowBytes(), &options);
REPORTER_ASSERT(r, result == SkCodec::kSuccess);
}