ImageDecoder can be deleted while the async decoder thread is still using it
[WebKit-https.git] / Source / WebCore / platform / graphics / win / ImageDecoderDirect2D.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "COMPtr.h"
29 #include "ImageSource.h"
30 #include "IntSize.h"
31 #include <wtf/Optional.h>
32
33 interface ID2D1RenderTarget;
34 interface IWICBitmapDecoder;
35 interface IWICImagingFactory;
36
37 namespace WebCore {
38
39 class ImageDecoder : public RefCounted<ImageDecoder> {
40     WTF_MAKE_FAST_ALLOCATED;
41 public:
42     ImageDecoder();
43     
44     static Ref<ImageDecoder> create(const SharedBuffer&, AlphaOption, GammaAndColorProfileOption)
45     {
46         return adoptRef(*new ImageDecoder());
47     }
48     
49     static size_t bytesDecodedToDetermineProperties();
50     
51     String filenameExtension() const;
52     bool isSizeAvailable() const;
53     
54     // Always original size, without subsampling.
55     IntSize size() const;
56     size_t frameCount() const;
57
58     RepetitionCount repetitionCount() const;
59     std::optional<IntPoint> hotSpot() const;
60     
61     IntSize frameSizeAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default) const;
62     bool frameIsCompleteAtIndex(size_t) const;
63     ImageOrientation frameOrientationAtIndex(size_t) const;
64     
65     float frameDurationAtIndex(size_t) const;
66     bool frameHasAlphaAtIndex(size_t) const;
67     bool frameAllowSubsamplingAtIndex(size_t) const;
68     unsigned frameBytesAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default) const;
69     
70     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default, const std::optional<IntSize>& sizeForDraw = { }) const;
71     
72     void setData(SharedBuffer&, bool allDataReceived);
73     bool isAllDataReceived() const { return m_isAllDataReceived; }
74     void clearFrameBufferCache(size_t) { }
75
76     void setTargetContext(ID2D1RenderTarget*);
77
78     static IWICImagingFactory* systemImagingFactory();
79
80 protected:
81     bool m_isAllDataReceived { false };
82     mutable IntSize m_size;
83     COMPtr<IWICBitmapDecoder> m_nativeDecoder;
84     COMPtr<ID2D1RenderTarget> m_renderTarget;
85 };
86
87 }