dav1d.h 6.79 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
68
    Dav1dPicAllocator allocator;
    Dav1dLogger logger;
69
70
71
72
73
74
75
} Dav1dSettings;

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

76
77
78
79
80
81
82
83
84
85
/**
 * Get library version based on version control system.
 */
DAV1D_API const char *dav1d_version_vcs(void);

/**
 * Get library version as unsigned int.
 */
DAV1D_API unsigned int dav1d_version_int(void);

86
87
/**
 * Initialize settings to default values.
88
89
 *
 * @param s Input settings context.
90
91
92
93
 */
DAV1D_API void dav1d_default_settings(Dav1dSettings *s);

/**
94
 * Allocate and open a decoder instance.
95
 *
James Almer's avatar
James Almer committed
96
97
 * @param c_out The decoder instance to open. *c_out will be set to the
 *              allocated context.
98
 * @param     s Input settings context.
99
 *
100
101
 * @note The context must be freed using dav1d_close() when decoding is
 *       finished.
102
 *
103
 * @return 0 on success, or < 0 (a negative errno code) on error.
104
105
106
 */
DAV1D_API int dav1d_open(Dav1dContext **c_out, const Dav1dSettings *s);

107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/**
 * 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.
 *
 * @return 0 on success, or < 0 (a negative errno code) on error.
 *
 * @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);

123
/**
James Almer's avatar
James Almer committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 * 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.
 *   -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 errno codes: Error during decoding or because of invalid
 *                               passed-in arguments.
 */
DAV1D_API int dav1d_send_data(Dav1dContext *c, Dav1dData *in);

/**
 * Return a decoded picture.
142
143
144
145
146
147
148
 *
 * @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.
James Almer's avatar
James Almer committed
149
150
 *   -EAGAIN: Not enough data to output a frame. dav1d_send_data() should be
 *            called with new input.
151
152
 *   other negative errno codes: Error during decoding or because of invalid
 *                               passed-in arguments.
153
 *
James Almer's avatar
James Almer committed
154
155
 * @note To drain buffered frames from the decoder (i.e. on end of stream),
 *       call this function until it returns -EAGAIN.
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 *
 * @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.
 *      if (res < 0 && res != -EAGAIN)
 *          free_and_abort();
 *      res = dav1d_get_picture(c, &p);
 *      if (res < 0) {
 *          if (res != -EAGAIN)
 *              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) {
 *          if (res != -EAGAIN)
 *              free_and_abort();
 *      } else
 *          output_and_unref_picture(&p);
 *  } while (res == 0);
 * @endcode
189
 */
James Almer's avatar
James Almer committed
190
DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out);
191
192

/**
193
194
195
 * Close a decoder instance and free all associated memory.
 *
 * @param c_out The decoder instance to close. *c_out will be set to NULL.
196
 */
197
DAV1D_API void dav1d_close(Dav1dContext **c_out);
198

Ronald S. Bultje's avatar
Ronald S. Bultje committed
199
/**
Janne Grunau's avatar
Janne Grunau committed
200
201
 * Flush all delayed frames in decoder and clear internal decoder state,
 * to be used when seeking.
202
203
 *
 * @param c Input decoder instance.
Janne Grunau's avatar
Janne Grunau committed
204
205
206
207
 *
 * @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
208
209
210
 */
DAV1D_API void dav1d_flush(Dav1dContext *c);

211
212
213
214
# ifdef __cplusplus
}
# endif

215
#endif /* DAV1D_H */