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