[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / platform / image-decoders / ico / ICOImageDecoder.h
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 #pragma once
32
33 #include "BMPImageReader.h"
34
35 namespace WebCore {
36
37     class PNGImageDecoder;
38
39     // This class decodes the ICO and CUR image formats.
40     class ICOImageDecoder final : public ImageDecoder {
41     public:
42         ICOImageDecoder(AlphaOption, GammaAndColorProfileOption);
43         virtual ~ICOImageDecoder();
44
45         // ImageDecoder
46         String filenameExtension() const override { return "ico"; }
47         void setData(SharedBuffer&, bool allDataReceived) override;
48         bool isSizeAvailable() override;
49         IntSize size() override;
50         IntSize frameSizeAtIndex(size_t, SubsamplingLevel) override;
51         bool setSize(const IntSize&) override;
52         size_t frameCount() const override;
53         ImageFrame* frameBufferAtIndex(size_t) override;
54         // CAUTION: setFailed() deletes all readers and decoders.  Be careful to
55         // avoid accessing deleted memory, especially when calling this from
56         // inside BMPImageReader!
57         bool setFailed() override;
58         std::optional<IntPoint> hotSpot() const override;
59
60     private:
61         enum ImageType {
62             Unknown,
63             BMP,
64             PNG,
65         };
66
67         enum FileType {
68             ICON = 1,
69             CURSOR = 2,
70         };
71
72         struct IconDirectoryEntry {
73             IntSize m_size;
74             uint16_t m_bitCount;
75             IntPoint m_hotSpot;
76             uint32_t m_imageOffset;
77         };
78
79         // Returns true if |a| is a preferable icon entry to |b|.
80         // Larger sizes, or greater bitdepths at the same size, are preferable.
81         static bool compareEntries(const IconDirectoryEntry& a, const IconDirectoryEntry& b);
82
83         inline uint16_t readUint16(int offset) const
84         {
85             return BMPImageReader::readUint16(m_data.get(), m_decodedOffset + offset);
86         }
87
88         inline uint32_t readUint32(int offset) const
89         {
90             return BMPImageReader::readUint32(m_data.get(), m_decodedOffset + offset);
91         }
92
93         // If the desired PNGImageDecoder exists, gives it the appropriate data.
94         void setDataForPNGDecoderAtIndex(size_t);
95
96         // Decodes the entry at |index|.  If |onlySize| is true, stops decoding
97         // after calculating the image size.  If decoding fails but there is no
98         // more data coming, sets the "decode failure" flag.
99         void decode(size_t index, bool onlySize);
100
101         // Decodes the directory and directory entries at the beginning of the
102         // data, and initializes members.  Returns true if all decoding
103         // succeeded.  Once this returns true, all entries' sizes are known.
104         bool decodeDirectory();
105
106         // Decodes the specified entry.
107         bool decodeAtIndex(size_t);
108
109         // Processes the ICONDIR at the beginning of the data.  Returns true if
110         // the directory could be decoded.
111         bool processDirectory();
112
113         // Processes the ICONDIRENTRY records after the directory.  Keeps the
114         // "best" entry as the one we'll decode.  Returns true if the entries
115         // could be decoded.
116         bool processDirectoryEntries();
117
118         // Returns the hot-spot for |index|, returns std::nullopt if there is none.
119         std::optional<IntPoint> hotSpotAtIndex(size_t) const;
120
121         // Reads and returns a directory entry from the current offset into
122         // |data|.
123         IconDirectoryEntry readDirectoryEntry();
124
125         // Determines whether the desired entry is a BMP or PNG.  Returns true
126         // if the type could be determined.
127         ImageType imageTypeAtIndex(size_t);
128
129         // An index into |m_data| representing how much we've already decoded.
130         // Note that this only tracks data _this_ class decodes; once the
131         // BMPImageReader takes over this will not be updated further.
132         size_t m_decodedOffset;
133
134         // Which type of file (ICO/CUR) this is.
135         FileType m_fileType;
136
137         // The headers for the ICO.
138         typedef Vector<IconDirectoryEntry> IconDirectoryEntries;
139         IconDirectoryEntries m_dirEntries;
140
141         // The image decoders for the various frames.
142         typedef Vector<std::unique_ptr<BMPImageReader>> BMPReaders;
143         BMPReaders m_bmpReaders;
144         typedef Vector<std::unique_ptr<PNGImageDecoder>> PNGDecoders;
145         PNGDecoders m_pngDecoders;
146
147         // Valid only while a BMPImageReader is decoding, this holds the size
148         // for the particular entry being decoded.
149         IntSize m_frameSize;
150     };
151
152 } // namespace WebCore