blob: 5d38b40412f6700073841c9b66a4bc7e600193b4 [file] [log] [blame]
epoger@google.comec3ed6a2011-07-28 14:26:00 +00001/*
2 * Copyright 2006 The Android Open Source Project
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
reed@android.com8a1c16f2008-12-17 15:59:43 +00008
9#include "SkImageDecoder.h"
10#include "SkBitmap.h"
scroggo@google.comf8d7d272013-02-22 21:38:35 +000011#include "SkImagePriv.h"
reed@android.com8a1c16f2008-12-17 15:59:43 +000012#include "SkPixelRef.h"
13#include "SkStream.h"
14#include "SkTemplates.h"
commit-bot@chromium.orga936e372013-03-14 14:42:18 +000015#include "SkCanvas.h"
reed@android.com8a1c16f2008-12-17 15:59:43 +000016
17static SkBitmap::Config gDeviceConfig = SkBitmap::kNo_Config;
18
19SkBitmap::Config SkImageDecoder::GetDeviceConfig()
20{
21 return gDeviceConfig;
22}
23
24void SkImageDecoder::SetDeviceConfig(SkBitmap::Config config)
25{
26 gDeviceConfig = config;
27}
28
29///////////////////////////////////////////////////////////////////////////////
30
31SkImageDecoder::SkImageDecoder()
scroggo@google.com7e6fcee2013-05-03 20:14:28 +000032 : fPeeker(NULL)
33 , fChooser(NULL)
34 , fAllocator(NULL)
35 , fSampleSize(1)
36 , fDefaultPref(SkBitmap::kNo_Config)
37 , fDitherImage(true)
38 , fUsePrefTable(false)
scroggo@google.com8d239242013-10-01 17:27:15 +000039 , fSkipWritingZeroes(false)
scroggo@google.com2bbc2c92013-06-14 15:33:20 +000040 , fPreferQualityOverSpeed(false)
41 , fRequireUnpremultipliedColors(false) {
reed@android.com8a1c16f2008-12-17 15:59:43 +000042}
43
44SkImageDecoder::~SkImageDecoder() {
reed@google.com82065d62011-02-07 15:30:46 +000045 SkSafeUnref(fPeeker);
46 SkSafeUnref(fChooser);
47 SkSafeUnref(fAllocator);
reed@android.com8a1c16f2008-12-17 15:59:43 +000048}
49
scroggo@google.com468142b2013-07-09 15:48:24 +000050void SkImageDecoder::copyFieldsToOther(SkImageDecoder* other) {
51 if (NULL == other) {
52 return;
53 }
54 other->setPeeker(fPeeker);
55 other->setChooser(fChooser);
56 other->setAllocator(fAllocator);
57 other->setSampleSize(fSampleSize);
58 if (fUsePrefTable) {
59 other->setPrefConfigTable(fPrefTable);
60 } else {
61 other->fDefaultPref = fDefaultPref;
62 }
scroggo@google.com8d239242013-10-01 17:27:15 +000063 other->setDitherImage(fDitherImage);
64 other->setSkipWritingZeroes(fSkipWritingZeroes);
scroggo@google.com468142b2013-07-09 15:48:24 +000065 other->setPreferQualityOverSpeed(fPreferQualityOverSpeed);
66 other->setRequireUnpremultipliedColors(fRequireUnpremultipliedColors);
67}
68
reed@android.com8a1c16f2008-12-17 15:59:43 +000069SkImageDecoder::Format SkImageDecoder::getFormat() const {
70 return kUnknown_Format;
71}
72
commit-bot@chromium.orga936e372013-03-14 14:42:18 +000073const char* SkImageDecoder::getFormatName() const {
scroggo@google.comf98118e2013-05-15 14:53:49 +000074 return GetFormatName(this->getFormat());
75}
76
77const char* SkImageDecoder::GetFormatName(Format format) {
78 switch (format) {
scroggo@google.com39edf4c2013-04-25 17:33:51 +000079 case kUnknown_Format:
80 return "Unknown Format";
81 case kBMP_Format:
82 return "BMP";
83 case kGIF_Format:
84 return "GIF";
85 case kICO_Format:
86 return "ICO";
robertphillips@google.com8cf81e02014-05-22 18:40:29 +000087 case kPKM_Format:
88 return "PKM";
krajcevski99ffe242014-06-03 13:04:35 -070089 case kKTX_Format:
90 return "KTX";
scroggo@google.com39edf4c2013-04-25 17:33:51 +000091 case kJPEG_Format:
92 return "JPEG";
93 case kPNG_Format:
94 return "PNG";
95 case kWBMP_Format:
96 return "WBMP";
97 case kWEBP_Format:
98 return "WEBP";
99 default:
mtklein@google.com330313a2013-08-22 15:37:26 +0000100 SkDEBUGFAIL("Invalid format type!");
scroggo@google.com39edf4c2013-04-25 17:33:51 +0000101 }
102 return "Unknown Format";
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000103}
104
reed@android.com8a1c16f2008-12-17 15:59:43 +0000105SkImageDecoder::Peeker* SkImageDecoder::setPeeker(Peeker* peeker) {
106 SkRefCnt_SafeAssign(fPeeker, peeker);
107 return peeker;
108}
109
110SkImageDecoder::Chooser* SkImageDecoder::setChooser(Chooser* chooser) {
111 SkRefCnt_SafeAssign(fChooser, chooser);
112 return chooser;
113}
114
115SkBitmap::Allocator* SkImageDecoder::setAllocator(SkBitmap::Allocator* alloc) {
116 SkRefCnt_SafeAssign(fAllocator, alloc);
117 return alloc;
118}
119
120void SkImageDecoder::setSampleSize(int size) {
121 if (size < 1) {
122 size = 1;
123 }
124 fSampleSize = size;
125}
126
reed6c225732014-06-09 19:52:07 -0700127// TODO: change Chooser virtual to take colorType, so we can stop calling SkColorTypeToBitmapConfig
128//
129bool SkImageDecoder::chooseFromOneChoice(SkColorType colorType, int width, int height) const {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000130 Chooser* chooser = fChooser;
reed6c225732014-06-09 19:52:07 -0700131
reed@android.com8a1c16f2008-12-17 15:59:43 +0000132 if (NULL == chooser) { // no chooser, we just say YES to decoding :)
133 return true;
134 }
135 chooser->begin(1);
reed6c225732014-06-09 19:52:07 -0700136 chooser->inspect(0, SkColorTypeToBitmapConfig(colorType), width, height);
reed@android.com8a1c16f2008-12-17 15:59:43 +0000137 return chooser->choose() == 0;
138}
139
140bool SkImageDecoder::allocPixelRef(SkBitmap* bitmap,
141 SkColorTable* ctable) const {
142 return bitmap->allocPixels(fAllocator, ctable);
143}
144
145///////////////////////////////////////////////////////////////////////////////
reed@android.comb6137c32009-07-29 20:56:52 +0000146
scroggo@google.comf698c822013-07-18 19:34:49 +0000147void SkImageDecoder::setPrefConfigTable(const PrefConfigTable& prefTable) {
148 fUsePrefTable = true;
149 fPrefTable = prefTable;
150}
151
reed6c225732014-06-09 19:52:07 -0700152// TODO: use colortype in fPrefTable, fDefaultPref and GetDeviceConfig()
153// so we can stop using SkBitmapConfigToColorType()
154//
155SkColorType SkImageDecoder::getPrefColorType(SrcDepth srcDepth, bool srcHasAlpha) const {
scroggo@google.com12d06422013-07-18 19:42:35 +0000156 SkBitmap::Config config = SkBitmap::kNo_Config;
reed@android.com3f1f06a2010-03-03 21:04:12 +0000157
158 if (fUsePrefTable) {
reed@android.com3f1f06a2010-03-03 21:04:12 +0000159 switch (srcDepth) {
160 case kIndex_SrcDepth:
scroggo@google.comf698c822013-07-18 19:34:49 +0000161 config = srcHasAlpha ? fPrefTable.fPrefFor_8Index_YesAlpha_src
162 : fPrefTable.fPrefFor_8Index_NoAlpha_src;
reed@android.com3f1f06a2010-03-03 21:04:12 +0000163 break;
scroggo@google.comf698c822013-07-18 19:34:49 +0000164 case k8BitGray_SrcDepth:
165 config = fPrefTable.fPrefFor_8Gray_src;
reed@android.com3f1f06a2010-03-03 21:04:12 +0000166 break;
167 case k32Bit_SrcDepth:
scroggo@google.comf698c822013-07-18 19:34:49 +0000168 config = srcHasAlpha ? fPrefTable.fPrefFor_8bpc_YesAlpha_src
169 : fPrefTable.fPrefFor_8bpc_NoAlpha_src;
reed@android.com3f1f06a2010-03-03 21:04:12 +0000170 break;
171 }
reed@android.com3f1f06a2010-03-03 21:04:12 +0000172 } else {
173 config = fDefaultPref;
174 }
175
176 if (SkBitmap::kNo_Config == config) {
177 config = SkImageDecoder::GetDeviceConfig();
178 }
reed6c225732014-06-09 19:52:07 -0700179 return SkBitmapConfigToColorType(config);
reed@android.com3f1f06a2010-03-03 21:04:12 +0000180}
181
reed@android.com8a1c16f2008-12-17 15:59:43 +0000182bool SkImageDecoder::decode(SkStream* stream, SkBitmap* bm,
scroggo@google.combc69ce92013-07-09 15:45:14 +0000183 SkBitmap::Config pref, Mode mode) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000184 // we reset this to false before calling onDecode
185 fShouldCancelDecode = false;
reed@android.com3f1f06a2010-03-03 21:04:12 +0000186 // assign this, for use by getPrefConfig(), in case fUsePrefTable is false
187 fDefaultPref = pref;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000188
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000189 // pass a temporary bitmap, so that if we return false, we are assured of
190 // leaving the caller's bitmap untouched.
191 SkBitmap tmp;
reed@android.com3f1f06a2010-03-03 21:04:12 +0000192 if (!this->onDecode(stream, &tmp, mode)) {
reed@android.com62900b42009-02-11 15:07:19 +0000193 return false;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000194 }
reed@android.com62900b42009-02-11 15:07:19 +0000195 bm->swap(tmp);
196 return true;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000197}
198
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000199bool SkImageDecoder::decodeSubset(SkBitmap* bm, const SkIRect& rect,
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000200 SkBitmap::Config pref) {
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000201 // we reset this to false before calling onDecodeSubset
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000202 fShouldCancelDecode = false;
203 // assign this, for use by getPrefConfig(), in case fUsePrefTable is false
204 fDefaultPref = pref;
205
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000206 return this->onDecodeSubset(bm, rect);
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000207}
208
scroggo@google.comb5571b32013-09-25 21:34:24 +0000209bool SkImageDecoder::buildTileIndex(SkStreamRewindable* stream,
210 int *width, int *height) {
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000211 // we reset this to false before calling onBuildTileIndex
212 fShouldCancelDecode = false;
213
214 return this->onBuildTileIndex(stream, width, height);
215}
216
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000217bool SkImageDecoder::cropBitmap(SkBitmap *dst, SkBitmap *src, int sampleSize,
218 int dstX, int dstY, int width, int height,
219 int srcX, int srcY) {
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000220 int w = width / sampleSize;
221 int h = height / sampleSize;
reed@google.com44699382013-10-31 17:28:30 +0000222 if (src->config() == SkBitmap::kIndex8_Config) {
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000223 // kIndex8 does not allow drawing via an SkCanvas, as is done below.
224 // Instead, use extractSubset. Note that this shares the SkPixelRef and
225 // SkColorTable.
226 // FIXME: Since src is discarded in practice, this holds on to more
227 // pixels than is strictly necessary. Switch to a copy if memory
228 // savings are more important than speed here. This also means
229 // that the pixels in dst can not be reused (though there is no
230 // allocation, which was already done on src).
231 int x = (dstX - srcX) / sampleSize;
232 int y = (dstY - srcY) / sampleSize;
233 SkIRect subset = SkIRect::MakeXYWH(x, y, w, h);
234 return src->extractSubset(dst, subset);
235 }
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000236 // if the destination has no pixels then we must allocate them.
237 if (dst->isNull()) {
reed6c225732014-06-09 19:52:07 -0700238 dst->setInfo(src->info().makeWH(w, h));
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000239
240 if (!this->allocPixelRef(dst, NULL)) {
241 SkDEBUGF(("failed to allocate pixels needed to crop the bitmap"));
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000242 return false;
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000243 }
244 }
245 // check to see if the destination is large enough to decode the desired
246 // region. If this assert fails we will just draw as much of the source
247 // into the destination that we can.
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000248 if (dst->width() < w || dst->height() < h) {
249 SkDEBUGF(("SkImageDecoder::cropBitmap does not have a large enough bitmap.\n"));
250 }
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000251
252 // Set the Src_Mode for the paint to prevent transparency issue in the
253 // dest in the event that the dest was being re-used.
254 SkPaint paint;
255 paint.setXfermodeMode(SkXfermode::kSrc_Mode);
256
257 SkCanvas canvas(*dst);
258 canvas.drawSprite(*src, (srcX - dstX) / sampleSize,
259 (srcY - dstY) / sampleSize,
260 &paint);
scroggo@google.com7e6fcee2013-05-03 20:14:28 +0000261 return true;
commit-bot@chromium.orga936e372013-03-14 14:42:18 +0000262}
263
reed@android.com8a1c16f2008-12-17 15:59:43 +0000264///////////////////////////////////////////////////////////////////////////////
265
266bool SkImageDecoder::DecodeFile(const char file[], SkBitmap* bm,
reed@android.comb3ade9d2009-06-15 13:04:45 +0000267 SkBitmap::Config pref, Mode mode, Format* format) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000268 SkASSERT(file);
269 SkASSERT(bm);
270
scroggo@google.comb5571b32013-09-25 21:34:24 +0000271 SkAutoTUnref<SkStreamRewindable> stream(SkStream::NewFromFile(file));
mike@reedtribe.orgf3811622013-03-19 02:18:33 +0000272 if (stream.get()) {
273 if (SkImageDecoder::DecodeStream(stream, bm, pref, mode, format)) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000274 bm->pixelRef()->setURI(file);
tomhudson@google.com1a366212012-01-03 14:42:08 +0000275 return true;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000276 }
reed@android.com8a1c16f2008-12-17 15:59:43 +0000277 }
278 return false;
279}
280
281bool SkImageDecoder::DecodeMemory(const void* buffer, size_t size, SkBitmap* bm,
reed@android.comb3ade9d2009-06-15 13:04:45 +0000282 SkBitmap::Config pref, Mode mode, Format* format) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000283 if (0 == size) {
284 return false;
285 }
286 SkASSERT(buffer);
287
288 SkMemoryStream stream(buffer, size);
reed@android.comb3ade9d2009-06-15 13:04:45 +0000289 return SkImageDecoder::DecodeStream(&stream, bm, pref, mode, format);
reed@android.com8a1c16f2008-12-17 15:59:43 +0000290}
291
scroggo@google.comb5571b32013-09-25 21:34:24 +0000292bool SkImageDecoder::DecodeStream(SkStreamRewindable* stream, SkBitmap* bm,
293 SkBitmap::Config pref, Mode mode,
294 Format* format) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000295 SkASSERT(stream);
296 SkASSERT(bm);
297
298 bool success = false;
299 SkImageDecoder* codec = SkImageDecoder::Factory(stream);
300
301 if (NULL != codec) {
302 success = codec->decode(stream, bm, pref, mode);
reed@android.comb3ade9d2009-06-15 13:04:45 +0000303 if (success && format) {
304 *format = codec->getFormat();
scroggo@google.com39edf4c2013-04-25 17:33:51 +0000305 if (kUnknown_Format == *format) {
306 if (stream->rewind()) {
307 *format = GetStreamFormat(stream);
308 }
309 }
reed@android.comb3ade9d2009-06-15 13:04:45 +0000310 }
reed@android.com8a1c16f2008-12-17 15:59:43 +0000311 delete codec;
312 }
313 return success;
314}