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