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