configure: --enable-shared for libx264.so
[x262.git] / x264.h
1 /*****************************************************************************
2  * x264.h: h264 encoder library
3  *****************************************************************************
4  * Copyright (C) 2003 Laurent Aimar
5  * $Id: x264.h,v 1.1 2004/06/03 19:24:12 fenrir Exp $
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 #ifndef _X264_H
25 #define _X264_H 1
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 45
39
40 /* x264_t:
41  *      opaque handler for decoder and encoder */
42 typedef struct x264_t x264_t;
43
44 /****************************************************************************
45  * Initialisation structure and function.
46  ****************************************************************************/
47 /* CPU flags
48  */
49 #define X264_CPU_MMX        0x000001    /* mmx */
50 #define X264_CPU_MMXEXT     0x000002    /* mmx-ext*/
51 #define X264_CPU_SSE        0x000004    /* sse */
52 #define X264_CPU_SSE2       0x000008    /* sse 2 */
53 #define X264_CPU_3DNOW      0x000010    /* 3dnow! */
54 #define X264_CPU_3DNOWEXT   0x000020    /* 3dnow! ext */
55 #define X264_CPU_ALTIVEC    0x000040    /* altivec */
56
57 /* Analyse flags
58  */
59 #define X264_ANALYSE_I4x4       0x0001  /* Analyse i4x4 */
60 #define X264_ANALYSE_I8x8       0x0002  /* Analyse i8x8 (requires 8x8 transform) */
61 #define X264_ANALYSE_PSUB16x16  0x0010  /* Analyse p16x8, p8x16 and p8x8 */
62 #define X264_ANALYSE_PSUB8x8    0x0020  /* Analyse p8x4, p4x8, p4x4 */
63 #define X264_ANALYSE_BSUB16x16  0x0100  /* Analyse b16x8, b8x16 and b8x8 */
64 #define X264_DIRECT_PRED_NONE        0
65 #define X264_DIRECT_PRED_SPATIAL     1
66 #define X264_DIRECT_PRED_TEMPORAL    2
67 #define X264_DIRECT_PRED_AUTO        3
68 #define X264_ME_DIA                  0
69 #define X264_ME_HEX                  1
70 #define X264_ME_UMH                  2
71 #define X264_ME_ESA                  3
72 #define X264_CQM_FLAT                0
73 #define X264_CQM_JVT                 1
74 #define X264_CQM_CUSTOM              2
75
76 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
77 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", 0 };
78
79 /* Colorspace type
80  */
81 #define X264_CSP_MASK           0x00ff  /* */
82 #define X264_CSP_NONE           0x0000  /* Invalid mode     */
83 #define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
84 #define X264_CSP_I422           0x0002  /* yuv 4:2:2 planar */
85 #define X264_CSP_I444           0x0003  /* yuv 4:4:4 planar */
86 #define X264_CSP_YV12           0x0004  /* yuv 4:2:0 planar */
87 #define X264_CSP_YUYV           0x0005  /* yuv 4:2:2 packed */
88 #define X264_CSP_RGB            0x0006  /* rgb 24bits       */
89 #define X264_CSP_BGR            0x0007  /* bgr 24bits       */
90 #define X264_CSP_BGRA           0x0008  /* bgr 32bits       */
91 #define X264_CSP_VFLIP          0x1000  /* */
92
93 /* Slice type
94  */
95 #define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
96 #define X264_TYPE_IDR           0x0001
97 #define X264_TYPE_I             0x0002
98 #define X264_TYPE_P             0x0003
99 #define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
100 #define X264_TYPE_B             0x0005
101 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
102 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
103
104 /* Log level
105  */
106 #define X264_LOG_NONE          (-1)
107 #define X264_LOG_ERROR          0
108 #define X264_LOG_WARNING        1
109 #define X264_LOG_INFO           2
110 #define X264_LOG_DEBUG          3
111
112 typedef struct
113 {
114     int i_start, i_end;
115     int b_force_qp;
116     int i_qp;
117     float f_bitrate_factor;
118 } x264_zone_t;
119
120 typedef struct
121 {
122     /* CPU flags */
123     unsigned int cpu;
124     int         i_threads;  /* divide each frame into multiple slices, encode in parallel */
125
126     /* Video Properties */
127     int         i_width;
128     int         i_height;
129     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
130     int         i_level_idc; 
131     int         i_frame_total; /* number of frames to encode if known, else 0 */
132
133     struct
134     {
135         /* they will be reduced to be 0 < x <= 65535 and prime */
136         int         i_sar_height;
137         int         i_sar_width;
138
139         int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
140         
141         /* see h264 annex E for the values of the following */
142         int         i_vidformat;
143         int         b_fullrange;
144         int         i_colorprim;
145         int         i_transfer;
146         int         i_colmatrix;
147         int         i_chroma_loc;    /* both top & bottom */
148     } vui;
149
150     int         i_fps_num;
151     int         i_fps_den;
152
153     /* Bitstream parameters */
154     int         i_frame_reference;  /* Maximum number of reference frames */
155     int         i_keyint_max;       /* Force an IDR keyframe at this interval */
156     int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
157     int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
158     int         i_bframe;   /* how many b-frame between 2 references pictures */
159     int         b_bframe_adaptive;
160     int         i_bframe_bias;
161     int         b_bframe_pyramid;   /* Keep some B-frames as references */
162
163     int         b_deblocking_filter;
164     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
165     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
166
167     int         b_cabac;
168     int         i_cabac_init_idc;
169
170     int         i_cqm_preset;
171     char        *psz_cqm_file;      /* JM format */
172     uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
173     uint8_t     cqm_4ic[16];
174     uint8_t     cqm_4py[16];
175     uint8_t     cqm_4pc[16];
176     uint8_t     cqm_8iy[64];
177     uint8_t     cqm_8py[64];
178
179     /* Log */
180     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
181     void        *p_log_private;
182     int         i_log_level;
183     int         b_visualize;
184
185     /* Encoder analyser parameters */
186     struct
187     {
188         unsigned int intra;     /* intra partitions */
189         unsigned int inter;     /* inter partitions */
190
191         int          b_transform_8x8;
192         int          b_weighted_bipred; /* implicit weighting for B-frames */
193         int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
194         int          i_chroma_qp_offset;
195
196         int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
197         int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
198         int          i_mv_range; /* maximum length of a mv (in pixels) */
199         int          i_subpel_refine; /* subpixel motion estimation quality */
200         int          b_bidir_me; /* jointly optimize both MVs in B-frames */
201         int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
202         int          b_bframe_rdo; /* RD based mode decision for B-frames */
203         int          b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
204         int          i_trellis;  /* trellis RD quantization */
205         int          b_fast_pskip; /* early SKIP detection on P-frames */
206         int          i_noise_reduction; /* adaptive pseudo-deadzone */
207
208         int          b_psnr;    /* Do we compute PSNR stats (save a few % of cpu) */
209     } analyse;
210
211     /* Rate control parameters */
212     struct
213     {
214         int         i_qp_constant;  /* 0-51 */
215         int         i_qp_min;       /* min allowed QP value */
216         int         i_qp_max;       /* max allowed QP value */
217         int         i_qp_step;      /* max QP step between frames */
218
219         int         b_cbr;          /* use bitrate instead of CQP */
220         int         i_bitrate;
221         int         i_rf_constant;  /* 1pass VBR, nominal QP */
222         float       f_rate_tolerance;
223         int         i_vbv_max_bitrate;
224         int         i_vbv_buffer_size;
225         float       f_vbv_buffer_init;
226         float       f_ip_factor;
227         float       f_pb_factor;
228
229         /* 2pass */
230         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
231         char        *psz_stat_out;
232         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
233         char        *psz_stat_in;
234
235         /* 2pass params (same as ffmpeg ones) */
236         char        *psz_rc_eq;     /* 2 pass rate control equation */
237         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
238         float       f_qblur;        /* temporally blur quants */
239         float       f_complexity_blur; /* temporally blur complexity */
240         x264_zone_t *zones;         /* ratecontrol overrides */
241         int         i_zones;        /* sumber of zone_t's */
242         char        *psz_zones;     /* alternate method of specifying zones */
243     } rc;
244
245     int b_aud;                  /* generate access unit delimiters */
246     int b_repeat_headers;       /* put SPS/PPS before each keyframe */
247 } x264_param_t;
248
249 typedef struct {
250     int level_idc;
251     int mbps;        // max macroblock processing rate (macroblocks/sec)
252     int frame_size;  // max frame size (macroblocks)
253     int dpb;         // max decoded picture buffer (bytes)
254     int bitrate;     // max bitrate (kbit/sec)
255     int cpb;         // max vbv buffer (kbit)
256     int mv_range;    // max vertical mv component range (pixels)
257     int mvs_per_2mb; // max mvs per 2 consecutive mbs.
258     int slice_rate;  // ??
259     int bipred8x8;   // limit bipred to >=8x8
260     int direct8x8;   // limit b_direct to >=8x8
261     int frame_only;  // forbid interlacing
262 } x264_level_t;
263
264 /* all of the levels defined in the standard, terminated by .level_idc=0 */
265 extern const x264_level_t x264_levels[];
266
267 /* x264_param_default:
268  *      fill x264_param_t with default values and do CPU detection */
269 void    x264_param_default( x264_param_t * );
270
271 /****************************************************************************
272  * Picture structures and functions.
273  ****************************************************************************/
274 typedef struct
275 {
276     int     i_csp;
277
278     int     i_plane;
279     int     i_stride[4];
280     uint8_t *plane[4];
281 } x264_image_t;
282
283 typedef struct
284 {
285     /* In: force picture type (if not auto) XXX: ignored for now
286      * Out: type of the picture encoded */
287     int     i_type;
288     /* In: force quantizer for > 0 */
289     int     i_qpplus1;
290     /* In: user pts, Out: pts of encoded picture (user)*/
291     int64_t i_pts;
292
293     /* In: raw data */
294     x264_image_t img;
295 } x264_picture_t;
296
297 /* x264_picture_alloc:
298  *  alloc data for a picture. You must call x264_picture_clean on it. */
299 void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
300
301 /* x264_picture_clean:
302  *  free associated resource for a x264_picture_t allocated with
303  *  x264_picture_alloc ONLY */
304 void x264_picture_clean( x264_picture_t *pic );
305
306 /****************************************************************************
307  * NAL structure and functions:
308  ****************************************************************************/
309 /* nal */
310 enum nal_unit_type_e
311 {
312     NAL_UNKNOWN = 0,
313     NAL_SLICE   = 1,
314     NAL_SLICE_DPA   = 2,
315     NAL_SLICE_DPB   = 3,
316     NAL_SLICE_DPC   = 4,
317     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
318     NAL_SEI         = 6,    /* ref_idc == 0 */
319     NAL_SPS         = 7,
320     NAL_PPS         = 8,
321     NAL_AUD         = 9,
322     /* ref_idc == 0 for 6,9,10,11,12 */
323 };
324 enum nal_priority_e
325 {
326     NAL_PRIORITY_DISPOSABLE = 0,
327     NAL_PRIORITY_LOW        = 1,
328     NAL_PRIORITY_HIGH       = 2,
329     NAL_PRIORITY_HIGHEST    = 3,
330 };
331
332 typedef struct
333 {
334     int i_ref_idc;  /* nal_priority_e */
335     int i_type;     /* nal_unit_type_e */
336
337     /* This data are raw payload */
338     int     i_payload;
339     uint8_t *p_payload;
340 } x264_nal_t;
341
342 /* x264_nal_encode:
343  *      encode a nal into a buffer, setting the size.
344  *      if b_annexeb then a long synch work is added
345  *      XXX: it currently doesn't check for overflow */
346 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
347
348 /* x264_nal_decode:
349  *      decode a buffer nal into a x264_nal_t */
350 int x264_nal_decode( x264_nal_t *nal, void *, int );
351
352 /****************************************************************************
353  * Encoder functions:
354  ****************************************************************************/
355
356 /* x264_encoder_open:
357  *      create a new encoder handler, all parameters from x264_param_t are copied */
358 x264_t *x264_encoder_open   ( x264_param_t * );
359 /* x264_encoder_reconfig:
360  *      change encoder options while encoding,
361  *      analysis-related parameters from x264_param_t are copied */
362 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
363 /* x264_encoder_headers:
364  *      return the SPS and PPS that will be used for the whole stream */
365 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
366 /* x264_encoder_encode:
367  *      encode one picture */
368 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
369 /* x264_encoder_close:
370  *      close an encoder handler */
371 void    x264_encoder_close  ( x264_t * );
372
373 /* XXX: decoder isn't working so no need to export it */
374
375 /****************************************************************************
376  * Private stuff for internal usage:
377  ****************************************************************************/
378 #ifdef __X264__
379 #   ifdef _MSC_VER
380 #       define inline __inline
381 #       define DECLARE_ALIGNED( type, var, n ) __declspec(align(n)) type var
382 #               define strncasecmp(s1, s2, n) strnicmp(s1, s2, n)
383 #   else
384 #       define DECLARE_ALIGNED( type, var, n ) type var __attribute__((aligned(n)))
385 #   endif
386 #endif
387
388 #endif