lavc: set defaults in internal codec frames
[ffmpeg.git] / libavcodec / eatgv.c
1 /*
2  * Electronic Arts TGV Video Decoder
3  * Copyright (c) 2007-2008 Peter Ross
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 /**
23  * @file
24  * Electronic Arts TGV Video Decoder
25  * by Peter Ross (pross@xvid.org)
26  *
27  * Technical details here:
28  * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_TGV
29  */
30
31 #include "avcodec.h"
32 #define ALT_BITSTREAM_READER_LE
33 #include "get_bits.h"
34 #include "libavutil/lzo.h"
35 #include "libavutil/imgutils.h"
36
37 #define EA_PREAMBLE_SIZE    8
38 #define kVGT_TAG MKTAG('k', 'V', 'G', 'T')
39
40 typedef struct TgvContext {
41     AVCodecContext *avctx;
42     AVFrame frame;
43     AVFrame last_frame;
44     int width,height;
45     unsigned int palette[AVPALETTE_COUNT];
46
47     int (*mv_codebook)[2];
48     unsigned char (*block_codebook)[16];
49     int num_mvs;           ///< current length of mv_codebook
50     int num_blocks_packed; ///< current length of block_codebook
51 } TgvContext;
52
53 static av_cold int tgv_decode_init(AVCodecContext *avctx){
54     TgvContext *s = avctx->priv_data;
55     s->avctx = avctx;
56     avctx->time_base = (AVRational){1, 15};
57     avctx->pix_fmt = PIX_FMT_PAL8;
58     avcodec_get_frame_defaults(&s->frame);
59     avcodec_get_frame_defaults(&s->last_frame);
60     return 0;
61 }
62
63 /**
64  * Unpack buffer
65  * @return 0 on success, -1 on critical buffer underflow
66  */
67 static int unpack(const uint8_t *src, const uint8_t *src_end, unsigned char *dst, int width, int height) {
68     unsigned char *dst_end = dst + width*height;
69     int size, size1, size2, av_uninit(offset), run;
70     unsigned char *dst_start = dst;
71
72     if (src[0] & 0x01)
73         src += 5;
74     else
75         src += 2;
76
77     if (src+3>src_end)
78         return -1;
79     size = AV_RB24(src);
80     src += 3;
81
82     while(size>0 && src<src_end) {
83
84         /* determine size1 and size2 */
85         size1 = (src[0] & 3);
86         if ( src[0] & 0x80 ) {  // 1
87             if (src[0] & 0x40 ) {  // 11
88                 if ( src[0] & 0x20 ) {  // 111
89                     if ( src[0] < 0xFC )  // !(111111)
90                         size1 = (((src[0] & 31) + 1) << 2);
91                     src++;
92                     size2 = 0;
93                 } else {  // 110
94                     offset = ((src[0] & 0x10) << 12) + AV_RB16(&src[1]) + 1;
95                     size2 = ((src[0] & 0xC) << 6) + src[3] + 5;
96                     src += 4;
97                 }
98             } else {  // 10
99                 size1 = ( ( src[1] & 0xC0) >> 6 );
100                 offset = (AV_RB16(&src[1]) & 0x3FFF) + 1;
101                 size2 = (src[0] & 0x3F) + 4;
102                 src += 3;
103             }
104         } else {  // 0
105             offset = ((src[0] & 0x60) << 3) + src[1] + 1;
106             size2 = ((src[0] & 0x1C) >> 2) + 3;
107             src += 2;
108         }
109
110
111         /* fetch strip from src */
112         if (size1>src_end-src)
113             break;
114
115         if (size1>0) {
116             size -= size1;
117             run = FFMIN(size1, dst_end-dst);
118             memcpy(dst, src, run);
119             dst += run;
120             src += run;
121         }
122
123         if (size2>0) {
124             if (dst-dst_start<offset)
125                 return 0;
126             size -= size2;
127             run = FFMIN(size2, dst_end-dst);
128             av_memcpy_backptr(dst, offset, run);
129             dst += run;
130         }
131     }
132
133     return 0;
134 }
135
136 /**
137  * Decode inter-frame
138  * @return 0 on success, -1 on critical buffer underflow
139  */
140 static int tgv_decode_inter(TgvContext * s, const uint8_t *buf, const uint8_t *buf_end){
141     unsigned char *frame0_end = s->last_frame.data[0] + s->avctx->width*s->last_frame.linesize[0];
142     int num_mvs;
143     int num_blocks_raw;
144     int num_blocks_packed;
145     int vector_bits;
146     int i,j,x,y;
147     GetBitContext gb;
148     int mvbits;
149     const unsigned char *blocks_raw;
150
151     if(buf+12>buf_end)
152         return -1;
153
154     num_mvs           = AV_RL16(&buf[0]);
155     num_blocks_raw    = AV_RL16(&buf[2]);
156     num_blocks_packed = AV_RL16(&buf[4]);
157     vector_bits       = AV_RL16(&buf[6]);
158     buf += 12;
159
160     /* allocate codebook buffers as neccessary */
161     if (num_mvs > s->num_mvs) {
162         s->mv_codebook = av_realloc(s->mv_codebook, num_mvs*2*sizeof(int));
163         s->num_mvs = num_mvs;
164     }
165
166     if (num_blocks_packed > s->num_blocks_packed) {
167         s->block_codebook = av_realloc(s->block_codebook, num_blocks_packed*16*sizeof(unsigned char));
168         s->num_blocks_packed = num_blocks_packed;
169     }
170
171     /* read motion vectors */
172     mvbits = (num_mvs*2*10+31) & ~31;
173
174     if (buf+(mvbits>>3)+16*num_blocks_raw+8*num_blocks_packed>buf_end)
175         return -1;
176
177     init_get_bits(&gb, buf, mvbits);
178     for (i=0; i<num_mvs; i++) {
179         s->mv_codebook[i][0] = get_sbits(&gb, 10);
180         s->mv_codebook[i][1] = get_sbits(&gb, 10);
181     }
182     buf += mvbits>>3;
183
184     /* note ptr to uncompressed blocks */
185     blocks_raw = buf;
186     buf += num_blocks_raw*16;
187
188     /* read compressed blocks */
189     init_get_bits(&gb, buf, (buf_end-buf)<<3);
190     for (i=0; i<num_blocks_packed; i++) {
191         int tmp[4];
192         for(j=0; j<4; j++)
193             tmp[j] = get_bits(&gb, 8);
194         for(j=0; j<16; j++)
195             s->block_codebook[i][15-j] = tmp[get_bits(&gb, 2)];
196     }
197
198     if (get_bits_left(&gb) < vector_bits *
199         (s->avctx->height/4) * (s->avctx->width/4))
200         return -1;
201
202     /* read vectors and build frame */
203     for(y=0; y<s->avctx->height/4; y++)
204     for(x=0; x<s->avctx->width/4; x++) {
205         unsigned int vector = get_bits(&gb, vector_bits);
206         const unsigned char *src;
207         int src_stride;
208
209         if (vector < num_mvs) {
210             src = s->last_frame.data[0] +
211                   (y*4 + s->mv_codebook[vector][1])*s->last_frame.linesize[0] +
212                    x*4 + s->mv_codebook[vector][0];
213             src_stride = s->last_frame.linesize[0];
214             if (src+3*src_stride+3>=frame0_end)
215                 continue;
216         }else{
217             int offset = vector - num_mvs;
218             if (offset<num_blocks_raw)
219                 src = blocks_raw + 16*offset;
220             else if (offset-num_blocks_raw<num_blocks_packed)
221                 src = s->block_codebook[offset-num_blocks_raw];
222             else
223                 continue;
224             src_stride = 4;
225         }
226
227         for(j=0; j<4; j++)
228         for(i=0; i<4; i++)
229             s->frame.data[0][ (y*4+j)*s->frame.linesize[0] + (x*4+i)  ] =
230                src[j*src_stride + i];
231     }
232
233     return 0;
234 }
235
236 /** release AVFrame buffers if allocated */
237 static void cond_release_buffer(AVFrame *pic)
238 {
239     if (pic->data[0]) {
240         av_freep(&pic->data[0]);
241         av_free(pic->data[1]);
242     }
243 }
244
245 static int tgv_decode_frame(AVCodecContext *avctx,
246                             void *data, int *data_size,
247                             AVPacket *avpkt)
248 {
249     const uint8_t *buf = avpkt->data;
250     int buf_size = avpkt->size;
251     TgvContext *s = avctx->priv_data;
252     const uint8_t *buf_end = buf + buf_size;
253     int chunk_type;
254
255     chunk_type = AV_RL32(&buf[0]);
256     buf += EA_PREAMBLE_SIZE;
257
258     if (chunk_type==kVGT_TAG) {
259         int pal_count, i;
260         if(buf+12>buf_end) {
261             av_log(avctx, AV_LOG_WARNING, "truncated header\n");
262             return -1;
263         }
264
265         s->width  = AV_RL16(&buf[0]);
266         s->height = AV_RL16(&buf[2]);
267         if (s->avctx->width!=s->width || s->avctx->height!=s->height) {
268             avcodec_set_dimensions(s->avctx, s->width, s->height);
269             cond_release_buffer(&s->frame);
270             cond_release_buffer(&s->last_frame);
271         }
272
273         pal_count = AV_RL16(&buf[6]);
274         buf += 12;
275         for(i=0; i<pal_count && i<AVPALETTE_COUNT && buf+2<buf_end; i++) {
276             s->palette[i] = AV_RB24(buf);
277             buf += 3;
278         }
279     }
280
281     if (av_image_check_size(s->width, s->height, 0, avctx))
282         return -1;
283
284     /* shuffle */
285     FFSWAP(AVFrame, s->frame, s->last_frame);
286     if (!s->frame.data[0]) {
287         s->frame.reference = 1;
288         s->frame.buffer_hints = FF_BUFFER_HINTS_VALID;
289         s->frame.linesize[0] = s->width;
290
291         /* allocate additional 12 bytes to accomodate av_memcpy_backptr() OUTBUF_PADDED optimisation */
292         s->frame.data[0] = av_malloc(s->width*s->height + 12);
293         if (!s->frame.data[0])
294             return AVERROR(ENOMEM);
295         s->frame.data[1] = av_malloc(AVPALETTE_SIZE);
296         if (!s->frame.data[1]) {
297             av_freep(&s->frame.data[0]);
298             return AVERROR(ENOMEM);
299         }
300     }
301     memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
302
303     if(chunk_type==kVGT_TAG) {
304         s->frame.key_frame = 1;
305         s->frame.pict_type = AV_PICTURE_TYPE_I;
306         if (unpack(buf, buf_end, s->frame.data[0], s->avctx->width, s->avctx->height)<0) {
307             av_log(avctx, AV_LOG_WARNING, "truncated intra frame\n");
308             return -1;
309         }
310     }else{
311         if (!s->last_frame.data[0]) {
312             av_log(avctx, AV_LOG_WARNING, "inter frame without corresponding intra frame\n");
313             return buf_size;
314         }
315         s->frame.key_frame = 0;
316         s->frame.pict_type = AV_PICTURE_TYPE_P;
317         if (tgv_decode_inter(s, buf, buf_end)<0) {
318             av_log(avctx, AV_LOG_WARNING, "truncated inter frame\n");
319             return -1;
320         }
321     }
322
323     *data_size = sizeof(AVFrame);
324     *(AVFrame*)data = s->frame;
325
326     return buf_size;
327 }
328
329 static av_cold int tgv_decode_end(AVCodecContext *avctx)
330 {
331     TgvContext *s = avctx->priv_data;
332     cond_release_buffer(&s->frame);
333     cond_release_buffer(&s->last_frame);
334     av_free(s->mv_codebook);
335     av_free(s->block_codebook);
336     return 0;
337 }
338
339 AVCodec ff_eatgv_decoder = {
340     "eatgv",
341     AVMEDIA_TYPE_VIDEO,
342     CODEC_ID_TGV,
343     sizeof(TgvContext),
344     tgv_decode_init,
345     NULL,
346     tgv_decode_end,
347     tgv_decode_frame,
348     .long_name = NULL_IF_CONFIG_SMALL("Electronic Arts TGV video"),
349 };