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 $
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
32 * opaque handler for decoder and encoder */
33 typedef struct x264_t x264_t;
35 /****************************************************************************
36 * Initialisation structure and function.
37 ****************************************************************************/
40 #define X264_CPU_MMX 0x000001 /* mmx */
41 #define X264_CPU_MMXEXT 0x000002 /* mmx-ext*/
42 #define X264_CPU_SSE 0x000004 /* sse */
43 #define X264_CPU_SSE2 0x000008 /* sse 2 */
44 #define X264_CPU_3DNOW 0x000010 /* 3dnow! */
45 #define X264_CPU_3DNOWEXT 0x000020 /* 3dnow! ext */
46 #define X264_CPU_ALTIVEC 0x000040 /* altivec */
50 #define X264_ANALYSE_I4x4 0x0001 /* Analyse i4x4 */
51 #define X264_ANALYSE_PSUB16x16 0x0010 /* Analyse p16x8, p8x16 and p8x8 */
52 #define X264_ANALYSE_PSUB8x8 0x0020 /* Analyse p8x4, p4x8, p4x4 */
53 #define X264_ANALYSE_BSUB16x16 0x0100 /* Analyse b16x8, b8x16 and b8x8 */
54 #define X264_DIRECT_PRED_NONE 0
55 #define X264_DIRECT_PRED_SPATIAL 1
56 #define X264_DIRECT_PRED_TEMPORAL 2
64 #define X264_CSP_MASK 0x00ff /* */
65 #define X264_CSP_NONE 0x0000 /* Invalid mode */
66 #define X264_CSP_I420 0x0001 /* yuv 4:2:0 planar */
67 #define X264_CSP_I422 0x0002 /* yuv 4:2:2 planar */
68 #define X264_CSP_I444 0x0003 /* yuv 4:4:4 planar */
69 #define X264_CSP_YV12 0x0004 /* yuv 4:2:0 planar */
70 #define X264_CSP_YUYV 0x0005 /* yuv 4:2:2 packed */
71 #define X264_CSP_RGB 0x0006 /* rgb 24bits */
72 #define X264_CSP_BGR 0x0007 /* bgr 24bits */
73 #define X264_CSP_BGRA 0x0008 /* bgr 32bits */
74 #define X264_CSP_VFLIP 0x1000 /* */
78 #define X264_TYPE_AUTO 0x0000 /* Let x264 choose the right type */
79 #define X264_TYPE_IDR 0x0001
80 #define X264_TYPE_I 0x0002
81 #define X264_TYPE_P 0x0003
82 #define X264_TYPE_BREF 0x0004 /* Non-disposable B-frame */
83 #define X264_TYPE_B 0x0005
84 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
85 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
89 #define X264_LOG_NONE (-1)
90 #define X264_LOG_ERROR 0
91 #define X264_LOG_WARNING 1
92 #define X264_LOG_INFO 2
93 #define X264_LOG_DEBUG 3
100 float f_bitrate_factor;
107 int i_threads; /* divide each frame into multiple slices, encode in parallel */
109 /* Video Properties */
112 int i_csp; /* CSP of encoded bitstream, only i420 supported */
117 /* they will be reduced to be 0 < x <= 65535 and prime */
125 /* Bitstream parameters */
126 int i_frame_reference; /* Maximum number of reference frames */
127 int i_keyint_max; /* Force an IDR keyframe at this interval */
128 int i_keyint_min; /* Scenecuts closer together than this are coded as I, not IDR. */
129 int i_scenecut_threshold; /* how aggressively to insert extra I frames */
130 int i_bframe; /* how many b-frame between 2 references pictures */
131 int b_bframe_adaptive;
133 int b_bframe_pyramid; /* Keep some B-frames as references */
135 int b_deblocking_filter;
136 int i_deblocking_filter_alphac0; /* [-6, 6] -6 light filter, 6 strong */
137 int i_deblocking_filter_beta; /* [-6, 6] idem */
140 int i_cabac_init_idc;
144 void (*pf_log)( void *, int i_level, const char *psz, va_list );
149 /* Encoder analyser parameters */
152 unsigned int intra; /* intra flags */
153 unsigned int inter; /* inter flags */
155 int i_direct_mv_pred; /* spatial vs temporal mv prediction */
156 int i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
157 int i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
158 int i_subpel_refine; /* subpixel motion estimation quality */
159 int b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
160 int i_mv_range; /* maximum length of a mv (in pixels) */
162 int b_weighted_bipred; /* implicit weighting for B-frames */
164 int i_chroma_qp_offset;
166 int b_psnr; /* Do we compute PSNR stats (save a few % of cpu) */
169 /* Rate control parameters */
172 int i_qp_constant; /* 1-51 */
173 int i_qp_min; /* min allowed QP value */
174 int i_qp_max; /* max allowed QP value */
175 int i_qp_step; /* max QP step between frames */
177 int b_cbr; /* use bitrate instead of CQP */
179 float f_rate_tolerance;
180 int i_vbv_max_bitrate;
181 int i_vbv_buffer_size;
182 float f_vbv_buffer_init;
187 int b_stat_write; /* Enable stat writing in psz_stat_out */
189 int b_stat_read; /* Read stat from psz_stat_in and use it */
192 /* 2pass params (same as ffmpeg ones) */
193 char *psz_rc_eq; /* 2 pass rate control equation */
194 float f_qcompress; /* 0.0 => cbr, 1.0 => constant qp */
195 float f_qblur; /* temporally blur quants */
196 float f_complexity_blur; /* temporally blur complexity */
197 x264_zone_t *zones; /* ratecontrol overrides */
198 int i_zones; /* sumber of zone_t's */
199 char *psz_zones; /* alternate method of specifying zones */
202 int b_aud; /* generate access unit delimiters */
205 /* x264_param_default:
206 * fill x264_param_t with default values and do CPU detection */
207 void x264_param_default( x264_param_t * );
209 /****************************************************************************
210 * Picture structures and functions.
211 ****************************************************************************/
223 /* In: force picture type (if not auto) XXX: ignored for now
224 * Out: type of the picture encoded */
226 /* In: force quantizer for > 0 */
228 /* In: user pts, Out: pts of encoded picture (user)*/
235 /* x264_picture_alloc:
236 * alloc data for a picture. You must call x264_picture_clean on it. */
237 void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
239 /* x264_picture_clean:
240 * free associated resource for a x264_picture_t allocated with
241 * x264_picture_alloc ONLY */
242 void x264_picture_clean( x264_picture_t *pic );
244 /****************************************************************************
245 * NAL structure and functions:
246 ****************************************************************************/
255 NAL_SLICE_IDR = 5, /* ref_idc != 0 */
256 NAL_SEI = 6, /* ref_idc == 0 */
260 /* ref_idc == 0 for 6,9,10,11,12 */
264 NAL_PRIORITY_DISPOSABLE = 0,
265 NAL_PRIORITY_LOW = 1,
266 NAL_PRIORITY_HIGH = 2,
267 NAL_PRIORITY_HIGHEST = 3,
272 int i_ref_idc; /* nal_priority_e */
273 int i_type; /* nal_unit_type_e */
275 /* This data are raw payload */
281 * encode a nal into a buffer, setting the size.
282 * if b_annexeb then a long synch work is added
283 * XXX: it currently doesn't check for overflow */
284 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
287 * decode a buffer nal into a x264_nal_t */
288 int x264_nal_decode( x264_nal_t *nal, void *, int );
290 /****************************************************************************
292 ****************************************************************************/
294 /* x264_encoder_open:
295 * create a new encoder handler, all parameters from x264_param_t are copied */
296 x264_t *x264_encoder_open ( x264_param_t * );
297 /* x264_encoder_reconfig:
298 * change encoder options while encoding,
299 * analysis-related parameters from x264_param_t are copied */
300 int x264_encoder_reconfig( x264_t *, x264_param_t * );
301 /* x264_encoder_headers:
302 * return the SPS and PPS that will be used for the whole stream */
303 int x264_encoder_headers( x264_t *, x264_nal_t **, int * );
304 /* x264_encoder_encode:
305 * encode one picture */
306 int x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
307 /* x264_encoder_close:
308 * close an encoder handler */
309 void x264_encoder_close ( x264_t * );
311 /* XXX: decoder isn't working so no need to export it */
313 /****************************************************************************
315 ****************************************************************************
316 * XXX: Not yet working so do not try ...
317 ****************************************************************************/
318 /* x264_decoder_open:
320 x264_t *x264_decoder_open ( x264_param_t * );
321 /* x264_decoder_decode:
323 int x264_decoder_decode ( x264_t *, x264_picture_t **, x264_nal_t * );
324 /* x264_decoder_close:
326 void x264_decoder_close ( x264_t * );
329 /****************************************************************************
330 * Private stuff for internal usage:
331 ****************************************************************************/
334 # define inline __inline
335 # define DECLARE_ALIGNED( type, var, n ) __declspec(align(n)) type var
337 # define DECLARE_ALIGNED( type, var, n ) type var __attribute__((aligned(n)))