ccdf7f156277ed591aa538093d54ca641ce71d20
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageSource.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 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 #if USE(DIRECT2D)
63     void setRenderTarget(GraphicsContext&);
64 #endif
65
66     void setData(SharedBuffer* data, bool allDataReceived);
67     bool dataChanged(SharedBuffer* data, bool allDataReceived);
68
69     unsigned decodedSize() const { return m_frameCache.decodedSize(); }
70     bool isAllDataReceived();
71
72     // Image metadata which is calculated by the decoder or can deduced by the case of the memory NativeImage.
73     bool isSizeAvailable() { return m_frameCache.isSizeAvailable(); }
74     size_t frameCount() { return m_frameCache.frameCount(); }
75     RepetitionCount repetitionCount() { return m_frameCache.repetitionCount(); }
76     String filenameExtension() { return m_frameCache.filenameExtension(); }
77     Optional<IntPoint> hotSpot() { return m_frameCache.hotSpot(); }
78
79     // Image metadata which is calculated from the first ImageFrame.
80     IntSize size() { return m_frameCache.size(); }
81     IntSize sizeRespectingOrientation() { return m_frameCache.sizeRespectingOrientation(); }
82     Color singlePixelSolidColor() { return m_frameCache.singlePixelSolidColor(); }
83
84     // ImageFrame metadata which does not require caching the ImageFrame.
85     bool frameIsCompleteAtIndex(size_t index) { return m_frameCache.frameIsCompleteAtIndex(index); }
86     bool frameHasAlphaAtIndex(size_t index) { return m_frameCache.frameHasAlphaAtIndex(index); }
87     bool frameHasImageAtIndex(size_t index) { return m_frameCache.frameHasImageAtIndex(index); }
88     bool frameHasInvalidNativeImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) { return m_frameCache.frameHasInvalidNativeImageAtIndex(index, subsamplingLevel); }
89     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) { return m_frameCache.frameSubsamplingLevelAtIndex(index); }
90
91     // ImageFrame metadata which forces caching or re-caching the ImageFrame.
92     IntSize frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache.frameSizeAtIndex(index, subsamplingLevel); }
93     unsigned frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache.frameBytesAtIndex(index, subsamplingLevel); }
94     float frameDurationAtIndex(size_t index) { return m_frameCache.frameDurationAtIndex(index); }
95     ImageOrientation frameOrientationAtIndex(size_t index) { return m_frameCache.frameOrientationAtIndex(index); }
96     NativeImagePtr frameImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache.frameImageAtIndex(index, subsamplingLevel); }
97
98     SubsamplingLevel maximumSubsamplingLevel();
99     SubsamplingLevel subsamplingLevelForScale(float);
100     void setAllowSubsampling(bool allowSubsampling) { m_allowSubsampling = allowSubsampling; }
101     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
102
103 private:
104     void clearFrameBufferCache(size_t);
105     void clear(bool destroyAll, size_t count, SharedBuffer* data);
106     void dump(TextStream&);
107     
108     ImageFrameCache m_frameCache;
109     std::unique_ptr<ImageDecoder> m_decoder;
110
111     Optional<SubsamplingLevel> m_maximumSubsamplingLevel;
112
113     // The default value of m_allowSubsampling should be the same as defaultImageSubsamplingEnabled in Settings.cpp
114 #if PLATFORM(IOS)
115     bool m_allowSubsampling { true };
116 #else
117     bool m_allowSubsampling { false };
118 #endif
119
120 #if PLATFORM(IOS)
121     // FIXME: We should expose a setting to enable/disable progressive loading so that we can remove the PLATFORM(IOS)-guard.
122     double m_progressiveLoadChunkTime { 0 };
123     uint16_t m_progressiveLoadChunkCount { 0 };
124 #endif
125
126     AlphaOption m_alphaOption { AlphaOption::Premultiplied };
127     GammaAndColorProfileOption m_gammaAndColorProfileOption { GammaAndColorProfileOption::Applied };
128 };
129
130 }