5ffcd9e291d980ad444494f1e73062d89b5a63ba
[WebKit-https.git] / Source / WebCore / platform / graphics / cg / ImageDecoderCG.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 "ImageSourceCG.h"
29 #include "IntSize.h"
30
31 #include <wtf/Optional.h>
32
33 typedef struct CGImageSource* CGImageSourceRef;
34 typedef const struct __CFData* CFDataRef;
35
36 namespace WebCore {
37
38 class ImageDecoder {
39     WTF_MAKE_FAST_ALLOCATED;
40 public:
41     ImageDecoder(AlphaOption, GammaAndColorProfileOption);
42
43     static std::unique_ptr<ImageDecoder> create(const SharedBuffer&, AlphaOption alphaOption, GammaAndColorProfileOption gammaAndColorProfileOption)
44     {
45         return std::make_unique<ImageDecoder>(alphaOption, gammaAndColorProfileOption);
46     }
47     
48     static size_t bytesDecodedToDetermineProperties();
49
50     bool isSizeAvailable() const;
51     size_t frameCount() const;
52     RepetitionCount repetitionCount() const;
53     String filenameExtension() const;
54     std::optional<IntPoint> hotSpot() const;
55
56     IntSize frameSizeAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default) const;
57     bool frameIsCompleteAtIndex(size_t) const;
58     ImageOrientation frameOrientationAtIndex(size_t) const;
59     
60     float frameDurationAtIndex(size_t) const;
61     bool frameHasAlphaAtIndex(size_t) const;
62     bool frameAllowSubsamplingAtIndex(size_t) const;
63     unsigned frameBytesAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default) const;
64     
65     NativeImagePtr createFrameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default, const std::optional<IntSize>& sizeForDrawing = { }) const;
66     
67     void setData(SharedBuffer&, bool allDataReceived);
68     bool isAllDataReceived() const { return m_isAllDataReceived; }
69     void clearFrameBufferCache(size_t) { }
70     
71 protected:
72     bool m_isAllDataReceived { false };
73     RetainPtr<CGImageSourceRef> m_nativeDecoder;
74 };
75
76 }