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