dav1d  1.4.0
dav1d is an AV1 decoder
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 #include <errno.h>
32 #include <stdarg.h>
33 
34 #include "common.h"
35 #include "picture.h"
36 #include "data.h"
37 #include "version.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
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;
58  void (*callback)(void *cookie, const char *format, va_list ap);
59 } Dav1dLogger;
60 
69 };
70 
76 };
77 
78 typedef struct Dav1dSettings {
79  int n_threads;
83  int all_layers;
84  unsigned frame_size_limit;
98  uint8_t reserved[16];
100 
104 DAV1D_API const char *dav1d_version(void);
105 
114 
121 
135 
155  const uint8_t *buf, const size_t sz);
156 
175 
227 
247  const Dav1dPicture *in);
248 
255 
267 
280 };
281 
296 
309 
324 
325 #ifdef __cplusplus
326 } /* extern "C" */
327 #endif
328 
329 #endif /* DAV1D_H */
#define DAV1D_API
Definition: common.h:50
DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out)
Dav1dInloopFilterType
Definition: dav1d.h:61
@ DAV1D_INLOOPFILTER_CDEF
Definition: dav1d.h:64
@ DAV1D_INLOOPFILTER_NONE
Definition: dav1d.h:62
@ DAV1D_INLOOPFILTER_ALL
Definition: dav1d.h:66
@ DAV1D_INLOOPFILTER_DEBLOCK
Definition: dav1d.h:63
@ DAV1D_INLOOPFILTER_RESTORATION
Definition: dav1d.h:65
DAV1D_API void dav1d_close(Dav1dContext **c_out)
struct Dav1dRef Dav1dRef
Definition: dav1d.h:44
DAV1D_API int dav1d_open(Dav1dContext **c_out, const Dav1dSettings *s)
Dav1dEventFlags
Definition: dav1d.h:268
@ DAV1D_EVENT_FLAG_NEW_SEQUENCE
Definition: dav1d.h:274
@ DAV1D_EVENT_FLAG_NEW_OP_PARAMS_INFO
Definition: dav1d.h:279
struct Dav1dContext Dav1dContext
Definition: dav1d.h:43
DAV1D_API const char * dav1d_version(void)
DAV1D_API int dav1d_parse_sequence_header(Dav1dSequenceHeader *out, const uint8_t *buf, const size_t sz)
DAV1D_API int dav1d_get_event_flags(Dav1dContext *c, enum Dav1dEventFlags *flags)
DAV1D_API void dav1d_default_settings(Dav1dSettings *s)
DAV1D_API int dav1d_send_data(Dav1dContext *c, Dav1dData *in)
DAV1D_API void dav1d_flush(Dav1dContext *c)
DAV1D_API int dav1d_apply_grain(Dav1dContext *c, Dav1dPicture *out, const Dav1dPicture *in)
DAV1D_API unsigned dav1d_version_api(void)
Dav1dDecodeFrameType
Definition: dav1d.h:71
@ DAV1D_DECODEFRAMETYPE_KEY
decode and return keyframes only
Definition: dav1d.h:75
@ DAV1D_DECODEFRAMETYPE_REFERENCE
decode and return frames referenced by other frames only
Definition: dav1d.h:73
@ DAV1D_DECODEFRAMETYPE_ALL
decode and return all frames
Definition: dav1d.h:72
@ DAV1D_DECODEFRAMETYPE_INTRA
decode and return intra frames only (includes keyframes)
Definition: dav1d.h:74
DAV1D_API int dav1d_get_frame_delay(const Dav1dSettings *s)
DAV1D_API int dav1d_get_decode_error_data_props(Dav1dContext *c, Dav1dDataProps *out)
Definition: common.h:77
Definition: data.h:40
Definition: dav1d.h:49
void * cookie
Custom data to pass to the callback.
Definition: dav1d.h:50
void(* callback)(void *cookie, const char *format, va_list ap)
Definition: dav1d.h:58
Definition: picture.h:107
Definition: picture.h:53
Definition: headers.h:207
Definition: dav1d.h:78
enum Dav1dInloopFilterType inloop_filters
Definition: dav1d.h:94
int all_layers
output all spatial layers of a scalable AV1 biststream (default 1)
Definition: dav1d.h:83
enum Dav1dDecodeFrameType decode_frame_type
Definition: dav1d.h:96
uint8_t reserved[16]
reserved for future use
Definition: dav1d.h:98
int operating_point
select an operating point for scalable AV1 bitstreams (0 - 31, default 0)
Definition: dav1d.h:82
int n_threads
number of threads (0 = number of logical cores in host system, default 0)
Definition: dav1d.h:79
Dav1dPicAllocator allocator
Picture allocator callback.
Definition: dav1d.h:85
int apply_grain
whether to apply film grain on output frames (default 1)
Definition: dav1d.h:81
int strict_std_compliance
Definition: dav1d.h:87
Dav1dLogger logger
Logger callback.
Definition: dav1d.h:86
int output_invisible_frames
Definition: dav1d.h:90
int max_frame_delay
Set to 1 for low-latency decoding (0 = ceil(sqrt(n_threads)), default 0)
Definition: dav1d.h:80
unsigned frame_size_limit
maximum frame size, in pixels (0 = unlimited, default 0)
Definition: dav1d.h:84