blob: cb36cbf4649c6158dd7f51415f67849faad4d7ac [file] [log] [blame]
msarett8c8f22a2015-04-01 06:58:48 -07001/*
2 * Copyright 2015 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 */
7
scroggo19b91532016-10-24 09:03:26 -07008/*
9 * Copyright (C) 2006 Apple Computer, Inc. All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
21 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
28 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33#include "SkCodecAnimation.h"
msarett8c8f22a2015-04-01 06:58:48 -070034#include "SkCodecPriv.h"
35#include "SkColorPriv.h"
36#include "SkColorTable.h"
msarett1a464672016-01-07 13:17:19 -080037#include "SkGifCodec.h"
msarett8c8f22a2015-04-01 06:58:48 -070038#include "SkStream.h"
39#include "SkSwizzler.h"
scroggo0057ac12016-10-25 12:48:25 -070040#include "SkUtils.h"
msarett8c8f22a2015-04-01 06:58:48 -070041
scroggo19b91532016-10-24 09:03:26 -070042#include <algorithm>
43
44#define GIF87_STAMP "GIF87a"
45#define GIF89_STAMP "GIF89a"
46#define GIF_STAMP_LEN 6
msarett39b2d5a2016-02-17 08:26:31 -080047
msarett8c8f22a2015-04-01 06:58:48 -070048/*
49 * Checks the start of the stream to see if the image is a gif
50 */
scroggodb30be22015-12-08 18:54:13 -080051bool SkGifCodec::IsGif(const void* buf, size_t bytesRead) {
52 if (bytesRead >= GIF_STAMP_LEN) {
scroggo19b91532016-10-24 09:03:26 -070053 if (memcmp(GIF87_STAMP, buf, GIF_STAMP_LEN) == 0 ||
bungeman0153dea2015-08-27 16:43:42 -070054 memcmp(GIF89_STAMP, buf, GIF_STAMP_LEN) == 0)
55 {
msarett8c8f22a2015-04-01 06:58:48 -070056 return true;
57 }
58 }
59 return false;
60}
61
62/*
msarett8c8f22a2015-04-01 06:58:48 -070063 * Error function
64 */
bungeman0153dea2015-08-27 16:43:42 -070065static SkCodec::Result gif_error(const char* msg, SkCodec::Result result = SkCodec::kInvalidInput) {
msarett8c8f22a2015-04-01 06:58:48 -070066 SkCodecPrintf("Gif Error: %s\n", msg);
67 return result;
68}
69
msarett438b2ad2015-04-09 12:43:10 -070070/*
msarett8c8f22a2015-04-01 06:58:48 -070071 * Assumes IsGif was called and returned true
72 * Creates a gif decoder
73 * Reads enough of the stream to determine the image format
74 */
75SkCodec* SkGifCodec::NewFromStream(SkStream* stream) {
scroggo3d3a65c2016-10-24 12:28:30 -070076 std::unique_ptr<SkGifImageReader> reader(new SkGifImageReader(stream));
scroggof9acbe22016-10-25 12:43:21 -070077 if (!reader->parse(SkGifImageReader::SkGIFSizeQuery)) {
scroggo19b91532016-10-24 09:03:26 -070078 // Not enough data to determine the size.
79 return nullptr;
msarett8c8f22a2015-04-01 06:58:48 -070080 }
msarett8c8f22a2015-04-01 06:58:48 -070081
scroggo19b91532016-10-24 09:03:26 -070082 if (0 == reader->screenWidth() || 0 == reader->screenHeight()) {
83 return nullptr;
84 }
85
86 const auto alpha = reader->firstFrameHasAlpha() ? SkEncodedInfo::kBinary_Alpha
87 : SkEncodedInfo::kOpaque_Alpha;
88 // Use kPalette since Gifs are encoded with a color table.
89 // FIXME: Gifs can actually be encoded with 4-bits per pixel. Using 8 works, but we could skip
90 // expanding to 8 bits and take advantage of the SkSwizzler to work from 4.
91 const auto encodedInfo = SkEncodedInfo::Make(SkEncodedInfo::kPalette_Color, alpha, 8);
92
93 // Although the encodedInfo is always kPalette_Color, it is possible that kIndex_8 is
94 // unsupported if the frame is subset and there is no transparent pixel.
95 const auto colorType = reader->firstFrameSupportsIndex8() ? kIndex_8_SkColorType
96 : kN32_SkColorType;
97 // The choice of unpremul versus premul is arbitrary, since all colors are either fully
98 // opaque or fully transparent (i.e. kBinary), but we stored the transparent colors as all
99 // zeroes, which is arguably premultiplied.
100 const auto alphaType = reader->firstFrameHasAlpha() ? kUnpremul_SkAlphaType
101 : kOpaque_SkAlphaType;
102 // FIXME: GIF should default to SkColorSpace::NewNamed(SkColorSpace::kSRGB_Named).
103 const auto imageInfo = SkImageInfo::Make(reader->screenWidth(), reader->screenHeight(),
104 colorType, alphaType);
105 return new SkGifCodec(encodedInfo, imageInfo, reader.release());
106}
msarett8c8f22a2015-04-01 06:58:48 -0700107
scroggob427db12015-08-12 07:24:13 -0700108bool SkGifCodec::onRewind() {
scroggo19b91532016-10-24 09:03:26 -0700109 fReader->clearDecodeState();
scroggob427db12015-08-12 07:24:13 -0700110 return true;
111}
112
scroggo19b91532016-10-24 09:03:26 -0700113SkGifCodec::SkGifCodec(const SkEncodedInfo& encodedInfo, const SkImageInfo& imageInfo,
scroggo3d3a65c2016-10-24 12:28:30 -0700114 SkGifImageReader* reader)
scroggo19b91532016-10-24 09:03:26 -0700115 : INHERITED(encodedInfo, imageInfo, nullptr)
116 , fReader(reader)
117 , fTmpBuffer(nullptr)
118 , fSwizzler(nullptr)
119 , fCurrColorTable(nullptr)
120 , fCurrColorTableIsReal(false)
121 , fFilledBackground(false)
122 , fFirstCallToIncrementalDecode(false)
123 , fDst(nullptr)
124 , fDstRowBytes(0)
125 , fRowsDecoded(0)
126{
127 reader->setClient(this);
msarett8c8f22a2015-04-01 06:58:48 -0700128}
msarett10522ff2015-09-07 08:54:01 -0700129
scroggo19b91532016-10-24 09:03:26 -0700130std::vector<SkCodec::FrameInfo> SkGifCodec::onGetFrameInfo() {
scroggof9acbe22016-10-25 12:43:21 -0700131 fReader->parse(SkGifImageReader::SkGIFFrameCountQuery);
scroggo19b91532016-10-24 09:03:26 -0700132 const size_t size = fReader->imagesCount();
133 std::vector<FrameInfo> result(size);
134 for (size_t i = 0; i < size; i++) {
scroggof9acbe22016-10-25 12:43:21 -0700135 const SkGIFFrameContext* frameContext = fReader->frameContext(i);
scroggo19b91532016-10-24 09:03:26 -0700136 result[i].fDuration = frameContext->delayTime();
137 result[i].fRequiredFrame = frameContext->getRequiredFrame();
msarett10522ff2015-09-07 08:54:01 -0700138 }
scroggo19b91532016-10-24 09:03:26 -0700139 return result;
msarett10522ff2015-09-07 08:54:01 -0700140}
141
scroggo19b91532016-10-24 09:03:26 -0700142void SkGifCodec::initializeColorTable(const SkImageInfo& dstInfo, size_t frameIndex,
143 SkPMColor* inputColorPtr, int* inputColorCount) {
144 fCurrColorTable = fReader->getColorTable(dstInfo.colorType(), frameIndex);
145 fCurrColorTableIsReal = fCurrColorTable;
146 if (!fCurrColorTable) {
scroggo0057ac12016-10-25 12:48:25 -0700147 // This is possible for an empty frame. Create a dummy with all transparent.
scroggoc85b9702016-10-25 12:53:59 -0700148 SkPMColor colors[SK_MAX_COLORS];
149 sk_memset32(colors, SK_ColorTRANSPARENT, SK_MAX_COLORS);
scroggo0057ac12016-10-25 12:48:25 -0700150 fCurrColorTable.reset(new SkColorTable(colors, 256));
msarett10522ff2015-09-07 08:54:01 -0700151 }
152
scroggo19b91532016-10-24 09:03:26 -0700153 if (inputColorCount) {
154 *inputColorCount = fCurrColorTable->count();
msarett10522ff2015-09-07 08:54:01 -0700155 }
156
scroggo19b91532016-10-24 09:03:26 -0700157 copy_color_table(dstInfo, fCurrColorTable.get(), inputColorPtr, inputColorCount);
msarett10522ff2015-09-07 08:54:01 -0700158}
159
scroggo19b91532016-10-24 09:03:26 -0700160
msarett10522ff2015-09-07 08:54:01 -0700161SkCodec::Result SkGifCodec::prepareToDecode(const SkImageInfo& dstInfo, SkPMColor* inputColorPtr,
162 int* inputColorCount, const Options& opts) {
msarett10522ff2015-09-07 08:54:01 -0700163 // Check for valid input parameters
msarett2ecc35f2016-09-08 11:55:16 -0700164 if (!conversion_possible_ignore_color_space(dstInfo, this->getInfo())) {
165 return gif_error("Cannot convert input type to output type.\n", kInvalidConversion);
msarett10522ff2015-09-07 08:54:01 -0700166 }
167
scroggo19b91532016-10-24 09:03:26 -0700168 if (dstInfo.colorType() == kRGBA_F16_SkColorType) {
169 // FIXME: This should be supported.
170 return gif_error("GIF does not yet support F16.\n", kInvalidConversion);
171 }
msarett5af4e0b2015-11-17 11:18:03 -0800172
scroggo19b91532016-10-24 09:03:26 -0700173 if (opts.fSubset) {
174 return gif_error("Subsets not supported.\n", kUnimplemented);
175 }
176
177 const size_t frameIndex = opts.fFrameIndex;
scroggo53f63b62016-10-27 08:29:13 -0700178 if (frameIndex > 0) {
179 switch (dstInfo.colorType()) {
180 case kIndex_8_SkColorType:
181 // FIXME: It is possible that a later frame can be decoded to index8, if it does one
182 // of the following:
183 // - Covers the entire previous frame
184 // - Shares a color table (and transparent index) with any prior frames that are
185 // showing.
186 // We must support index8 for the first frame to be backwards compatible on Android,
187 // but we do not (currently) need to support later frames as index8.
188 return gif_error("Cannot decode multiframe gif (except frame 0) as index 8.\n",
189 kInvalidConversion);
190 case kRGB_565_SkColorType:
191 // FIXME: In theory, we might be able to support this, but it's not clear that it
192 // is necessary (Chromium does not decode to 565, and Android does not decode
193 // frames beyond the first). Disabling it because it is somewhat difficult:
194 // - If there is a transparent pixel, and this frame draws on top of another frame
195 // (if the frame is independent with a transparent pixel, we should not decode to
196 // 565 anyway, since it is not opaque), we need to skip drawing the transparent
197 // pixels (see writeTransparentPixels in haveDecodedRow). We currently do this by
198 // first swizzling into temporary memory, then copying into the destination. (We
199 // let the swizzler handle it first because it may need to sample.) After
200 // swizzling to 565, we do not know which pixels in our temporary memory
201 // correspond to the transparent pixel, so we do not know what to skip. We could
202 // special case the non-sampled case (no need to swizzle), but as this is
203 // currently unused we can just not support it.
204 return gif_error("Cannot decode multiframe gif (except frame 0) as 565.\n",
205 kInvalidConversion);
206 default:
207 break;
208 }
scroggo19b91532016-10-24 09:03:26 -0700209 }
210
scroggof9acbe22016-10-25 12:43:21 -0700211 fReader->parse((SkGifImageReader::SkGIFParseQuery) frameIndex);
scroggo19b91532016-10-24 09:03:26 -0700212
213 if (frameIndex >= fReader->imagesCount()) {
214 return gif_error("frame index out of range!\n", kIncompleteInput);
215 }
216
217 fTmpBuffer.reset(new uint8_t[dstInfo.minRowBytes()]);
218
219 // Initialize color table and copy to the client if necessary
220 this->initializeColorTable(dstInfo, frameIndex, inputColorPtr, inputColorCount);
221 this->initializeSwizzler(dstInfo, frameIndex);
msarettb30d6982016-02-15 10:18:45 -0800222 return kSuccess;
msarett10522ff2015-09-07 08:54:01 -0700223}
224
scroggo19b91532016-10-24 09:03:26 -0700225void SkGifCodec::initializeSwizzler(const SkImageInfo& dstInfo, size_t frameIndex) {
scroggof9acbe22016-10-25 12:43:21 -0700226 const SkGIFFrameContext* frame = fReader->frameContext(frameIndex);
scroggo19b91532016-10-24 09:03:26 -0700227 // This is only called by prepareToDecode, which ensures frameIndex is in range.
228 SkASSERT(frame);
msarett10522ff2015-09-07 08:54:01 -0700229
scroggo19b91532016-10-24 09:03:26 -0700230 const int xBegin = frame->xOffset();
231 const int xEnd = std::min(static_cast<int>(frame->xOffset() + frame->width()),
232 static_cast<int>(fReader->screenWidth()));
233
234 // CreateSwizzler only reads left and right of the frame. We cannot use the frame's raw
235 // frameRect, since it might extend beyond the edge of the frame.
236 SkIRect swizzleRect = SkIRect::MakeLTRB(xBegin, 0, xEnd, 0);
237
238 // The default Options should be fine:
239 // - we'll ignore if the memory is zero initialized - unless we're the first frame, this won't
240 // matter anyway.
241 // - subsets are not supported for gif
242 // - the swizzler does not need to know about the frame.
243 // We may not be able to use the real Options anyway, since getPixels does not store it (due to
244 // a bug).
245 fSwizzler.reset(SkSwizzler::CreateSwizzler(this->getEncodedInfo(),
246 fCurrColorTable->readColors(), dstInfo, Options(), &swizzleRect));
247 SkASSERT(fSwizzler.get());
msarett10522ff2015-09-07 08:54:01 -0700248}
249
250/*
251 * Initiates the gif decode
252 */
253SkCodec::Result SkGifCodec::onGetPixels(const SkImageInfo& dstInfo,
scroggo19b91532016-10-24 09:03:26 -0700254 void* pixels, size_t dstRowBytes,
msarett10522ff2015-09-07 08:54:01 -0700255 const Options& opts,
256 SkPMColor* inputColorPtr,
msarette6dd0042015-10-09 11:07:34 -0700257 int* inputColorCount,
258 int* rowsDecoded) {
msarett10522ff2015-09-07 08:54:01 -0700259 Result result = this->prepareToDecode(dstInfo, inputColorPtr, inputColorCount, opts);
260 if (kSuccess != result) {
261 return result;
262 }
263
264 if (dstInfo.dimensions() != this->getInfo().dimensions()) {
265 return gif_error("Scaling not supported.\n", kInvalidScale);
266 }
267
scroggo19b91532016-10-24 09:03:26 -0700268 fDst = pixels;
269 fDstRowBytes = dstRowBytes;
270
271 return this->decodeFrame(true, opts, rowsDecoded);
272}
273
274SkCodec::Result SkGifCodec::onStartIncrementalDecode(const SkImageInfo& dstInfo,
275 void* pixels, size_t dstRowBytes,
276 const SkCodec::Options& opts,
277 SkPMColor* inputColorPtr,
278 int* inputColorCount) {
279 Result result = this->prepareToDecode(dstInfo, inputColorPtr, inputColorCount, opts);
280 if (result != kSuccess) {
281 return result;
msarett10522ff2015-09-07 08:54:01 -0700282 }
283
scroggo19b91532016-10-24 09:03:26 -0700284 fDst = pixels;
285 fDstRowBytes = dstRowBytes;
286
287 fFirstCallToIncrementalDecode = true;
288
msarett10522ff2015-09-07 08:54:01 -0700289 return kSuccess;
290}
291
scroggo19b91532016-10-24 09:03:26 -0700292SkCodec::Result SkGifCodec::onIncrementalDecode(int* rowsDecoded) {
293 // It is possible the client has appended more data. Parse, if needed.
294 const auto& options = this->options();
295 const size_t frameIndex = options.fFrameIndex;
scroggof9acbe22016-10-25 12:43:21 -0700296 fReader->parse((SkGifImageReader::SkGIFParseQuery) frameIndex);
scroggo19b91532016-10-24 09:03:26 -0700297
298 const bool firstCallToIncrementalDecode = fFirstCallToIncrementalDecode;
299 fFirstCallToIncrementalDecode = false;
300 return this->decodeFrame(firstCallToIncrementalDecode, options, rowsDecoded);
msarette6dd0042015-10-09 11:07:34 -0700301}
302
scroggo19b91532016-10-24 09:03:26 -0700303SkCodec::Result SkGifCodec::decodeFrame(bool firstAttempt, const Options& opts, int* rowsDecoded) {
304 const SkImageInfo& dstInfo = this->dstInfo();
305 const size_t frameIndex = opts.fFrameIndex;
306 SkASSERT(frameIndex < fReader->imagesCount());
scroggof9acbe22016-10-25 12:43:21 -0700307 const SkGIFFrameContext* frameContext = fReader->frameContext(frameIndex);
scroggo19b91532016-10-24 09:03:26 -0700308 if (firstAttempt) {
309 // rowsDecoded reports how many rows have been initialized, so a layer above
310 // can fill the rest. In some cases, we fill the background before decoding
311 // (or it is already filled for us), so we report rowsDecoded to be the full
312 // height.
313 bool filledBackground = false;
314 if (frameContext->getRequiredFrame() == kNone) {
315 // We may need to clear to transparent for one of the following reasons:
316 // - The frameRect does not cover the full bounds. haveDecodedRow will
317 // only draw inside the frameRect, so we need to clear the rest.
scroggo19b91532016-10-24 09:03:26 -0700318 // - The frame is interlaced. There is no obvious way to fill
319 // afterwards for an incomplete image. (FIXME: Does the first pass
320 // cover all rows? If so, we do not have to fill here.)
scroggo8bce1172016-10-25 13:08:40 -0700321 // - There is no color table for this frame. In that case will not
322 // draw anything, so we need to fill.
scroggo19b91532016-10-24 09:03:26 -0700323 if (frameContext->frameRect() != this->getInfo().bounds()
scroggo8bce1172016-10-25 13:08:40 -0700324 || frameContext->interlaced() || !fCurrColorTableIsReal) {
scroggo19b91532016-10-24 09:03:26 -0700325 // fill ignores the width (replaces it with the actual, scaled width).
326 // But we need to scale in Y.
327 const int scaledHeight = get_scaled_dimension(dstInfo.height(),
328 fSwizzler->sampleY());
329 auto fillInfo = dstInfo.makeWH(0, scaledHeight);
330 fSwizzler->fill(fillInfo, fDst, fDstRowBytes, this->getFillValue(dstInfo),
331 opts.fZeroInitialized);
332 filledBackground = true;
333 }
334 } else {
335 // Not independent
336 if (!opts.fHasPriorFrame) {
337 // Decode that frame into pixels.
338 Options prevFrameOpts(opts);
339 prevFrameOpts.fFrameIndex = frameContext->getRequiredFrame();
340 prevFrameOpts.fHasPriorFrame = false;
341 const Result prevResult = this->decodeFrame(true, prevFrameOpts, nullptr);
342 switch (prevResult) {
343 case kSuccess:
344 // Prior frame succeeded. Carry on.
345 break;
346 case kIncompleteInput:
347 // Prior frame was incomplete. So this frame cannot be decoded.
348 return kInvalidInput;
349 default:
350 return prevResult;
351 }
352 }
353 const auto* prevFrame = fReader->frameContext(frameContext->getRequiredFrame());
354 if (prevFrame->getDisposalMethod() == SkCodecAnimation::RestoreBGColor_DisposalMethod) {
355 const SkIRect prevRect = prevFrame->frameRect();
356 auto left = get_scaled_dimension(prevRect.fLeft, fSwizzler->sampleX());
357 auto top = get_scaled_dimension(prevRect.fTop, fSwizzler->sampleY());
358 void* const eraseDst = SkTAddOffset<void>(fDst, top * fDstRowBytes
359 + left * SkColorTypeBytesPerPixel(dstInfo.colorType()));
360 auto width = get_scaled_dimension(prevRect.width(), fSwizzler->sampleX());
361 auto height = get_scaled_dimension(prevRect.height(), fSwizzler->sampleY());
362 // fSwizzler->fill() would fill to the scaled width of the frame, but we want to
363 // fill to the scaled with of the width of the PRIOR frame, so we do all the scaling
364 // ourselves and call the static version.
365 SkSampler::Fill(dstInfo.makeWH(width, height), eraseDst,
366 fDstRowBytes, this->getFillValue(dstInfo), kNo_ZeroInitialized);
367 }
368 filledBackground = true;
msarett10522ff2015-09-07 08:54:01 -0700369 }
scroggo19b91532016-10-24 09:03:26 -0700370
371 fFilledBackground = filledBackground;
372 if (filledBackground) {
373 // Report the full (scaled) height, since the client will never need to fill.
374 fRowsDecoded = get_scaled_dimension(dstInfo.height(), fSwizzler->sampleY());
375 } else {
376 // This will be updated by haveDecodedRow.
377 fRowsDecoded = 0;
378 }
msarett10522ff2015-09-07 08:54:01 -0700379 }
msarette6dd0042015-10-09 11:07:34 -0700380
scroggo3d3a65c2016-10-24 12:28:30 -0700381 // Note: there is a difference between the following call to SkGifImageReader::decode
scroggo19b91532016-10-24 09:03:26 -0700382 // returning false and leaving frameDecoded false:
383 // - If the method returns false, there was an error in the stream. We still treat this as
384 // incomplete, since we have already decoded some rows.
385 // - If frameDecoded is false, that just means that we do not have enough data. If more data
386 // is supplied, we may be able to continue decoding this frame. We also treat this as
387 // incomplete.
388 // FIXME: Ensure that we do not attempt to continue decoding if the method returns false and
389 // more data is supplied.
390 bool frameDecoded = false;
391 if (!fReader->decode(frameIndex, &frameDecoded) || !frameDecoded) {
392 if (rowsDecoded) {
393 *rowsDecoded = fRowsDecoded;
394 }
395 return kIncompleteInput;
396 }
397
398 return kSuccess;
msarett10522ff2015-09-07 08:54:01 -0700399}
scroggo46c57472015-09-30 08:57:13 -0700400
scroggo19b91532016-10-24 09:03:26 -0700401uint64_t SkGifCodec::onGetFillValue(const SkImageInfo& dstInfo) const {
402 // Note: Using fCurrColorTable relies on having called initializeColorTable already.
403 // This is (currently) safe because this method is only called when filling, after
404 // initializeColorTable has been called.
405 // FIXME: Is there a way to make this less fragile?
406 if (dstInfo.colorType() == kIndex_8_SkColorType && fCurrColorTableIsReal) {
407 // We only support index 8 for the first frame, for backwards
408 // compatibity on Android, so we are using the color table for the first frame.
409 SkASSERT(this->options().fFrameIndex == 0);
410 // Use the transparent index for the first frame.
411 const size_t transPixel = fReader->frameContext(0)->transparentPixel();
412 if (transPixel < (size_t) fCurrColorTable->count()) {
413 return transPixel;
414 }
415 // Fall through to return SK_ColorTRANSPARENT (i.e. 0). This choice is arbitrary,
416 // but we have to pick something inside the color table, and this one is as good
417 // as any.
418 }
419 // Using transparent as the fill value matches the behavior in Chromium,
420 // which ignores the background color.
421 // If the colorType is kIndex_8, and there was no color table (i.e.
422 // fCurrColorTableIsReal is false), this value (zero) corresponds to the
423 // only entry in the dummy color table provided to the client.
424 return SK_ColorTRANSPARENT;
425}
msarett72261c02015-11-19 15:29:26 -0800426
scroggo19b91532016-10-24 09:03:26 -0700427bool SkGifCodec::haveDecodedRow(size_t frameIndex, const unsigned char* rowBegin,
428 size_t rowNumber, unsigned repeatCount, bool writeTransparentPixels)
429{
scroggof9acbe22016-10-25 12:43:21 -0700430 const SkGIFFrameContext* frameContext = fReader->frameContext(frameIndex);
scroggo19b91532016-10-24 09:03:26 -0700431 // The pixel data and coordinates supplied to us are relative to the frame's
432 // origin within the entire image size, i.e.
433 // (frameContext->xOffset, frameContext->yOffset). There is no guarantee
434 // that width == (size().width() - frameContext->xOffset), so
435 // we must ensure we don't run off the end of either the source data or the
436 // row's X-coordinates.
437 const size_t width = frameContext->width();
438 const int xBegin = frameContext->xOffset();
439 const int yBegin = frameContext->yOffset() + rowNumber;
440 const int xEnd = std::min(static_cast<int>(frameContext->xOffset() + width),
441 this->getInfo().width());
442 const int yEnd = std::min(static_cast<int>(frameContext->yOffset() + rowNumber + repeatCount),
443 this->getInfo().height());
444 // FIXME: No need to make the checks on width/xBegin/xEnd for every row. We could instead do
445 // this once in prepareToDecode.
446 if (!width || (xBegin < 0) || (yBegin < 0) || (xEnd <= xBegin) || (yEnd <= yBegin))
447 return true;
448
449 // yBegin is the first row in the non-sampled image. dstRow will be the row in the output,
450 // after potentially scaling it.
451 int dstRow = yBegin;
452
453 const int sampleY = fSwizzler->sampleY();
454 if (sampleY > 1) {
455 // Check to see whether this row or one that falls in the repeatCount is needed in the
456 // output.
457 bool foundNecessaryRow = false;
458 for (unsigned i = 0; i < repeatCount; i++) {
459 const int potentialRow = yBegin + i;
460 if (fSwizzler->rowNeeded(potentialRow)) {
461 dstRow = potentialRow / sampleY;
462 const int scaledHeight = get_scaled_dimension(this->dstInfo().height(), sampleY);
463 if (dstRow >= scaledHeight) {
464 return true;
465 }
466
467 foundNecessaryRow = true;
468 repeatCount -= i;
469
470 repeatCount = (repeatCount - 1) / sampleY + 1;
471
472 // Make sure the repeatCount does not take us beyond the end of the dst
473 if (dstRow + (int) repeatCount > scaledHeight) {
474 repeatCount = scaledHeight - dstRow;
475 SkASSERT(repeatCount >= 1);
476 }
477 break;
478 }
479 }
480
481 if (!foundNecessaryRow) {
482 return true;
483 }
Matt Sarett8a4e9c52016-10-25 14:24:50 -0400484 } else {
485 // Make sure the repeatCount does not take us beyond the end of the dst
486 SkASSERT(this->dstInfo().height() >= yBegin);
487 repeatCount = SkTMin(repeatCount, (unsigned) (this->dstInfo().height() - yBegin));
scroggo19b91532016-10-24 09:03:26 -0700488 }
489
490 if (!fFilledBackground) {
491 // At this point, we are definitely going to write the row, so count it towards the number
492 // of rows decoded.
493 // We do not consider the repeatCount, which only happens for interlaced, in which case we
494 // have already set fRowsDecoded to the proper value (reflecting that we have filled the
495 // background).
496 fRowsDecoded++;
497 }
498
499 if (!fCurrColorTableIsReal) {
500 // No color table, so nothing to draw this frame.
501 // FIXME: We can abort even earlier - no need to decode this frame.
502 return true;
503 }
504
505 // The swizzler takes care of offsetting into the dst width-wise.
506 void* dstLine = SkTAddOffset<void>(fDst, dstRow * fDstRowBytes);
507
508 // We may or may not need to write transparent pixels to the buffer.
scroggo1285f412016-10-26 13:48:03 -0700509 // If we're compositing against a previous image, it's wrong, but if
510 // we're decoding an interlaced gif and displaying it "Haeberli"-style,
511 // we must write these for passes beyond the first, or the initial passes
512 // will "show through" the later ones.
scroggo19b91532016-10-24 09:03:26 -0700513 const auto dstInfo = this->dstInfo();
scroggo53f63b62016-10-27 08:29:13 -0700514 if (writeTransparentPixels) {
scroggo19b91532016-10-24 09:03:26 -0700515 fSwizzler->swizzle(dstLine, rowBegin);
516 } else {
517 // We cannot swizzle directly into the dst, since that will write the transparent pixels.
518 // Instead, swizzle into a temporary buffer, and copy that into the dst.
519 {
520 void* const memsetDst = fTmpBuffer.get();
521 // Although onGetFillValue returns a uint64_t, we only use the low eight bits. The
522 // return value is either an 8 bit index (for index8) or SK_ColorTRANSPARENT, which is
523 // all zeroes.
524 const int fillValue = (uint8_t) this->onGetFillValue(dstInfo);
525 const size_t rb = dstInfo.minRowBytes();
526 if (fillValue == 0) {
527 // FIXME: This special case should be unnecessary, and in fact sk_bzero just calls
528 // memset. But without it, the compiler thinks this is trying to pass a zero length
529 // to memset, causing an error.
530 sk_bzero(memsetDst, rb);
531 } else {
532 memset(memsetDst, fillValue, rb);
533 }
534 }
535 fSwizzler->swizzle(fTmpBuffer.get(), rowBegin);
536
537 const size_t offsetBytes = fSwizzler->swizzleOffsetBytes();
538 switch (dstInfo.colorType()) {
539 case kBGRA_8888_SkColorType:
540 case kRGBA_8888_SkColorType: {
541 uint32_t* dstPixel = SkTAddOffset<uint32_t>(dstLine, offsetBytes);
542 uint32_t* srcPixel = SkTAddOffset<uint32_t>(fTmpBuffer.get(), offsetBytes);
543 for (int i = 0; i < fSwizzler->swizzleWidth(); i++) {
544 // Technically SK_ColorTRANSPARENT is an SkPMColor, and srcPixel would have
545 // the opposite swizzle for the non-native swizzle, but TRANSPARENT is all
546 // zeroes, which is the same either way.
547 if (*srcPixel != SK_ColorTRANSPARENT) {
548 *dstPixel = *srcPixel;
549 }
550 dstPixel++;
551 srcPixel++;
552 }
553 break;
554 }
555 case kIndex_8_SkColorType: {
556 uint8_t* dstPixel = SkTAddOffset<uint8_t>(dstLine, offsetBytes);
557 uint8_t* srcPixel = SkTAddOffset<uint8_t>(fTmpBuffer.get(), offsetBytes);
558 for (int i = 0; i < fSwizzler->swizzleWidth(); i++) {
559 if (*srcPixel != frameContext->transparentPixel()) {
560 *dstPixel = *srcPixel;
561 }
562 dstPixel++;
563 srcPixel++;
564 }
565 break;
566 }
567 default:
568 SkASSERT(false);
569 break;
570 }
571 }
572
573 // Tell the frame to copy the row data if need be.
574 if (repeatCount > 1) {
575 const size_t bytesPerPixel = SkColorTypeBytesPerPixel(this->dstInfo().colorType());
576 const size_t bytesToCopy = fSwizzler->swizzleWidth() * bytesPerPixel;
577 void* copiedLine = SkTAddOffset<void>(dstLine, fSwizzler->swizzleOffsetBytes());
578 void* dst = copiedLine;
579 for (unsigned i = 1; i < repeatCount; i++) {
580 dst = SkTAddOffset<void>(dst, fDstRowBytes);
581 memcpy(dst, copiedLine, bytesToCopy);
msarett72261c02015-11-19 15:29:26 -0800582 }
583 }
584
585 return true;
586}