aboutsummaryrefslogtreecommitdiff
path: root/src/codec
diff options
context:
space:
mode:
authorNigel Tao <nigeltao@google.com>2018-10-21 16:29:38 +1100
committerSkia Commit-Bot <skia-commit-bot@chromium.org>2018-10-24 20:17:59 +0000
commit60009388be154f9f65b9e3336c0b460851541aef (patch)
tree0a2b2ba127c1a19735d11dc4489992969199c1a8 /src/codec
parent4f598e8c829aeb3300f221cd990e595114dda59a (diff)
downloadskqp-60009388be154f9f65b9e3336c0b460851541aef.tar.gz
New GIF codec; new third_party/wuffs dep
Bug: skia:8235 Change-Id: I883e05bc50c48f822b5ac3884f25ae67d21c94a9 Reviewed-on: https://skia-review.googlesource.com/c/136940 Commit-Queue: Leon Scroggins <scroggo@google.com> Reviewed-by: Leon Scroggins <scroggo@google.com>
Diffstat (limited to 'src/codec')
-rw-r--r--src/codec/SkCodec.cpp10
-rw-r--r--src/codec/SkWuffsCodec.cpp793
-rw-r--r--src/codec/SkWuffsCodec.h17
3 files changed, 819 insertions, 1 deletions
diff --git a/src/codec/SkCodec.cpp b/src/codec/SkCodec.cpp
index dfd1e0a5e8..626de9f4e5 100644
--- a/src/codec/SkCodec.cpp
+++ b/src/codec/SkCodec.cpp
@@ -11,7 +11,6 @@
#include "SkColorSpace.h"
#include "SkData.h"
#include "SkFrameHolder.h"
-#include "SkGifCodec.h"
#include "SkHalf.h"
#ifdef SK_HAS_HEIF_LIBRARY
#include "SkHeifCodec.h"
@@ -25,6 +24,11 @@
#include "SkStream.h"
#include "SkWbmpCodec.h"
#include "SkWebpCodec.h"
+#ifdef SK_HAS_WUFFS_LIBRARY
+#include "SkWuffsCodec.h"
+#else
+#include "SkGifCodec.h"
+#endif
struct DecoderProc {
bool (*IsFormat)(const void*, size_t);
@@ -38,7 +42,11 @@ static constexpr DecoderProc gDecoderProcs[] = {
#ifdef SK_HAS_WEBP_LIBRARY
{ SkWebpCodec::IsWebp, SkWebpCodec::MakeFromStream },
#endif
+#ifdef SK_HAS_WUFFS_LIBRARY
+ { SkWuffsCodec_IsFormat, SkWuffsCodec_MakeFromStream },
+#else
{ SkGifCodec::IsGif, SkGifCodec::MakeFromStream },
+#endif
#ifdef SK_HAS_PNG_LIBRARY
{ SkIcoCodec::IsIco, SkIcoCodec::MakeFromStream },
#endif
diff --git a/src/codec/SkWuffsCodec.cpp b/src/codec/SkWuffsCodec.cpp
new file mode 100644
index 0000000000..cb647487bf
--- /dev/null
+++ b/src/codec/SkWuffsCodec.cpp
@@ -0,0 +1,793 @@
+/*
+ * Copyright 2018 Google Inc.
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include "SkWuffsCodec.h"
+
+#include "../private/SkMalloc.h"
+#include "SkFrameHolder.h"
+#include "SkSampler.h"
+#include "wuffs-v0.2.h"
+
+#define SK_WUFFS_CODEC_BUFFER_SIZE 4096
+
+// TODO(nigeltao): use a swizzler instead of load_u32le and store_etc.
+
+static inline uint32_t load_u32le(uint8_t* p) {
+ return ((uint32_t)(p[0]) << 0) | ((uint32_t)(p[1]) << 8) | ((uint32_t)(p[2]) << 16) |
+ ((uint32_t)(p[3]) << 24);
+}
+
+static inline void store_u32le(uint8_t* p, uint32_t x) {
+ p[0] = x >> 0;
+ p[1] = x >> 8;
+ p[2] = x >> 16;
+ p[3] = x >> 24;
+}
+
+static inline void store_u32le_switched(uint8_t* p, uint32_t x) {
+ // This could probably be optimized, but in any case, we should use a
+ // swizzler.
+ p[0] = x >> 16;
+ p[1] = x >> 8;
+ p[2] = x >> 0;
+ p[3] = x >> 24;
+}
+
+static inline void store_565(uint8_t* p, uint32_t argb) {
+ uint32_t r5 = 0x1F & (argb >> ((8 - 5) + 16));
+ uint32_t g6 = 0x3F & (argb >> ((8 - 6) + 8));
+ uint32_t b5 = 0x1F & (argb >> ((8 - 5) + 0));
+ p[0] = (b5 << 0) | (g6 << 5);
+ p[1] = (g6 >> 3) | (r5 << 3);
+}
+
+static bool fill_buffer(wuffs_base__io_buffer* b, SkStream* s) {
+ b->compact();
+ size_t num_read = s->read(b->data.ptr + b->meta.wi, b->data.len - b->meta.wi);
+ b->meta.wi += num_read;
+ b->meta.closed = s->isAtEnd();
+ return num_read > 0;
+}
+
+static bool seek_buffer(wuffs_base__io_buffer* b, SkStream* s, uint64_t pos) {
+ // Try to re-position the io_buffer's meta.ri read-index first, which is
+ // cheaper than seeking in the backing SkStream.
+ if ((pos >= b->meta.pos) && (pos - b->meta.pos <= b->meta.wi)) {
+ b->meta.ri = pos - b->meta.pos;
+ return true;
+ }
+ // Seek in the backing SkStream.
+ if ((pos > SIZE_MAX) || (!s->seek(pos))) {
+ return false;
+ }
+ b->meta.wi = 0;
+ b->meta.ri = 0;
+ b->meta.pos = pos;
+ b->meta.closed = false;
+ return true;
+}
+
+static SkEncodedInfo::Alpha wuffs_blend_to_skia_alpha(wuffs_base__animation_blend w) {
+ return (w == WUFFS_BASE__ANIMATION_BLEND__OPAQUE) ? SkEncodedInfo::kOpaque_Alpha
+ : SkEncodedInfo::kUnpremul_Alpha;
+}
+
+static SkCodecAnimation::Blend wuffs_blend_to_skia_blend(wuffs_base__animation_blend w) {
+ return (w == WUFFS_BASE__ANIMATION_BLEND__SRC) ? SkCodecAnimation::Blend::kBG
+ : SkCodecAnimation::Blend::kPriorFrame;
+}
+
+static SkCodecAnimation::DisposalMethod wuffs_disposal_to_skia_disposal(
+ wuffs_base__animation_disposal w) {
+ switch (w) {
+ case WUFFS_BASE__ANIMATION_DISPOSAL__RESTORE_BACKGROUND:
+ return SkCodecAnimation::DisposalMethod::kRestoreBGColor;
+ case WUFFS_BASE__ANIMATION_DISPOSAL__RESTORE_PREVIOUS:
+ return SkCodecAnimation::DisposalMethod::kRestorePrevious;
+ default:
+ return SkCodecAnimation::DisposalMethod::kKeep;
+ }
+}
+
+// -------------------------------- Class definitions
+
+class SkWuffsCodec;
+
+class SkWuffsFrame final : public SkFrame {
+public:
+ SkWuffsFrame(wuffs_base__frame_config* fc);
+
+ SkCodec::FrameInfo frameInfo(bool fullyReceived) const;
+ uint64_t ioPosition() const;
+
+ // SkFrame overrides.
+ SkEncodedInfo::Alpha onReportedAlpha() const override;
+
+private:
+ uint64_t fIOPosition;
+ SkEncodedInfo::Alpha fReportedAlpha;
+
+ typedef SkFrame INHERITED;
+};
+
+// SkWuffsFrameHolder is a trivial indirector that forwards its calls onto a
+// SkWuffsCodec. It is a separate class as SkWuffsCodec would otherwise
+// inherit from both SkCodec and SkFrameHolder, and Skia style discourages
+// multiple inheritance (e.g. with its "typedef Foo INHERITED" convention).
+class SkWuffsFrameHolder final : public SkFrameHolder {
+public:
+ SkWuffsFrameHolder() : INHERITED() {}
+
+ void init(SkWuffsCodec* codec, int width, int height);
+
+ // SkFrameHolder overrides.
+ const SkFrame* onGetFrame(int i) const override;
+
+private:
+ const SkWuffsCodec* fCodec;
+
+ typedef SkFrameHolder INHERITED;
+};
+
+class SkWuffsCodec final : public SkCodec {
+public:
+ SkWuffsCodec(SkEncodedInfo&& encodedInfo,
+ std::unique_ptr<SkStream> stream,
+ std::unique_ptr<wuffs_gif__decoder, decltype(&sk_free)> dec,
+ std::unique_ptr<uint8_t, decltype(&sk_free)> pixbuf_ptr,
+ std::unique_ptr<uint8_t, decltype(&sk_free)> workbuf_ptr,
+ size_t workbuf_len,
+ wuffs_base__image_config imgcfg,
+ wuffs_base__pixel_buffer pixbuf,
+ wuffs_base__io_buffer iobuf);
+
+ const SkWuffsFrame* frame(int i) const;
+
+private:
+ // SkCodec overrides.
+ SkEncodedImageFormat onGetEncodedFormat() const override;
+ Result onGetPixels(const SkImageInfo&, void*, size_t, const Options&, int*) override;
+ const SkFrameHolder* getFrameHolder() const override;
+ Result onStartIncrementalDecode(const SkImageInfo& dstInfo,
+ void* dst,
+ size_t rowBytes,
+ const SkCodec::Options& options) override;
+ Result onIncrementalDecode(int* rowsDecoded) override;
+ int onGetFrameCount() override;
+ bool onGetFrameInfo(int, FrameInfo*) const override;
+ int onGetRepetitionCount() override;
+
+ void readFrames();
+ Result seekFrame(int frameIndex);
+
+ Result resetDecoder();
+ const char* decodeFrameConfig();
+ const char* decodeFrame();
+ void updateNumFullyReceivedFrames();
+
+ SkWuffsFrameHolder fFrameHolder;
+ std::unique_ptr<SkStream> fStream;
+ std::unique_ptr<wuffs_gif__decoder, decltype(&sk_free)> fDecoder;
+ std::unique_ptr<uint8_t, decltype(&sk_free)> fPixbufPtr;
+ std::unique_ptr<uint8_t, decltype(&sk_free)> fWorkbufPtr;
+ size_t fWorkbufLen;
+
+ const uint64_t fFirstFrameIOPosition;
+ wuffs_base__frame_config fFrameConfig;
+ wuffs_base__pixel_buffer fPixelBuffer;
+ wuffs_base__io_buffer fIOBuffer;
+
+ // Incremental decoding state.
+ SkColorType fIncrDecColorType;
+ uint8_t* fIncrDecDst;
+ bool fIncrDecHaveFrameConfig;
+ size_t fIncrDecRowBytes;
+
+ uint64_t fNumFullyReceivedFrames;
+ std::vector<SkWuffsFrame> fFrames;
+ bool fFramesComplete;
+
+ // If calling an fDecoder method returns an incomplete status, then
+ // fDecoder is suspended in a coroutine (i.e. waiting on I/O or halted on a
+ // non-recoverable error). To keep its internal proof-of-safety invariants
+ // consistent, there's only two things you can safely do with a suspended
+ // Wuffs object: resume the coroutine, or reset all state (memset to zero
+ // and start again).
+ //
+ // If fDecoderIsSuspended, and we aren't sure that we're going to resume
+ // the coroutine, then we will need to call this->resetDecoder before
+ // calling other fDecoder methods.
+ bool fDecoderIsSuspended;
+
+ uint8_t fBuffer[SK_WUFFS_CODEC_BUFFER_SIZE];
+
+ typedef SkCodec INHERITED;
+};
+
+// -------------------------------- SkWuffsFrame implementation
+
+SkWuffsFrame::SkWuffsFrame(wuffs_base__frame_config* fc)
+ : INHERITED(fc->index()),
+ fIOPosition(fc->io_position()),
+ fReportedAlpha(wuffs_blend_to_skia_alpha(fc->blend())) {
+ wuffs_base__rect_ie_u32 r = fc->bounds();
+ this->setXYWH(r.min_incl_x, r.min_incl_y, r.width(), r.height());
+ this->setDisposalMethod(wuffs_disposal_to_skia_disposal(fc->disposal()));
+ this->setDuration(fc->duration() / WUFFS_BASE__FLICKS_PER_MILLISECOND);
+ this->setBlend(wuffs_blend_to_skia_blend(fc->blend()));
+}
+
+SkCodec::FrameInfo SkWuffsFrame::frameInfo(bool fullyReceived) const {
+ return ((SkCodec::FrameInfo){
+ .fRequiredFrame = getRequiredFrame(),
+ .fDuration = getDuration(),
+ .fFullyReceived = fullyReceived,
+ .fAlphaType = hasAlpha() ? kUnpremul_SkAlphaType : kOpaque_SkAlphaType,
+ .fDisposalMethod = getDisposalMethod(),
+ });
+}
+
+uint64_t SkWuffsFrame::ioPosition() const {
+ return fIOPosition;
+}
+
+SkEncodedInfo::Alpha SkWuffsFrame::onReportedAlpha() const {
+ return fReportedAlpha;
+}
+
+// -------------------------------- SkWuffsFrameHolder implementation
+
+void SkWuffsFrameHolder::init(SkWuffsCodec* codec, int width, int height) {
+ fCodec = codec;
+ // Initialize SkFrameHolder's (the superclass) fields.
+ fScreenWidth = width;
+ fScreenHeight = height;
+}
+
+const SkFrame* SkWuffsFrameHolder::onGetFrame(int i) const {
+ return fCodec->frame(i);
+};
+
+// -------------------------------- SkWuffsCodec implementation
+
+SkWuffsCodec::SkWuffsCodec(SkEncodedInfo&& encodedInfo,
+ std::unique_ptr<SkStream> stream,
+ std::unique_ptr<wuffs_gif__decoder, decltype(&sk_free)> dec,
+ std::unique_ptr<uint8_t, decltype(&sk_free)> pixbuf_ptr,
+ std::unique_ptr<uint8_t, decltype(&sk_free)> workbuf_ptr,
+ size_t workbuf_len,
+ wuffs_base__image_config imgcfg,
+ wuffs_base__pixel_buffer pixbuf,
+ wuffs_base__io_buffer iobuf)
+ : INHERITED(std::move(encodedInfo),
+ skcms_PixelFormat_RGBA_8888,
+ // Pass a nullptr SkStream to the SkCodec constructor. We
+ // manage the stream ourselves, as the default SkCodec behavior
+ // is too trigger-happy on rewinding the stream.
+ nullptr),
+ fStream(std::move(stream)),
+ fDecoder(std::move(dec)),
+ fPixbufPtr(std::move(pixbuf_ptr)),
+ fWorkbufPtr(std::move(workbuf_ptr)),
+ fWorkbufLen(workbuf_len),
+ fFirstFrameIOPosition(imgcfg.first_frame_io_position()),
+ fFrameConfig((wuffs_base__frame_config){}),
+ fPixelBuffer(pixbuf),
+ fIOBuffer((wuffs_base__io_buffer){}),
+ fIncrDecColorType(kUnknown_SkColorType),
+ fIncrDecDst(nullptr),
+ fIncrDecHaveFrameConfig(false),
+ fIncrDecRowBytes(0),
+ fNumFullyReceivedFrames(0),
+ fFramesComplete(false),
+ fDecoderIsSuspended(false) {
+ fFrameHolder.init(this, imgcfg.pixcfg.width(), imgcfg.pixcfg.height());
+
+ // Initialize fIOBuffer's fields, copying any outstanding data from iobuf to
+ // fIOBuffer, as iobuf's backing array may not be valid for the lifetime of
+ // this SkWuffsCodec object, but fIOBuffer's backing array (fBuffer) is.
+ SkASSERT(iobuf.data.len == SK_WUFFS_CODEC_BUFFER_SIZE);
+ memmove(fBuffer, iobuf.data.ptr, iobuf.meta.wi);
+ fIOBuffer = ((wuffs_base__io_buffer){
+ .data = ((wuffs_base__slice_u8){
+ .ptr = fBuffer,
+ .len = SK_WUFFS_CODEC_BUFFER_SIZE,
+ }),
+ .meta = iobuf.meta,
+ });
+}
+
+const SkWuffsFrame* SkWuffsCodec::frame(int i) const {
+ if ((0 <= i) && (static_cast<size_t>(i) < fFrames.size())) {
+ return &fFrames[i];
+ }
+ return nullptr;
+}
+
+SkEncodedImageFormat SkWuffsCodec::onGetEncodedFormat() const {
+ return SkEncodedImageFormat::kGIF;
+}
+
+SkCodec::Result SkWuffsCodec::onGetPixels(const SkImageInfo& dstInfo,
+ void* dst,
+ size_t rowBytes,
+ const Options& options,
+ int* rowsDecoded) {
+ SkCodec::Result result = this->onStartIncrementalDecode(dstInfo, dst, rowBytes, options);
+ if (result != kSuccess) {
+ return result;
+ }
+ return this->onIncrementalDecode(rowsDecoded);
+}
+
+const SkFrameHolder* SkWuffsCodec::getFrameHolder() const {
+ return &fFrameHolder;
+}
+
+SkCodec::Result SkWuffsCodec::onStartIncrementalDecode(const SkImageInfo& dstInfo,
+ void* dst,
+ size_t rowBytes,
+ const SkCodec::Options& options) {
+ if (options.fSubset) {
+ return SkCodec::kUnimplemented;
+ }
+ SkCodec::Result result = this->seekFrame(options.fFrameIndex);
+ if (result != SkCodec::kSuccess) {
+ return result;
+ }
+
+ SkSampler::Fill(dstInfo, dst, rowBytes, options.fZeroInitialized);
+
+ fIncrDecColorType = dstInfo.colorType();
+ fIncrDecDst = static_cast<uint8_t*>(dst);
+ fIncrDecHaveFrameConfig = false;
+ fIncrDecRowBytes = rowBytes;
+
+ return SkCodec::kSuccess;
+}
+
+SkCodec::Result SkWuffsCodec::onIncrementalDecode(int* rowsDecoded) {
+ if (!fIncrDecDst) {
+ return SkCodec::kInternalError;
+ }
+
+ if (!fIncrDecHaveFrameConfig) {
+ const char* status = this->decodeFrameConfig();
+ if (status == nullptr) {
+ // No-op.
+ } else if (status == wuffs_base__suspension__short_read) {
+ return SkCodec::kIncompleteInput;
+ } else {
+ SkCodecPrintf("decodeFrameConfig: %s", status);
+ return SkCodec::kErrorInInput;
+ }
+ fIncrDecHaveFrameConfig = true;
+ }
+
+ SkCodec::Result result = SkCodec::kSuccess;
+ const char* status = this->decodeFrame();
+ if (status == nullptr) {
+ // No-op.
+ } else if (status == wuffs_base__suspension__short_read) {
+ result = SkCodec::kIncompleteInput;
+ } else {
+ SkCodecPrintf("decodeFrame: %s", status);
+ return SkCodec::kErrorInInput;
+ }
+
+ // TODO(nigeltao): use a swizzler, once I figure out how it works. For
+ // now, a C style load/store loop gets the job done.
+ wuffs_base__rect_ie_u32 r = fFrameConfig.bounds();
+ wuffs_base__table_u8 pixels = fPixelBuffer.plane(0);
+ wuffs_base__slice_u8 palette = fPixelBuffer.palette();
+ SkASSERT(palette.len == 4 * 256);
+ switch (fIncrDecColorType) {
+ case kRGB_565_SkColorType:
+ for (uint32_t y = r.min_incl_y; y < r.max_excl_y; y++) {
+ uint8_t* d = fIncrDecDst + (y * fIncrDecRowBytes) + (r.min_incl_x * 2);
+ uint8_t* s = pixels.ptr + (y * pixels.stride) + (r.min_incl_x * 1);
+ for (uint32_t x = r.min_incl_x; x < r.max_excl_x; x++) {
+ uint8_t index = *s++;
+ uint32_t argb = load_u32le(palette.ptr + 4 * static_cast<size_t>(index));
+ store_565(d, argb);
+ d += 2;
+ }
+ }
+ break;
+ case kBGRA_8888_SkColorType:
+ for (uint32_t y = r.min_incl_y; y < r.max_excl_y; y++) {
+ uint8_t* d = fIncrDecDst + (y * fIncrDecRowBytes) + (r.min_incl_x * 4);
+ uint8_t* s = pixels.ptr + (y * pixels.stride) + (r.min_incl_x * 1);
+ for (uint32_t x = r.min_incl_x; x < r.max_excl_x; x++) {
+ uint8_t index = *s++;
+ uint32_t argb = load_u32le(palette.ptr + 4 * static_cast<size_t>(index));
+ store_u32le(d, argb);
+ d += 4;
+ }
+ }
+ break;
+ case kRGBA_8888_SkColorType:
+ for (uint32_t y = r.min_incl_y; y < r.max_excl_y; y++) {
+ uint8_t* d = fIncrDecDst + (y * fIncrDecRowBytes) + (r.min_incl_x * 4);
+ uint8_t* s = pixels.ptr + (y * pixels.stride) + (r.min_incl_x * 1);
+ for (uint32_t x = r.min_incl_x; x < r.max_excl_x; x++) {
+ uint8_t index = *s++;
+ uint32_t argb = load_u32le(palette.ptr + 4 * static_cast<size_t>(index));
+ store_u32le_switched(d, argb);
+ d += 4;
+ }
+ }
+ break;
+ default:
+ return SkCodec::kUnimplemented;
+ }
+
+ // The semantics of *rowsDecoded is: say you have a 10 pixel high image
+ // (both the frame and the image). If you only decoded the first 3 rows,
+ // set this to 3, and then SkCodec (or the caller of incrementalDecode)
+ // would zero-initialize the remaining 7 (unless the memory was already
+ // zero-initialized).
+ //
+ // Now let's say that the image is still 10 pixels high, but the frame is
+ // from row 5 to 9. If you only decoded 3 rows, but you initialized the
+ // first 5, you could return 8, and the caller would zero-initialize the
+ // final 2. For GIF (where a frame can be smaller than the image and can be
+ // interlaced), we just zero-initialize all 10 rows ahead of time and
+ // return the height of the image, so the caller knows it doesn't need to
+ // do anything.
+ if (rowsDecoded) {
+ *rowsDecoded = static_cast<int>(fPixelBuffer.pixcfg.height());
+ }
+
+ if (result == SkCodec::kSuccess) {
+ fIncrDecColorType = kUnknown_SkColorType;
+ fIncrDecDst = nullptr;
+ fIncrDecHaveFrameConfig = false;
+ fIncrDecRowBytes = 0;
+ }
+ return result;
+}
+
+int SkWuffsCodec::onGetFrameCount() {
+ if (!fFramesComplete) {
+ this->readFrames();
+ this->updateNumFullyReceivedFrames();
+ }
+ return fFrames.size();
+}
+
+bool SkWuffsCodec::onGetFrameInfo(int i, SkCodec::FrameInfo* frameInfo) const {
+ const SkWuffsFrame* f = this->frame(i);
+ if (!f) {
+ return false;
+ }
+ if (frameInfo) {
+ *frameInfo = f->frameInfo(static_cast<uint64_t>(i) < this->fNumFullyReceivedFrames);
+ }
+ return true;
+}
+
+int SkWuffsCodec::onGetRepetitionCount() {
+ // Convert from Wuffs's loop count to Skia's repeat count. Wuffs' uint32_t
+ // number is how many times to play the loop. Skia's int number is how many
+ // times to play the loop *after the first play*. Wuffs and Skia use 0 and
+ // kRepetitionCountInfinite respectively to mean loop forever.
+ uint32_t n = wuffs_gif__decoder__num_animation_loops(fDecoder.get());
+ if (n == 0) {
+ return SkCodec::kRepetitionCountInfinite;
+ }
+ n--;
+ return n < INT_MAX ? n : INT_MAX;
+}
+
+void SkWuffsCodec::readFrames() {
+ size_t n = fFrames.size();
+ int i = n ? n - 1 : 0;
+ if (this->seekFrame(i) != SkCodec::kSuccess) {
+ return;
+ }
+
+ // Iterate through the frames, converting from Wuffs'
+ // wuffs_base__frame_config type to Skia's SkWuffsFrame type.
+ for (; i < INT_MAX; i++) {
+ const char* status = this->decodeFrameConfig();
+ if (status == nullptr) {
+ // No-op.
+ } else if (status == wuffs_base__warning__end_of_data) {
+ break;
+ } else {
+ return;
+ }
+
+ if (static_cast<size_t>(i) < fFrames.size()) {
+ continue;
+ }
+ fFrames.emplace_back(&fFrameConfig);
+ SkWuffsFrame* f = &fFrames[fFrames.size() - 1];
+ fFrameHolder.setAlphaAndRequiredFrame(f);
+ }
+
+ fFramesComplete = true;
+}
+
+SkCodec::Result SkWuffsCodec::seekFrame(int frameIndex) {
+ if (fDecoderIsSuspended) {
+ SkCodec::Result res = this->resetDecoder();
+ if (res != SkCodec::kSuccess) {
+ return res;
+ }
+ }
+
+ uint64_t pos = 0;
+ if (frameIndex < 0) {
+ return SkCodec::kInternalError;
+ } else if (frameIndex == 0) {
+ pos = fFirstFrameIOPosition;
+ } else if (static_cast<size_t>(frameIndex) < fFrames.size()) {
+ pos = fFrames[frameIndex].ioPosition();
+ } else {
+ return SkCodec::kInternalError;
+ }
+
+ if (!seek_buffer(&fIOBuffer, fStream.get(), pos)) {
+ return SkCodec::kInternalError;
+ }
+ const char* status = wuffs_gif__decoder__restart_frame(fDecoder.get(), frameIndex,
+ fIOBuffer.reader_io_position());
+ if (status != nullptr) {
+ return SkCodec::kInternalError;
+ }
+ return SkCodec::kSuccess;
+}
+
+// An overview of the Wuffs decoding API:
+//
+// An animated image (such as GIF) has an image header and then N frames. The
+// image header gives e.g. the overall image's width and height. Each frame
+// consists of a frame header (e.g. frame rectangle bounds, display duration)
+// and a payload (the pixels).
+//
+// In Wuffs terminology, there is one image config and then N pairs of
+// (frame_config, frame). To decode everything (without knowing N in advance)
+// sequentially:
+// - call wuffs_gif__decoder::decode_image_config
+// - while (true) {
+// - call wuffs_gif__decoder::decode_frame_config
+// - if that returned wuffs_base__warning__end_of_data, break
+// - call wuffs_gif__decoder::decode_frame
+// - }
+//
+// The first argument to each decode_foo method is the destination struct to
+// store the decoded information.
+//
+// For random (instead of sequential) access to an image's frames, call
+// wuffs_gif__decoder::restart_frame to prepare to decode the i'th frame.
+// Essentially, it restores the state to be at the top of the while loop above.
+// The wuffs_base__io_buffer's reader position will also need to be set at the
+// right point in the source data stream. The position for the i'th frame is
+// calculated by the i'th decode_frame_config call. You can only call
+// restart_frame after decode_image_config is called, explicitly or implicitly
+// (see below), as decoding a single frame might require for-all-frames
+// information like the overall image dimensions and the global palette.
+//
+// All of those decode_xxx calls are optional. For example, if
+// decode_image_config is not called, then the first decode_frame_config call
+// will implicitly parse and verify the image header, before parsing the first
+// frame's header. Similarly, you can call only decode_frame N times, without
+// calling decode_image_config or decode_frame_config, if you already know
+// metadata like N and each frame's rectangle bounds by some other means (e.g.
+// this is a first party, statically known image).
+//
+// Specifically, starting with an unknown (but re-windable) GIF image, if you
+// want to just find N (i.e. count the number of frames), you can loop calling
+// only the decode_frame_config method and avoid calling the more expensive
+// decode_frame method. In terms of the underlying GIF image format, this will
+// skip over the LZW-encoded pixel data, avoiding the costly LZW decompression.
+//
+// Those decode_xxx methods are also suspendible. They will return early (with
+// a status code that is_suspendible and therefore isn't is_complete) if there
+// isn't enough source data to complete the operation: an incremental decode.
+// Calling decode_xxx again with additional source data will resume the
+// previous operation, instead of starting a new operation. Calling decode_yyy
+// whilst decode_xxx is suspended will result in an error.
+//
+// Once an error is encountered, whether from invalid source data or from a
+// programming error such as calling decode_yyy while suspended in decode_xxx,
+// all subsequent calls will be no-ops that return an error. To reset the
+// decoder into something that does productive work, memset the entire struct
+// to zero, check the Wuffs version and then, in order to be able to call
+// restart_frame, call decode_image_config. The io_buffer and its associated
+// stream will also need to be rewound.
+
+static SkCodec::Result reset_and_decode_image_config(wuffs_gif__decoder* decoder,
+ wuffs_base__image_config* imgcfg,
+ wuffs_base__io_buffer* b,
+ SkStream* s) {
+ memset(decoder, 0, sizeof__wuffs_gif__decoder());
+ const char* status = wuffs_gif__decoder__check_wuffs_version(
+ decoder, sizeof__wuffs_gif__decoder(), WUFFS_VERSION);
+ if (status != nullptr) {
+ SkCodecPrintf("check_wuffs_version: %s", status);
+ return SkCodec::kInternalError;
+ }
+ while (true) {
+ status = wuffs_gif__decoder__decode_image_config(decoder, imgcfg, b->reader());
+ if (status == nullptr) {
+ return SkCodec::kSuccess;
+ } else if (status != wuffs_base__suspension__short_read) {
+ SkCodecPrintf("decode_image_config: %s", status);
+ return SkCodec::kErrorInInput;
+ } else if (!fill_buffer(b, s)) {
+ return SkCodec::kIncompleteInput;
+ }
+ }
+}
+
+SkCodec::Result SkWuffsCodec::resetDecoder() {
+ if (!fStream->rewind()) {
+ return SkCodec::kInternalError;
+ }
+ fIOBuffer.meta = ((wuffs_base__io_buffer_meta){});
+
+ SkCodec::Result result =
+ reset_and_decode_image_config(fDecoder.get(), nullptr, &fIOBuffer, fStream.get());
+ if (result == SkCodec::kIncompleteInput) {
+ return SkCodec::kInternalError;
+ } else if (result != SkCodec::kSuccess) {
+ return result;
+ }
+
+ fDecoderIsSuspended = false;
+ return SkCodec::kSuccess;
+}
+
+const char* SkWuffsCodec::decodeFrameConfig() {
+ while (true) {
+ const char* status = wuffs_gif__decoder__decode_frame_config(fDecoder.get(), &fFrameConfig,
+ fIOBuffer.reader());
+ if ((status == wuffs_base__suspension__short_read) &&
+ fill_buffer(&fIOBuffer, fStream.get())) {
+ continue;
+ }
+ fDecoderIsSuspended = !wuffs_base__status__is_complete(status);
+ this->updateNumFullyReceivedFrames();
+ return status;
+ }
+}
+
+const char* SkWuffsCodec::decodeFrame() {
+ while (true) {
+ const char* status =
+ wuffs_gif__decoder__decode_frame(fDecoder.get(), &fPixelBuffer, fIOBuffer.reader(),
+ ((wuffs_base__slice_u8){
+ .ptr = fWorkbufPtr.get(),
+ .len = fWorkbufLen,
+ }),
+ NULL);
+ if ((status == wuffs_base__suspension__short_read) &&
+ fill_buffer(&fIOBuffer, fStream.get())) {
+ continue;
+ }
+ fDecoderIsSuspended = !wuffs_base__status__is_complete(status);
+ this->updateNumFullyReceivedFrames();
+ return status;
+ }
+}
+
+void SkWuffsCodec::updateNumFullyReceivedFrames() {
+ // wuffs_gif__decoder__num_decoded_frames's return value, n, can change
+ // over time, both up and down, as we seek back and forth in the underlying
+ // stream. fNumFullyReceivedFrames is the highest n we've seen.
+ uint64_t n = wuffs_gif__decoder__num_decoded_frames(fDecoder.get());
+ if (fNumFullyReceivedFrames < n) {
+ fNumFullyReceivedFrames = n;
+ }
+}
+
+// -------------------------------- SkWuffsCodec.h functions
+
+bool SkWuffsCodec_IsFormat(const void* buf, size_t bytesRead) {
+ constexpr const char* gif_ptr = "GIF8";
+ constexpr size_t gif_len = 4;
+ return (bytesRead >= gif_len) && (memcmp(buf, gif_ptr, gif_len) == 0);
+}
+
+std::unique_ptr<SkCodec> SkWuffsCodec_MakeFromStream(std::unique_ptr<SkStream> stream,
+ SkCodec::Result* result) {
+ uint8_t buffer[SK_WUFFS_CODEC_BUFFER_SIZE];
+ wuffs_base__io_buffer iobuf = ((wuffs_base__io_buffer){
+ .data = ((wuffs_base__slice_u8){
+ .ptr = buffer,
+ .len = SK_WUFFS_CODEC_BUFFER_SIZE,
+ }),
+ .meta = ((wuffs_base__io_buffer_meta){}),
+ });
+ wuffs_base__image_config imgcfg = ((wuffs_base__image_config){});
+
+ // Wuffs is primarily a C library, not a C++ one. Furthermore, outside of
+ // the wuffs_base__etc types, the sizeof a file format specific type like
+ // GIF's wuffs_gif__decoder can vary between Wuffs versions. If p is of
+ // type wuffs_gif__decoder*, then the supported API treats p as a pointer
+ // to an opaque type: a private implementation detail. The API is always
+ // "set_foo(p, etc)" and not "p->foo = etc".
+ //
+ // See https://en.wikipedia.org/wiki/Opaque_pointer#C
+ //
+ // Thus, we don't use C++'s new operator (which requires knowing the sizeof
+ // the struct at compile time). Instead, we use sk_malloc_canfail, with
+ // sizeof__wuffs_gif__decoder returning the appropriate value for the
+ // (statically or dynamically) linked version of the Wuffs library.
+ //
+ // As a C (not C++) library, none of the Wuffs types have constructors or
+ // destructors.
+ //
+ // In RAII style, we can still use std::unique_ptr with these pointers, but
+ // we pair the pointer with sk_free instead of C++'s delete.
+ void* decoder_raw = sk_malloc_canfail(sizeof__wuffs_gif__decoder());
+ if (!decoder_raw) {
+ *result = SkCodec::kInternalError;
+ return nullptr;
+ }
+ std::unique_ptr<wuffs_gif__decoder, decltype(&sk_free)> decoder(
+ reinterpret_cast<wuffs_gif__decoder*>(decoder_raw), &sk_free);
+
+ SkCodec::Result reset_result =
+ reset_and_decode_image_config(decoder.get(), &imgcfg, &iobuf, stream.get());
+ if (reset_result != SkCodec::kSuccess) {
+ *result = reset_result;
+ return nullptr;
+ }
+
+ uint32_t width = imgcfg.pixcfg.width();
+ uint32_t height = imgcfg.pixcfg.height();
+ if ((width == 0) || (width > INT_MAX) || (height == 0) || (height > INT_MAX)) {
+ *result = SkCodec::kInvalidInput;
+ return nullptr;
+ }
+
+ uint64_t workbuf_len = imgcfg.workbuf_len().max_incl;
+ void* workbuf_ptr_raw = workbuf_len <= SIZE_MAX ? sk_malloc_canfail(workbuf_len) : nullptr;
+ if (!workbuf_ptr_raw) {
+ *result = SkCodec::kInternalError;
+ return nullptr;
+ }
+ std::unique_ptr<uint8_t, decltype(&sk_free)> workbuf_ptr(
+ reinterpret_cast<uint8_t*>(workbuf_ptr_raw), &sk_free);
+
+ uint64_t pixbuf_len = imgcfg.pixcfg.pixbuf_len();
+ void* pixbuf_ptr_raw = pixbuf_len <= SIZE_MAX ? sk_malloc_canfail(pixbuf_len) : nullptr;
+ if (!pixbuf_ptr_raw) {
+ *result = SkCodec::kInternalError;
+ return nullptr;
+ }
+ std::unique_ptr<uint8_t, decltype(&sk_free)> pixbuf_ptr(
+ reinterpret_cast<uint8_t*>(pixbuf_ptr_raw), &sk_free);
+ wuffs_base__pixel_buffer pixbuf = ((wuffs_base__pixel_buffer){});
+
+ const char* status = pixbuf.set_from_slice(&imgcfg.pixcfg, ((wuffs_base__slice_u8){
+ .ptr = pixbuf_ptr.get(),
+ .len = pixbuf_len,
+ }));
+ if (status != nullptr) {
+ SkCodecPrintf("set_from_slice: %s", status);
+ *result = SkCodec::kInternalError;
+ return nullptr;
+ }
+
+ // In Skia's API, the alpha we calculate here and return is only for the
+ // first frame.
+ SkEncodedInfo::Alpha alpha = imgcfg.first_frame_is_opaque() ? SkEncodedInfo::kOpaque_Alpha
+ : SkEncodedInfo::kBinary_Alpha;
+
+ SkEncodedInfo encodedInfo =
+ SkEncodedInfo::Make(width, height, SkEncodedInfo::kPalette_Color, alpha, 8);
+
+ *result = SkCodec::kSuccess;
+ return std::unique_ptr<SkCodec>(new SkWuffsCodec(
+ std::move(encodedInfo), std::move(stream), std::move(decoder), std::move(pixbuf_ptr),
+ std::move(workbuf_ptr), workbuf_len, imgcfg, pixbuf, iobuf));
+}
diff --git a/src/codec/SkWuffsCodec.h b/src/codec/SkWuffsCodec.h
new file mode 100644
index 0000000000..6dbe62a2f9
--- /dev/null
+++ b/src/codec/SkWuffsCodec.h
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2018 Google Inc.
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef SkWuffsCodec_DEFINED
+#define SkWuffsCodec_DEFINED
+
+#include "SkCodec.h"
+
+// These functions' types match DecoderProc in SkCodec.cpp.
+bool SkWuffsCodec_IsFormat(const void*, size_t);
+std::unique_ptr<SkCodec> SkWuffsCodec_MakeFromStream(std::unique_ptr<SkStream>, SkCodec::Result*);
+
+#endif // SkWuffsCodec_DEFINED