avcodec/mpeg4videodec: Use more specific error codes
[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
65 /* smaller packets likely don't contain a real frame */
66 #define MAX_NVOP_SIZE 19
67
68 typedef struct Mpeg4DecContext {
69     MpegEncContext m;
70
71     /// number of bits to represent the fractional part of time
72     int time_increment_bits;
73     int shape;
74     int vol_sprite_usage;
75     int sprite_brightness_change;
76     int num_sprite_warping_points;
77     /// sprite trajectory points
78     uint16_t sprite_traj[4][2];
79     /// sprite shift [isChroma]
80     int sprite_shift[2];
81
82     // reversible vlc
83     int rvlc;
84     /// could this stream contain resync markers
85     int resync_marker;
86     /// time distance of first I -> B, used for interlaced B-frames
87     int t_frame;
88
89     int new_pred;
90     int enhancement_type;
91     int scalability;
92     int use_intra_dc_vlc;
93
94     /// QP above which the ac VLC should be used for intra dc
95     int intra_dc_threshold;
96
97     /* bug workarounds */
98     int divx_version;
99     int divx_build;
100     int xvid_build;
101     int lavc_build;
102
103     /// flag for having shown the warning about invalid Divx B-frames
104     int showed_packed_warning;
105     /** does the stream contain the low_delay flag,
106      *  used to work around buggy encoders. */
107     int vol_control_parameters;
108     int cplx_estimation_trash_i;
109     int cplx_estimation_trash_p;
110     int cplx_estimation_trash_b;
111 } Mpeg4DecContext;
112
113 /* dc encoding for MPEG-4 */
114 extern const uint8_t ff_mpeg4_DCtab_lum[13][2];
115 extern const uint8_t ff_mpeg4_DCtab_chrom[13][2];
116
117 extern const uint16_t ff_mpeg4_intra_vlc[103][2];
118 extern const int8_t ff_mpeg4_intra_level[102];
119 extern const int8_t ff_mpeg4_intra_run[102];
120
121 extern RLTable ff_mpeg4_rl_intra;
122
123 /* Note this is identical to the intra rvlc except that it is reordered. */
124 extern RLTable ff_rvlc_rl_inter;
125 extern RLTable ff_rvlc_rl_intra;
126
127 extern const uint16_t ff_sprite_trajectory_tab[15][2];
128 extern const uint8_t ff_mb_type_b_tab[4][2];
129
130 /* these matrixes will be permuted for the idct */
131 extern const int16_t ff_mpeg4_default_intra_matrix[64];
132 extern const int16_t ff_mpeg4_default_non_intra_matrix[64];
133
134 extern const uint8_t ff_mpeg4_y_dc_scale_table[32];
135 extern const uint8_t ff_mpeg4_c_dc_scale_table[32];
136 extern const uint16_t ff_mpeg4_resync_prefix[8];
137
138 extern const uint8_t ff_mpeg4_dc_threshold[8];
139
140 void ff_mpeg4_encode_mb(MpegEncContext *s,
141                         int16_t block[6][64],
142                         int motion_x, int motion_y);
143 void ff_mpeg4_pred_ac(MpegEncContext *s, int16_t *block, int n,
144                       int dir);
145 void ff_set_mpeg4_time(MpegEncContext *s);
146 int ff_mpeg4_encode_picture_header(MpegEncContext *s, int picture_number);
147
148 int ff_mpeg4_decode_picture_header(Mpeg4DecContext *ctx, GetBitContext *gb);
149 void ff_mpeg4_encode_video_packet_header(MpegEncContext *s);
150 void ff_mpeg4_clean_buffers(MpegEncContext *s);
151 void ff_mpeg4_stuffing(PutBitContext *pbc);
152 void ff_mpeg4_init_partitions(MpegEncContext *s);
153 void ff_mpeg4_merge_partitions(MpegEncContext *s);
154 void ff_clean_mpeg4_qscales(MpegEncContext *s);
155 int ff_mpeg4_decode_partitions(Mpeg4DecContext *ctx);
156 int ff_mpeg4_get_video_packet_prefix_length(MpegEncContext *s);
157 int ff_mpeg4_decode_video_packet_header(Mpeg4DecContext *ctx);
158 void ff_mpeg4_init_direct_mv(MpegEncContext *s);
159 void ff_mpeg4videodec_static_init(void);
160 int ff_mpeg4_workaround_bugs(AVCodecContext *avctx);
161 int ff_mpeg4_frame_end(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
162
163 /**
164  * @return the mb_type
165  */
166 int ff_mpeg4_set_direct_mv(MpegEncContext *s, int mx, int my);
167
168 extern uint8_t ff_mpeg4_static_rl_table_store[3][2][2 * MAX_RUN + MAX_LEVEL + 3];
169
170 #if 0 //3IV1 is quite rare and it slows things down a tiny bit
171 #define IS_3IV1 s->codec_tag == AV_RL32("3IV1")
172 #else
173 #define IS_3IV1 0
174 #endif
175
176 /**
177  * Predict the dc.
178  * encoding quantized level -> quantized diff
179  * decoding quantized diff -> quantized level
180  * @param n block index (0-3 are luma, 4-5 are chroma)
181  * @param dir_ptr pointer to an integer where the prediction direction will be stored
182  */
183 static inline int ff_mpeg4_pred_dc(MpegEncContext *s, int n, int level,
184                                    int *dir_ptr, int encoding)
185 {
186     int a, b, c, wrap, pred, scale, ret;
187     int16_t *dc_val;
188
189     /* find prediction */
190     if (n < 4)
191         scale = s->y_dc_scale;
192     else
193         scale = s->c_dc_scale;
194     if (IS_3IV1)
195         scale = 8;
196
197     wrap   = s->block_wrap[n];
198     dc_val = s->dc_val[0] + s->block_index[n];
199
200     /* B C
201      * A X
202      */
203     a = dc_val[-1];
204     b = dc_val[-1 - wrap];
205     c = dc_val[-wrap];
206
207     /* outside slice handling (we can't do that by memset as we need the
208      * dc for error resilience) */
209     if (s->first_slice_line && n != 3) {
210         if (n != 2)
211             b = c = 1024;
212         if (n != 1 && s->mb_x == s->resync_mb_x)
213             b = a = 1024;
214     }
215     if (s->mb_x == s->resync_mb_x && s->mb_y == s->resync_mb_y + 1) {
216         if (n == 0 || n == 4 || n == 5)
217             b = 1024;
218     }
219
220     if (abs(a - b) < abs(b - c)) {
221         pred     = c;
222         *dir_ptr = 1; /* top */
223     } else {
224         pred     = a;
225         *dir_ptr = 0; /* left */
226     }
227     /* we assume pred is positive */
228     pred = FASTDIV((pred + (scale >> 1)), scale);
229
230     if (encoding) {
231         ret = level - pred;
232     } else {
233         level += pred;
234         ret    = level;
235     }
236     level *= scale;
237     if (level & (~2047)) {
238         if (!s->encoding && (s->avctx->err_recognition & (AV_EF_BITSTREAM | AV_EF_AGGRESSIVE))) {
239             if (level < 0) {
240                 av_log(s->avctx, AV_LOG_ERROR,
241                        "dc<0 at %dx%d\n", s->mb_x, s->mb_y);
242                 return AVERROR_INVALIDDATA;
243             }
244             if (level > 2048 + scale) {
245                 av_log(s->avctx, AV_LOG_ERROR,
246                        "dc overflow at %dx%d\n", s->mb_x, s->mb_y);
247                 return AVERROR_INVALIDDATA;
248             }
249         }
250         if (level < 0)
251             level = 0;
252         else if (!(s->workaround_bugs & FF_BUG_DC_CLIP))
253             level = 2047;
254     }
255     dc_val[0] = level;
256
257     return ret;
258 }
259
260 #endif /* AVCODEC_MPEG4VIDEO_H */