huffman: allow specifying nb_bits to ff_huff_build_tree()
[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 Libav.
7  *
8  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Lossless Fraps 'FPS1' decoder
26  * @author Roine Gustafsson (roine at users sf net)
27  * @author Konstantin Shishkov
28  *
29  * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
30  *
31  * Version 2 files support by Konstantin Shishkov
32  */
33
34 #include "avcodec.h"
35 #include "get_bits.h"
36 #include "huffman.h"
37 #include "bytestream.h"
38 #include "bswapdsp.h"
39 #include "internal.h"
40
41 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
42
43 /**
44  * local variable storage
45  */
46 typedef struct FrapsContext {
47     AVCodecContext *avctx;
48     BswapDSPContext bdsp;
49     AVFrame *frame;
50     uint8_t *tmpbuf;
51     int tmpbuf_size;
52 } FrapsContext;
53
54
55 /**
56  * initializes decoder
57  * @param avctx codec context
58  * @return 0 on success or negative if fails
59  */
60 static av_cold int decode_init(AVCodecContext *avctx)
61 {
62     FrapsContext * const s = avctx->priv_data;
63
64     avctx->pix_fmt     = AV_PIX_FMT_NONE; /* set in decode_frame */
65
66     s->avctx  = avctx;
67     s->tmpbuf = NULL;
68
69     s->frame = av_frame_alloc();
70     if (!s->frame)
71         return AVERROR(ENOMEM);
72
73     ff_bswapdsp_init(&s->bdsp);
74
75     return 0;
76 }
77
78 /**
79  * Comparator - our nodes should ascend by count
80  * but with preserved symbol order
81  */
82 static int huff_cmp(const void *va, const void *vb)
83 {
84     const Node *a = va, *b = vb;
85     return (a->count - b->count)*256 + a->sym - b->sym;
86 }
87
88 /**
89  * decode Fraps v2 packed plane
90  */
91 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
92                                int h, const uint8_t *src, int size, int Uoff,
93                                const int step)
94 {
95     int i, j, ret;
96     GetBitContext gb;
97     VLC vlc;
98     Node nodes[512];
99
100     for (i = 0; i < 256; i++)
101         nodes[i].count = bytestream_get_le32(&src);
102     size -= 1024;
103     if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, FF_HUFFMAN_BITS,
104                                   nodes, huff_cmp,
105                                   FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
106         return ret;
107     /* we have built Huffman table and are ready to decode plane */
108
109     /* convert bits so they may be used by standard bitreader */
110     s->bdsp.bswap_buf((uint32_t *) s->tmpbuf,
111                       (const uint32_t *) src, size >> 2);
112
113     init_get_bits(&gb, s->tmpbuf, size * 8);
114     for (j = 0; j < h; j++) {
115         for (i = 0; i < w*step; i += step) {
116             dst[i] = get_vlc2(&gb, vlc.table, FF_HUFFMAN_BITS, 3);
117             /* lines are stored as deltas between previous lines
118              * and we need to add 0x80 to the first lines of chroma planes
119              */
120             if (j)
121                 dst[i] += dst[i - stride];
122             else if (Uoff)
123                 dst[i] += 0x80;
124             if (get_bits_left(&gb) < 0) {
125                 ff_free_vlc(&vlc);
126                 return AVERROR_INVALIDDATA;
127             }
128         }
129         dst += stride;
130     }
131     ff_free_vlc(&vlc);
132     return 0;
133 }
134
135 static int decode_frame(AVCodecContext *avctx,
136                         void *data, int *got_frame,
137                         AVPacket *avpkt)
138 {
139     FrapsContext * const s = avctx->priv_data;
140     const uint8_t *buf     = avpkt->data;
141     int buf_size           = avpkt->size;
142     AVFrame *frame         = data;
143     AVFrame * const f      = s->frame;
144     uint32_t header;
145     unsigned int version,header_size;
146     unsigned int x, y;
147     const uint32_t *buf32;
148     uint32_t *luma1,*luma2,*cb,*cr;
149     uint32_t offs[4];
150     int i, j, ret, is_chroma, planes;
151     enum AVPixelFormat pix_fmt;
152     int prev_pic_bit, expected_size;
153
154     if (buf_size < 4) {
155         av_log(avctx, AV_LOG_ERROR, "Packet is too short\n");
156         return AVERROR_INVALIDDATA;
157     }
158
159     header      = AV_RL32(buf);
160     version     = header & 0xff;
161     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
162     prev_pic_bit = header & (1U << 31); /* bit 31 means same as previous pic */
163
164     if (version > 5) {
165         av_log(avctx, AV_LOG_ERROR,
166                "This file is encoded with Fraps version %d. " \
167                "This codec can only decode versions <= 5.\n", version);
168         return AVERROR_PATCHWELCOME;
169     }
170
171     buf += 4;
172     if (header_size == 8)
173         buf += 4;
174
175     pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
176     if (avctx->pix_fmt != pix_fmt && f->data[0]) {
177         av_frame_unref(f);
178     }
179     avctx->pix_fmt = pix_fmt;
180     avctx->color_range = version & 1 ? AVCOL_RANGE_UNSPECIFIED
181                                      : AVCOL_RANGE_JPEG;
182
183     expected_size = header_size;
184
185     switch (version) {
186     case 0:
187     default:
188         /* Fraps v0 is a reordered YUV420 */
189         if (!prev_pic_bit)
190             expected_size += avctx->width * avctx->height * 3 / 2;
191         if (buf_size != expected_size) {
192             av_log(avctx, AV_LOG_ERROR,
193                    "Invalid frame length %d (should be %d)\n",
194                    buf_size, expected_size);
195             return AVERROR_INVALIDDATA;
196         }
197
198         if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
199             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
200                    avctx->width, avctx->height);
201             return AVERROR_INVALIDDATA;
202         }
203
204         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
205             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
206             return ret;
207         }
208         f->pict_type = prev_pic_bit ? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
209         f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
210
211         if (f->pict_type == AV_PICTURE_TYPE_I) {
212             buf32 = (const uint32_t*)buf;
213             for (y = 0; y < avctx->height / 2; y++) {
214                 luma1 = (uint32_t*)&f->data[0][ y * 2      * f->linesize[0]];
215                 luma2 = (uint32_t*)&f->data[0][(y * 2 + 1) * f->linesize[0]];
216                 cr    = (uint32_t*)&f->data[1][ y          * f->linesize[1]];
217                 cb    = (uint32_t*)&f->data[2][ y          * f->linesize[2]];
218                 for (x = 0; x < avctx->width; x += 8) {
219                     *(luma1++) = *(buf32++);
220                     *(luma1++) = *(buf32++);
221                     *(luma2++) = *(buf32++);
222                     *(luma2++) = *(buf32++);
223                     *(cr++) = *(buf32++);
224                     *(cb++) = *(buf32++);
225                 }
226             }
227         }
228         break;
229
230     case 1:
231         /* Fraps v1 is an upside-down BGR24 */
232         if (!prev_pic_bit)
233             expected_size += avctx->width * avctx->height * 3;
234         if (buf_size != expected_size) {
235             av_log(avctx, AV_LOG_ERROR,
236                    "Invalid frame length %d (should be %d)\n",
237                    buf_size, expected_size);
238             return AVERROR_INVALIDDATA;
239         }
240
241         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
242             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
243             return ret;
244         }
245         f->pict_type = prev_pic_bit ? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
246         f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
247
248         if (f->pict_type == AV_PICTURE_TYPE_I) {
249             for (y = 0; y<avctx->height; y++)
250                 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
251                        &buf[y * avctx->width * 3],
252                        3 * avctx->width);
253         }
254         break;
255
256     case 2:
257     case 4:
258         /**
259          * Fraps v2 is Huffman-coded YUV420 planes
260          * Fraps v4 is virtually the same
261          */
262         planes = 3;
263         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
264             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
265             return ret;
266         }
267         /* skip frame */
268         if (buf_size == 8) {
269             f->pict_type = AV_PICTURE_TYPE_P;
270             f->key_frame = 0;
271             break;
272         }
273         f->pict_type = AV_PICTURE_TYPE_I;
274         f->key_frame = 1;
275         if ((AV_RL32(buf) != FPS_TAG) || (buf_size < (planes * 1024 + 24))) {
276             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
277             return AVERROR_INVALIDDATA;
278         }
279         for (i = 0; i < planes; i++) {
280             offs[i] = AV_RL32(buf + 4 + i * 4);
281             if (offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
282                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
283                 return AVERROR_INVALIDDATA;
284             }
285         }
286         offs[planes] = buf_size;
287         for (i = 0; i < planes; i++) {
288             is_chroma = !!i;
289             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size,
290                                   offs[i + 1] - offs[i] - 1024);
291             if (!s->tmpbuf)
292                 return AVERROR(ENOMEM);
293             if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
294                                            avctx->width  >> is_chroma,
295                                            avctx->height >> is_chroma,
296                                            buf + offs[i], offs[i + 1] - offs[i],
297                                            is_chroma, 1)) < 0) {
298                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
299                 return ret;
300             }
301         }
302         break;
303     case 3:
304     case 5:
305         /* Virtually the same as version 4, but is for RGB24 */
306         planes = 3;
307         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
308             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
309             return ret;
310         }
311         /* skip frame */
312         if (buf_size == 8) {
313             f->pict_type = AV_PICTURE_TYPE_P;
314             f->key_frame = 0;
315             break;
316         }
317         f->pict_type = AV_PICTURE_TYPE_I;
318         f->key_frame = 1;
319         if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
320             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
321             return AVERROR_INVALIDDATA;
322         }
323         for (i = 0; i < planes; i++) {
324             offs[i] = AV_RL32(buf + 4 + i * 4);
325             if (offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
326                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
327                 return AVERROR_INVALIDDATA;
328             }
329         }
330         offs[planes] = buf_size;
331         for (i = 0; i < planes; i++) {
332             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size,
333                                   offs[i + 1] - offs[i] - 1024);
334             if (!s->tmpbuf)
335                 return AVERROR(ENOMEM);
336             if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
337                                            -f->linesize[0], avctx->width, avctx->height,
338                                            buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
339                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
340                 return ret;
341             }
342         }
343         // convert pseudo-YUV into real RGB
344         for (j = 0; j < avctx->height; j++) {
345             for (i = 0; i < avctx->width; i++) {
346                 f->data[0][0 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
347                 f->data[0][2 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
348             }
349         }
350         break;
351     }
352
353     if ((ret = av_frame_ref(frame, f)) < 0)
354         return ret;
355     *got_frame = 1;
356
357     return buf_size;
358 }
359
360
361 /**
362  * closes decoder
363  * @param avctx codec context
364  * @return 0 on success or negative if fails
365  */
366 static av_cold int decode_end(AVCodecContext *avctx)
367 {
368     FrapsContext *s = (FrapsContext*)avctx->priv_data;
369
370     av_frame_free(&s->frame);
371
372     av_freep(&s->tmpbuf);
373     return 0;
374 }
375
376
377 AVCodec ff_fraps_decoder = {
378     .name           = "fraps",
379     .long_name      = NULL_IF_CONFIG_SMALL("Fraps"),
380     .type           = AVMEDIA_TYPE_VIDEO,
381     .id             = AV_CODEC_ID_FRAPS,
382     .priv_data_size = sizeof(FrapsContext),
383     .init           = decode_init,
384     .close          = decode_end,
385     .decode         = decode_frame,
386     .capabilities   = AV_CODEC_CAP_DR1,
387 };