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