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