Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageSource.h
1 /*
2  * Copyright (C) 2016-2017 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "ImageFrame.h"
29
30 #include <wtf/Forward.h>
31 #include <wtf/Optional.h>
32 #include <wtf/SynchronizedFixedQueue.h>
33 #include <wtf/WorkQueue.h>
34 #include <wtf/text/TextStream.h>
35
36 namespace WebCore {
37
38 class BitmapImage;
39 class GraphicsContext;
40 class ImageDecoder;
41
42 class ImageSource : public ThreadSafeRefCounted<ImageSource> {
43     friend class BitmapImage;
44 public:
45     ~ImageSource();
46
47     static Ref<ImageSource> create(BitmapImage* image, AlphaOption alphaOption = AlphaOption::Premultiplied, GammaAndColorProfileOption gammaAndColorProfileOption = GammaAndColorProfileOption::Applied)
48     {
49         return adoptRef(*new ImageSource(image, alphaOption, gammaAndColorProfileOption));
50     }
51
52     static Ref<ImageSource> create(NativeImagePtr&& nativeImage)
53     {
54         return adoptRef(*new ImageSource(WTFMove(nativeImage)));
55     }
56
57     void setData(SharedBuffer* data, bool allDataReceived);
58     void resetData(SharedBuffer* data);
59     EncodedDataStatus dataChanged(SharedBuffer* data, bool allDataReceived);
60     bool isAllDataReceived();
61
62     unsigned decodedSize() const { return m_decodedSize; }
63     void destroyAllDecodedData() { destroyDecodedData(frameCount(), frameCount()); }
64     void destroyAllDecodedDataExcludeFrame(size_t excludeFrame) { destroyDecodedData(frameCount(), excludeFrame); }
65     void destroyDecodedDataBeforeFrame(size_t beforeFrame) { destroyDecodedData(beforeFrame, beforeFrame); }
66     void destroyIncompleteDecodedData();
67     void clearFrameBufferCache(size_t beforeFrame);
68
69     void growFrames();
70     void clearMetadata();
71     void clearImage() { m_image = nullptr; }
72     URL sourceURL() const;
73     String mimeType() const;
74     long long expectedContentLength() const;
75
76     // Asynchronous image decoding
77     bool canUseAsyncDecoding();
78     void startAsyncDecodingQueue();
79     void requestFrameAsyncDecodingAtIndex(size_t, SubsamplingLevel, const std::optional<IntSize>& = { });
80     void stopAsyncDecodingQueue();
81     bool hasAsyncDecodingQueue() const { return m_decodingQueue; }
82     bool isAsyncDecodingQueueIdle() const;
83     void setFrameDecodingDurationForTesting(Seconds duration) { m_frameDecodingDurationForTesting = duration; }
84     Seconds frameDecodingDurationForTesting() const { return m_frameDecodingDurationForTesting; }
85
86     // Image metadata which is calculated either by the ImageDecoder or directly
87     // from the NativeImage if this class was created for a memory image.
88     EncodedDataStatus encodedDataStatus();
89     bool isSizeAvailable() { return encodedDataStatus() >= EncodedDataStatus::SizeAvailable; }
90     size_t frameCount();
91     RepetitionCount repetitionCount();
92     String uti();
93     String filenameExtension();
94     std::optional<IntPoint> hotSpot();
95
96     // Image metadata which is calculated from the first ImageFrame.
97     WEBCORE_EXPORT IntSize size();
98     IntSize sizeRespectingOrientation();
99     Color singlePixelSolidColor();
100     SubsamplingLevel maximumSubsamplingLevel();
101
102     // ImageFrame metadata which does not require caching the ImageFrame.
103     bool frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(size_t, const DecodingOptions&);
104     DecodingStatus frameDecodingStatusAtIndex(size_t);
105     bool frameHasAlphaAtIndex(size_t);
106     bool frameHasImageAtIndex(size_t);
107     bool frameHasFullSizeNativeImageAtIndex(size_t, const std::optional<SubsamplingLevel>&);
108     bool frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(size_t, const std::optional<SubsamplingLevel>&, const DecodingOptions&);
109     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t);
110
111     // ImageFrame metadata which forces caching or re-caching the ImageFrame.
112     IntSize frameSizeAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
113     unsigned frameBytesAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
114     Seconds frameDurationAtIndex(size_t);
115     ImageOrientation frameOrientationAtIndex(size_t);
116
117 #if USE(DIRECT2D)
118     void setTargetContext(const GraphicsContext*);
119 #endif
120     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
121     NativeImagePtr frameImageAtIndex(size_t);
122     NativeImagePtr frameImageAtIndexCacheIfNeeded(size_t, SubsamplingLevel = SubsamplingLevel::Default);
123
124 private:
125     ImageSource(BitmapImage*, AlphaOption = AlphaOption::Premultiplied, GammaAndColorProfileOption = GammaAndColorProfileOption::Applied);
126     ImageSource(NativeImagePtr&&);
127
128     template<typename T, T (ImageDecoder::*functor)() const>
129     T metadata(const T& defaultValue, std::optional<T>* cachedValue = nullptr);
130
131     template<typename T, typename... Args>
132     T frameMetadataAtIndex(size_t, T (ImageFrame::*functor)(Args...) const, Args&&...);
133
134     template<typename T, typename... Args>
135     T frameMetadataAtIndexCacheIfNeeded(size_t, T (ImageFrame::*functor)() const,  std::optional<T>* cachedValue, Args&&...);
136
137     bool ensureDecoderAvailable(SharedBuffer* data);
138     bool isDecoderAvailable() const { return m_decoder; }
139     void destroyDecodedData(size_t frameCount, size_t excludeFrame);
140     void decodedSizeChanged(long long decodedSize);
141     void didDecodeProperties(unsigned decodedPropertiesSize);
142     void decodedSizeIncreased(unsigned decodedSize);
143     void decodedSizeDecreased(unsigned decodedSize);
144     void decodedSizeReset(unsigned decodedSize);
145
146     void setNativeImage(NativeImagePtr&&);
147     void cacheMetadataAtIndex(size_t, SubsamplingLevel, DecodingStatus = DecodingStatus::Invalid);
148     void cacheNativeImageAtIndex(NativeImagePtr&&, size_t, SubsamplingLevel, const DecodingOptions&, DecodingStatus = DecodingStatus::Invalid);
149     void cacheNativeImageAtIndexAsync(NativeImagePtr&&, size_t, SubsamplingLevel, const DecodingOptions&, DecodingStatus);
150
151     struct ImageFrameRequest;
152     static const int BufferSize = 8;
153     WorkQueue& decodingQueue();
154     SynchronizedFixedQueue<ImageFrameRequest, BufferSize>& frameRequestQueue();
155
156     const ImageFrame& frameAtIndexCacheIfNeeded(size_t, ImageFrame::Caching, const std::optional<SubsamplingLevel>& = { });
157
158     void dump(TextStream&);
159
160     BitmapImage* m_image { nullptr };
161     RefPtr<ImageDecoder> m_decoder;
162     AlphaOption m_alphaOption { AlphaOption::Premultiplied };
163     GammaAndColorProfileOption m_gammaAndColorProfileOption { GammaAndColorProfileOption::Applied };
164
165     unsigned m_decodedSize { 0 };
166     unsigned m_decodedPropertiesSize { 0 };
167     Vector<ImageFrame, 1> m_frames;
168
169     // Asynchronous image decoding.
170     struct ImageFrameRequest {
171         size_t index;
172         SubsamplingLevel subsamplingLevel;
173         DecodingOptions decodingOptions;
174         DecodingStatus decodingStatus;
175         bool operator==(const ImageFrameRequest& other) const
176         {
177             return index == other.index && subsamplingLevel == other.subsamplingLevel && decodingOptions == other.decodingOptions && decodingStatus == other.decodingStatus;
178         }
179     };
180     using FrameRequestQueue = SynchronizedFixedQueue<ImageFrameRequest, BufferSize>;
181     using FrameCommitQueue = Deque<ImageFrameRequest, BufferSize>;
182     RefPtr<FrameRequestQueue> m_frameRequestQueue;
183     FrameCommitQueue m_frameCommitQueue;
184     RefPtr<WorkQueue> m_decodingQueue;
185     Seconds m_frameDecodingDurationForTesting;
186
187     // Image metadata.
188     std::optional<EncodedDataStatus> m_encodedDataStatus;
189     std::optional<size_t> m_frameCount;
190     std::optional<RepetitionCount> m_repetitionCount;
191     std::optional<String> m_uti;
192     std::optional<String> m_filenameExtension;
193     std::optional<std::optional<IntPoint>> m_hotSpot;
194
195     // Image metadata which is calculated from the first ImageFrame.
196     std::optional<IntSize> m_size;
197     std::optional<IntSize> m_sizeRespectingOrientation;
198     std::optional<Color> m_singlePixelSolidColor;
199     std::optional<SubsamplingLevel> m_maximumSubsamplingLevel;
200 };
201
202 }