xref: /aosp_15_r20/external/libdav1d/include/dav1d/data.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_DATA_H
29 #define DAV1D_DATA_H
30 
31 #include <stddef.h>
32 #include <stdint.h>
33 
34 #include "common.h"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 typedef struct Dav1dData {
41     const uint8_t *data; ///< data pointer
42     size_t sz; ///< data size
43     struct Dav1dRef *ref; ///< allocation origin
44     Dav1dDataProps m; ///< user provided metadata passed to the output picture
45 } Dav1dData;
46 
47 /**
48  * Allocate data.
49  *
50  * @param data Input context.
51  * @param   sz Size of the data that should be allocated.
52  *
53  * @return Pointer to the allocated buffer on success. NULL on error.
54  */
55 DAV1D_API uint8_t * dav1d_data_create(Dav1dData *data, size_t sz);
56 
57 /**
58  * Wrap an existing data array.
59  *
60  * @param          data Input context.
61  * @param           buf The data to be wrapped.
62  * @param            sz Size of the data.
63  * @param free_callback Function to be called when we release our last
64  *                      reference to this data. In this callback, $buf will be
65  *                      the $buf argument to this function, and $cookie will
66  *                      be the $cookie input argument to this function.
67  * @param        cookie Opaque parameter passed to free_callback().
68  *
69  * @return 0 on success. A negative DAV1D_ERR value on error.
70  */
71 DAV1D_API int dav1d_data_wrap(Dav1dData *data, const uint8_t *buf, size_t sz,
72                               void (*free_callback)(const uint8_t *buf, void *cookie),
73                               void *cookie);
74 
75 /**
76  * Wrap a user-provided data pointer into a reference counted object.
77  *
78  * data->m.user_data field will initialized to wrap the provided $user_data
79  * pointer.
80  *
81  * $free_callback will be called on the same thread that released the last
82  * reference. If frame threading is used, make sure $free_callback is
83  * thread-safe.
84  *
85  * @param          data Input context.
86  * @param     user_data The user data to be wrapped.
87  * @param free_callback Function to be called when we release our last
88  *                      reference to this data. In this callback, $user_data
89  *                      will be the $user_data argument to this function, and
90  *                      $cookie will be the $cookie input argument to this
91  *                      function.
92  * @param        cookie Opaque parameter passed to $free_callback.
93  *
94  * @return 0 on success. A negative DAV1D_ERR value on error.
95  */
96 DAV1D_API int dav1d_data_wrap_user_data(Dav1dData *data,
97                                         const uint8_t *user_data,
98                                         void (*free_callback)(const uint8_t *user_data,
99                                                               void *cookie),
100                                         void *cookie);
101 
102 /**
103  * Free the data reference.
104  *
105  * The reference count for data->m.user_data will be decremented (if it has been
106  * initialized with dav1d_data_wrap_user_data). The $data object will be memset
107  * to 0.
108  *
109  * @param data Input context.
110  */
111 DAV1D_API void dav1d_data_unref(Dav1dData *data);
112 
113 #ifdef __cplusplus
114 } /* extern "C" */
115 #endif
116 
117 #endif /* DAV1D_DATA_H */
118