x264.h 26.6 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1 2 3
/*****************************************************************************
 * x264.h: h264 encoder library
 *****************************************************************************
4
 * Copyright (C) 2003-2008 x264 Project
Laurent Aimar's avatar
Laurent Aimar committed
5 6
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7
 *          Loren Merritt <lorenm@u.washington.edu>
Laurent Aimar's avatar
Laurent Aimar committed
8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
Laurent Aimar's avatar
Laurent Aimar committed
22 23
 *****************************************************************************/

24 25
#ifndef X264_X264_H
#define X264_X264_H
Laurent Aimar's avatar
Laurent Aimar committed
26

27 28
#if !defined(_STDINT_H) && !defined(_STDINT_H_) && \
    !defined(_INTTYPES_H) && !defined(_INTTYPES_H_)
Eric Petit's avatar
Eric Petit committed
29 30 31 32 33
# ifdef _MSC_VER
#  pragma message("You must include stdint.h or inttypes.h before x264.h")
# else
#  warning You must include stdint.h or inttypes.h before x264.h
# endif
34 35
#endif

Måns Rullgård's avatar
Måns Rullgård committed
36 37
#include <stdarg.h>

38
#define X264_BUILD 87
Laurent Aimar's avatar
Laurent Aimar committed
39 40

/* x264_t:
41
 *      opaque handler for encoder */
Laurent Aimar's avatar
Laurent Aimar committed
42 43 44
typedef struct x264_t x264_t;

/****************************************************************************
45
 * Encoder parameters
Laurent Aimar's avatar
Laurent Aimar committed
46 47 48
 ****************************************************************************/
/* CPU flags
 */
49 50 51 52 53 54 55 56 57 58 59
#define X264_CPU_CACHELINE_32   0x000001  /* avoid memory loads that span the border between two cachelines */
#define X264_CPU_CACHELINE_64   0x000002  /* 32/64 is the size of a cacheline in bytes */
#define X264_CPU_ALTIVEC        0x000004
#define X264_CPU_MMX            0x000008
#define X264_CPU_MMXEXT         0x000010  /* MMX2 aka MMXEXT aka ISSE */
#define X264_CPU_SSE            0x000020
#define X264_CPU_SSE2           0x000040
#define X264_CPU_SSE2_IS_SLOW   0x000080  /* avoid most SSE2 functions on Athlon64 */
#define X264_CPU_SSE2_IS_FAST   0x000100  /* a few functions are only faster on Core2 and Phenom */
#define X264_CPU_SSE3           0x000200
#define X264_CPU_SSSE3          0x000400
Fiona Glaser's avatar
Fiona Glaser committed
60
#define X264_CPU_SHUFFLE_IS_FAST 0x000800 /* Penryn, Nehalem, and Phenom have fast shuffle units */
61 62 63
#define X264_CPU_STACK_MOD4     0x001000  /* if stack is only mod4 and not mod16 */
#define X264_CPU_SSE4           0x002000  /* SSE4.1 */
#define X264_CPU_SSE42          0x004000  /* SSE4.2 */
Fiona Glaser's avatar
Fiona Glaser committed
64
#define X264_CPU_SSE_MISALIGN   0x008000  /* Phenom support for misaligned SSE instruction arguments */
65
#define X264_CPU_LZCNT          0x010000  /* Phenom support for "leading zero count" instruction. */
66 67 68
#define X264_CPU_ARMV6          0x020000
#define X264_CPU_NEON           0x040000  /* ARM NEON */
#define X264_CPU_FAST_NEON_MRC  0x080000  /* Transfer from NEON to ARM register is fast (Cortex-A9) */
Laurent Aimar's avatar
Laurent Aimar committed
69 70 71 72

/* Analyse flags
 */
#define X264_ANALYSE_I4x4       0x0001  /* Analyse i4x4 */
73
#define X264_ANALYSE_I8x8       0x0002  /* Analyse i8x8 (requires 8x8 transform) */
Laurent Aimar's avatar
Laurent Aimar committed
74 75
#define X264_ANALYSE_PSUB16x16  0x0010  /* Analyse p16x8, p8x16 and p8x8 */
#define X264_ANALYSE_PSUB8x8    0x0020  /* Analyse p8x4, p4x8, p4x4 */
76 77
#define X264_ANALYSE_BSUB16x16  0x0100  /* Analyse b16x8, b8x16 and b8x8 */
#define X264_DIRECT_PRED_NONE        0
78 79
#define X264_DIRECT_PRED_SPATIAL     1
#define X264_DIRECT_PRED_TEMPORAL    2
Loren Merritt's avatar
Loren Merritt committed
80
#define X264_DIRECT_PRED_AUTO        3
81 82
#define X264_ME_DIA                  0
#define X264_ME_HEX                  1
83 84
#define X264_ME_UMH                  2
#define X264_ME_ESA                  3
85
#define X264_ME_TESA                 4
Loren Merritt's avatar
Loren Merritt committed
86 87 88
#define X264_CQM_FLAT                0
#define X264_CQM_JVT                 1
#define X264_CQM_CUSTOM              2
89 90 91
#define X264_RC_CQP                  0
#define X264_RC_CRF                  1
#define X264_RC_ABR                  2
92
#define X264_AQ_NONE                 0
93
#define X264_AQ_VARIANCE             1
Anton Mitrofanov's avatar
Anton Mitrofanov committed
94
#define X264_AQ_AUTOVARIANCE         2
95 96 97
#define X264_B_ADAPT_NONE            0
#define X264_B_ADAPT_FAST            1
#define X264_B_ADAPT_TRELLIS         2
Dylan Yudaken's avatar
Dylan Yudaken committed
98 99 100
#define X264_WEIGHTP_NONE            0
#define X264_WEIGHTP_BLIND           1
#define X264_WEIGHTP_SMART           2
Lamont Alston's avatar
Lamont Alston committed
101 102 103
#define X264_B_PYRAMID_NONE          0
#define X264_B_PYRAMID_STRICT        1
#define X264_B_PYRAMID_NORMAL        2
104

Loren Merritt's avatar
Loren Merritt committed
105
static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
106
static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
Lamont Alston's avatar
Lamont Alston committed
107
static const char * const x264_b_pyramid_names[] = { "none", "strict", "normal", 0 };
108 109 110 111 112 113
static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
static const char * const x264_fullrange_names[] = { "off", "on", 0 };
static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", 0 };
static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316", 0 };
static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", 0 };
Loren Merritt's avatar
Loren Merritt committed
114

Laurent Aimar's avatar
Laurent Aimar committed
115
/* Colorspace type
116
 * legacy only; nothing other than I420 is really supported. */
Laurent Aimar's avatar
Laurent Aimar committed
117 118 119 120 121 122 123 124 125 126
#define X264_CSP_MASK           0x00ff  /* */
#define X264_CSP_NONE           0x0000  /* Invalid mode     */
#define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
#define X264_CSP_I422           0x0002  /* yuv 4:2:2 planar */
#define X264_CSP_I444           0x0003  /* yuv 4:4:4 planar */
#define X264_CSP_YV12           0x0004  /* yuv 4:2:0 planar */
#define X264_CSP_YUYV           0x0005  /* yuv 4:2:2 packed */
#define X264_CSP_RGB            0x0006  /* rgb 24bits       */
#define X264_CSP_BGR            0x0007  /* bgr 24bits       */
#define X264_CSP_BGRA           0x0008  /* bgr 32bits       */
127
#define X264_CSP_MAX            0x0009  /* end of list */
Laurent Aimar's avatar
Laurent Aimar committed
128 129
#define X264_CSP_VFLIP          0x1000  /* */

130
/* Slice type */
Laurent Aimar's avatar
Laurent Aimar committed
131 132 133 134
#define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
#define X264_TYPE_IDR           0x0001
#define X264_TYPE_I             0x0002
#define X264_TYPE_P             0x0003
135 136 137 138
#define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
#define X264_TYPE_B             0x0005
#define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
#define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
Laurent Aimar's avatar
Laurent Aimar committed
139

140
/* Log level */
141 142 143 144 145 146
#define X264_LOG_NONE          (-1)
#define X264_LOG_ERROR          0
#define X264_LOG_WARNING        1
#define X264_LOG_INFO           2
#define X264_LOG_DEBUG          3

147 148
/* Threading */
#define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
149
#define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
150

151 152 153
/* Zones: override ratecontrol or other options for specific sections of the video.
 * See x264_encoder_reconfig() for which options can be changed.
 * If zones overlap, whichever comes later in the list takes precedence. */
Loren Merritt's avatar
Loren Merritt committed
154 155
typedef struct
{
156 157
    int i_start, i_end; /* range of frame numbers */
    int b_force_qp; /* whether to use qp vs bitrate factor */
Loren Merritt's avatar
Loren Merritt committed
158 159
    int i_qp;
    float f_bitrate_factor;
160
    struct x264_param_t *param;
Loren Merritt's avatar
Loren Merritt committed
161 162
} x264_zone_t;

163
typedef struct x264_param_t
Laurent Aimar's avatar
Laurent Aimar committed
164 165 166
{
    /* CPU flags */
    unsigned int cpu;
Loren Merritt's avatar
Loren Merritt committed
167
    int         i_threads;       /* encode multiple frames in parallel */
168
    int         b_sliced_threads;  /* Whether to use slice-based threading. */
Loren Merritt's avatar
Loren Merritt committed
169
    int         b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
Steven Walters's avatar
Steven Walters committed
170
    int         i_sync_lookahead; /* threaded lookahead buffer */
Laurent Aimar's avatar
Laurent Aimar committed
171 172 173 174 175

    /* Video Properties */
    int         i_width;
    int         i_height;
    int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
Loren Merritt's avatar
Loren Merritt committed
176
    int         i_level_idc;
177
    int         i_frame_total; /* number of frames to encode if known, else 0 */
Laurent Aimar's avatar
Laurent Aimar committed
178 179 180 181 182 183

    struct
    {
        /* they will be reduced to be 0 < x <= 65535 and prime */
        int         i_sar_height;
        int         i_sar_width;
184 185

        int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
Loren Merritt's avatar
Loren Merritt committed
186

187 188 189 190 191 192 193
        /* see h264 annex E for the values of the following */
        int         i_vidformat;
        int         b_fullrange;
        int         i_colorprim;
        int         i_transfer;
        int         i_colmatrix;
        int         i_chroma_loc;    /* both top & bottom */
Laurent Aimar's avatar
Laurent Aimar committed
194 195
    } vui;

Måns Rullgård's avatar
Måns Rullgård committed
196 197
    int         i_fps_num;
    int         i_fps_den;
Laurent Aimar's avatar
Laurent Aimar committed
198 199 200

    /* Bitstream parameters */
    int         i_frame_reference;  /* Maximum number of reference frames */
201 202
    int         i_keyint_max;       /* Force an IDR keyframe at this interval */
    int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
203
    int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
Fiona Glaser's avatar
Fiona Glaser committed
204 205
    int         b_intra_refresh;    /* Whether or not to use periodic intra refresh instead of IDR frames. */

Laurent Aimar's avatar
Laurent Aimar committed
206
    int         i_bframe;   /* how many b-frame between 2 references pictures */
207
    int         i_bframe_adaptive;
208
    int         i_bframe_bias;
209
    int         i_bframe_pyramid;   /* Keep some B-frames as references: 0=off, 1=strict hierarchical, 2=normal */
Laurent Aimar's avatar
Laurent Aimar committed
210 211 212 213 214 215 216 217

    int         b_deblocking_filter;
    int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
    int         i_deblocking_filter_beta;       /* [-6, 6]  idem */

    int         b_cabac;
    int         i_cabac_init_idc;

218
    int         b_interlaced;
219
    int         b_constrained_intra;
220

Loren Merritt's avatar
Loren Merritt committed
221
    int         i_cqm_preset;
222
    char        *psz_cqm_file;      /* JM format */
Loren Merritt's avatar
Loren Merritt committed
223 224 225 226 227 228
    uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
    uint8_t     cqm_4ic[16];
    uint8_t     cqm_4py[16];
    uint8_t     cqm_4pc[16];
    uint8_t     cqm_8iy[64];
    uint8_t     cqm_8py[64];
Laurent Aimar's avatar
Laurent Aimar committed
229

230 231 232 233
    /* Log */
    void        (*pf_log)( void *, int i_level, const char *psz, va_list );
    void        *p_log_private;
    int         i_log_level;
Loren Merritt's avatar
Loren Merritt committed
234
    int         b_visualize;
235
    char        *psz_dump_yuv;  /* filename for reconstructed frames */
236

Laurent Aimar's avatar
Laurent Aimar committed
237 238 239
    /* Encoder analyser parameters */
    struct
    {
240 241 242 243
        unsigned int intra;     /* intra partitions */
        unsigned int inter;     /* inter partitions */

        int          b_transform_8x8;
Dylan Yudaken's avatar
Dylan Yudaken committed
244
        int          i_weighted_pred; /* weighting for P-frames */
Loren Merritt's avatar
Loren Merritt committed
245
        int          b_weighted_bipred; /* implicit weighting for B-frames */
246
        int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
Loren Merritt's avatar
Loren Merritt committed
247 248
        int          i_chroma_qp_offset;

249 250
        int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
        int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
251
        int          i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
Loren Merritt's avatar
Loren Merritt committed
252
        int          i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
253
        int          i_subpel_refine; /* subpixel motion estimation quality */
Loren Merritt's avatar
Loren Merritt committed
254
        int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
Loren Merritt's avatar
Loren Merritt committed
255
        int          b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
Loren Merritt's avatar
Loren Merritt committed
256
        int          i_trellis;  /* trellis RD quantization */
Loren Merritt's avatar
Loren Merritt committed
257
        int          b_fast_pskip; /* early SKIP detection on P-frames */
258
        int          b_dct_decimate; /* transform coefficient thresholding on P-frames */
259
        int          i_noise_reduction; /* adaptive pseudo-deadzone */
260 261
        float        f_psy_rd; /* Psy RD strength */
        float        f_psy_trellis; /* Psy trellis strength */
Fiona Glaser's avatar
Fiona Glaser committed
262
        int          b_psy; /* Toggle all psy optimizations */
263

264
        /* the deadzone size that will be used in luma quantization */
265
        int          i_luma_deadzone[2]; /* {inter, intra} */
266

267 268
        int          b_psnr;    /* compute and print PSNR stats */
        int          b_ssim;    /* compute and print SSIM stats */
Laurent Aimar's avatar
Laurent Aimar committed
269 270
    } analyse;

271 272 273
    /* Rate control parameters */
    struct
    {
274 275
        int         i_rc_method;    /* X264_RC_* */

276
        int         i_qp_constant;  /* 0-51 */
277 278 279 280 281
        int         i_qp_min;       /* min allowed QP value */
        int         i_qp_max;       /* max allowed QP value */
        int         i_qp_step;      /* max QP step between frames */

        int         i_bitrate;
Loren Merritt's avatar
Loren Merritt committed
282
        float       f_rf_constant;  /* 1pass VBR, nominal QP */
Loren Merritt's avatar
Loren Merritt committed
283 284 285
        float       f_rate_tolerance;
        int         i_vbv_max_bitrate;
        int         i_vbv_buffer_size;
286
        float       f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
287 288 289
        float       f_ip_factor;
        float       f_pb_factor;

290 291
        int         i_aq_mode;      /* psy adaptive QP. (X264_AQ_*) */
        float       f_aq_strength;
Fiona Glaser's avatar
Fiona Glaser committed
292 293
        int         b_mb_tree;      /* Macroblock-tree ratecontrol. */
        int         i_lookahead;
294

295 296 297 298 299 300
        /* 2pass */
        int         b_stat_write;   /* Enable stat writing in psz_stat_out */
        char        *psz_stat_out;
        int         b_stat_read;    /* Read stat from psz_stat_in and use it */
        char        *psz_stat_in;

Loren Merritt's avatar
Loren Merritt committed
301
        /* 2pass params (same as ffmpeg ones) */
302 303
        float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
        float       f_qblur;        /* temporally blur quants */
Loren Merritt's avatar
Loren Merritt committed
304
        float       f_complexity_blur; /* temporally blur complexity */
Loren Merritt's avatar
Loren Merritt committed
305
        x264_zone_t *zones;         /* ratecontrol overrides */
Loren Merritt's avatar
Loren Merritt committed
306
        int         i_zones;        /* number of zone_t's */
307
        char        *psz_zones;     /* alternate method of specifying zones */
308 309
    } rc;

310
    /* Muxing parameters */
311
    int b_aud;                  /* generate access unit delimiters */
Loren Merritt's avatar
10l  
Loren Merritt committed
312
    int b_repeat_headers;       /* put SPS/PPS before each keyframe */
313 314
    int b_annexb;               /* if set, place start codes (4 bytes) before NAL units,
                                 * otherwise place size (4 bytes) before NAL units. */
315
    int i_sps_id;               /* SPS and PPS id number */
316 317 318
    int b_vfr_input;            /* VFR input */
    int i_timebase_num;         /* Timebase numerator */
    int i_timebase_den;         /* Timebase denominator */
319 320 321
    int b_dts_compress;         /* DTS compression: this algorithm eliminates negative DTS
                                 * by compressing them to be less than the second PTS.
                                 * Warning: this will change the timebase! */
322

Fiona Glaser's avatar
Fiona Glaser committed
323 324 325 326 327
    /* Slicing parameters */
    int i_slice_max_size;    /* Max size per slice in bytes; includes estimated NAL overhead. */
    int i_slice_max_mbs;     /* Max number of MBs per slice; overrides i_slice_count. */
    int i_slice_count;       /* Number of slices per frame: forces rectangular slices. */

328 329 330 331 332
    /* Optional callback for freeing this x264_param_t when it is done being used.
     * Only used when the x264_param_t sits in memory for an indefinite period of time,
     * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
     * Not used when x264_encoder_reconfig is called directly. */
    void (*param_free)( void* );
Laurent Aimar's avatar
Laurent Aimar committed
333 334
} x264_param_t;

335 336 337 338
/****************************************************************************
 * H.264 level restriction information
 ****************************************************************************/

339 340
typedef struct {
    int level_idc;
341 342 343 344 345 346 347 348 349 350 351
    int mbps;        /* max macroblock processing rate (macroblocks/sec) */
    int frame_size;  /* max frame size (macroblocks) */
    int dpb;         /* max decoded picture buffer (bytes) */
    int bitrate;     /* max bitrate (kbit/sec) */
    int cpb;         /* max vbv buffer (kbit) */
    int mv_range;    /* max vertical mv component range (pixels) */
    int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
    int slice_rate;  /* ?? */
    int bipred8x8;   /* limit bipred to >=8x8 */
    int direct8x8;   /* limit b_direct to >=8x8 */
    int frame_only;  /* forbid interlacing */
352 353 354 355 356
} x264_level_t;

/* all of the levels defined in the standard, terminated by .level_idc=0 */
extern const x264_level_t x264_levels[];

357 358 359 360
/****************************************************************************
 * Basic parameter handling functions
 ****************************************************************************/

Laurent Aimar's avatar
Laurent Aimar committed
361 362 363 364
/* x264_param_default:
 *      fill x264_param_t with default values and do CPU detection */
void    x264_param_default( x264_param_t * );

365
/* x264_param_parse:
366 367 368 369 370 371
 *  set one parameter by name.
 *  returns 0 on success, or returns one of the following errors.
 *  note: BAD_VALUE occurs only if it can't even parse the value,
 *  numerical range is not checked until x264_encoder_open() or
 *  x264_encoder_reconfig().
 *  value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
372 373 374 375
#define X264_PARAM_BAD_NAME  (-1)
#define X264_PARAM_BAD_VALUE (-2)
int x264_param_parse( x264_param_t *, const char *name, const char *value );

Laurent Aimar's avatar
Laurent Aimar committed
376
/****************************************************************************
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
 * Advanced parameter handling functions
 ****************************************************************************/

/* These functions expose the full power of x264's preset-tune-profile system for
 * easy adjustment of large numbers of internal parameters.
 *
 * In order to replicate x264CLI's option handling, these functions MUST be called
 * in the following order:
 * 1) x264_param_default_preset
 * 2) Custom user options (via param_parse or directly assigned variables)
 * 3) x264_param_apply_fastfirstpass
 * 4) x264_param_apply_profile
 *
 * Additionally, x264CLI does not apply step 3 if the preset chosen is "placebo"
 * or --slow-firstpass is set. */

/* x264_param_default_preset:
 *      The same as x264_param_default, but also use the passed preset and tune
 *      to modify the default settings.
 *      (either can be NULL, which implies no preset or no tune, respectively)
 *
 *      Currently available presets are, ordered from fastest to slowest: */
static const char * const x264_preset_names[] = { "ultrafast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo", 0 };

/*      Warning: the speed of these presets scales dramatically.  Ultrafast is a full
 *      100 times faster than placebo!
 *
 *      Currently available tunings are: */
static const char * const x264_tune_names[] = { "film", "animation", "grain", "psnr", "ssim", "fastdecode", "zerolatency", 0 };

/*      Multiple tunings can be used if separated by a delimiter in ",./-+",
 *      however multiple psy tunings cannot be used.
 *      film, animation, grain, psnr, and ssim are psy tunings.
 *
 *      returns 0 on success, negative on failure (e.g. invalid preset/tune name). */
int     x264_param_default_preset( x264_param_t *, const char *preset, const char *tune );

/* x264_param_apply_fastfirstpass:
 *      If first-pass mode is set (rc.b_stat_read == 1, rc.b_stat_write == 0),
 *      modify the encoder settings to disable options generally not useful on
 *      the first pass. */
void    x264_param_apply_fastfirstpass( x264_param_t * );

/* x264_param_apply_profile:
 *      Applies the restrictions of the given profile.
 *      Currently available profiles are, from most to least restrictive: */
static const char * const x264_profile_names[] = { "baseline", "main", "high", 0 };

/*      (can be NULL, in which case the function will do nothing)
 *
 *      Does NOT guarantee that the given profile will be used: if the restrictions
 *      of "High" are applied to settings that are already Baseline-compatible, the
 *      stream will remain baseline.  In short, it does not increase settings, only
 *      decrease them.
 *
 *      returns 0 on success, negative on failure (e.g. invalid profile name). */
int     x264_param_apply_profile( x264_param_t *, const char *profile );

/****************************************************************************
 * Picture structures and functions
Laurent Aimar's avatar
Laurent Aimar committed
437 438 439
 ****************************************************************************/
typedef struct
{
440 441 442 443
    int     i_csp;       /* Colorspace */
    int     i_plane;     /* Number of image planes */
    int     i_stride[4]; /* Strides for each plane */
    uint8_t *plane[4];   /* Pointers to each plane */
Laurent Aimar's avatar
Laurent Aimar committed
444 445 446 447
} x264_image_t;

typedef struct
{
448 449 450 451 452
    /* In: force picture type (if not auto)
     *     If x264 encoding parameters are violated in the forcing of picture types,
     *     x264 will correct the input picture type and log a warning.
     *     The quality of frametype decisions may suffer if a great deal of fine-grained
     *     mixing of auto and forced frametypes is done.
Laurent Aimar's avatar
Laurent Aimar committed
453 454 455 456
     * Out: type of the picture encoded */
    int     i_type;
    /* In: force quantizer for > 0 */
    int     i_qpplus1;
Fiona Glaser's avatar
Fiona Glaser committed
457 458 459
    /* Out: whether this frame is a keyframe.  Important when using modes that result in
     * SEI recovery points being used instead of IDR frames. */
    int     b_keyframe;
Laurent Aimar's avatar
Laurent Aimar committed
460 461
    /* In: user pts, Out: pts of encoded picture (user)*/
    int64_t i_pts;
462 463 464
    /* Out: frame dts. Since the pts of the first frame is always zero,
     *      initial frames may have a negative dts which must be dealt with by any muxer */
    int64_t i_dts;
465 466 467 468 469 470 471
    /* In: custom encoding parameters to be set from this frame forwards
           (in coded order, not display order). If NULL, continue using
           parameters from the previous frame.  Some parameters, such as
           aspect ratio, can only be changed per-GOP due to the limitations
           of H.264 itself; in this case, the caller must force an IDR frame
           if it needs the changed parameter to apply immediately. */
    x264_param_t *param;
Laurent Aimar's avatar
Laurent Aimar committed
472 473
    /* In: raw data */
    x264_image_t img;
474 475 476
    /* private user data. libx264 doesn't touch this,
       not even copy it from input to output frames. */
    void *opaque;
Laurent Aimar's avatar
Laurent Aimar committed
477 478 479
} x264_picture_t;

/* x264_picture_alloc:
480 481 482
 *  alloc data for a picture. You must call x264_picture_clean on it.
 *  returns 0 on success, or -1 on malloc failure. */
int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
Laurent Aimar's avatar
Laurent Aimar committed
483 484 485 486 487 488 489

/* x264_picture_clean:
 *  free associated resource for a x264_picture_t allocated with
 *  x264_picture_alloc ONLY */
void x264_picture_clean( x264_picture_t *pic );

/****************************************************************************
490
 * NAL structure and functions
Laurent Aimar's avatar
Laurent Aimar committed
491
 ****************************************************************************/
492

Laurent Aimar's avatar
Laurent Aimar committed
493 494 495 496 497 498 499 500 501 502
enum nal_unit_type_e
{
    NAL_UNKNOWN = 0,
    NAL_SLICE   = 1,
    NAL_SLICE_DPA   = 2,
    NAL_SLICE_DPB   = 3,
    NAL_SLICE_DPC   = 4,
    NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
    NAL_SEI         = 6,    /* ref_idc == 0 */
    NAL_SPS         = 7,
503 504
    NAL_PPS         = 8,
    NAL_AUD         = 9,
Laurent Aimar's avatar
Laurent Aimar committed
505 506 507 508 509 510 511 512 513 514
    /* ref_idc == 0 for 6,9,10,11,12 */
};
enum nal_priority_e
{
    NAL_PRIORITY_DISPOSABLE = 0,
    NAL_PRIORITY_LOW        = 1,
    NAL_PRIORITY_HIGH       = 2,
    NAL_PRIORITY_HIGHEST    = 3,
};

515 516 517 518 519
/* The data within the payload is already NAL-encapsulated; the ref_idc and type
 * are merely in the struct for easy access by the calling application.
 * All data returned in an x264_nal_t, including the data in p_payload, is no longer
 * valid after the next call to x264_encoder_encode.  Thus it must be used or copied
 * before calling x264_encoder_encode or x264_encoder_headers again. */
Laurent Aimar's avatar
Laurent Aimar committed
520 521 522 523 524
typedef struct
{
    int i_ref_idc;  /* nal_priority_e */
    int i_type;     /* nal_unit_type_e */

525
    /* Size of payload in bytes. */
Laurent Aimar's avatar
Laurent Aimar committed
526
    int     i_payload;
527 528 529
    /* If param->b_annexb is set, Annex-B bytestream with 4-byte startcode.
     * Otherwise, startcode is replaced with a 4-byte size.
     * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
Laurent Aimar's avatar
Laurent Aimar committed
530 531 532 533
    uint8_t *p_payload;
} x264_nal_t;

/****************************************************************************
534
 * Encoder functions
Laurent Aimar's avatar
Laurent Aimar committed
535 536
 ****************************************************************************/

537 538 539 540 541 542 543
/* Force a link error in the case of linking against an incompatible API version.
 * Glue #defines exist to force correct macro expansion; the final output of the macro
 * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
#define x264_encoder_glue1(x,y) x##y
#define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
#define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)

Laurent Aimar's avatar
Laurent Aimar committed
544 545
/* x264_encoder_open:
 *      create a new encoder handler, all parameters from x264_param_t are copied */
546 547
x264_t *x264_encoder_open( x264_param_t * );

548
/* x264_encoder_reconfig:
549
 *      various parameters from x264_param_t are copied.
550 551
 *      this takes effect immediately, on whichever frame is encoded next;
 *      due to delay, this may not be the next frame passed to encoder_encode.
552
 *      if the change should apply to some particular frame, use x264_picture_t->param instead.
553 554
 *      returns 0 on success, negative on parameter validation error.
 *      not all parameters can be changed; see the actual function for a detailed breakdown. */
555
int     x264_encoder_reconfig( x264_t *, x264_param_t * );
556 557 558 559 560 561 562 563
/* x264_encoder_parameters:
 *      copies the current internal set of parameters to the pointer provided
 *      by the caller.  useful when the calling application needs to know
 *      how x264_encoder_open has changed the parameters, or the current state
 *      of the encoder after multiple x264_encoder_reconfig calls.
 *      note that the data accessible through pointers in the returned param struct
 *      (e.g. filenames) should not be modified by the calling application. */
void    x264_encoder_parameters( x264_t *, x264_param_t * );
Laurent Aimar's avatar
Laurent Aimar committed
564
/* x264_encoder_headers:
565
 *      return the SPS and PPS that will be used for the whole stream.
566
 *      *pi_nal is the number of NAL units outputted in pp_nal.
567 568
 *      returns negative on error.
 *      the payloads of all output NALs are guaranteed to be sequential in memory. */
569
int     x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
Laurent Aimar's avatar
Laurent Aimar committed
570
/* x264_encoder_encode:
571
 *      encode one picture.
572
 *      *pi_nal is the number of NAL units outputted in pp_nal.
573 574
 *      returns negative on error, zero if no NAL units returned.
 *      the payloads of all output NALs are guaranteed to be sequential in memory. */
575
int     x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
Laurent Aimar's avatar
Laurent Aimar committed
576 577 578
/* x264_encoder_close:
 *      close an encoder handler */
void    x264_encoder_close  ( x264_t * );
579 580 581 582
/* x264_encoder_delayed_frames:
 *      return the number of currently delayed (buffered) frames
 *      this should be used at the end of the stream, to know when you have all the encoded frames. */
int     x264_encoder_delayed_frames( x264_t * );
Laurent Aimar's avatar
Laurent Aimar committed
583 584

#endif