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

   1 /*
   2  * H.264 encoding using the x264 library
   3  * Copyright (C) 2005  Mans Rullgard <mans@mansr.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 "libavutil/opt.h"
  23 #include "avcodec.h"
  24 #include <x264.h>
  25 #include <math.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 typedef struct X264Context {
  31     AVClass        *class;
  32     x264_param_t    params;
  33     x264_t         *enc;
  34     x264_picture_t  pic;
  35     uint8_t        *sei;
  36     int             sei_size;
  37     AVFrame         out_pic;
  38     char *preset;
  39     char *tune;
  40     char *profile;
  41     char *level;
  42     int fastfirstpass;
  43     char *stats;
  44     char *weightp;
  45     char *x264opts;
  46 } X264Context;
  47
  48 static void X264_log(void *p, int level, const char *fmt, va_list args)
  49 {
  50     static const int level_map[] = {
  51         [X264_LOG_ERROR]   = AV_LOG_ERROR,
  52         [X264_LOG_WARNING] = AV_LOG_WARNING,
  53         [X264_LOG_INFO]    = AV_LOG_INFO,
  54         [X264_LOG_DEBUG]   = AV_LOG_DEBUG
  55     };
  56
  57     if (level < 0 || level > X264_LOG_DEBUG)
  58         return;
  59
  60     av_vlog(p, level_map[level], fmt, args);
  61 }
  62
  63
  64 static int encode_nals(AVCodecContext *ctx, uint8_t *buf, int size,
  65                        x264_nal_t *nals, int nnal, int skip_sei)
  66 {
  67     X264Context *x4 = ctx->priv_data;
  68     uint8_t *p = buf;
  69     int i;
  70
  71     /* Write the SEI as part of the first frame. */
  72     if (x4->sei_size > 0 && nnal > 0) {
  73         memcpy(p, x4->sei, x4->sei_size);
  74         p += x4->sei_size;
  75         x4->sei_size = 0;
  76     }
  77
  78     for (i = 0; i < nnal; i++){
  79         /* Don't put the SEI in extradata. */
  80         if (skip_sei && nals[i].i_type == NAL_SEI) {
  81             x4->sei_size = nals[i].i_payload;
  82             x4->sei      = av_malloc(x4->sei_size);
  83             memcpy(x4->sei, nals[i].p_payload, nals[i].i_payload);
  84             continue;
  85         }
  86         memcpy(p, nals[i].p_payload, nals[i].i_payload);
  87         p += nals[i].i_payload;
  88     }
  89
  90     return p - buf;
  91 }
  92
  93 static int X264_frame(AVCodecContext *ctx, uint8_t *buf,
  94                       int bufsize, void *data)
  95 {
  96     X264Context *x4 = ctx->priv_data;
  97     AVFrame *frame = data;
  98     x264_nal_t *nal;
  99     int nnal, i;
 100     x264_picture_t pic_out;
 101
 102     x264_picture_init( &x4->pic );
 103     x4->pic.img.i_csp   = X264_CSP_I420;
 104     x4->pic.img.i_plane = 3;
 105
 106     if (frame) {
 107         for (i = 0; i < 3; i++) {
 108             x4->pic.img.plane[i]    = frame->data[i];
 109             x4->pic.img.i_stride[i] = frame->linesize[i];
 110         }
 111
 112         x4->pic.i_pts  = frame->pts;
 113         x4->pic.i_type =
 114             frame->pict_type == AV_PICTURE_TYPE_I ? X264_TYPE_KEYFRAME :
 115             frame->pict_type == AV_PICTURE_TYPE_P ? X264_TYPE_P :
 116             frame->pict_type == AV_PICTURE_TYPE_B ? X264_TYPE_B :
 117                                             X264_TYPE_AUTO;
 118         if (x4->params.b_tff != frame->top_field_first) {
 119             x4->params.b_tff = frame->top_field_first;
 120             x264_encoder_reconfig(x4->enc, &x4->params);
 121         }
 122         if (x4->params.vui.i_sar_height != ctx->sample_aspect_ratio.den
 123          || x4->params.vui.i_sar_width != ctx->sample_aspect_ratio.num) {
 124             x4->params.vui.i_sar_height = ctx->sample_aspect_ratio.den;
 125             x4->params.vui.i_sar_width = ctx->sample_aspect_ratio.num;
 126             x264_encoder_reconfig(x4->enc, &x4->params);
 127         }
 128     }
 129
 130     do {
 131     if (x264_encoder_encode(x4->enc, &nal, &nnal, frame? &x4->pic: NULL, &pic_out) < 0)
 132         return -1;
 133
 134     bufsize = encode_nals(ctx, buf, bufsize, nal, nnal, 0);
 135     if (bufsize < 0)
 136         return -1;
 137     } while (!bufsize && !frame && x264_encoder_delayed_frames(x4->enc));
 138
 139     /* FIXME: libx264 now provides DTS, but AVFrame doesn't have a field for it. */
 140     x4->out_pic.pts = pic_out.i_pts;
 141
 142     switch (pic_out.i_type) {
 143     case X264_TYPE_IDR:
 144     case X264_TYPE_I:
 145         x4->out_pic.pict_type = AV_PICTURE_TYPE_I;
 146         break;
 147     case X264_TYPE_P:
 148         x4->out_pic.pict_type = AV_PICTURE_TYPE_P;
 149         break;
 150     case X264_TYPE_B:
 151     case X264_TYPE_BREF:
 152         x4->out_pic.pict_type = AV_PICTURE_TYPE_B;
 153         break;
 154     }
 155
 156     x4->out_pic.key_frame = pic_out.b_keyframe;
 157     if (bufsize)
 158         x4->out_pic.quality = (pic_out.i_qpplus1 - 1) * FF_QP2LAMBDA;
 159
 160     return bufsize;
 161 }
 162
 163 static av_cold int X264_close(AVCodecContext *avctx)
 164 {
 165     X264Context *x4 = avctx->priv_data;
 166
 167     av_freep(&avctx->extradata);
 168     av_free(x4->sei);
 169
 170     if (x4->enc)
 171         x264_encoder_close(x4->enc);
 172
 173     return 0;
 174 }
 175
 176 /**
 177  * Detect default settings and use default profile to avoid libx264 failure.
 178  */
 179 static void check_default_settings(AVCodecContext *avctx)
 180 {
 181     X264Context *x4 = avctx->priv_data;
 182
 183     int score = 0;
 184     score += x4->params.analyse.i_me_range == 0;
 185     score += x4->params.rc.i_qp_step == 3;
 186     score += x4->params.i_keyint_max == 12;
 187     score += x4->params.rc.i_qp_min == 2;
 188     score += x4->params.rc.i_qp_max == 31;
 189     score += x4->params.rc.f_qcompress == 0.5;
 190     score += fabs(x4->params.rc.f_ip_factor - 1.25) < 0.01;
 191     score += fabs(x4->params.rc.f_pb_factor - 1.25) < 0.01;
 192     score += x4->params.analyse.inter == 0 && x4->params.analyse.i_subpel_refine == 8;
 193     if (score >= 5) {
 194         av_log(avctx, AV_LOG_ERROR, "Default settings detected, using medium profile\n");
 195         x4->preset = av_strdup("medium");
 196         if (avctx->bit_rate == 200*1000)
 197             avctx->crf = 23;
 198     }
 199 }
 200
 201 #define OPT_STR(opt, param)                                                   \
 202     do {                                                                      \
 203         int ret;                                                              \
 204         if (param && (ret = x264_param_parse(&x4->params, opt, param)) < 0) { \
 205             if(ret == X264_PARAM_BAD_NAME)                                    \
 206                 av_log(avctx, AV_LOG_ERROR,                                   \
 207                         "bad option '%s': '%s'\n", opt, param);               \
 208             else                                                              \
 209                 av_log(avctx, AV_LOG_ERROR,                                   \
 210                         "bad value for '%s': '%s'\n", opt, param);            \
 211             return -1;                                                        \
 212         }                                                                     \
 213     } while (0);
 214
 215 static av_cold int X264_init(AVCodecContext *avctx)
 216 {
 217     X264Context *x4 = avctx->priv_data;
 218
 219     x4->sei_size = 0;
 220     x264_param_default(&x4->params);
 221
 222     x4->params.i_keyint_max         = avctx->gop_size;
 223
 224     x4->params.i_bframe          = avctx->max_b_frames;
 225     x4->params.b_cabac           = avctx->coder_type == FF_CODER_TYPE_AC;
 226     x4->params.i_bframe_adaptive = avctx->b_frame_strategy;
 227     x4->params.i_bframe_bias     = avctx->bframebias;
 228     x4->params.i_bframe_pyramid  = avctx->flags2 & CODEC_FLAG2_BPYRAMID ? X264_B_PYRAMID_NORMAL : X264_B_PYRAMID_NONE;
 229
 230     x4->params.i_keyint_min = avctx->keyint_min;
 231     if (x4->params.i_keyint_min > x4->params.i_keyint_max)
 232         x4->params.i_keyint_min = x4->params.i_keyint_max;
 233
 234     x4->params.i_scenecut_threshold        = avctx->scenechange_threshold;
 235
 236     x4->params.b_deblocking_filter         = avctx->flags & CODEC_FLAG_LOOP_FILTER;
 237     x4->params.i_deblocking_filter_alphac0 = avctx->deblockalpha;
 238     x4->params.i_deblocking_filter_beta    = avctx->deblockbeta;
 239
 240     x4->params.rc.i_qp_min                 = avctx->qmin;
 241     x4->params.rc.i_qp_max                 = avctx->qmax;
 242     x4->params.rc.i_qp_step                = avctx->max_qdiff;
 243
 244     x4->params.rc.f_qcompress       = avctx->qcompress; /* 0.0 => cbr, 1.0 => constant qp */
 245     x4->params.rc.f_qblur           = avctx->qblur;     /* temporally blur quants */
 246     x4->params.rc.f_complexity_blur = avctx->complexityblur;
 247
 248     x4->params.i_frame_reference    = avctx->refs;
 249
 250     x4->params.analyse.inter    = 0;
 251     if (avctx->partitions) {
 252         if (avctx->partitions & X264_PART_I4X4)
 253             x4->params.analyse.inter |= X264_ANALYSE_I4x4;
 254         if (avctx->partitions & X264_PART_I8X8)
 255             x4->params.analyse.inter |= X264_ANALYSE_I8x8;
 256         if (avctx->partitions & X264_PART_P8X8)
 257             x4->params.analyse.inter |= X264_ANALYSE_PSUB16x16;
 258         if (avctx->partitions & X264_PART_P4X4)
 259             x4->params.analyse.inter |= X264_ANALYSE_PSUB8x8;
 260         if (avctx->partitions & X264_PART_B8X8)
 261             x4->params.analyse.inter |= X264_ANALYSE_BSUB16x16;
 262     }
 263
 264     x4->params.analyse.i_direct_mv_pred  = avctx->directpred;
 265
 266     x4->params.analyse.b_weighted_bipred = avctx->flags2 & CODEC_FLAG2_WPRED;
 267
 268     if (avctx->me_method == ME_EPZS)
 269         x4->params.analyse.i_me_method = X264_ME_DIA;
 270     else if (avctx->me_method == ME_HEX)
 271         x4->params.analyse.i_me_method = X264_ME_HEX;
 272     else if (avctx->me_method == ME_UMH)
 273         x4->params.analyse.i_me_method = X264_ME_UMH;
 274     else if (avctx->me_method == ME_FULL)
 275         x4->params.analyse.i_me_method = X264_ME_ESA;
 276     else if (avctx->me_method == ME_TESA)
 277         x4->params.analyse.i_me_method = X264_ME_TESA;
 278     else x4->params.analyse.i_me_method = X264_ME_HEX;
 279
 280     x4->params.rc.i_aq_mode               = avctx->aq_mode;
 281     x4->params.rc.f_aq_strength           = avctx->aq_strength;
 282     x4->params.rc.i_lookahead             = avctx->rc_lookahead;
 283
 284     x4->params.analyse.b_psy              = avctx->flags2 & CODEC_FLAG2_PSY;
 285     x4->params.analyse.f_psy_rd           = avctx->psy_rd;
 286     x4->params.analyse.f_psy_trellis      = avctx->psy_trellis;
 287
 288     x4->params.analyse.i_me_range         = avctx->me_range;
 289     x4->params.analyse.i_subpel_refine    = avctx->me_subpel_quality;
 290
 291     x4->params.analyse.b_mixed_references = avctx->flags2 & CODEC_FLAG2_MIXED_REFS;
 292     x4->params.analyse.b_chroma_me        = avctx->me_cmp & FF_CMP_CHROMA;
 293     x4->params.analyse.b_transform_8x8    = avctx->flags2 & CODEC_FLAG2_8X8DCT;
 294     x4->params.analyse.b_fast_pskip       = avctx->flags2 & CODEC_FLAG2_FASTPSKIP;
 295
 296     x4->params.analyse.i_trellis          = avctx->trellis;
 297     x4->params.analyse.i_noise_reduction  = avctx->noise_reduction;
 298
 299     x4->params.rc.b_mb_tree               = !!(avctx->flags2 & CODEC_FLAG2_MBTREE);
 300     x4->params.rc.f_ip_factor             = 1 / fabs(avctx->i_quant_factor);
 301     x4->params.rc.f_pb_factor             = avctx->b_quant_factor;
 302     x4->params.analyse.i_chroma_qp_offset = avctx->chromaoffset;
 303
 304     if (!x4->preset)
 305         check_default_settings(avctx);
 306
 307     if (x4->preset || x4->tune) {
 308         if (x264_param_default_preset(&x4->params, x4->preset, x4->tune) < 0) {
 309             av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", x4->preset, x4->tune);
 310             return AVERROR(EINVAL);
 311         }
 312     }
 313
 314     x4->params.pf_log               = X264_log;
 315     x4->params.p_log_private        = avctx;
 316     x4->params.i_log_level          = X264_LOG_DEBUG;
 317
 318     OPT_STR("weightp", x4->weightp);
 319
 320     x4->params.b_intra_refresh      = avctx->flags2 & CODEC_FLAG2_INTRA_REFRESH;
 321     x4->params.rc.i_bitrate         = avctx->bit_rate       / 1000;
 322     x4->params.rc.i_vbv_buffer_size = avctx->rc_buffer_size / 1000;
 323     x4->params.rc.i_vbv_max_bitrate = avctx->rc_max_rate    / 1000;
 324     x4->params.rc.b_stat_write      = avctx->flags & CODEC_FLAG_PASS1;
 325     if (avctx->flags & CODEC_FLAG_PASS2) {
 326         x4->params.rc.b_stat_read = 1;
 327     } else {
 328         if (avctx->crf) {
 329             x4->params.rc.i_rc_method   = X264_RC_CRF;
 330             x4->params.rc.f_rf_constant = avctx->crf;
 331             x4->params.rc.f_rf_constant_max = avctx->crf_max;
 332         } else if (avctx->cqp > -1) {
 333             x4->params.rc.i_rc_method   = X264_RC_CQP;
 334             x4->params.rc.i_qp_constant = avctx->cqp;
 335         }
 336     }
 337
 338     OPT_STR("stats", x4->stats);
 339
 340     // if neither crf nor cqp modes are selected we have to enable the RC
 341     // we do it this way because we cannot check if the bitrate has been set
 342     if (!(avctx->crf || (avctx->cqp > -1)))
 343         x4->params.rc.i_rc_method = X264_RC_ABR;
 344
 345     if (avctx->rc_buffer_size && avctx->rc_initial_buffer_occupancy &&
 346         (avctx->rc_initial_buffer_occupancy <= avctx->rc_buffer_size)) {
 347         x4->params.rc.f_vbv_buffer_init =
 348             (float)avctx->rc_initial_buffer_occupancy / avctx->rc_buffer_size;
 349     }
 350
 351     OPT_STR("level", x4->level);
 352
 353     if(x4->x264opts){
 354         const char *p= x4->x264opts;
 355         while(p){
 356             char param[256]={0}, val[256]={0};
 357             sscanf(p, "%255[^:=]=%255[^:]", param, val);
 358             OPT_STR(param, val);
 359             p= strchr(p, ':');
 360             p+=!!p;
 361         }
 362     }
 363
 364     if (x4->fastfirstpass)
 365         x264_param_apply_fastfirstpass(&x4->params);
 366
 367     if (x4->profile)
 368         if (x264_param_apply_profile(&x4->params, x4->profile) < 0) {
 369             av_log(avctx, AV_LOG_ERROR, "Error setting profile %s.\n", x4->profile);
 370             return AVERROR(EINVAL);
 371         }
 372
 373     x4->params.i_width          = avctx->width;
 374     x4->params.i_height         = avctx->height;
 375     x4->params.vui.i_sar_width  = avctx->sample_aspect_ratio.num;
 376     x4->params.vui.i_sar_height = avctx->sample_aspect_ratio.den;
 377     x4->params.i_fps_num = x4->params.i_timebase_den = avctx->time_base.den;
 378     x4->params.i_fps_den = x4->params.i_timebase_num = avctx->time_base.num;
 379
 380     x4->params.analyse.b_psnr = avctx->flags & CODEC_FLAG_PSNR;
 381     x4->params.analyse.b_ssim = avctx->flags2 & CODEC_FLAG2_SSIM;
 382
 383     x4->params.b_aud          = avctx->flags2 & CODEC_FLAG2_AUD;
 384
 385     x4->params.i_threads      = avctx->thread_count;
 386
 387     x4->params.b_interlaced   = avctx->flags & CODEC_FLAG_INTERLACED_DCT;
 388
 389 //    x4->params.b_open_gop     = !(avctx->flags & CODEC_FLAG_CLOSED_GOP);
 390
 391     x4->params.i_slice_count  = avctx->slices;
 392
 393     x4->params.vui.b_fullrange = avctx->pix_fmt == PIX_FMT_YUVJ420P;
 394
 395     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER)
 396         x4->params.b_repeat_headers = 0;
 397
 398     // update AVCodecContext with x264 parameters
 399     avctx->has_b_frames = x4->params.i_bframe ?
 400         x4->params.i_bframe_pyramid ? 2 : 1 : 0;
 401     avctx->bit_rate = x4->params.rc.i_bitrate*1000;
 402     avctx->crf = x4->params.rc.f_rf_constant;
 403
 404     x4->enc = x264_encoder_open(&x4->params);
 405     if (!x4->enc)
 406         return -1;
 407
 408     avctx->coded_frame = &x4->out_pic;
 409
 410     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
 411         x264_nal_t *nal;
 412         int nnal, s, i;
 413
 414         s = x264_encoder_headers(x4->enc, &nal, &nnal);
 415
 416         for (i = 0; i < nnal; i++)
 417             if (nal[i].i_type == NAL_SEI)
 418                 av_log(avctx, AV_LOG_INFO, "%s\n", nal[i].p_payload+25);
 419
 420         avctx->extradata      = av_malloc(s);
 421         avctx->extradata_size = encode_nals(avctx, avctx->extradata, s, nal, nnal, 1);
 422     }
 423
 424     return 0;
 425 }
 426
 427 #define OFFSET(x) offsetof(X264Context,x)
 428 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 429
 430 static const AVOption options[] = {
 431     { "preset",        "Set the encoding preset (cf. x264 --fullhelp)",   OFFSET(preset),        FF_OPT_TYPE_STRING, { 0 }, 0, 0, VE},
 432     { "tune",          "Tune the encoding params (cf. x264 --fullhelp)",  OFFSET(tune),          FF_OPT_TYPE_STRING, { 0 }, 0, 0, VE},
 433     { "profile",       "Set profile restrictions (cf. x264 --fullhelp) ", OFFSET(profile),       FF_OPT_TYPE_STRING, { 0 }, 0, 0, VE},
 434     { "fastfirstpass", "Use fast settings when encoding first pass",      OFFSET(fastfirstpass), FF_OPT_TYPE_INT,    { 1 }, 0, 1, VE},
 435     {"level", "Specify level (as defined by Annex A)", OFFSET(level), FF_OPT_TYPE_STRING, {.str=NULL}, 0, 0, VE},
 436     {"passlogfile", "Filename for 2 pass stats", OFFSET(stats), FF_OPT_TYPE_STRING, {.str=NULL}, 0, 0, VE},
 437     {"wpredp", "Weighted prediction for P-frames", OFFSET(weightp), FF_OPT_TYPE_STRING, {.str=NULL}, 0, 0, VE},
 438     {"x264opts", "x264 options", OFFSET(x264opts), FF_OPT_TYPE_STRING, {.str=NULL}, 0, 0, VE},
 439     { NULL },
 440 };
 441
 442 static const AVClass class = {
 443     .class_name = "libx264",
 444     .item_name  = av_default_item_name,
 445     .option     = options,
 446     .version    = LIBAVUTIL_VERSION_INT,
 447 };
 448
 449 AVCodec ff_libx264_encoder = {
 450     .name           = "libx264",
 451     .type           = AVMEDIA_TYPE_VIDEO,
 452     .id             = CODEC_ID_H264,
 453     .priv_data_size = sizeof(X264Context),
 454     .init           = X264_init,
 455     .encode         = X264_frame,
 456     .close          = X264_close,
 457     .capabilities   = CODEC_CAP_DELAY,
 458     .pix_fmts       = (const enum PixelFormat[]) { PIX_FMT_YUV420P, PIX_FMT_YUVJ420P, PIX_FMT_NONE },
 459     .long_name      = NULL_IF_CONFIG_SMALL("libx264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
 460     .priv_class     = &class,
 461 };