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