[Win][Direct2D] Implement basic SVG support
[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 destroyDecodedData(SharedBuffer* data, bool destroyAll = true, size_t count = 0);
57     bool destroyDecodedDataIfNecessary(SharedBuffer* data, bool destroyAll = true, size_t count = 0);
58
59     bool ensureDecoderAvailable(SharedBuffer*);
60     bool isDecoderAvailable() const { return m_decoder.get(); }
61
62     void setData(SharedBuffer* data, bool allDataReceived);
63     bool dataChanged(SharedBuffer* data, bool allDataReceived);
64
65     unsigned decodedSize() const { return m_frameCache.decodedSize(); }
66     bool isAllDataReceived();
67
68     // Image metadata which is calculated by the decoder or can deduced by the case of the memory NativeImage.
69     bool isSizeAvailable() { return m_frameCache.isSizeAvailable(); }
70     size_t frameCount() { return m_frameCache.frameCount(); }
71     RepetitionCount repetitionCount() { return m_frameCache.repetitionCount(); }
72     String filenameExtension() { return m_frameCache.filenameExtension(); }
73     Optional<IntPoint> hotSpot() { return m_frameCache.hotSpot(); }
74
75     // Image metadata which is calculated from the first ImageFrame.
76     IntSize size() { return m_frameCache.size(); }
77     IntSize sizeRespectingOrientation() { return m_frameCache.sizeRespectingOrientation(); }
78     Color singlePixelSolidColor() { return m_frameCache.singlePixelSolidColor(); }
79
80     // ImageFrame metadata which does not require caching the ImageFrame.
81     bool frameIsCompleteAtIndex(size_t index) { return m_frameCache.frameIsCompleteAtIndex(index); }
82     bool frameHasAlphaAtIndex(size_t index) { return m_frameCache.frameHasAlphaAtIndex(index); }
83     bool frameHasImageAtIndex(size_t index) { return m_frameCache.frameHasImageAtIndex(index); }
84     bool frameHasInvalidNativeImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) { return m_frameCache.frameHasInvalidNativeImageAtIndex(index, subsamplingLevel); }
85     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) { return m_frameCache.frameSubsamplingLevelAtIndex(index); }
86
87     // ImageFrame metadata which forces caching or re-caching the ImageFrame.
88     IntSize frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache.frameSizeAtIndex(index, subsamplingLevel); }
89     unsigned frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache.frameBytesAtIndex(index, subsamplingLevel); }
90     float frameDurationAtIndex(size_t index) { return m_frameCache.frameDurationAtIndex(index); }
91     ImageOrientation frameOrientationAtIndex(size_t index) { return m_frameCache.frameOrientationAtIndex(index); }
92     NativeImagePtr frameImageAtIndex(size_t index, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* targetContext = nullptr);
93
94     SubsamplingLevel maximumSubsamplingLevel();
95     SubsamplingLevel subsamplingLevelForScale(float);
96     void setAllowSubsampling(bool allowSubsampling) { m_allowSubsampling = allowSubsampling; }
97     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
98
99 private:
100     void clearFrameBufferCache(size_t);
101     void clear(bool destroyAll, size_t count, SharedBuffer* data);
102     void dump(TextStream&);
103
104     void setDecoderTargetContext(const GraphicsContext*);
105
106     ImageFrameCache m_frameCache;
107     std::unique_ptr<ImageDecoder> m_decoder;
108
109     Optional<SubsamplingLevel> m_maximumSubsamplingLevel;
110
111     // The default value of m_allowSubsampling should be the same as defaultImageSubsamplingEnabled in Settings.cpp
112 #if PLATFORM(IOS)
113     bool m_allowSubsampling { true };
114 #else
115     bool m_allowSubsampling { false };
116 #endif
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 }