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     int   forced_idr;
  46     char *preset;
  47     char *tune;
  48     char *profile;
  49     char *x265_opts;
  50 } libx265Context;
  51
  52 static int is_keyframe(NalUnitType naltype)
  53 {
  54     switch (naltype) {
  55     case NAL_UNIT_CODED_SLICE_BLA_W_LP:
  56     case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
  57     case NAL_UNIT_CODED_SLICE_BLA_N_LP:
  58     case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
  59     case NAL_UNIT_CODED_SLICE_IDR_N_LP:
  60     case NAL_UNIT_CODED_SLICE_CRA:
  61         return 1;
  62     default:
  63         return 0;
  64     }
  65 }
  66
  67 static av_cold int libx265_encode_close(AVCodecContext *avctx)
  68 {
  69     libx265Context *ctx = avctx->priv_data;
  70
  71     ctx->api->param_free(ctx->params);
  72
  73     if (ctx->encoder)
  74         ctx->api->encoder_close(ctx->encoder);
  75
  76     return 0;
  77 }
  78
  79 static av_cold int libx265_encode_init(AVCodecContext *avctx)
  80 {
  81     libx265Context *ctx = avctx->priv_data;
  82
  83     ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
  84     if (!ctx->api)
  85         ctx->api = x265_api_get(0);
  86
  87     ctx->params = ctx->api->param_alloc();
  88     if (!ctx->params) {
  89         av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
  90         return AVERROR(ENOMEM);
  91     }
  92
  93     if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
  94         int i;
  95
  96         av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", ctx->preset, ctx->tune);
  97         av_log(avctx, AV_LOG_INFO, "Possible presets:");
  98         for (i = 0; x265_preset_names[i]; i++)
  99             av_log(avctx, AV_LOG_INFO, " %s", x265_preset_names[i]);
 100
 101         av_log(avctx, AV_LOG_INFO, "\n");
 102         av_log(avctx, AV_LOG_INFO, "Possible tunes:");
 103         for (i = 0; x265_tune_names[i]; i++)
 104             av_log(avctx, AV_LOG_INFO, " %s", x265_tune_names[i]);
 105
 106         av_log(avctx, AV_LOG_INFO, "\n");
 107
 108         return AVERROR(EINVAL);
 109     }
 110
 111     ctx->params->frameNumThreads = avctx->thread_count;
 112     ctx->params->fpsNum          = avctx->time_base.den;
 113     ctx->params->fpsDenom        = avctx->time_base.num * avctx->ticks_per_frame;
 114     ctx->params->sourceWidth     = avctx->width;
 115     ctx->params->sourceHeight    = avctx->height;
 116     ctx->params->bEnablePsnr     = !!(avctx->flags & AV_CODEC_FLAG_PSNR);
 117
 118     /* Tune the CTU size based on input resolution. */
 119     if (ctx->params->sourceWidth < 64 || ctx->params->sourceHeight < 64)
 120         ctx->params->maxCUSize = 32;
 121     if (ctx->params->sourceWidth < 32 || ctx->params->sourceHeight < 32)
 122         ctx->params->maxCUSize = 16;
 123     if (ctx->params->sourceWidth < 16 || ctx->params->sourceHeight < 16) {
 124         av_log(avctx, AV_LOG_ERROR, "Image size is too small (%dx%d).\n",
 125                ctx->params->sourceWidth, ctx->params->sourceHeight);
 126         return AVERROR(EINVAL);
 127     }
 128
 129     if ((avctx->color_primaries <= AVCOL_PRI_SMPTE432 &&
 130          avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
 131         (avctx->color_trc <= AVCOL_TRC_ARIB_STD_B67 &&
 132          avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
 133         (avctx->colorspace <= AVCOL_SPC_ICTCP &&
 134          avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
 135
 136         ctx->params->vui.bEnableVideoSignalTypePresentFlag  = 1;
 137         ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
 138
 139         // x265 validates the parameters internally
 140         ctx->params->vui.colorPrimaries          = avctx->color_primaries;
 141         ctx->params->vui.transferCharacteristics = avctx->color_trc;
 142         ctx->params->vui.matrixCoeffs            = avctx->colorspace;
 143     }
 144
 145     if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
 146         char sar[12];
 147         int sar_num, sar_den;
 148
 149         av_reduce(&sar_num, &sar_den,
 150                   avctx->sample_aspect_ratio.num,
 151                   avctx->sample_aspect_ratio.den, 65535);
 152         snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
 153         if (ctx->api->param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
 154             av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
 155             return AVERROR_INVALIDDATA;
 156         }
 157     }
 158
 159     switch (avctx->pix_fmt) {
 160     case AV_PIX_FMT_YUV420P:
 161     case AV_PIX_FMT_YUV420P10:
 162     case AV_PIX_FMT_YUV420P12:
 163         ctx->params->internalCsp = X265_CSP_I420;
 164         break;
 165     case AV_PIX_FMT_YUV422P:
 166     case AV_PIX_FMT_YUV422P10:
 167     case AV_PIX_FMT_YUV422P12:
 168         ctx->params->internalCsp = X265_CSP_I422;
 169         break;
 170     case AV_PIX_FMT_GBRP:
 171     case AV_PIX_FMT_GBRP10:
 172     case AV_PIX_FMT_GBRP12:
 173         ctx->params->vui.matrixCoeffs = AVCOL_SPC_RGB;
 174         ctx->params->vui.bEnableVideoSignalTypePresentFlag  = 1;
 175         ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
 176     case AV_PIX_FMT_YUV444P:
 177     case AV_PIX_FMT_YUV444P10:
 178     case AV_PIX_FMT_YUV444P12:
 179         ctx->params->internalCsp = X265_CSP_I444;
 180         break;
 181     case AV_PIX_FMT_GRAY8:
 182     case AV_PIX_FMT_GRAY10:
 183     case AV_PIX_FMT_GRAY12:
 184         if (ctx->api->api_build_number < 85) {
 185             av_log(avctx, AV_LOG_ERROR,
 186                    "libx265 version is %d, must be at least 85 for gray encoding.\n",
 187                    ctx->api->api_build_number);
 188             return AVERROR_INVALIDDATA;
 189         }
 190         ctx->params->internalCsp = X265_CSP_I400;
 191         break;
 192     }
 193
 194     if (ctx->crf >= 0) {
 195         char crf[6];
 196
 197         snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
 198         if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
 199             av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
 200             return AVERROR(EINVAL);
 201         }
 202     } else if (avctx->bit_rate > 0) {
 203         ctx->params->rc.bitrate         = avctx->bit_rate / 1000;
 204         ctx->params->rc.rateControlMode = X265_RC_ABR;
 205     }
 206
 207     if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
 208         ctx->params->bRepeatHeaders = 1;
 209
 210     if (ctx->x265_opts) {
 211         AVDictionary *dict    = NULL;
 212         AVDictionaryEntry *en = NULL;
 213
 214         if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
 215             while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
 216                 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
 217
 218                 switch (parse_ret) {
 219                 case X265_PARAM_BAD_NAME:
 220                     av_log(avctx, AV_LOG_WARNING,
 221                           "Unknown option: %s.\n", en->key);
 222                     break;
 223                 case X265_PARAM_BAD_VALUE:
 224                     av_log(avctx, AV_LOG_WARNING,
 225                           "Invalid value for %s: %s.\n", en->key, en->value);
 226                     break;
 227                 default:
 228                     break;
 229                 }
 230             }
 231             av_dict_free(&dict);
 232         }
 233     }
 234
 235     if (ctx->profile) {
 236         if (ctx->api->param_apply_profile(ctx->params, ctx->profile) < 0) {
 237             int i;
 238             av_log(avctx, AV_LOG_ERROR, "Invalid or incompatible profile set: %s.\n", ctx->profile);
 239             av_log(avctx, AV_LOG_INFO, "Possible profiles:");
 240             for (i = 0; x265_profile_names[i]; i++)
 241                 av_log(avctx, AV_LOG_INFO, " %s", x265_profile_names[i]);
 242             av_log(avctx, AV_LOG_INFO, "\n");
 243             return AVERROR(EINVAL);
 244         }
 245     }
 246
 247     ctx->encoder = ctx->api->encoder_open(ctx->params);
 248     if (!ctx->encoder) {
 249         av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
 250         libx265_encode_close(avctx);
 251         return AVERROR_INVALIDDATA;
 252     }
 253
 254     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
 255         x265_nal *nal;
 256         int nnal;
 257
 258         avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
 259         if (avctx->extradata_size <= 0) {
 260             av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
 261             libx265_encode_close(avctx);
 262             return AVERROR_INVALIDDATA;
 263         }
 264
 265         avctx->extradata = av_malloc(avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
 266         if (!avctx->extradata) {
 267             av_log(avctx, AV_LOG_ERROR,
 268                    "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
 269             libx265_encode_close(avctx);
 270             return AVERROR(ENOMEM);
 271         }
 272
 273         memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
 274     }
 275
 276     return 0;
 277 }
 278
 279 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
 280                                 const AVFrame *pic, int *got_packet)
 281 {
 282     libx265Context *ctx = avctx->priv_data;
 283     x265_picture x265pic;
 284     x265_picture x265pic_out = { 0 };
 285     x265_nal *nal;
 286     uint8_t *dst;
 287     int payload = 0;
 288     int nnal;
 289     int ret;
 290     int i;
 291
 292     ctx->api->picture_init(ctx->params, &x265pic);
 293
 294     if (pic) {
 295         for (i = 0; i < 3; i++) {
 296            x265pic.planes[i] = pic->data[i];
 297            x265pic.stride[i] = pic->linesize[i];
 298         }
 299
 300         x265pic.pts      = pic->pts;
 301         x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
 302
 303         x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ?
 304                                               (ctx->forced_idr ? X265_TYPE_IDR : X265_TYPE_I) :
 305                             pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
 306                             pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
 307                             X265_TYPE_AUTO;
 308     }
 309
 310     ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
 311                                    pic ? &x265pic : NULL, &x265pic_out);
 312     if (ret < 0)
 313         return AVERROR_EXTERNAL;
 314
 315     if (!nnal)
 316         return 0;
 317
 318     for (i = 0; i < nnal; i++)
 319         payload += nal[i].sizeBytes;
 320
 321     ret = ff_alloc_packet2(avctx, pkt, payload, payload);
 322     if (ret < 0) {
 323         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
 324         return ret;
 325     }
 326     dst = pkt->data;
 327
 328     for (i = 0; i < nnal; i++) {
 329         memcpy(dst, nal[i].payload, nal[i].sizeBytes);
 330         dst += nal[i].sizeBytes;
 331
 332         if (is_keyframe(nal[i].type))
 333             pkt->flags |= AV_PKT_FLAG_KEY;
 334     }
 335
 336     pkt->pts = x265pic_out.pts;
 337     pkt->dts = x265pic_out.dts;
 338
 339 #if FF_API_CODED_FRAME
 340 FF_DISABLE_DEPRECATION_WARNINGS
 341     switch (x265pic_out.sliceType) {
 342     case X265_TYPE_IDR:
 343     case X265_TYPE_I:
 344         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
 345         break;
 346     case X265_TYPE_P:
 347         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
 348         break;
 349     case X265_TYPE_B:
 350         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
 351         break;
 352     }
 353 FF_ENABLE_DEPRECATION_WARNINGS
 354 #endif
 355
 356 #if X265_BUILD >= 130
 357     if (x265pic_out.sliceType == X265_TYPE_B)
 358 #else
 359     if (x265pic_out.frameData.sliceType == 'b')
 360 #endif
 361         pkt->flags |= AV_PKT_FLAG_DISPOSABLE;
 362
 363     *got_packet = 1;
 364     return 0;
 365 }
 366
 367 static const enum AVPixelFormat x265_csp_eight[] = {
 368     AV_PIX_FMT_YUV420P,
 369     AV_PIX_FMT_YUV422P,
 370     AV_PIX_FMT_YUV444P,
 371     AV_PIX_FMT_GBRP,
 372     AV_PIX_FMT_GRAY8,
 373     AV_PIX_FMT_NONE
 374 };
 375
 376 static const enum AVPixelFormat x265_csp_ten[] = {
 377     AV_PIX_FMT_YUV420P,
 378     AV_PIX_FMT_YUV422P,
 379     AV_PIX_FMT_YUV444P,
 380     AV_PIX_FMT_GBRP,
 381     AV_PIX_FMT_YUV420P10,
 382     AV_PIX_FMT_YUV422P10,
 383     AV_PIX_FMT_YUV444P10,
 384     AV_PIX_FMT_GBRP10,
 385     AV_PIX_FMT_GRAY8,
 386     AV_PIX_FMT_GRAY10,
 387     AV_PIX_FMT_NONE
 388 };
 389
 390 static const enum AVPixelFormat x265_csp_twelve[] = {
 391     AV_PIX_FMT_YUV420P,
 392     AV_PIX_FMT_YUV422P,
 393     AV_PIX_FMT_YUV444P,
 394     AV_PIX_FMT_GBRP,
 395     AV_PIX_FMT_YUV420P10,
 396     AV_PIX_FMT_YUV422P10,
 397     AV_PIX_FMT_YUV444P10,
 398     AV_PIX_FMT_GBRP10,
 399     AV_PIX_FMT_YUV420P12,
 400     AV_PIX_FMT_YUV422P12,
 401     AV_PIX_FMT_YUV444P12,
 402     AV_PIX_FMT_GBRP12,
 403     AV_PIX_FMT_GRAY8,
 404     AV_PIX_FMT_GRAY10,
 405     AV_PIX_FMT_GRAY12,
 406     AV_PIX_FMT_NONE
 407 };
 408
 409 static av_cold void libx265_encode_init_csp(AVCodec *codec)
 410 {
 411     if (x265_api_get(12))
 412         codec->pix_fmts = x265_csp_twelve;
 413     else if (x265_api_get(10))
 414         codec->pix_fmts = x265_csp_ten;
 415     else if (x265_api_get(8))
 416         codec->pix_fmts = x265_csp_eight;
 417 }
 418
 419 #define OFFSET(x) offsetof(libx265Context, x)
 420 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 421 static const AVOption options[] = {
 422     { "crf",         "set the x265 crf",                                                            OFFSET(crf),       AV_OPT_TYPE_FLOAT,  { .dbl = -1 }, -1, FLT_MAX, VE },
 423     { "forced-idr",  "if forcing keyframes, force them as IDR frames",                              OFFSET(forced_idr),AV_OPT_TYPE_BOOL,   { .i64 =  0 },  0,       1, VE },
 424     { "preset",      "set the x265 preset",                                                         OFFSET(preset),    AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
 425     { "tune",        "set the x265 tune parameter",                                                 OFFSET(tune),      AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
 426     { "profile",     "set the x265 profile",                                                        OFFSET(profile),   AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
 427     { "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 },
 428     { NULL }
 429 };
 430
 431 static const AVClass class = {
 432     .class_name = "libx265",
 433     .item_name  = av_default_item_name,
 434     .option     = options,
 435     .version    = LIBAVUTIL_VERSION_INT,
 436 };
 437
 438 static const AVCodecDefault x265_defaults[] = {
 439     { "b", "0" },
 440     { NULL },
 441 };
 442
 443 AVCodec ff_libx265_encoder = {
 444     .name             = "libx265",
 445     .long_name        = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
 446     .type             = AVMEDIA_TYPE_VIDEO,
 447     .id               = AV_CODEC_ID_HEVC,
 448     .init             = libx265_encode_init,
 449     .init_static_data = libx265_encode_init_csp,
 450     .encode2          = libx265_encode_frame,
 451     .close            = libx265_encode_close,
 452     .priv_data_size   = sizeof(libx265Context),
 453     .priv_class       = &class,
 454     .defaults         = x265_defaults,
 455     .capabilities     = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
 456     .wrapper_name     = "libx265",
 457 };