mpeg4video: Add support for MPEG-4 Simple Studio Profile.
[ffmpeg.git] / libavcodec / mpeg4video.h
1 /*
2  * MPEG-4 encoder/decoder internal header.
3  * Copyright (c) 2000,2001 Fabrice Bellard
4  * Copyright (c) 2002-2010 Michael Niedermayer <michaelni@gmx.at>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef AVCODEC_MPEG4VIDEO_H
24 #define AVCODEC_MPEG4VIDEO_H
25
26 #include <stdint.h>
27
28 #include "get_bits.h"
29 #include "mpegvideo.h"
30 #include "rl.h"
31
32 // shapes
33 #define RECT_SHAPE       0
34 #define BIN_SHAPE        1
35 #define BIN_ONLY_SHAPE   2
36 #define GRAY_SHAPE       3
37
38 #define SIMPLE_VO_TYPE           1
39 #define CORE_VO_TYPE             3
40 #define MAIN_VO_TYPE             4
41 #define NBIT_VO_TYPE             5
42 #define ARTS_VO_TYPE            10
43 #define ACE_VO_TYPE             12
44 #define ADV_SIMPLE_VO_TYPE      17
45
46 #define VOT_VIDEO_ID 1
47 #define VOT_STILL_TEXTURE_ID 2
48
49 // aspect_ratio_info
50 #define EXTENDED_PAR 15
51
52 //vol_sprite_usage / sprite_enable
53 #define STATIC_SPRITE 1
54 #define GMC_SPRITE 2
55
56 #define MOTION_MARKER 0x1F001
57 #define DC_MARKER     0x6B001
58
59 #define VOS_STARTCODE        0x1B0
60 #define USER_DATA_STARTCODE  0x1B2
61 #define GOP_STARTCODE        0x1B3
62 #define VISUAL_OBJ_STARTCODE 0x1B5
63 #define VOP_STARTCODE        0x1B6
64 #define SLICE_STARTCODE      0x1B7
65 #define EXT_STARTCODE        0x1B8
66
67 #define QUANT_MATRIX_EXT_ID  0x3
68
69 /* smaller packets likely don't contain a real frame */
70 #define MAX_NVOP_SIZE 19
71
72 typedef struct Mpeg4DecContext {
73     MpegEncContext m;
74
75     /// number of bits to represent the fractional part of time
76     int time_increment_bits;
77     int shape;
78     int vol_sprite_usage;
79     int sprite_brightness_change;
80     int num_sprite_warping_points;
81     /// sprite trajectory points
82     uint16_t sprite_traj[4][2];
83     /// sprite shift [isChroma]
84     int sprite_shift[2];
85
86     // reversible vlc
87     int rvlc;
88     /// could this stream contain resync markers
89     int resync_marker;
90     /// time distance of first I -> B, used for interlaced B-frames
91     int t_frame;
92
93     int new_pred;
94     int enhancement_type;
95     int scalability;
96     int use_intra_dc_vlc;
97
98     /// QP above which the ac VLC should be used for intra dc
99     int intra_dc_threshold;
100
101     /* bug workarounds */
102     int divx_version;
103     int divx_build;
104     int xvid_build;
105     int lavc_build;
106
107     /// flag for having shown the warning about invalid Divx B-frames
108     int showed_packed_warning;
109     /** does the stream contain the low_delay flag,
110      *  used to work around buggy encoders. */
111     int vol_control_parameters;
112     int cplx_estimation_trash_i;
113     int cplx_estimation_trash_p;
114     int cplx_estimation_trash_b;
115
116     VLC studio_intra_tab[12];
117     VLC studio_luma_dc;
118     VLC studio_chroma_dc;
119
120     int rgb;
121 } Mpeg4DecContext;
122
123 static const uint8_t mpeg4_block_count[4] = {0, 6, 8, 12};
124
125 /* dc encoding for MPEG-4 */
126 extern const uint8_t ff_mpeg4_DCtab_lum[13][2];
127 extern const uint8_t ff_mpeg4_DCtab_chrom[13][2];
128
129 extern const uint16_t ff_mpeg4_intra_vlc[103][2];
130 extern const int8_t ff_mpeg4_intra_level[102];
131 extern const int8_t ff_mpeg4_intra_run[102];
132
133 extern RLTable ff_mpeg4_rl_intra;
134
135 /* Note this is identical to the intra rvlc except that it is reordered. */
136 extern RLTable ff_rvlc_rl_inter;
137 extern RLTable ff_rvlc_rl_intra;
138
139 extern const uint16_t ff_sprite_trajectory_tab[15][2];
140 extern const uint8_t ff_mb_type_b_tab[4][2];
141
142 /* these matrixes will be permuted for the idct */
143 extern const int16_t ff_mpeg4_default_intra_matrix[64];
144 extern const int16_t ff_mpeg4_default_non_intra_matrix[64];
145
146 extern const uint8_t ff_mpeg4_y_dc_scale_table[32];
147 extern const uint8_t ff_mpeg4_c_dc_scale_table[32];
148 extern const uint16_t ff_mpeg4_resync_prefix[8];
149
150 extern const uint8_t ff_mpeg4_dc_threshold[8];
151
152 extern const uint16_t ff_mpeg4_studio_dc_luma[19][2];
153 extern const uint16_t ff_mpeg4_studio_dc_chroma[19][2];
154 extern const uint16_t ff_mpeg4_studio_intra[12][22][2];
155
156 void ff_mpeg4_encode_mb(MpegEncContext *s,
157                         int16_t block[6][64],
158                         int motion_x, int motion_y);
159 void ff_mpeg4_pred_ac(MpegEncContext *s, int16_t *block, int n,
160                       int dir);
161 void ff_set_mpeg4_time(MpegEncContext *s);
162 int ff_mpeg4_encode_picture_header(MpegEncContext *s, int picture_number);
163
164 int ff_mpeg4_decode_picture_header(Mpeg4DecContext *ctx, GetBitContext *gb);
165 void ff_mpeg4_encode_video_packet_header(MpegEncContext *s);
166 void ff_mpeg4_clean_buffers(MpegEncContext *s);
167 void ff_mpeg4_stuffing(PutBitContext *pbc);
168 void ff_mpeg4_init_partitions(MpegEncContext *s);
169 void ff_mpeg4_merge_partitions(MpegEncContext *s);
170 void ff_clean_mpeg4_qscales(MpegEncContext *s);
171 int ff_mpeg4_decode_partitions(Mpeg4DecContext *ctx);
172 int ff_mpeg4_get_video_packet_prefix_length(MpegEncContext *s);
173 int ff_mpeg4_decode_video_packet_header(Mpeg4DecContext *ctx);
174 int ff_mpeg4_decode_studio_slice_header(Mpeg4DecContext *ctx);
175 void ff_mpeg4_init_direct_mv(MpegEncContext *s);
176 void ff_mpeg4videodec_static_init(void);
177 int ff_mpeg4_workaround_bugs(AVCodecContext *avctx);
178 int ff_mpeg4_frame_end(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
179
180 /**
181  * @return the mb_type
182  */
183 int ff_mpeg4_set_direct_mv(MpegEncContext *s, int mx, int my);
184
185 extern uint8_t ff_mpeg4_static_rl_table_store[3][2][2 * MAX_RUN + MAX_LEVEL + 3];
186
187 #if 0 //3IV1 is quite rare and it slows things down a tiny bit
188 #define IS_3IV1 s->codec_tag == AV_RL32("3IV1")
189 #else
190 #define IS_3IV1 0
191 #endif
192
193 /**
194  * Predict the dc.
195  * encoding quantized level -> quantized diff
196  * decoding quantized diff -> quantized level
197  * @param n block index (0-3 are luma, 4-5 are chroma)
198  * @param dir_ptr pointer to an integer where the prediction direction will be stored
199  */
200 static inline int ff_mpeg4_pred_dc(MpegEncContext *s, int n, int level,
201                                    int *dir_ptr, int encoding)
202 {
203     int a, b, c, wrap, pred, scale, ret;
204     int16_t *dc_val;
205
206     /* find prediction */
207     if (n < 4)
208         scale = s->y_dc_scale;
209     else
210         scale = s->c_dc_scale;
211     if (IS_3IV1)
212         scale = 8;
213
214     wrap   = s->block_wrap[n];
215     dc_val = s->dc_val[0] + s->block_index[n];
216
217     /* B C
218      * A X
219      */
220     a = dc_val[-1];
221     b = dc_val[-1 - wrap];
222     c = dc_val[-wrap];
223
224     /* outside slice handling (we can't do that by memset as we need the
225      * dc for error resilience) */
226     if (s->first_slice_line && n != 3) {
227         if (n != 2)
228             b = c = 1024;
229         if (n != 1 && s->mb_x == s->resync_mb_x)
230             b = a = 1024;
231     }
232     if (s->mb_x == s->resync_mb_x && s->mb_y == s->resync_mb_y + 1) {
233         if (n == 0 || n == 4 || n == 5)
234             b = 1024;
235     }
236
237     if (abs(a - b) < abs(b - c)) {
238         pred     = c;
239         *dir_ptr = 1; /* top */
240     } else {
241         pred     = a;
242         *dir_ptr = 0; /* left */
243     }
244     /* we assume pred is positive */
245     pred = FASTDIV((pred + (scale >> 1)), scale);
246
247     if (encoding) {
248         ret = level - pred;
249     } else {
250         level += pred;
251         ret    = level;
252     }
253     level *= scale;
254     if (level & (~2047)) {
255         if (!s->encoding && (s->avctx->err_recognition & (AV_EF_BITSTREAM | AV_EF_AGGRESSIVE))) {
256             if (level < 0) {
257                 av_log(s->avctx, AV_LOG_ERROR,
258                        "dc<0 at %dx%d\n", s->mb_x, s->mb_y);
259                 return AVERROR_INVALIDDATA;
260             }
261             if (level > 2048 + scale) {
262                 av_log(s->avctx, AV_LOG_ERROR,
263                        "dc overflow at %dx%d\n", s->mb_x, s->mb_y);
264                 return AVERROR_INVALIDDATA;
265             }
266         }
267         if (level < 0)
268             level = 0;
269         else if (!(s->workaround_bugs & FF_BUG_DC_CLIP))
270             level = 2047;
271     }
272     dc_val[0] = level;
273
274     return ret;
275 }
276
277 #endif /* AVCODEC_MPEG4VIDEO_H */