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