xref: /aosp_15_r20/external/skia/include/codec/SkGifDecoder.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1 /*
2  * Copyright 2023 Google LLC
3  *
4  * Use of this source code is governed by a BSD-style license that can be
5  * found in the LICENSE file.
6  */
7 #ifndef SkGifDecoder_DEFINED
8 #define SkGifDecoder_DEFINED
9 
10 #include "include/codec/SkCodec.h"
11 #include "include/core/SkRefCnt.h"
12 #include "include/private/base/SkAPI.h"
13 
14 class SkData;
15 class SkStream;
16 
17 #include <memory>
18 
19 namespace SkGifDecoder {
20 
21 /** Returns true if this data claims to be a GIF image. */
22 SK_API bool IsGif(const void*, size_t);
23 
24 /**
25  *  Attempts to decode the given bytes as a GIF.
26  *
27  *  If the bytes are not a GIF, returns nullptr.
28  *
29  *  DecodeContext is ignored
30  */
31 SK_API std::unique_ptr<SkCodec> Decode(std::unique_ptr<SkStream>,
32                                        SkCodec::Result*,
33                                        SkCodecs::DecodeContext = nullptr);
34 SK_API std::unique_ptr<SkCodec> Decode(sk_sp<SkData>,
35                                        SkCodec::Result*,
36                                        SkCodecs::DecodeContext = nullptr);
37 
Decoder()38 inline constexpr SkCodecs::Decoder Decoder() {
39     return { "gif", IsGif, Decode };
40 }
41 
42 }  // namespace SkGifDecoder
43 
44 #endif  // SkGifDecoder_DEFINED
45