REGRESSION(r215211): [GTK] Several webgl related tests are failing
[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
39 namespace WebCore {
40
41 // Number of bits in .ICO/.CUR used to store the directory and its entries,
42 // respectively (doesn't match sizeof values for member structs since we omit
43 // some fields).
44 static const size_t sizeOfDirectory = 6;
45 static const size_t sizeOfDirEntry = 16;
46
47 ICOImageDecoder::ICOImageDecoder(AlphaOption alphaOption, GammaAndColorProfileOption gammaAndColorProfileOption)
48     : ImageDecoder(alphaOption, gammaAndColorProfileOption)
49     , m_decodedOffset(0)
50 {
51 }
52
53 ICOImageDecoder::~ICOImageDecoder()
54 {
55 }
56
57 void ICOImageDecoder::setData(SharedBuffer& data, bool allDataReceived)
58 {
59     if (failed())
60         return;
61
62     ImageDecoder::setData(data, allDataReceived);
63
64     for (BMPReaders::iterator i(m_bmpReaders.begin()); i != m_bmpReaders.end(); ++i) {
65         if (*i)
66             (*i)->setData(&data);
67     }
68     for (size_t i = 0; i < m_pngDecoders.size(); ++i)
69         setDataForPNGDecoderAtIndex(i);
70 }
71
72 IntSize ICOImageDecoder::size()
73 {
74     return m_frameSize.isEmpty() ? ImageDecoder::size() : m_frameSize;
75 }
76
77 IntSize ICOImageDecoder::frameSizeAtIndex(size_t index, SubsamplingLevel)
78 {
79     return (index && (index < m_dirEntries.size())) ? m_dirEntries[index].m_size : size();
80 }
81
82 bool ICOImageDecoder::setSize(const IntSize& size)
83 {
84     // The size calculated inside the BMPImageReader had better match the one in
85     // the icon directory.
86     return m_frameSize.isEmpty() ? ImageDecoder::setSize(size) : ((size == m_frameSize) || setFailed());
87 }
88
89 size_t ICOImageDecoder::frameCount() const
90 {
91     const_cast<ICOImageDecoder*>(this)->decode(0, true, isAllDataReceived());
92     return m_frameBufferCache.size();
93 }
94
95 ImageFrame* ICOImageDecoder::frameBufferAtIndex(size_t index)
96 {
97     // Ensure |index| is valid.
98     if (index >= frameCount())
99         return 0;
100
101     ImageFrame* buffer = &m_frameBufferCache[index];
102     if (!buffer->isComplete())
103         decode(index, false, isAllDataReceived());
104     return buffer;
105 }
106
107 bool ICOImageDecoder::setFailed()
108 {
109     m_bmpReaders.clear();
110     m_pngDecoders.clear();
111     return ImageDecoder::setFailed();
112 }
113
114 std::optional<IntPoint> ICOImageDecoder::hotSpot() const
115 {
116     // When unspecified, the default frame is always frame 0. This is consistent with
117     // BitmapImage where currentFrame() starts at 0 and only increases when animation is
118     // requested.
119     return hotSpotAtIndex(0);
120 }
121
122 std::optional<IntPoint> ICOImageDecoder::hotSpotAtIndex(size_t index) const
123 {
124     if (index >= m_dirEntries.size() || m_fileType != CURSOR)
125         return std::nullopt;
126
127     return m_dirEntries[index].m_hotSpot;
128 }
129
130
131 // static
132 bool ICOImageDecoder::compareEntries(const IconDirectoryEntry& a, const IconDirectoryEntry& b)
133 {
134     // Larger icons are better.  After that, higher bit-depth icons are better.
135     const int aEntryArea = a.m_size.width() * a.m_size.height();
136     const int bEntryArea = b.m_size.width() * b.m_size.height();
137     return (aEntryArea == bEntryArea) ? (a.m_bitCount > b.m_bitCount) : (aEntryArea > bEntryArea);
138 }
139
140 void ICOImageDecoder::setDataForPNGDecoderAtIndex(size_t index)
141 {
142     if (!m_pngDecoders[index])
143         return;
144
145     const IconDirectoryEntry& dirEntry = m_dirEntries[index];
146     // Copy out PNG data to a separate vector and send to the PNG decoder.
147     // FIXME: Save this copy by making the PNG decoder able to take an
148     // optional offset.
149     RefPtr<SharedBuffer> pngData(SharedBuffer::create(&m_data->data()[dirEntry.m_imageOffset], m_data->size() - dirEntry.m_imageOffset));
150     m_pngDecoders[index]->setData(*pngData, isAllDataReceived());
151 }
152
153 void ICOImageDecoder::decode(size_t index, bool onlySize, bool allDataReceived)
154 {
155     if (failed())
156         return;
157
158     // If we couldn't decode the image but we've received all the data, decoding
159     // has failed.
160     if ((!decodeDirectory() || (!onlySize && !decodeAtIndex(index))) && allDataReceived)
161         setFailed();
162     // If we're done decoding this frame, we don't need the BMPImageReader or
163     // PNGImageDecoder anymore.  (If we failed, these have already been
164     // cleared.)
165     else if ((m_frameBufferCache.size() > index) && m_frameBufferCache[index].isComplete()) {
166         m_bmpReaders[index] = nullptr;
167         m_pngDecoders[index] = nullptr;
168     }
169     
170     if (m_frameBufferCache.isEmpty())
171         m_frameBufferCache.resize(m_dirEntries.size());
172     // CAUTION: We must not resize m_frameBufferCache again after this, as
173     // decodeAtIndex() may give a BMPImageReader a pointer to one of the
174     // entries.
175 }
176
177 bool ICOImageDecoder::decodeDirectory()
178 {
179     // Read and process directory.
180     if ((m_decodedOffset < sizeOfDirectory) && !processDirectory())
181         return false;
182
183     // Read and process directory entries.
184     return (m_decodedOffset >= (sizeOfDirectory + (m_dirEntries.size() * sizeOfDirEntry))) || processDirectoryEntries();
185 }
186
187 bool ICOImageDecoder::decodeAtIndex(size_t index)
188 {
189     ASSERT_WITH_SECURITY_IMPLICATION(index < m_dirEntries.size());
190     const IconDirectoryEntry& dirEntry = m_dirEntries[index];
191     const ImageType imageType = imageTypeAtIndex(index);
192     if (imageType == Unknown)
193         return false; // Not enough data to determine image type yet.
194
195     if (imageType == BMP) {
196         if (!m_bmpReaders[index]) {
197             // We need to have already sized m_frameBufferCache before this, and
198             // we must not resize it again later (see caution in frameCount()).
199             ASSERT(m_frameBufferCache.size() == m_dirEntries.size());
200             m_bmpReaders[index] = std::make_unique<BMPImageReader>(this, dirEntry.m_imageOffset, 0, true);
201             m_bmpReaders[index]->setData(m_data.get());
202             m_bmpReaders[index]->setBuffer(&m_frameBufferCache[index]);
203         }
204         m_frameSize = dirEntry.m_size;
205         bool result = m_bmpReaders[index]->decodeBMP(false);
206         m_frameSize = IntSize();
207         return result;
208     }
209
210     if (!m_pngDecoders[index]) {
211         m_pngDecoders[index] = PNGImageDecoder::create(m_premultiplyAlpha ? AlphaOption::Premultiplied : AlphaOption::NotPremultiplied, m_ignoreGammaAndColorProfile ? GammaAndColorProfileOption::Ignored : GammaAndColorProfileOption::Applied);
212         setDataForPNGDecoderAtIndex(index);
213     }
214     // Fail if the size the PNGImageDecoder calculated does not match the size
215     // in the directory.
216     if (m_pngDecoders[index]->encodedDataStatus() >= EncodedDataStatus::SizeAvailable && (m_pngDecoders[index]->size() != dirEntry.m_size))
217         return setFailed();
218     m_frameBufferCache[index] = *m_pngDecoders[index]->frameBufferAtIndex(0);
219     return !m_pngDecoders[index]->failed() || setFailed();
220 }
221
222 bool ICOImageDecoder::processDirectory()
223 {
224     // Read directory.
225     ASSERT(!m_decodedOffset);
226     if (m_data->size() < sizeOfDirectory)
227         return false;
228     const uint16_t fileType = readUint16(2);
229     const uint16_t idCount = readUint16(4);
230     m_decodedOffset = sizeOfDirectory;
231
232     // See if this is an icon filetype we understand, and make sure we have at
233     // least one entry in the directory.
234     if (((fileType != ICON) && (fileType != CURSOR)) || (!idCount))
235         return setFailed();
236
237     m_fileType = static_cast<FileType>(fileType);
238
239     // Enlarge member vectors to hold all the entries.
240     m_dirEntries.resize(idCount);
241     m_bmpReaders.resize(idCount);
242     m_pngDecoders.resize(idCount);
243     return true;
244 }
245
246 bool ICOImageDecoder::processDirectoryEntries()
247 {
248     // Read directory entries.
249     ASSERT(m_decodedOffset == sizeOfDirectory);
250     if ((m_decodedOffset > m_data->size()) || ((m_data->size() - m_decodedOffset) < (m_dirEntries.size() * sizeOfDirEntry)))
251         return false;
252     for (IconDirectoryEntries::iterator i(m_dirEntries.begin()); i != m_dirEntries.end(); ++i)
253         *i = readDirectoryEntry();  // Updates m_decodedOffset.
254
255     // Make sure the specified image offsets are past the end of the directory
256     // entries.
257     for (IconDirectoryEntries::iterator i(m_dirEntries.begin()); i != m_dirEntries.end(); ++i) {
258         if (i->m_imageOffset < m_decodedOffset)
259             return setFailed();
260     }
261
262     // Arrange frames in decreasing quality order.
263     std::sort(m_dirEntries.begin(), m_dirEntries.end(), compareEntries);
264
265     // The image size is the size of the largest entry.
266     const IconDirectoryEntry& dirEntry = m_dirEntries.first();
267     // Technically, this next call shouldn't be able to fail, since the width
268     // and height here are each <= 256, and |m_frameSize| is empty.
269     return setSize(dirEntry.m_size);
270 }
271
272 ICOImageDecoder::IconDirectoryEntry ICOImageDecoder::readDirectoryEntry()
273 {
274     // Read icon data.
275     // The casts to uint8_t in the next few lines are because that's the on-disk
276     // type of the width and height values.  Storing them in ints (instead of
277     // matching uint8_ts) is so we can record dimensions of size 256 (which is
278     // what a zero byte really means).
279     int width = static_cast<uint8_t>(m_data->data()[m_decodedOffset]);
280     if (!width)
281         width = 256;
282     int height = static_cast<uint8_t>(m_data->data()[m_decodedOffset + 1]);
283     if (!height)
284         height = 256;
285     IconDirectoryEntry entry;
286     entry.m_size = IntSize(width, height);
287     if (m_fileType == CURSOR) {
288         entry.m_bitCount = 0;
289         entry.m_hotSpot = IntPoint(readUint16(4), readUint16(6));
290     } else {
291         entry.m_bitCount = readUint16(6);
292         entry.m_hotSpot = IntPoint();
293     }
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_WITH_SECURITY_IMPLICATION(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 }