Report frame bytes by platform ImageDecoder
[WebKit-https.git] / Source / WebCore / platform / image-decoders / ImageDecoder.cpp
1 /*
2  * Copyright (C) 2008-2009 Torch Mobile, Inc.
3  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Library General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Library General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Library General Public License
16  *  along with this library; see the file COPYING.LIB.  If not, write to
17  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  *  Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #include "config.h"
23 #include "ImageDecoder.h"
24
25 #include "BMPImageDecoder.h"
26 #include "GIFImageDecoder.h"
27 #include "ICOImageDecoder.h"
28 #if PLATFORM(QT)
29 #include "ImageDecoderQt.h"
30 #endif
31 #include "JPEGImageDecoder.h"
32 #include "PNGImageDecoder.h"
33 #include "SharedBuffer.h"
34 #if USE(WEBP)
35 #include "WEBPImageDecoder.h"
36 #endif
37
38 #include <algorithm>
39 #include <cmath>
40
41 using namespace std;
42
43 namespace WebCore {
44
45 namespace {
46
47 unsigned copyFromSharedBuffer(char* buffer, unsigned bufferLength, const SharedBuffer& sharedBuffer, unsigned offset)
48 {
49     unsigned bytesExtracted = 0;
50     const char* moreData;
51     while (unsigned moreDataLength = sharedBuffer.getSomeData(moreData, offset)) {
52         unsigned bytesToCopy = min(bufferLength - bytesExtracted, moreDataLength);
53         memcpy(buffer + bytesExtracted, moreData, bytesToCopy);
54         bytesExtracted += bytesToCopy;
55         if (bytesExtracted == bufferLength)
56             break;
57         offset += bytesToCopy;
58     }
59     return bytesExtracted;
60 }
61
62 bool matchesGIFSignature(char* contents)
63 {
64     return !memcmp(contents, "GIF87a", 6) || !memcmp(contents, "GIF89a", 6);
65 }
66
67 bool matchesPNGSignature(char* contents)
68 {
69     return !memcmp(contents, "\x89\x50\x4E\x47\x0D\x0A\x1A\x0A", 8);
70 }
71
72 bool matchesJPEGSignature(char* contents)
73 {
74     return !memcmp(contents, "\xFF\xD8\xFF", 3);
75 }
76
77 #if USE(WEBP)
78 bool matchesWebPSignature(char* contents)
79 {
80     return !memcmp(contents, "RIFF", 4) && !memcmp(contents + 8, "WEBPVP", 6);
81 }
82 #endif
83
84 bool matchesBMPSignature(char* contents)
85 {
86     return !memcmp(contents, "BM", 2);
87 }
88
89 bool matchesICOSignature(char* contents)
90 {
91     return !memcmp(contents, "\x00\x00\x01\x00", 4);
92 }
93
94 bool matchesCURSignature(char* contents)
95 {
96     return !memcmp(contents, "\x00\x00\x02\x00", 4);
97 }
98
99 }
100
101 ImageDecoder* ImageDecoder::create(const SharedBuffer& data, ImageSource::AlphaOption alphaOption, ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
102 {
103     static const unsigned lengthOfLongestSignature = 14; // To wit: "RIFF????WEBPVP"
104     char contents[lengthOfLongestSignature];
105     unsigned length = copyFromSharedBuffer(contents, lengthOfLongestSignature, data, 0);
106     if (length < lengthOfLongestSignature)
107         return 0;
108
109     if (matchesGIFSignature(contents))
110         return new GIFImageDecoder(alphaOption, gammaAndColorProfileOption);
111
112 #if !PLATFORM(QT) || (PLATFORM(QT) && USE(LIBPNG))
113     if (matchesPNGSignature(contents))
114         return new PNGImageDecoder(alphaOption, gammaAndColorProfileOption);
115
116     if (matchesICOSignature(contents) || matchesCURSignature(contents))
117         return new ICOImageDecoder(alphaOption, gammaAndColorProfileOption);
118 #endif
119
120 #if !PLATFORM(QT) || (PLATFORM(QT) && USE(LIBJPEG))
121     if (matchesJPEGSignature(contents))
122         return new JPEGImageDecoder(alphaOption, gammaAndColorProfileOption);
123 #endif
124
125 #if USE(WEBP)
126     if (matchesWebPSignature(contents))
127         return new WEBPImageDecoder(alphaOption, gammaAndColorProfileOption);
128 #endif
129
130     if (matchesBMPSignature(contents))
131         return new BMPImageDecoder(alphaOption, gammaAndColorProfileOption);
132
133 #if PLATFORM(QT)
134     return new ImageDecoderQt(alphaOption, gammaAndColorProfileOption);
135 #endif
136     return 0;
137 }
138
139 #if !USE(SKIA)
140
141 ImageFrame::ImageFrame()
142     : m_hasAlpha(false)
143     , m_status(FrameEmpty)
144     , m_duration(0)
145     , m_disposalMethod(DisposeNotSpecified)
146     , m_premultiplyAlpha(true)
147 {
148
149
150 ImageFrame& ImageFrame::operator=(const ImageFrame& other)
151 {
152     if (this == &other)
153         return *this;
154
155     copyBitmapData(other);
156     setOriginalFrameRect(other.originalFrameRect());
157     setStatus(other.status());
158     setDuration(other.duration());
159     setDisposalMethod(other.disposalMethod());
160     setPremultiplyAlpha(other.premultiplyAlpha());
161     return *this;
162 }
163
164 void ImageFrame::clearPixelData()
165 {
166     m_backingStore.clear();
167     m_bytes = 0;
168     m_status = FrameEmpty;
169     // NOTE: Do not reset other members here; clearFrameBufferCache() calls this
170     // to free the bitmap data, but other functions like initFrameBuffer() and
171     // frameComplete() may still need to read other metadata out of this frame
172     // later.
173 }
174
175 void ImageFrame::zeroFillPixelData()
176 {
177     memset(m_bytes, 0, m_size.width() * m_size.height() * sizeof(PixelData));
178     m_hasAlpha = true;
179 }
180
181 bool ImageFrame::copyBitmapData(const ImageFrame& other)
182 {
183     if (this == &other)
184         return true;
185
186     m_backingStore = other.m_backingStore;
187     m_bytes = m_backingStore.data();
188     m_size = other.m_size;
189     setHasAlpha(other.m_hasAlpha);
190     return true;
191 }
192
193 bool ImageFrame::setSize(int newWidth, int newHeight)
194 {
195     ASSERT(!width() && !height());
196     size_t backingStoreSize = newWidth * newHeight;
197     if (!m_backingStore.tryReserveCapacity(backingStoreSize))
198         return false;
199     m_backingStore.resize(backingStoreSize);
200     m_bytes = m_backingStore.data();
201     m_size = IntSize(newWidth, newHeight);
202
203     zeroFillPixelData();
204     return true;
205 }
206
207 bool ImageFrame::hasAlpha() const
208 {
209     return m_hasAlpha;
210 }
211
212 void ImageFrame::setHasAlpha(bool alpha)
213 {
214     m_hasAlpha = alpha;
215 }
216
217 void ImageFrame::setColorProfile(const ColorProfile& colorProfile)
218 {
219     m_colorProfile = colorProfile;
220 }
221
222 void ImageFrame::setStatus(FrameStatus status)
223 {
224     m_status = status;
225 }
226
227 int ImageFrame::width() const
228 {
229     return m_size.width();
230 }
231
232 int ImageFrame::height() const
233 {
234     return m_size.height();
235 }
236
237 #endif
238
239 namespace {
240
241 enum MatchType {
242     Exact,
243     UpperBound,
244     LowerBound
245 };
246
247 inline void fillScaledValues(Vector<int>& scaledValues, double scaleRate, int length)
248 {
249     double inflateRate = 1. / scaleRate;
250     scaledValues.reserveCapacity(static_cast<int>(length * scaleRate + 0.5));
251     for (int scaledIndex = 0; ; ++scaledIndex) {
252         int index = static_cast<int>(scaledIndex * inflateRate + 0.5);
253         if (index >= length)
254             break;
255         scaledValues.append(index);
256     }
257 }
258
259 template <MatchType type> int getScaledValue(const Vector<int>& scaledValues, int valueToMatch, int searchStart)
260 {
261     if (scaledValues.isEmpty())
262         return valueToMatch;
263
264     const int* dataStart = scaledValues.data();
265     const int* dataEnd = dataStart + scaledValues.size();
266     const int* matched = std::lower_bound(dataStart + searchStart, dataEnd, valueToMatch);
267     switch (type) {
268     case Exact:
269         return matched != dataEnd && *matched == valueToMatch ? matched - dataStart : -1;
270     case LowerBound:
271         return matched != dataEnd && *matched == valueToMatch ? matched - dataStart : matched - dataStart - 1;
272     case UpperBound:
273     default:
274         return matched != dataEnd ? matched - dataStart : -1;
275     }
276 }
277
278 }
279
280 bool ImageDecoder::frameHasAlphaAtIndex(size_t index) const
281 {
282     if (m_frameBufferCache.size() <= index)
283         return true;
284     if (m_frameBufferCache[index].status() == ImageFrame::FrameComplete)
285         return m_frameBufferCache[index].hasAlpha();
286     return true;
287 }
288
289 unsigned ImageDecoder::frameBytesAtIndex(size_t index) const
290 {
291     if (m_frameBufferCache.size() <= index)
292         return 0;
293     // FIXME: Use the dimension of the requested frame.
294     return m_size.area() * sizeof(ImageFrame::PixelData);
295 }
296
297 void ImageDecoder::prepareScaleDataIfNecessary()
298 {
299     m_scaled = false;
300     m_scaledColumns.clear();
301     m_scaledRows.clear();
302
303     int width = size().width();
304     int height = size().height();
305     int numPixels = height * width;
306     if (m_maxNumPixels <= 0 || numPixels <= m_maxNumPixels)
307         return;
308
309     m_scaled = true;
310     double scale = sqrt(m_maxNumPixels / (double)numPixels);
311     fillScaledValues(m_scaledColumns, scale, width);
312     fillScaledValues(m_scaledRows, scale, height);
313 }
314
315 int ImageDecoder::upperBoundScaledX(int origX, int searchStart)
316 {
317     return getScaledValue<UpperBound>(m_scaledColumns, origX, searchStart);
318 }
319
320 int ImageDecoder::lowerBoundScaledX(int origX, int searchStart)
321 {
322     return getScaledValue<LowerBound>(m_scaledColumns, origX, searchStart);
323 }
324
325 int ImageDecoder::upperBoundScaledY(int origY, int searchStart)
326 {
327     return getScaledValue<UpperBound>(m_scaledRows, origY, searchStart);
328 }
329
330 int ImageDecoder::lowerBoundScaledY(int origY, int searchStart)
331 {
332     return getScaledValue<LowerBound>(m_scaledRows, origY, searchStart);
333 }
334
335 int ImageDecoder::scaledY(int origY, int searchStart)
336 {
337     return getScaledValue<Exact>(m_scaledRows, origY, searchStart);
338 }
339
340 }