1 /*****************************************************************************
2 * x264.h: h264 encoder library
3 *****************************************************************************
4 * Copyright (C) 2003-2008 x264 Project
6 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7 * Loren Merritt <lorenm@u.washington.edu>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111, USA.
22 *****************************************************************************/
27 #if !defined(_STDINT_H) && !defined(_STDINT_H_) && \
28 !defined(_INTTYPES_H) && !defined(_INTTYPES_H_)
30 # pragma message("You must include stdint.h or inttypes.h before x264.h")
32 # warning You must include stdint.h or inttypes.h before x264.h
41 * opaque handler for encoder */
42 typedef struct x264_t x264_t;
44 /****************************************************************************
46 ****************************************************************************/
49 #define X264_CPU_CACHELINE_32 0x000001 /* avoid memory loads that span the border between two cachelines */
50 #define X264_CPU_CACHELINE_64 0x000002 /* 32/64 is the size of a cacheline in bytes */
51 #define X264_CPU_ALTIVEC 0x000004
52 #define X264_CPU_MMX 0x000008
53 #define X264_CPU_MMXEXT 0x000010 /* MMX2 aka MMXEXT aka ISSE */
54 #define X264_CPU_SSE 0x000020
55 #define X264_CPU_SSE2 0x000040
56 #define X264_CPU_SSE2_IS_SLOW 0x000080 /* avoid most SSE2 functions on Athlon64 */
57 #define X264_CPU_SSE2_IS_FAST 0x000100 /* a few functions are only faster on Core2 and Phenom */
58 #define X264_CPU_SSE3 0x000200
59 #define X264_CPU_SSSE3 0x000400
60 #define X264_CPU_SHUFFLE_IS_FAST 0x000800 /* Penryn, Nehalem, and Phenom have fast shuffle units */
61 #define X264_CPU_STACK_MOD4 0x001000 /* if stack is only mod4 and not mod16 */
62 #define X264_CPU_SSE4 0x002000 /* SSE4.1 */
63 #define X264_CPU_SSE42 0x004000 /* SSE4.2 */
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 #define X264_CPU_ARMV6 0x020000
67 #define X264_CPU_NEON 0x040000 /* ARM NEON */
68 #define X264_CPU_FAST_NEON_MRC 0x080000 /* Transfer from NEON to ARM register is fast (Cortex-A9) */
69 #define X264_CPU_SLOW_CTZ 0x100000 /* BSR/BSF x86 instructions are really slow on some CPUs */
70 #define X264_CPU_SLOW_ATOM 0x200000 /* The Atom just sucks */
74 #define X264_ANALYSE_I4x4 0x0001 /* Analyse i4x4 */
75 #define X264_ANALYSE_I8x8 0x0002 /* Analyse i8x8 (requires 8x8 transform) */
76 #define X264_ANALYSE_PSUB16x16 0x0010 /* Analyse p16x8, p8x16 and p8x8 */
77 #define X264_ANALYSE_PSUB8x8 0x0020 /* Analyse p8x4, p4x8, p4x4 */
78 #define X264_ANALYSE_BSUB16x16 0x0100 /* Analyse b16x8, b8x16 and b8x8 */
79 #define X264_DIRECT_PRED_NONE 0
80 #define X264_DIRECT_PRED_SPATIAL 1
81 #define X264_DIRECT_PRED_TEMPORAL 2
82 #define X264_DIRECT_PRED_AUTO 3
87 #define X264_ME_TESA 4
88 #define X264_CQM_FLAT 0
89 #define X264_CQM_JVT 1
90 #define X264_CQM_CUSTOM 2
94 #define X264_AQ_NONE 0
95 #define X264_AQ_VARIANCE 1
96 #define X264_AQ_AUTOVARIANCE 2
97 #define X264_B_ADAPT_NONE 0
98 #define X264_B_ADAPT_FAST 1
99 #define X264_B_ADAPT_TRELLIS 2
100 #define X264_WEIGHTP_NONE 0
101 #define X264_WEIGHTP_BLIND 1
102 #define X264_WEIGHTP_SMART 2
103 #define X264_B_PYRAMID_NONE 0
104 #define X264_B_PYRAMID_STRICT 1
105 #define X264_B_PYRAMID_NORMAL 2
106 #define X264_KEYINT_MIN_AUTO 0
107 #define X264_OPEN_GOP_NONE 0
108 #define X264_OPEN_GOP_DISPLAY_ORDER 1
109 #define X264_OPEN_GOP_CODED_ORDER 2
111 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
112 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
113 static const char * const x264_b_pyramid_names[] = { "none", "strict", "normal", 0 };
114 static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
115 static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
116 static const char * const x264_fullrange_names[] = { "off", "on", 0 };
117 static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", 0 };
118 static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316", 0 };
119 static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", 0 };
120 static const char * const x264_nal_hrd_names[] = { "none", "vbr", "cbr", 0 };
121 static const char * const x264_open_gop_names[] = { "none", "display", "coded", 0 };
124 * legacy only; nothing other than I420 is really supported. */
125 #define X264_CSP_MASK 0x00ff /* */
126 #define X264_CSP_NONE 0x0000 /* Invalid mode */
127 #define X264_CSP_I420 0x0001 /* yuv 4:2:0 planar */
128 #define X264_CSP_I422 0x0002 /* yuv 4:2:2 planar */
129 #define X264_CSP_I444 0x0003 /* yuv 4:4:4 planar */
130 #define X264_CSP_YV12 0x0004 /* yuv 4:2:0 planar */
131 #define X264_CSP_YUYV 0x0005 /* yuv 4:2:2 packed */
132 #define X264_CSP_RGB 0x0006 /* rgb 24bits */
133 #define X264_CSP_BGR 0x0007 /* bgr 24bits */
134 #define X264_CSP_BGRA 0x0008 /* bgr 32bits */
135 #define X264_CSP_MAX 0x0009 /* end of list */
136 #define X264_CSP_VFLIP 0x1000 /* */
139 #define X264_TYPE_AUTO 0x0000 /* Let x264 choose the right type */
140 #define X264_TYPE_IDR 0x0001
141 #define X264_TYPE_I 0x0002
142 #define X264_TYPE_P 0x0003
143 #define X264_TYPE_BREF 0x0004 /* Non-disposable B-frame */
144 #define X264_TYPE_B 0x0005
145 #define X264_TYPE_KEYFRAME 0x0006 /* IDR or I depending on b_open_gop option */
146 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
147 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
150 #define X264_LOG_NONE (-1)
151 #define X264_LOG_ERROR 0
152 #define X264_LOG_WARNING 1
153 #define X264_LOG_INFO 2
154 #define X264_LOG_DEBUG 3
157 #define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
158 #define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
161 #define X264_NAL_HRD_NONE 0
162 #define X264_NAL_HRD_VBR 1
163 #define X264_NAL_HRD_CBR 2
165 /* Zones: override ratecontrol or other options for specific sections of the video.
166 * See x264_encoder_reconfig() for which options can be changed.
167 * If zones overlap, whichever comes later in the list takes precedence. */
170 int i_start, i_end; /* range of frame numbers */
171 int b_force_qp; /* whether to use qp vs bitrate factor */
173 float f_bitrate_factor;
174 struct x264_param_t *param;
177 typedef struct x264_param_t
181 int i_threads; /* encode multiple frames in parallel */
182 int b_sliced_threads; /* Whether to use slice-based threading. */
183 int b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
184 int i_sync_lookahead; /* threaded lookahead buffer */
186 /* Video Properties */
189 int i_csp; /* CSP of encoded bitstream, only i420 supported */
191 int i_frame_total; /* number of frames to encode if known, else 0 */
194 * Uses Buffering and Picture Timing SEIs to signal HRD
195 * The HRD in H.264 was not designed with VFR in mind.
196 * It is therefore not recommendeded to use NAL HRD with VFR.
197 * Furthermore, reconfiguring the VBV (via x264_encoder_reconfig)
198 * will currently generate invalid HRD. */
203 /* they will be reduced to be 0 < x <= 65535 and prime */
207 int i_overscan; /* 0=undef, 1=no overscan, 2=overscan */
209 /* see h264 annex E for the values of the following */
215 int i_chroma_loc; /* both top & bottom */
218 /* Bitstream parameters */
219 int i_frame_reference; /* Maximum number of reference frames */
220 int i_keyint_max; /* Force an IDR keyframe at this interval */
221 int i_keyint_min; /* Scenecuts closer together than this are coded as I, not IDR. */
222 int i_scenecut_threshold; /* how aggressively to insert extra I frames */
223 int b_intra_refresh; /* Whether or not to use periodic intra refresh instead of IDR frames. */
225 int i_bframe; /* how many b-frame between 2 references pictures */
226 int i_bframe_adaptive;
228 int i_bframe_pyramid; /* Keep some B-frames as references: 0=off, 1=strict hierarchical, 2=normal */
229 int i_open_gop; /* Open gop: 1=display order, 2=coded order to determine gop size */
231 int b_deblocking_filter;
232 int i_deblocking_filter_alphac0; /* [-6, 6] -6 light filter, 6 strong */
233 int i_deblocking_filter_beta; /* [-6, 6] idem */
236 int i_cabac_init_idc;
239 int b_constrained_intra;
242 char *psz_cqm_file; /* JM format */
243 uint8_t cqm_4iy[16]; /* used only if i_cqm_preset == X264_CQM_CUSTOM */
251 void (*pf_log)( void *, int i_level, const char *psz, va_list );
255 char *psz_dump_yuv; /* filename for reconstructed frames */
257 /* Encoder analyser parameters */
260 unsigned int intra; /* intra partitions */
261 unsigned int inter; /* inter partitions */
264 int i_weighted_pred; /* weighting for P-frames */
265 int b_weighted_bipred; /* implicit weighting for B-frames */
266 int i_direct_mv_pred; /* spatial vs temporal mv prediction */
267 int i_chroma_qp_offset;
269 int i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
270 int i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
271 int i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
272 int i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
273 int i_subpel_refine; /* subpixel motion estimation quality */
274 int b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
275 int b_mixed_references; /* allow each mb partition to have its own reference number */
276 int i_trellis; /* trellis RD quantization */
277 int b_fast_pskip; /* early SKIP detection on P-frames */
278 int b_dct_decimate; /* transform coefficient thresholding on P-frames */
279 int i_noise_reduction; /* adaptive pseudo-deadzone */
280 float f_psy_rd; /* Psy RD strength */
281 float f_psy_trellis; /* Psy trellis strength */
282 int b_psy; /* Toggle all psy optimizations */
284 /* the deadzone size that will be used in luma quantization */
285 int i_luma_deadzone[2]; /* {inter, intra} */
287 int b_psnr; /* compute and print PSNR stats */
288 int b_ssim; /* compute and print SSIM stats */
291 /* Rate control parameters */
294 int i_rc_method; /* X264_RC_* */
296 int i_qp_constant; /* 0-51 */
297 int i_qp_min; /* min allowed QP value */
298 int i_qp_max; /* max allowed QP value */
299 int i_qp_step; /* max QP step between frames */
302 float f_rf_constant; /* 1pass VBR, nominal QP */
303 float f_rf_constant_max; /* In CRF mode, maximum CRF as caused by VBV */
304 float f_rate_tolerance;
305 int i_vbv_max_bitrate;
306 int i_vbv_buffer_size;
307 float f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
311 int i_aq_mode; /* psy adaptive QP. (X264_AQ_*) */
313 int b_mb_tree; /* Macroblock-tree ratecontrol. */
317 int b_stat_write; /* Enable stat writing in psz_stat_out */
319 int b_stat_read; /* Read stat from psz_stat_in and use it */
322 /* 2pass params (same as ffmpeg ones) */
323 float f_qcompress; /* 0.0 => cbr, 1.0 => constant qp */
324 float f_qblur; /* temporally blur quants */
325 float f_complexity_blur; /* temporally blur complexity */
326 x264_zone_t *zones; /* ratecontrol overrides */
327 int i_zones; /* number of zone_t's */
328 char *psz_zones; /* alternate method of specifying zones */
331 /* Muxing parameters */
332 int b_aud; /* generate access unit delimiters */
333 int b_repeat_headers; /* put SPS/PPS before each keyframe */
334 int b_annexb; /* if set, place start codes (4 bytes) before NAL units,
335 * otherwise place size (4 bytes) before NAL units. */
336 int i_sps_id; /* SPS and PPS id number */
337 int b_vfr_input; /* VFR input */
340 uint32_t i_timebase_num; /* Timebase numerator */
341 uint32_t i_timebase_den; /* Timebase denominator */
342 int b_dts_compress; /* DTS compression: this algorithm eliminates negative DTS
343 * by compressing them to be less than the second PTS.
344 * Warning: this will change the timebase! */
349 * The correct pic_struct must be passed with each input frame.
350 * The input timebase should be the timebase corresponding to the output framerate. This should be constant.
351 * e.g. for 3:2 pulldown timebase should be 1001/30000
352 * The PTS passed with each frame must be the PTS of the frame after pulldown is applied.
353 * Frame doubling and tripling require b_vfr_input set to zero (see H.264 Table D-1)
355 * Pulldown changes are not clearly defined in H.264. Therefore, it is the calling app's responsibility to manage this.
362 * Used only when b_interlaced=0. Setting this flag makes it possible to flag the stream as PAFF interlaced yet
363 * encode all frames progessively. It is useful for encoding 25p and 30p Blu-Ray streams.
366 int b_fake_interlaced;
368 /* Slicing parameters */
369 int i_slice_max_size; /* Max size per slice in bytes; includes estimated NAL overhead. */
370 int i_slice_max_mbs; /* Max number of MBs per slice; overrides i_slice_count. */
371 int i_slice_count; /* Number of slices per frame: forces rectangular slices. */
373 /* Optional callback for freeing this x264_param_t when it is done being used.
374 * Only used when the x264_param_t sits in memory for an indefinite period of time,
375 * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
376 * Not used when x264_encoder_reconfig is called directly. */
377 void (*param_free)( void* );
380 /****************************************************************************
381 * H.264 level restriction information
382 ****************************************************************************/
386 int mbps; /* max macroblock processing rate (macroblocks/sec) */
387 int frame_size; /* max frame size (macroblocks) */
388 int dpb; /* max decoded picture buffer (bytes) */
389 int bitrate; /* max bitrate (kbit/sec) */
390 int cpb; /* max vbv buffer (kbit) */
391 int mv_range; /* max vertical mv component range (pixels) */
392 int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
393 int slice_rate; /* ?? */
394 int mincr; /* min compression ratio */
395 int bipred8x8; /* limit bipred to >=8x8 */
396 int direct8x8; /* limit b_direct to >=8x8 */
397 int frame_only; /* forbid interlacing */
400 /* all of the levels defined in the standard, terminated by .level_idc=0 */
401 extern const x264_level_t x264_levels[];
403 /****************************************************************************
404 * Basic parameter handling functions
405 ****************************************************************************/
407 /* x264_param_default:
408 * fill x264_param_t with default values and do CPU detection */
409 void x264_param_default( x264_param_t * );
412 * set one parameter by name.
413 * returns 0 on success, or returns one of the following errors.
414 * note: BAD_VALUE occurs only if it can't even parse the value,
415 * numerical range is not checked until x264_encoder_open() or
416 * x264_encoder_reconfig().
417 * value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
418 #define X264_PARAM_BAD_NAME (-1)
419 #define X264_PARAM_BAD_VALUE (-2)
420 int x264_param_parse( x264_param_t *, const char *name, const char *value );
422 /****************************************************************************
423 * Advanced parameter handling functions
424 ****************************************************************************/
426 /* These functions expose the full power of x264's preset-tune-profile system for
427 * easy adjustment of large numbers of internal parameters.
429 * In order to replicate x264CLI's option handling, these functions MUST be called
430 * in the following order:
431 * 1) x264_param_default_preset
432 * 2) Custom user options (via param_parse or directly assigned variables)
433 * 3) x264_param_apply_fastfirstpass
434 * 4) x264_param_apply_profile
436 * Additionally, x264CLI does not apply step 3 if the preset chosen is "placebo"
437 * or --slow-firstpass is set. */
439 /* x264_param_default_preset:
440 * The same as x264_param_default, but also use the passed preset and tune
441 * to modify the default settings.
442 * (either can be NULL, which implies no preset or no tune, respectively)
444 * Currently available presets are, ordered from fastest to slowest: */
445 static const char * const x264_preset_names[] = { "ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo", 0 };
447 /* Warning: the speed of these presets scales dramatically. Ultrafast is a full
448 * 100 times faster than placebo!
450 * Currently available tunings are: */
451 static const char * const x264_tune_names[] = { "film", "animation", "grain", "stillimage", "psnr", "ssim", "fastdecode", "zerolatency", 0 };
453 /* Multiple tunings can be used if separated by a delimiter in ",./-+",
454 * however multiple psy tunings cannot be used.
455 * film, animation, grain, stillimage, psnr, and ssim are psy tunings.
457 * returns 0 on success, negative on failure (e.g. invalid preset/tune name). */
458 int x264_param_default_preset( x264_param_t *, const char *preset, const char *tune );
460 /* x264_param_apply_fastfirstpass:
461 * If first-pass mode is set (rc.b_stat_read == 0, rc.b_stat_write == 1),
462 * modify the encoder settings to disable options generally not useful on
464 void x264_param_apply_fastfirstpass( x264_param_t * );
466 /* x264_param_apply_profile:
467 * Applies the restrictions of the given profile.
468 * Currently available profiles are, from most to least restrictive: */
469 static const char * const x264_profile_names[] = { "baseline", "main", "high", 0 };
471 /* (can be NULL, in which case the function will do nothing)
473 * Does NOT guarantee that the given profile will be used: if the restrictions
474 * of "High" are applied to settings that are already Baseline-compatible, the
475 * stream will remain baseline. In short, it does not increase settings, only
478 * returns 0 on success, negative on failure (e.g. invalid profile name). */
479 int x264_param_apply_profile( x264_param_t *, const char *profile );
481 /****************************************************************************
482 * Picture structures and functions
483 ****************************************************************************/
487 PIC_STRUCT_AUTO = 0, // automatically decide (default)
488 PIC_STRUCT_PROGRESSIVE = 1, // progressive frame
489 // "TOP" and "BOTTOM" are not supported in x264 (PAFF only)
490 PIC_STRUCT_TOP_BOTTOM = 4, // top field followed by bottom
491 PIC_STRUCT_BOTTOM_TOP = 5, // bottom field followed by top
492 PIC_STRUCT_TOP_BOTTOM_TOP = 6, // top field, bottom field, top field repeated
493 PIC_STRUCT_BOTTOM_TOP_BOTTOM = 7, // bottom field, top field, bottom field repeated
494 PIC_STRUCT_DOUBLE = 8, // double frame
495 PIC_STRUCT_TRIPLE = 9, // triple frame
500 double cpb_initial_arrival_time;
501 double cpb_final_arrival_time;
502 double cpb_removal_time;
504 double dpb_output_time;
509 int i_csp; /* Colorspace */
510 int i_plane; /* Number of image planes */
511 int i_stride[4]; /* Strides for each plane */
512 uint8_t *plane[4]; /* Pointers to each plane */
517 /* In: an array of quantizer offsets to be applied to this image during encoding.
518 * These are added on top of the decisions made by x264.
519 * Offsets can be fractional; they are added before QPs are rounded to integer.
520 * Adaptive quantization must be enabled to use this feature. Behavior if quant
521 * offsets differ between encoding passes is undefined.
523 * Array contains one offset per macroblock, in raster scan order. In interlaced
524 * mode, top-field MBs and bottom-field MBs are interleaved at the row level. */
525 float *quant_offsets;
526 /* In: optional callback to free quant_offsets when used.
527 * Useful if one wants to use a different quant_offset array for each frame. */
528 void (*quant_offsets_free)( void* );
529 } x264_image_properties_t;
533 /* In: force picture type (if not auto)
534 * If x264 encoding parameters are violated in the forcing of picture types,
535 * x264 will correct the input picture type and log a warning.
536 * The quality of frametype decisions may suffer if a great deal of fine-grained
537 * mixing of auto and forced frametypes is done.
538 * Out: type of the picture encoded */
540 /* In: force quantizer for > 0 */
542 /* In: pic_struct, for pulldown/doubling/etc...used only if b_pic_timing_sei=1.
543 * use pic_struct_e for pic_struct inputs */
545 /* Out: whether this frame is a keyframe. Important when using modes that result in
546 * SEI recovery points being used instead of IDR frames. */
548 /* In: user pts, Out: pts of encoded picture (user)*/
550 /* Out: frame dts. Since the pts of the first frame is always zero,
551 * initial frames may have a negative dts which must be dealt with by any muxer */
553 /* In: custom encoding parameters to be set from this frame forwards
554 (in coded order, not display order). If NULL, continue using
555 parameters from the previous frame. Some parameters, such as
556 aspect ratio, can only be changed per-GOP due to the limitations
557 of H.264 itself; in this case, the caller must force an IDR frame
558 if it needs the changed parameter to apply immediately. */
562 /* In: optional information to modify encoder decisions for this frame */
563 x264_image_properties_t prop;
564 /* Out: HRD timing information. Output only when i_nal_hrd is set. */
565 x264_hrd_t hrd_timing;
566 /* private user data. libx264 doesn't touch this,
567 not even copy it from input to output frames. */
571 /* x264_picture_init:
572 * initialize an x264_picture_t. Needs to be done if the calling application
573 * allocates its own x264_picture_t as opposed to using x264_picture_alloc. */
574 void x264_picture_init( x264_picture_t *pic );
576 /* x264_picture_alloc:
577 * alloc data for a picture. You must call x264_picture_clean on it.
578 * returns 0 on success, or -1 on malloc failure. */
579 int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
581 /* x264_picture_clean:
582 * free associated resource for a x264_picture_t allocated with
583 * x264_picture_alloc ONLY */
584 void x264_picture_clean( x264_picture_t *pic );
586 /****************************************************************************
587 * NAL structure and functions
588 ****************************************************************************/
597 NAL_SLICE_IDR = 5, /* ref_idc != 0 */
598 NAL_SEI = 6, /* ref_idc == 0 */
603 /* ref_idc == 0 for 6,9,10,11,12 */
607 NAL_PRIORITY_DISPOSABLE = 0,
608 NAL_PRIORITY_LOW = 1,
609 NAL_PRIORITY_HIGH = 2,
610 NAL_PRIORITY_HIGHEST = 3,
613 /* The data within the payload is already NAL-encapsulated; the ref_idc and type
614 * are merely in the struct for easy access by the calling application.
615 * All data returned in an x264_nal_t, including the data in p_payload, is no longer
616 * valid after the next call to x264_encoder_encode. Thus it must be used or copied
617 * before calling x264_encoder_encode or x264_encoder_headers again. */
620 int i_ref_idc; /* nal_priority_e */
621 int i_type; /* nal_unit_type_e */
623 /* Size of payload in bytes. */
625 /* If param->b_annexb is set, Annex-B bytestream with 4-byte startcode.
626 * Otherwise, startcode is replaced with a 4-byte size.
627 * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
631 /****************************************************************************
633 ****************************************************************************/
635 /* Force a link error in the case of linking against an incompatible API version.
636 * Glue #defines exist to force correct macro expansion; the final output of the macro
637 * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
638 #define x264_encoder_glue1(x,y) x##y
639 #define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
640 #define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)
642 /* x264_encoder_open:
643 * create a new encoder handler, all parameters from x264_param_t are copied */
644 x264_t *x264_encoder_open( x264_param_t * );
646 /* x264_encoder_reconfig:
647 * various parameters from x264_param_t are copied.
648 * this takes effect immediately, on whichever frame is encoded next;
649 * due to delay, this may not be the next frame passed to encoder_encode.
650 * if the change should apply to some particular frame, use x264_picture_t->param instead.
651 * returns 0 on success, negative on parameter validation error.
652 * not all parameters can be changed; see the actual function for a detailed breakdown. */
653 int x264_encoder_reconfig( x264_t *, x264_param_t * );
654 /* x264_encoder_parameters:
655 * copies the current internal set of parameters to the pointer provided
656 * by the caller. useful when the calling application needs to know
657 * how x264_encoder_open has changed the parameters, or the current state
658 * of the encoder after multiple x264_encoder_reconfig calls.
659 * note that the data accessible through pointers in the returned param struct
660 * (e.g. filenames) should not be modified by the calling application. */
661 void x264_encoder_parameters( x264_t *, x264_param_t * );
662 /* x264_encoder_headers:
663 * return the SPS and PPS that will be used for the whole stream.
664 * *pi_nal is the number of NAL units outputted in pp_nal.
665 * returns negative on error.
666 * the payloads of all output NALs are guaranteed to be sequential in memory. */
667 int x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
668 /* x264_encoder_encode:
669 * encode one picture.
670 * *pi_nal is the number of NAL units outputted in pp_nal.
671 * returns negative on error, zero if no NAL units returned.
672 * the payloads of all output NALs are guaranteed to be sequential in memory. */
673 int x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
674 /* x264_encoder_close:
675 * close an encoder handler */
676 void x264_encoder_close ( x264_t * );
677 /* x264_encoder_delayed_frames:
678 * return the number of currently delayed (buffered) frames
679 * this should be used at the end of the stream, to know when you have all the encoded frames. */
680 int x264_encoder_delayed_frames( x264_t * );
681 /* x264_encoder_intra_refresh:
682 * If an intra refresh is not in progress, begin one with the next P-frame.
683 * If an intra refresh is in progress, begin one as soon as the current one finishes.
684 * Requires that b_intra_refresh be set.
685 * Useful for interactive streaming where the client can tell the server that packet loss has
686 * occurred. In this case, keyint can be set to an extremely high value so that intra refreshes
687 * only occur when calling x264_encoder_intra_refresh. */
688 void x264_encoder_intra_refresh( x264_t * );