blob: f67e6c06d3d78a1b604ab7dece1d0fe8fb680a8f [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"
Mike Kleine60ae822018-05-23 00:06:33 +000012#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:
Mike Kleince4cf722018-05-10 11:29:15 -0400172 return dst.colorSpace();
Leon Scroggins III07418182017-08-15 12:24:02 -0400173 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());
Mike Reed7fcfb622018-02-09 13:26:46 -0500217 const size_t bpp = dstInfo.bytesPerPixel();
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400218 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 III42ee2842018-01-14 14:46:51 -0500240 if (options.fSubset) {
241 // If we add support for this, we need to update the code that zeroes
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400242 // 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) {
Leon Scroggins III42ee2842018-01-14 14:46:51 -0500278 SkIRect prevRect = prevFrame->frameRect();
279 if (info.dimensions() != fSrcInfo.dimensions()) {
280 auto src = SkRect::Make(fSrcInfo.dimensions());
281 auto dst = SkRect::Make(info.dimensions());
282 SkMatrix map = SkMatrix::MakeRectToRect(src, dst,
283 SkMatrix::kCenter_ScaleToFit);
284 SkRect asRect = SkRect::Make(prevRect);
285 if (!map.mapRect(&asRect)) {
286 return kInternalError;
287 }
288 asRect.roundIn(&prevRect);
289 if (prevRect.isEmpty()) {
290 // Down-scaling shrank the empty portion to nothing,
291 // so nothing to zero.
292 break;
293 }
294 if (!prevRect.intersect(SkIRect::MakeSize(info.dimensions()))) {
295 SkCodecPrintf("rectangles do not intersect!");
296 SkASSERT(false);
297 break;
298 }
299 }
300 zero_rect(info, pixels, rowBytes, prevRect);
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400301 }
302 break;
303 default:
304 break;
305 }
306 } else {
307 Options prevFrameOptions(options);
308 prevFrameOptions.fFrameIndex = requiredFrame;
309 prevFrameOptions.fZeroInitialized = kNo_ZeroInitialized;
310 const Result result = this->getPixels(info, pixels, rowBytes, &prevFrameOptions);
311 if (result != kSuccess) {
312 return result;
313 }
314 const auto* prevFrame = frameHolder->getFrame(requiredFrame);
315 const auto disposalMethod = prevFrame->getDisposalMethod();
316 if (disposalMethod == SkCodecAnimation::DisposalMethod::kRestoreBGColor) {
317 zero_rect(info, pixels, rowBytes, prevFrame->frameRect());
318 }
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400319 }
320 }
321
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500322 return this->initializeColorXform(info, frame->reportedAlpha(), options.fPremulBehavior)
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400323 ? kSuccess : kInvalidConversion;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400324}
scroggo8e6c7ad2016-09-16 08:20:38 -0700325
scroggoeb602a52015-07-09 08:16:03 -0700326SkCodec::Result SkCodec::getPixels(const SkImageInfo& info, void* pixels, size_t rowBytes,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000327 const Options* options) {
scroggoeb602a52015-07-09 08:16:03 -0700328 if (kUnknown_SkColorType == info.colorType()) {
329 return kInvalidConversion;
330 }
halcanary96fcdcc2015-08-27 07:41:13 -0700331 if (nullptr == pixels) {
scroggoeb602a52015-07-09 08:16:03 -0700332 return kInvalidParameters;
333 }
334 if (rowBytes < info.minRowBytes()) {
335 return kInvalidParameters;
336 }
337
scroggo3a7701c2015-09-30 09:15:14 -0700338 if (!this->rewindIfNeeded()) {
339 return kCouldNotRewind;
340 }
341
scroggoeb602a52015-07-09 08:16:03 -0700342 // Default options.
343 Options optsStorage;
halcanary96fcdcc2015-08-27 07:41:13 -0700344 if (nullptr == options) {
scroggoeb602a52015-07-09 08:16:03 -0700345 options = &optsStorage;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400346 } else {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400347 if (options->fSubset) {
348 SkIRect subset(*options->fSubset);
349 if (!this->onGetValidSubset(&subset) || subset != *options->fSubset) {
350 // FIXME: How to differentiate between not supporting subset at all
351 // and not supporting this particular subset?
352 return kUnimplemented;
353 }
scroggoe7fc14b2015-10-02 13:14:46 -0700354 }
scroggoeb602a52015-07-09 08:16:03 -0700355 }
scroggoe7fc14b2015-10-02 13:14:46 -0700356
Leon Scroggins III07418182017-08-15 12:24:02 -0400357 const Result frameIndexResult = this->handleFrameIndex(info, pixels, rowBytes,
358 *options);
359 if (frameIndexResult != kSuccess) {
360 return frameIndexResult;
361 }
362
scroggoe7fc14b2015-10-02 13:14:46 -0700363 // FIXME: Support subsets somehow? Note that this works for SkWebpCodec
364 // because it supports arbitrary scaling/subset combinations.
365 if (!this->dimensionsSupported(info.dimensions())) {
366 return kInvalidScale;
367 }
368
scroggo8e6c7ad2016-09-16 08:20:38 -0700369 fDstInfo = info;
Leon Scroggins III42886572017-01-27 13:16:28 -0500370 fOptions = *options;
scroggo8e6c7ad2016-09-16 08:20:38 -0700371
msarette6dd0042015-10-09 11:07:34 -0700372 // On an incomplete decode, the subclass will specify the number of scanlines that it decoded
373 // successfully.
374 int rowsDecoded = 0;
Leon Scroggins571b30f2017-07-11 17:35:31 +0000375 const Result result = this->onGetPixels(info, pixels, rowBytes, *options, &rowsDecoded);
msarette6dd0042015-10-09 11:07:34 -0700376
377 // A return value of kIncompleteInput indicates a truncated image stream.
378 // In this case, we will fill any uninitialized memory with a default value.
379 // Some subclasses will take care of filling any uninitialized memory on
380 // their own. They indicate that all of the memory has been filled by
381 // setting rowsDecoded equal to the height.
Leon Scroggins III674a1842017-07-06 12:26:09 -0400382 if ((kIncompleteInput == result || kErrorInInput == result) && rowsDecoded != info.height()) {
Leon Scroggins III42886572017-01-27 13:16:28 -0500383 // FIXME: (skbug.com/5772) fillIncompleteImage will fill using the swizzler's width, unless
384 // there is a subset. In that case, it will use the width of the subset. From here, the
385 // subset will only be non-null in the case of SkWebpCodec, but it treats the subset
386 // differenty from the other codecs, and it needs to use the width specified by the info.
387 // Set the subset to null so SkWebpCodec uses the correct width.
388 fOptions.fSubset = nullptr;
msarette6dd0042015-10-09 11:07:34 -0700389 this->fillIncompleteImage(info, pixels, rowBytes, options->fZeroInitialized, info.height(),
390 rowsDecoded);
391 }
392
scroggoeb602a52015-07-09 08:16:03 -0700393 return result;
394}
395
scroggo8e6c7ad2016-09-16 08:20:38 -0700396SkCodec::Result SkCodec::startIncrementalDecode(const SkImageInfo& info, void* pixels,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000397 size_t rowBytes, const SkCodec::Options* options) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700398 fStartedIncrementalDecode = false;
399
400 if (kUnknown_SkColorType == info.colorType()) {
401 return kInvalidConversion;
402 }
403 if (nullptr == pixels) {
404 return kInvalidParameters;
405 }
406
scroggo8e6c7ad2016-09-16 08:20:38 -0700407 // FIXME: If the rows come after the rows of a previous incremental decode,
408 // we might be able to skip the rewind, but only the implementation knows
409 // that. (e.g. PNG will always need to rewind, since we called longjmp, but
410 // a bottom-up BMP could skip rewinding if the new rows are above the old
411 // rows.)
412 if (!this->rewindIfNeeded()) {
413 return kCouldNotRewind;
414 }
415
416 // Set options.
417 Options optsStorage;
418 if (nullptr == options) {
419 options = &optsStorage;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400420 } else {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400421 if (options->fSubset) {
422 SkIRect size = SkIRect::MakeSize(info.dimensions());
423 if (!size.contains(*options->fSubset)) {
424 return kInvalidParameters;
425 }
scroggo8e6c7ad2016-09-16 08:20:38 -0700426
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400427 const int top = options->fSubset->top();
428 const int bottom = options->fSubset->bottom();
429 if (top < 0 || top >= info.height() || top >= bottom || bottom > info.height()) {
430 return kInvalidParameters;
431 }
scroggo8e6c7ad2016-09-16 08:20:38 -0700432 }
433 }
434
Leon Scroggins III07418182017-08-15 12:24:02 -0400435 const Result frameIndexResult = this->handleFrameIndex(info, pixels, rowBytes,
436 *options);
437 if (frameIndexResult != kSuccess) {
438 return frameIndexResult;
439 }
440
scroggo8e6c7ad2016-09-16 08:20:38 -0700441 if (!this->dimensionsSupported(info.dimensions())) {
442 return kInvalidScale;
443 }
444
445 fDstInfo = info;
446 fOptions = *options;
447
Leon Scroggins571b30f2017-07-11 17:35:31 +0000448 const Result result = this->onStartIncrementalDecode(info, pixels, rowBytes, fOptions);
scroggo8e6c7ad2016-09-16 08:20:38 -0700449 if (kSuccess == result) {
450 fStartedIncrementalDecode = true;
451 } else if (kUnimplemented == result) {
452 // FIXME: This is temporarily necessary, until we transition SkCodec
453 // implementations from scanline decoding to incremental decoding.
454 // SkAndroidCodec will first attempt to use incremental decoding, but
455 // will fall back to scanline decoding if incremental returns
456 // kUnimplemented. rewindIfNeeded(), above, set fNeedsRewind to true
457 // (after potentially rewinding), but we do not want the next call to
458 // startScanlineDecode() to do a rewind.
459 fNeedsRewind = false;
460 }
461 return result;
462}
463
464
465SkCodec::Result SkCodec::startScanlineDecode(const SkImageInfo& info,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000466 const SkCodec::Options* options) {
scroggo46c57472015-09-30 08:57:13 -0700467 // Reset fCurrScanline in case of failure.
468 fCurrScanline = -1;
scroggo46c57472015-09-30 08:57:13 -0700469
scroggo3a7701c2015-09-30 09:15:14 -0700470 if (!this->rewindIfNeeded()) {
471 return kCouldNotRewind;
472 }
473
scroggo46c57472015-09-30 08:57:13 -0700474 // Set options.
475 Options optsStorage;
476 if (nullptr == options) {
477 options = &optsStorage;
scroggoe7fc14b2015-10-02 13:14:46 -0700478 } else if (options->fSubset) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700479 SkIRect size = SkIRect::MakeSize(info.dimensions());
msarettfdb47572015-10-13 12:50:14 -0700480 if (!size.contains(*options->fSubset)) {
481 return kInvalidInput;
482 }
483
484 // We only support subsetting in the x-dimension for scanline decoder.
485 // Subsetting in the y-dimension can be accomplished using skipScanlines().
scroggo8e6c7ad2016-09-16 08:20:38 -0700486 if (options->fSubset->top() != 0 || options->fSubset->height() != info.height()) {
msarettfdb47572015-10-13 12:50:14 -0700487 return kInvalidInput;
scroggoe7fc14b2015-10-02 13:14:46 -0700488 }
489 }
490
Leon Scroggins III07418182017-08-15 12:24:02 -0400491 // Scanline decoding only supports decoding the first frame.
492 if (options->fFrameIndex != 0) {
493 return kUnimplemented;
494 }
495
496 // The void* dst and rowbytes in handleFrameIndex or only used for decoding prior
497 // frames, which is not supported here anyway, so it is safe to pass nullptr/0.
498 const Result frameIndexResult = this->handleFrameIndex(info, nullptr, 0, *options);
499 if (frameIndexResult != kSuccess) {
500 return frameIndexResult;
501 }
502
scroggoe7fc14b2015-10-02 13:14:46 -0700503 // FIXME: Support subsets somehow?
scroggo8e6c7ad2016-09-16 08:20:38 -0700504 if (!this->dimensionsSupported(info.dimensions())) {
scroggoe7fc14b2015-10-02 13:14:46 -0700505 return kInvalidScale;
scroggo46c57472015-09-30 08:57:13 -0700506 }
507
Leon Scroggins571b30f2017-07-11 17:35:31 +0000508 const Result result = this->onStartScanlineDecode(info, *options);
scroggo46c57472015-09-30 08:57:13 -0700509 if (result != SkCodec::kSuccess) {
510 return result;
511 }
512
513 fCurrScanline = 0;
scroggo8e6c7ad2016-09-16 08:20:38 -0700514 fDstInfo = info;
scroggo46c57472015-09-30 08:57:13 -0700515 fOptions = *options;
516 return kSuccess;
517}
518
msarette6dd0042015-10-09 11:07:34 -0700519int SkCodec::getScanlines(void* dst, int countLines, size_t rowBytes) {
scroggo46c57472015-09-30 08:57:13 -0700520 if (fCurrScanline < 0) {
msarette6dd0042015-10-09 11:07:34 -0700521 return 0;
scroggo46c57472015-09-30 08:57:13 -0700522 }
523
524 SkASSERT(!fDstInfo.isEmpty());
scroggoe7fc14b2015-10-02 13:14:46 -0700525 if (countLines <= 0 || fCurrScanline + countLines > fDstInfo.height()) {
msarette6dd0042015-10-09 11:07:34 -0700526 return 0;
scroggo46c57472015-09-30 08:57:13 -0700527 }
528
msarette6dd0042015-10-09 11:07:34 -0700529 const int linesDecoded = this->onGetScanlines(dst, countLines, rowBytes);
530 if (linesDecoded < countLines) {
531 this->fillIncompleteImage(this->dstInfo(), dst, rowBytes, this->options().fZeroInitialized,
532 countLines, linesDecoded);
533 }
534 fCurrScanline += countLines;
535 return linesDecoded;
536}
537
538bool SkCodec::skipScanlines(int countLines) {
539 if (fCurrScanline < 0) {
540 return false;
541 }
542
543 SkASSERT(!fDstInfo.isEmpty());
544 if (countLines < 0 || fCurrScanline + countLines > fDstInfo.height()) {
545 // Arguably, we could just skip the scanlines which are remaining,
546 // and return true. We choose to return false so the client
547 // can catch their bug.
548 return false;
549 }
550
551 bool result = this->onSkipScanlines(countLines);
scroggo46c57472015-09-30 08:57:13 -0700552 fCurrScanline += countLines;
553 return result;
554}
555
msarette6dd0042015-10-09 11:07:34 -0700556int SkCodec::outputScanline(int inputScanline) const {
557 SkASSERT(0 <= inputScanline && inputScanline < this->getInfo().height());
558 return this->onOutputScanline(inputScanline);
559}
scroggo46c57472015-09-30 08:57:13 -0700560
msarette6dd0042015-10-09 11:07:34 -0700561int SkCodec::onOutputScanline(int inputScanline) const {
562 switch (this->getScanlineOrder()) {
563 case kTopDown_SkScanlineOrder:
msarette6dd0042015-10-09 11:07:34 -0700564 return inputScanline;
565 case kBottomUp_SkScanlineOrder:
566 return this->getInfo().height() - inputScanline - 1;
567 default:
568 // This case indicates an interlaced gif and is implemented by SkGifCodec.
569 SkASSERT(false);
570 return 0;
scroggo46c57472015-09-30 08:57:13 -0700571 }
msarette6dd0042015-10-09 11:07:34 -0700572}
scroggo46c57472015-09-30 08:57:13 -0700573
msarettf7eb6fc2016-09-13 09:04:11 -0700574uint64_t SkCodec::onGetFillValue(const SkImageInfo& dstInfo) const {
575 switch (dstInfo.colorType()) {
576 case kRGBA_F16_SkColorType: {
577 static constexpr uint64_t transparentColor = 0;
578 static constexpr uint64_t opaqueColor = ((uint64_t) SK_Half1) << 48;
579 return (kOpaque_SkAlphaType == fSrcInfo.alphaType()) ? opaqueColor : transparentColor;
580 }
581 default: {
Leon Scroggins571b30f2017-07-11 17:35:31 +0000582 // This not only handles the kN32 case, but also k565, kGray8, since
msarettf7eb6fc2016-09-13 09:04:11 -0700583 // the low bits are zeros.
584 return (kOpaque_SkAlphaType == fSrcInfo.alphaType()) ?
585 SK_ColorBLACK : SK_ColorTRANSPARENT;
586 }
587 }
588}
589
msarette6dd0042015-10-09 11:07:34 -0700590static void fill_proc(const SkImageInfo& info, void* dst, size_t rowBytes,
msarettf7eb6fc2016-09-13 09:04:11 -0700591 uint64_t colorOrIndex, SkCodec::ZeroInitialized zeroInit, SkSampler* sampler) {
msarette6dd0042015-10-09 11:07:34 -0700592 if (sampler) {
593 sampler->fill(info, dst, rowBytes, colorOrIndex, zeroInit);
594 } else {
595 SkSampler::Fill(info, dst, rowBytes, colorOrIndex, zeroInit);
596 }
597}
598
599void SkCodec::fillIncompleteImage(const SkImageInfo& info, void* dst, size_t rowBytes,
600 ZeroInitialized zeroInit, int linesRequested, int linesDecoded) {
601
602 void* fillDst;
msarettf7eb6fc2016-09-13 09:04:11 -0700603 const uint64_t fillValue = this->getFillValue(info);
msarette6dd0042015-10-09 11:07:34 -0700604 const int linesRemaining = linesRequested - linesDecoded;
605 SkSampler* sampler = this->getSampler(false);
606
msarett91c22b22016-02-22 12:27:46 -0800607 int fillWidth = info.width();
608 if (fOptions.fSubset) {
609 fillWidth = fOptions.fSubset->width();
610 }
611
msarette6dd0042015-10-09 11:07:34 -0700612 switch (this->getScanlineOrder()) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700613 case kTopDown_SkScanlineOrder: {
msarett91c22b22016-02-22 12:27:46 -0800614 const SkImageInfo fillInfo = info.makeWH(fillWidth, linesRemaining);
msarette6dd0042015-10-09 11:07:34 -0700615 fillDst = SkTAddOffset<void>(dst, linesDecoded * rowBytes);
616 fill_proc(fillInfo, fillDst, rowBytes, fillValue, zeroInit, sampler);
617 break;
618 }
619 case kBottomUp_SkScanlineOrder: {
620 fillDst = dst;
msarett91c22b22016-02-22 12:27:46 -0800621 const SkImageInfo fillInfo = info.makeWH(fillWidth, linesRemaining);
msarette6dd0042015-10-09 11:07:34 -0700622 fill_proc(fillInfo, fillDst, rowBytes, fillValue, zeroInit, sampler);
623 break;
624 }
msarette6dd0042015-10-09 11:07:34 -0700625 }
scroggo46c57472015-09-30 08:57:13 -0700626}
Matt Sarett313c4632016-10-20 12:35:23 -0400627
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400628static inline SkColorSpaceXform::ColorFormat select_xform_format_ct(SkColorType colorType) {
629 switch (colorType) {
630 case kRGBA_8888_SkColorType:
631 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
632 case kBGRA_8888_SkColorType:
633 return SkColorSpaceXform::kBGRA_8888_ColorFormat;
634 case kRGB_565_SkColorType:
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400635#ifdef SK_PMCOLOR_IS_RGBA
636 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
637#else
638 return SkColorSpaceXform::kBGRA_8888_ColorFormat;
639#endif
640 default:
641 SkASSERT(false);
642 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
643 }
644}
645
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400646bool SkCodec::initializeColorXform(const SkImageInfo& dstInfo, SkEncodedInfo::Alpha encodedAlpha,
Matt Sarettcf3f2342017-03-23 15:32:25 -0400647 SkTransferFunctionBehavior premulBehavior) {
Matt Sarett313c4632016-10-20 12:35:23 -0400648 fColorXform = nullptr;
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400649 fXformOnDecode = false;
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400650 if (!this->usesColorXform()) {
651 return true;
652 }
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500653 // FIXME: In SkWebpCodec, if a frame is blending with a prior frame, we don't need
654 // a colorXform to do a color correct premul, since the blend step will handle
655 // premultiplication. But there is no way to know whether we need to blend from
656 // inside this call.
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400657 bool needsColorCorrectPremul = needs_premul(dstInfo.alphaType(), encodedAlpha) &&
Matt Sarettcf3f2342017-03-23 15:32:25 -0400658 SkTransferFunctionBehavior::kRespect == premulBehavior;
Leon Scroggins III07418182017-08-15 12:24:02 -0400659 if (needs_color_xform(dstInfo, fSrcInfo.colorSpace(), needsColorCorrectPremul)) {
Mike Kleine60ae822018-05-23 00:06:33 +0000660 fColorXform = SkColorSpaceXform_Base::New(fSrcInfo.colorSpace(), dstInfo.colorSpace(),
661 premulBehavior);
Matt Sarett313c4632016-10-20 12:35:23 -0400662 if (!fColorXform) {
663 return false;
664 }
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400665
666 // We will apply the color xform when reading the color table unless F16 is requested.
667 fXformOnDecode = SkEncodedInfo::kPalette_Color != fEncodedInfo.color()
668 || kRGBA_F16_SkColorType == dstInfo.colorType();
669 if (fXformOnDecode) {
670 fDstXformFormat = select_xform_format(dstInfo.colorType());
671 } else {
672 fDstXformFormat = select_xform_format_ct(dstInfo.colorType());
673 }
Matt Sarett313c4632016-10-20 12:35:23 -0400674 }
675
676 return true;
677}
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400678
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400679void SkCodec::applyColorXform(void* dst, const void* src, int count, SkAlphaType at) const {
680 SkASSERT(fColorXform);
681 SkAssertResult(fColorXform->apply(fDstXformFormat, dst,
682 fSrcXformFormat, src,
683 count, at));
684}
685
686void SkCodec::applyColorXform(void* dst, const void* src, int count) const {
687 auto alphaType = select_xform_alpha(fDstInfo.alphaType(), fSrcInfo.alphaType());
688 this->applyColorXform(dst, src, count, alphaType);
689}
690
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400691std::vector<SkCodec::FrameInfo> SkCodec::getFrameInfo() {
Leon Scroggins III249b8e32017-04-17 12:46:33 -0400692 const int frameCount = this->getFrameCount();
693 SkASSERT(frameCount >= 0);
694 if (frameCount <= 0) {
695 return std::vector<FrameInfo>{};
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400696 }
Leon Scroggins III249b8e32017-04-17 12:46:33 -0400697
698 if (frameCount == 1 && !this->onGetFrameInfo(0, nullptr)) {
699 // Not animated.
700 return std::vector<FrameInfo>{};
701 }
702
703 std::vector<FrameInfo> result(frameCount);
704 for (int i = 0; i < frameCount; ++i) {
705 SkAssertResult(this->onGetFrameInfo(i, &result[i]));
706 }
707 return result;
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400708}
Leon Scroggins IIIfe3da022018-01-16 11:56:54 -0500709
710const char* SkCodec::ResultToString(Result result) {
711 switch (result) {
712 case kSuccess:
713 return "success";
714 case kIncompleteInput:
715 return "incomplete input";
716 case kErrorInInput:
717 return "error in input";
718 case kInvalidConversion:
719 return "invalid conversion";
720 case kInvalidScale:
721 return "invalid scale";
722 case kInvalidParameters:
723 return "invalid parameters";
724 case kInvalidInput:
725 return "invalid input";
726 case kCouldNotRewind:
727 return "could not rewind";
728 case kInternalError:
729 return "internal error";
730 case kUnimplemented:
731 return "unimplemented";
732 default:
733 SkASSERT(false);
734 return "bogus result value";
735 }
736}