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

   1 /*
   2  * libx265 encoder
   3  *
   4  * Copyright (c) 2013-2014 Derek Buitenhuis
   5  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * FFmpeg is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with FFmpeg; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #if defined(_MSC_VER)
  24 #define X265_API_IMPORTS 1
  25 #endif
  26
  27 #include <x265.h>
  28 #include <float.h>
  29
  30 #include "libavutil/internal.h"
  31 #include "libavutil/common.h"
  32 #include "libavutil/opt.h"
  33 #include "libavutil/pixdesc.h"
  34 #include "avcodec.h"
  35 #include "internal.h"
  36
  37 typedef struct libx265Context {
  38     const AVClass *class;
  39
  40     x265_encoder *encoder;
  41     x265_param   *params;
  42     const x265_api *api;
  43
  44     float crf;
  45     char *preset;
  46     char *tune;
  47     char *x265_opts;
  48 } libx265Context;
  49
  50 static int is_keyframe(NalUnitType naltype)
  51 {
  52     switch (naltype) {
  53     case NAL_UNIT_CODED_SLICE_BLA_W_LP:
  54     case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
  55     case NAL_UNIT_CODED_SLICE_BLA_N_LP:
  56     case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
  57     case NAL_UNIT_CODED_SLICE_IDR_N_LP:
  58     case NAL_UNIT_CODED_SLICE_CRA:
  59         return 1;
  60     default:
  61         return 0;
  62     }
  63 }
  64
  65 static av_cold int libx265_encode_close(AVCodecContext *avctx)
  66 {
  67     libx265Context *ctx = avctx->priv_data;
  68
  69     ctx->api->param_free(ctx->params);
  70
  71     if (ctx->encoder)
  72         ctx->api->encoder_close(ctx->encoder);
  73
  74     return 0;
  75 }
  76
  77 static av_cold int libx265_encode_init(AVCodecContext *avctx)
  78 {
  79     libx265Context *ctx = avctx->priv_data;
  80
  81     ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
  82     if (!ctx->api)
  83         ctx->api = x265_api_get(0);
  84
  85     ctx->params = ctx->api->param_alloc();
  86     if (!ctx->params) {
  87         av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
  88         return AVERROR(ENOMEM);
  89     }
  90
  91     if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
  92         int i;
  93
  94         av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", ctx->preset, ctx->tune);
  95         av_log(avctx, AV_LOG_INFO, "Possible presets:");
  96         for (i = 0; x265_preset_names[i]; i++)
  97             av_log(avctx, AV_LOG_INFO, " %s", x265_preset_names[i]);
  98
  99         av_log(avctx, AV_LOG_INFO, "\n");
 100         av_log(avctx, AV_LOG_INFO, "Possible tunes:");
 101         for (i = 0; x265_tune_names[i]; i++)
 102             av_log(avctx, AV_LOG_INFO, " %s", x265_tune_names[i]);
 103
 104         av_log(avctx, AV_LOG_INFO, "\n");
 105
 106         return AVERROR(EINVAL);
 107     }
 108
 109     ctx->params->frameNumThreads = avctx->thread_count;
 110     ctx->params->fpsNum          = avctx->time_base.den;
 111     ctx->params->fpsDenom        = avctx->time_base.num * avctx->ticks_per_frame;
 112     ctx->params->sourceWidth     = avctx->width;
 113     ctx->params->sourceHeight    = avctx->height;
 114     ctx->params->bEnablePsnr     = !!(avctx->flags & AV_CODEC_FLAG_PSNR);
 115
 116     if ((avctx->color_primaries <= AVCOL_PRI_BT2020 &&
 117          avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
 118         (avctx->color_trc <= AVCOL_TRC_BT2020_12 &&
 119          avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
 120         (avctx->colorspace <= AVCOL_SPC_BT2020_CL &&
 121          avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
 122
 123         ctx->params->vui.bEnableVideoSignalTypePresentFlag  = 1;
 124         ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
 125
 126         // x265 validates the parameters internally
 127         ctx->params->vui.colorPrimaries          = avctx->color_primaries;
 128         ctx->params->vui.transferCharacteristics = avctx->color_trc;
 129         ctx->params->vui.matrixCoeffs            = avctx->colorspace;
 130     }
 131
 132     if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
 133         char sar[12];
 134         int sar_num, sar_den;
 135
 136         av_reduce(&sar_num, &sar_den,
 137                   avctx->sample_aspect_ratio.num,
 138                   avctx->sample_aspect_ratio.den, 65535);
 139         snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
 140         if (ctx->api->param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
 141             av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
 142             return AVERROR_INVALIDDATA;
 143         }
 144     }
 145
 146     switch (avctx->pix_fmt) {
 147     case AV_PIX_FMT_YUV420P:
 148     case AV_PIX_FMT_YUV420P10:
 149     case AV_PIX_FMT_YUV420P12:
 150         ctx->params->internalCsp = X265_CSP_I420;
 151         break;
 152     case AV_PIX_FMT_YUV422P:
 153     case AV_PIX_FMT_YUV422P10:
 154     case AV_PIX_FMT_YUV422P12:
 155         ctx->params->internalCsp = X265_CSP_I422;
 156         break;
 157     case AV_PIX_FMT_GBRP:
 158     case AV_PIX_FMT_GBRP10:
 159     case AV_PIX_FMT_GBRP12:
 160         ctx->params->vui.matrixCoeffs = AVCOL_SPC_RGB;
 161         ctx->params->vui.bEnableVideoSignalTypePresentFlag  = 1;
 162         ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
 163     case AV_PIX_FMT_YUV444P:
 164     case AV_PIX_FMT_YUV444P10:
 165     case AV_PIX_FMT_YUV444P12:
 166         ctx->params->internalCsp = X265_CSP_I444;
 167         break;
 168     }
 169
 170     if (ctx->crf >= 0) {
 171         char crf[6];
 172
 173         snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
 174         if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
 175             av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
 176             return AVERROR(EINVAL);
 177         }
 178     } else if (avctx->bit_rate > 0) {
 179         ctx->params->rc.bitrate         = avctx->bit_rate / 1000;
 180         ctx->params->rc.rateControlMode = X265_RC_ABR;
 181     }
 182
 183     if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
 184         ctx->params->bRepeatHeaders = 1;
 185
 186     if (ctx->x265_opts) {
 187         AVDictionary *dict    = NULL;
 188         AVDictionaryEntry *en = NULL;
 189
 190         if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
 191             while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
 192                 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
 193
 194                 switch (parse_ret) {
 195                 case X265_PARAM_BAD_NAME:
 196                     av_log(avctx, AV_LOG_WARNING,
 197                           "Unknown option: %s.\n", en->key);
 198                     break;
 199                 case X265_PARAM_BAD_VALUE:
 200                     av_log(avctx, AV_LOG_WARNING,
 201                           "Invalid value for %s: %s.\n", en->key, en->value);
 202                     break;
 203                 default:
 204                     break;
 205                 }
 206             }
 207             av_dict_free(&dict);
 208         }
 209     }
 210
 211     ctx->encoder = ctx->api->encoder_open(ctx->params);
 212     if (!ctx->encoder) {
 213         av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
 214         libx265_encode_close(avctx);
 215         return AVERROR_INVALIDDATA;
 216     }
 217
 218     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
 219         x265_nal *nal;
 220         int nnal;
 221
 222         avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
 223         if (avctx->extradata_size <= 0) {
 224             av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
 225             libx265_encode_close(avctx);
 226             return AVERROR_INVALIDDATA;
 227         }
 228
 229         avctx->extradata = av_malloc(avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
 230         if (!avctx->extradata) {
 231             av_log(avctx, AV_LOG_ERROR,
 232                    "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
 233             libx265_encode_close(avctx);
 234             return AVERROR(ENOMEM);
 235         }
 236
 237         memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
 238     }
 239
 240     return 0;
 241 }
 242
 243 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
 244                                 const AVFrame *pic, int *got_packet)
 245 {
 246     libx265Context *ctx = avctx->priv_data;
 247     x265_picture x265pic;
 248     x265_picture x265pic_out = { 0 };
 249     x265_nal *nal;
 250     uint8_t *dst;
 251     int payload = 0;
 252     int nnal;
 253     int ret;
 254     int i;
 255
 256     ctx->api->picture_init(ctx->params, &x265pic);
 257
 258     if (pic) {
 259         for (i = 0; i < 3; i++) {
 260            x265pic.planes[i] = pic->data[i];
 261            x265pic.stride[i] = pic->linesize[i];
 262         }
 263
 264         x265pic.pts      = pic->pts;
 265         x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
 266
 267         x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ? X265_TYPE_I :
 268                             pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
 269                             pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
 270                             X265_TYPE_AUTO;
 271     }
 272
 273     ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
 274                                    pic ? &x265pic : NULL, &x265pic_out);
 275     if (ret < 0)
 276         return AVERROR_EXTERNAL;
 277
 278     if (!nnal)
 279         return 0;
 280
 281     for (i = 0; i < nnal; i++)
 282         payload += nal[i].sizeBytes;
 283
 284     ret = ff_alloc_packet(pkt, payload);
 285     if (ret < 0) {
 286         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
 287         return ret;
 288     }
 289     dst = pkt->data;
 290
 291     for (i = 0; i < nnal; i++) {
 292         memcpy(dst, nal[i].payload, nal[i].sizeBytes);
 293         dst += nal[i].sizeBytes;
 294
 295         if (is_keyframe(nal[i].type))
 296             pkt->flags |= AV_PKT_FLAG_KEY;
 297     }
 298
 299     pkt->pts = x265pic_out.pts;
 300     pkt->dts = x265pic_out.dts;
 301
 302 #if FF_API_CODED_FRAME
 303 FF_DISABLE_DEPRECATION_WARNINGS
 304     switch (x265pic_out.sliceType) {
 305     case X265_TYPE_IDR:
 306     case X265_TYPE_I:
 307         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
 308         break;
 309     case X265_TYPE_P:
 310         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
 311         break;
 312     case X265_TYPE_B:
 313         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
 314         break;
 315     }
 316 FF_ENABLE_DEPRECATION_WARNINGS
 317 #endif
 318
 319     *got_packet = 1;
 320     return 0;
 321 }
 322
 323 static const enum AVPixelFormat x265_csp_eight[] = {
 324     AV_PIX_FMT_YUV420P,
 325     AV_PIX_FMT_YUV422P,
 326     AV_PIX_FMT_YUV444P,
 327     AV_PIX_FMT_GBRP,
 328     AV_PIX_FMT_NONE
 329 };
 330
 331 static const enum AVPixelFormat x265_csp_ten[] = {
 332     AV_PIX_FMT_YUV420P,
 333     AV_PIX_FMT_YUV422P,
 334     AV_PIX_FMT_YUV444P,
 335     AV_PIX_FMT_GBRP,
 336     AV_PIX_FMT_YUV420P10,
 337     AV_PIX_FMT_YUV422P10,
 338     AV_PIX_FMT_YUV444P10,
 339     AV_PIX_FMT_GBRP10,
 340     AV_PIX_FMT_NONE
 341 };
 342
 343 static const enum AVPixelFormat x265_csp_twelve[] = {
 344     AV_PIX_FMT_YUV420P,
 345     AV_PIX_FMT_YUV422P,
 346     AV_PIX_FMT_YUV444P,
 347     AV_PIX_FMT_GBRP,
 348     AV_PIX_FMT_YUV420P10,
 349     AV_PIX_FMT_YUV422P10,
 350     AV_PIX_FMT_YUV444P10,
 351     AV_PIX_FMT_GBRP10,
 352     AV_PIX_FMT_YUV420P12,
 353     AV_PIX_FMT_YUV422P12,
 354     AV_PIX_FMT_YUV444P12,
 355     AV_PIX_FMT_GBRP12,
 356     AV_PIX_FMT_NONE
 357 };
 358
 359 static av_cold void libx265_encode_init_csp(AVCodec *codec)
 360 {
 361     if (x265_api_get(12))
 362         codec->pix_fmts = x265_csp_twelve;
 363     else if (x265_api_get(10))
 364         codec->pix_fmts = x265_csp_ten;
 365     else if (x265_api_get(8))
 366         codec->pix_fmts = x265_csp_eight;
 367 }
 368
 369 #define OFFSET(x) offsetof(libx265Context, x)
 370 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 371 static const AVOption options[] = {
 372     { "crf",         "set the x265 crf",                                                            OFFSET(crf),       AV_OPT_TYPE_FLOAT,  { .dbl = -1 }, -1, FLT_MAX, VE },
 373     { "preset",      "set the x265 preset",                                                         OFFSET(preset),    AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
 374     { "tune",        "set the x265 tune parameter",                                                 OFFSET(tune),      AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
 375     { "x265-params", "set the x265 configuration using a :-separated list of key=value parameters", OFFSET(x265_opts), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
 376     { NULL }
 377 };
 378
 379 static const AVClass class = {
 380     .class_name = "libx265",
 381     .item_name  = av_default_item_name,
 382     .option     = options,
 383     .version    = LIBAVUTIL_VERSION_INT,
 384 };
 385
 386 static const AVCodecDefault x265_defaults[] = {
 387     { "b", "0" },
 388     { NULL },
 389 };
 390
 391 AVCodec ff_libx265_encoder = {
 392     .name             = "libx265",
 393     .long_name        = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
 394     .type             = AVMEDIA_TYPE_VIDEO,
 395     .id               = AV_CODEC_ID_HEVC,
 396     .init             = libx265_encode_init,
 397     .init_static_data = libx265_encode_init_csp,
 398     .encode2          = libx265_encode_frame,
 399     .close            = libx265_encode_close,
 400     .priv_data_size   = sizeof(libx265Context),
 401     .priv_class       = &class,
 402     .defaults         = x265_defaults,
 403     .capabilities     = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
 404 };