check (most of) the levels constaints.
[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 40
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_ME_DIA                  0
68 #define X264_ME_HEX                  1
69 #define X264_ME_UMH                  2
70 #define X264_ME_ESA                  3
71 #define X264_CQM_FLAT                0
72 #define X264_CQM_JVT                 1
73 #define X264_CQM_CUSTOM              2
74
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 };
77
78 /* Colorspace type
79  */
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  /* */
91
92 /* Slice type
93  */
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)
102
103 /* Log level
104  */
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
110
111 typedef struct
112 {
113     int i_start, i_end;
114     int b_force_qp;
115     int i_qp;
116     float f_bitrate_factor;
117 } x264_zone_t;
118
119 typedef struct
120 {
121     /* CPU flags */
122     unsigned int cpu;
123     int         i_threads;  /* divide each frame into multiple slices, encode in parallel */
124
125     /* Video Properties */
126     int         i_width;
127     int         i_height;
128     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
129     int         i_level_idc; 
130     int         i_frame_total; /* number of frames to encode if known, else 0 */
131
132     struct
133     {
134         /* they will be reduced to be 0 < x <= 65535 and prime */
135         int         i_sar_height;
136         int         i_sar_width;
137
138         int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
139         
140         /* see h264 annex E for the values of the following */
141         int         i_vidformat;
142         int         b_fullrange;
143         int         i_colorprim;
144         int         i_transfer;
145         int         i_colmatrix;
146         int         i_chroma_loc;    /* both top & bottom */
147     } vui;
148
149     int         i_fps_num;
150     int         i_fps_den;
151
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;
159     int         i_bframe_bias;
160     int         b_bframe_pyramid;   /* Keep some B-frames as references */
161
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 */
165
166     int         b_cabac;
167     int         i_cabac_init_idc;
168
169     int         i_cqm_preset;
170     char        *psz_cqm_file;      /* JM format */
171     uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
172     uint8_t     cqm_4ic[16];
173     uint8_t     cqm_4py[16];
174     uint8_t     cqm_4pc[16];
175     uint8_t     cqm_8iy[64];
176     uint8_t     cqm_8py[64];
177
178     /* Log */
179     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
180     void        *p_log_private;
181     int         i_log_level;
182     int         b_visualize;
183
184     /* Encoder analyser parameters */
185     struct
186     {
187         unsigned int intra;     /* intra partitions */
188         unsigned int inter;     /* inter partitions */
189
190         int          b_transform_8x8;
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;
194
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_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
200         int          b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
201         int          i_trellis;  /* trellis RD quantization */
202
203         int          b_psnr;    /* Do we compute PSNR stats (save a few % of cpu) */
204     } analyse;
205
206     /* Rate control parameters */
207     struct
208     {
209         int         i_qp_constant;  /* 0-51 */
210         int         i_qp_min;       /* min allowed QP value */
211         int         i_qp_max;       /* max allowed QP value */
212         int         i_qp_step;      /* max QP step between frames */
213
214         int         b_cbr;          /* use bitrate instead of CQP */
215         int         i_bitrate;
216         int         i_rf_constant;  /* 1pass VBR, nominal QP */
217         float       f_rate_tolerance;
218         int         i_vbv_max_bitrate;
219         int         i_vbv_buffer_size;
220         float       f_vbv_buffer_init;
221         float       f_ip_factor;
222         float       f_pb_factor;
223
224         /* 2pass */
225         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
226         char        *psz_stat_out;
227         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
228         char        *psz_stat_in;
229
230         /* 2pass params (same as ffmpeg ones) */
231         char        *psz_rc_eq;     /* 2 pass rate control equation */
232         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
233         float       f_qblur;        /* temporally blur quants */
234         float       f_complexity_blur; /* temporally blur complexity */
235         x264_zone_t *zones;         /* ratecontrol overrides */
236         int         i_zones;        /* sumber of zone_t's */
237         char        *psz_zones;     /* alternate method of specifying zones */
238     } rc;
239
240     int b_aud;                  /* generate access unit delimiters */
241 } x264_param_t;
242
243 typedef struct {
244     int level_idc;
245     int mbps;        // max macroblock processing rate (macroblocks/sec)
246     int frame_size;  // max frame size (macroblocks)
247     int dpb;         // max decoded picture buffer (bytes)
248     int bitrate;     // max bitrate (kbit/sec)
249     int cpb;         // max vbv buffer (kbit)
250     int mv_range;    // max vertical mv component range (pixels)
251     int mvs_per_2mb; // max mvs per 2 consecutive mbs.
252     int slice_rate;  // ??
253     int bipred8x8;   // limit bipred to >=8x8
254     int direct8x8;   // limit b_direct to >=8x8
255     int frame_only;  // forbid interlacing
256 } x264_level_t;
257
258 /* all of the levels defined in the standard, terminated by .level_idc=0 */
259 extern const x264_level_t x264_levels[];
260
261 /* x264_param_default:
262  *      fill x264_param_t with default values and do CPU detection */
263 void    x264_param_default( x264_param_t * );
264
265 /****************************************************************************
266  * Picture structures and functions.
267  ****************************************************************************/
268 typedef struct
269 {
270     int     i_csp;
271
272     int     i_plane;
273     int     i_stride[4];
274     uint8_t *plane[4];
275 } x264_image_t;
276
277 typedef struct
278 {
279     /* In: force picture type (if not auto) XXX: ignored for now
280      * Out: type of the picture encoded */
281     int     i_type;
282     /* In: force quantizer for > 0 */
283     int     i_qpplus1;
284     /* In: user pts, Out: pts of encoded picture (user)*/
285     int64_t i_pts;
286
287     /* In: raw data */
288     x264_image_t img;
289 } x264_picture_t;
290
291 /* x264_picture_alloc:
292  *  alloc data for a picture. You must call x264_picture_clean on it. */
293 void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
294
295 /* x264_picture_clean:
296  *  free associated resource for a x264_picture_t allocated with
297  *  x264_picture_alloc ONLY */
298 void x264_picture_clean( x264_picture_t *pic );
299
300 /****************************************************************************
301  * NAL structure and functions:
302  ****************************************************************************/
303 /* nal */
304 enum nal_unit_type_e
305 {
306     NAL_UNKNOWN = 0,
307     NAL_SLICE   = 1,
308     NAL_SLICE_DPA   = 2,
309     NAL_SLICE_DPB   = 3,
310     NAL_SLICE_DPC   = 4,
311     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
312     NAL_SEI         = 6,    /* ref_idc == 0 */
313     NAL_SPS         = 7,
314     NAL_PPS         = 8,
315     NAL_AUD         = 9,
316     /* ref_idc == 0 for 6,9,10,11,12 */
317 };
318 enum nal_priority_e
319 {
320     NAL_PRIORITY_DISPOSABLE = 0,
321     NAL_PRIORITY_LOW        = 1,
322     NAL_PRIORITY_HIGH       = 2,
323     NAL_PRIORITY_HIGHEST    = 3,
324 };
325
326 typedef struct
327 {
328     int i_ref_idc;  /* nal_priority_e */
329     int i_type;     /* nal_unit_type_e */
330
331     /* This data are raw payload */
332     int     i_payload;
333     uint8_t *p_payload;
334 } x264_nal_t;
335
336 /* x264_nal_encode:
337  *      encode a nal into a buffer, setting the size.
338  *      if b_annexeb then a long synch work is added
339  *      XXX: it currently doesn't check for overflow */
340 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
341
342 /* x264_nal_decode:
343  *      decode a buffer nal into a x264_nal_t */
344 int x264_nal_decode( x264_nal_t *nal, void *, int );
345
346 /****************************************************************************
347  * Encoder functions:
348  ****************************************************************************/
349
350 /* x264_encoder_open:
351  *      create a new encoder handler, all parameters from x264_param_t are copied */
352 x264_t *x264_encoder_open   ( x264_param_t * );
353 /* x264_encoder_reconfig:
354  *      change encoder options while encoding,
355  *      analysis-related parameters from x264_param_t are copied */
356 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
357 /* x264_encoder_headers:
358  *      return the SPS and PPS that will be used for the whole stream */
359 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
360 /* x264_encoder_encode:
361  *      encode one picture */
362 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
363 /* x264_encoder_close:
364  *      close an encoder handler */
365 void    x264_encoder_close  ( x264_t * );
366
367 /* XXX: decoder isn't working so no need to export it */
368
369 /****************************************************************************
370  * Private stuff for internal usage:
371  ****************************************************************************/
372 #ifdef __X264__
373 #   ifdef _MSC_VER
374 #       define inline __inline
375 #       define DECLARE_ALIGNED( type, var, n ) __declspec(align(n)) type var
376 #               define strncasecmp(s1, s2, n) strnicmp(s1, s2, n)
377 #   else
378 #       define DECLARE_ALIGNED( type, var, n ) type var __attribute__((aligned(n)))
379 #   endif
380 #endif
381
382 #endif