xref: /aosp_15_r20/external/libdav1d/src/ref.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_SRC_REF_H
29 #define DAV1D_SRC_REF_H
30 
31 #include "dav1d/dav1d.h"
32 
33 #include "src/mem.h"
34 #include "src/thread.h"
35 
36 #include <stdatomic.h>
37 #include <stddef.h>
38 
39 struct Dav1dRef {
40     void *data;
41     const void *const_data;
42     atomic_int ref_cnt;
43     int free_ref;
44     void (*free_callback)(const uint8_t *data, void *user_data);
45     void *user_data;
46 };
47 
48 #if !TRACK_HEAP_ALLOCATIONS
49 #define dav1d_ref_create(type, size) dav1d_ref_create(size)
50 #endif
51 
52 Dav1dRef *dav1d_ref_create(enum AllocationType type, size_t size);
53 Dav1dRef *dav1d_ref_create_using_pool(Dav1dMemPool *pool, size_t size);
54 void dav1d_ref_dec(Dav1dRef **ref);
55 
dav1d_ref_init(Dav1dRef * const ref,const void * const ptr,void (* const free_callback)(const uint8_t * data,void * user_data),void * const user_data,const int free_ref)56 static inline Dav1dRef *dav1d_ref_init(Dav1dRef *const ref, const void *const ptr,
57                                        void (*const free_callback)(const uint8_t *data, void *user_data),
58                                        void *const user_data, const int free_ref)
59 {
60     ref->data = NULL;
61     ref->const_data = ptr;
62     atomic_init(&ref->ref_cnt, 1);
63     ref->free_ref = free_ref;
64     ref->free_callback = free_callback;
65     ref->user_data = user_data;
66     return ref;
67 }
68 
dav1d_ref_inc(Dav1dRef * const ref)69 static inline void dav1d_ref_inc(Dav1dRef *const ref) {
70     atomic_fetch_add_explicit(&ref->ref_cnt, 1, memory_order_relaxed);
71 }
72 
dav1d_ref_is_writable(Dav1dRef * const ref)73 static inline int dav1d_ref_is_writable(Dav1dRef *const ref) {
74     return atomic_load(&ref->ref_cnt) == 1 && ref->data;
75 }
76 
77 #endif /* DAV1D_SRC_REF_H */
78