1 /*****************************************************************************
2 * x264.h: x264 public header
3 *****************************************************************************
4 * Copyright (C) 2003-2012 x264 project
6 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7 * Loren Merritt <lorenm@u.washington.edu>
8 * Fiona Glaser <fiona@x264.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111, USA.
24 * This program is also available under a commercial proprietary license.
25 * For more information, contact us at licensing@x264.com.
26 *****************************************************************************/
31 #if !defined(_STDINT_H) && !defined(_STDINT_H_) && \
32 !defined(_INTTYPES_H) && !defined(_INTTYPES_H_)
34 # pragma message("You must include stdint.h or inttypes.h before x264.h")
36 # warning You must include stdint.h or inttypes.h before x264.h
42 #include "x264_config.h"
44 #define X264_BUILD 124
46 /* Application developers planning to link against a shared library version of
47 * libx264 from a Microsoft Visual Studio or similar development environment
48 * will need to define X264_API_IMPORTS before including this header.
49 * This clause does not apply to MinGW, similar development environments, or non
50 * Windows platforms. */
51 #ifdef X264_API_IMPORTS
52 #define X264_API __declspec(dllimport)
58 * opaque handler for encoder */
59 typedef struct x264_t x264_t;
61 /****************************************************************************
62 * NAL structure and functions
63 ****************************************************************************/
72 NAL_SLICE_IDR = 5, /* ref_idc != 0 */
73 NAL_SEI = 6, /* ref_idc == 0 */
78 /* ref_idc == 0 for 6,9,10,11,12 */
82 NAL_PRIORITY_DISPOSABLE = 0,
84 NAL_PRIORITY_HIGH = 2,
85 NAL_PRIORITY_HIGHEST = 3,
88 /* The data within the payload is already NAL-encapsulated; the ref_idc and type
89 * are merely in the struct for easy access by the calling application.
90 * All data returned in an x264_nal_t, including the data in p_payload, is no longer
91 * valid after the next call to x264_encoder_encode. Thus it must be used or copied
92 * before calling x264_encoder_encode or x264_encoder_headers again. */
95 int i_ref_idc; /* nal_priority_e */
96 int i_type; /* nal_unit_type_e */
98 int i_first_mb; /* If this NAL is a slice, the index of the first MB in the slice. */
99 int i_last_mb; /* If this NAL is a slice, the index of the last MB in the slice. */
101 /* Size of payload in bytes. */
103 /* If param->b_annexb is set, Annex-B bytestream with startcode.
104 * Otherwise, startcode is replaced with a 4-byte size.
105 * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
109 /****************************************************************************
111 ****************************************************************************/
114 #define X264_CPU_CACHELINE_32 0x0000001 /* avoid memory loads that span the border between two cachelines */
115 #define X264_CPU_CACHELINE_64 0x0000002 /* 32/64 is the size of a cacheline in bytes */
116 #define X264_CPU_ALTIVEC 0x0000004
117 #define X264_CPU_MMX 0x0000008
118 #define X264_CPU_MMX2 0x0000010 /* MMX2 aka MMXEXT aka ISSE */
119 #define X264_CPU_MMXEXT X264_CPU_MMX2
120 #define X264_CPU_SSE 0x0000020
121 #define X264_CPU_SSE2 0x0000040
122 #define X264_CPU_SSE2_IS_SLOW 0x0000080 /* avoid most SSE2 functions on Athlon64 */
123 #define X264_CPU_SSE2_IS_FAST 0x0000100 /* a few functions are only faster on Core2 and Phenom */
124 #define X264_CPU_SSE3 0x0000200
125 #define X264_CPU_SSSE3 0x0000400
126 #define X264_CPU_SHUFFLE_IS_FAST 0x0000800 /* Penryn, Nehalem, and Phenom have fast shuffle units */
127 #define X264_CPU_STACK_MOD4 0x0001000 /* if stack is only mod4 and not mod16 */
128 #define X264_CPU_SSE4 0x0002000 /* SSE4.1 */
129 #define X264_CPU_SSE42 0x0004000 /* SSE4.2 */
130 #define X264_CPU_SSE_MISALIGN 0x0008000 /* Phenom support for misaligned SSE instruction arguments */
131 #define X264_CPU_LZCNT 0x0010000 /* Phenom support for "leading zero count" instruction. */
132 #define X264_CPU_ARMV6 0x0020000
133 #define X264_CPU_NEON 0x0040000 /* ARM NEON */
134 #define X264_CPU_FAST_NEON_MRC 0x0080000 /* Transfer from NEON to ARM register is fast (Cortex-A9) */
135 #define X264_CPU_SLOW_CTZ 0x0100000 /* BSR/BSF x86 instructions are really slow on some CPUs */
136 #define X264_CPU_SLOW_ATOM 0x0200000 /* The Atom just sucks */
137 #define X264_CPU_AVX 0x0400000 /* AVX support: requires OS support even if YMM registers
139 #define X264_CPU_XOP 0x0800000 /* AMD XOP */
140 #define X264_CPU_FMA4 0x1000000 /* AMD FMA4 */
141 #define X264_CPU_AVX2 0x2000000 /* AVX2 */
142 #define X264_CPU_FMA3 0x4000000 /* Intel FMA3 */
143 #define X264_CPU_BMI1 0x8000000 /* BMI1 */
144 #define X264_CPU_BMI2 0x10000000 /* BMI2 */
145 #define X264_CPU_TBM 0x20000000 /* AMD TBM */
149 #define X264_ANALYSE_I4x4 0x0001 /* Analyse i4x4 */
150 #define X264_ANALYSE_I8x8 0x0002 /* Analyse i8x8 (requires 8x8 transform) */
151 #define X264_ANALYSE_PSUB16x16 0x0010 /* Analyse p16x8, p8x16 and p8x8 */
152 #define X264_ANALYSE_PSUB8x8 0x0020 /* Analyse p8x4, p4x8, p4x4 */
153 #define X264_ANALYSE_BSUB16x16 0x0100 /* Analyse b16x8, b8x16 and b8x8 */
154 #define X264_DIRECT_PRED_NONE 0
155 #define X264_DIRECT_PRED_SPATIAL 1
156 #define X264_DIRECT_PRED_TEMPORAL 2
157 #define X264_DIRECT_PRED_AUTO 3
158 #define X264_ME_DIA 0
159 #define X264_ME_HEX 1
160 #define X264_ME_UMH 2
161 #define X264_ME_ESA 3
162 #define X264_ME_TESA 4
163 #define X264_CQM_FLAT 0
164 #define X264_CQM_JVT 1
165 #define X264_CQM_CUSTOM 2
166 #define X264_RC_CQP 0
167 #define X264_RC_CRF 1
168 #define X264_RC_ABR 2
169 #define X264_QP_AUTO 0
170 #define X264_AQ_NONE 0
171 #define X264_AQ_VARIANCE 1
172 #define X264_AQ_AUTOVARIANCE 2
173 #define X264_B_ADAPT_NONE 0
174 #define X264_B_ADAPT_FAST 1
175 #define X264_B_ADAPT_TRELLIS 2
176 #define X264_WEIGHTP_NONE 0
177 #define X264_WEIGHTP_SIMPLE 1
178 #define X264_WEIGHTP_SMART 2
179 #define X264_B_PYRAMID_NONE 0
180 #define X264_B_PYRAMID_STRICT 1
181 #define X264_B_PYRAMID_NORMAL 2
182 #define X264_KEYINT_MIN_AUTO 0
183 #define X264_KEYINT_MAX_INFINITE (1<<30)
185 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
186 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
187 static const char * const x264_b_pyramid_names[] = { "none", "strict", "normal", 0 };
188 static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
189 static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
190 static const char * const x264_fullrange_names[] = { "off", "on", 0 };
191 static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", 0 };
192 static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316", 0 };
193 static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", 0 };
194 static const char * const x264_nal_hrd_names[] = { "none", "vbr", "cbr", 0 };
196 /* Colorspace type */
197 #define X264_CSP_MASK 0x00ff /* */
198 #define X264_CSP_NONE 0x0000 /* Invalid mode */
199 #define X264_CSP_I420 0x0001 /* yuv 4:2:0 planar */
200 #define X264_CSP_YV12 0x0002 /* yvu 4:2:0 planar */
201 #define X264_CSP_NV12 0x0003 /* yuv 4:2:0, with one y plane and one packed u+v */
202 #define X264_CSP_I422 0x0004 /* yuv 4:2:2 planar */
203 #define X264_CSP_YV16 0x0005 /* yvu 4:2:2 planar */
204 #define X264_CSP_NV16 0x0006 /* yuv 4:2:2, with one y plane and one packed u+v */
205 #define X264_CSP_I444 0x0007 /* yuv 4:4:4 planar */
206 #define X264_CSP_YV24 0x0008 /* yvu 4:4:4 planar */
207 #define X264_CSP_BGR 0x0009 /* packed bgr 24bits */
208 #define X264_CSP_BGRA 0x000a /* packed bgr 32bits */
209 #define X264_CSP_RGB 0x000b /* packed rgb 24bits */
210 #define X264_CSP_MAX 0x000c /* end of list */
211 #define X264_CSP_VFLIP 0x1000 /* the csp is vertically flipped */
212 #define X264_CSP_HIGH_DEPTH 0x2000 /* the csp has a depth of 16 bits per pixel component */
215 #define X264_TYPE_AUTO 0x0000 /* Let x264 choose the right type */
216 #define X264_TYPE_IDR 0x0001
217 #define X264_TYPE_I 0x0002
218 #define X264_TYPE_P 0x0003
219 #define X264_TYPE_BREF 0x0004 /* Non-disposable B-frame */
220 #define X264_TYPE_B 0x0005
221 #define X264_TYPE_KEYFRAME 0x0006 /* IDR or I depending on b_open_gop option */
222 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
223 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
226 #define X264_LOG_NONE (-1)
227 #define X264_LOG_ERROR 0
228 #define X264_LOG_WARNING 1
229 #define X264_LOG_INFO 2
230 #define X264_LOG_DEBUG 3
233 #define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
234 #define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
237 #define X264_NAL_HRD_NONE 0
238 #define X264_NAL_HRD_VBR 1
239 #define X264_NAL_HRD_CBR 2
241 /* Zones: override ratecontrol or other options for specific sections of the video.
242 * See x264_encoder_reconfig() for which options can be changed.
243 * If zones overlap, whichever comes later in the list takes precedence. */
246 int i_start, i_end; /* range of frame numbers */
247 int b_force_qp; /* whether to use qp vs bitrate factor */
249 float f_bitrate_factor;
250 struct x264_param_t *param;
253 typedef struct x264_param_t
257 int i_threads; /* encode multiple frames in parallel */
258 int b_sliced_threads; /* Whether to use slice-based threading. */
259 int b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
260 int b_cpu_independent; /* force canonical behavior rather than cpu-dependent optimal algorithms */
261 int i_sync_lookahead; /* threaded lookahead buffer */
263 /* Video Properties */
266 int i_csp; /* CSP of encoded bitstream */
268 int i_frame_total; /* number of frames to encode if known, else 0 */
271 * Uses Buffering and Picture Timing SEIs to signal HRD
272 * The HRD in H.264 was not designed with VFR in mind.
273 * It is therefore not recommendeded to use NAL HRD with VFR.
274 * Furthermore, reconfiguring the VBV (via x264_encoder_reconfig)
275 * will currently generate invalid HRD. */
280 /* they will be reduced to be 0 < x <= 65535 and prime */
284 int i_overscan; /* 0=undef, 1=no overscan, 2=overscan */
286 /* see h264 annex E for the values of the following */
292 int i_chroma_loc; /* both top & bottom */
295 /* Bitstream parameters */
296 int i_frame_reference; /* Maximum number of reference frames */
297 int i_dpb_size; /* Force a DPB size larger than that implied by B-frames and reference frames.
298 * Useful in combination with interactive error resilience. */
299 int i_keyint_max; /* Force an IDR keyframe at this interval */
300 int i_keyint_min; /* Scenecuts closer together than this are coded as I, not IDR. */
301 int i_scenecut_threshold; /* how aggressively to insert extra I frames */
302 int b_intra_refresh; /* Whether or not to use periodic intra refresh instead of IDR frames. */
304 int i_bframe; /* how many b-frame between 2 references pictures */
305 int i_bframe_adaptive;
307 int i_bframe_pyramid; /* Keep some B-frames as references: 0=off, 1=strict hierarchical, 2=normal */
311 int b_deblocking_filter;
312 int i_deblocking_filter_alphac0; /* [-6, 6] -6 light filter, 6 strong */
313 int i_deblocking_filter_beta; /* [-6, 6] idem */
316 int i_cabac_init_idc;
319 int b_constrained_intra;
322 char *psz_cqm_file; /* JM format */
323 uint8_t cqm_4iy[16]; /* used only if i_cqm_preset == X264_CQM_CUSTOM */
333 void (*pf_log)( void *, int i_level, const char *psz, va_list );
337 int b_full_recon; /* fully reconstruct frames, even when not necessary for encoding. Implied by psz_dump_yuv */
338 char *psz_dump_yuv; /* filename for reconstructed frames */
340 /* Encoder analyser parameters */
343 unsigned int intra; /* intra partitions */
344 unsigned int inter; /* inter partitions */
347 int i_weighted_pred; /* weighting for P-frames */
348 int b_weighted_bipred; /* implicit weighting for B-frames */
349 int i_direct_mv_pred; /* spatial vs temporal mv prediction */
350 int i_chroma_qp_offset;
352 int i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
353 int i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
354 int i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
355 int i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
356 int i_subpel_refine; /* subpixel motion estimation quality */
357 int b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
358 int b_mixed_references; /* allow each mb partition to have its own reference number */
359 int i_trellis; /* trellis RD quantization */
360 int b_fast_pskip; /* early SKIP detection on P-frames */
361 int b_dct_decimate; /* transform coefficient thresholding on P-frames */
362 int i_noise_reduction; /* adaptive pseudo-deadzone */
363 float f_psy_rd; /* Psy RD strength */
364 float f_psy_trellis; /* Psy trellis strength */
365 int b_psy; /* Toggle all psy optimizations */
367 int b_mb_info; /* Use input mb_info data in x264_picture_t */
369 /* the deadzone size that will be used in luma quantization */
370 int i_luma_deadzone[2]; /* {inter, intra} */
372 int b_psnr; /* compute and print PSNR stats */
373 int b_ssim; /* compute and print SSIM stats */
376 /* Rate control parameters */
379 int i_rc_method; /* X264_RC_* */
381 int i_qp_constant; /* 0 to (51 + 6*(x264_bit_depth-8)). 0=lossless */
382 int i_qp_min; /* min allowed QP value */
383 int i_qp_max; /* max allowed QP value */
384 int i_qp_step; /* max QP step between frames */
387 float f_rf_constant; /* 1pass VBR, nominal QP */
388 float f_rf_constant_max; /* In CRF mode, maximum CRF as caused by VBV */
389 float f_rate_tolerance;
390 int i_vbv_max_bitrate;
391 int i_vbv_buffer_size;
392 float f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
396 int i_aq_mode; /* psy adaptive QP. (X264_AQ_*) */
398 int b_mb_tree; /* Macroblock-tree ratecontrol. */
402 int b_stat_write; /* Enable stat writing in psz_stat_out */
404 int b_stat_read; /* Read stat from psz_stat_in and use it */
407 /* 2pass params (same as ffmpeg ones) */
408 float f_qcompress; /* 0.0 => cbr, 1.0 => constant qp */
409 float f_qblur; /* temporally blur quants */
410 float f_complexity_blur; /* temporally blur complexity */
411 x264_zone_t *zones; /* ratecontrol overrides */
412 int i_zones; /* number of zone_t's */
413 char *psz_zones; /* alternate method of specifying zones */
416 /* Cropping Rectangle parameters: added to those implicitly defined by
417 non-mod16 video resolutions. */
422 unsigned int i_right;
423 unsigned int i_bottom;
426 /* frame packing arrangement flag */
429 /* Muxing parameters */
430 int b_aud; /* generate access unit delimiters */
431 int b_repeat_headers; /* put SPS/PPS before each keyframe */
432 int b_annexb; /* if set, place start codes (4 bytes) before NAL units,
433 * otherwise place size (4 bytes) before NAL units. */
434 int i_sps_id; /* SPS and PPS id number */
435 int b_vfr_input; /* VFR input. If 1, use timebase and timestamps for ratecontrol purposes.
436 * If 0, use fps only. */
437 int b_pulldown; /* use explicity set timebase for CFR */
440 uint32_t i_timebase_num; /* Timebase numerator */
441 uint32_t i_timebase_den; /* Timebase denominator */
446 * The correct pic_struct must be passed with each input frame.
447 * The input timebase should be the timebase corresponding to the output framerate. This should be constant.
448 * e.g. for 3:2 pulldown timebase should be 1001/30000
449 * The PTS passed with each frame must be the PTS of the frame after pulldown is applied.
450 * Frame doubling and tripling require b_vfr_input set to zero (see H.264 Table D-1)
452 * Pulldown changes are not clearly defined in H.264. Therefore, it is the calling app's responsibility to manage this.
459 * Used only when b_interlaced=0. Setting this flag makes it possible to flag the stream as PAFF interlaced yet
460 * encode all frames progessively. It is useful for encoding 25p and 30p Blu-Ray streams.
463 int b_fake_interlaced;
465 /* Slicing parameters */
466 int i_slice_max_size; /* Max size per slice in bytes; includes estimated NAL overhead. */
467 int i_slice_max_mbs; /* Max number of MBs per slice; overrides i_slice_count. */
468 int i_slice_count; /* Number of slices per frame: forces rectangular slices. */
470 /* Optional callback for freeing this x264_param_t when it is done being used.
471 * Only used when the x264_param_t sits in memory for an indefinite period of time,
472 * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
473 * Not used when x264_encoder_reconfig is called directly. */
474 void (*param_free)( void* );
476 /* Optional low-level callback for low-latency encoding. Called for each output NAL unit
477 * immediately after the NAL unit is finished encoding. This allows the calling application
478 * to begin processing video data (e.g. by sending packets over a network) before the frame
481 * This callback MUST do the following in order to work correctly:
482 * 1) Have available an output buffer of at least size nal->i_payload*3/2 + 5 + 16.
483 * 2) Call x264_nal_encode( h, dst, nal ), where dst is the output buffer.
484 * After these steps, the content of nal is valid and can be used in the same way as if
485 * the NAL unit were output by x264_encoder_encode.
487 * This does not need to be synchronous with the encoding process: the data pointed to
488 * by nal (both before and after x264_nal_encode) will remain valid until the next
489 * x264_encoder_encode call. The callback must be re-entrant.
491 * This callback does not work with frame-based threads; threads must be disabled
492 * or sliced-threads enabled. This callback also does not work as one would expect
493 * with HRD -- since the buffering period SEI cannot be calculated until the frame
494 * is finished encoding, it will not be sent via this callback.
496 * Note also that the NALs are not necessarily returned in order when sliced threads is
497 * enabled. Accordingly, the variable i_first_mb and i_last_mb are available in
498 * x264_nal_t to help the calling application reorder the slices if necessary.
500 * When this callback is enabled, x264_encoder_encode does not return valid NALs;
501 * the calling application is expected to acquire all output NALs through the callback.
503 * It is generally sensible to combine this callback with a use of slice-max-mbs or
505 void (*nalu_process) ( x264_t *h, x264_nal_t *nal );
508 void x264_nal_encode( x264_t *h, uint8_t *dst, x264_nal_t *nal );
510 /****************************************************************************
511 * H.264 level restriction information
512 ****************************************************************************/
517 int mbps; /* max macroblock processing rate (macroblocks/sec) */
518 int frame_size; /* max frame size (macroblocks) */
519 int dpb; /* max decoded picture buffer (bytes) */
520 int bitrate; /* max bitrate (kbit/sec) */
521 int cpb; /* max vbv buffer (kbit) */
522 int mv_range; /* max vertical mv component range (pixels) */
523 int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
524 int slice_rate; /* ?? */
525 int mincr; /* min compression ratio */
526 int bipred8x8; /* limit bipred to >=8x8 */
527 int direct8x8; /* limit b_direct to >=8x8 */
528 int frame_only; /* forbid interlacing */
531 /* all of the levels defined in the standard, terminated by .level_idc=0 */
532 X264_API extern const x264_level_t x264_levels[];
534 /****************************************************************************
535 * Basic parameter handling functions
536 ****************************************************************************/
538 /* x264_param_default:
539 * fill x264_param_t with default values and do CPU detection */
540 void x264_param_default( x264_param_t * );
543 * set one parameter by name.
544 * returns 0 on success, or returns one of the following errors.
545 * note: BAD_VALUE occurs only if it can't even parse the value,
546 * numerical range is not checked until x264_encoder_open() or
547 * x264_encoder_reconfig().
548 * value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
549 #define X264_PARAM_BAD_NAME (-1)
550 #define X264_PARAM_BAD_VALUE (-2)
551 int x264_param_parse( x264_param_t *, const char *name, const char *value );
553 /****************************************************************************
554 * Advanced parameter handling functions
555 ****************************************************************************/
557 /* These functions expose the full power of x264's preset-tune-profile system for
558 * easy adjustment of large numbers of internal parameters.
560 * In order to replicate x264CLI's option handling, these functions MUST be called
561 * in the following order:
562 * 1) x264_param_default_preset
563 * 2) Custom user options (via param_parse or directly assigned variables)
564 * 3) x264_param_apply_fastfirstpass
565 * 4) x264_param_apply_profile
567 * Additionally, x264CLI does not apply step 3 if the preset chosen is "placebo"
568 * or --slow-firstpass is set. */
570 /* x264_param_default_preset:
571 * The same as x264_param_default, but also use the passed preset and tune
572 * to modify the default settings.
573 * (either can be NULL, which implies no preset or no tune, respectively)
575 * Currently available presets are, ordered from fastest to slowest: */
576 static const char * const x264_preset_names[] = { "ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo", 0 };
578 /* The presets can also be indexed numerically, as in:
579 * x264_param_default_preset( ¶m, "3", ... )
580 * with ultrafast mapping to "0" and placebo mapping to "9". This mapping may
581 * of course change if new presets are added in between, but will always be
582 * ordered from fastest to slowest.
584 * Warning: the speed of these presets scales dramatically. Ultrafast is a full
585 * 100 times faster than placebo!
587 * Currently available tunings are: */
588 static const char * const x264_tune_names[] = { "film", "animation", "grain", "stillimage", "psnr", "ssim", "fastdecode", "zerolatency", 0 };
590 /* Multiple tunings can be used if separated by a delimiter in ",./-+",
591 * however multiple psy tunings cannot be used.
592 * film, animation, grain, stillimage, psnr, and ssim are psy tunings.
594 * returns 0 on success, negative on failure (e.g. invalid preset/tune name). */
595 int x264_param_default_preset( x264_param_t *, const char *preset, const char *tune );
597 /* x264_param_apply_fastfirstpass:
598 * If first-pass mode is set (rc.b_stat_read == 0, rc.b_stat_write == 1),
599 * modify the encoder settings to disable options generally not useful on
601 void x264_param_apply_fastfirstpass( x264_param_t * );
603 /* x264_param_apply_profile:
604 * Applies the restrictions of the given profile.
605 * Currently available profiles are, from most to least restrictive: */
606 static const char * const x264_profile_names[] = { "baseline", "main", "high", "high10", "high422", "high444", 0 };
608 /* (can be NULL, in which case the function will do nothing)
610 * Does NOT guarantee that the given profile will be used: if the restrictions
611 * of "High" are applied to settings that are already Baseline-compatible, the
612 * stream will remain baseline. In short, it does not increase settings, only
615 * returns 0 on success, negative on failure (e.g. invalid profile name). */
616 int x264_param_apply_profile( x264_param_t *, const char *profile );
618 /****************************************************************************
619 * Picture structures and functions
620 ****************************************************************************/
623 * Specifies the number of bits per pixel that x264 uses. This is also the
624 * bit depth that x264 encodes in. If this value is > 8, x264 will read
625 * two bytes of input data for each pixel sample, and expect the upper
626 * (16-x264_bit_depth) bits to be zero.
627 * Note: The flag X264_CSP_HIGH_DEPTH must be used to specify the
628 * colorspace depth as well. */
629 X264_API extern const int x264_bit_depth;
631 /* x264_chroma_format:
632 * Specifies the chroma formats that x264 supports encoding. When this
633 * value is non-zero, then it represents a X264_CSP_* that is the only
634 * chroma format that x264 supports encoding. If the value is 0 then
635 * there are no restrictions. */
636 X264_API extern const int x264_chroma_format;
640 PIC_STRUCT_AUTO = 0, // automatically decide (default)
641 PIC_STRUCT_PROGRESSIVE = 1, // progressive frame
642 // "TOP" and "BOTTOM" are not supported in x264 (PAFF only)
643 PIC_STRUCT_TOP_BOTTOM = 4, // top field followed by bottom
644 PIC_STRUCT_BOTTOM_TOP = 5, // bottom field followed by top
645 PIC_STRUCT_TOP_BOTTOM_TOP = 6, // top field, bottom field, top field repeated
646 PIC_STRUCT_BOTTOM_TOP_BOTTOM = 7, // bottom field, top field, bottom field repeated
647 PIC_STRUCT_DOUBLE = 8, // double frame
648 PIC_STRUCT_TRIPLE = 9, // triple frame
653 double cpb_initial_arrival_time;
654 double cpb_final_arrival_time;
655 double cpb_removal_time;
657 double dpb_output_time;
660 /* Arbitrary user SEI:
661 * Payload size is in bytes and the payload pointer must be valid.
662 * Payload types and syntax can be found in Annex D of the H.264 Specification.
663 * SEI payload alignment bits as described in Annex D must be included at the
664 * end of the payload if needed.
665 * The payload should not be NAL-encapsulated.
666 * Payloads are written first in order of input, apart from in the case when HRD
667 * is enabled where payloads are written after the Buffering Period SEI. */
674 } x264_sei_payload_t;
679 x264_sei_payload_t *payloads;
680 /* In: optional callback to free each payload AND x264_sei_payload_t when used. */
681 void (*sei_free)( void* );
686 int i_csp; /* Colorspace */
687 int i_plane; /* Number of image planes */
688 int i_stride[4]; /* Strides for each plane */
689 uint8_t *plane[4]; /* Pointers to each plane */
694 /* All arrays of data here are ordered as follows:
695 * each array contains one offset per macroblock, in raster scan order. In interlaced
696 * mode, top-field MBs and bottom-field MBs are interleaved at the row level.
697 * Macroblocks are 16x16 blocks of pixels (with respect to the luma plane). For the
698 * purposes of calculating the number of macroblocks, width and height are rounded up to
699 * the nearest 16. If in interlaced mode, height is rounded up to the nearest 32 instead. */
701 /* In: an array of quantizer offsets to be applied to this image during encoding.
702 * These are added on top of the decisions made by x264.
703 * Offsets can be fractional; they are added before QPs are rounded to integer.
704 * Adaptive quantization must be enabled to use this feature. Behavior if quant
705 * offsets differ between encoding passes is undefined. */
706 float *quant_offsets;
707 /* In: optional callback to free quant_offsets when used.
708 * Useful if one wants to use a different quant_offset array for each frame. */
709 void (*quant_offsets_free)( void* );
711 /* In: optional array of flags for each macroblock.
712 * Allows specifying additional information for the encoder such as which macroblocks
713 * remain unchanged. Usable flags are listed below.
714 * x264_param_t.analyse.b_mb_info must be set to use this, since x264 needs to track
715 * extra data internally to make full use of this information. */
717 /* In: optional callback to free mb_info when used. */
718 void (*mb_info_free)( void* );
720 /* The macroblock is constant and remains unchanged from the previous frame. */
721 #define X264_MBINFO_CONSTANT (1<<0)
722 /* More flags may be added in the future. */
724 /* Out: SSIM of the the frame luma (if x264_param_t.b_ssim is set) */
726 /* Out: Average PSNR of the frame (if x264_param_t.b_psnr is set) */
728 /* Out: PSNR of Y, U, and V (if x264_param_t.b_psnr is set) */
730 } x264_image_properties_t;
734 /* In: force picture type (if not auto)
735 * If x264 encoding parameters are violated in the forcing of picture types,
736 * x264 will correct the input picture type and log a warning.
737 * The quality of frametype decisions may suffer if a great deal of fine-grained
738 * mixing of auto and forced frametypes is done.
739 * Out: type of the picture encoded */
741 /* In: force quantizer for != X264_QP_AUTO */
743 /* In: pic_struct, for pulldown/doubling/etc...used only if b_pic_struct=1.
744 * use pic_struct_e for pic_struct inputs
745 * Out: pic_struct element associated with frame */
747 /* Out: whether this frame is a keyframe. Important when using modes that result in
748 * SEI recovery points being used instead of IDR frames. */
750 /* In: user pts, Out: pts of encoded picture (user)*/
752 /* Out: frame dts. When the pts of the first frame is close to zero,
753 * initial frames may have a negative dts which must be dealt with by any muxer */
755 /* In: custom encoding parameters to be set from this frame forwards
756 (in coded order, not display order). If NULL, continue using
757 parameters from the previous frame. Some parameters, such as
758 aspect ratio, can only be changed per-GOP due to the limitations
759 of H.264 itself; in this case, the caller must force an IDR frame
760 if it needs the changed parameter to apply immediately. */
762 /* In: raw image data */
763 /* Out: reconstructed image data. x264 may skip part of the reconstruction process,
764 e.g. deblocking, in frames where it isn't necessary. To force complete
765 reconstruction, at a small speed cost, set b_full_recon. */
767 /* In: optional information to modify encoder decisions for this frame
768 * Out: information about the encoded frame */
769 x264_image_properties_t prop;
770 /* Out: HRD timing information. Output only when i_nal_hrd is set. */
771 x264_hrd_t hrd_timing;
772 /* In: arbitrary user SEI (e.g subtitles, AFDs) */
773 x264_sei_t extra_sei;
774 /* private user data. copied from input to output frames. */
778 /* x264_picture_init:
779 * initialize an x264_picture_t. Needs to be done if the calling application
780 * allocates its own x264_picture_t as opposed to using x264_picture_alloc. */
781 void x264_picture_init( x264_picture_t *pic );
783 /* x264_picture_alloc:
784 * alloc data for a picture. You must call x264_picture_clean on it.
785 * returns 0 on success, or -1 on malloc failure or invalid colorspace. */
786 int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
788 /* x264_picture_clean:
789 * free associated resource for a x264_picture_t allocated with
790 * x264_picture_alloc ONLY */
791 void x264_picture_clean( x264_picture_t *pic );
793 /****************************************************************************
795 ****************************************************************************/
797 /* Force a link error in the case of linking against an incompatible API version.
798 * Glue #defines exist to force correct macro expansion; the final output of the macro
799 * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
800 #define x264_encoder_glue1(x,y) x##y
801 #define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
802 #define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)
804 /* x264_encoder_open:
805 * create a new encoder handler, all parameters from x264_param_t are copied */
806 x264_t *x264_encoder_open( x264_param_t * );
808 /* x264_encoder_reconfig:
809 * various parameters from x264_param_t are copied.
810 * this takes effect immediately, on whichever frame is encoded next;
811 * due to delay, this may not be the next frame passed to encoder_encode.
812 * if the change should apply to some particular frame, use x264_picture_t->param instead.
813 * returns 0 on success, negative on parameter validation error.
814 * not all parameters can be changed; see the actual function for a detailed breakdown. */
815 int x264_encoder_reconfig( x264_t *, x264_param_t * );
816 /* x264_encoder_parameters:
817 * copies the current internal set of parameters to the pointer provided
818 * by the caller. useful when the calling application needs to know
819 * how x264_encoder_open has changed the parameters, or the current state
820 * of the encoder after multiple x264_encoder_reconfig calls.
821 * note that the data accessible through pointers in the returned param struct
822 * (e.g. filenames) should not be modified by the calling application. */
823 void x264_encoder_parameters( x264_t *, x264_param_t * );
824 /* x264_encoder_headers:
825 * return the SPS and PPS that will be used for the whole stream.
826 * *pi_nal is the number of NAL units outputted in pp_nal.
827 * returns negative on error.
828 * the payloads of all output NALs are guaranteed to be sequential in memory. */
829 int x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
830 /* x264_encoder_encode:
831 * encode one picture.
832 * *pi_nal is the number of NAL units outputted in pp_nal.
833 * returns negative on error, zero if no NAL units returned.
834 * the payloads of all output NALs are guaranteed to be sequential in memory. */
835 int x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
836 /* x264_encoder_close:
837 * close an encoder handler */
838 void x264_encoder_close ( x264_t * );
839 /* x264_encoder_delayed_frames:
840 * return the number of currently delayed (buffered) frames
841 * this should be used at the end of the stream, to know when you have all the encoded frames. */
842 int x264_encoder_delayed_frames( x264_t * );
843 /* x264_encoder_maximum_delayed_frames( x264_t *h ):
844 * return the maximum number of delayed (buffered) frames that can occur with the current
846 int x264_encoder_maximum_delayed_frames( x264_t *h );
847 /* x264_encoder_intra_refresh:
848 * If an intra refresh is not in progress, begin one with the next P-frame.
849 * If an intra refresh is in progress, begin one as soon as the current one finishes.
850 * Requires that b_intra_refresh be set.
852 * Useful for interactive streaming where the client can tell the server that packet loss has
853 * occurred. In this case, keyint can be set to an extremely high value so that intra refreshes
854 * only occur when calling x264_encoder_intra_refresh.
856 * In multi-pass encoding, if x264_encoder_intra_refresh is called differently in each pass,
857 * behavior is undefined.
859 * Should not be called during an x264_encoder_encode. */
860 void x264_encoder_intra_refresh( x264_t * );
861 /* x264_encoder_invalidate_reference:
862 * An interactive error resilience tool, designed for use in a low-latency one-encoder-few-clients
863 * system. When the client has packet loss or otherwise incorrectly decodes a frame, the encoder
864 * can be told with this command to "forget" the frame and all frames that depend on it, referencing
865 * only frames that occurred before the loss. This will force a keyframe if no frames are left to
866 * reference after the aforementioned "forgetting".
868 * It is strongly recommended to use a large i_dpb_size in this case, which allows the encoder to
869 * keep around extra, older frames to fall back on in case more recent frames are all invalidated.
870 * Unlike increasing i_frame_reference, this does not increase the number of frames used for motion
871 * estimation and thus has no speed impact. It is also recommended to set a very large keyframe
872 * interval, so that keyframes are not used except as necessary for error recovery.
874 * x264_encoder_invalidate_reference is not currently compatible with the use of B-frames or intra
877 * In multi-pass encoding, if x264_encoder_invalidate_reference is called differently in each pass,
878 * behavior is undefined.
880 * Should not be called during an x264_encoder_encode, but multiple calls can be made simultaneously.
882 * Returns 0 on success, negative on failure. */
883 int x264_encoder_invalidate_reference( x264_t *, int64_t pts );