]> git.sesse.net Git - ffmpeg/blob - libavcodec/libdav1d.c
avcodec/libdav1d: set AVFrame reordered_opaque
[ffmpeg] / libavcodec / libdav1d.c
1 /*
2  * Copyright (c) 2018 Ronald S. Bultje <rsbultje gmail com>
3  * Copyright (c) 2018 James Almer <jamrial gmail com>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include <dav1d/dav1d.h>
23
24 #include "libavutil/avassert.h"
25 #include "libavutil/mastering_display_metadata.h"
26 #include "libavutil/imgutils.h"
27 #include "libavutil/opt.h"
28
29 #include "avcodec.h"
30 #include "decode.h"
31 #include "internal.h"
32
33 typedef struct Libdav1dContext {
34     AVClass *class;
35     Dav1dContext *c;
36     AVBufferPool *pool;
37     int pool_size;
38
39     Dav1dData data;
40     int tile_threads;
41     int frame_threads;
42     int apply_grain;
43 } Libdav1dContext;
44
45 static const enum AVPixelFormat pix_fmt[][3] = {
46     [DAV1D_PIXEL_LAYOUT_I400] = { AV_PIX_FMT_GRAY8,   AV_PIX_FMT_GRAY10,    AV_PIX_FMT_GRAY12 },
47     [DAV1D_PIXEL_LAYOUT_I420] = { AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV420P12 },
48     [DAV1D_PIXEL_LAYOUT_I422] = { AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV422P12 },
49     [DAV1D_PIXEL_LAYOUT_I444] = { AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV444P12 },
50 };
51
52 static const enum AVPixelFormat pix_fmt_rgb[3] = {
53     AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRP12,
54 };
55
56 static void libdav1d_log_callback(void *opaque, const char *fmt, va_list vl)
57 {
58     AVCodecContext *c = opaque;
59
60     av_vlog(c, AV_LOG_ERROR, fmt, vl);
61 }
62
63 static int libdav1d_picture_allocator(Dav1dPicture *p, void *cookie)
64 {
65     Libdav1dContext *dav1d = cookie;
66     enum AVPixelFormat format = pix_fmt[p->p.layout][p->seq_hdr->hbd];
67     int ret, linesize[4], h = FFALIGN(p->p.h, 128);
68     uint8_t *aligned_ptr, *data[4];
69     AVBufferRef *buf;
70
71     ret = av_image_fill_arrays(data, linesize, NULL, format, FFALIGN(p->p.w, 128),
72                                h, DAV1D_PICTURE_ALIGNMENT);
73     if (ret < 0)
74         return ret;
75
76     if (ret != dav1d->pool_size) {
77         av_buffer_pool_uninit(&dav1d->pool);
78         // Use twice the amount of required padding bytes for aligned_ptr below.
79         dav1d->pool = av_buffer_pool_init(ret + DAV1D_PICTURE_ALIGNMENT * 2, NULL);
80         if (!dav1d->pool) {
81             dav1d->pool_size = 0;
82             return AVERROR(ENOMEM);
83         }
84         dav1d->pool_size = ret;
85     }
86     buf = av_buffer_pool_get(dav1d->pool);
87     if (!buf)
88         return AVERROR(ENOMEM);
89
90     // libdav1d requires DAV1D_PICTURE_ALIGNMENT aligned buffers, which av_malloc()
91     // doesn't guarantee for example when AVX is disabled at configure time.
92     // Use the extra DAV1D_PICTURE_ALIGNMENT padding bytes in the buffer to align it
93     // if required.
94     aligned_ptr = (uint8_t *)FFALIGN((uintptr_t)buf->data, DAV1D_PICTURE_ALIGNMENT);
95     ret = av_image_fill_pointers(data, format, h, aligned_ptr, linesize);
96     if (ret < 0) {
97         av_buffer_unref(&buf);
98         return ret;
99     }
100
101     p->data[0] = data[0];
102     p->data[1] = data[1];
103     p->data[2] = data[2];
104     p->stride[0] = linesize[0];
105     p->stride[1] = linesize[1];
106     p->allocator_data = buf;
107
108     return 0;
109 }
110
111 static void libdav1d_picture_release(Dav1dPicture *p, void *cookie)
112 {
113     AVBufferRef *buf = p->allocator_data;
114
115     av_buffer_unref(&buf);
116 }
117
118 static av_cold int libdav1d_init(AVCodecContext *c)
119 {
120     Libdav1dContext *dav1d = c->priv_data;
121     Dav1dSettings s;
122     int threads = (c->thread_count ? c->thread_count : av_cpu_count()) * 3 / 2;
123     int res;
124
125     av_log(c, AV_LOG_INFO, "libdav1d %s\n", dav1d_version());
126
127     dav1d_default_settings(&s);
128     s.logger.cookie = c;
129     s.logger.callback = libdav1d_log_callback;
130     s.allocator.cookie = dav1d;
131     s.allocator.alloc_picture_callback = libdav1d_picture_allocator;
132     s.allocator.release_picture_callback = libdav1d_picture_release;
133     s.frame_size_limit = c->max_pixels;
134     if (dav1d->apply_grain >= 0)
135         s.apply_grain = dav1d->apply_grain;
136
137     s.n_tile_threads = dav1d->tile_threads
138                      ? dav1d->tile_threads
139                      : FFMIN(floor(sqrt(threads)), DAV1D_MAX_TILE_THREADS);
140     s.n_frame_threads = dav1d->frame_threads
141                       ? dav1d->frame_threads
142                       : FFMIN(ceil(threads / s.n_tile_threads), DAV1D_MAX_FRAME_THREADS);
143     av_log(c, AV_LOG_DEBUG, "Using %d frame threads, %d tile threads\n",
144            s.n_frame_threads, s.n_tile_threads);
145
146     res = dav1d_open(&dav1d->c, &s);
147     if (res < 0)
148         return AVERROR(ENOMEM);
149
150     return 0;
151 }
152
153 static void libdav1d_flush(AVCodecContext *c)
154 {
155     Libdav1dContext *dav1d = c->priv_data;
156
157     dav1d_data_unref(&dav1d->data);
158     dav1d_flush(dav1d->c);
159 }
160
161 static void libdav1d_data_free(const uint8_t *data, void *opaque) {
162     AVBufferRef *buf = opaque;
163
164     av_buffer_unref(&buf);
165 }
166
167 static int libdav1d_receive_frame(AVCodecContext *c, AVFrame *frame)
168 {
169     Libdav1dContext *dav1d = c->priv_data;
170     Dav1dData *data = &dav1d->data;
171     Dav1dPicture pic = { 0 }, *p = &pic;
172     int res;
173
174     if (!data->sz) {
175         AVPacket pkt = { 0 };
176
177         res = ff_decode_get_packet(c, &pkt);
178         if (res < 0 && res != AVERROR_EOF)
179             return res;
180
181         if (pkt.size) {
182             res = dav1d_data_wrap(data, pkt.data, pkt.size, libdav1d_data_free, pkt.buf);
183             if (res < 0) {
184                 av_packet_unref(&pkt);
185                 return res;
186             }
187
188             data->m.timestamp = pkt.pts;
189             data->m.offset = pkt.pos;
190             data->m.duration = pkt.duration;
191
192             pkt.buf = NULL;
193             av_packet_unref(&pkt);
194         }
195     }
196
197     res = dav1d_send_data(dav1d->c, data);
198     if (res < 0) {
199         if (res == AVERROR(EINVAL))
200             res = AVERROR_INVALIDDATA;
201         if (res != AVERROR(EAGAIN))
202             return res;
203     }
204
205     res = dav1d_get_picture(dav1d->c, p);
206     if (res < 0) {
207         if (res == AVERROR(EINVAL))
208             res = AVERROR_INVALIDDATA;
209         else if (res == AVERROR(EAGAIN) && c->internal->draining)
210             res = AVERROR_EOF;
211
212         return res;
213     }
214
215     av_assert0(p->data[0] && p->allocator_data);
216
217     // This requires the custom allocator above
218     frame->buf[0] = av_buffer_ref(p->allocator_data);
219     if (!frame->buf[0]) {
220         dav1d_picture_unref(p);
221         return AVERROR(ENOMEM);
222     }
223
224     frame->data[0] = p->data[0];
225     frame->data[1] = p->data[1];
226     frame->data[2] = p->data[2];
227     frame->linesize[0] = p->stride[0];
228     frame->linesize[1] = p->stride[1];
229     frame->linesize[2] = p->stride[1];
230
231     c->profile = p->seq_hdr->profile;
232     c->level = ((p->seq_hdr->operating_points[0].major_level - 2) << 2)
233                | p->seq_hdr->operating_points[0].minor_level;
234     frame->width = p->p.w;
235     frame->height = p->p.h;
236     if (c->width != p->p.w || c->height != p->p.h) {
237         res = ff_set_dimensions(c, p->p.w, p->p.h);
238         if (res < 0)
239             goto fail;
240     }
241
242     switch (p->seq_hdr->chr) {
243     case DAV1D_CHR_VERTICAL:
244         frame->chroma_location = c->chroma_sample_location = AVCHROMA_LOC_LEFT;
245         break;
246     case DAV1D_CHR_COLOCATED:
247         frame->chroma_location = c->chroma_sample_location = AVCHROMA_LOC_TOPLEFT;
248         break;
249     }
250     frame->colorspace = c->colorspace = (enum AVColorSpace) p->seq_hdr->mtrx;
251     frame->color_primaries = c->color_primaries = (enum AVColorPrimaries) p->seq_hdr->pri;
252     frame->color_trc = c->color_trc = (enum AVColorTransferCharacteristic) p->seq_hdr->trc;
253     frame->color_range = c->color_range = p->seq_hdr->color_range ? AVCOL_RANGE_JPEG : AVCOL_RANGE_MPEG;
254
255     if (p->p.layout == DAV1D_PIXEL_LAYOUT_I444 &&
256         p->seq_hdr->mtrx == DAV1D_MC_IDENTITY &&
257         p->seq_hdr->pri  == DAV1D_COLOR_PRI_BT709 &&
258         p->seq_hdr->trc  == DAV1D_TRC_SRGB)
259         frame->format = c->pix_fmt = pix_fmt_rgb[p->seq_hdr->hbd];
260     else
261         frame->format = c->pix_fmt = pix_fmt[p->p.layout][p->seq_hdr->hbd];
262
263     frame->reordered_opaque = c->reordered_opaque;
264
265     // match timestamps and packet size
266     frame->pts = frame->best_effort_timestamp = p->m.timestamp;
267 #if FF_API_PKT_PTS
268 FF_DISABLE_DEPRECATION_WARNINGS
269     frame->pkt_pts = p->m.timestamp;
270 FF_ENABLE_DEPRECATION_WARNINGS
271 #endif
272     frame->pkt_dts = p->m.timestamp;
273     frame->pkt_pos = p->m.offset;
274     frame->pkt_size = p->m.size;
275     frame->pkt_duration = p->m.duration;
276     frame->key_frame = p->frame_hdr->frame_type == DAV1D_FRAME_TYPE_KEY;
277
278     switch (p->frame_hdr->frame_type) {
279     case DAV1D_FRAME_TYPE_KEY:
280     case DAV1D_FRAME_TYPE_INTRA:
281         frame->pict_type = AV_PICTURE_TYPE_I;
282         break;
283     case DAV1D_FRAME_TYPE_INTER:
284         frame->pict_type = AV_PICTURE_TYPE_P;
285         break;
286     case DAV1D_FRAME_TYPE_SWITCH:
287         frame->pict_type = AV_PICTURE_TYPE_SP;
288         break;
289     default:
290         res = AVERROR_INVALIDDATA;
291         goto fail;
292     }
293
294     if (p->mastering_display) {
295         AVMasteringDisplayMetadata *mastering = av_mastering_display_metadata_create_side_data(frame);
296         if (!mastering) {
297             res = AVERROR(ENOMEM);
298             goto fail;
299         }
300
301         for (int i = 0; i < 3; i++) {
302             mastering->display_primaries[i][0] = av_make_q(p->mastering_display->primaries[i][0], 1 << 16);
303             mastering->display_primaries[i][1] = av_make_q(p->mastering_display->primaries[i][1], 1 << 16);
304         }
305         mastering->white_point[0] = av_make_q(p->mastering_display->white_point[0], 1 << 16);
306         mastering->white_point[1] = av_make_q(p->mastering_display->white_point[1], 1 << 16);
307
308         mastering->max_luminance = av_make_q(p->mastering_display->max_luminance, 1 << 8);
309         mastering->min_luminance = av_make_q(p->mastering_display->min_luminance, 1 << 14);
310
311         mastering->has_primaries = 1;
312         mastering->has_luminance = 1;
313     }
314     if (p->content_light) {
315         AVContentLightMetadata *light = av_content_light_metadata_create_side_data(frame);
316         if (!light) {
317             res = AVERROR(ENOMEM);
318             goto fail;
319         }
320         light->MaxCLL = p->content_light->max_content_light_level;
321         light->MaxFALL = p->content_light->max_frame_average_light_level;
322     }
323
324     res = 0;
325 fail:
326     dav1d_picture_unref(p);
327     if (res < 0)
328         av_frame_unref(frame);
329     return res;
330 }
331
332 static av_cold int libdav1d_close(AVCodecContext *c)
333 {
334     Libdav1dContext *dav1d = c->priv_data;
335
336     av_buffer_pool_uninit(&dav1d->pool);
337     dav1d_data_unref(&dav1d->data);
338     dav1d_close(&dav1d->c);
339
340     return 0;
341 }
342
343 #define OFFSET(x) offsetof(Libdav1dContext, x)
344 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
345 static const AVOption libdav1d_options[] = {
346     { "tilethreads", "Tile threads", OFFSET(tile_threads), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, DAV1D_MAX_TILE_THREADS, VD },
347     { "framethreads", "Frame threads", OFFSET(frame_threads), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, DAV1D_MAX_FRAME_THREADS, VD },
348     { "filmgrain", "Apply Film Grain", OFFSET(apply_grain), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, VD },
349     { NULL }
350 };
351
352 static const AVClass libdav1d_class = {
353     .class_name = "libdav1d decoder",
354     .item_name  = av_default_item_name,
355     .option     = libdav1d_options,
356     .version    = LIBAVUTIL_VERSION_INT,
357 };
358
359 AVCodec ff_libdav1d_decoder = {
360     .name           = "libdav1d",
361     .long_name      = NULL_IF_CONFIG_SMALL("dav1d AV1 decoder by VideoLAN"),
362     .type           = AVMEDIA_TYPE_VIDEO,
363     .id             = AV_CODEC_ID_AV1,
364     .priv_data_size = sizeof(Libdav1dContext),
365     .init           = libdav1d_init,
366     .close          = libdav1d_close,
367     .flush          = libdav1d_flush,
368     .receive_frame  = libdav1d_receive_frame,
369     .capabilities   = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
370     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE | FF_CODEC_CAP_SETS_PKT_DTS,
371     .priv_class     = &libdav1d_class,
372     .wrapper_name   = "libdav1d",
373 };