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