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