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