[WTF] Import std::optional reference implementation as WTF::Optional
[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 bool ICOImageDecoder::isSizeAvailable()
73 {
74     if (!ImageDecoder::isSizeAvailable())
75         decode(0, true);
76
77     return ImageDecoder::isSizeAvailable();
78 }
79
80 IntSize ICOImageDecoder::size()
81 {
82     return m_frameSize.isEmpty() ? ImageDecoder::size() : m_frameSize;
83 }
84
85 IntSize ICOImageDecoder::frameSizeAtIndex(size_t index, SubsamplingLevel)
86 {
87     return (index && (index < m_dirEntries.size())) ? m_dirEntries[index].m_size : size();
88 }
89
90 bool ICOImageDecoder::setSize(const IntSize& size)
91 {
92     // The size calculated inside the BMPImageReader had better match the one in
93     // the icon directory.
94     return m_frameSize.isEmpty() ? ImageDecoder::setSize(size) : ((size == m_frameSize) || setFailed());
95 }
96
97 size_t ICOImageDecoder::frameCount() const
98 {
99     const_cast<ICOImageDecoder*>(this)->decode(0, true);
100     return m_frameBufferCache.size();
101 }
102
103 ImageFrame* ICOImageDecoder::frameBufferAtIndex(size_t index)
104 {
105     // Ensure |index| is valid.
106     if (index >= frameCount())
107         return 0;
108
109     ImageFrame* buffer = &m_frameBufferCache[index];
110     if (!buffer->isComplete())
111         decode(index, false);
112     return buffer;
113 }
114
115 bool ICOImageDecoder::setFailed()
116 {
117     m_bmpReaders.clear();
118     m_pngDecoders.clear();
119     return ImageDecoder::setFailed();
120 }
121
122 std::optional<IntPoint> ICOImageDecoder::hotSpot() const
123 {
124     // When unspecified, the default frame is always frame 0. This is consistent with
125     // BitmapImage where currentFrame() starts at 0 and only increases when animation is
126     // requested.
127     return hotSpotAtIndex(0);
128 }
129
130 std::optional<IntPoint> ICOImageDecoder::hotSpotAtIndex(size_t index) const
131 {
132     if (index >= m_dirEntries.size() || m_fileType != CURSOR)
133         return std::nullopt;
134
135     return m_dirEntries[index].m_hotSpot;
136 }
137
138
139 // static
140 bool ICOImageDecoder::compareEntries(const IconDirectoryEntry& a, const IconDirectoryEntry& b)
141 {
142     // Larger icons are better.  After that, higher bit-depth icons are better.
143     const int aEntryArea = a.m_size.width() * a.m_size.height();
144     const int bEntryArea = b.m_size.width() * b.m_size.height();
145     return (aEntryArea == bEntryArea) ? (a.m_bitCount > b.m_bitCount) : (aEntryArea > bEntryArea);
146 }
147
148 void ICOImageDecoder::setDataForPNGDecoderAtIndex(size_t index)
149 {
150     if (!m_pngDecoders[index])
151         return;
152
153     const IconDirectoryEntry& dirEntry = m_dirEntries[index];
154     // Copy out PNG data to a separate vector and send to the PNG decoder.
155     // FIXME: Save this copy by making the PNG decoder able to take an
156     // optional offset.
157     RefPtr<SharedBuffer> pngData(SharedBuffer::create(&m_data->data()[dirEntry.m_imageOffset], m_data->size() - dirEntry.m_imageOffset));
158     m_pngDecoders[index]->setData(*pngData, isAllDataReceived());
159 }
160
161 void ICOImageDecoder::decode(size_t index, bool onlySize)
162 {
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].isComplete()) {
174         m_bmpReaders[index] = nullptr;
175         m_pngDecoders[index] = nullptr;
176     }
177     
178     if (m_frameBufferCache.isEmpty())
179         m_frameBufferCache.resize(m_dirEntries.size());
180     // CAUTION: We must not resize m_frameBufferCache again after this, as
181     // decodeAtIndex() may give a BMPImageReader a pointer to one of the
182     // entries.
183 }
184
185 bool ICOImageDecoder::decodeDirectory()
186 {
187     // Read and process directory.
188     if ((m_decodedOffset < sizeOfDirectory) && !processDirectory())
189         return false;
190
191     // Read and process directory entries.
192     return (m_decodedOffset >= (sizeOfDirectory + (m_dirEntries.size() * sizeOfDirEntry))) || processDirectoryEntries();
193 }
194
195 bool ICOImageDecoder::decodeAtIndex(size_t index)
196 {
197     ASSERT_WITH_SECURITY_IMPLICATION(index < m_dirEntries.size());
198     const IconDirectoryEntry& dirEntry = m_dirEntries[index];
199     const ImageType imageType = imageTypeAtIndex(index);
200     if (imageType == Unknown)
201         return false; // Not enough data to determine image type yet.
202
203     if (imageType == BMP) {
204         if (!m_bmpReaders[index]) {
205             // We need to have already sized m_frameBufferCache before this, and
206             // we must not resize it again later (see caution in frameCount()).
207             ASSERT(m_frameBufferCache.size() == m_dirEntries.size());
208             m_bmpReaders[index] = std::make_unique<BMPImageReader>(this, dirEntry.m_imageOffset, 0, true);
209             m_bmpReaders[index]->setData(m_data.get());
210             m_bmpReaders[index]->setBuffer(&m_frameBufferCache[index]);
211         }
212         m_frameSize = dirEntry.m_size;
213         bool result = m_bmpReaders[index]->decodeBMP(false);
214         m_frameSize = IntSize();
215         return result;
216     }
217
218     if (!m_pngDecoders[index]) {
219         m_pngDecoders[index] = std::make_unique<
220             PNGImageDecoder>(m_premultiplyAlpha ? AlphaOption::Premultiplied : AlphaOption::NotPremultiplied,
221                 m_ignoreGammaAndColorProfile ? GammaAndColorProfileOption::Ignored : GammaAndColorProfileOption::Applied);
222         setDataForPNGDecoderAtIndex(index);
223     }
224     // Fail if the size the PNGImageDecoder calculated does not match the size
225     // in the directory.
226     if (m_pngDecoders[index]->isSizeAvailable() && (m_pngDecoders[index]->size() != dirEntry.m_size))
227         return setFailed();
228     m_frameBufferCache[index] = *m_pngDecoders[index]->frameBufferAtIndex(0);
229     return !m_pngDecoders[index]->failed() || setFailed();
230 }
231
232 bool ICOImageDecoder::processDirectory()
233 {
234     // Read directory.
235     ASSERT(!m_decodedOffset);
236     if (m_data->size() < sizeOfDirectory)
237         return false;
238     const uint16_t fileType = readUint16(2);
239     const uint16_t idCount = readUint16(4);
240     m_decodedOffset = sizeOfDirectory;
241
242     // See if this is an icon filetype we understand, and make sure we have at
243     // least one entry in the directory.
244     if (((fileType != ICON) && (fileType != CURSOR)) || (!idCount))
245         return setFailed();
246
247     m_fileType = static_cast<FileType>(fileType);
248
249     // Enlarge member vectors to hold all the entries.
250     m_dirEntries.resize(idCount);
251     m_bmpReaders.resize(idCount);
252     m_pngDecoders.resize(idCount);
253     return true;
254 }
255
256 bool ICOImageDecoder::processDirectoryEntries()
257 {
258     // Read directory entries.
259     ASSERT(m_decodedOffset == sizeOfDirectory);
260     if ((m_decodedOffset > m_data->size()) || ((m_data->size() - m_decodedOffset) < (m_dirEntries.size() * sizeOfDirEntry)))
261         return false;
262     for (IconDirectoryEntries::iterator i(m_dirEntries.begin()); i != m_dirEntries.end(); ++i)
263         *i = readDirectoryEntry();  // Updates m_decodedOffset.
264
265     // Make sure the specified image offsets are past the end of the directory
266     // entries.
267     for (IconDirectoryEntries::iterator i(m_dirEntries.begin()); i != m_dirEntries.end(); ++i) {
268         if (i->m_imageOffset < m_decodedOffset)
269             return setFailed();
270     }
271
272     // Arrange frames in decreasing quality order.
273     std::sort(m_dirEntries.begin(), m_dirEntries.end(), compareEntries);
274
275     // The image size is the size of the largest entry.
276     const IconDirectoryEntry& dirEntry = m_dirEntries.first();
277     // Technically, this next call shouldn't be able to fail, since the width
278     // and height here are each <= 256, and |m_frameSize| is empty.
279     return setSize(dirEntry.m_size);
280 }
281
282 ICOImageDecoder::IconDirectoryEntry ICOImageDecoder::readDirectoryEntry()
283 {
284     // Read icon data.
285     // The casts to uint8_t in the next few lines are because that's the on-disk
286     // type of the width and height values.  Storing them in ints (instead of
287     // matching uint8_ts) is so we can record dimensions of size 256 (which is
288     // what a zero byte really means).
289     int width = static_cast<uint8_t>(m_data->data()[m_decodedOffset]);
290     if (!width)
291         width = 256;
292     int height = static_cast<uint8_t>(m_data->data()[m_decodedOffset + 1]);
293     if (!height)
294         height = 256;
295     IconDirectoryEntry entry;
296     entry.m_size = IntSize(width, height);
297     if (m_fileType == CURSOR) {
298         entry.m_bitCount = 0;
299         entry.m_hotSpot = IntPoint(readUint16(4), readUint16(6));
300     } else {
301         entry.m_bitCount = readUint16(6);
302         entry.m_hotSpot = IntPoint();
303     }
304     entry.m_imageOffset = readUint32(12);
305
306     // Some icons don't have a bit depth, only a color count.  Convert the
307     // color count to the minimum necessary bit depth.  It doesn't matter if
308     // this isn't quite what the bitmap info header says later, as we only use
309     // this value to determine which icon entry is best.
310     if (!entry.m_bitCount) {
311         int colorCount = static_cast<uint8_t>(m_data->data()[m_decodedOffset + 2]);
312         if (!colorCount)
313             colorCount = 256;  // Vague in the spec, needed by real-world icons.
314         for (--colorCount; colorCount; colorCount >>= 1)
315             ++entry.m_bitCount;
316     }
317
318     m_decodedOffset += sizeOfDirEntry;
319     return entry;
320 }
321
322 ICOImageDecoder::ImageType ICOImageDecoder::imageTypeAtIndex(size_t index)
323 {
324     // Check if this entry is a BMP or a PNG; we need 4 bytes to check the magic
325     // number.
326     ASSERT_WITH_SECURITY_IMPLICATION(index < m_dirEntries.size());
327     const uint32_t imageOffset = m_dirEntries[index].m_imageOffset;
328     if ((imageOffset > m_data->size()) || ((m_data->size() - imageOffset) < 4))
329         return Unknown;
330     return strncmp(&m_data->data()[imageOffset], "\x89PNG", 4) ? BMP : PNG;
331 }
332
333 }