git.sesse.net Git - ffmpeg/blob - libavcodec/libvpxdec.c

   1 /*
   2  * Copyright (c) 2010, Google, Inc.
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * VP8/9 decoder support via libvpx
  24  */
  25
  26 #define VPX_CODEC_DISABLE_COMPAT 1
  27 #include <vpx/vpx_decoder.h>
  28 #include <vpx/vpx_frame_buffer.h>
  29 #include <vpx/vp8dx.h>
  30
  31 #include "libavutil/common.h"
  32 #include "libavutil/imgutils.h"
  33 #include "libavutil/intreadwrite.h"
  34 #include "avcodec.h"
  35 #include "internal.h"
  36 #include "libvpx.h"
  37 #include "profiles.h"
  38
  39 typedef struct VPxDecoderContext {
  40     struct vpx_codec_ctx decoder;
  41     struct vpx_codec_ctx decoder_alpha;
  42     AVBufferPool *pool;
  43     size_t pool_size;
  44     int has_alpha_channel;
  45 } VPxContext;
  46
  47
  48 static int get_frame_buffer(void *priv, size_t min_size, vpx_codec_frame_buffer_t *fb)
  49 {
  50     VPxContext *ctx = priv;
  51     AVBufferRef *buf;
  52
  53     if (min_size > ctx->pool_size) {
  54         av_buffer_pool_uninit(&ctx->pool);
  55         /* According to the libvpx docs the buffer must be zeroed out. */
  56         ctx->pool = av_buffer_pool_init(min_size, av_buffer_allocz);
  57         if (!ctx->pool) {
  58             ctx->pool_size = 0;
  59             return AVERROR(ENOMEM);
  60         }
  61         ctx->pool_size = min_size;
  62     }
  63
  64     buf = av_buffer_pool_get(ctx->pool);
  65     if (!buf)
  66         return AVERROR(ENOMEM);
  67
  68     fb->priv = buf;
  69     fb->size = ctx->pool_size;
  70     fb->data = buf->data;
  71
  72     return 0;
  73 }
  74
  75 static int release_frame_buffer(void *priv, vpx_codec_frame_buffer_t *fb)
  76 {
  77     AVBufferRef *buf = fb->priv;
  78     av_buffer_unref(&buf);
  79     return 0;
  80 }
  81
  82 static av_cold int vpx_init(AVCodecContext *avctx,
  83                             struct vpx_codec_ctx* decoder,
  84                             const struct vpx_codec_iface *iface)
  85 {
  86     struct vpx_codec_dec_cfg deccfg = {
  87         .threads = FFMIN(avctx->thread_count ? avctx->thread_count : av_cpu_count(), 16)
  88     };
  89
  90     av_log(avctx, AV_LOG_INFO, "%s\n", vpx_codec_version_str());
  91     av_log(avctx, AV_LOG_VERBOSE, "%s\n", vpx_codec_build_config());
  92
  93     if (vpx_codec_dec_init(decoder, iface, &deccfg, 0) != VPX_CODEC_OK) {
  94         const char *error = vpx_codec_error(decoder);
  95         av_log(avctx, AV_LOG_ERROR, "Failed to initialize decoder: %s\n",
  96                error);
  97         return AVERROR(EINVAL);
  98     }
  99
 100     if (avctx->codec_id == AV_CODEC_ID_VP9)
 101         vpx_codec_set_frame_buffer_functions(decoder, get_frame_buffer, release_frame_buffer, avctx->priv_data);
 102
 103     return 0;
 104 }
 105
 106 // returns 0 on success, AVERROR_INVALIDDATA otherwise
 107 static int set_pix_fmt(AVCodecContext *avctx, struct vpx_image *img,
 108                        int has_alpha_channel)
 109 {
 110     static const enum AVColorSpace colorspaces[8] = {
 111         AVCOL_SPC_UNSPECIFIED, AVCOL_SPC_BT470BG, AVCOL_SPC_BT709, AVCOL_SPC_SMPTE170M,
 112         AVCOL_SPC_SMPTE240M, AVCOL_SPC_BT2020_NCL, AVCOL_SPC_RESERVED, AVCOL_SPC_RGB,
 113     };
 114 #if VPX_IMAGE_ABI_VERSION >= 4
 115     static const enum AVColorRange color_ranges[] = {
 116         AVCOL_RANGE_MPEG, AVCOL_RANGE_JPEG
 117     };
 118     avctx->color_range = color_ranges[img->range];
 119 #endif
 120     avctx->colorspace = colorspaces[img->cs];
 121     if (avctx->codec_id == AV_CODEC_ID_VP8 && img->fmt != VPX_IMG_FMT_I420)
 122         return AVERROR_INVALIDDATA;
 123     switch (img->fmt) {
 124     case VPX_IMG_FMT_I420:
 125         if (avctx->codec_id == AV_CODEC_ID_VP9)
 126             avctx->profile = FF_PROFILE_VP9_0;
 127         avctx->pix_fmt =
 128             has_alpha_channel ? AV_PIX_FMT_YUVA420P : AV_PIX_FMT_YUV420P;
 129         return 0;
 130 #if CONFIG_LIBVPX_VP9_DECODER
 131     case VPX_IMG_FMT_I422:
 132         avctx->profile = FF_PROFILE_VP9_1;
 133         avctx->pix_fmt = AV_PIX_FMT_YUV422P;
 134         return 0;
 135     case VPX_IMG_FMT_I440:
 136         avctx->profile = FF_PROFILE_VP9_1;
 137         avctx->pix_fmt = AV_PIX_FMT_YUV440P;
 138         return 0;
 139     case VPX_IMG_FMT_I444:
 140         avctx->profile = FF_PROFILE_VP9_1;
 141         avctx->pix_fmt = avctx->colorspace == AVCOL_SPC_RGB ?
 142                          AV_PIX_FMT_GBRP : AV_PIX_FMT_YUV444P;
 143         return 0;
 144     case VPX_IMG_FMT_I42016:
 145         avctx->profile = FF_PROFILE_VP9_2;
 146         if (img->bit_depth == 10) {
 147             avctx->pix_fmt = AV_PIX_FMT_YUV420P10;
 148             return 0;
 149         } else if (img->bit_depth == 12) {
 150             avctx->pix_fmt = AV_PIX_FMT_YUV420P12;
 151             return 0;
 152         } else {
 153             return AVERROR_INVALIDDATA;
 154         }
 155     case VPX_IMG_FMT_I42216:
 156         avctx->profile = FF_PROFILE_VP9_3;
 157         if (img->bit_depth == 10) {
 158             avctx->pix_fmt = AV_PIX_FMT_YUV422P10;
 159             return 0;
 160         } else if (img->bit_depth == 12) {
 161             avctx->pix_fmt = AV_PIX_FMT_YUV422P12;
 162             return 0;
 163         } else {
 164             return AVERROR_INVALIDDATA;
 165         }
 166     case VPX_IMG_FMT_I44016:
 167         avctx->profile = FF_PROFILE_VP9_3;
 168         if (img->bit_depth == 10) {
 169             avctx->pix_fmt = AV_PIX_FMT_YUV440P10;
 170             return 0;
 171         } else if (img->bit_depth == 12) {
 172             avctx->pix_fmt = AV_PIX_FMT_YUV440P12;
 173             return 0;
 174         } else {
 175             return AVERROR_INVALIDDATA;
 176         }
 177     case VPX_IMG_FMT_I44416:
 178         avctx->profile = FF_PROFILE_VP9_3;
 179         if (img->bit_depth == 10) {
 180             avctx->pix_fmt = avctx->colorspace == AVCOL_SPC_RGB ?
 181                              AV_PIX_FMT_GBRP10 : AV_PIX_FMT_YUV444P10;
 182             return 0;
 183         } else if (img->bit_depth == 12) {
 184             avctx->pix_fmt = avctx->colorspace == AVCOL_SPC_RGB ?
 185                              AV_PIX_FMT_GBRP12 : AV_PIX_FMT_YUV444P12;
 186             return 0;
 187         } else {
 188             return AVERROR_INVALIDDATA;
 189         }
 190 #endif
 191     default:
 192         return AVERROR_INVALIDDATA;
 193     }
 194 }
 195
 196 static int decode_frame(AVCodecContext *avctx, vpx_codec_ctx_t *decoder,
 197                         uint8_t *data, uint32_t data_sz)
 198 {
 199     if (vpx_codec_decode(decoder, data, data_sz, NULL, 0) != VPX_CODEC_OK) {
 200         const char *error  = vpx_codec_error(decoder);
 201         const char *detail = vpx_codec_error_detail(decoder);
 202
 203         av_log(avctx, AV_LOG_ERROR, "Failed to decode frame: %s\n", error);
 204         if (detail) {
 205             av_log(avctx, AV_LOG_ERROR, "  Additional information: %s\n",
 206                    detail);
 207         }
 208         return AVERROR_INVALIDDATA;
 209     }
 210     return 0;
 211 }
 212
 213 static int vpx_decode(AVCodecContext *avctx,
 214                       void *data, int *got_frame, AVPacket *avpkt)
 215 {
 216     VPxContext *ctx = avctx->priv_data;
 217     AVFrame *picture = data;
 218     const void *iter = NULL;
 219     const void *iter_alpha = NULL;
 220     struct vpx_image *img, *img_alpha;
 221     int ret;
 222     uint8_t *side_data = NULL;
 223     int side_data_size = 0;
 224
 225     ret = decode_frame(avctx, &ctx->decoder, avpkt->data, avpkt->size);
 226     if (ret)
 227         return ret;
 228
 229     side_data = av_packet_get_side_data(avpkt,
 230                                         AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
 231                                         &side_data_size);
 232     if (side_data_size >= 8) {
 233         const uint64_t additional_id = AV_RB64(side_data);
 234         side_data += 8;
 235         side_data_size -= 8;
 236         if (additional_id == 1) {  // 1 stands for alpha channel data.
 237             if (!ctx->has_alpha_channel) {
 238                 ctx->has_alpha_channel = 1;
 239                 ret = vpx_init(avctx,
 240                                &ctx->decoder_alpha,
 241 #if CONFIG_LIBVPX_VP8_DECODER && CONFIG_LIBVPX_VP9_DECODER
 242                                (avctx->codec_id == AV_CODEC_ID_VP8) ?
 243                                &vpx_codec_vp8_dx_algo : &vpx_codec_vp9_dx_algo
 244 #elif CONFIG_LIBVPX_VP8_DECODER
 245                                &vpx_codec_vp8_dx_algo
 246 #else
 247                                &vpx_codec_vp9_dx_algo
 248 #endif
 249                                );
 250                 if (ret)
 251                     return ret;
 252             }
 253             ret = decode_frame(avctx, &ctx->decoder_alpha, side_data,
 254                                side_data_size);
 255             if (ret)
 256                 return ret;
 257         }
 258     }
 259
 260     if ((img = vpx_codec_get_frame(&ctx->decoder, &iter)) &&
 261         (!ctx->has_alpha_channel ||
 262          (img_alpha = vpx_codec_get_frame(&ctx->decoder_alpha, &iter_alpha)))) {
 263         uint8_t *planes[4];
 264         int linesizes[4];
 265
 266         if (img->d_w > img->w || img->d_h > img->h) {
 267             av_log(avctx, AV_LOG_ERROR, "Display dimensions %dx%d exceed storage %dx%d\n",
 268                    img->d_w, img->d_h, img->w, img->h);
 269             return AVERROR_EXTERNAL;
 270         }
 271
 272         if ((ret = set_pix_fmt(avctx, img, ctx->has_alpha_channel)) < 0) {
 273             av_log(avctx, AV_LOG_ERROR, "Unsupported output colorspace (%d) / bit_depth (%d)\n",
 274                    img->fmt, img->bit_depth);
 275             return ret;
 276         }
 277
 278         if ((int) img->d_w != avctx->width || (int) img->d_h != avctx->height) {
 279             av_log(avctx, AV_LOG_INFO, "dimension change! %dx%d -> %dx%d\n",
 280                    avctx->width, avctx->height, img->d_w, img->d_h);
 281             ret = ff_set_dimensions(avctx, img->d_w, img->d_h);
 282             if (ret < 0)
 283                 return ret;
 284         }
 285
 286         planes[0] = img->planes[VPX_PLANE_Y];
 287         planes[1] = img->planes[VPX_PLANE_U];
 288         planes[2] = img->planes[VPX_PLANE_V];
 289         planes[3] =
 290             ctx->has_alpha_channel ? img_alpha->planes[VPX_PLANE_Y] : NULL;
 291         linesizes[0] = img->stride[VPX_PLANE_Y];
 292         linesizes[1] = img->stride[VPX_PLANE_U];
 293         linesizes[2] = img->stride[VPX_PLANE_V];
 294         linesizes[3] =
 295             ctx->has_alpha_channel ? img_alpha->stride[VPX_PLANE_Y] : 0;
 296
 297         if (img->fb_priv && (!ctx->has_alpha_channel || img_alpha->fb_priv)) {
 298             ret = ff_decode_frame_props(avctx, picture);
 299             if (ret < 0)
 300                 return ret;
 301             picture->buf[0] = av_buffer_ref(img->fb_priv);
 302             if (!picture->buf[0])
 303                 return AVERROR(ENOMEM);
 304             if (ctx->has_alpha_channel) {
 305                 picture->buf[1] = av_buffer_ref(img_alpha->fb_priv);
 306                 if (!picture->buf[1]) {
 307                     av_frame_unref(picture);
 308                     return AVERROR(ENOMEM);
 309                 }
 310             }
 311             for (int i = 0; i < 4; i++) {
 312                 picture->data[i] = planes[i];
 313                 picture->linesize[i] = linesizes[i];
 314             }
 315         } else {
 316             if ((ret = ff_get_buffer(avctx, picture, 0)) < 0)
 317                 return ret;
 318             av_image_copy(picture->data, picture->linesize, (const uint8_t**)planes,
 319                           linesizes, avctx->pix_fmt, img->d_w, img->d_h);
 320         }
 321         *got_frame           = 1;
 322     }
 323     return avpkt->size;
 324 }
 325
 326 static av_cold int vpx_free(AVCodecContext *avctx)
 327 {
 328     VPxContext *ctx = avctx->priv_data;
 329     vpx_codec_destroy(&ctx->decoder);
 330     if (ctx->has_alpha_channel)
 331         vpx_codec_destroy(&ctx->decoder_alpha);
 332     av_buffer_pool_uninit(&ctx->pool);
 333     return 0;
 334 }
 335
 336 #if CONFIG_LIBVPX_VP8_DECODER
 337 static av_cold int vp8_init(AVCodecContext *avctx)
 338 {
 339     VPxContext *ctx = avctx->priv_data;
 340     return vpx_init(avctx, &ctx->decoder, &vpx_codec_vp8_dx_algo);
 341 }
 342
 343 AVCodec ff_libvpx_vp8_decoder = {
 344     .name           = "libvpx",
 345     .long_name      = NULL_IF_CONFIG_SMALL("libvpx VP8"),
 346     .type           = AVMEDIA_TYPE_VIDEO,
 347     .id             = AV_CODEC_ID_VP8,
 348     .priv_data_size = sizeof(VPxContext),
 349     .init           = vp8_init,
 350     .close          = vpx_free,
 351     .decode         = vpx_decode,
 352     .capabilities   = AV_CODEC_CAP_AUTO_THREADS | AV_CODEC_CAP_DR1,
 353     .wrapper_name   = "libvpx",
 354 };
 355 #endif /* CONFIG_LIBVPX_VP8_DECODER */
 356
 357 #if CONFIG_LIBVPX_VP9_DECODER
 358 static av_cold int vp9_init(AVCodecContext *avctx)
 359 {
 360     VPxContext *ctx = avctx->priv_data;
 361     return vpx_init(avctx, &ctx->decoder, &vpx_codec_vp9_dx_algo);
 362 }
 363
 364 AVCodec ff_libvpx_vp9_decoder = {
 365     .name           = "libvpx-vp9",
 366     .long_name      = NULL_IF_CONFIG_SMALL("libvpx VP9"),
 367     .type           = AVMEDIA_TYPE_VIDEO,
 368     .id             = AV_CODEC_ID_VP9,
 369     .priv_data_size = sizeof(VPxContext),
 370     .init           = vp9_init,
 371     .close          = vpx_free,
 372     .decode         = vpx_decode,
 373     .capabilities   = AV_CODEC_CAP_AUTO_THREADS,
 374     .init_static_data = ff_vp9_init_static,
 375     .profiles       = NULL_IF_CONFIG_SMALL(ff_vp9_profiles),
 376     .wrapper_name   = "libvpx",
 377 };
 378 #endif /* CONFIG_LIBVPX_VP9_DECODER */