Checking if frame is complete and access duration doesn't need a decode
[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 #if !PLATFORM(QT) || USE(LIBJPEG)
32 #include "JPEGImageDecoder.h"
33 #endif
34 #include "PNGImageDecoder.h"
35 #include "SharedBuffer.h"
36 #if USE(WEBP)
37 #include "WEBPImageDecoder.h"
38 #endif
39
40 #include <algorithm>
41 #include <cmath>
42
43 using namespace std;
44
45 namespace WebCore {
46
47 namespace {
48
49 unsigned copyFromSharedBuffer(char* buffer, unsigned bufferLength, const SharedBuffer& sharedBuffer, unsigned offset)
50 {
51     unsigned bytesExtracted = 0;
52     const char* moreData;
53     while (unsigned moreDataLength = sharedBuffer.getSomeData(moreData, offset)) {
54         unsigned bytesToCopy = min(bufferLength - bytesExtracted, moreDataLength);
55         memcpy(buffer + bytesExtracted, moreData, bytesToCopy);
56         bytesExtracted += bytesToCopy;
57         if (bytesExtracted == bufferLength)
58             break;
59         offset += bytesToCopy;
60     }
61     return bytesExtracted;
62 }
63
64 bool matchesGIFSignature(char* contents)
65 {
66     return !memcmp(contents, "GIF87a", 6) || !memcmp(contents, "GIF89a", 6);
67 }
68
69 bool matchesPNGSignature(char* contents)
70 {
71     return !memcmp(contents, "\x89\x50\x4E\x47\x0D\x0A\x1A\x0A", 8);
72 }
73
74 bool matchesJPEGSignature(char* contents)
75 {
76     return !memcmp(contents, "\xFF\xD8\xFF", 3);
77 }
78
79 #if USE(WEBP)
80 bool matchesWebPSignature(char* contents)
81 {
82     return !memcmp(contents, "RIFF", 4) && !memcmp(contents + 8, "WEBPVP", 6);
83 }
84 #endif
85
86 bool matchesBMPSignature(char* contents)
87 {
88     return !memcmp(contents, "BM", 2);
89 }
90
91 bool matchesICOSignature(char* contents)
92 {
93     return !memcmp(contents, "\x00\x00\x01\x00", 4);
94 }
95
96 bool matchesCURSignature(char* contents)
97 {
98     return !memcmp(contents, "\x00\x00\x02\x00", 4);
99 }
100
101 }
102
103 ImageDecoder* ImageDecoder::create(const SharedBuffer& data, ImageSource::AlphaOption alphaOption, ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
104 {
105     static const unsigned lengthOfLongestSignature = 14; // To wit: "RIFF????WEBPVP"
106     char contents[lengthOfLongestSignature];
107     unsigned length = copyFromSharedBuffer(contents, lengthOfLongestSignature, data, 0);
108     if (length < lengthOfLongestSignature)
109         return 0;
110
111     if (matchesGIFSignature(contents))
112         return new GIFImageDecoder(alphaOption, gammaAndColorProfileOption);
113
114 #if !PLATFORM(QT) || (PLATFORM(QT) && USE(LIBPNG))
115     if (matchesPNGSignature(contents))
116         return new PNGImageDecoder(alphaOption, gammaAndColorProfileOption);
117
118     if (matchesICOSignature(contents) || matchesCURSignature(contents))
119         return new ICOImageDecoder(alphaOption, gammaAndColorProfileOption);
120 #endif
121
122 #if !PLATFORM(QT) || (PLATFORM(QT) && USE(LIBJPEG))
123     if (matchesJPEGSignature(contents))
124         return new JPEGImageDecoder(alphaOption, gammaAndColorProfileOption);
125 #endif
126
127 #if USE(WEBP)
128     if (matchesWebPSignature(contents))
129         return new WEBPImageDecoder(alphaOption, gammaAndColorProfileOption);
130 #endif
131
132     if (matchesBMPSignature(contents))
133         return new BMPImageDecoder(alphaOption, gammaAndColorProfileOption);
134
135 #if PLATFORM(QT)
136     return new ImageDecoderQt(alphaOption, gammaAndColorProfileOption);
137 #endif
138     return 0;
139 }
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 namespace {
228
229 enum MatchType {
230     Exact,
231     UpperBound,
232     LowerBound
233 };
234
235 inline void fillScaledValues(Vector<int>& scaledValues, double scaleRate, int length)
236 {
237     double inflateRate = 1. / scaleRate;
238     scaledValues.reserveCapacity(static_cast<int>(length * scaleRate + 0.5));
239     for (int scaledIndex = 0; ; ++scaledIndex) {
240         int index = static_cast<int>(scaledIndex * inflateRate + 0.5);
241         if (index >= length)
242             break;
243         scaledValues.append(index);
244     }
245 }
246
247 template <MatchType type> int getScaledValue(const Vector<int>& scaledValues, int valueToMatch, int searchStart)
248 {
249     if (scaledValues.isEmpty())
250         return valueToMatch;
251
252     const int* dataStart = scaledValues.data();
253     const int* dataEnd = dataStart + scaledValues.size();
254     const int* matched = std::lower_bound(dataStart + searchStart, dataEnd, valueToMatch);
255     switch (type) {
256     case Exact:
257         return matched != dataEnd && *matched == valueToMatch ? matched - dataStart : -1;
258     case LowerBound:
259         return matched != dataEnd && *matched == valueToMatch ? matched - dataStart : matched - dataStart - 1;
260     case UpperBound:
261     default:
262         return matched != dataEnd ? matched - dataStart : -1;
263     }
264 }
265
266 }
267
268 bool ImageDecoder::frameHasAlphaAtIndex(size_t index) const
269 {
270     return !frameIsCompleteAtIndex(index) || m_frameBufferCache[index].hasAlpha();
271 }
272
273 bool ImageDecoder::frameIsCompleteAtIndex(size_t index) const
274 {
275     return (index < m_frameBufferCache.size()) && (m_frameBufferCache[index].status() == ImageFrame::FrameComplete);
276 }
277
278 unsigned ImageDecoder::frameBytesAtIndex(size_t index) const
279 {
280     if (m_frameBufferCache.size() <= index)
281         return 0;
282     // FIXME: Use the dimension of the requested frame.
283     return m_size.area() * sizeof(ImageFrame::PixelData);
284 }
285
286 void ImageDecoder::prepareScaleDataIfNecessary()
287 {
288     m_scaled = false;
289     m_scaledColumns.clear();
290     m_scaledRows.clear();
291
292     int width = size().width();
293     int height = size().height();
294     int numPixels = height * width;
295     if (m_maxNumPixels <= 0 || numPixels <= m_maxNumPixels)
296         return;
297
298     m_scaled = true;
299     double scale = sqrt(m_maxNumPixels / (double)numPixels);
300     fillScaledValues(m_scaledColumns, scale, width);
301     fillScaledValues(m_scaledRows, scale, height);
302 }
303
304 int ImageDecoder::upperBoundScaledX(int origX, int searchStart)
305 {
306     return getScaledValue<UpperBound>(m_scaledColumns, origX, searchStart);
307 }
308
309 int ImageDecoder::lowerBoundScaledX(int origX, int searchStart)
310 {
311     return getScaledValue<LowerBound>(m_scaledColumns, origX, searchStart);
312 }
313
314 int ImageDecoder::upperBoundScaledY(int origY, int searchStart)
315 {
316     return getScaledValue<UpperBound>(m_scaledRows, origY, searchStart);
317 }
318
319 int ImageDecoder::lowerBoundScaledY(int origY, int searchStart)
320 {
321     return getScaledValue<LowerBound>(m_scaledRows, origY, searchStart);
322 }
323
324 int ImageDecoder::scaledY(int origY, int searchStart)
325 {
326     return getScaledValue<Exact>(m_scaledRows, origY, searchStart);
327 }
328
329 }