added skip macroblock optimization (big perf win on black regions for example)
[libav.git] / libavcodec / mpegvideo.h
1 /*
2 * Generic DCT based hybrid video encoder
3 * Copyright (c) 2000,2001 Gerard Lantau.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 /* Macros for picture code type. */
21 #define I_TYPE 1
22 #define P_TYPE 2
23 #define B_TYPE 3
24
25 enum OutputFormat {
26 FMT_MPEG1,
27 FMT_H263,
28 FMT_MJPEG,
29 };
30
31 #define MPEG_BUF_SIZE (16 * 1024)
32
33 typedef struct MpegEncContext {
34 /* the following parameters must be initialized before encoding */
35 int width, height; /* picture size. must be a multiple of 16 */
36 int gop_size;
37 int frame_rate; /* number of frames per second */
38 int intra_only; /* if true, only intra pictures are generated */
39 int bit_rate; /* wanted bit rate */
40 enum OutputFormat out_format; /* output format */
41 int h263_plus; /* h263 plus headers */
42 int h263_rv10; /* use RV10 variation for H263 */
43 int h263_pred; /* use OpenDIVX (aka mpeg4) ac/dc predictions */
44 int h263_msmpeg4; /* generate MSMPEG4 compatible stream */
45 int h263_intel; /* use I263 intel h263 header */
46 int fixed_qscale; /* fixed qscale if non zero */
47 int encoding; /* true if we are encoding (vs decoding) */
48 /* the following fields are managed internally by the encoder */
49
50 /* bit output */
51 PutBitContext pb;
52
53 /* sequence parameters */
54 int context_initialized;
55 int picture_number;
56 int fake_picture_number; /* picture number at the bitstream frame rate */
57 int gop_picture_number; /* index of the first picture of a GOP */
58 int mb_width, mb_height;
59 int linesize; /* line size, in bytes, may be different from width */
60 UINT8 *new_picture[3]; /* picture to be compressed */
61 UINT8 *last_picture[3]; /* previous picture */
62 UINT8 *last_picture_base[3]; /* real start of the picture */
63 UINT8 *next_picture[3]; /* previous picture (for bidir pred) */
64 UINT8 *next_picture_base[3]; /* real start of the picture */
65 UINT8 *aux_picture[3]; /* aux picture (for B frames only) */
66 UINT8 *aux_picture_base[3]; /* real start of the picture */
67 UINT8 *current_picture[3]; /* buffer to store the decompressed current picture */
68 int last_dc[3]; /* last DC values for MPEG1 */
69 INT16 *dc_val[3]; /* used for mpeg4 DC prediction */
70 int y_dc_scale, c_dc_scale;
71 UINT8 *coded_block; /* used for coded block pattern prediction */
72 INT16 (*ac_val[3])[16]; /* used for for mpeg4 AC prediction */
73 int ac_pred;
74 int mb_skiped; /* MUST BE SET only during DECODING */
75 UINT8 *mbskip_table; /* used to avoid copy if macroblock
76 skipped (for black regions for example) */
77
78 int qscale;
79 int pict_type;
80 int frame_rate_index;
81 /* motion compensation */
82 int unrestricted_mv;
83 int h263_long_vectors; /* use horrible h263v1 long vector mode */
84
85 int f_code; /* resolution */
86 INT16 (*motion_val)[2]; /* used for MV prediction */
87 int full_search;
88 int mv_dir;
89 #define MV_DIR_BACKWARD 1
90 #define MV_DIR_FORWARD 2
91 int mv_type;
92 #define MV_TYPE_16X16 0 /* 1 vector for the whole mb */
93 #define MV_TYPE_8X8 1 /* 4 vectors (h263) */
94 #define MV_TYPE_16X8 2 /* 2 vectors, one per 16x8 block */
95 #define MV_TYPE_FIELD 3 /* 2 vectors, one per field */
96 #define MV_TYPE_DMV 4 /* 2 vectors, special mpeg2 Dual Prime Vectors */
97 /* motion vectors for a macroblock
98 first coordinate : 0 = forward 1 = backward
99 second " : depend on type
100 third " : 0 = x, 1 = y
101 */
102 int mv[2][4][2];
103 int field_select[2][2];
104 int last_mv[2][2][2];
105
106 int has_b_frames;
107 int no_rounding; /* apply no rounding to motion estimation (MPEG4) */
108
109 /* macroblock layer */
110 int mb_x, mb_y;
111 int mb_incr;
112 int mb_intra;
113 /* matrix transmitted in the bitstream */
114 UINT16 intra_matrix[64];
115 UINT16 chroma_intra_matrix[64];
116 UINT16 non_intra_matrix[64];
117 UINT16 chroma_non_intra_matrix[64];
118 /* precomputed matrix (combine qscale and DCT renorm) */
119 int q_intra_matrix[64];
120 int q_non_intra_matrix[64];
121 int block_last_index[6]; /* last non zero coefficient in block */
122
123 void *opaque; /* private data for the user */
124
125 /* bit rate control */
126 int I_frame_bits; /* wanted number of bits per I frame */
127 int P_frame_bits; /* same for P frame */
128 long long wanted_bits;
129 long long total_bits;
130
131 /* mpeg4 specific */
132 int time_increment_bits;
133
134 /* RV10 specific */
135 int rv10_version; /* RV10 version: 0 or 3 */
136 int rv10_first_dc_coded[3];
137
138 /* MJPEG specific */
139 struct MJpegContext *mjpeg_ctx;
140
141 /* MSMPEG4 specific */
142 int mv_table_index;
143 int rl_table_index;
144 int rl_chroma_table_index;
145 int dc_table_index;
146 int use_skip_mb_code;
147 int slice_height; /* in macroblocks */
148 int first_slice_line;
149 /* decompression specific */
150 GetBitContext gb;
151
152 /* MPEG2 specific - I wish I had not to support this mess. */
153 int progressive_sequence;
154 int mpeg_f_code[2][2];
155 int picture_structure;
156 /* picture type */
157 #define PICT_TOP_FIELD 1
158 #define PICT_BOTTOM_FIELD 2
159 #define PICT_FRAME 3
160
161 int intra_dc_precision;
162 int frame_pred_frame_dct;
163 int top_field_first;
164 int concealment_motion_vectors;
165 int q_scale_type;
166 int intra_vlc_format;
167 int alternate_scan;
168 int repeat_first_field;
169 int chroma_420_type;
170 int progressive_frame;
171 int mpeg2;
172 int full_pel[2];
173 int interlaced_dct;
174 int last_qscale;
175 int first_slice;
176 } MpegEncContext;
177
178 extern const UINT8 zigzag_direct[64];
179
180 int MPV_common_init(MpegEncContext *s);
181 void MPV_common_end(MpegEncContext *s);
182 void MPV_decode_mb(MpegEncContext *s, DCTELEM block[6][64]);
183 void MPV_frame_start(MpegEncContext *s);
184 void MPV_frame_end(MpegEncContext *s);
185
186 /* motion_est.c */
187
188 int estimate_motion(MpegEncContext *s,
189 int mb_x, int mb_y,
190 int *mx_ptr, int *my_ptr);
191
192 /* mpeg12.c */
193 extern const UINT8 default_intra_matrix[64];
194 extern const UINT8 default_non_intra_matrix[64];
195
196 void mpeg1_encode_picture_header(MpegEncContext *s, int picture_number);
197 void mpeg1_encode_mb(MpegEncContext *s,
198 DCTELEM block[6][64],
199 int motion_x, int motion_y);
200
201 /* h263enc.c */
202
203 /* run length table */
204 #define MAX_RUN 64
205 #define MAX_LEVEL 64
206
207 typedef struct RLTable {
208 int n; /* number of entries of table_vlc minus 1 */
209 int last; /* number of values for last = 0 */
210 const UINT16 (*table_vlc)[2];
211 const INT8 *table_run;
212 const INT8 *table_level;
213 UINT8 *index_run[2]; /* encoding only */
214 INT8 *max_level[2]; /* encoding & decoding */
215 INT8 *max_run[2]; /* encoding & decoding */
216 VLC vlc; /* decoding only */
217 } RLTable;
218
219 void init_rl(RLTable *rl);
220 void init_vlc_rl(RLTable *rl);
221
222 extern inline int get_rl_index(const RLTable *rl, int last, int run, int level)
223 {
224 int index;
225 index = rl->index_run[last][run];
226 if (index >= rl->n)
227 return rl->n;
228 if (level > rl->max_level[last][run])
229 return rl->n;
230 return index + level - 1;
231 }
232
233 void h263_encode_mb(MpegEncContext *s,
234 DCTELEM block[6][64],
235 int motion_x, int motion_y);
236 void h263_encode_picture_header(MpegEncContext *s, int picture_number);
237 void h263_dc_scale(MpegEncContext *s);
238 INT16 *h263_pred_motion(MpegEncContext * s, int block,
239 int *px, int *py);
240 void mpeg4_pred_ac(MpegEncContext * s, INT16 *block, int n,
241 int dir);
242 void mpeg4_encode_picture_header(MpegEncContext *s, int picture_number);
243 void h263_encode_init_vlc(MpegEncContext *s);
244
245 void h263_decode_init_vlc(MpegEncContext *s);
246 int h263_decode_picture_header(MpegEncContext *s);
247 int mpeg4_decode_picture_header(MpegEncContext * s);
248 int intel_h263_decode_picture_header(MpegEncContext *s);
249 int h263_decode_mb(MpegEncContext *s,
250 DCTELEM block[6][64]);
251 int h263_get_picture_format(int width, int height);
252 extern UINT8 ff_alternate_horizontal_scan[64];
253 extern UINT8 ff_alternate_vertical_scan[64];
254
255 /* rv10.c */
256 void rv10_encode_picture_header(MpegEncContext *s, int picture_number);
257 int rv_decode_dc(MpegEncContext *s, int n);
258
259 /* msmpeg4.c */
260 void msmpeg4_encode_picture_header(MpegEncContext * s, int picture_number);
261 void msmpeg4_encode_mb(MpegEncContext * s,
262 DCTELEM block[6][64],
263 int motion_x, int motion_y);
264 void msmpeg4_dc_scale(MpegEncContext * s);
265 int msmpeg4_decode_picture_header(MpegEncContext * s);
266 int msmpeg4_decode_mb(MpegEncContext *s,
267 DCTELEM block[6][64]);
268 int msmpeg4_decode_init_vlc(MpegEncContext *s);
269
270 /* mjpegenc.c */
271
272 int mjpeg_init(MpegEncContext *s);
273 void mjpeg_close(MpegEncContext *s);
274 void mjpeg_encode_mb(MpegEncContext *s,
275 DCTELEM block[6][64]);
276 void mjpeg_picture_header(MpegEncContext *s);
277 void mjpeg_picture_trailer(MpegEncContext *s);