xref: /aosp_15_r20/external/libdav1d/include/dav1d/common.h (revision c09093415860a1c2373dacd84c4fde00c507cdfd)
1 /*
2  * Copyright © 2018, VideoLAN and dav1d authors
3  * Copyright © 2018, Two Orioles, LLC
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  *    list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  *    this list of conditions and the following disclaimer in the documentation
14  *    and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef DAV1D_COMMON_H
29 #define DAV1D_COMMON_H
30 
31 #include <errno.h>
32 #include <stddef.h>
33 #include <stdint.h>
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 #ifndef DAV1D_API
40     #if defined _WIN32
41       #if defined DAV1D_BUILDING_DLL
42         #define DAV1D_API __declspec(dllexport)
43       #else
44         #define DAV1D_API
45       #endif
46     #else
47       #if __GNUC__ >= 4
48         #define DAV1D_API __attribute__ ((visibility ("default")))
49       #else
50         #define DAV1D_API
51       #endif
52     #endif
53 #endif
54 
55 #if EPERM > 0
56 #define DAV1D_ERR(e) (-(e)) ///< Negate POSIX error code.
57 #else
58 #define DAV1D_ERR(e) (e)
59 #endif
60 
61 /**
62  * A reference-counted object wrapper for a user-configurable pointer.
63  */
64 typedef struct Dav1dUserData {
65     const uint8_t *data; ///< data pointer
66     struct Dav1dRef *ref; ///< allocation origin
67 } Dav1dUserData;
68 
69 /**
70  * Input packet metadata which are copied from the input data used to
71  * decode each image into the matching structure of the output image
72  * returned back to the user. Since these are metadata fields, they
73  * can be used for other purposes than the documented ones, they will
74  * still be passed from input data to output picture without being
75  * used internally.
76  */
77 typedef struct Dav1dDataProps {
78     int64_t timestamp; ///< container timestamp of input data, INT64_MIN if unknown (default)
79     int64_t duration; ///< container duration of input data, 0 if unknown (default)
80     int64_t offset; ///< stream offset of input data, -1 if unknown (default)
81     size_t size; ///< packet size, default Dav1dData.sz
82     struct Dav1dUserData user_data; ///< user-configurable data, default NULL members
83 } Dav1dDataProps;
84 
85 /**
86  * Release reference to a Dav1dDataProps.
87  */
88 DAV1D_API void dav1d_data_props_unref(Dav1dDataProps *props);
89 
90 #ifdef __cplusplus
91 } /* extern "C" */
92 #endif
93 
94 #endif /* DAV1D_COMMON_H */
95