dav1d.h 6.85 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/*
 * Copyright © 2018, VideoLAN and dav1d authors
 * Copyright © 2018, Two Orioles, LLC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

28
29
#ifndef DAV1D_H
#define DAV1D_H
30

31
32
33
34
#ifdef __cplusplus
extern "C" {
#endif

35
#include <errno.h>
James Almer's avatar
James Almer committed
36
#include <stdarg.h>
37

38
39
40
#include "common.h"
#include "picture.h"
#include "data.h"
41
#include "version.h"
42
43
44
45

typedef struct Dav1dContext Dav1dContext;
typedef struct Dav1dRef Dav1dRef;

46
47
48
#define DAV1D_MAX_FRAME_THREADS 256
#define DAV1D_MAX_TILE_THREADS 64

James Almer's avatar
James Almer committed
49
50
51
52
53
54
55
56
57
58
59
60
typedef struct Dav1dLogger {
    void *cookie; ///< Custom data to pass to the callback.
    /**
     * Logger callback. Default prints to stderr. May be NULL to disable logging.
     *
     * @param cookie Custom pointer passed to all calls.
     * @param format The vprintf compatible format string.
     * @param     ap List of arguments referenced by the format string.
     */
    void (*callback)(void *cookie, const char *format, va_list ap);
} Dav1dLogger;

61
62
63
typedef struct Dav1dSettings {
    int n_frame_threads;
    int n_tile_threads;
64
    int apply_grain;
65
    int operating_point; ///< select an operating point for scalable AV1 bitstreams (0 - 31)
66
    int all_layers; ///< output all spatial layers of a scalable AV1 biststream
67
    unsigned frame_size_limit; ///< maximum frame size, in pixels (0 = unlimited)
68
69
    int output_invisible_frames;
    uint8_t reserved[28]; ///< reserved for future use
70
71
    Dav1dPicAllocator allocator;
    Dav1dLogger logger;
72
73
74
75
76
77
78
79
80
} Dav1dSettings;

/**
 * Get library version.
 */
DAV1D_API const char *dav1d_version(void);

/**
 * Initialize settings to default values.
81
82
 *
 * @param s Input settings context.
83
84
85
86
 */
DAV1D_API void dav1d_default_settings(Dav1dSettings *s);

/**
87
 * Allocate and open a decoder instance.
88
 *
James Almer's avatar
James Almer committed
89
90
 * @param c_out The decoder instance to open. *c_out will be set to the
 *              allocated context.
91
 * @param     s Input settings context.
92
 *
93
94
 * @note The context must be freed using dav1d_close() when decoding is
 *       finished.
95
 *
96
 * @return 0 on success, or < 0 (a negative DAV1D_ERR code) on error.
97
98
99
 */
DAV1D_API int dav1d_open(Dav1dContext **c_out, const Dav1dSettings *s);

100
101
102
103
104
105
106
/**
 * Parse a Sequence Header OBU from bitstream data.
 *
 * @param out Output Sequence Header.
 * @param buf The data to be parser.
 * @param sz  Size of the data.
 *
107
 * @return 0 on success, or < 0 (a negative DAV1D_ERR code) on error.
108
109
110
111
112
113
114
115
 *
 * @note It is safe to feed this function data containing other OBUs than a
 *       Sequence Header, as they will simply be ignored. If there is more than
 *       one Sequence Header OBU present, only the last will be returned.
 */
DAV1D_API int dav1d_parse_sequence_header(Dav1dSequenceHeader *out,
                                          const uint8_t *buf, const size_t sz);

116
/**
James Almer's avatar
James Almer committed
117
118
119
120
121
122
123
124
 * Feed bitstream data to the decoder.
 *
 * @param   c Input decoder instance.
 * @param  in Input bitstream data. On success, ownership of the reference is
 *            passed to the library.
 *
 * @return
 *         0: Success, and the data was consumed.
125
126
127
128
129
 *  DAV1D_ERR(EAGAIN): The data can't be consumed. dav1d_get_picture() should
 *                     be called to get one or more frames before the function
 *                     can consume new data.
 *  other negative DAV1D_ERR codes: Error during decoding or because of invalid
 *                                  passed-in arguments.
James Almer's avatar
James Almer committed
130
131
132
133
134
 */
DAV1D_API int dav1d_send_data(Dav1dContext *c, Dav1dData *in);

/**
 * Return a decoded picture.
135
136
137
138
139
140
141
 *
 * @param   c Input decoder instance.
 * @param out Output frame. The caller assumes ownership of the returned
 *            reference.
 *
 * @return
 *         0: Success, and a frame is returned.
142
143
144
145
 *  DAV1D_ERR(EAGAIN): Not enough data to output a frame. dav1d_send_data()
 *                     should be called with new input.
 *  other negative DAV1D_ERR codes: Error during decoding or because of invalid
 *                                  passed-in arguments.
146
 *
James Almer's avatar
James Almer committed
147
 * @note To drain buffered frames from the decoder (i.e. on end of stream),
148
 *       call this function until it returns DAV1D_ERR(EAGAIN).
149
150
151
152
153
154
155
156
157
158
159
160
 *
 * @code{.c}
 *  Dav1dData data = { 0 };
 *  Dav1dPicture p = { 0 };
 *  int res;
 *
 *  read_data(&data);
 *  do {
 *      res = dav1d_send_data(c, &data);
 *      // Keep going even if the function can't consume the current data
 *         packet. It eventually will after one or more frames have been
 *         returned in this loop.
161
 *      if (res < 0 && res != DAV1D_ERR(EAGAIN))
162
163
164
 *          free_and_abort();
 *      res = dav1d_get_picture(c, &p);
 *      if (res < 0) {
165
 *          if (res != DAV1D_ERR(EAGAIN))
166
167
168
169
170
171
172
173
174
175
 *              free_and_abort();
 *      } else
 *          output_and_unref_picture(&p);
 *  // Stay in the loop as long as there's data to consume.
 *  } while (data.sz || read_data(&data) == SUCCESS);
 *
 *  // Handle EOS by draining all buffered frames.
 *  do {
 *      res = dav1d_get_picture(c, &p);
 *      if (res < 0) {
176
 *          if (res != DAV1D_ERR(EAGAIN))
177
178
179
180
181
 *              free_and_abort();
 *      } else
 *          output_and_unref_picture(&p);
 *  } while (res == 0);
 * @endcode
182
 */
James Almer's avatar
James Almer committed
183
DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out);
184
185

/**
186
187
188
 * Close a decoder instance and free all associated memory.
 *
 * @param c_out The decoder instance to close. *c_out will be set to NULL.
189
 */
190
DAV1D_API void dav1d_close(Dav1dContext **c_out);
191

Ronald S. Bultje's avatar
Ronald S. Bultje committed
192
/**
Janne Grunau's avatar
Janne Grunau committed
193
194
 * Flush all delayed frames in decoder and clear internal decoder state,
 * to be used when seeking.
195
196
 *
 * @param c Input decoder instance.
Janne Grunau's avatar
Janne Grunau committed
197
198
199
200
 *
 * @note Decoding will start only after a valid sequence header OBU is
 *       delivered to dav1d_send_data().
 *
Ronald S. Bultje's avatar
Ronald S. Bultje committed
201
202
203
 */
DAV1D_API void dav1d_flush(Dav1dContext *c);

204
205
206
207
# ifdef __cplusplus
}
# endif

208
#endif /* DAV1D_H */