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