[Chromium] Add trace events for decoding and drawing images.
[WebKit-https.git] / Source / WebCore / platform / image-decoders / ico / ICOImageDecoder.cpp
1 /*
2  * Copyright (c) 2008, 2009, Google Inc. All rights reserved.
3  * 
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  * 
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  * 
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "ICOImageDecoder.h"
33
34 #include <algorithm>
35
36 #include "BMPImageReader.h"
37 #include "PNGImageDecoder.h"
38 #include <wtf/PassOwnPtr.h>
39
40 #if PLATFORM(CHROMIUM)
41 #include "TraceEvent.h"
42 #endif
43
44 namespace WebCore {
45
46 // Number of bits in .ICO/.CUR used to store the directory and its entries,
47 // respectively (doesn't match sizeof values for member structs since we omit
48 // some fields).
49 static const size_t sizeOfDirectory = 6;
50 static const size_t sizeOfDirEntry = 16;
51
52 ICOImageDecoder::ICOImageDecoder(ImageSource::AlphaOption alphaOption,
53                                  ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
54     : ImageDecoder(alphaOption, gammaAndColorProfileOption)
55     , m_decodedOffset(0)
56 {
57 }
58
59 ICOImageDecoder::~ICOImageDecoder()
60 {
61 }
62
63 void ICOImageDecoder::setData(SharedBuffer* data, bool allDataReceived)
64 {
65     if (failed())
66         return;
67
68     ImageDecoder::setData(data, allDataReceived);
69
70     for (BMPReaders::iterator i(m_bmpReaders.begin()); i != m_bmpReaders.end(); ++i) {
71         if (*i)
72             (*i)->setData(data);
73     }
74     for (size_t i = 0; i < m_pngDecoders.size(); ++i)
75         setDataForPNGDecoderAtIndex(i);
76 }
77
78 bool ICOImageDecoder::isSizeAvailable()
79 {
80     if (!ImageDecoder::isSizeAvailable())
81         decode(0, true);
82
83     return ImageDecoder::isSizeAvailable();
84 }
85
86 IntSize ICOImageDecoder::size() const
87 {
88     return m_frameSize.isEmpty() ? ImageDecoder::size() : m_frameSize;
89 }
90
91 IntSize ICOImageDecoder::frameSizeAtIndex(size_t index) const
92 {
93     return (index && (index < m_dirEntries.size())) ? m_dirEntries[index].m_size : size();
94 }
95
96 bool ICOImageDecoder::setSize(unsigned width, unsigned height)
97 {
98     // The size calculated inside the BMPImageReader had better match the one in
99     // the icon directory.
100     return m_frameSize.isEmpty() ? ImageDecoder::setSize(width, height) : ((IntSize(width, height) == m_frameSize) || setFailed());
101 }
102
103 size_t ICOImageDecoder::frameCount()
104 {
105     decode(0, true);
106     if (m_frameBufferCache.isEmpty()) {
107         m_frameBufferCache.resize(m_dirEntries.size());
108         for (size_t i = 0; i < m_dirEntries.size(); ++i)
109             m_frameBufferCache[i].setPremultiplyAlpha(m_premultiplyAlpha);
110     }
111     // CAUTION: We must not resize m_frameBufferCache again after this, as
112     // decodeAtIndex() may give a BMPImageReader a pointer to one of the
113     // entries.
114     return m_frameBufferCache.size();
115 }
116
117 ImageFrame* ICOImageDecoder::frameBufferAtIndex(size_t index)
118 {
119     // Ensure |index| is valid.
120     if (index >= frameCount())
121         return 0;
122
123     ImageFrame* buffer = &m_frameBufferCache[index];
124     if (buffer->status() != ImageFrame::FrameComplete)
125         decode(index, false);
126     return buffer;
127 }
128
129 bool ICOImageDecoder::setFailed()
130 {
131     m_bmpReaders.clear();
132     m_pngDecoders.clear();
133     return ImageDecoder::setFailed();
134 }
135
136 // static
137 bool ICOImageDecoder::compareEntries(const IconDirectoryEntry& a, const IconDirectoryEntry& b)
138 {
139     // Larger icons are better.  After that, higher bit-depth icons are better.
140     const int aEntryArea = a.m_size.width() * a.m_size.height();
141     const int bEntryArea = b.m_size.width() * b.m_size.height();
142     return (aEntryArea == bEntryArea) ? (a.m_bitCount > b.m_bitCount) : (aEntryArea > bEntryArea);
143 }
144
145 void ICOImageDecoder::setDataForPNGDecoderAtIndex(size_t index)
146 {
147     if (!m_pngDecoders[index])
148         return;
149
150     const IconDirectoryEntry& dirEntry = m_dirEntries[index];
151     // Copy out PNG data to a separate vector and send to the PNG decoder.
152     // FIXME: Save this copy by making the PNG decoder able to take an
153     // optional offset.
154     RefPtr<SharedBuffer> pngData(SharedBuffer::create(&m_data->data()[dirEntry.m_imageOffset], m_data->size() - dirEntry.m_imageOffset));
155     m_pngDecoders[index]->setData(pngData.get(), isAllDataReceived());
156 }
157
158 void ICOImageDecoder::decode(size_t index, bool onlySize)
159 {
160 #if PLATFORM(CHROMIUM)
161     TRACE_EVENT("ICOImageDecoder::decode", this, 0);
162 #endif
163     if (failed())
164         return;
165
166     // If we couldn't decode the image but we've received all the data, decoding
167     // has failed.
168     if ((!decodeDirectory() || (!onlySize && !decodeAtIndex(index))) && isAllDataReceived())
169         setFailed();
170     // If we're done decoding this frame, we don't need the BMPImageReader or
171     // PNGImageDecoder anymore.  (If we failed, these have already been
172     // cleared.)
173     else if ((m_frameBufferCache.size() > index) && (m_frameBufferCache[index].status() == ImageFrame::FrameComplete)) {
174         m_bmpReaders[index].clear();
175         m_pngDecoders[index].clear();
176     }
177 }
178
179 bool ICOImageDecoder::decodeDirectory()
180 {
181     // Read and process directory.
182     if ((m_decodedOffset < sizeOfDirectory) && !processDirectory())
183         return false;
184
185     // Read and process directory entries.
186     return (m_decodedOffset >= (sizeOfDirectory + (m_dirEntries.size() * sizeOfDirEntry))) || processDirectoryEntries();
187 }
188
189 bool ICOImageDecoder::decodeAtIndex(size_t index)
190 {
191     ASSERT(index < m_dirEntries.size());
192     const IconDirectoryEntry& dirEntry = m_dirEntries[index];
193     const ImageType imageType = imageTypeAtIndex(index);
194     if (imageType == Unknown)
195         return false; // Not enough data to determine image type yet.
196
197     if (imageType == BMP) {
198         if (!m_bmpReaders[index]) {
199             // We need to have already sized m_frameBufferCache before this, and
200             // we must not resize it again later (see caution in frameCount()).
201             ASSERT(m_frameBufferCache.size() == m_dirEntries.size());
202             m_bmpReaders[index] = adoptPtr(new BMPImageReader(this, dirEntry.m_imageOffset, 0, true));
203             m_bmpReaders[index]->setData(m_data.get());
204             m_bmpReaders[index]->setBuffer(&m_frameBufferCache[index]);
205         }
206         m_frameSize = dirEntry.m_size;
207         bool result = m_bmpReaders[index]->decodeBMP(false);
208         m_frameSize = IntSize();
209         return result;
210     }
211
212     if (!m_pngDecoders[index]) {
213         m_pngDecoders[index] = adoptPtr(
214             new PNGImageDecoder(m_premultiplyAlpha ? ImageSource::AlphaPremultiplied : ImageSource::AlphaNotPremultiplied,
215                                 m_ignoreGammaAndColorProfile ? ImageSource::GammaAndColorProfileIgnored : ImageSource::GammaAndColorProfileApplied));
216         setDataForPNGDecoderAtIndex(index);
217     }
218     // Fail if the size the PNGImageDecoder calculated does not match the size
219     // in the directory.
220     if (m_pngDecoders[index]->isSizeAvailable() && (m_pngDecoders[index]->size() != dirEntry.m_size))
221         return setFailed();
222     m_frameBufferCache[index] = *m_pngDecoders[index]->frameBufferAtIndex(0);
223     return !m_pngDecoders[index]->failed() || setFailed();
224 }
225
226 bool ICOImageDecoder::processDirectory()
227 {
228     // Read directory.
229     ASSERT(!m_decodedOffset);
230     if (m_data->size() < sizeOfDirectory)
231         return false;
232     const uint16_t fileType = readUint16(2);
233     const uint16_t idCount = readUint16(4);
234     m_decodedOffset = sizeOfDirectory;
235
236     // See if this is an icon filetype we understand, and make sure we have at
237     // least one entry in the directory.
238     enum {
239         ICON = 1,
240         CURSOR = 2,
241     };
242     if (((fileType != ICON) && (fileType != CURSOR)) || (!idCount))
243         return setFailed();
244
245     // Enlarge member vectors to hold all the entries.
246     m_dirEntries.resize(idCount);
247     m_bmpReaders.resize(idCount);
248     m_pngDecoders.resize(idCount);
249     return true;
250 }
251
252 bool ICOImageDecoder::processDirectoryEntries()
253 {
254     // Read directory entries.
255     ASSERT(m_decodedOffset == sizeOfDirectory);
256     if ((m_decodedOffset > m_data->size()) || ((m_data->size() - m_decodedOffset) < (m_dirEntries.size() * sizeOfDirEntry)))
257         return false;
258     for (IconDirectoryEntries::iterator i(m_dirEntries.begin()); i != m_dirEntries.end(); ++i)
259         *i = readDirectoryEntry();  // Updates m_decodedOffset.
260
261     // Make sure the specified image offsets are past the end of the directory
262     // entries.
263     for (IconDirectoryEntries::iterator i(m_dirEntries.begin()); i != m_dirEntries.end(); ++i) {
264         if (i->m_imageOffset < m_decodedOffset)
265             return setFailed();
266     }
267
268     // Arrange frames in decreasing quality order.
269     std::sort(m_dirEntries.begin(), m_dirEntries.end(), compareEntries);
270
271     // The image size is the size of the largest entry.
272     const IconDirectoryEntry& dirEntry = m_dirEntries.first();
273     // Technically, this next call shouldn't be able to fail, since the width
274     // and height here are each <= 256, and |m_frameSize| is empty.
275     return setSize(dirEntry.m_size.width(), dirEntry.m_size.height());
276 }
277
278 ICOImageDecoder::IconDirectoryEntry ICOImageDecoder::readDirectoryEntry()
279 {
280     // Read icon data.
281     // The casts to uint8_t in the next few lines are because that's the on-disk
282     // type of the width and height values.  Storing them in ints (instead of
283     // matching uint8_ts) is so we can record dimensions of size 256 (which is
284     // what a zero byte really means).
285     int width = static_cast<uint8_t>(m_data->data()[m_decodedOffset]);
286     if (!width)
287         width = 256;
288     int height = static_cast<uint8_t>(m_data->data()[m_decodedOffset + 1]);
289     if (!height)
290         height = 256;
291     IconDirectoryEntry entry;
292     entry.m_size = IntSize(width, height);
293     entry.m_bitCount = readUint16(6);
294     entry.m_imageOffset = readUint32(12);
295
296     // Some icons don't have a bit depth, only a color count.  Convert the
297     // color count to the minimum necessary bit depth.  It doesn't matter if
298     // this isn't quite what the bitmap info header says later, as we only use
299     // this value to determine which icon entry is best.
300     if (!entry.m_bitCount) {
301         int colorCount = static_cast<uint8_t>(m_data->data()[m_decodedOffset + 2]);
302         if (!colorCount)
303             colorCount = 256;  // Vague in the spec, needed by real-world icons.
304         for (--colorCount; colorCount; colorCount >>= 1)
305             ++entry.m_bitCount;
306     }
307
308     m_decodedOffset += sizeOfDirEntry;
309     return entry;
310 }
311
312 ICOImageDecoder::ImageType ICOImageDecoder::imageTypeAtIndex(size_t index)
313 {
314     // Check if this entry is a BMP or a PNG; we need 4 bytes to check the magic
315     // number.
316     ASSERT(index < m_dirEntries.size());
317     const uint32_t imageOffset = m_dirEntries[index].m_imageOffset;
318     if ((imageOffset > m_data->size()) || ((m_data->size() - imageOffset) < 4))
319         return Unknown;
320     return strncmp(&m_data->data()[imageOffset], "\x89PNG", 4) ? BMP : PNG;
321 }
322
323 }