lavc decoders: work with refcounted 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 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 "dsputil.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     AVFrame frame;
49     uint8_t *tmpbuf;
50     int tmpbuf_size;
51     DSPContext dsp;
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     ff_dsputil_init(&s->dsp, avctx);
70
71     return 0;
72 }
73
74 /**
75  * Comparator - our nodes should ascend by count
76  * but with preserved symbol order
77  */
78 static int huff_cmp(const void *va, const void *vb)
79 {
80     const Node *a = va, *b = vb;
81     return (a->count - b->count)*256 + a->sym - b->sym;
82 }
83
84 /**
85  * decode Fraps v2 packed plane
86  */
87 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
88                                int h, const uint8_t *src, int size, int Uoff,
89                                const int step)
90 {
91     int i, j, ret;
92     GetBitContext gb;
93     VLC vlc;
94     Node nodes[512];
95
96     for (i = 0; i < 256; i++)
97         nodes[i].count = bytestream_get_le32(&src);
98     size -= 1024;
99     if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
100                                   FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
101         return ret;
102     /* we have built Huffman table and are ready to decode plane */
103
104     /* convert bits so they may be used by standard bitreader */
105     s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
106
107     init_get_bits(&gb, s->tmpbuf, size * 8);
108     for (j = 0; j < h; j++) {
109         for (i = 0; i < w*step; i += step) {
110             dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
111             /* lines are stored as deltas between previous lines
112              * and we need to add 0x80 to the first lines of chroma planes
113              */
114             if (j)
115                 dst[i] += dst[i - stride];
116             else if (Uoff)
117                 dst[i] += 0x80;
118             if (get_bits_left(&gb) < 0) {
119                 ff_free_vlc(&vlc);
120                 return AVERROR_INVALIDDATA;
121             }
122         }
123         dst += stride;
124     }
125     ff_free_vlc(&vlc);
126     return 0;
127 }
128
129 static int decode_frame(AVCodecContext *avctx,
130                         void *data, int *got_frame,
131                         AVPacket *avpkt)
132 {
133     FrapsContext * const s = avctx->priv_data;
134     const uint8_t *buf     = avpkt->data;
135     int buf_size           = avpkt->size;
136     AVFrame *frame         = data;
137     AVFrame * const f      = &s->frame;
138     uint32_t header;
139     unsigned int version,header_size;
140     unsigned int x, y;
141     const uint32_t *buf32;
142     uint32_t *luma1,*luma2,*cb,*cr;
143     uint32_t offs[4];
144     int i, j, ret, is_chroma, planes;
145     enum AVPixelFormat pix_fmt;
146
147     header      = AV_RL32(buf);
148     version     = header & 0xff;
149     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
150
151     if (version > 5) {
152         av_log(avctx, AV_LOG_ERROR,
153                "This file is encoded with Fraps version %d. " \
154                "This codec can only decode versions <= 5.\n", version);
155         return AVERROR_PATCHWELCOME;
156     }
157
158     buf += 4;
159     if (header_size == 8)
160         buf += 4;
161
162     pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
163     if (avctx->pix_fmt != pix_fmt && f->data[0]) {
164         av_frame_unref(f);
165     }
166     avctx->pix_fmt = pix_fmt;
167
168     switch (version) {
169     case 0:
170     default:
171         /* Fraps v0 is a reordered YUV420 */
172         if ((buf_size != avctx->width * avctx->height * 3 / 2 + header_size) &&
173             (buf_size != header_size)) {
174             av_log(avctx, AV_LOG_ERROR,
175                    "Invalid frame length %d (should be %d)\n",
176                    buf_size,
177                    avctx->width * avctx->height * 3 / 2 + header_size);
178             return AVERROR_INVALIDDATA;
179         }
180
181         if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
182             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
183                    avctx->width, avctx->height);
184             return AVERROR_INVALIDDATA;
185         }
186
187         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
188             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
189             return ret;
190         }
191         /* bit 31 means same as previous pic */
192         f->pict_type = (header & (1U << 31)) ? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
193         f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
194
195         if (f->pict_type == AV_PICTURE_TYPE_I) {
196             buf32 = (const uint32_t*)buf;
197             for (y = 0; y < avctx->height / 2; y++) {
198                 luma1 = (uint32_t*)&f->data[0][ y * 2      * f->linesize[0]];
199                 luma2 = (uint32_t*)&f->data[0][(y * 2 + 1) * f->linesize[0]];
200                 cr    = (uint32_t*)&f->data[1][ y          * f->linesize[1]];
201                 cb    = (uint32_t*)&f->data[2][ y          * f->linesize[2]];
202                 for (x = 0; x < avctx->width; x += 8) {
203                     *(luma1++) = *(buf32++);
204                     *(luma1++) = *(buf32++);
205                     *(luma2++) = *(buf32++);
206                     *(luma2++) = *(buf32++);
207                     *(cr++) = *(buf32++);
208                     *(cb++) = *(buf32++);
209                 }
210             }
211         }
212         break;
213
214     case 1:
215         /* Fraps v1 is an upside-down BGR24 */
216         if ((buf_size != avctx->width * avctx->height * 3 + header_size) &&
217             (buf_size != header_size) ) {
218             av_log(avctx, AV_LOG_ERROR,
219                    "Invalid frame length %d (should be %d)\n",
220                    buf_size, avctx->width * avctx->height * 3 + header_size);
221             return AVERROR_INVALIDDATA;
222         }
223
224         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
225             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
226             return ret;
227         }
228         /* bit 31 means same as previous pic */
229         f->pict_type = (header & (1U<<31))? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
230         f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
231
232         if (f->pict_type == AV_PICTURE_TYPE_I) {
233             for (y = 0; y<avctx->height; y++)
234                 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
235                        &buf[y * avctx->width * 3],
236                        3 * avctx->width);
237         }
238         break;
239
240     case 2:
241     case 4:
242         /**
243          * Fraps v2 is Huffman-coded YUV420 planes
244          * Fraps v4 is virtually the same
245          */
246         planes = 3;
247         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
248             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
249             return ret;
250         }
251         /* skip frame */
252         if (buf_size == 8) {
253             f->pict_type = AV_PICTURE_TYPE_P;
254             f->key_frame = 0;
255             break;
256         }
257         f->pict_type = AV_PICTURE_TYPE_I;
258         f->key_frame = 1;
259         if ((AV_RL32(buf) != FPS_TAG) || (buf_size < (planes * 1024 + 24))) {
260             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
261             return AVERROR_INVALIDDATA;
262         }
263         for (i = 0; i < planes; i++) {
264             offs[i] = AV_RL32(buf + 4 + i * 4);
265             if (offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
266                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
267                 return AVERROR_INVALIDDATA;
268             }
269         }
270         offs[planes] = buf_size;
271         for (i = 0; i < planes; i++) {
272             is_chroma = !!i;
273             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size,
274                                   offs[i + 1] - offs[i] - 1024);
275             if (!s->tmpbuf)
276                 return AVERROR(ENOMEM);
277             if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
278                                            avctx->width  >> is_chroma,
279                                            avctx->height >> is_chroma,
280                                            buf + offs[i], offs[i + 1] - offs[i],
281                                            is_chroma, 1)) < 0) {
282                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
283                 return ret;
284             }
285         }
286         break;
287     case 3:
288     case 5:
289         /* Virtually the same as version 4, but is for RGB24 */
290         planes = 3;
291         if ((ret = ff_reget_buffer(avctx, f)) < 0) {
292             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
293             return ret;
294         }
295         /* skip frame */
296         if (buf_size == 8) {
297             f->pict_type = AV_PICTURE_TYPE_P;
298             f->key_frame = 0;
299             break;
300         }
301         f->pict_type = AV_PICTURE_TYPE_I;
302         f->key_frame = 1;
303         if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
304             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
305             return AVERROR_INVALIDDATA;
306         }
307         for (i = 0; i < planes; i++) {
308             offs[i] = AV_RL32(buf + 4 + i * 4);
309             if (offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
310                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
311                 return AVERROR_INVALIDDATA;
312             }
313         }
314         offs[planes] = buf_size;
315         for (i = 0; i < planes; i++) {
316             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size,
317                                   offs[i + 1] - offs[i] - 1024);
318             if (!s->tmpbuf)
319                 return AVERROR(ENOMEM);
320             if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
321                                            -f->linesize[0], avctx->width, avctx->height,
322                                            buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
323                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
324                 return ret;
325             }
326         }
327         // convert pseudo-YUV into real RGB
328         for (j = 0; j < avctx->height; j++) {
329             for (i = 0; i < avctx->width; i++) {
330                 f->data[0][0 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
331                 f->data[0][2 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
332             }
333         }
334         break;
335     }
336
337     if ((ret = av_frame_ref(frame, f)) < 0)
338         return ret;
339     *got_frame = 1;
340
341     return buf_size;
342 }
343
344
345 /**
346  * closes decoder
347  * @param avctx codec context
348  * @return 0 on success or negative if fails
349  */
350 static av_cold int decode_end(AVCodecContext *avctx)
351 {
352     FrapsContext *s = (FrapsContext*)avctx->priv_data;
353
354     av_frame_unref(&s->frame);
355
356     av_freep(&s->tmpbuf);
357     return 0;
358 }
359
360
361 AVCodec ff_fraps_decoder = {
362     .name           = "fraps",
363     .type           = AVMEDIA_TYPE_VIDEO,
364     .id             = AV_CODEC_ID_FRAPS,
365     .priv_data_size = sizeof(FrapsContext),
366     .init           = decode_init,
367     .close          = decode_end,
368     .decode         = decode_frame,
369     .capabilities   = CODEC_CAP_DR1,
370     .long_name      = NULL_IF_CONFIG_SMALL("Fraps"),
371 };