blob: d0fb43a053479470dc5fc037caee0a4f70066ce7 [file] [log] [blame]
scroggof24f2242015-03-03 08:59:20 -08001/*
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
msarettb46e5e22015-07-30 11:36:40 -07008#include "SkBmpCodec.h"
scroggof24f2242015-03-03 08:59:20 -08009#include "SkCodec.h"
msarett8c8f22a2015-04-01 06:58:48 -070010#include "SkCodecPriv.h"
msarettad8bcfe2016-03-07 07:09:03 -080011#include "SkColorSpace.h"
Matt Sarettcf3f2342017-03-23 15:32:25 -040012#include "SkColorSpaceXform_Base.h"
msarett1a464672016-01-07 13:17:19 -080013#include "SkData.h"
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -040014#include "SkFrameHolder.h"
msarett1a464672016-01-07 13:17:19 -080015#include "SkGifCodec.h"
msarettf7eb6fc2016-09-13 09:04:11 -070016#include "SkHalf.h"
Leon Scroggins III04be2b52017-08-17 15:13:20 -040017#ifdef SK_HAS_HEIF_LIBRARY
18#include "SkHeifCodec.h"
19#endif
msarett1a464672016-01-07 13:17:19 -080020#include "SkIcoCodec.h"
msarette16b04a2015-04-15 07:32:19 -070021#include "SkJpegCodec.h"
msarettad3a5c62016-05-06 07:21:26 -070022#ifdef SK_HAS_PNG_LIBRARY
msarettbe1d5552016-01-21 09:05:23 -080023#include "SkPngCodec.h"
yujieqin916de9f2016-01-25 08:26:16 -080024#endif
msarett39b2d5a2016-02-17 08:26:31 -080025#include "SkRawCodec.h"
scroggof24f2242015-03-03 08:59:20 -080026#include "SkStream.h"
msarett1a464672016-01-07 13:17:19 -080027#include "SkWbmpCodec.h"
scroggo6f5e6192015-06-18 12:53:43 -070028#include "SkWebpCodec.h"
scroggof24f2242015-03-03 08:59:20 -080029
msarett74114382015-03-16 11:55:18 -070030struct DecoderProc {
scroggodb30be22015-12-08 18:54:13 -080031 bool (*IsFormat)(const void*, size_t);
Mike Reedede7bac2017-07-23 15:30:02 -040032 std::unique_ptr<SkCodec> (*MakeFromStream)(std::unique_ptr<SkStream>, SkCodec::Result*);
msarett74114382015-03-16 11:55:18 -070033};
34
Leon Scroggins III862c1962017-10-02 16:28:49 -040035static constexpr DecoderProc gDecoderProcs[] = {
msarettad3a5c62016-05-06 07:21:26 -070036#ifdef SK_HAS_JPEG_LIBRARY
Mike Reedede7bac2017-07-23 15:30:02 -040037 { SkJpegCodec::IsJpeg, SkJpegCodec::MakeFromStream },
msarett39b2d5a2016-02-17 08:26:31 -080038#endif
msarettad3a5c62016-05-06 07:21:26 -070039#ifdef SK_HAS_WEBP_LIBRARY
Mike Reedede7bac2017-07-23 15:30:02 -040040 { SkWebpCodec::IsWebp, SkWebpCodec::MakeFromStream },
msarett39b2d5a2016-02-17 08:26:31 -080041#endif
Mike Reedede7bac2017-07-23 15:30:02 -040042 { SkGifCodec::IsGif, SkGifCodec::MakeFromStream },
msarettad3a5c62016-05-06 07:21:26 -070043#ifdef SK_HAS_PNG_LIBRARY
Mike Reedede7bac2017-07-23 15:30:02 -040044 { SkIcoCodec::IsIco, SkIcoCodec::MakeFromStream },
msarett39b2d5a2016-02-17 08:26:31 -080045#endif
Mike Reedede7bac2017-07-23 15:30:02 -040046 { SkBmpCodec::IsBmp, SkBmpCodec::MakeFromStream },
Leon Scroggins III04be2b52017-08-17 15:13:20 -040047 { SkWbmpCodec::IsWbmp, SkWbmpCodec::MakeFromStream },
48#ifdef SK_HAS_HEIF_LIBRARY
49 { SkHeifCodec::IsHeif, SkHeifCodec::MakeFromStream },
50#endif
msarett74114382015-03-16 11:55:18 -070051};
52
Mike Reedede7bac2017-07-23 15:30:02 -040053std::unique_ptr<SkCodec> SkCodec::MakeFromStream(std::unique_ptr<SkStream> stream,
54 Result* outResult, SkPngChunkReader* chunkReader) {
Leon Scroggins III588fb042017-07-14 16:32:31 -040055 Result resultStorage;
56 if (!outResult) {
57 outResult = &resultStorage;
58 }
59
scroggof24f2242015-03-03 08:59:20 -080060 if (!stream) {
Leon Scroggins III588fb042017-07-14 16:32:31 -040061 *outResult = kInvalidInput;
halcanary96fcdcc2015-08-27 07:41:13 -070062 return nullptr;
scroggof24f2242015-03-03 08:59:20 -080063 }
scroggo0a7e69c2015-04-03 07:22:22 -070064
Leon Scroggins III04be2b52017-08-17 15:13:20 -040065 constexpr size_t bytesToRead = MinBufferedBytesNeeded();
scroggodb30be22015-12-08 18:54:13 -080066
67 char buffer[bytesToRead];
68 size_t bytesRead = stream->peek(buffer, bytesToRead);
69
70 // It is also possible to have a complete image less than bytesToRead bytes
71 // (e.g. a 1 x 1 wbmp), meaning peek() would return less than bytesToRead.
72 // Assume that if bytesRead < bytesToRead, but > 0, the stream is shorter
73 // than bytesToRead, so pass that directly to the decoder.
74 // It also is possible the stream uses too small a buffer for peeking, but
75 // we trust the caller to use a large enough buffer.
76
77 if (0 == bytesRead) {
scroggo3ab9f2e2016-01-06 09:53:34 -080078 // TODO: After implementing peek in CreateJavaOutputStreamAdaptor.cpp, this
79 // printf could be useful to notice failures.
80 // SkCodecPrintf("Encoded image data failed to peek!\n");
81
scroggodb30be22015-12-08 18:54:13 -080082 // It is possible the stream does not support peeking, but does support
83 // rewinding.
84 // Attempt to read() and pass the actual amount read to the decoder.
85 bytesRead = stream->read(buffer, bytesToRead);
86 if (!stream->rewind()) {
scroggo3ab9f2e2016-01-06 09:53:34 -080087 SkCodecPrintf("Encoded image data could not peek or rewind to determine format!\n");
Leon Scroggins III588fb042017-07-14 16:32:31 -040088 *outResult = kCouldNotRewind;
scroggodb30be22015-12-08 18:54:13 -080089 return nullptr;
90 }
91 }
92
scroggocf98fa92015-11-23 08:14:40 -080093 // PNG is special, since we want to be able to supply an SkPngChunkReader.
94 // But this code follows the same pattern as the loop.
msarettad3a5c62016-05-06 07:21:26 -070095#ifdef SK_HAS_PNG_LIBRARY
scroggodb30be22015-12-08 18:54:13 -080096 if (SkPngCodec::IsPng(buffer, bytesRead)) {
Mike Reedede7bac2017-07-23 15:30:02 -040097 return SkPngCodec::MakeFromStream(std::move(stream), outResult, chunkReader);
msarett39b2d5a2016-02-17 08:26:31 -080098 } else
99#endif
100 {
scroggocf98fa92015-11-23 08:14:40 -0800101 for (DecoderProc proc : gDecoderProcs) {
scroggodb30be22015-12-08 18:54:13 -0800102 if (proc.IsFormat(buffer, bytesRead)) {
Mike Reedede7bac2017-07-23 15:30:02 -0400103 return proc.MakeFromStream(std::move(stream), outResult);
scroggocf98fa92015-11-23 08:14:40 -0800104 }
msarett74114382015-03-16 11:55:18 -0700105 }
yujieqin916de9f2016-01-25 08:26:16 -0800106
107#ifdef SK_CODEC_DECODES_RAW
108 // Try to treat the input as RAW if all the other checks failed.
Mike Reedede7bac2017-07-23 15:30:02 -0400109 return SkRawCodec::MakeFromStream(std::move(stream), outResult);
yujieqin916de9f2016-01-25 08:26:16 -0800110#endif
scroggof24f2242015-03-03 08:59:20 -0800111 }
msarett8c8f22a2015-04-01 06:58:48 -0700112
Leon Scroggins III588fb042017-07-14 16:32:31 -0400113 if (bytesRead < bytesToRead) {
114 *outResult = kIncompleteInput;
115 } else {
116 *outResult = kUnimplemented;
117 }
118
msarettf44631b2016-01-13 10:54:20 -0800119 return nullptr;
scroggof24f2242015-03-03 08:59:20 -0800120}
121
Mike Reedede7bac2017-07-23 15:30:02 -0400122std::unique_ptr<SkCodec> SkCodec::MakeFromData(sk_sp<SkData> data, SkPngChunkReader* reader) {
scroggof24f2242015-03-03 08:59:20 -0800123 if (!data) {
halcanary96fcdcc2015-08-27 07:41:13 -0700124 return nullptr;
scroggof24f2242015-03-03 08:59:20 -0800125 }
Mike Reed847068c2017-07-26 11:35:53 -0400126 return MakeFromStream(SkMemoryStream::Make(std::move(data)), nullptr, reader);
scroggof24f2242015-03-03 08:59:20 -0800127}
128
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400129SkCodec::SkCodec(int width, int height, const SkEncodedInfo& info,
Mike Reedede7bac2017-07-23 15:30:02 -0400130 XformFormat srcFormat, std::unique_ptr<SkStream> stream,
Leon Scroggins IIIb6ab10f2017-10-18 14:42:43 -0400131 sk_sp<SkColorSpace> colorSpace, SkEncodedOrigin origin)
msarettc30c4182016-04-20 11:53:35 -0700132 : fEncodedInfo(info)
msarett530c8442016-07-21 11:57:49 -0700133 , fSrcInfo(info.makeImageInfo(width, height, std::move(colorSpace)))
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400134 , fSrcXformFormat(srcFormat)
Mike Reedede7bac2017-07-23 15:30:02 -0400135 , fStream(std::move(stream))
scroggof24f2242015-03-03 08:59:20 -0800136 , fNeedsRewind(false)
msarett0e6274f2016-03-21 08:04:40 -0700137 , fOrigin(origin)
scroggo46c57472015-09-30 08:57:13 -0700138 , fDstInfo()
139 , fOptions()
140 , fCurrScanline(-1)
Ivan Afanasyev26315582017-10-09 10:09:53 +0700141 , fStartedIncrementalDecode(false)
scroggof24f2242015-03-03 08:59:20 -0800142{}
143
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400144SkCodec::SkCodec(const SkEncodedInfo& info, const SkImageInfo& imageInfo,
Leon Scroggins IIIb6ab10f2017-10-18 14:42:43 -0400145 XformFormat srcFormat, std::unique_ptr<SkStream> stream,
146 SkEncodedOrigin origin)
msarett549ca322016-08-17 08:54:08 -0700147 : fEncodedInfo(info)
148 , fSrcInfo(imageInfo)
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400149 , fSrcXformFormat(srcFormat)
Mike Reedede7bac2017-07-23 15:30:02 -0400150 , fStream(std::move(stream))
msarett549ca322016-08-17 08:54:08 -0700151 , fNeedsRewind(false)
152 , fOrigin(origin)
153 , fDstInfo()
154 , fOptions()
155 , fCurrScanline(-1)
Ivan Afanasyev26315582017-10-09 10:09:53 +0700156 , fStartedIncrementalDecode(false)
msarett549ca322016-08-17 08:54:08 -0700157{}
158
scroggo9b2cdbf42015-07-10 12:07:02 -0700159SkCodec::~SkCodec() {}
scroggoeb602a52015-07-09 08:16:03 -0700160
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500161bool SkCodec::conversionSupported(const SkImageInfo& dst, SkColorType srcColor,
Leon Scroggins III07418182017-08-15 12:24:02 -0400162 bool srcIsOpaque, const SkColorSpace* srcCS) const {
163 if (!valid_alpha(dst.alphaType(), srcIsOpaque)) {
164 return false;
165 }
166
167 switch (dst.colorType()) {
168 case kRGBA_8888_SkColorType:
169 case kBGRA_8888_SkColorType:
170 return true;
171 case kRGBA_F16_SkColorType:
172 return dst.colorSpace() && dst.colorSpace()->gammaIsLinear();
173 case kRGB_565_SkColorType:
174 return srcIsOpaque;
175 case kGray_8_SkColorType:
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500176 return kGray_8_SkColorType == srcColor && srcIsOpaque &&
Leon Scroggins III07418182017-08-15 12:24:02 -0400177 !needs_color_xform(dst, srcCS, false);
Mike Reedd6cb11e2017-11-30 15:33:04 -0500178 case kAlpha_8_SkColorType:
179 // conceptually we can convert anything into alpha_8, but we haven't actually coded
180 // all of those other conversions yet, so only return true for the case we have codec.
181 return fSrcInfo.colorType() == kAlpha_8_SkColorType;;
Leon Scroggins III07418182017-08-15 12:24:02 -0400182 default:
183 return false;
184 }
185
186}
187
scroggob427db12015-08-12 07:24:13 -0700188bool SkCodec::rewindIfNeeded() {
scroggof24f2242015-03-03 08:59:20 -0800189 // Store the value of fNeedsRewind so we can update it. Next read will
190 // require a rewind.
halcanarya096d7a2015-03-27 12:16:53 -0700191 const bool needsRewind = fNeedsRewind;
scroggof24f2242015-03-03 08:59:20 -0800192 fNeedsRewind = true;
halcanarya096d7a2015-03-27 12:16:53 -0700193 if (!needsRewind) {
scroggob427db12015-08-12 07:24:13 -0700194 return true;
halcanarya096d7a2015-03-27 12:16:53 -0700195 }
scroggob427db12015-08-12 07:24:13 -0700196
scroggo46c57472015-09-30 08:57:13 -0700197 // startScanlineDecode will need to be called before decoding scanlines.
198 fCurrScanline = -1;
scroggo8e6c7ad2016-09-16 08:20:38 -0700199 // startIncrementalDecode will need to be called before incrementalDecode.
200 fStartedIncrementalDecode = false;
scroggo46c57472015-09-30 08:57:13 -0700201
scroggo19b91532016-10-24 09:03:26 -0700202 // Some codecs do not have a stream. They may hold onto their own data or another codec.
203 // They must handle rewinding themselves.
204 if (fStream && !fStream->rewind()) {
scroggob427db12015-08-12 07:24:13 -0700205 return false;
206 }
207
208 return this->onRewind();
scroggof24f2242015-03-03 08:59:20 -0800209}
scroggo05245902015-03-25 11:11:52 -0700210
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400211static void zero_rect(const SkImageInfo& dstInfo, void* pixels, size_t rowBytes,
212 SkIRect frameRect) {
213 if (!frameRect.intersect(dstInfo.bounds())) {
214 return;
215 }
216 const auto info = dstInfo.makeWH(frameRect.width(), frameRect.height());
217 const size_t bpp = SkColorTypeBytesPerPixel(dstInfo.colorType());
218 const size_t offset = frameRect.x() * bpp + frameRect.y() * rowBytes;
219 auto* eraseDst = SkTAddOffset<void>(pixels, offset);
220 SkSampler::Fill(info, eraseDst, rowBytes, 0, SkCodec::kNo_ZeroInitialized);
221}
222
223SkCodec::Result SkCodec::handleFrameIndex(const SkImageInfo& info, void* pixels, size_t rowBytes,
224 const Options& options) {
225 const int index = options.fFrameIndex;
226 if (0 == index) {
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500227 if (!this->conversionSupported(info, fSrcInfo.colorType(), fEncodedInfo.opaque(),
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400228 fSrcInfo.colorSpace())
229 || !this->initializeColorXform(info, fEncodedInfo.alpha(), options.fPremulBehavior))
230 {
Leon Scroggins III07418182017-08-15 12:24:02 -0400231 return kInvalidConversion;
232 }
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400233 return kSuccess;
234 }
235
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400236 if (index < 0) {
237 return kInvalidParameters;
238 }
239
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400240 if (options.fSubset || info.dimensions() != fSrcInfo.dimensions()) {
241 // If we add support for these, we need to update the code that zeroes
242 // a kRestoreBGColor frame.
243 return kInvalidParameters;
244 }
245
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400246 if (index >= this->onGetFrameCount()) {
247 return kIncompleteInput;
248 }
249
250 const auto* frameHolder = this->getFrameHolder();
251 SkASSERT(frameHolder);
252
253 const auto* frame = frameHolder->getFrame(index);
254 SkASSERT(frame);
255
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500256 if (!this->conversionSupported(info, fSrcInfo.colorType(), !frame->hasAlpha(),
Leon Scroggins III07418182017-08-15 12:24:02 -0400257 fSrcInfo.colorSpace())) {
258 return kInvalidConversion;
259 }
260
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400261 const int requiredFrame = frame->getRequiredFrame();
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400262 if (requiredFrame != kNone) {
263 if (options.fPriorFrame != kNone) {
264 // Check for a valid frame as a starting point. Alternatively, we could
265 // treat an invalid frame as not providing one, but rejecting it will
266 // make it easier to catch the mistake.
267 if (options.fPriorFrame < requiredFrame || options.fPriorFrame >= index) {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400268 return kInvalidParameters;
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400269 }
270 const auto* prevFrame = frameHolder->getFrame(options.fPriorFrame);
271 switch (prevFrame->getDisposalMethod()) {
272 case SkCodecAnimation::DisposalMethod::kRestorePrevious:
273 return kInvalidParameters;
274 case SkCodecAnimation::DisposalMethod::kRestoreBGColor:
275 // If a frame after the required frame is provided, there is no
276 // need to clear, since it must be covered by the desired frame.
277 if (options.fPriorFrame == requiredFrame) {
278 zero_rect(info, pixels, rowBytes, prevFrame->frameRect());
279 }
280 break;
281 default:
282 break;
283 }
284 } else {
285 Options prevFrameOptions(options);
286 prevFrameOptions.fFrameIndex = requiredFrame;
287 prevFrameOptions.fZeroInitialized = kNo_ZeroInitialized;
288 const Result result = this->getPixels(info, pixels, rowBytes, &prevFrameOptions);
289 if (result != kSuccess) {
290 return result;
291 }
292 const auto* prevFrame = frameHolder->getFrame(requiredFrame);
293 const auto disposalMethod = prevFrame->getDisposalMethod();
294 if (disposalMethod == SkCodecAnimation::DisposalMethod::kRestoreBGColor) {
295 zero_rect(info, pixels, rowBytes, prevFrame->frameRect());
296 }
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400297 }
298 }
299
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500300 return this->initializeColorXform(info, frame->reportedAlpha(), options.fPremulBehavior)
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400301 ? kSuccess : kInvalidConversion;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400302}
scroggo8e6c7ad2016-09-16 08:20:38 -0700303
scroggoeb602a52015-07-09 08:16:03 -0700304SkCodec::Result SkCodec::getPixels(const SkImageInfo& info, void* pixels, size_t rowBytes,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000305 const Options* options) {
scroggoeb602a52015-07-09 08:16:03 -0700306 if (kUnknown_SkColorType == info.colorType()) {
307 return kInvalidConversion;
308 }
halcanary96fcdcc2015-08-27 07:41:13 -0700309 if (nullptr == pixels) {
scroggoeb602a52015-07-09 08:16:03 -0700310 return kInvalidParameters;
311 }
312 if (rowBytes < info.minRowBytes()) {
313 return kInvalidParameters;
314 }
315
scroggo3a7701c2015-09-30 09:15:14 -0700316 if (!this->rewindIfNeeded()) {
317 return kCouldNotRewind;
318 }
319
scroggoeb602a52015-07-09 08:16:03 -0700320 // Default options.
321 Options optsStorage;
halcanary96fcdcc2015-08-27 07:41:13 -0700322 if (nullptr == options) {
scroggoeb602a52015-07-09 08:16:03 -0700323 options = &optsStorage;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400324 } else {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400325 if (options->fSubset) {
326 SkIRect subset(*options->fSubset);
327 if (!this->onGetValidSubset(&subset) || subset != *options->fSubset) {
328 // FIXME: How to differentiate between not supporting subset at all
329 // and not supporting this particular subset?
330 return kUnimplemented;
331 }
scroggoe7fc14b2015-10-02 13:14:46 -0700332 }
scroggoeb602a52015-07-09 08:16:03 -0700333 }
scroggoe7fc14b2015-10-02 13:14:46 -0700334
Leon Scroggins III07418182017-08-15 12:24:02 -0400335 const Result frameIndexResult = this->handleFrameIndex(info, pixels, rowBytes,
336 *options);
337 if (frameIndexResult != kSuccess) {
338 return frameIndexResult;
339 }
340
scroggoe7fc14b2015-10-02 13:14:46 -0700341 // FIXME: Support subsets somehow? Note that this works for SkWebpCodec
342 // because it supports arbitrary scaling/subset combinations.
343 if (!this->dimensionsSupported(info.dimensions())) {
344 return kInvalidScale;
345 }
346
scroggo8e6c7ad2016-09-16 08:20:38 -0700347 fDstInfo = info;
Leon Scroggins III42886572017-01-27 13:16:28 -0500348 fOptions = *options;
scroggo8e6c7ad2016-09-16 08:20:38 -0700349
msarette6dd0042015-10-09 11:07:34 -0700350 // On an incomplete decode, the subclass will specify the number of scanlines that it decoded
351 // successfully.
352 int rowsDecoded = 0;
Leon Scroggins571b30f2017-07-11 17:35:31 +0000353 const Result result = this->onGetPixels(info, pixels, rowBytes, *options, &rowsDecoded);
msarette6dd0042015-10-09 11:07:34 -0700354
355 // A return value of kIncompleteInput indicates a truncated image stream.
356 // In this case, we will fill any uninitialized memory with a default value.
357 // Some subclasses will take care of filling any uninitialized memory on
358 // their own. They indicate that all of the memory has been filled by
359 // setting rowsDecoded equal to the height.
Leon Scroggins III674a1842017-07-06 12:26:09 -0400360 if ((kIncompleteInput == result || kErrorInInput == result) && rowsDecoded != info.height()) {
Leon Scroggins III42886572017-01-27 13:16:28 -0500361 // FIXME: (skbug.com/5772) fillIncompleteImage will fill using the swizzler's width, unless
362 // there is a subset. In that case, it will use the width of the subset. From here, the
363 // subset will only be non-null in the case of SkWebpCodec, but it treats the subset
364 // differenty from the other codecs, and it needs to use the width specified by the info.
365 // Set the subset to null so SkWebpCodec uses the correct width.
366 fOptions.fSubset = nullptr;
msarette6dd0042015-10-09 11:07:34 -0700367 this->fillIncompleteImage(info, pixels, rowBytes, options->fZeroInitialized, info.height(),
368 rowsDecoded);
369 }
370
scroggoeb602a52015-07-09 08:16:03 -0700371 return result;
372}
373
scroggo8e6c7ad2016-09-16 08:20:38 -0700374SkCodec::Result SkCodec::startIncrementalDecode(const SkImageInfo& info, void* pixels,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000375 size_t rowBytes, const SkCodec::Options* options) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700376 fStartedIncrementalDecode = false;
377
378 if (kUnknown_SkColorType == info.colorType()) {
379 return kInvalidConversion;
380 }
381 if (nullptr == pixels) {
382 return kInvalidParameters;
383 }
384
scroggo8e6c7ad2016-09-16 08:20:38 -0700385 // FIXME: If the rows come after the rows of a previous incremental decode,
386 // we might be able to skip the rewind, but only the implementation knows
387 // that. (e.g. PNG will always need to rewind, since we called longjmp, but
388 // a bottom-up BMP could skip rewinding if the new rows are above the old
389 // rows.)
390 if (!this->rewindIfNeeded()) {
391 return kCouldNotRewind;
392 }
393
394 // Set options.
395 Options optsStorage;
396 if (nullptr == options) {
397 options = &optsStorage;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400398 } else {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400399 if (options->fSubset) {
400 SkIRect size = SkIRect::MakeSize(info.dimensions());
401 if (!size.contains(*options->fSubset)) {
402 return kInvalidParameters;
403 }
scroggo8e6c7ad2016-09-16 08:20:38 -0700404
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400405 const int top = options->fSubset->top();
406 const int bottom = options->fSubset->bottom();
407 if (top < 0 || top >= info.height() || top >= bottom || bottom > info.height()) {
408 return kInvalidParameters;
409 }
scroggo8e6c7ad2016-09-16 08:20:38 -0700410 }
411 }
412
Leon Scroggins III07418182017-08-15 12:24:02 -0400413 const Result frameIndexResult = this->handleFrameIndex(info, pixels, rowBytes,
414 *options);
415 if (frameIndexResult != kSuccess) {
416 return frameIndexResult;
417 }
418
scroggo8e6c7ad2016-09-16 08:20:38 -0700419 if (!this->dimensionsSupported(info.dimensions())) {
420 return kInvalidScale;
421 }
422
423 fDstInfo = info;
424 fOptions = *options;
425
Leon Scroggins571b30f2017-07-11 17:35:31 +0000426 const Result result = this->onStartIncrementalDecode(info, pixels, rowBytes, fOptions);
scroggo8e6c7ad2016-09-16 08:20:38 -0700427 if (kSuccess == result) {
428 fStartedIncrementalDecode = true;
429 } else if (kUnimplemented == result) {
430 // FIXME: This is temporarily necessary, until we transition SkCodec
431 // implementations from scanline decoding to incremental decoding.
432 // SkAndroidCodec will first attempt to use incremental decoding, but
433 // will fall back to scanline decoding if incremental returns
434 // kUnimplemented. rewindIfNeeded(), above, set fNeedsRewind to true
435 // (after potentially rewinding), but we do not want the next call to
436 // startScanlineDecode() to do a rewind.
437 fNeedsRewind = false;
438 }
439 return result;
440}
441
442
443SkCodec::Result SkCodec::startScanlineDecode(const SkImageInfo& info,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000444 const SkCodec::Options* options) {
scroggo46c57472015-09-30 08:57:13 -0700445 // Reset fCurrScanline in case of failure.
446 fCurrScanline = -1;
scroggo46c57472015-09-30 08:57:13 -0700447
scroggo3a7701c2015-09-30 09:15:14 -0700448 if (!this->rewindIfNeeded()) {
449 return kCouldNotRewind;
450 }
451
scroggo46c57472015-09-30 08:57:13 -0700452 // Set options.
453 Options optsStorage;
454 if (nullptr == options) {
455 options = &optsStorage;
scroggoe7fc14b2015-10-02 13:14:46 -0700456 } else if (options->fSubset) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700457 SkIRect size = SkIRect::MakeSize(info.dimensions());
msarettfdb47572015-10-13 12:50:14 -0700458 if (!size.contains(*options->fSubset)) {
459 return kInvalidInput;
460 }
461
462 // We only support subsetting in the x-dimension for scanline decoder.
463 // Subsetting in the y-dimension can be accomplished using skipScanlines().
scroggo8e6c7ad2016-09-16 08:20:38 -0700464 if (options->fSubset->top() != 0 || options->fSubset->height() != info.height()) {
msarettfdb47572015-10-13 12:50:14 -0700465 return kInvalidInput;
scroggoe7fc14b2015-10-02 13:14:46 -0700466 }
467 }
468
Leon Scroggins III07418182017-08-15 12:24:02 -0400469 // Scanline decoding only supports decoding the first frame.
470 if (options->fFrameIndex != 0) {
471 return kUnimplemented;
472 }
473
474 // The void* dst and rowbytes in handleFrameIndex or only used for decoding prior
475 // frames, which is not supported here anyway, so it is safe to pass nullptr/0.
476 const Result frameIndexResult = this->handleFrameIndex(info, nullptr, 0, *options);
477 if (frameIndexResult != kSuccess) {
478 return frameIndexResult;
479 }
480
scroggoe7fc14b2015-10-02 13:14:46 -0700481 // FIXME: Support subsets somehow?
scroggo8e6c7ad2016-09-16 08:20:38 -0700482 if (!this->dimensionsSupported(info.dimensions())) {
scroggoe7fc14b2015-10-02 13:14:46 -0700483 return kInvalidScale;
scroggo46c57472015-09-30 08:57:13 -0700484 }
485
Leon Scroggins571b30f2017-07-11 17:35:31 +0000486 const Result result = this->onStartScanlineDecode(info, *options);
scroggo46c57472015-09-30 08:57:13 -0700487 if (result != SkCodec::kSuccess) {
488 return result;
489 }
490
491 fCurrScanline = 0;
scroggo8e6c7ad2016-09-16 08:20:38 -0700492 fDstInfo = info;
scroggo46c57472015-09-30 08:57:13 -0700493 fOptions = *options;
494 return kSuccess;
495}
496
msarette6dd0042015-10-09 11:07:34 -0700497int SkCodec::getScanlines(void* dst, int countLines, size_t rowBytes) {
scroggo46c57472015-09-30 08:57:13 -0700498 if (fCurrScanline < 0) {
msarette6dd0042015-10-09 11:07:34 -0700499 return 0;
scroggo46c57472015-09-30 08:57:13 -0700500 }
501
502 SkASSERT(!fDstInfo.isEmpty());
scroggoe7fc14b2015-10-02 13:14:46 -0700503 if (countLines <= 0 || fCurrScanline + countLines > fDstInfo.height()) {
msarette6dd0042015-10-09 11:07:34 -0700504 return 0;
scroggo46c57472015-09-30 08:57:13 -0700505 }
506
msarette6dd0042015-10-09 11:07:34 -0700507 const int linesDecoded = this->onGetScanlines(dst, countLines, rowBytes);
508 if (linesDecoded < countLines) {
509 this->fillIncompleteImage(this->dstInfo(), dst, rowBytes, this->options().fZeroInitialized,
510 countLines, linesDecoded);
511 }
512 fCurrScanline += countLines;
513 return linesDecoded;
514}
515
516bool SkCodec::skipScanlines(int countLines) {
517 if (fCurrScanline < 0) {
518 return false;
519 }
520
521 SkASSERT(!fDstInfo.isEmpty());
522 if (countLines < 0 || fCurrScanline + countLines > fDstInfo.height()) {
523 // Arguably, we could just skip the scanlines which are remaining,
524 // and return true. We choose to return false so the client
525 // can catch their bug.
526 return false;
527 }
528
529 bool result = this->onSkipScanlines(countLines);
scroggo46c57472015-09-30 08:57:13 -0700530 fCurrScanline += countLines;
531 return result;
532}
533
msarette6dd0042015-10-09 11:07:34 -0700534int SkCodec::outputScanline(int inputScanline) const {
535 SkASSERT(0 <= inputScanline && inputScanline < this->getInfo().height());
536 return this->onOutputScanline(inputScanline);
537}
scroggo46c57472015-09-30 08:57:13 -0700538
msarette6dd0042015-10-09 11:07:34 -0700539int SkCodec::onOutputScanline(int inputScanline) const {
540 switch (this->getScanlineOrder()) {
541 case kTopDown_SkScanlineOrder:
msarette6dd0042015-10-09 11:07:34 -0700542 return inputScanline;
543 case kBottomUp_SkScanlineOrder:
544 return this->getInfo().height() - inputScanline - 1;
545 default:
546 // This case indicates an interlaced gif and is implemented by SkGifCodec.
547 SkASSERT(false);
548 return 0;
scroggo46c57472015-09-30 08:57:13 -0700549 }
msarette6dd0042015-10-09 11:07:34 -0700550}
scroggo46c57472015-09-30 08:57:13 -0700551
msarettf7eb6fc2016-09-13 09:04:11 -0700552uint64_t SkCodec::onGetFillValue(const SkImageInfo& dstInfo) const {
553 switch (dstInfo.colorType()) {
554 case kRGBA_F16_SkColorType: {
555 static constexpr uint64_t transparentColor = 0;
556 static constexpr uint64_t opaqueColor = ((uint64_t) SK_Half1) << 48;
557 return (kOpaque_SkAlphaType == fSrcInfo.alphaType()) ? opaqueColor : transparentColor;
558 }
559 default: {
Leon Scroggins571b30f2017-07-11 17:35:31 +0000560 // This not only handles the kN32 case, but also k565, kGray8, since
msarettf7eb6fc2016-09-13 09:04:11 -0700561 // the low bits are zeros.
562 return (kOpaque_SkAlphaType == fSrcInfo.alphaType()) ?
563 SK_ColorBLACK : SK_ColorTRANSPARENT;
564 }
565 }
566}
567
msarette6dd0042015-10-09 11:07:34 -0700568static void fill_proc(const SkImageInfo& info, void* dst, size_t rowBytes,
msarettf7eb6fc2016-09-13 09:04:11 -0700569 uint64_t colorOrIndex, SkCodec::ZeroInitialized zeroInit, SkSampler* sampler) {
msarette6dd0042015-10-09 11:07:34 -0700570 if (sampler) {
571 sampler->fill(info, dst, rowBytes, colorOrIndex, zeroInit);
572 } else {
573 SkSampler::Fill(info, dst, rowBytes, colorOrIndex, zeroInit);
574 }
575}
576
577void SkCodec::fillIncompleteImage(const SkImageInfo& info, void* dst, size_t rowBytes,
578 ZeroInitialized zeroInit, int linesRequested, int linesDecoded) {
579
580 void* fillDst;
msarettf7eb6fc2016-09-13 09:04:11 -0700581 const uint64_t fillValue = this->getFillValue(info);
msarette6dd0042015-10-09 11:07:34 -0700582 const int linesRemaining = linesRequested - linesDecoded;
583 SkSampler* sampler = this->getSampler(false);
584
msarett91c22b22016-02-22 12:27:46 -0800585 int fillWidth = info.width();
586 if (fOptions.fSubset) {
587 fillWidth = fOptions.fSubset->width();
588 }
589
msarette6dd0042015-10-09 11:07:34 -0700590 switch (this->getScanlineOrder()) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700591 case kTopDown_SkScanlineOrder: {
msarett91c22b22016-02-22 12:27:46 -0800592 const SkImageInfo fillInfo = info.makeWH(fillWidth, linesRemaining);
msarette6dd0042015-10-09 11:07:34 -0700593 fillDst = SkTAddOffset<void>(dst, linesDecoded * rowBytes);
594 fill_proc(fillInfo, fillDst, rowBytes, fillValue, zeroInit, sampler);
595 break;
596 }
597 case kBottomUp_SkScanlineOrder: {
598 fillDst = dst;
msarett91c22b22016-02-22 12:27:46 -0800599 const SkImageInfo fillInfo = info.makeWH(fillWidth, linesRemaining);
msarette6dd0042015-10-09 11:07:34 -0700600 fill_proc(fillInfo, fillDst, rowBytes, fillValue, zeroInit, sampler);
601 break;
602 }
msarette6dd0042015-10-09 11:07:34 -0700603 }
scroggo46c57472015-09-30 08:57:13 -0700604}
Matt Sarett313c4632016-10-20 12:35:23 -0400605
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400606static inline SkColorSpaceXform::ColorFormat select_xform_format_ct(SkColorType colorType) {
607 switch (colorType) {
608 case kRGBA_8888_SkColorType:
609 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
610 case kBGRA_8888_SkColorType:
611 return SkColorSpaceXform::kBGRA_8888_ColorFormat;
612 case kRGB_565_SkColorType:
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400613#ifdef SK_PMCOLOR_IS_RGBA
614 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
615#else
616 return SkColorSpaceXform::kBGRA_8888_ColorFormat;
617#endif
618 default:
619 SkASSERT(false);
620 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
621 }
622}
623
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400624bool SkCodec::initializeColorXform(const SkImageInfo& dstInfo, SkEncodedInfo::Alpha encodedAlpha,
Matt Sarettcf3f2342017-03-23 15:32:25 -0400625 SkTransferFunctionBehavior premulBehavior) {
Matt Sarett313c4632016-10-20 12:35:23 -0400626 fColorXform = nullptr;
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400627 fXformOnDecode = false;
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400628 if (!this->usesColorXform()) {
629 return true;
630 }
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500631 // FIXME: In SkWebpCodec, if a frame is blending with a prior frame, we don't need
632 // a colorXform to do a color correct premul, since the blend step will handle
633 // premultiplication. But there is no way to know whether we need to blend from
634 // inside this call.
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400635 bool needsColorCorrectPremul = needs_premul(dstInfo.alphaType(), encodedAlpha) &&
Matt Sarettcf3f2342017-03-23 15:32:25 -0400636 SkTransferFunctionBehavior::kRespect == premulBehavior;
Leon Scroggins III07418182017-08-15 12:24:02 -0400637 if (needs_color_xform(dstInfo, fSrcInfo.colorSpace(), needsColorCorrectPremul)) {
Matt Sarettcf3f2342017-03-23 15:32:25 -0400638 fColorXform = SkColorSpaceXform_Base::New(fSrcInfo.colorSpace(), dstInfo.colorSpace(),
639 premulBehavior);
Matt Sarett313c4632016-10-20 12:35:23 -0400640 if (!fColorXform) {
641 return false;
642 }
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400643
644 // We will apply the color xform when reading the color table unless F16 is requested.
645 fXformOnDecode = SkEncodedInfo::kPalette_Color != fEncodedInfo.color()
646 || kRGBA_F16_SkColorType == dstInfo.colorType();
647 if (fXformOnDecode) {
648 fDstXformFormat = select_xform_format(dstInfo.colorType());
649 } else {
650 fDstXformFormat = select_xform_format_ct(dstInfo.colorType());
651 }
Matt Sarett313c4632016-10-20 12:35:23 -0400652 }
653
654 return true;
655}
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400656
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400657void SkCodec::applyColorXform(void* dst, const void* src, int count, SkAlphaType at) const {
658 SkASSERT(fColorXform);
659 SkAssertResult(fColorXform->apply(fDstXformFormat, dst,
660 fSrcXformFormat, src,
661 count, at));
662}
663
664void SkCodec::applyColorXform(void* dst, const void* src, int count) const {
665 auto alphaType = select_xform_alpha(fDstInfo.alphaType(), fSrcInfo.alphaType());
666 this->applyColorXform(dst, src, count, alphaType);
667}
668
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400669std::vector<SkCodec::FrameInfo> SkCodec::getFrameInfo() {
Leon Scroggins III249b8e32017-04-17 12:46:33 -0400670 const int frameCount = this->getFrameCount();
671 SkASSERT(frameCount >= 0);
672 if (frameCount <= 0) {
673 return std::vector<FrameInfo>{};
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400674 }
Leon Scroggins III249b8e32017-04-17 12:46:33 -0400675
676 if (frameCount == 1 && !this->onGetFrameInfo(0, nullptr)) {
677 // Not animated.
678 return std::vector<FrameInfo>{};
679 }
680
681 std::vector<FrameInfo> result(frameCount);
682 for (int i = 0; i < frameCount; ++i) {
683 SkAssertResult(this->onGetFrameInfo(i, &result[i]));
684 }
685 return result;
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400686}
Leon Scroggins IIIfe3da022018-01-16 11:56:54 -0500687
688const char* SkCodec::ResultToString(Result result) {
689 switch (result) {
690 case kSuccess:
691 return "success";
692 case kIncompleteInput:
693 return "incomplete input";
694 case kErrorInInput:
695 return "error in input";
696 case kInvalidConversion:
697 return "invalid conversion";
698 case kInvalidScale:
699 return "invalid scale";
700 case kInvalidParameters:
701 return "invalid parameters";
702 case kInvalidInput:
703 return "invalid input";
704 case kCouldNotRewind:
705 return "could not rewind";
706 case kInternalError:
707 return "internal error";
708 case kUnimplemented:
709 return "unimplemented";
710 default:
711 SkASSERT(false);
712 return "bogus result value";
713 }
714}