Unreviewed, rolling out r213618.
[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 "TextStream.h"
35 #include <wtf/Forward.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/Optional.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 clearFrameBufferCache(size_t);
60     void clear(SharedBuffer* data);
61
62     bool ensureDecoderAvailable(SharedBuffer*);
63     bool isDecoderAvailable() const { return m_decoder.get(); }
64
65     void setData(SharedBuffer* data, bool allDataReceived);
66     bool dataChanged(SharedBuffer* data, bool allDataReceived);
67
68     unsigned decodedSize() const { return m_frameCache->decodedSize(); }
69     bool isAllDataReceived();
70
71     bool isAsyncDecodingRequired();
72     bool requestFrameAsyncDecodingAtIndex(size_t index, SubsamplingLevel subsamplingLevel, const IntSize& sizeForDrawing) { return m_frameCache->requestFrameAsyncDecodingAtIndex(index, subsamplingLevel, sizeForDrawing); }
73     bool hasDecodingQueue() const { return m_frameCache->hasDecodingQueue(); }
74     void stopAsyncDecodingQueue() { m_frameCache->stopAsyncDecodingQueue(); }
75
76     // Image metadata which is calculated by the decoder or can deduced by the case of the memory NativeImage.
77     bool isSizeAvailable() { return m_frameCache->isSizeAvailable(); }
78     size_t frameCount() { return m_frameCache->frameCount(); }
79     RepetitionCount repetitionCount() { return m_frameCache->repetitionCount(); }
80     String filenameExtension() { return m_frameCache->filenameExtension(); }
81     std::optional<IntPoint> hotSpot() { return m_frameCache->hotSpot(); }
82
83     // Image metadata which is calculated from the first ImageFrame.
84     IntSize size() { return m_frameCache->size(); }
85     IntSize sizeRespectingOrientation() { return m_frameCache->sizeRespectingOrientation(); }
86     Color singlePixelSolidColor() { return m_frameCache->singlePixelSolidColor(); }
87
88     // ImageFrame metadata which does not require caching the ImageFrame.
89     bool frameIsBeingDecodedAtIndex(size_t index, const std::optional<IntSize>& sizeForDrawing) { return m_frameCache->frameIsBeingDecodedAtIndex(index, sizeForDrawing); }
90     bool frameIsCompleteAtIndex(size_t index) { return m_frameCache->frameIsCompleteAtIndex(index); }
91     bool frameHasAlphaAtIndex(size_t index) { return m_frameCache->frameHasAlphaAtIndex(index); }
92     bool frameHasImageAtIndex(size_t index) { return m_frameCache->frameHasImageAtIndex(index); }
93     bool frameHasValidNativeImageAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel, const std::optional<IntSize>& sizeForDrawing) { return m_frameCache->frameHasValidNativeImageAtIndex(index, subsamplingLevel, sizeForDrawing); }
94     bool frameHasDecodedNativeImage(size_t index) { return m_frameCache->frameHasDecodedNativeImage(index); }
95     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) { return m_frameCache->frameSubsamplingLevelAtIndex(index); }
96
97     // ImageFrame metadata which forces caching or re-caching the ImageFrame.
98     IntSize frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache->frameSizeAtIndex(index, subsamplingLevel); }
99     unsigned frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache->frameBytesAtIndex(index, subsamplingLevel); }
100     float frameDurationAtIndex(size_t index) { return m_frameCache->frameDurationAtIndex(index); }
101     ImageOrientation frameOrientationAtIndex(size_t index) { return m_frameCache->frameOrientationAtIndex(index); }
102     NativeImagePtr frameImageAtIndex(size_t index, const std::optional<SubsamplingLevel>& = { }, const std::optional<IntSize>& sizeForDrawing = { }, const GraphicsContext* targetContext = nullptr);
103
104     SubsamplingLevel maximumSubsamplingLevel();
105     SubsamplingLevel subsamplingLevelForScale(float);
106     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
107
108 private:
109     void dump(TextStream&);
110
111     void setDecoderTargetContext(const GraphicsContext*);
112
113     Ref<ImageFrameCache> m_frameCache;
114     std::unique_ptr<ImageDecoder> m_decoder;
115
116     std::optional<SubsamplingLevel> m_maximumSubsamplingLevel;
117
118 #if PLATFORM(IOS)
119     // FIXME: We should expose a setting to enable/disable progressive loading so that we can remove the PLATFORM(IOS)-guard.
120     double m_progressiveLoadChunkTime { 0 };
121     uint16_t m_progressiveLoadChunkCount { 0 };
122 #endif
123
124     AlphaOption m_alphaOption { AlphaOption::Premultiplied };
125     GammaAndColorProfileOption m_gammaAndColorProfileOption { GammaAndColorProfileOption::Applied };
126 };
127
128 }