91863203bdc4bea6975b15bf1a1b94baf67cae68
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageSource.h
1 /*
2  * Copyright (C) 2004-2008, 2010, 2012, 2014, 2016 Apple Inc.  All rights reserved.
3  * Copyright (C) 2007-2008 Torch Mobile, Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "ImageFrame.h"
30 #include "ImageFrameCache.h"
31 #include "ImageOrientation.h"
32 #include "IntPoint.h"
33 #include "NativeImage.h"
34 #include <wtf/Forward.h>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/Optional.h>
37 #include <wtf/text/TextStream.h>
38
39 namespace WebCore {
40
41 class GraphicsContext;
42 class ImageDecoder;
43 class ImageOrientation;
44 class IntPoint;
45 class IntSize;
46 class SharedBuffer;
47
48 class ImageSource {
49     WTF_MAKE_NONCOPYABLE(ImageSource);
50     friend class BitmapImage;
51 public:
52     ImageSource(NativeImagePtr&&);
53     ImageSource(Image*, AlphaOption = AlphaOption::Premultiplied, GammaAndColorProfileOption = GammaAndColorProfileOption::Applied);
54     ~ImageSource();
55
56     void destroyAllDecodedData() { m_frameCache->destroyAllDecodedData(); }
57     void destroyAllDecodedDataExcludeFrame(size_t excludeFrame) { m_frameCache->destroyAllDecodedDataExcludeFrame(excludeFrame); }
58     void destroyDecodedDataBeforeFrame(size_t beforeFrame) { m_frameCache->destroyDecodedDataBeforeFrame(beforeFrame); }
59     void destroyIncompleteDecodedData() { m_frameCache->destroyIncompleteDecodedData(); }
60     void clearImage() { m_frameCache->clearImage(); }
61     void clearFrameBufferCache(size_t);
62
63     bool ensureDecoderAvailable(SharedBuffer*);
64     bool isDecoderAvailable() const { return m_decoder.get(); }
65
66     void setData(SharedBuffer* data, bool allDataReceived);
67     void resetData(SharedBuffer* data);
68     EncodedDataStatus dataChanged(SharedBuffer* data, bool allDataReceived);
69
70     unsigned decodedSize() const { return m_frameCache->decodedSize(); }
71     bool isAllDataReceived();
72
73     bool canUseAsyncDecoding();
74     void requestFrameAsyncDecodingAtIndex(size_t index, SubsamplingLevel subsamplingLevel, const std::optional<IntSize>& sizeForDrawing = { }) { m_frameCache->requestFrameAsyncDecodingAtIndex(index, subsamplingLevel, sizeForDrawing); }
75     bool hasAsyncDecodingQueue() const { return m_frameCache->hasAsyncDecodingQueue(); }
76     bool isAsyncDecodingQueueIdle() const  { return m_frameCache->isAsyncDecodingQueueIdle(); }
77     void stopAsyncDecodingQueue() { m_frameCache->stopAsyncDecodingQueue(); }
78
79     // Image metadata which is calculated by the decoder or can deduced by the case of the memory NativeImage.
80     EncodedDataStatus encodedDataStatus() { return m_frameCache->encodedDataStatus(); }
81     size_t frameCount() { return m_frameCache->frameCount(); }
82     RepetitionCount repetitionCount() { return m_frameCache->repetitionCount(); }
83     String uti() { return m_frameCache->uti(); }
84     String filenameExtension() { return m_frameCache->filenameExtension(); }
85     std::optional<IntPoint> hotSpot() { return m_frameCache->hotSpot(); }
86
87     // Image metadata which is calculated from the first ImageFrame.
88     IntSize size() { return m_frameCache->size(); }
89     IntSize sizeRespectingOrientation() { return m_frameCache->sizeRespectingOrientation(); }
90     Color singlePixelSolidColor() { return m_frameCache->singlePixelSolidColor(); }
91
92     // ImageFrame metadata which does not require caching the ImageFrame.
93     bool frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(size_t index, const DecodingOptions& decodingOptions) { return m_frameCache->frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(index, decodingOptions); }
94     DecodingStatus frameDecodingStatusAtIndex(size_t index) { return m_frameCache->frameDecodingStatusAtIndex(index); }
95     bool frameHasAlphaAtIndex(size_t index) { return m_frameCache->frameHasAlphaAtIndex(index); }
96     bool frameHasImageAtIndex(size_t index) { return m_frameCache->frameHasImageAtIndex(index); }
97     bool frameHasFullSizeNativeImageAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel) { return m_frameCache->frameHasFullSizeNativeImageAtIndex(index, subsamplingLevel); }
98     bool frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel, const DecodingOptions& decodingOptions) { return m_frameCache->frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(index, subsamplingLevel, decodingOptions); }
99     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) { return m_frameCache->frameSubsamplingLevelAtIndex(index); }
100
101     // ImageFrame metadata which forces caching or re-caching the ImageFrame.
102     IntSize frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache->frameSizeAtIndex(index, subsamplingLevel); }
103     unsigned frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache->frameBytesAtIndex(index, subsamplingLevel); }
104     float frameDurationAtIndex(size_t index) { return m_frameCache->frameDurationAtIndex(index); }
105     ImageOrientation frameOrientationAtIndex(size_t index) { return m_frameCache->frameOrientationAtIndex(index); }
106
107     NativeImagePtr frameImageAtIndex(size_t index) { return m_frameCache->frameImageAtIndex(index); }
108     NativeImagePtr frameImageAtIndexCacheIfNeeded(size_t, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* = nullptr);
109
110     SubsamplingLevel maximumSubsamplingLevel();
111     SubsamplingLevel subsamplingLevelForScaleFactor(GraphicsContext&, const FloatSize& scaleFactor);
112     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
113
114 private:
115     void dump(WTF::TextStream&);
116
117     void setDecoderTargetContext(const GraphicsContext*);
118
119     Ref<ImageFrameCache> m_frameCache;
120     RefPtr<ImageDecoder> m_decoder;
121
122     std::optional<SubsamplingLevel> m_maximumSubsamplingLevel;
123
124 #if PLATFORM(IOS)
125     // FIXME: We should expose a setting to enable/disable progressive loading so that we can remove the PLATFORM(IOS)-guard.
126     double m_progressiveLoadChunkTime { 0 };
127     uint16_t m_progressiveLoadChunkCount { 0 };
128 #endif
129
130     AlphaOption m_alphaOption { AlphaOption::Premultiplied };
131     GammaAndColorProfileOption m_gammaAndColorProfileOption { GammaAndColorProfileOption::Applied };
132 };
133
134 }