Merge commit 'e2ceb17642f374a7df8f1f5d3d2b2446525bc7fb'
[ffmpeg.git] / libavcodec / mpeg4video.h
1 /*
2  * MPEG4 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 // aspect_ratio_info
47 #define EXTENDED_PAR 15
48
49 //vol_sprite_usage / sprite_enable
50 #define STATIC_SPRITE 1
51 #define GMC_SPRITE 2
52
53 #define MOTION_MARKER 0x1F001
54 #define DC_MARKER     0x6B001
55
56 #define VOS_STARTCODE        0x1B0
57 #define USER_DATA_STARTCODE  0x1B2
58 #define GOP_STARTCODE        0x1B3
59 #define VISUAL_OBJ_STARTCODE 0x1B5
60 #define VOP_STARTCODE        0x1B6
61
62 typedef struct Mpeg4DecContext {
63     MpegEncContext m;
64
65     ///< number of bits to represent the fractional part of time
66     int time_increment_bits;
67     int shape;
68     int vol_sprite_usage;
69     // reversible vlc
70     int rvlc;
71     ///< could this stream contain resync markers
72     int resync_marker;
73 } Mpeg4DecContext;
74
75 /* dc encoding for mpeg4 */
76 extern const uint8_t ff_mpeg4_DCtab_lum[13][2];
77 extern const uint8_t ff_mpeg4_DCtab_chrom[13][2];
78
79 extern const uint16_t ff_mpeg4_intra_vlc[103][2];
80 extern const int8_t ff_mpeg4_intra_level[102];
81 extern const int8_t ff_mpeg4_intra_run[102];
82
83 extern RLTable ff_mpeg4_rl_intra;
84
85 /* Note this is identical to the intra rvlc except that it is reordered. */
86 extern RLTable ff_rvlc_rl_inter;
87 extern RLTable ff_rvlc_rl_intra;
88
89 extern const uint16_t ff_sprite_trajectory_tab[15][2];
90 extern const uint8_t ff_mb_type_b_tab[4][2];
91
92 /* these matrixes will be permuted for the idct */
93 extern const int16_t ff_mpeg4_default_intra_matrix[64];
94 extern const int16_t ff_mpeg4_default_non_intra_matrix[64];
95
96 extern const uint8_t ff_mpeg4_y_dc_scale_table[32];
97 extern const uint8_t ff_mpeg4_c_dc_scale_table[32];
98 extern const uint16_t ff_mpeg4_resync_prefix[8];
99
100 extern const uint8_t ff_mpeg4_dc_threshold[8];
101
102 void ff_mpeg4_encode_mb(MpegEncContext *s,
103                         int16_t block[6][64],
104                         int motion_x, int motion_y);
105 void ff_mpeg4_pred_ac(MpegEncContext *s, int16_t *block, int n,
106                       int dir);
107 void ff_set_mpeg4_time(MpegEncContext *s);
108 void ff_mpeg4_encode_picture_header(MpegEncContext *s, int picture_number);
109
110 int ff_mpeg4_decode_picture_header(Mpeg4DecContext *ctx, GetBitContext *gb);
111 void ff_mpeg4_encode_video_packet_header(MpegEncContext *s);
112 void ff_mpeg4_clean_buffers(MpegEncContext *s);
113 void ff_mpeg4_stuffing(PutBitContext *pbc);
114 void ff_mpeg4_init_partitions(MpegEncContext *s);
115 void ff_mpeg4_merge_partitions(MpegEncContext *s);
116 void ff_clean_mpeg4_qscales(MpegEncContext *s);
117 int ff_mpeg4_decode_partitions(Mpeg4DecContext *ctx);
118 int ff_mpeg4_get_video_packet_prefix_length(MpegEncContext *s);
119 int ff_mpeg4_decode_video_packet_header(Mpeg4DecContext *ctx);
120 void ff_mpeg4_init_direct_mv(MpegEncContext *s);
121 void ff_mpeg4videodec_static_init(void);
122 int ff_mpeg4_workaround_bugs(AVCodecContext *avctx);
123 int ff_mpeg4_frame_end(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
124
125 /**
126  *
127  * @return the mb_type
128  */
129 int ff_mpeg4_set_direct_mv(MpegEncContext *s, int mx, int my);
130
131 extern uint8_t ff_mpeg4_static_rl_table_store[3][2][2 * MAX_RUN + MAX_LEVEL + 3];
132
133 #if 0 //3IV1 is quite rare and it slows things down a tiny bit
134 #define IS_3IV1 s->codec_tag == AV_RL32("3IV1")
135 #else
136 #define IS_3IV1 0
137 #endif
138
139 /**
140  * Predict the dc.
141  * encoding quantized level -> quantized diff
142  * decoding quantized diff -> quantized level
143  * @param n block index (0-3 are luma, 4-5 are chroma)
144  * @param dir_ptr pointer to an integer where the prediction direction will be stored
145  */
146 static inline int ff_mpeg4_pred_dc(MpegEncContext *s, int n, int level,
147                                    int *dir_ptr, int encoding)
148 {
149     int a, b, c, wrap, pred, scale, ret;
150     int16_t *dc_val;
151
152     /* find prediction */
153     if (n < 4)
154         scale = s->y_dc_scale;
155     else
156         scale = s->c_dc_scale;
157     if (IS_3IV1)
158         scale = 8;
159
160     wrap   = s->block_wrap[n];
161     dc_val = s->dc_val[0] + s->block_index[n];
162
163     /* B C
164      * A X
165      */
166     a = dc_val[-1];
167     b = dc_val[-1 - wrap];
168     c = dc_val[-wrap];
169
170     /* outside slice handling (we can't do that by memset as we need the
171      * dc for error resilience) */
172     if (s->first_slice_line && n != 3) {
173         if (n != 2)
174             b = c = 1024;
175         if (n != 1 && s->mb_x == s->resync_mb_x)
176             b = a = 1024;
177     }
178     if (s->mb_x == s->resync_mb_x && s->mb_y == s->resync_mb_y + 1) {
179         if (n == 0 || n == 4 || n == 5)
180             b = 1024;
181     }
182
183     if (abs(a - b) < abs(b - c)) {
184         pred     = c;
185         *dir_ptr = 1; /* top */
186     } else {
187         pred     = a;
188         *dir_ptr = 0; /* left */
189     }
190     /* we assume pred is positive */
191     pred = FASTDIV((pred + (scale >> 1)), scale);
192
193     if (encoding) {
194         ret = level - pred;
195     } else {
196         level += pred;
197         ret    = level;
198         if (s->err_recognition & (AV_EF_BITSTREAM | AV_EF_AGGRESSIVE)) {
199             if (level < 0) {
200                 av_log(s->avctx, AV_LOG_ERROR,
201                        "dc<0 at %dx%d\n", s->mb_x, s->mb_y);
202                 return -1;
203             }
204             if (level * scale > 2048 + scale) {
205                 av_log(s->avctx, AV_LOG_ERROR,
206                        "dc overflow at %dx%d\n", s->mb_x, s->mb_y);
207                 return -1;
208             }
209         }
210     }
211     level *= scale;
212     if (level & (~2047)) {
213         if (level < 0)
214             level = 0;
215         else if (!(s->workaround_bugs & FF_BUG_DC_CLIP))
216             level = 2047;
217     }
218     dc_val[0] = level;
219
220     return ret;
221 }
222
223 #endif /* AVCODEC_MPEG4VIDEO_H */