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 } 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 void libdav1d_user_data_free(const uint8_t *data, void *opaque) {
 168     av_assert0(data == opaque);
 169     av_free(opaque);
 170 }
 171
 172 static int libdav1d_receive_frame(AVCodecContext *c, AVFrame *frame)
 173 {
 174     Libdav1dContext *dav1d = c->priv_data;
 175     Dav1dData *data = &dav1d->data;
 176     Dav1dPicture pic = { 0 }, *p = &pic;
 177     int res;
 178
 179     if (!data->sz) {
 180         AVPacket pkt = { 0 };
 181
 182         res = ff_decode_get_packet(c, &pkt);
 183         if (res < 0 && res != AVERROR_EOF)
 184             return res;
 185
 186         if (pkt.size) {
 187             res = dav1d_data_wrap(data, pkt.data, pkt.size, libdav1d_data_free, pkt.buf);
 188             if (res < 0) {
 189                 av_packet_unref(&pkt);
 190                 return res;
 191             }
 192
 193             data->m.timestamp = pkt.pts;
 194             data->m.offset = pkt.pos;
 195             data->m.duration = pkt.duration;
 196
 197             pkt.buf = NULL;
 198             av_packet_unref(&pkt);
 199
 200             if (c->reordered_opaque != AV_NOPTS_VALUE) {
 201                 uint8_t *reordered_opaque = av_malloc(sizeof(c->reordered_opaque));
 202                 if (!reordered_opaque) {
 203                     dav1d_data_unref(data);
 204                     return AVERROR(ENOMEM);
 205                 }
 206
 207                 memcpy(reordered_opaque, &c->reordered_opaque, sizeof(c->reordered_opaque));
 208                 res = dav1d_data_wrap_user_data(data, reordered_opaque,
 209                                                 libdav1d_user_data_free, reordered_opaque);
 210                 if (res < 0) {
 211                     av_free(reordered_opaque);
 212                     dav1d_data_unref(data);
 213                     return res;
 214                 }
 215             }
 216         }
 217     }
 218
 219     res = dav1d_send_data(dav1d->c, data);
 220     if (res < 0) {
 221         if (res == AVERROR(EINVAL))
 222             res = AVERROR_INVALIDDATA;
 223         if (res != AVERROR(EAGAIN))
 224             return res;
 225     }
 226
 227     res = dav1d_get_picture(dav1d->c, p);
 228     if (res < 0) {
 229         if (res == AVERROR(EINVAL))
 230             res = AVERROR_INVALIDDATA;
 231         else if (res == AVERROR(EAGAIN) && c->internal->draining)
 232             res = AVERROR_EOF;
 233
 234         return res;
 235     }
 236
 237     av_assert0(p->data[0] && p->allocator_data);
 238
 239     // This requires the custom allocator above
 240     frame->buf[0] = av_buffer_ref(p->allocator_data);
 241     if (!frame->buf[0]) {
 242         dav1d_picture_unref(p);
 243         return AVERROR(ENOMEM);
 244     }
 245
 246     frame->data[0] = p->data[0];
 247     frame->data[1] = p->data[1];
 248     frame->data[2] = p->data[2];
 249     frame->linesize[0] = p->stride[0];
 250     frame->linesize[1] = p->stride[1];
 251     frame->linesize[2] = p->stride[1];
 252
 253     c->profile = p->seq_hdr->profile;
 254     c->level = ((p->seq_hdr->operating_points[0].major_level - 2) << 2)
 255                | p->seq_hdr->operating_points[0].minor_level;
 256     frame->width = p->p.w;
 257     frame->height = p->p.h;
 258     if (c->width != p->p.w || c->height != p->p.h) {
 259         res = ff_set_dimensions(c, p->p.w, p->p.h);
 260         if (res < 0)
 261             goto fail;
 262     }
 263
 264     switch (p->seq_hdr->chr) {
 265     case DAV1D_CHR_VERTICAL:
 266         frame->chroma_location = c->chroma_sample_location = AVCHROMA_LOC_LEFT;
 267         break;
 268     case DAV1D_CHR_COLOCATED:
 269         frame->chroma_location = c->chroma_sample_location = AVCHROMA_LOC_TOPLEFT;
 270         break;
 271     }
 272     frame->colorspace = c->colorspace = (enum AVColorSpace) p->seq_hdr->mtrx;
 273     frame->color_primaries = c->color_primaries = (enum AVColorPrimaries) p->seq_hdr->pri;
 274     frame->color_trc = c->color_trc = (enum AVColorTransferCharacteristic) p->seq_hdr->trc;
 275     frame->color_range = c->color_range = p->seq_hdr->color_range ? AVCOL_RANGE_JPEG : AVCOL_RANGE_MPEG;
 276
 277     if (p->p.layout == DAV1D_PIXEL_LAYOUT_I444 &&
 278         p->seq_hdr->mtrx == DAV1D_MC_IDENTITY &&
 279         p->seq_hdr->pri  == DAV1D_COLOR_PRI_BT709 &&
 280         p->seq_hdr->trc  == DAV1D_TRC_SRGB)
 281         frame->format = c->pix_fmt = pix_fmt_rgb[p->seq_hdr->hbd];
 282     else
 283         frame->format = c->pix_fmt = pix_fmt[p->p.layout][p->seq_hdr->hbd];
 284
 285     if (p->m.user_data.data)
 286         memcpy(&frame->reordered_opaque, p->m.user_data.data, sizeof(frame->reordered_opaque));
 287     else
 288         frame->reordered_opaque = AV_NOPTS_VALUE;
 289
 290     // match timestamps and packet size
 291     frame->pts = frame->best_effort_timestamp = p->m.timestamp;
 292 #if FF_API_PKT_PTS
 293 FF_DISABLE_DEPRECATION_WARNINGS
 294     frame->pkt_pts = p->m.timestamp;
 295 FF_ENABLE_DEPRECATION_WARNINGS
 296 #endif
 297     frame->pkt_dts = p->m.timestamp;
 298     frame->pkt_pos = p->m.offset;
 299     frame->pkt_size = p->m.size;
 300     frame->pkt_duration = p->m.duration;
 301     frame->key_frame = p->frame_hdr->frame_type == DAV1D_FRAME_TYPE_KEY;
 302
 303     switch (p->frame_hdr->frame_type) {
 304     case DAV1D_FRAME_TYPE_KEY:
 305     case DAV1D_FRAME_TYPE_INTRA:
 306         frame->pict_type = AV_PICTURE_TYPE_I;
 307         break;
 308     case DAV1D_FRAME_TYPE_INTER:
 309         frame->pict_type = AV_PICTURE_TYPE_P;
 310         break;
 311     case DAV1D_FRAME_TYPE_SWITCH:
 312         frame->pict_type = AV_PICTURE_TYPE_SP;
 313         break;
 314     default:
 315         res = AVERROR_INVALIDDATA;
 316         goto fail;
 317     }
 318
 319     if (p->mastering_display) {
 320         AVMasteringDisplayMetadata *mastering = av_mastering_display_metadata_create_side_data(frame);
 321         if (!mastering) {
 322             res = AVERROR(ENOMEM);
 323             goto fail;
 324         }
 325
 326         for (int i = 0; i < 3; i++) {
 327             mastering->display_primaries[i][0] = av_make_q(p->mastering_display->primaries[i][0], 1 << 16);
 328             mastering->display_primaries[i][1] = av_make_q(p->mastering_display->primaries[i][1], 1 << 16);
 329         }
 330         mastering->white_point[0] = av_make_q(p->mastering_display->white_point[0], 1 << 16);
 331         mastering->white_point[1] = av_make_q(p->mastering_display->white_point[1], 1 << 16);
 332
 333         mastering->max_luminance = av_make_q(p->mastering_display->max_luminance, 1 << 8);
 334         mastering->min_luminance = av_make_q(p->mastering_display->min_luminance, 1 << 14);
 335
 336         mastering->has_primaries = 1;
 337         mastering->has_luminance = 1;
 338     }
 339     if (p->content_light) {
 340         AVContentLightMetadata *light = av_content_light_metadata_create_side_data(frame);
 341         if (!light) {
 342             res = AVERROR(ENOMEM);
 343             goto fail;
 344         }
 345         light->MaxCLL = p->content_light->max_content_light_level;
 346         light->MaxFALL = p->content_light->max_frame_average_light_level;
 347     }
 348
 349     res = 0;
 350 fail:
 351     dav1d_picture_unref(p);
 352     if (res < 0)
 353         av_frame_unref(frame);
 354     return res;
 355 }
 356
 357 static av_cold int libdav1d_close(AVCodecContext *c)
 358 {
 359     Libdav1dContext *dav1d = c->priv_data;
 360
 361     av_buffer_pool_uninit(&dav1d->pool);
 362     dav1d_data_unref(&dav1d->data);
 363     dav1d_close(&dav1d->c);
 364
 365     return 0;
 366 }
 367
 368 #define OFFSET(x) offsetof(Libdav1dContext, x)
 369 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
 370 static const AVOption libdav1d_options[] = {
 371     { "tilethreads", "Tile threads", OFFSET(tile_threads), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, DAV1D_MAX_TILE_THREADS, VD },
 372     { "framethreads", "Frame threads", OFFSET(frame_threads), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, DAV1D_MAX_FRAME_THREADS, VD },
 373     { "filmgrain", "Apply Film Grain", OFFSET(apply_grain), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, VD },
 374     { NULL }
 375 };
 376
 377 static const AVClass libdav1d_class = {
 378     .class_name = "libdav1d decoder",
 379     .item_name  = av_default_item_name,
 380     .option     = libdav1d_options,
 381     .version    = LIBAVUTIL_VERSION_INT,
 382 };
 383
 384 AVCodec ff_libdav1d_decoder = {
 385     .name           = "libdav1d",
 386     .long_name      = NULL_IF_CONFIG_SMALL("dav1d AV1 decoder by VideoLAN"),
 387     .type           = AVMEDIA_TYPE_VIDEO,
 388     .id             = AV_CODEC_ID_AV1,
 389     .priv_data_size = sizeof(Libdav1dContext),
 390     .init           = libdav1d_init,
 391     .close          = libdav1d_close,
 392     .flush          = libdav1d_flush,
 393     .receive_frame  = libdav1d_receive_frame,
 394     .capabilities   = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
 395     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE | FF_CODEC_CAP_SETS_PKT_DTS,
 396     .priv_class     = &libdav1d_class,
 397     .wrapper_name   = "libdav1d",
 398 };