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