Correct support for Fraps v4 (and Huffman tree for < 256 symbols)
[ffmpeg.git] / libavcodec / fraps.c
1 /*
2  * Fraps FPS1 decoder
3  * Copyright (c) 2005 Roine Gustafsson
4  * Copyright (c) 2006 Konstantin Shishkov
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
24 /**
25  * @file fraps.c
26  * Lossless Fraps 'FPS1' decoder
27  * @author Roine Gustafsson <roine at users sf net>
28  * @author Konstantin Shishkov
29  *
30  * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
31  *
32  * Version 2 files support by Konstantin Shishkov
33  */
34
35 #include "avcodec.h"
36 #include "bitstream.h"
37 #include "dsputil.h"
38
39 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
40
41 /* symbol for Huffman tree node */
42 #define HNODE -1
43
44 /**
45  * Huffman node
46  * FIXME one day this should belong to one general framework
47  */
48 typedef struct Node{
49     int16_t sym;
50     int16_t n0;
51     int count;
52 }Node;
53
54 /**
55  * local variable storage
56  */
57 typedef struct FrapsContext{
58     AVCodecContext *avctx;
59     AVFrame frame;
60     Node nodes[512];
61     uint8_t *tmpbuf;
62     DSPContext dsp;
63 } FrapsContext;
64
65
66 /**
67  * initializes decoder
68  * @param avctx codec context
69  * @return 0 on success or negative if fails
70  */
71 static int decode_init(AVCodecContext *avctx)
72 {
73     FrapsContext * const s = avctx->priv_data;
74
75     avctx->coded_frame = (AVFrame*)&s->frame;
76     avctx->has_b_frames = 0;
77     avctx->pix_fmt= PIX_FMT_NONE; /* set in decode_frame */
78
79     s->avctx = avctx;
80     s->frame.data[0] = NULL;
81     s->tmpbuf = NULL;
82
83     dsputil_init(&s->dsp, avctx);
84
85     return 0;
86 }
87
88 /**
89  * Comparator - our nodes should ascend by count
90  * but with preserved symbol order
91  */
92 static int huff_cmp(const Node *a, const Node *b){
93     return (a->count - b->count)*256 + a->sym - b->sym;
94 }
95
96 static void get_tree_codes(uint32_t *bits, int16_t *lens, uint8_t *xlat, Node *nodes, int node, uint32_t pfx, int pl, int *pos)
97 {
98     int s;
99
100     s = nodes[node].sym;
101     if(s != HNODE || !nodes[node].count){
102         bits[*pos] = pfx;
103         lens[*pos] = pl;
104         xlat[*pos] = s;
105         (*pos)++;
106     }else{
107         pfx <<= 1;
108         pl++;
109         get_tree_codes(bits, lens, xlat, nodes, nodes[node].n0, pfx, pl, pos);
110         pfx |= 1;
111         get_tree_codes(bits, lens, xlat, nodes, nodes[node].n0+1, pfx, pl, pos);
112     }
113 }
114
115 static int build_huff_tree(VLC *vlc, Node *nodes, uint8_t *xlat)
116 {
117     uint32_t bits[256];
118     int16_t lens[256];
119     int pos = 0;
120
121     get_tree_codes(bits, lens, xlat, nodes, 510, 0, 0, &pos);
122     return init_vlc(vlc, 9, pos, lens, 2, 2, bits, 4, 4, 0);
123 }
124
125
126 /**
127  * decode Fraps v2 packed plane
128  */
129 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
130                                int h, uint8_t *src, int size, int Uoff)
131 {
132     int i, j;
133     int cur_node;
134     GetBitContext gb;
135     VLC vlc;
136     int64_t sum = 0;
137     uint8_t recode[256];
138
139     for(i = 0; i < 256; i++){
140         s->nodes[i].sym = i;
141         s->nodes[i].count = LE_32(src);
142         s->nodes[i].n0 = -2;
143         src += 4;
144         sum += s->nodes[i].count;
145     }
146     size -= 1024;
147
148     if(sum >> 31) {
149         av_log(s->avctx, AV_LOG_ERROR, "Too high symbol frequencies. Tree construction is not possible\n");
150         return -1;
151     }
152     qsort(s->nodes, 256, sizeof(Node), huff_cmp);
153     cur_node = 256;
154     for(i = 0; i < 511; i += 2){
155         s->nodes[cur_node].sym = HNODE;
156         s->nodes[cur_node].count = s->nodes[i].count + s->nodes[i+1].count;
157         s->nodes[cur_node].n0 = i;
158         for(j = cur_node; j > 0; j--){
159             if(s->nodes[j].count >= s->nodes[j - 1].count) break;
160             FFSWAP(Node, s->nodes[j], s->nodes[j - 1]);
161         }
162         cur_node++;
163     }
164     if(build_huff_tree(&vlc, s->nodes, recode) < 0){
165         av_log(s->avctx, AV_LOG_ERROR, "Error building tree\n");
166         return -1;
167     }
168     /* we have built Huffman table and are ready to decode plane */
169
170     /* convert bits so they may be used by standard bitreader */
171     s->dsp.bswap_buf(s->tmpbuf, src, size >> 2);
172
173     init_get_bits(&gb, s->tmpbuf, size * 8);
174     for(j = 0; j < h; j++){
175         for(i = 0; i < w; i++){
176             dst[i] = recode[get_vlc2(&gb, vlc.table, 9, 3)];
177             /* lines are stored as deltas between previous lines
178              * and we need to add 0x80 to the first lines of chroma planes
179              */
180             if(j) dst[i] += dst[i - stride];
181             else if(Uoff) dst[i] += 0x80;
182         }
183         dst += stride;
184     }
185     free_vlc(&vlc);
186     return 0;
187 }
188
189 /**
190  * decode a frame
191  * @param avctx codec context
192  * @param data output AVFrame
193  * @param data_size size of output data or 0 if no picture is returned
194  * @param buf input data frame
195  * @param buf_size size of input data frame
196  * @return number of consumed bytes on success or negative if decode fails
197  */
198 static int decode_frame(AVCodecContext *avctx,
199                         void *data, int *data_size,
200                         uint8_t *buf, int buf_size)
201 {
202     FrapsContext * const s = avctx->priv_data;
203     AVFrame *frame = data;
204     AVFrame * const f = (AVFrame*)&s->frame;
205     uint32_t header;
206     unsigned int version,header_size;
207     unsigned int x, y;
208     uint32_t *buf32;
209     uint32_t *luma1,*luma2,*cb,*cr;
210     uint32_t offs[4];
211     int i, is_chroma, planes;
212
213
214     header = LE_32(buf);
215     version = header & 0xff;
216     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
217
218     if (version > 2 && version != 4) {
219         av_log(avctx, AV_LOG_ERROR,
220                "This file is encoded with Fraps version %d. " \
221                "This codec can only decode version 0, 1, 2 and 4.\n", version);
222         return -1;
223     }
224
225     buf+=4;
226     if (header_size == 8)
227         buf+=4;
228
229     switch(version) {
230     case 0:
231     default:
232         /* Fraps v0 is a reordered YUV420 */
233         avctx->pix_fmt = PIX_FMT_YUV420P;
234
235         if ( (buf_size != avctx->width*avctx->height*3/2+header_size) &&
236              (buf_size != header_size) ) {
237             av_log(avctx, AV_LOG_ERROR,
238                    "Invalid frame length %d (should be %d)\n",
239                    buf_size, avctx->width*avctx->height*3/2+header_size);
240             return -1;
241         }
242
243         if (( (avctx->width % 8) != 0) || ( (avctx->height % 2) != 0 )) {
244             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
245                    avctx->width, avctx->height);
246             return -1;
247         }
248
249         f->reference = 1;
250         f->buffer_hints = FF_BUFFER_HINTS_VALID |
251                           FF_BUFFER_HINTS_PRESERVE |
252                           FF_BUFFER_HINTS_REUSABLE;
253         if (avctx->reget_buffer(avctx, f)) {
254             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
255             return -1;
256         }
257         /* bit 31 means same as previous pic */
258         f->pict_type = (header & (1<<31))? FF_P_TYPE : FF_I_TYPE;
259         f->key_frame = f->pict_type == FF_I_TYPE;
260
261         if (f->pict_type == FF_I_TYPE) {
262             buf32=(uint32_t*)buf;
263             for(y=0; y<avctx->height/2; y++){
264                 luma1=(uint32_t*)&f->data[0][ y*2*f->linesize[0] ];
265                 luma2=(uint32_t*)&f->data[0][ (y*2+1)*f->linesize[0] ];
266                 cr=(uint32_t*)&f->data[1][ y*f->linesize[1] ];
267                 cb=(uint32_t*)&f->data[2][ y*f->linesize[2] ];
268                 for(x=0; x<avctx->width; x+=8){
269                     *(luma1++) = *(buf32++);
270                     *(luma1++) = *(buf32++);
271                     *(luma2++) = *(buf32++);
272                     *(luma2++) = *(buf32++);
273                     *(cr++) = *(buf32++);
274                     *(cb++) = *(buf32++);
275                 }
276             }
277         }
278         break;
279
280     case 1:
281         /* Fraps v1 is an upside-down BGR24 */
282         avctx->pix_fmt = PIX_FMT_BGR24;
283
284         if ( (buf_size != avctx->width*avctx->height*3+header_size) &&
285              (buf_size != header_size) ) {
286             av_log(avctx, AV_LOG_ERROR,
287                    "Invalid frame length %d (should be %d)\n",
288                    buf_size, avctx->width*avctx->height*3+header_size);
289             return -1;
290         }
291
292         f->reference = 1;
293         f->buffer_hints = FF_BUFFER_HINTS_VALID |
294                           FF_BUFFER_HINTS_PRESERVE |
295                           FF_BUFFER_HINTS_REUSABLE;
296         if (avctx->reget_buffer(avctx, f)) {
297             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
298             return -1;
299         }
300         /* bit 31 means same as previous pic */
301         f->pict_type = (header & (1<<31))? FF_P_TYPE : FF_I_TYPE;
302         f->key_frame = f->pict_type == FF_I_TYPE;
303
304         if (f->pict_type == FF_I_TYPE) {
305             for(y=0; y<avctx->height; y++)
306                 memcpy(&f->data[0][ (avctx->height-y)*f->linesize[0] ],
307                        &buf[y*avctx->width*3],
308                        f->linesize[0]);
309         }
310         break;
311
312     case 2:
313     case 4:
314         /**
315          * Fraps v2 is Huffman-coded YUV420 planes
316          * Fraps v4 is virtually the same
317          */
318         avctx->pix_fmt = PIX_FMT_YUV420P;
319         planes = 3;
320         f->reference = 1;
321         f->buffer_hints = FF_BUFFER_HINTS_VALID |
322                           FF_BUFFER_HINTS_PRESERVE |
323                           FF_BUFFER_HINTS_REUSABLE;
324         if (avctx->reget_buffer(avctx, f)) {
325             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
326             return -1;
327         }
328         /* skip frame */
329         if(buf_size == 8) {
330             f->pict_type = FF_P_TYPE;
331             f->key_frame = 0;
332             break;
333         }
334         f->pict_type = FF_I_TYPE;
335         f->key_frame = 1;
336         if ((LE_32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
337             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
338             return -1;
339         }
340         for(i = 0; i < planes; i++) {
341             offs[i] = LE_32(buf + 4 + i * 4);
342             if(offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
343                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
344                 return -1;
345             }
346         }
347         offs[planes] = buf_size;
348         for(i = 0; i < planes; i++){
349             is_chroma = !!i;
350             s->tmpbuf = av_realloc(s->tmpbuf, offs[i + 1] - offs[i] - 1024 + FF_INPUT_BUFFER_PADDING_SIZE);
351             if(fraps2_decode_plane(s, f->data[i], f->linesize[i], avctx->width >> is_chroma,
352                     avctx->height >> is_chroma, buf + offs[i], offs[i + 1] - offs[i], is_chroma) < 0) {
353                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
354                 return -1;
355             }
356         }
357         break;
358     }
359
360     *frame = *f;
361     *data_size = sizeof(AVFrame);
362
363     return buf_size;
364 }
365
366
367 /**
368  * closes decoder
369  * @param avctx codec context
370  * @return 0 on success or negative if fails
371  */
372 static int decode_end(AVCodecContext *avctx)
373 {
374     FrapsContext *s = (FrapsContext*)avctx->priv_data;
375
376     if (s->frame.data[0])
377         avctx->release_buffer(avctx, &s->frame);
378
379     av_freep(&s->tmpbuf);
380     return 0;
381 }
382
383
384 AVCodec fraps_decoder = {
385     "fraps",
386     CODEC_TYPE_VIDEO,
387     CODEC_ID_FRAPS,
388     sizeof(FrapsContext),
389     decode_init,
390     NULL,
391     decode_end,
392     decode_frame,
393     CODEC_CAP_DR1,
394 };