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