K-means weightp
[x264-7mod.git] / x264.h
blob6223cb73f0913862bfdbecbeae5f0931186393df
1 /*****************************************************************************
2 * x264.h: x264 public header
3 *****************************************************************************
4 * Copyright (C) 2003-2017 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 *****************************************************************************/
28 #ifndef X264_X264_H
29 #define X264_X264_H
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
35 #if !defined(_STDINT_H) && !defined(_STDINT_H_) && !defined(_STDINT_H_INCLUDED) && !defined(_STDINT) &&\
36 !defined(_SYS_STDINT_H_) && !defined(_INTTYPES_H) && !defined(_INTTYPES_H_) && !defined(_INTTYPES)
37 # ifdef _MSC_VER
38 # pragma message("You must include stdint.h or inttypes.h before x264.h")
39 # else
40 # warning You must include stdint.h or inttypes.h before x264.h
41 # endif
42 #endif
44 #include <stdarg.h>
46 #include "x264_config.h"
48 #define X264_BUILD 152
50 /* Application developers planning to link against a shared library version of
51 * libx264 from a Microsoft Visual Studio or similar development environment
52 * will need to define X264_API_IMPORTS before including this header.
53 * This clause does not apply to MinGW, similar development environments, or non
54 * Windows platforms. */
55 #ifdef X264_API_IMPORTS
56 #define X264_API __declspec(dllimport)
57 #else
58 #define X264_API
59 #endif
61 /* x264_t:
62 * opaque handler for encoder */
63 typedef struct x264_t x264_t;
65 /****************************************************************************
66 * NAL structure and functions
67 ****************************************************************************/
69 enum nal_unit_type_e
71 NAL_UNKNOWN = 0,
72 NAL_SLICE = 1,
73 NAL_SLICE_DPA = 2,
74 NAL_SLICE_DPB = 3,
75 NAL_SLICE_DPC = 4,
76 NAL_SLICE_IDR = 5, /* ref_idc != 0 */
77 NAL_SEI = 6, /* ref_idc == 0 */
78 NAL_SPS = 7,
79 NAL_PPS = 8,
80 NAL_AUD = 9,
81 NAL_FILLER = 12,
82 /* ref_idc == 0 for 6,9,10,11,12 */
84 enum nal_priority_e
86 NAL_PRIORITY_DISPOSABLE = 0,
87 NAL_PRIORITY_LOW = 1,
88 NAL_PRIORITY_HIGH = 2,
89 NAL_PRIORITY_HIGHEST = 3,
92 /* The data within the payload is already NAL-encapsulated; the ref_idc and type
93 * are merely in the struct for easy access by the calling application.
94 * All data returned in an x264_nal_t, including the data in p_payload, is no longer
95 * valid after the next call to x264_encoder_encode. Thus it must be used or copied
96 * before calling x264_encoder_encode or x264_encoder_headers again. */
97 typedef struct x264_nal_t
99 int i_ref_idc; /* nal_priority_e */
100 int i_type; /* nal_unit_type_e */
101 int b_long_startcode;
102 int i_first_mb; /* If this NAL is a slice, the index of the first MB in the slice. */
103 int i_last_mb; /* If this NAL is a slice, the index of the last MB in the slice. */
105 /* Size of payload (including any padding) in bytes. */
106 int i_payload;
107 /* If param->b_annexb is set, Annex-B bytestream with startcode.
108 * Otherwise, startcode is replaced with a 4-byte size.
109 * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
110 uint8_t *p_payload;
112 /* Size of padding in bytes. */
113 int i_padding;
114 } x264_nal_t;
116 /****************************************************************************
117 * Encoder parameters
118 ****************************************************************************/
119 /* CPU flags */
121 /* x86 */
122 #define X264_CPU_MMX (1<<0)
123 #define X264_CPU_MMX2 (1<<1) /* MMX2 aka MMXEXT aka ISSE */
124 #define X264_CPU_MMXEXT X264_CPU_MMX2
125 #define X264_CPU_SSE (1<<2)
126 #define X264_CPU_SSE2 (1<<3)
127 #define X264_CPU_LZCNT (1<<4)
128 #define X264_CPU_SSE3 (1<<5)
129 #define X264_CPU_SSSE3 (1<<6)
130 #define X264_CPU_SSE4 (1<<7) /* SSE4.1 */
131 #define X264_CPU_SSE42 (1<<8) /* SSE4.2 */
132 #define X264_CPU_AVX (1<<9) /* Requires OS support even if YMM registers aren't used */
133 #define X264_CPU_XOP (1<<10) /* AMD XOP */
134 #define X264_CPU_FMA4 (1<<11) /* AMD FMA4 */
135 #define X264_CPU_FMA3 (1<<12)
136 #define X264_CPU_BMI1 (1<<13)
137 #define X264_CPU_BMI2 (1<<14)
138 #define X264_CPU_AVX2 (1<<15)
139 #define X264_CPU_AVX512 (1<<16) /* AVX-512 {F, CD, BW, DQ, VL}, requires OS support */
140 /* x86 modifiers */
141 #define X264_CPU_CACHELINE_32 (1<<17) /* avoid memory loads that span the border between two cachelines */
142 #define X264_CPU_CACHELINE_64 (1<<18) /* 32/64 is the size of a cacheline in bytes */
143 #define X264_CPU_SSE2_IS_SLOW (1<<19) /* avoid most SSE2 functions on Athlon64 */
144 #define X264_CPU_SSE2_IS_FAST (1<<20) /* a few functions are only faster on Core2 and Phenom */
145 #define X264_CPU_SLOW_SHUFFLE (1<<21) /* The Conroe has a slow shuffle unit (relative to overall SSE performance) */
146 #define X264_CPU_STACK_MOD4 (1<<22) /* if stack is only mod4 and not mod16 */
147 #define X264_CPU_SLOW_ATOM (1<<23) /* The Atom is terrible: slow SSE unaligned loads, slow
148 * SIMD multiplies, slow SIMD variable shifts, slow pshufb,
149 * cacheline split penalties -- gather everything here that
150 * isn't shared by other CPUs to avoid making half a dozen
151 * new SLOW flags. */
152 #define X264_CPU_SLOW_PSHUFB (1<<24) /* such as on the Intel Atom */
153 #define X264_CPU_SLOW_PALIGNR (1<<25) /* such as on the AMD Bobcat */
155 /* PowerPC */
156 #define X264_CPU_ALTIVEC 0x0000001
158 /* ARM and AArch64 */
159 #define X264_CPU_ARMV6 0x0000001
160 #define X264_CPU_NEON 0x0000002 /* ARM NEON */
161 #define X264_CPU_FAST_NEON_MRC 0x0000004 /* Transfer from NEON to ARM register is fast (Cortex-A9) */
162 #define X264_CPU_ARMV8 0x0000008
164 /* MIPS */
165 #define X264_CPU_MSA 0x0000001 /* MIPS MSA */
167 /* Analyse flags */
168 #define X264_ANALYSE_I4x4 0x0001 /* Analyse i4x4 */
169 #define X264_ANALYSE_I8x8 0x0002 /* Analyse i8x8 (requires 8x8 transform) */
170 #define X264_ANALYSE_PSUB16x16 0x0010 /* Analyse p16x8, p8x16 and p8x8 */
171 #define X264_ANALYSE_PSUB8x8 0x0020 /* Analyse p8x4, p4x8, p4x4 */
172 #define X264_ANALYSE_BSUB16x16 0x0100 /* Analyse b16x8, b8x16 and b8x8 */
173 #define X264_DIRECT_PRED_NONE 0
174 #define X264_DIRECT_PRED_SPATIAL 1
175 #define X264_DIRECT_PRED_TEMPORAL 2
176 #define X264_DIRECT_PRED_AUTO 3
177 #define X264_ME_DIA 0
178 #define X264_ME_HEX 1
179 #define X264_ME_UMH 2
180 #define X264_ME_ESA 3
181 #define X264_ME_TESA 4
182 #define X264_CQM_FLAT 0
183 #define X264_CQM_JVT 1
184 #define X264_CQM_CUSTOM 2
185 #define X264_RC_CQP 0
186 #define X264_RC_CRF 1
187 #define X264_RC_ABR 2
188 #define X264_QP_AUTO 0
189 #define X264_AQ_NONE 0
190 #define X264_AQ_MIX 1
191 #define X264_AQ_AUTOMIX 2
192 #define X264_AQ_AUTOMIX_BIASED 3
193 #define X264_AQ_AUTOMIX_MOD 4
194 #define X264_AQ_ORE 1
195 #define X264_AQ_MIXORE 2
196 #define X264_B_ADAPT_NONE 0
197 #define X264_B_ADAPT_FAST 1
198 #define X264_B_ADAPT_TRELLIS 2
199 #define X264_WEIGHTP_NONE 0
200 #define X264_WEIGHTP_SIMPLE 1
201 #define X264_WEIGHTP_SMART 2
202 #define X264_WEIGHTP_KMEAN 3
203 #define X264_B_PYRAMID_NONE 0
204 #define X264_B_PYRAMID_STRICT 1
205 #define X264_B_PYRAMID_NORMAL 2
206 #define X264_KEYINT_MIN_AUTO 0
207 #define X264_KEYINT_MAX_INFINITE (1<<30)
208 #define X264_KEYINT_MAX_AUTO (-1)
209 #define X264_LEVEL_IDC_AUTO (-1)
211 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
212 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
213 static const char * const x264_b_pyramid_names[] = { "none", "strict", "normal", 0 };
214 static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
215 static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
216 static const char * const x264_fullrange_names[] = { "off", "on", 0 };
217 static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", "bt2020", "smpte428",
218 "smpte431", "smpte432", 0 };
219 static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316",
220 "iec61966-2-4", "bt1361e", "iec61966-2-1", "bt2020-10", "bt2020-12", "smpte2084", "smpte428", 0 };
221 static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", "bt2020nc", "bt2020c",
222 "smpte2085", 0 };
223 static const char * const x264_nal_hrd_names[] = { "none", "vbr", "cbr", 0 };
224 static const char * const x264_log_level_names[] = { "none", "error", "warning", "info", "debug", 0 };
226 /* Colorspace type */
227 #define X264_CSP_MASK 0x00ff /* */
228 #define X264_CSP_NONE 0x0000 /* Invalid mode */
229 #define X264_CSP_I420 0x0001 /* yuv 4:2:0 planar */
230 #define X264_CSP_YV12 0x0002 /* yvu 4:2:0 planar */
231 #define X264_CSP_NV12 0x0003 /* yuv 4:2:0, with one y plane and one packed u+v */
232 #define X264_CSP_NV21 0x0004 /* yuv 4:2:0, with one y plane and one packed v+u */
233 #define X264_CSP_I422 0x0005 /* yuv 4:2:2 planar */
234 #define X264_CSP_YV16 0x0006 /* yvu 4:2:2 planar */
235 #define X264_CSP_NV16 0x0007 /* yuv 4:2:2, with one y plane and one packed u+v */
236 #define X264_CSP_YUYV 0x0008 /* yuyv 4:2:2 packed */
237 #define X264_CSP_UYVY 0x0009 /* uyvy 4:2:2 packed */
238 #define X264_CSP_V210 0x000a /* 10-bit yuv 4:2:2 packed in 32 */
239 #define X264_CSP_I444 0x000b /* yuv 4:4:4 planar */
240 #define X264_CSP_YV24 0x000c /* yvu 4:4:4 planar */
241 #define X264_CSP_BGR 0x000d /* packed bgr 24bits */
242 #define X264_CSP_BGRA 0x000e /* packed bgr 32bits */
243 #define X264_CSP_RGB 0x000f /* packed rgb 24bits */
244 #define X264_CSP_MAX 0x0010 /* end of list */
245 #define X264_CSP_VFLIP 0x1000 /* the csp is vertically flipped */
246 #define X264_CSP_HIGH_DEPTH 0x2000 /* the csp has a depth of 16 bits per pixel component */
247 #define X264_CSP_SKIP_DEPTH_FILTER 0x0100 /* HACK: totally skips depth filter to prevent dither error */
249 /* Slice type */
250 #define X264_TYPE_AUTO 0x0000 /* Let x264 choose the right type */
251 #define X264_TYPE_IDR 0x0001
252 #define X264_TYPE_I 0x0002
253 #define X264_TYPE_P 0x0003
254 #define X264_TYPE_BREF 0x0004 /* Non-disposable B-frame */
255 #define X264_TYPE_B 0x0005
256 #define X264_TYPE_KEYFRAME 0x0006 /* IDR or I depending on b_open_gop option */
257 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR || (x)==X264_TYPE_KEYFRAME)
258 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
260 /* Log level */
261 #define X264_LOG_NONE (-1)
262 #define X264_LOG_ERROR 0
263 #define X264_LOG_WARNING 1
264 #define X264_LOG_INFO 2
265 #define X264_LOG_DEBUG 3
267 /* Threading */
268 #define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
269 #define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
271 /* HRD */
272 #define X264_NAL_HRD_NONE 0
273 #define X264_NAL_HRD_VBR 1
274 #define X264_NAL_HRD_CBR 2
276 /* SEI level */
277 #define X264_OPTS_NONE 0x0000
278 #define X264_OPTS_INFO 0x0001
279 #define X264_OPTS_SETTING 0x0002
280 #define X264_OPTS_FULL 0x0003
282 #define X264_OPTS_PREINFO 0x0010
283 #define X264_OPTS_POSTINFO 0x0020
284 #define X264_OPTS_PREOPT 0x0040
285 #define X264_OPTS_POSTOPT 0x0080
287 #define X264_OPTS_MAX 4
289 /* Zones: override ratecontrol or other options for specific sections of the video.
290 * See x264_encoder_reconfig() for which options can be changed.
291 * If zones overlap, whichever comes later in the list takes precedence. */
292 typedef struct x264_zone_t
294 int i_start, i_end; /* range of frame numbers */
295 int b_force_qp; /* whether to use qp vs bitrate factor */
296 int i_qp;
297 float f_bitrate_factor;
298 struct x264_param_t *param;
299 } x264_zone_t;
301 /* Auto VBV*/
302 #define X264_VBV_MAXRATE_HIGH444 -5 /* Set the VBV maxrate to fit in the target level of High 4:4:4 Predictive Profile */
303 #define X264_VBV_MAXRATE_HIGH422 -4 /* Set the VBV maxrate to fit in the target level of High 4:2:2 Profile */
304 #define X264_VBV_MAXRATE_HIGH10 -3 /* Set the VBV maxrate to fit in the target level of High 10 Profile */
305 #define X264_VBV_MAXRATE_HIGH -2 /* Set the VBV maxrate to fit in the target level of High Profile */
306 #define X264_VBV_MAXRATE_MAIN -1 /* Set the VBV maxrate to fit in the target level of Main Profile */
307 #define X264_VBV_BUFSIZE_HIGH444 -5 /* Set the VBV bufsize to fit in the target level of High 4:4:4 Predictive Profile */
308 #define X264_VBV_BUFSIZE_HIGH422 -4 /* Set the VBV bufsize to fit in the target level of High 4:2:2 Profile */
309 #define X264_VBV_BUFSIZE_HIGH10 -3 /* Set the VBV bufsize to fit in the target level of High 10 Profile */
310 #define X264_VBV_BUFSIZE_HIGH -2 /* Set the VBV bufsize to fit in the target level of High Profile */
311 #define X264_VBV_BUFSIZE_MAIN -1 /* Set the VBV bufsize to fit in the target level of Main Profile */
313 /* Device capability */
314 #define X264_LEVEL_IDC_DXVA 41
315 #define X264_LEVEL_IDC_BLURAY 41
316 #define X264_LEVEL_IDC_PSP 30 /* Actually the latest firmware supports Level 5.2, thus not restricted */
317 #define X264_LEVEL_IDC_PSV 31 /* Actually the latest firmware supports Level 5.2, thus not restricted */
318 #define X264_LEVEL_IDC_PS3 42
319 #define X264_LEVEL_IDC_XBOX 41
320 #define X264_LEVEL_IDC_IPHONE 41
321 #define X264_LEVEL_IDC_GENERIC 30
322 #define X264_VBV_MAXRATE_BLURAY 40000 /* Vbv restriction is taken from MeGUI */
323 #define X264_VBV_BUFSIZE_BLURAY 30000
324 #define X264_VBV_MAXRATE_PSP 10000
325 #define X264_VBV_BUFSIZE_PSP 10000
326 #define X264_VBV_MAXRATE_PS3 31250
327 #define X264_VBV_BUFSIZE_PS3 31250
328 #define X264_VBV_MAXRATE_XBOX 24000
329 #define X264_VBV_BUFSIZE_XBOX 24000
330 #define X264_VBV_MAXRATE_GENERIC 10000
331 #define X264_VBV_BUFSIZE_GENERIC 10000
333 /* Device mask */
334 #define X264_DEVICE_HIGH_DEPTH 0x0001 /* Device supports high bit depth */
335 #define X264_DEVICE_422 0x0002 /* Device supports 4:2:2 */
336 #define X264_DEVICE_444 0x0004 /* Device supports 4:4:4 */
337 #define X264_DEVICE_LOSSLESS 0x0008 /* Device supports lossless */
338 #define X264_DEVICE_LEVEL_FREE 0x0010 /* Device has no level force */
340 #define X264_DEVICE_DXVA 0x0000
341 #define X264_DEVICE_BLURAY 0x0000
342 #define X264_DEVICE_PSP 0x0000
343 #define X264_DEVICE_PSV 0x0000
344 #define X264_DEVICE_PS3 0x0000
345 #define X264_DEVICE_XBOX 0x0000
346 #define X264_DEVICE_IPHONE 0x0000
347 #define X264_DEVICE_GENERIC 0x0000
349 typedef struct x264_param_t
351 /* CPU flags */
352 unsigned int cpu;
353 int i_threads; /* encode multiple frames in parallel */
354 int i_lookahead_threads; /* multiple threads for lookahead analysis */
355 int b_sliced_threads; /* Whether to use slice-based threading. */
356 int b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
357 int b_cpu_independent; /* force canonical behavior rather than cpu-dependent optimal algorithms */
358 int i_sync_lookahead; /* threaded lookahead buffer */
360 /* Video Properties */
361 int i_width;
362 int i_height;
363 int i_csp; /* CSP of encoded bitstream */
364 int i_level_idc;
365 int b_level_force; /* force ref etc. for level */
366 int i_profile;
367 int b_profile_force; /* do not automatically decrease profile settings even if not needed */
368 int i_frame_total; /* number of frames to encode if known, else 0 */
370 /* NAL HRD
371 * Uses Buffering and Picture Timing SEIs to signal HRD
372 * The HRD in H.264 was not designed with VFR in mind.
373 * It is therefore not recommendeded to use NAL HRD with VFR.
374 * Furthermore, reconfiguring the VBV (via x264_encoder_reconfig)
375 * will currently generate invalid HRD. */
376 int i_nal_hrd;
378 struct
380 /* they will be reduced to be 0 < x <= 65535 and prime */
381 int i_sar_height;
382 int i_sar_width;
384 int i_overscan; /* 0=undef, 1=no overscan, 2=overscan */
386 /* see h264 annex E for the values of the following */
387 int i_vidformat;
388 int b_fullrange;
389 int i_colorprim;
390 int i_transfer;
391 int i_colmatrix;
392 int i_chroma_loc; /* both top & bottom */
393 } vui;
395 /* Bitstream parameters */
396 int i_frame_reference; /* Maximum number of reference frames */
397 int i_dpb_size; /* Force a DPB size larger than that implied by B-frames and reference frames.
398 * Useful in combination with interactive error resilience. */
399 int i_keyint_max; /* Force an IDR keyframe at this interval */
400 int i_keyint_min; /* Scenecuts closer together than this are coded as I, not IDR. */
401 int i_scenecut_threshold; /* how aggressively to insert extra I frames */
402 int b_intra_refresh; /* Whether or not to use periodic intra refresh instead of IDR frames. */
404 int i_bframe; /* how many b-frame between 2 references pictures */
405 int i_bframe_adaptive;
406 int i_bframe_bias;
407 int i_bframe_pyramid; /* Keep some B-frames as references: 0=off, 1=strict hierarchical, 2=normal */
408 int b_open_gop;
409 int b_bluray_compat;
410 int i_avcintra_class;
412 int b_deblocking_filter;
413 int i_deblocking_filter_alphac0; /* [-6, 6] -6 light filter, 6 strong */
414 int i_deblocking_filter_beta; /* [-6, 6] idem */
416 int b_cabac;
417 int i_cabac_init_idc;
419 int b_interlaced;
420 int b_constrained_intra;
422 int i_cqm_preset;
423 char *psz_cqm_file; /* filename (in UTF-8) of CQM file, JM format */
424 uint8_t cqm_4iy[16]; /* used only if i_cqm_preset == X264_CQM_CUSTOM */
425 uint8_t cqm_4py[16];
426 uint8_t cqm_4ic[16];
427 uint8_t cqm_4pc[16];
428 uint8_t cqm_8iy[64];
429 uint8_t cqm_8py[64];
430 uint8_t cqm_8ic[64];
431 uint8_t cqm_8pc[64];
433 /* Log */
434 void (*pf_log)( void *, int i_level, const char *psz, va_list );
435 void *p_log_private;
436 int i_log_level;
437 int i_log_file_level;
438 char *psz_log_file; /* filename (in UTF-8) of log-file */
439 int b_full_recon; /* fully reconstruct frames, even when not necessary for encoding. Implied by psz_dump_yuv */
440 int b_stylish;
441 char *psz_dump_yuv; /* filename (in UTF-8) for reconstructed frames */
443 /* Encoder analyser parameters */
444 struct
446 unsigned int intra; /* intra partitions */
447 unsigned int inter; /* inter partitions */
449 int b_transform_8x8;
450 int i_weighted_pred; /* weighting for P-frames */
451 int b_weighted_bipred; /* implicit weighting for B-frames */
452 int i_direct_mv_pred; /* spatial vs temporal mv prediction */
453 int i_chroma_qp_offset;
455 int i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
456 int i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
457 int i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
458 int i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
459 int i_subpel_refine; /* subpixel motion estimation quality */
460 int b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
461 int b_mixed_references; /* allow each mb partition to have its own reference number */
462 int i_trellis; /* trellis RD quantization */
463 int b_fast_pskip; /* early SKIP detection on P-frames */
464 int b_dct_decimate; /* transform coefficient thresholding on P-frames */
465 int i_noise_reduction; /* adaptive pseudo-deadzone */
466 int i_fgo; /* psy film grain optimization */
467 float f_psy_rd; /* Psy RD strength */
468 float f_psy_trellis; /* Psy trellis strength */
469 int b_psy; /* Toggle all psy optimizations */
471 int b_mb_info; /* Use input mb_info data in x264_picture_t */
472 int b_mb_info_update; /* Update the values in mb_info according to the results of encoding. */
474 /* the deadzone size that will be used in luma quantization */
475 int i_luma_deadzone[2]; /* {inter, intra} */
477 int b_psnr; /* compute and print PSNR stats */
478 int b_ssim; /* compute and print SSIM stats */
479 } analyse;
481 /* Rate control parameters */
482 struct
484 int i_rc_method; /* X264_RC_* */
486 int i_qp_constant; /* 0 to (51 + 6*(x264_bit_depth-8)). 0=lossless */
487 int i_qp_min[3]; /* min allowed QP value of I:P:B slices */
488 int i_qp_max[3]; /* max allowed QP value of I:P:B slices */
489 int i_qp_min_min; /* min allowed QP value */
490 int i_qp_max_max; /* max allowed QP value */
491 int i_qp_step; /* max QP step between frames */
493 int i_bitrate;
494 float f_rf_constant; /* 1pass VBR, nominal QP */
495 float f_rf_constant_max; /* In CRF mode, maximum CRF as caused by VBV */
496 float f_rate_tolerance;
497 int i_vbv_max_bitrate;
498 int i_vbv_buffer_size;
499 float f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
500 float f_ip_factor;
501 float f_pb_factor;
503 /* VBV filler: force CBR VBV and use filler bytes to ensure hard-CBR.
504 * Implied by NAL-HRD CBR. */
505 int b_filler;
507 int i_aq_mode; /* psy adaptive QP. (X264_AQ_*) */
508 float f_aq_strength;
509 float f_aq_sensitivity;
510 float f_aq_ifactor;
511 float f_aq_pfactor;
512 float f_aq_bfactor;
513 int b_aq2; /* psy 2nd adaptive QP */
514 float f_aq2_strength;
515 float f_aq2_sensitivity;
516 float f_aq2_ifactor;
517 float f_aq2_pfactor;
518 float f_aq2_bfactor;
519 int i_aq3_mode; /* psy 3rd adaptive QP */
520 float f_aq3_strength;
521 float f_aq3_strengths[2][4]; /* Up{ Bright, Middle, Dark, M.Dark }, Down{ Bright, Middle, Dark, Other stuff } */
522 float f_aq3_sensitivity;
523 float f_aq3_ifactor[2]; /* { Up, Down } */
524 float f_aq3_pfactor[2]; /* { Up, Down } */
525 float f_aq3_bfactor[2]; /* { Up, Down } */
526 int b_aq3_boundary;
527 int i_aq3_boundary[3];
528 float f_fade_compensate; /* Give more bits to fades. */
529 int b_mb_tree; /* Macroblock-tree ratecontrol. */
530 int i_lookahead;
532 /* 2pass */
533 int b_stat_write; /* Enable stat writing in psz_stat_out */
534 char *psz_stat_out; /* output filename (in UTF-8) of the 2pass stats file */
535 int b_stat_read; /* Read stat from psz_stat_in and use it */
536 char *psz_stat_in; /* input filename (in UTF-8) of the 2pass stats file */
538 /* 2pass params (same as ffmpeg ones) */
539 float f_qcompress; /* 0.0 => cbr, 1.0 => constant qp */
540 float f_qblur; /* temporally blur quants */
541 float f_complexity_blur; /* temporally blur complexity */
542 x264_zone_t *zones; /* ratecontrol overrides */
543 int i_zones; /* number of zone_t's */
544 char *psz_zones; /* alternate method of specifying zones */
545 } rc;
547 /* Cropping Rectangle parameters: added to those implicitly defined by
548 non-mod16 video resolutions. */
549 struct
551 unsigned int i_left;
552 unsigned int i_top;
553 unsigned int i_right;
554 unsigned int i_bottom;
555 } crop_rect;
557 /* frame packing arrangement flag */
558 int i_frame_packing;
560 /* Muxing parameters */
561 int b_aud; /* generate access unit delimiters */
562 int b_repeat_headers; /* put SPS/PPS before each keyframe */
563 int b_annexb; /* if set, place start codes (4 bytes) before NAL units,
564 * otherwise place size (4 bytes) before NAL units. */
565 int i_sps_id; /* SPS and PPS id number */
566 int b_vfr_input; /* VFR input. If 1, use timebase and timestamps for ratecontrol purposes.
567 * If 0, use fps only. */
568 int b_pulldown; /* use explicity set timebase for CFR */
569 uint32_t i_fps_num;
570 uint32_t i_fps_den;
571 int b_accurate_fps;
572 uint32_t i_timebase_num; /* Timebase numerator */
573 uint32_t i_timebase_den; /* Timebase denominator */
574 int i_opts_write;
575 char *psz_opts[X264_OPTS_MAX];
577 int b_tff;
579 /* Pulldown:
580 * The correct pic_struct must be passed with each input frame.
581 * The input timebase should be the timebase corresponding to the output framerate. This should be constant.
582 * e.g. for 3:2 pulldown timebase should be 1001/30000
583 * The PTS passed with each frame must be the PTS of the frame after pulldown is applied.
584 * Frame doubling and tripling require b_vfr_input set to zero (see H.264 Table D-1)
586 * Pulldown changes are not clearly defined in H.264. Therefore, it is the calling app's responsibility to manage this.
589 int b_pic_struct;
591 /* Fake Interlaced.
593 * Used only when b_interlaced=0. Setting this flag makes it possible to flag the stream as PAFF interlaced yet
594 * encode all frames progessively. It is useful for encoding 25p and 30p Blu-Ray streams.
597 int b_fake_interlaced;
599 /* Don't optimize header parameters based on video content, e.g. ensure that splitting an input video, compressing
600 * each part, and stitching them back together will result in identical SPS/PPS. This is necessary for stitching
601 * with container formats that don't allow multiple SPS/PPS. */
602 int b_stitchable;
604 int b_opencl; /* use OpenCL when available */
605 int i_opencl_device; /* specify count of GPU devices to skip, for CLI users */
606 void *opencl_device_id; /* pass explicit cl_device_id as void*, for API users */
607 char *psz_clbin_file; /* filename (in UTF-8) of the compiled OpenCL kernel cache file */
609 /* Slicing parameters */
610 int i_slice_max_size; /* Max size per slice in bytes; includes estimated NAL overhead. */
611 int i_slice_max_mbs; /* Max number of MBs per slice; overrides i_slice_count. */
612 int i_slice_min_mbs; /* Min number of MBs per slice */
613 int i_slice_count; /* Number of slices per frame: forces rectangular slices. */
614 int i_slice_count_max; /* Absolute cap on slices per frame; stops applying slice-max-size
615 * and slice-max-mbs if this is reached. */
616 /* Filters */
617 struct
619 int b_sub; /* Load subtitles or not */
620 } filters;
623 /* Optional callback for freeing this x264_param_t when it is done being used.
624 * Only used when the x264_param_t sits in memory for an indefinite period of time,
625 * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
626 * Not used when x264_encoder_reconfig is called directly. */
627 void (*param_free)( void* );
629 /* Optional low-level callback for low-latency encoding. Called for each output NAL unit
630 * immediately after the NAL unit is finished encoding. This allows the calling application
631 * to begin processing video data (e.g. by sending packets over a network) before the frame
632 * is done encoding.
634 * This callback MUST do the following in order to work correctly:
635 * 1) Have available an output buffer of at least size nal->i_payload*3/2 + 5 + 64.
636 * 2) Call x264_nal_encode( h, dst, nal ), where dst is the output buffer.
637 * After these steps, the content of nal is valid and can be used in the same way as if
638 * the NAL unit were output by x264_encoder_encode.
640 * This does not need to be synchronous with the encoding process: the data pointed to
641 * by nal (both before and after x264_nal_encode) will remain valid until the next
642 * x264_encoder_encode call. The callback must be re-entrant.
644 * This callback does not work with frame-based threads; threads must be disabled
645 * or sliced-threads enabled. This callback also does not work as one would expect
646 * with HRD -- since the buffering period SEI cannot be calculated until the frame
647 * is finished encoding, it will not be sent via this callback.
649 * Note also that the NALs are not necessarily returned in order when sliced threads is
650 * enabled. Accordingly, the variable i_first_mb and i_last_mb are available in
651 * x264_nal_t to help the calling application reorder the slices if necessary.
653 * When this callback is enabled, x264_encoder_encode does not return valid NALs;
654 * the calling application is expected to acquire all output NALs through the callback.
656 * It is generally sensible to combine this callback with a use of slice-max-mbs or
657 * slice-max-size.
659 * The opaque pointer is the opaque pointer from the input frame associated with this
660 * NAL unit. This helps distinguish between nalu_process calls from different sources,
661 * e.g. if doing multiple encodes in one process.
663 void (*nalu_process)( x264_t *h, x264_nal_t *nal, void *opaque );
664 } x264_param_t;
666 void x264_nal_encode( x264_t *h, uint8_t *dst, x264_nal_t *nal );
668 /****************************************************************************
669 * H.264 level restriction information
670 ****************************************************************************/
672 typedef struct x264_level_t
674 uint8_t level_idc;
675 uint32_t mbps; /* max macroblock processing rate (macroblocks/sec) */
676 uint32_t frame_size; /* max frame size (macroblocks) */
677 uint32_t dpb; /* max decoded picture buffer (mbs) */
678 uint32_t bitrate; /* max bitrate (kbit/sec) */
679 uint32_t cpb; /* max vbv buffer (kbit) */
680 uint16_t mv_range; /* max vertical mv component range (pixels) */
681 uint8_t mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
682 uint8_t slice_rate; /* ?? */
683 uint8_t mincr; /* min compression ratio */
684 uint8_t bipred8x8; /* limit bipred to >=8x8 */
685 uint8_t direct8x8; /* limit b_direct to >=8x8 */
686 uint8_t frame_only; /* forbid interlacing */
687 } x264_level_t;
689 /* all of the levels defined in the standard, terminated by .level_idc=0 */
690 X264_API extern const x264_level_t x264_levels[];
692 /****************************************************************************
693 * Basic parameter handling functions
694 ****************************************************************************/
696 /* x264_param_default:
697 * fill x264_param_t with default values and do CPU detection */
698 void x264_param_default( x264_param_t * );
700 /* x264_param_parse:
701 * set one parameter by name.
702 * returns 0 on success, or returns one of the following errors.
703 * note: BAD_VALUE occurs only if it can't even parse the value,
704 * numerical range is not checked until x264_encoder_open() or
705 * x264_encoder_reconfig().
706 * value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
707 #define X264_PARAM_BAD_NAME (-1)
708 #define X264_PARAM_BAD_VALUE (-2)
709 int x264_param_parse( x264_param_t *, const char *name, const char *value );
711 /****************************************************************************
712 * Advanced parameter handling functions
713 ****************************************************************************/
715 /* These functions expose the full power of x264's preset-tune-profile system for
716 * easy adjustment of large numbers of internal parameters.
718 * In order to replicate x264CLI's option handling, these functions MUST be called
719 * in the following order:
720 * 1) x264_param_default_preset
721 * 2) Custom user options (via param_parse or directly assigned variables)
722 * 3) x264_param_apply_fastfirstpass
723 * 4) x264_param_apply_profile
725 * Additionally, x264CLI does not apply step 3 if the preset chosen is "placebo"
726 * or --slow-firstpass is set. */
728 /* x264_param_default_preset:
729 * The same as x264_param_default, but also use the passed preset and tune
730 * to modify the default settings.
731 * (either can be NULL, which implies no preset or no tune, respectively)
733 * Currently available presets are, ordered from fastest to slowest: */
734 static const char * const x264_preset_names[] = { "ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo", 0 };
736 /* The presets can also be indexed numerically, as in:
737 * x264_param_default_preset( &param, "3", ... )
738 * with ultrafast mapping to "0" and placebo mapping to "9". This mapping may
739 * of course change if new presets are added in between, but will always be
740 * ordered from fastest to slowest.
742 * Warning: the speed of these presets scales dramatically. Ultrafast is a full
743 * 100 times faster than placebo!
745 * Currently available tunings are: */
746 static const char * const x264_tune_names[] = { "film", "animation", "grain", "stillimage", "psnr", "ssim", "fastdecode", "zerolatency", 0 };
748 /* Multiple tunings can be used if separated by a delimiter in ",./-+",
749 * however multiple psy tunings cannot be used.
750 * film, animation, grain, stillimage, psnr, and ssim are psy tunings.
752 * returns 0 on success, negative on failure (e.g. invalid preset/tune name). */
753 int x264_param_default_preset( x264_param_t *, const char *preset, const char *tune );
755 /* x264_param_apply_fastfirstpass:
756 * If first-pass mode is set (rc.b_stat_read == 0, rc.b_stat_write == 1),
757 * modify the encoder settings to disable options generally not useful on
758 * the first pass. */
759 void x264_param_apply_fastfirstpass( x264_param_t * );
761 /* x264_param_apply_profile:
762 * Applies the restrictions of the given profile.
763 * Currently available profiles are, from most to least restrictive: */
764 static const char * const x264_profile_names[] = { "baseline", "main", "high", "high10", "high422", "high444", 0 };
766 /* (can be NULL, in which case the function will do nothing)
768 * Does NOT guarantee that the given profile will be used: if the restrictions
769 * of "High" are applied to settings that are already Baseline-compatible, the
770 * stream will remain baseline. In short, it does not increase settings, only
771 * decrease them.
773 * returns 0 on success, negative on failure (e.g. invalid profile name). */
774 int x264_param_apply_profile( x264_param_t *, const char *profile, const char *device );
776 /****************************************************************************
777 * Picture structures and functions
778 ****************************************************************************/
780 /* x264_bit_depth:
781 * Specifies the number of bits per pixel that x264 uses. This is also the
782 * bit depth that x264 encodes in. If this value is > 8, x264 will read
783 * two bytes of input data for each pixel sample, and expect the upper
784 * (16-x264_bit_depth) bits to be zero.
785 * Note: The flag X264_CSP_HIGH_DEPTH must be used to specify the
786 * colorspace depth as well. */
787 X264_API extern const int x264_bit_depth;
789 /* x264_chroma_format:
790 * Specifies the chroma formats that x264 supports encoding. When this
791 * value is non-zero, then it represents a X264_CSP_* that is the only
792 * chroma format that x264 supports encoding. If the value is 0 then
793 * there are no restrictions. */
794 X264_API extern const int x264_chroma_format;
796 enum pic_struct_e
798 PIC_STRUCT_AUTO = 0, // automatically decide (default)
799 PIC_STRUCT_PROGRESSIVE = 1, // progressive frame
800 // "TOP" and "BOTTOM" are not supported in x264 (PAFF only)
801 PIC_STRUCT_TOP_BOTTOM = 4, // top field followed by bottom
802 PIC_STRUCT_BOTTOM_TOP = 5, // bottom field followed by top
803 PIC_STRUCT_TOP_BOTTOM_TOP = 6, // top field, bottom field, top field repeated
804 PIC_STRUCT_BOTTOM_TOP_BOTTOM = 7, // bottom field, top field, bottom field repeated
805 PIC_STRUCT_DOUBLE = 8, // double frame
806 PIC_STRUCT_TRIPLE = 9, // triple frame
809 typedef struct x264_hrd_t
811 double cpb_initial_arrival_time;
812 double cpb_final_arrival_time;
813 double cpb_removal_time;
815 double dpb_output_time;
816 } x264_hrd_t;
818 /* Arbitrary user SEI:
819 * Payload size is in bytes and the payload pointer must be valid.
820 * Payload types and syntax can be found in Annex D of the H.264 Specification.
821 * SEI payload alignment bits as described in Annex D must be included at the
822 * end of the payload if needed.
823 * The payload should not be NAL-encapsulated.
824 * Payloads are written first in order of input, apart from in the case when HRD
825 * is enabled where payloads are written after the Buffering Period SEI. */
827 typedef struct x264_sei_payload_t
829 int payload_size;
830 int payload_type;
831 uint8_t *payload;
832 } x264_sei_payload_t;
834 typedef struct x264_sei_t
836 int num_payloads;
837 x264_sei_payload_t *payloads;
838 /* In: optional callback to free each payload AND x264_sei_payload_t when used. */
839 void (*sei_free)( void* );
840 } x264_sei_t;
842 typedef struct x264_image_t
844 int i_csp; /* Colorspace */
845 int i_plane; /* Number of image planes */
846 int i_stride[4]; /* Strides for each plane */
847 uint8_t *plane[4]; /* Pointers to each plane */
848 } x264_image_t;
850 typedef struct x264_image_properties_t
852 /* All arrays of data here are ordered as follows:
853 * each array contains one offset per macroblock, in raster scan order. In interlaced
854 * mode, top-field MBs and bottom-field MBs are interleaved at the row level.
855 * Macroblocks are 16x16 blocks of pixels (with respect to the luma plane). For the
856 * purposes of calculating the number of macroblocks, width and height are rounded up to
857 * the nearest 16. If in interlaced mode, height is rounded up to the nearest 32 instead. */
859 /* In: an array of quantizer offsets to be applied to this image during encoding.
860 * These are added on top of the decisions made by x264.
861 * Offsets can be fractional; they are added before QPs are rounded to integer.
862 * Adaptive quantization must be enabled to use this feature. Behavior if quant
863 * offsets differ between encoding passes is undefined. */
864 float *quant_offsets;
865 /* In: optional callback to free quant_offsets when used.
866 * Useful if one wants to use a different quant_offset array for each frame. */
867 void (*quant_offsets_free)( void* );
869 /* In: optional array of flags for each macroblock.
870 * Allows specifying additional information for the encoder such as which macroblocks
871 * remain unchanged. Usable flags are listed below.
872 * x264_param_t.analyse.b_mb_info must be set to use this, since x264 needs to track
873 * extra data internally to make full use of this information.
875 * Out: if b_mb_info_update is set, x264 will update this array as a result of encoding.
877 * For "MBINFO_CONSTANT", it will remove this flag on any macroblock whose decoded
878 * pixels have changed. This can be useful for e.g. noting which areas of the
879 * frame need to actually be blitted. Note: this intentionally ignores the effects
880 * of deblocking for the current frame, which should be fine unless one needs exact
881 * pixel-perfect accuracy.
883 * Results for MBINFO_CONSTANT are currently only set for P-frames, and are not
884 * guaranteed to enumerate all blocks which haven't changed. (There may be false
885 * negatives, but no false positives.)
887 uint8_t *mb_info;
888 /* In: optional callback to free mb_info when used. */
889 void (*mb_info_free)( void* );
891 /* The macroblock is constant and remains unchanged from the previous frame. */
892 #define X264_MBINFO_CONSTANT (1<<0)
893 /* More flags may be added in the future. */
895 /* Out: SSIM of the the frame luma (if x264_param_t.b_ssim is set) */
896 double f_ssim;
897 /* Out: Average PSNR of the frame (if x264_param_t.b_psnr is set) */
898 double f_psnr_avg;
899 /* Out: PSNR of Y, U, and V (if x264_param_t.b_psnr is set) */
900 double f_psnr[3];
902 /* Out: Average effective CRF of the encoded frame */
903 double f_crf_avg;
904 } x264_image_properties_t;
906 typedef struct x264_picture_t
908 /* In: force picture type (if not auto)
909 * If x264 encoding parameters are violated in the forcing of picture types,
910 * x264 will correct the input picture type and log a warning.
911 * Out: type of the picture encoded */
912 int i_type;
913 /* In: force quantizer for != X264_QP_AUTO */
914 int i_qpplus1;
915 /* In: pic_struct, for pulldown/doubling/etc...used only if b_pic_struct=1.
916 * use pic_struct_e for pic_struct inputs
917 * Out: pic_struct element associated with frame */
918 int i_pic_struct;
919 /* Out: whether this frame is a keyframe. Important when using modes that result in
920 * SEI recovery points being used instead of IDR frames. */
921 int b_keyframe;
922 /* Out: identifier for pictures. The recovery point is specified as frame_num increment of
923 * the recovery point from the frame having the SEI. */
924 int i_frame_num;
925 /* In: user pts, Out: pts of encoded picture (user)*/
926 int64_t i_pts;
927 /* Out: frame dts. When the pts of the first frame is close to zero,
928 * initial frames may have a negative dts which must be dealt with by any muxer */
929 int64_t i_dts;
930 /* In: custom encoding parameters to be set from this frame forwards
931 (in coded order, not display order). If NULL, continue using
932 parameters from the previous frame. Some parameters, such as
933 aspect ratio, can only be changed per-GOP due to the limitations
934 of H.264 itself; in this case, the caller must force an IDR frame
935 if it needs the changed parameter to apply immediately. */
936 x264_param_t *param;
937 /* In: raw image data */
938 /* Out: reconstructed image data. x264 may skip part of the reconstruction process,
939 e.g. deblocking, in frames where it isn't necessary. To force complete
940 reconstruction, at a small speed cost, set b_full_recon. */
941 x264_image_t img;
942 /* In: optional information to modify encoder decisions for this frame
943 * Out: information about the encoded frame */
944 x264_image_properties_t prop;
945 /* Out: HRD timing information. Output only when i_nal_hrd is set. */
946 x264_hrd_t hrd_timing;
947 /* In: arbitrary user SEI (e.g subtitles, AFDs) */
948 x264_sei_t extra_sei;
949 /* private user data. copied from input to output frames. */
950 void *opaque;
951 } x264_picture_t;
953 /* x264_picture_init:
954 * initialize an x264_picture_t. Needs to be done if the calling application
955 * allocates its own x264_picture_t as opposed to using x264_picture_alloc. */
956 void x264_picture_init( x264_picture_t *pic );
958 /* x264_picture_alloc:
959 * alloc data for a picture. You must call x264_picture_clean on it.
960 * returns 0 on success, or -1 on malloc failure or invalid colorspace. */
961 int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
963 /* x264_picture_clean:
964 * free associated resource for a x264_picture_t allocated with
965 * x264_picture_alloc ONLY */
966 void x264_picture_clean( x264_picture_t *pic );
968 /****************************************************************************
969 * Encoder functions
970 ****************************************************************************/
972 /* Force a link error in the case of linking against an incompatible API version.
973 * Glue #defines exist to force correct macro expansion; the final output of the macro
974 * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
975 #define x264_encoder_glue1(x,y) x##y
976 #define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
977 #define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)
979 /* x264_encoder_open:
980 * create a new encoder handler, all parameters from x264_param_t are copied */
981 x264_t *x264_encoder_open( x264_param_t * );
983 /* x264_encoder_reconfig:
984 * various parameters from x264_param_t are copied.
985 * this takes effect immediately, on whichever frame is encoded next;
986 * due to delay, this may not be the next frame passed to encoder_encode.
987 * if the change should apply to some particular frame, use x264_picture_t->param instead.
988 * returns 0 on success, negative on parameter validation error.
989 * not all parameters can be changed; see the actual function for a detailed breakdown.
991 * since not all parameters can be changed, moving from preset to preset may not always
992 * fully copy all relevant parameters, but should still work usably in practice. however,
993 * more so than for other presets, many of the speed shortcuts used in ultrafast cannot be
994 * switched out of; using reconfig to switch between ultrafast and other presets is not
995 * recommended without a more fine-grained breakdown of parameters to take this into account. */
996 int x264_encoder_reconfig( x264_t *, x264_param_t * );
997 /* x264_encoder_parameters:
998 * copies the current internal set of parameters to the pointer provided
999 * by the caller. useful when the calling application needs to know
1000 * how x264_encoder_open has changed the parameters, or the current state
1001 * of the encoder after multiple x264_encoder_reconfig calls.
1002 * note that the data accessible through pointers in the returned param struct
1003 * (e.g. filenames) should not be modified by the calling application. */
1004 void x264_encoder_parameters( x264_t *, x264_param_t * );
1005 /* x264_encoder_headers:
1006 * return the SPS and PPS that will be used for the whole stream.
1007 * *pi_nal is the number of NAL units outputted in pp_nal.
1008 * returns the number of bytes in the returned NALs.
1009 * returns negative on error.
1010 * the payloads of all output NALs are guaranteed to be sequential in memory. */
1011 int x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
1012 /* x264_encoder_encode:
1013 * encode one picture.
1014 * *pi_nal is the number of NAL units outputted in pp_nal.
1015 * returns the number of bytes in the returned NALs.
1016 * returns negative on error and zero if no NAL units returned.
1017 * the payloads of all output NALs are guaranteed to be sequential in memory. */
1018 int x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
1019 /* x264_encoder_close:
1020 * close an encoder handler */
1021 void x264_encoder_close( x264_t * );
1022 /* x264_encoder_delayed_frames:
1023 * return the number of currently delayed (buffered) frames
1024 * this should be used at the end of the stream, to know when you have all the encoded frames. */
1025 int x264_encoder_delayed_frames( x264_t * );
1026 /* x264_encoder_maximum_delayed_frames( x264_t *h ):
1027 * return the maximum number of delayed (buffered) frames that can occur with the current
1028 * parameters. */
1029 int x264_encoder_maximum_delayed_frames( x264_t *h );
1030 /* x264_encoder_intra_refresh:
1031 * If an intra refresh is not in progress, begin one with the next P-frame.
1032 * If an intra refresh is in progress, begin one as soon as the current one finishes.
1033 * Requires that b_intra_refresh be set.
1035 * Useful for interactive streaming where the client can tell the server that packet loss has
1036 * occurred. In this case, keyint can be set to an extremely high value so that intra refreshes
1037 * only occur when calling x264_encoder_intra_refresh.
1039 * In multi-pass encoding, if x264_encoder_intra_refresh is called differently in each pass,
1040 * behavior is undefined.
1042 * Should not be called during an x264_encoder_encode. */
1043 void x264_encoder_intra_refresh( x264_t * );
1044 /* x264_encoder_invalidate_reference:
1045 * An interactive error resilience tool, designed for use in a low-latency one-encoder-few-clients
1046 * system. When the client has packet loss or otherwise incorrectly decodes a frame, the encoder
1047 * can be told with this command to "forget" the frame and all frames that depend on it, referencing
1048 * only frames that occurred before the loss. This will force a keyframe if no frames are left to
1049 * reference after the aforementioned "forgetting".
1051 * It is strongly recommended to use a large i_dpb_size in this case, which allows the encoder to
1052 * keep around extra, older frames to fall back on in case more recent frames are all invalidated.
1053 * Unlike increasing i_frame_reference, this does not increase the number of frames used for motion
1054 * estimation and thus has no speed impact. It is also recommended to set a very large keyframe
1055 * interval, so that keyframes are not used except as necessary for error recovery.
1057 * x264_encoder_invalidate_reference is not currently compatible with the use of B-frames or intra
1058 * refresh.
1060 * In multi-pass encoding, if x264_encoder_invalidate_reference is called differently in each pass,
1061 * behavior is undefined.
1063 * Should not be called during an x264_encoder_encode, but multiple calls can be made simultaneously.
1065 * Returns 0 on success, negative on failure. */
1066 int x264_encoder_invalidate_reference( x264_t *, int64_t pts );
1068 #ifdef __cplusplus
1070 #endif
1072 #endif