blob: d9992c0cd9142287894b103c5d6fea8fbedae3ee [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 Klein6747f522018-05-22 10:32:20 -040012#include "SkColorSpaceXformPriv.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 III7916c0e2018-05-24 13:04:06 -0400211bool zero_rect(const SkImageInfo& dstInfo, void* pixels, size_t rowBytes,
212 SkISize srcDimensions, SkIRect prevRect) {
213 const auto dimensions = dstInfo.dimensions();
214 if (dimensions != srcDimensions) {
215 SkRect src = SkRect::Make(srcDimensions);
216 SkRect dst = SkRect::Make(dimensions);
217 SkMatrix map = SkMatrix::MakeRectToRect(src, dst, SkMatrix::kCenter_ScaleToFit);
218 SkRect asRect = SkRect::Make(prevRect);
219 if (!map.mapRect(&asRect)) {
220 return false;
221 }
222 asRect.roundIn(&prevRect);
223 if (prevRect.isEmpty()) {
224 // Down-scaling shrank the empty portion to nothing,
225 // so nothing to zero.
226 return true;
227 }
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400228 }
Leon Scroggins III7916c0e2018-05-24 13:04:06 -0400229
230 if (!prevRect.intersect(dstInfo.bounds())) {
231 SkCodecPrintf("rectangles do not intersect!");
232 SkASSERT(false);
233 return true;
234 }
235
236 const SkImageInfo info = dstInfo.makeWH(prevRect.width(), prevRect.height());
Mike Reed7fcfb622018-02-09 13:26:46 -0500237 const size_t bpp = dstInfo.bytesPerPixel();
Leon Scroggins III7916c0e2018-05-24 13:04:06 -0400238 const size_t offset = prevRect.x() * bpp + prevRect.y() * rowBytes;
239 void* eraseDst = SkTAddOffset<void>(pixels, offset);
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400240 SkSampler::Fill(info, eraseDst, rowBytes, 0, SkCodec::kNo_ZeroInitialized);
Leon Scroggins III7916c0e2018-05-24 13:04:06 -0400241 return true;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400242}
243
244SkCodec::Result SkCodec::handleFrameIndex(const SkImageInfo& info, void* pixels, size_t rowBytes,
245 const Options& options) {
246 const int index = options.fFrameIndex;
247 if (0 == index) {
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500248 if (!this->conversionSupported(info, fSrcInfo.colorType(), fEncodedInfo.opaque(),
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400249 fSrcInfo.colorSpace())
250 || !this->initializeColorXform(info, fEncodedInfo.alpha(), options.fPremulBehavior))
251 {
Leon Scroggins III07418182017-08-15 12:24:02 -0400252 return kInvalidConversion;
253 }
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400254 return kSuccess;
255 }
256
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400257 if (index < 0) {
258 return kInvalidParameters;
259 }
260
Leon Scroggins III42ee2842018-01-14 14:46:51 -0500261 if (options.fSubset) {
262 // If we add support for this, we need to update the code that zeroes
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400263 // a kRestoreBGColor frame.
264 return kInvalidParameters;
265 }
266
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400267 if (index >= this->onGetFrameCount()) {
268 return kIncompleteInput;
269 }
270
271 const auto* frameHolder = this->getFrameHolder();
272 SkASSERT(frameHolder);
273
274 const auto* frame = frameHolder->getFrame(index);
275 SkASSERT(frame);
276
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500277 if (!this->conversionSupported(info, fSrcInfo.colorType(), !frame->hasAlpha(),
Leon Scroggins III07418182017-08-15 12:24:02 -0400278 fSrcInfo.colorSpace())) {
279 return kInvalidConversion;
280 }
281
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400282 const int requiredFrame = frame->getRequiredFrame();
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400283 if (requiredFrame != kNone) {
284 if (options.fPriorFrame != kNone) {
285 // Check for a valid frame as a starting point. Alternatively, we could
286 // treat an invalid frame as not providing one, but rejecting it will
287 // make it easier to catch the mistake.
288 if (options.fPriorFrame < requiredFrame || options.fPriorFrame >= index) {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400289 return kInvalidParameters;
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400290 }
291 const auto* prevFrame = frameHolder->getFrame(options.fPriorFrame);
292 switch (prevFrame->getDisposalMethod()) {
293 case SkCodecAnimation::DisposalMethod::kRestorePrevious:
294 return kInvalidParameters;
295 case SkCodecAnimation::DisposalMethod::kRestoreBGColor:
296 // If a frame after the required frame is provided, there is no
297 // need to clear, since it must be covered by the desired frame.
298 if (options.fPriorFrame == requiredFrame) {
Leon Scroggins III42ee2842018-01-14 14:46:51 -0500299 SkIRect prevRect = prevFrame->frameRect();
Leon Scroggins III7916c0e2018-05-24 13:04:06 -0400300 if (!zero_rect(info, pixels, rowBytes, fSrcInfo.dimensions(), prevRect)) {
301 return kInternalError;
Leon Scroggins III42ee2842018-01-14 14:46:51 -0500302 }
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400303 }
304 break;
305 default:
306 break;
307 }
308 } else {
309 Options prevFrameOptions(options);
310 prevFrameOptions.fFrameIndex = requiredFrame;
311 prevFrameOptions.fZeroInitialized = kNo_ZeroInitialized;
312 const Result result = this->getPixels(info, pixels, rowBytes, &prevFrameOptions);
313 if (result != kSuccess) {
314 return result;
315 }
316 const auto* prevFrame = frameHolder->getFrame(requiredFrame);
317 const auto disposalMethod = prevFrame->getDisposalMethod();
318 if (disposalMethod == SkCodecAnimation::DisposalMethod::kRestoreBGColor) {
Leon Scroggins III7916c0e2018-05-24 13:04:06 -0400319 auto prevRect = prevFrame->frameRect();
320 if (!zero_rect(info, pixels, rowBytes, fSrcInfo.dimensions(), prevRect)) {
321 return kInternalError;
322 }
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400323 }
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400324 }
325 }
326
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500327 return this->initializeColorXform(info, frame->reportedAlpha(), options.fPremulBehavior)
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400328 ? kSuccess : kInvalidConversion;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400329}
scroggo8e6c7ad2016-09-16 08:20:38 -0700330
scroggoeb602a52015-07-09 08:16:03 -0700331SkCodec::Result SkCodec::getPixels(const SkImageInfo& info, void* pixels, size_t rowBytes,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000332 const Options* options) {
scroggoeb602a52015-07-09 08:16:03 -0700333 if (kUnknown_SkColorType == info.colorType()) {
334 return kInvalidConversion;
335 }
halcanary96fcdcc2015-08-27 07:41:13 -0700336 if (nullptr == pixels) {
scroggoeb602a52015-07-09 08:16:03 -0700337 return kInvalidParameters;
338 }
339 if (rowBytes < info.minRowBytes()) {
340 return kInvalidParameters;
341 }
342
scroggo3a7701c2015-09-30 09:15:14 -0700343 if (!this->rewindIfNeeded()) {
344 return kCouldNotRewind;
345 }
346
scroggoeb602a52015-07-09 08:16:03 -0700347 // Default options.
348 Options optsStorage;
halcanary96fcdcc2015-08-27 07:41:13 -0700349 if (nullptr == options) {
scroggoeb602a52015-07-09 08:16:03 -0700350 options = &optsStorage;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400351 } else {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400352 if (options->fSubset) {
353 SkIRect subset(*options->fSubset);
354 if (!this->onGetValidSubset(&subset) || subset != *options->fSubset) {
355 // FIXME: How to differentiate between not supporting subset at all
356 // and not supporting this particular subset?
357 return kUnimplemented;
358 }
scroggoe7fc14b2015-10-02 13:14:46 -0700359 }
scroggoeb602a52015-07-09 08:16:03 -0700360 }
scroggoe7fc14b2015-10-02 13:14:46 -0700361
Leon Scroggins III07418182017-08-15 12:24:02 -0400362 const Result frameIndexResult = this->handleFrameIndex(info, pixels, rowBytes,
363 *options);
364 if (frameIndexResult != kSuccess) {
365 return frameIndexResult;
366 }
367
scroggoe7fc14b2015-10-02 13:14:46 -0700368 // FIXME: Support subsets somehow? Note that this works for SkWebpCodec
369 // because it supports arbitrary scaling/subset combinations.
370 if (!this->dimensionsSupported(info.dimensions())) {
371 return kInvalidScale;
372 }
373
scroggo8e6c7ad2016-09-16 08:20:38 -0700374 fDstInfo = info;
Leon Scroggins III42886572017-01-27 13:16:28 -0500375 fOptions = *options;
scroggo8e6c7ad2016-09-16 08:20:38 -0700376
msarette6dd0042015-10-09 11:07:34 -0700377 // On an incomplete decode, the subclass will specify the number of scanlines that it decoded
378 // successfully.
379 int rowsDecoded = 0;
Leon Scroggins571b30f2017-07-11 17:35:31 +0000380 const Result result = this->onGetPixels(info, pixels, rowBytes, *options, &rowsDecoded);
msarette6dd0042015-10-09 11:07:34 -0700381
382 // A return value of kIncompleteInput indicates a truncated image stream.
383 // In this case, we will fill any uninitialized memory with a default value.
384 // Some subclasses will take care of filling any uninitialized memory on
385 // their own. They indicate that all of the memory has been filled by
386 // setting rowsDecoded equal to the height.
Leon Scroggins III674a1842017-07-06 12:26:09 -0400387 if ((kIncompleteInput == result || kErrorInInput == result) && rowsDecoded != info.height()) {
Leon Scroggins III42886572017-01-27 13:16:28 -0500388 // FIXME: (skbug.com/5772) fillIncompleteImage will fill using the swizzler's width, unless
389 // there is a subset. In that case, it will use the width of the subset. From here, the
390 // subset will only be non-null in the case of SkWebpCodec, but it treats the subset
391 // differenty from the other codecs, and it needs to use the width specified by the info.
392 // Set the subset to null so SkWebpCodec uses the correct width.
393 fOptions.fSubset = nullptr;
msarette6dd0042015-10-09 11:07:34 -0700394 this->fillIncompleteImage(info, pixels, rowBytes, options->fZeroInitialized, info.height(),
395 rowsDecoded);
396 }
397
scroggoeb602a52015-07-09 08:16:03 -0700398 return result;
399}
400
scroggo8e6c7ad2016-09-16 08:20:38 -0700401SkCodec::Result SkCodec::startIncrementalDecode(const SkImageInfo& info, void* pixels,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000402 size_t rowBytes, const SkCodec::Options* options) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700403 fStartedIncrementalDecode = false;
404
405 if (kUnknown_SkColorType == info.colorType()) {
406 return kInvalidConversion;
407 }
408 if (nullptr == pixels) {
409 return kInvalidParameters;
410 }
411
scroggo8e6c7ad2016-09-16 08:20:38 -0700412 // FIXME: If the rows come after the rows of a previous incremental decode,
413 // we might be able to skip the rewind, but only the implementation knows
414 // that. (e.g. PNG will always need to rewind, since we called longjmp, but
415 // a bottom-up BMP could skip rewinding if the new rows are above the old
416 // rows.)
417 if (!this->rewindIfNeeded()) {
418 return kCouldNotRewind;
419 }
420
421 // Set options.
422 Options optsStorage;
423 if (nullptr == options) {
424 options = &optsStorage;
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400425 } else {
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400426 if (options->fSubset) {
427 SkIRect size = SkIRect::MakeSize(info.dimensions());
428 if (!size.contains(*options->fSubset)) {
429 return kInvalidParameters;
430 }
scroggo8e6c7ad2016-09-16 08:20:38 -0700431
Leon Scroggins III1f6af6b2017-06-12 16:41:09 -0400432 const int top = options->fSubset->top();
433 const int bottom = options->fSubset->bottom();
434 if (top < 0 || top >= info.height() || top >= bottom || bottom > info.height()) {
435 return kInvalidParameters;
436 }
scroggo8e6c7ad2016-09-16 08:20:38 -0700437 }
438 }
439
Leon Scroggins III07418182017-08-15 12:24:02 -0400440 const Result frameIndexResult = this->handleFrameIndex(info, pixels, rowBytes,
441 *options);
442 if (frameIndexResult != kSuccess) {
443 return frameIndexResult;
444 }
445
scroggo8e6c7ad2016-09-16 08:20:38 -0700446 if (!this->dimensionsSupported(info.dimensions())) {
447 return kInvalidScale;
448 }
449
450 fDstInfo = info;
451 fOptions = *options;
452
Leon Scroggins571b30f2017-07-11 17:35:31 +0000453 const Result result = this->onStartIncrementalDecode(info, pixels, rowBytes, fOptions);
scroggo8e6c7ad2016-09-16 08:20:38 -0700454 if (kSuccess == result) {
455 fStartedIncrementalDecode = true;
456 } else if (kUnimplemented == result) {
457 // FIXME: This is temporarily necessary, until we transition SkCodec
458 // implementations from scanline decoding to incremental decoding.
459 // SkAndroidCodec will first attempt to use incremental decoding, but
460 // will fall back to scanline decoding if incremental returns
461 // kUnimplemented. rewindIfNeeded(), above, set fNeedsRewind to true
462 // (after potentially rewinding), but we do not want the next call to
463 // startScanlineDecode() to do a rewind.
464 fNeedsRewind = false;
465 }
466 return result;
467}
468
469
470SkCodec::Result SkCodec::startScanlineDecode(const SkImageInfo& info,
Leon Scroggins571b30f2017-07-11 17:35:31 +0000471 const SkCodec::Options* options) {
scroggo46c57472015-09-30 08:57:13 -0700472 // Reset fCurrScanline in case of failure.
473 fCurrScanline = -1;
scroggo46c57472015-09-30 08:57:13 -0700474
scroggo3a7701c2015-09-30 09:15:14 -0700475 if (!this->rewindIfNeeded()) {
476 return kCouldNotRewind;
477 }
478
scroggo46c57472015-09-30 08:57:13 -0700479 // Set options.
480 Options optsStorage;
481 if (nullptr == options) {
482 options = &optsStorage;
scroggoe7fc14b2015-10-02 13:14:46 -0700483 } else if (options->fSubset) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700484 SkIRect size = SkIRect::MakeSize(info.dimensions());
msarettfdb47572015-10-13 12:50:14 -0700485 if (!size.contains(*options->fSubset)) {
486 return kInvalidInput;
487 }
488
489 // We only support subsetting in the x-dimension for scanline decoder.
490 // Subsetting in the y-dimension can be accomplished using skipScanlines().
scroggo8e6c7ad2016-09-16 08:20:38 -0700491 if (options->fSubset->top() != 0 || options->fSubset->height() != info.height()) {
msarettfdb47572015-10-13 12:50:14 -0700492 return kInvalidInput;
scroggoe7fc14b2015-10-02 13:14:46 -0700493 }
494 }
495
Leon Scroggins III07418182017-08-15 12:24:02 -0400496 // Scanline decoding only supports decoding the first frame.
497 if (options->fFrameIndex != 0) {
498 return kUnimplemented;
499 }
500
501 // The void* dst and rowbytes in handleFrameIndex or only used for decoding prior
502 // frames, which is not supported here anyway, so it is safe to pass nullptr/0.
503 const Result frameIndexResult = this->handleFrameIndex(info, nullptr, 0, *options);
504 if (frameIndexResult != kSuccess) {
505 return frameIndexResult;
506 }
507
scroggoe7fc14b2015-10-02 13:14:46 -0700508 // FIXME: Support subsets somehow?
scroggo8e6c7ad2016-09-16 08:20:38 -0700509 if (!this->dimensionsSupported(info.dimensions())) {
scroggoe7fc14b2015-10-02 13:14:46 -0700510 return kInvalidScale;
scroggo46c57472015-09-30 08:57:13 -0700511 }
512
Leon Scroggins571b30f2017-07-11 17:35:31 +0000513 const Result result = this->onStartScanlineDecode(info, *options);
scroggo46c57472015-09-30 08:57:13 -0700514 if (result != SkCodec::kSuccess) {
515 return result;
516 }
517
518 fCurrScanline = 0;
scroggo8e6c7ad2016-09-16 08:20:38 -0700519 fDstInfo = info;
scroggo46c57472015-09-30 08:57:13 -0700520 fOptions = *options;
521 return kSuccess;
522}
523
msarette6dd0042015-10-09 11:07:34 -0700524int SkCodec::getScanlines(void* dst, int countLines, size_t rowBytes) {
scroggo46c57472015-09-30 08:57:13 -0700525 if (fCurrScanline < 0) {
msarette6dd0042015-10-09 11:07:34 -0700526 return 0;
scroggo46c57472015-09-30 08:57:13 -0700527 }
528
529 SkASSERT(!fDstInfo.isEmpty());
scroggoe7fc14b2015-10-02 13:14:46 -0700530 if (countLines <= 0 || fCurrScanline + countLines > fDstInfo.height()) {
msarette6dd0042015-10-09 11:07:34 -0700531 return 0;
scroggo46c57472015-09-30 08:57:13 -0700532 }
533
msarette6dd0042015-10-09 11:07:34 -0700534 const int linesDecoded = this->onGetScanlines(dst, countLines, rowBytes);
535 if (linesDecoded < countLines) {
536 this->fillIncompleteImage(this->dstInfo(), dst, rowBytes, this->options().fZeroInitialized,
537 countLines, linesDecoded);
538 }
539 fCurrScanline += countLines;
540 return linesDecoded;
541}
542
543bool SkCodec::skipScanlines(int countLines) {
544 if (fCurrScanline < 0) {
545 return false;
546 }
547
548 SkASSERT(!fDstInfo.isEmpty());
549 if (countLines < 0 || fCurrScanline + countLines > fDstInfo.height()) {
550 // Arguably, we could just skip the scanlines which are remaining,
551 // and return true. We choose to return false so the client
552 // can catch their bug.
553 return false;
554 }
555
556 bool result = this->onSkipScanlines(countLines);
scroggo46c57472015-09-30 08:57:13 -0700557 fCurrScanline += countLines;
558 return result;
559}
560
msarette6dd0042015-10-09 11:07:34 -0700561int SkCodec::outputScanline(int inputScanline) const {
562 SkASSERT(0 <= inputScanline && inputScanline < this->getInfo().height());
563 return this->onOutputScanline(inputScanline);
564}
scroggo46c57472015-09-30 08:57:13 -0700565
msarette6dd0042015-10-09 11:07:34 -0700566int SkCodec::onOutputScanline(int inputScanline) const {
567 switch (this->getScanlineOrder()) {
568 case kTopDown_SkScanlineOrder:
msarette6dd0042015-10-09 11:07:34 -0700569 return inputScanline;
570 case kBottomUp_SkScanlineOrder:
571 return this->getInfo().height() - inputScanline - 1;
572 default:
573 // This case indicates an interlaced gif and is implemented by SkGifCodec.
574 SkASSERT(false);
575 return 0;
scroggo46c57472015-09-30 08:57:13 -0700576 }
msarette6dd0042015-10-09 11:07:34 -0700577}
scroggo46c57472015-09-30 08:57:13 -0700578
msarettf7eb6fc2016-09-13 09:04:11 -0700579uint64_t SkCodec::onGetFillValue(const SkImageInfo& dstInfo) const {
580 switch (dstInfo.colorType()) {
581 case kRGBA_F16_SkColorType: {
582 static constexpr uint64_t transparentColor = 0;
583 static constexpr uint64_t opaqueColor = ((uint64_t) SK_Half1) << 48;
584 return (kOpaque_SkAlphaType == fSrcInfo.alphaType()) ? opaqueColor : transparentColor;
585 }
586 default: {
Leon Scroggins571b30f2017-07-11 17:35:31 +0000587 // This not only handles the kN32 case, but also k565, kGray8, since
msarettf7eb6fc2016-09-13 09:04:11 -0700588 // the low bits are zeros.
589 return (kOpaque_SkAlphaType == fSrcInfo.alphaType()) ?
590 SK_ColorBLACK : SK_ColorTRANSPARENT;
591 }
592 }
593}
594
msarette6dd0042015-10-09 11:07:34 -0700595static void fill_proc(const SkImageInfo& info, void* dst, size_t rowBytes,
msarettf7eb6fc2016-09-13 09:04:11 -0700596 uint64_t colorOrIndex, SkCodec::ZeroInitialized zeroInit, SkSampler* sampler) {
msarette6dd0042015-10-09 11:07:34 -0700597 if (sampler) {
598 sampler->fill(info, dst, rowBytes, colorOrIndex, zeroInit);
599 } else {
600 SkSampler::Fill(info, dst, rowBytes, colorOrIndex, zeroInit);
601 }
602}
603
604void SkCodec::fillIncompleteImage(const SkImageInfo& info, void* dst, size_t rowBytes,
605 ZeroInitialized zeroInit, int linesRequested, int linesDecoded) {
606
607 void* fillDst;
msarettf7eb6fc2016-09-13 09:04:11 -0700608 const uint64_t fillValue = this->getFillValue(info);
msarette6dd0042015-10-09 11:07:34 -0700609 const int linesRemaining = linesRequested - linesDecoded;
610 SkSampler* sampler = this->getSampler(false);
611
msarett91c22b22016-02-22 12:27:46 -0800612 int fillWidth = info.width();
613 if (fOptions.fSubset) {
614 fillWidth = fOptions.fSubset->width();
615 }
616
msarette6dd0042015-10-09 11:07:34 -0700617 switch (this->getScanlineOrder()) {
scroggo8e6c7ad2016-09-16 08:20:38 -0700618 case kTopDown_SkScanlineOrder: {
msarett91c22b22016-02-22 12:27:46 -0800619 const SkImageInfo fillInfo = info.makeWH(fillWidth, linesRemaining);
msarette6dd0042015-10-09 11:07:34 -0700620 fillDst = SkTAddOffset<void>(dst, linesDecoded * rowBytes);
621 fill_proc(fillInfo, fillDst, rowBytes, fillValue, zeroInit, sampler);
622 break;
623 }
624 case kBottomUp_SkScanlineOrder: {
625 fillDst = dst;
msarett91c22b22016-02-22 12:27:46 -0800626 const SkImageInfo fillInfo = info.makeWH(fillWidth, linesRemaining);
msarette6dd0042015-10-09 11:07:34 -0700627 fill_proc(fillInfo, fillDst, rowBytes, fillValue, zeroInit, sampler);
628 break;
629 }
msarette6dd0042015-10-09 11:07:34 -0700630 }
scroggo46c57472015-09-30 08:57:13 -0700631}
Matt Sarett313c4632016-10-20 12:35:23 -0400632
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400633static inline SkColorSpaceXform::ColorFormat select_xform_format_ct(SkColorType colorType) {
634 switch (colorType) {
635 case kRGBA_8888_SkColorType:
636 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
637 case kBGRA_8888_SkColorType:
638 return SkColorSpaceXform::kBGRA_8888_ColorFormat;
639 case kRGB_565_SkColorType:
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400640#ifdef SK_PMCOLOR_IS_RGBA
641 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
642#else
643 return SkColorSpaceXform::kBGRA_8888_ColorFormat;
644#endif
645 default:
646 SkASSERT(false);
647 return SkColorSpaceXform::kRGBA_8888_ColorFormat;
648 }
649}
650
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400651bool SkCodec::initializeColorXform(const SkImageInfo& dstInfo, SkEncodedInfo::Alpha encodedAlpha,
Matt Sarettcf3f2342017-03-23 15:32:25 -0400652 SkTransferFunctionBehavior premulBehavior) {
Matt Sarett313c4632016-10-20 12:35:23 -0400653 fColorXform = nullptr;
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400654 fXformOnDecode = false;
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400655 if (!this->usesColorXform()) {
656 return true;
657 }
Leon Scroggins IIIc8037dc2017-12-05 13:55:24 -0500658 // FIXME: In SkWebpCodec, if a frame is blending with a prior frame, we don't need
659 // a colorXform to do a color correct premul, since the blend step will handle
660 // premultiplication. But there is no way to know whether we need to blend from
661 // inside this call.
Leon Scroggins IIIae79f322017-08-18 10:53:24 -0400662 bool needsColorCorrectPremul = needs_premul(dstInfo.alphaType(), encodedAlpha) &&
Matt Sarettcf3f2342017-03-23 15:32:25 -0400663 SkTransferFunctionBehavior::kRespect == premulBehavior;
Leon Scroggins III07418182017-08-15 12:24:02 -0400664 if (needs_color_xform(dstInfo, fSrcInfo.colorSpace(), needsColorCorrectPremul)) {
Mike Klein6747f522018-05-22 10:32:20 -0400665 fColorXform = SkMakeColorSpaceXform(fSrcInfo.colorSpace(),
666 dstInfo.colorSpace(),
667 premulBehavior);
Matt Sarett313c4632016-10-20 12:35:23 -0400668 if (!fColorXform) {
669 return false;
670 }
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400671
672 // We will apply the color xform when reading the color table unless F16 is requested.
673 fXformOnDecode = SkEncodedInfo::kPalette_Color != fEncodedInfo.color()
674 || kRGBA_F16_SkColorType == dstInfo.colorType();
675 if (fXformOnDecode) {
676 fDstXformFormat = select_xform_format(dstInfo.colorType());
677 } else {
678 fDstXformFormat = select_xform_format_ct(dstInfo.colorType());
679 }
Matt Sarett313c4632016-10-20 12:35:23 -0400680 }
681
682 return true;
683}
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400684
Leon Scroggins IIIc6e6a5f2017-06-05 15:53:38 -0400685void SkCodec::applyColorXform(void* dst, const void* src, int count, SkAlphaType at) const {
686 SkASSERT(fColorXform);
687 SkAssertResult(fColorXform->apply(fDstXformFormat, dst,
688 fSrcXformFormat, src,
689 count, at));
690}
691
692void SkCodec::applyColorXform(void* dst, const void* src, int count) const {
693 auto alphaType = select_xform_alpha(fDstInfo.alphaType(), fSrcInfo.alphaType());
694 this->applyColorXform(dst, src, count, alphaType);
695}
696
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400697std::vector<SkCodec::FrameInfo> SkCodec::getFrameInfo() {
Leon Scroggins III249b8e32017-04-17 12:46:33 -0400698 const int frameCount = this->getFrameCount();
699 SkASSERT(frameCount >= 0);
700 if (frameCount <= 0) {
701 return std::vector<FrameInfo>{};
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400702 }
Leon Scroggins III249b8e32017-04-17 12:46:33 -0400703
704 if (frameCount == 1 && !this->onGetFrameInfo(0, nullptr)) {
705 // Not animated.
706 return std::vector<FrameInfo>{};
707 }
708
709 std::vector<FrameInfo> result(frameCount);
710 for (int i = 0; i < frameCount; ++i) {
711 SkAssertResult(this->onGetFrameInfo(i, &result[i]));
712 }
713 return result;
Leon Scroggins IIIe132e7b2017-04-12 10:49:52 -0400714}
Leon Scroggins IIIfe3da022018-01-16 11:56:54 -0500715
716const char* SkCodec::ResultToString(Result result) {
717 switch (result) {
718 case kSuccess:
719 return "success";
720 case kIncompleteInput:
721 return "incomplete input";
722 case kErrorInInput:
723 return "error in input";
724 case kInvalidConversion:
725 return "invalid conversion";
726 case kInvalidScale:
727 return "invalid scale";
728 case kInvalidParameters:
729 return "invalid parameters";
730 case kInvalidInput:
731 return "invalid input";
732 case kCouldNotRewind:
733 return "could not rewind";
734 case kInternalError:
735 return "internal error";
736 case kUnimplemented:
737 return "unimplemented";
738 default:
739 SkASSERT(false);
740 return "bogus result value";
741 }
742}