Merge remote-tracking branch 'qatar/master'
[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  * @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 "thread.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     avcodec_get_frame_defaults(&s->frame);
65     avctx->coded_frame = (AVFrame*)&s->frame;
66
67     s->avctx = avctx;
68     s->tmpbuf = NULL;
69
70     ff_dsputil_init(&s->dsp, avctx);
71
72     return 0;
73 }
74
75 /**
76  * Comparator - our nodes should ascend by count
77  * but with preserved symbol order
78  */
79 static int huff_cmp(const void *va, const void *vb){
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;
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 (ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
100                            FF_HUFFMAN_FLAG_ZERO_COUNT) < 0)
101         return -1;
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) dst[i] += dst[i - stride];
115             else if(Uoff) dst[i] += 0x80;
116             if (get_bits_left(&gb) < 0) {
117                 ff_free_vlc(&vlc);
118                 return AVERROR_INVALIDDATA;
119             }
120         }
121         dst += stride;
122     }
123     ff_free_vlc(&vlc);
124     return 0;
125 }
126
127 static int decode_frame(AVCodecContext *avctx,
128                         void *data, int *data_size,
129                         AVPacket *avpkt)
130 {
131     const uint8_t *buf = avpkt->data;
132     int buf_size = avpkt->size;
133     FrapsContext * const s = avctx->priv_data;
134     AVFrame *frame = data;
135     AVFrame * const f = (AVFrame*)&s->frame;
136     uint32_t header;
137     unsigned int version,header_size;
138     unsigned int x, y;
139     const uint32_t *buf32;
140     uint32_t *luma1,*luma2,*cb,*cr;
141     uint32_t offs[4];
142     int i, j, is_chroma;
143     const int planes = 3;
144     uint8_t *out;
145     enum PixelFormat 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 -1;
156     }
157
158     buf += header_size;
159
160     if (version < 2) {
161         unsigned needed_size = avctx->width*avctx->height*3;
162         if (version == 0) needed_size /= 2;
163         needed_size += header_size;
164         if (buf_size != needed_size && buf_size != header_size) {
165             av_log(avctx, AV_LOG_ERROR,
166                    "Invalid frame length %d (should be %d)\n",
167                    buf_size, needed_size);
168             return -1;
169         }
170         /* bit 31 means same as previous pic */
171         if (header & (1U<<31)) {
172             *data_size = 0;
173             return buf_size;
174         }
175     } else {
176         /* skip frame */
177         if (buf_size == 8) {
178             *data_size = 0;
179             return buf_size;
180         }
181         if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
182             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
183             return -1;
184         }
185         for(i = 0; i < planes; i++) {
186             offs[i] = AV_RL32(buf + 4 + i * 4);
187             if(offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
188                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
189                 return -1;
190             }
191         }
192         offs[planes] = buf_size - header_size;
193         for(i = 0; i < planes; i++) {
194             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
195             if (!s->tmpbuf)
196                 return AVERROR(ENOMEM);
197         }
198     }
199
200     if (f->data[0])
201         ff_thread_release_buffer(avctx, f);
202     f->pict_type = AV_PICTURE_TYPE_I;
203     f->key_frame = 1;
204     f->reference = 0;
205     f->buffer_hints = FF_BUFFER_HINTS_VALID;
206
207     pix_fmt = version & 1 ? PIX_FMT_BGR24 : PIX_FMT_YUVJ420P;
208     if (avctx->pix_fmt != pix_fmt && f->data[0]) {
209         avctx->release_buffer(avctx, f);
210     }
211     avctx->pix_fmt = pix_fmt;
212
213     if (ff_thread_get_buffer(avctx, f)) {
214         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
215         return -1;
216     }
217
218     switch(version) {
219     case 0:
220     default:
221         /* Fraps v0 is a reordered YUV420 */
222         if ( (avctx->width % 8) != 0 || (avctx->height % 2) != 0 ) {
223             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
224                    avctx->width, avctx->height);
225             return -1;
226         }
227
228         buf32=(const uint32_t*)buf;
229         for(y=0; y<avctx->height/2; y++){
230             luma1=(uint32_t*)&f->data[0][ y*2*f->linesize[0] ];
231             luma2=(uint32_t*)&f->data[0][ (y*2+1)*f->linesize[0] ];
232             cr=(uint32_t*)&f->data[1][ y*f->linesize[1] ];
233             cb=(uint32_t*)&f->data[2][ y*f->linesize[2] ];
234             for(x=0; x<avctx->width; x+=8){
235                 *luma1++ = *buf32++;
236                 *luma1++ = *buf32++;
237                 *luma2++ = *buf32++;
238                 *luma2++ = *buf32++;
239                 *cr++    = *buf32++;
240                 *cb++    = *buf32++;
241             }
242         }
243         break;
244
245     case 1:
246         /* Fraps v1 is an upside-down BGR24 */
247         for(y=0; y<avctx->height; y++)
248             memcpy(&f->data[0][ (avctx->height-y)*f->linesize[0] ],
249                    &buf[y*avctx->width*3],
250                    3*avctx->width);
251         break;
252
253     case 2:
254     case 4:
255         /**
256          * Fraps v2 is Huffman-coded YUV420 planes
257          * Fraps v4 is virtually the same
258          */
259         for(i = 0; i < planes; i++){
260             is_chroma = !!i;
261             if(fraps2_decode_plane(s, f->data[i], f->linesize[i], avctx->width >> is_chroma,
262                     avctx->height >> is_chroma, buf + offs[i], offs[i + 1] - offs[i], is_chroma, 1) < 0) {
263                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
264                 return -1;
265             }
266         }
267         break;
268     case 3:
269     case 5:
270         /* Virtually the same as version 4, but is for RGB24 */
271         for(i = 0; i < planes; i++){
272             if(fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)), -f->linesize[0],
273                     avctx->width, avctx->height, buf + offs[i], offs[i + 1] - offs[i], 0, 3) < 0) {
274                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
275                 return -1;
276             }
277         }
278         out = f->data[0];
279         // convert pseudo-YUV into real RGB
280         for(j = 0; j < avctx->height; j++){
281             uint8_t *line_end = out + 3*avctx->width;
282             while (out < line_end) {
283                 out[0]  += out[1];
284                 out[2]  += out[1];
285                 out += 3;
286             }
287             out += f->linesize[0] - 3*avctx->width;
288         }
289         break;
290     }
291
292     *frame = *f;
293     *data_size = sizeof(AVFrame);
294
295     return buf_size;
296 }
297
298
299 /**
300  * closes decoder
301  * @param avctx codec context
302  * @return 0 on success or negative if fails
303  */
304 static av_cold int decode_end(AVCodecContext *avctx)
305 {
306     FrapsContext *s = (FrapsContext*)avctx->priv_data;
307
308     if (s->frame.data[0])
309         avctx->release_buffer(avctx, &s->frame);
310
311     av_freep(&s->tmpbuf);
312     return 0;
313 }
314
315
316 AVCodec ff_fraps_decoder = {
317     .name           = "fraps",
318     .type           = AVMEDIA_TYPE_VIDEO,
319     .id             = CODEC_ID_FRAPS,
320     .priv_data_size = sizeof(FrapsContext),
321     .init           = decode_init,
322     .close          = decode_end,
323     .decode         = decode_frame,
324     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
325     .long_name = NULL_IF_CONFIG_SMALL("Fraps"),
326 };