Ensure ImageFrameCache does not access its BitmapImage after it is deleted
[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 "URL.h"
36 #include <wtf/Forward.h>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/Optional.h>
39
40 namespace WebCore {
41
42 class GraphicsContext;
43 class ImageDecoder;
44 class ImageOrientation;
45 class IntPoint;
46 class IntSize;
47 class SharedBuffer;
48
49 class ImageSource {
50     WTF_MAKE_NONCOPYABLE(ImageSource);
51     friend class BitmapImage;
52 public:
53     ImageSource(NativeImagePtr&&);
54     ImageSource(Image*, AlphaOption = AlphaOption::Premultiplied, GammaAndColorProfileOption = GammaAndColorProfileOption::Applied);
55     ~ImageSource();
56
57     void destroyAllDecodedData() { m_frameCache->destroyAllDecodedData(); }
58     void destroyAllDecodedDataExcludeFrame(size_t excludeFrame) { m_frameCache->destroyAllDecodedDataExcludeFrame(excludeFrame); }
59     void destroyDecodedDataBeforeFrame(size_t beforeFrame) { m_frameCache->destroyDecodedDataBeforeFrame(beforeFrame); }
60     void destroyIncompleteDecodedData() { m_frameCache->destroyIncompleteDecodedData(); }
61     void clearImage() { m_frameCache->clearImage(); }
62     void clearFrameBufferCache(size_t);
63
64     bool ensureDecoderAvailable(SharedBuffer*);
65     bool isDecoderAvailable() const { return m_decoder.get(); }
66
67     void setData(SharedBuffer* data, bool allDataReceived);
68     void resetData(SharedBuffer* data);
69     EncodedDataStatus dataChanged(SharedBuffer* data, bool allDataReceived);
70
71     unsigned decodedSize() const { return m_frameCache->decodedSize(); }
72     bool isAllDataReceived();
73
74     bool shouldUseAsyncDecoding();
75     void requestFrameAsyncDecodingAtIndex(size_t index, SubsamplingLevel subsamplingLevel, const std::optional<IntSize>& sizeForDrawing = { }) { m_frameCache->requestFrameAsyncDecodingAtIndex(index, subsamplingLevel, sizeForDrawing); }
76     bool hasAsyncDecodingQueue() const { return m_frameCache->hasAsyncDecodingQueue(); }
77     bool isAsyncDecodingQueueIdle() const  { return m_frameCache->isAsyncDecodingQueueIdle(); }
78     void stopAsyncDecodingQueue() { m_frameCache->stopAsyncDecodingQueue(); }
79
80     // Image metadata which is calculated by the decoder or can deduced by the case of the memory NativeImage.
81     EncodedDataStatus encodedDataStatus() { return m_frameCache->encodedDataStatus(); }
82     size_t frameCount() { return m_frameCache->frameCount(); }
83     RepetitionCount repetitionCount() { return m_frameCache->repetitionCount(); }
84     String uti() { return m_frameCache->uti(); }
85     String filenameExtension() { return m_frameCache->filenameExtension(); }
86     std::optional<IntPoint> hotSpot() { return m_frameCache->hotSpot(); }
87
88     // Image metadata which is calculated from the first ImageFrame.
89     IntSize size() { return m_frameCache->size(); }
90     IntSize sizeRespectingOrientation() { return m_frameCache->sizeRespectingOrientation(); }
91     Color singlePixelSolidColor() { return m_frameCache->singlePixelSolidColor(); }
92
93     // ImageFrame metadata which does not require caching the ImageFrame.
94     bool frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(size_t index, const DecodingOptions& decodingOptions) { return m_frameCache->frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(index, decodingOptions); }
95     ImageFrame::DecodingStatus frameDecodingStatusAtIndex(size_t index) { return m_frameCache->frameDecodingStatusAtIndex(index); }
96     bool frameHasAlphaAtIndex(size_t index) { return m_frameCache->frameHasAlphaAtIndex(index); }
97     bool frameHasImageAtIndex(size_t index) { return m_frameCache->frameHasImageAtIndex(index); }
98     bool frameHasFullSizeNativeImageAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel) { return m_frameCache->frameHasFullSizeNativeImageAtIndex(index, subsamplingLevel); }
99     bool frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel, const DecodingOptions& decodingOptions) { return m_frameCache->frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(index, subsamplingLevel, decodingOptions); }
100     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) { return m_frameCache->frameSubsamplingLevelAtIndex(index); }
101
102     // ImageFrame metadata which forces caching or re-caching the ImageFrame.
103     IntSize frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache->frameSizeAtIndex(index, subsamplingLevel); }
104     unsigned frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel = SubsamplingLevel::Default) { return m_frameCache->frameBytesAtIndex(index, subsamplingLevel); }
105     float frameDurationAtIndex(size_t index) { return m_frameCache->frameDurationAtIndex(index); }
106     ImageOrientation frameOrientationAtIndex(size_t index) { return m_frameCache->frameOrientationAtIndex(index); }
107
108     NativeImagePtr frameImageAtIndex(size_t index) { return m_frameCache->frameImageAtIndex(index); }
109     NativeImagePtr frameImageAtIndexCacheIfNeeded(size_t, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* = nullptr);
110
111     SubsamplingLevel maximumSubsamplingLevel();
112     SubsamplingLevel subsamplingLevelForScaleFactor(GraphicsContext&, const FloatSize& scaleFactor);
113     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default);
114
115 private:
116     void dump(TextStream&);
117
118     void setDecoderTargetContext(const GraphicsContext*);
119
120     Ref<ImageFrameCache> m_frameCache;
121     RefPtr<ImageDecoder> m_decoder;
122
123     std::optional<SubsamplingLevel> m_maximumSubsamplingLevel;
124
125 #if PLATFORM(IOS)
126     // FIXME: We should expose a setting to enable/disable progressive loading so that we can remove the PLATFORM(IOS)-guard.
127     double m_progressiveLoadChunkTime { 0 };
128     uint16_t m_progressiveLoadChunkCount { 0 };
129 #endif
130
131     AlphaOption m_alphaOption { AlphaOption::Premultiplied };
132     GammaAndColorProfileOption m_gammaAndColorProfileOption { GammaAndColorProfileOption::Applied };
133 };
134
135 }