dav1d
dav1d.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2018-2021, 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_H
29 #define DAV1D_H
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 #include <errno.h>
36 #include <stdarg.h>
37 
38 #include "common.h"
39 #include "picture.h"
40 #include "data.h"
41 #include "version.h"
42 
43 typedef struct Dav1dContext Dav1dContext;
44 typedef struct Dav1dRef Dav1dRef;
45 
46 #define DAV1D_MAX_THREADS 256
47 #define DAV1D_MAX_FRAME_DELAY 256
48 
49 typedef struct Dav1dLogger {
50  void *cookie;
51 
58  void (*callback)(void *cookie, const char *format, va_list ap);
59 } Dav1dLogger;
60 
69 };
70 
71 typedef struct Dav1dSettings {
72  int n_threads;
76  int all_layers;
77  unsigned frame_size_limit;
88  uint8_t reserved[20];
91 
95 DAV1D_API const char *dav1d_version(void);
96 
103 
116 DAV1D_API int dav1d_open(Dav1dContext **c_out, const Dav1dSettings *s);
117 
137  const uint8_t *buf, const size_t sz);
138 
155 
207 
227  const Dav1dPicture *in);
228 
234 DAV1D_API void dav1d_close(Dav1dContext **c_out);
235 
247 
260 };
261 
276 
289 
290 # ifdef __cplusplus
291 }
292 # endif
293 
294 #endif /* DAV1D_H */
DAV1D_API void dav1d_flush(Dav1dContext *c)
int operating_point
select an operating point for scalable AV1 bitstreams (0 - 31, default 0)
Definition: dav1d.h:75
int apply_grain
whether to apply film grain on output frames (default 1)
Definition: dav1d.h:74
Definition: data.h:36
DAV1D_API int dav1d_apply_grain(Dav1dContext *c, Dav1dPicture *out, const Dav1dPicture *in)
Definition: common.h:73
enum Dav1dInloopFilterType inloop_filters
Definition: dav1d.h:87
Definition: dav1d.h:64
Definition: picture.h:49
uint8_t reserved[20]
reserved for future use
Definition: dav1d.h:89
Definition: dav1d.h:254
DAV1D_API int dav1d_send_data(Dav1dContext *c, Dav1dData *in)
Definition: dav1d.h:49
int all_layers
output all spatial layers of a scalable AV1 biststream (default 1)
Definition: dav1d.h:76
DAV1D_API int dav1d_parse_sequence_header(Dav1dSequenceHeader *out, const uint8_t *buf, const size_t sz)
Dav1dPicAllocator allocator
Picture allocator callback.
Definition: dav1d.h:78
Dav1dLogger logger
Logger callback.
Definition: dav1d.h:79
Definition: headers.h:203
DAV1D_API void dav1d_default_settings(Dav1dSettings *s)
DAV1D_API const char * dav1d_version(void)
struct Dav1dContext Dav1dContext
Definition: dav1d.h:43
Definition: dav1d.h:65
DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out)
int strict_std_compliance
Definition: dav1d.h:80
Definition: picture.h:98
void * cookie
Custom data to pass to the callback.
Definition: dav1d.h:50
DAV1D_API int dav1d_open(Dav1dContext **c_out, const Dav1dSettings *s)
Definition: dav1d.h:63
DAV1D_API void dav1d_close(Dav1dContext **c_out)
DAV1D_API int dav1d_get_decode_error_data_props(Dav1dContext *c, Dav1dDataProps *out)
Dav1dEventFlags
Definition: dav1d.h:248
void(* callback)(void *cookie, const char *format, va_list ap)
Definition: dav1d.h:58
DAV1D_API int dav1d_get_event_flags(Dav1dContext *c, enum Dav1dEventFlags *flags)
int output_invisible_frames
Definition: dav1d.h:83
int n_threads
number of threads (0 = number of logical cores in host system, default 0)
Definition: dav1d.h:72
Definition: dav1d.h:66
int max_frame_delay
Set to 1 for low-latency decoding (0 = ceil(sqrt(n_threads)), default 0)
Definition: dav1d.h:73
Definition: dav1d.h:62
Dav1dInloopFilterType
Definition: dav1d.h:61
Definition: dav1d.h:71
unsigned frame_size_limit
maximum frame size, in pixels (0 = unlimited, default 0)
Definition: dav1d.h:77
struct Dav1dRef Dav1dRef
Definition: dav1d.h:44
#define DAV1D_API
Definition: common.h:46