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