2 * Copyright (c) 2018 Ronald S. Bultje <rsbultje gmail com>
3 * Copyright (c) 2018 James Almer <jamrial gmail com>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <dav1d/dav1d.h>
24 #include "libavutil/avassert.h"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/opt.h"
32 typedef struct Libdav1dContext {
43 static const enum AVPixelFormat pix_fmt[][3] = {
44 [DAV1D_PIXEL_LAYOUT_I400] = { AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12 },
45 [DAV1D_PIXEL_LAYOUT_I420] = { AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV420P12 },
46 [DAV1D_PIXEL_LAYOUT_I422] = { AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV422P12 },
47 [DAV1D_PIXEL_LAYOUT_I444] = { AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV444P12 },
50 static void libdav1d_log_callback(void *opaque, const char *fmt, va_list vl)
52 AVCodecContext *c = opaque;
54 av_vlog(c, AV_LOG_ERROR, fmt, vl);
57 static int libdav1d_picture_allocator(Dav1dPicture *p, void *cookie)
59 Libdav1dContext *dav1d = cookie;
60 enum AVPixelFormat format = pix_fmt[p->p.layout][p->seq_hdr->hbd];
61 int ret, linesize[4], h = FFALIGN(p->p.h, 128);
62 uint8_t *aligned_ptr, *data[4];
65 ret = av_image_fill_arrays(data, linesize, NULL, format, FFALIGN(p->p.w, 128),
66 h, DAV1D_PICTURE_ALIGNMENT);
70 if (ret != dav1d->pool_size) {
71 av_buffer_pool_uninit(&dav1d->pool);
72 // Use twice the amount of required padding bytes for aligned_ptr below.
73 dav1d->pool = av_buffer_pool_init(ret + DAV1D_PICTURE_ALIGNMENT * 2, NULL);
75 return AVERROR(ENOMEM);
76 dav1d->pool_size = ret;
78 buf = av_buffer_pool_get(dav1d->pool);
80 return AVERROR(ENOMEM);
82 // libdav1d requires DAV1D_PICTURE_ALIGNMENT aligned buffers, which av_malloc()
83 // doesn't guarantee for example when AVX is disabled at configure time.
84 // Use the extra DAV1D_PICTURE_ALIGNMENT padding bytes in the buffer to align it
86 aligned_ptr = (uint8_t *)FFALIGN((uintptr_t)buf->data, DAV1D_PICTURE_ALIGNMENT);
87 ret = av_image_fill_pointers(data, format, h, aligned_ptr, linesize);
89 av_buffer_unref(&buf);
96 p->stride[0] = linesize[0];
97 p->stride[1] = linesize[1];
98 p->allocator_data = buf;
103 static void libdav1d_picture_release(Dav1dPicture *p, void *cookie)
105 AVBufferRef *buf = p->allocator_data;
107 av_buffer_unref(&buf);
110 static av_cold int libdav1d_init(AVCodecContext *c)
112 Libdav1dContext *dav1d = c->priv_data;
116 av_log(c, AV_LOG_INFO, "libdav1d %s\n", dav1d_version());
118 dav1d_default_settings(&s);
120 s.logger.callback = libdav1d_log_callback;
121 s.allocator.cookie = dav1d;
122 s.allocator.alloc_picture_callback = libdav1d_picture_allocator;
123 s.allocator.release_picture_callback = libdav1d_picture_release;
124 s.n_tile_threads = dav1d->tile_threads;
125 s.apply_grain = dav1d->apply_grain;
126 s.n_frame_threads = FFMIN(c->thread_count ? c->thread_count : av_cpu_count(), DAV1D_MAX_FRAME_THREADS);
128 res = dav1d_open(&dav1d->c, &s);
130 return AVERROR(ENOMEM);
135 static void libdav1d_flush(AVCodecContext *c)
137 Libdav1dContext *dav1d = c->priv_data;
139 dav1d_data_unref(&dav1d->data);
140 dav1d_flush(dav1d->c);
143 static void libdav1d_data_free(const uint8_t *data, void *opaque) {
144 AVBufferRef *buf = opaque;
146 av_buffer_unref(&buf);
149 static void libdav1d_frame_free(void *opaque, uint8_t *data) {
150 Dav1dPicture *p = opaque;
152 dav1d_picture_unref(p);
156 static int libdav1d_receive_frame(AVCodecContext *c, AVFrame *frame)
158 Libdav1dContext *dav1d = c->priv_data;
159 Dav1dData *data = &dav1d->data;
164 AVPacket pkt = { 0 };
166 res = ff_decode_get_packet(c, &pkt);
167 if (res < 0 && res != AVERROR_EOF)
171 res = dav1d_data_wrap(data, pkt.data, pkt.size, libdav1d_data_free, pkt.buf);
173 av_packet_unref(&pkt);
177 data->m.timestamp = pkt.pts;
178 data->m.offset = pkt.pos;
179 data->m.duration = pkt.duration;
182 av_packet_unref(&pkt);
186 res = dav1d_send_data(dav1d->c, data);
188 if (res == AVERROR(EINVAL))
189 res = AVERROR_INVALIDDATA;
190 if (res != AVERROR(EAGAIN))
194 p = av_mallocz(sizeof(*p));
196 return AVERROR(ENOMEM);
198 res = dav1d_get_picture(dav1d->c, p);
200 if (res == AVERROR(EINVAL))
201 res = AVERROR_INVALIDDATA;
202 else if (res == AVERROR(EAGAIN) && c->internal->draining)
209 av_assert0(p->data[0] != NULL);
211 frame->buf[0] = av_buffer_create(NULL, 0, libdav1d_frame_free,
212 p, AV_BUFFER_FLAG_READONLY);
213 if (!frame->buf[0]) {
214 dav1d_picture_unref(p);
216 return AVERROR(ENOMEM);
219 frame->data[0] = p->data[0];
220 frame->data[1] = p->data[1];
221 frame->data[2] = p->data[2];
222 frame->linesize[0] = p->stride[0];
223 frame->linesize[1] = p->stride[1];
224 frame->linesize[2] = p->stride[1];
226 c->profile = p->seq_hdr->profile;
227 frame->format = c->pix_fmt = pix_fmt[p->p.layout][p->seq_hdr->hbd];
228 frame->width = p->p.w;
229 frame->height = p->p.h;
230 if (c->width != p->p.w || c->height != p->p.h) {
231 res = ff_set_dimensions(c, p->p.w, p->p.h);
236 switch (p->seq_hdr->chr) {
237 case DAV1D_CHR_VERTICAL:
238 frame->chroma_location = c->chroma_sample_location = AVCHROMA_LOC_LEFT;
240 case DAV1D_CHR_COLOCATED:
241 frame->chroma_location = c->chroma_sample_location = AVCHROMA_LOC_TOPLEFT;
244 frame->colorspace = c->colorspace = (enum AVColorSpace) p->seq_hdr->mtrx;
245 frame->color_primaries = c->color_primaries = (enum AVColorPrimaries) p->seq_hdr->pri;
246 frame->color_trc = c->color_trc = (enum AVColorTransferCharacteristic) p->seq_hdr->trc;
247 frame->color_range = c->color_range = p->seq_hdr->color_range ? AVCOL_RANGE_JPEG : AVCOL_RANGE_MPEG;
249 // match timestamps and packet size
250 frame->pts = frame->best_effort_timestamp = p->m.timestamp;
252 FF_DISABLE_DEPRECATION_WARNINGS
253 frame->pkt_pts = p->m.timestamp;
254 FF_ENABLE_DEPRECATION_WARNINGS
256 frame->pkt_dts = p->m.timestamp;
257 frame->pkt_pos = p->m.offset;
258 frame->pkt_size = p->m.size;
259 frame->pkt_duration = p->m.duration;
260 frame->key_frame = p->frame_hdr->frame_type == DAV1D_FRAME_TYPE_KEY;
262 switch (p->frame_hdr->frame_type) {
263 case DAV1D_FRAME_TYPE_KEY:
264 case DAV1D_FRAME_TYPE_INTRA:
265 frame->pict_type = AV_PICTURE_TYPE_I;
267 case DAV1D_FRAME_TYPE_INTER:
268 frame->pict_type = AV_PICTURE_TYPE_P;
270 case DAV1D_FRAME_TYPE_SWITCH:
271 frame->pict_type = AV_PICTURE_TYPE_SP;
274 return AVERROR_INVALIDDATA;
280 static av_cold int libdav1d_close(AVCodecContext *c)
282 Libdav1dContext *dav1d = c->priv_data;
284 av_buffer_pool_uninit(&dav1d->pool);
285 dav1d_data_unref(&dav1d->data);
286 dav1d_close(&dav1d->c);
291 #define OFFSET(x) offsetof(Libdav1dContext, x)
292 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
293 static const AVOption libdav1d_options[] = {
294 { "tilethreads", "Tile threads", OFFSET(tile_threads), AV_OPT_TYPE_INT, { .i64 = 1 }, 1, DAV1D_MAX_TILE_THREADS, VD },
295 { "filmgrain", "Apply Film Grain", OFFSET(apply_grain), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, VD },
299 static const AVClass libdav1d_class = {
300 .class_name = "libdav1d decoder",
301 .item_name = av_default_item_name,
302 .option = libdav1d_options,
303 .version = LIBAVUTIL_VERSION_INT,
306 AVCodec ff_libdav1d_decoder = {
308 .long_name = NULL_IF_CONFIG_SMALL("dav1d AV1 decoder by VideoLAN"),
309 .type = AVMEDIA_TYPE_VIDEO,
310 .id = AV_CODEC_ID_AV1,
311 .priv_data_size = sizeof(Libdav1dContext),
312 .init = libdav1d_init,
313 .close = libdav1d_close,
314 .flush = libdav1d_flush,
315 .receive_frame = libdav1d_receive_frame,
316 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
317 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE | FF_CODEC_CAP_SETS_PKT_DTS,
318 .priv_class = &libdav1d_class,
319 .wrapper_name = "libdav1d",