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