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