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
*****************************************************************************/
27
#if !defined(_STDINT_H) && !defined(_STDINT_H_) && \
28
!defined(_INTTYPES_H) && !defined(_INTTYPES_H_)
30
# pragma message("You must include stdint.h or inttypes.h before x264.h")
32
# warning You must include stdint.h or inttypes.h before x264.h
41
* opaque handler for decoder and encoder */
42
typedef struct x264_t x264_t;
44
/****************************************************************************
45
* Initialisation structure and function.
46
****************************************************************************/
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 */
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
71
#define X264_CQM_FLAT 0
72
#define X264_CQM_JVT 1
73
#define X264_CQM_CUSTOM 2
75
static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", 0 };
76
static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", 0 };
80
#define X264_CSP_MASK 0x00ff /* */
81
#define X264_CSP_NONE 0x0000 /* Invalid mode */
82
#define X264_CSP_I420 0x0001 /* yuv 4:2:0 planar */
83
#define X264_CSP_I422 0x0002 /* yuv 4:2:2 planar */
84
#define X264_CSP_I444 0x0003 /* yuv 4:4:4 planar */
85
#define X264_CSP_YV12 0x0004 /* yuv 4:2:0 planar */
86
#define X264_CSP_YUYV 0x0005 /* yuv 4:2:2 packed */
87
#define X264_CSP_RGB 0x0006 /* rgb 24bits */
88
#define X264_CSP_BGR 0x0007 /* bgr 24bits */
89
#define X264_CSP_BGRA 0x0008 /* bgr 32bits */
90
#define X264_CSP_VFLIP 0x1000 /* */
94
#define X264_TYPE_AUTO 0x0000 /* Let x264 choose the right type */
95
#define X264_TYPE_IDR 0x0001
96
#define X264_TYPE_I 0x0002
97
#define X264_TYPE_P 0x0003
98
#define X264_TYPE_BREF 0x0004 /* Non-disposable B-frame */
99
#define X264_TYPE_B 0x0005
100
#define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
101
#define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
105
#define X264_LOG_NONE (-1)
106
#define X264_LOG_ERROR 0
107
#define X264_LOG_WARNING 1
108
#define X264_LOG_INFO 2
109
#define X264_LOG_DEBUG 3
116
float f_bitrate_factor;
123
int i_threads; /* divide each frame into multiple slices, encode in parallel */
125
/* Video Properties */
128
int i_csp; /* CSP of encoded bitstream, only i420 supported */
130
int i_frame_total; /* number of frames to encode if known, else 0 */
134
/* they will be reduced to be 0 < x <= 65535 and prime */
138
int i_overscan; /* 0=undef, 1=no overscan, 2=overscan */
140
/* see h264 annex E for the values of the following */
146
int i_chroma_loc; /* both top & bottom */
152
/* Bitstream parameters */
153
int i_frame_reference; /* Maximum number of reference frames */
154
int i_keyint_max; /* Force an IDR keyframe at this interval */
155
int i_keyint_min; /* Scenecuts closer together than this are coded as I, not IDR. */
156
int i_scenecut_threshold; /* how aggressively to insert extra I frames */
157
int i_bframe; /* how many b-frame between 2 references pictures */
158
int b_bframe_adaptive;
160
int b_bframe_pyramid; /* Keep some B-frames as references */
162
int b_deblocking_filter;
163
int i_deblocking_filter_alphac0; /* [-6, 6] -6 light filter, 6 strong */
164
int i_deblocking_filter_beta; /* [-6, 6] idem */
167
int i_cabac_init_idc;
170
char *psz_cqm_file; /* JM format */
171
uint8_t cqm_4iy[16]; /* used only if i_cqm_preset == X264_CQM_CUSTOM */
179
void (*pf_log)( void *, int i_level, const char *psz, va_list );
184
/* Encoder analyser parameters */
187
unsigned int intra; /* intra partitions */
188
unsigned int inter; /* inter partitions */
191
int b_weighted_bipred; /* implicit weighting for B-frames */
192
int i_direct_mv_pred; /* spatial vs temporal mv prediction */
193
int i_chroma_qp_offset;
195
int i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
196
int i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
197
int i_mv_range; /* maximum length of a mv (in pixels) */
198
int i_subpel_refine; /* subpixel motion estimation quality */
199
int b_bidir_me; /* jointly optimize both MVs in B-frames */
200
int b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
201
int b_bframe_rdo; /* RD based mode decision for B-frames */
202
int b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
203
int i_trellis; /* trellis RD quantization */
204
int b_fast_pskip; /* early SKIP detection on P-frames */
205
int i_noise_reduction; /* adaptive pseudo-deadzone */
207
int b_psnr; /* Do we compute PSNR stats (save a few % of cpu) */
210
/* Rate control parameters */
213
int i_qp_constant; /* 0-51 */
214
int i_qp_min; /* min allowed QP value */
215
int i_qp_max; /* max allowed QP value */
216
int i_qp_step; /* max QP step between frames */
218
int b_cbr; /* use bitrate instead of CQP */
220
int i_rf_constant; /* 1pass VBR, nominal QP */
221
float f_rate_tolerance;
222
int i_vbv_max_bitrate;
223
int i_vbv_buffer_size;
224
float f_vbv_buffer_init;
229
int b_stat_write; /* Enable stat writing in psz_stat_out */
231
int b_stat_read; /* Read stat from psz_stat_in and use it */
234
/* 2pass params (same as ffmpeg ones) */
235
char *psz_rc_eq; /* 2 pass rate control equation */
236
float f_qcompress; /* 0.0 => cbr, 1.0 => constant qp */
237
float f_qblur; /* temporally blur quants */
238
float f_complexity_blur; /* temporally blur complexity */
239
x264_zone_t *zones; /* ratecontrol overrides */
240
int i_zones; /* sumber of zone_t's */
241
char *psz_zones; /* alternate method of specifying zones */
244
int b_aud; /* generate access unit delimiters */
245
int b_repeat_headers; /* put SPS/PPS before each keyframe */
250
int mbps; // max macroblock processing rate (macroblocks/sec)
251
int frame_size; // max frame size (macroblocks)
252
int dpb; // max decoded picture buffer (bytes)
253
int bitrate; // max bitrate (kbit/sec)
254
int cpb; // max vbv buffer (kbit)
255
int mv_range; // max vertical mv component range (pixels)
256
int mvs_per_2mb; // max mvs per 2 consecutive mbs.
257
int slice_rate; // ??
258
int bipred8x8; // limit bipred to >=8x8
259
int direct8x8; // limit b_direct to >=8x8
260
int frame_only; // forbid interlacing
263
/* all of the levels defined in the standard, terminated by .level_idc=0 */
264
extern const x264_level_t x264_levels[];
266
/* x264_param_default:
267
* fill x264_param_t with default values and do CPU detection */
268
void x264_param_default( x264_param_t * );
270
/****************************************************************************
271
* Picture structures and functions.
272
****************************************************************************/
284
/* In: force picture type (if not auto) XXX: ignored for now
285
* Out: type of the picture encoded */
287
/* In: force quantizer for > 0 */
289
/* In: user pts, Out: pts of encoded picture (user)*/
296
/* x264_picture_alloc:
297
* alloc data for a picture. You must call x264_picture_clean on it. */
298
void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
300
/* x264_picture_clean:
301
* free associated resource for a x264_picture_t allocated with
302
* x264_picture_alloc ONLY */
303
void x264_picture_clean( x264_picture_t *pic );
305
/****************************************************************************
306
* NAL structure and functions:
307
****************************************************************************/
316
NAL_SLICE_IDR = 5, /* ref_idc != 0 */
317
NAL_SEI = 6, /* ref_idc == 0 */
321
/* ref_idc == 0 for 6,9,10,11,12 */
325
NAL_PRIORITY_DISPOSABLE = 0,
326
NAL_PRIORITY_LOW = 1,
327
NAL_PRIORITY_HIGH = 2,
328
NAL_PRIORITY_HIGHEST = 3,
333
int i_ref_idc; /* nal_priority_e */
334
int i_type; /* nal_unit_type_e */
336
/* This data are raw payload */
342
* encode a nal into a buffer, setting the size.
343
* if b_annexeb then a long synch work is added
344
* XXX: it currently doesn't check for overflow */
345
int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
348
* decode a buffer nal into a x264_nal_t */
349
int x264_nal_decode( x264_nal_t *nal, void *, int );
351
/****************************************************************************
353
****************************************************************************/
355
/* x264_encoder_open:
356
* create a new encoder handler, all parameters from x264_param_t are copied */
357
x264_t *x264_encoder_open ( x264_param_t * );
358
/* x264_encoder_reconfig:
359
* change encoder options while encoding,
360
* analysis-related parameters from x264_param_t are copied */
361
int x264_encoder_reconfig( x264_t *, x264_param_t * );
362
/* x264_encoder_headers:
363
* return the SPS and PPS that will be used for the whole stream */
364
int x264_encoder_headers( x264_t *, x264_nal_t **, int * );
365
/* x264_encoder_encode:
366
* encode one picture */
367
int x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
368
/* x264_encoder_close:
369
* close an encoder handler */
370
void x264_encoder_close ( x264_t * );
372
/* XXX: decoder isn't working so no need to export it */
374
/****************************************************************************
375
* Private stuff for internal usage:
376
****************************************************************************/
379
# define inline __inline
380
# define DECLARE_ALIGNED( type, var, n ) __declspec(align(n)) type var
381
# define strncasecmp(s1, s2, n) strnicmp(s1, s2, n)
383
# define DECLARE_ALIGNED( type, var, n ) type var __attribute__((aligned(n)))
added
removed
x264.h
