Move some duplicated code, simplify.
[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
40 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
41
42 /**
43  * local variable storage
44  */
45 typedef struct FrapsContext{
46     AVCodecContext *avctx;
47     AVFrame frame;
48     uint8_t *tmpbuf;
49     int tmpbuf_size;
50     DSPContext dsp;
51 } FrapsContext;
52
53
54 /**
55  * initializes decoder
56  * @param avctx codec context
57  * @return 0 on success or negative if fails
58  */
59 static av_cold int decode_init(AVCodecContext *avctx)
60 {
61     FrapsContext * const s = avctx->priv_data;
62
63     avcodec_get_frame_defaults(&s->frame);
64     avctx->coded_frame = (AVFrame*)&s->frame;
65
66     s->avctx = avctx;
67     s->tmpbuf = NULL;
68
69     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     const Node *a = va, *b = vb;
80     return (a->count - b->count)*256 + a->sym - b->sym;
81 }
82
83 /**
84  * decode Fraps v2 packed plane
85  */
86 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
87                                int h, const uint8_t *src, int size, int Uoff,
88                                const int step)
89 {
90     int i, j;
91     GetBitContext gb;
92     VLC vlc;
93     Node nodes[512];
94
95     for(i = 0; i < 256; i++)
96         nodes[i].count = bytestream_get_le32(&src);
97     size -= 1024;
98     if (ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
99                            FF_HUFFMAN_FLAG_ZERO_COUNT) < 0)
100         return -1;
101     /* we have built Huffman table and are ready to decode plane */
102
103     /* convert bits so they may be used by standard bitreader */
104     s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
105
106     init_get_bits(&gb, s->tmpbuf, size * 8);
107     for(j = 0; j < h; j++){
108         for(i = 0; i < w*step; i += step){
109             dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
110             /* lines are stored as deltas between previous lines
111              * and we need to add 0x80 to the first lines of chroma planes
112              */
113             if(j) dst[i] += dst[i - stride];
114             else if(Uoff) dst[i] += 0x80;
115             if (get_bits_left(&gb) < 0) {
116                 free_vlc(&vlc);
117                 return AVERROR_INVALIDDATA;
118             }
119         }
120         dst += stride;
121     }
122     free_vlc(&vlc);
123     return 0;
124 }
125
126 static int decode_frame(AVCodecContext *avctx,
127                         void *data, int *data_size,
128                         AVPacket *avpkt)
129 {
130     const uint8_t *buf = avpkt->data;
131     int buf_size = avpkt->size;
132     FrapsContext * const s = avctx->priv_data;
133     AVFrame *frame = data;
134     AVFrame * const f = (AVFrame*)&s->frame;
135     uint32_t header;
136     unsigned int version,header_size;
137     unsigned int x, y;
138     const uint32_t *buf32;
139     uint32_t *luma1,*luma2,*cb,*cr;
140     uint32_t offs[4];
141     int i, j, is_chroma;
142     const int planes = 3;
143
144
145     header = AV_RL32(buf);
146     version = header & 0xff;
147     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
148
149     if (version > 5) {
150         av_log(avctx, AV_LOG_ERROR,
151                "This file is encoded with Fraps version %d. " \
152                "This codec can only decode versions <= 5.\n", version);
153         return -1;
154     }
155
156     buf+=4;
157     if (header_size == 8)
158         buf+=4;
159
160     f->pict_type = AV_PICTURE_TYPE_I;
161     f->key_frame = 1;
162     f->reference = 3;
163     f->buffer_hints = FF_BUFFER_HINTS_VALID |
164                       FF_BUFFER_HINTS_PRESERVE |
165                       FF_BUFFER_HINTS_REUSABLE;
166
167     switch(version) {
168     case 0:
169     default:
170         /* Fraps v0 is a reordered YUV420 */
171         avctx->pix_fmt = PIX_FMT_YUVJ420P;
172
173         if ( (buf_size != avctx->width*avctx->height*3/2+header_size) &&
174              (buf_size != header_size) ) {
175             av_log(avctx, AV_LOG_ERROR,
176                    "Invalid frame length %d (should be %d)\n",
177                    buf_size, avctx->width*avctx->height*3/2+header_size);
178             return -1;
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 -1;
185         }
186
187         if (avctx->reget_buffer(avctx, f)) {
188             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
189             return -1;
190         }
191         /* bit 31 means same as previous pic */
192         if (header & (1U<<31)) {
193             f->pict_type = AV_PICTURE_TYPE_P;
194             f->key_frame = 0;
195         } else {
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         avctx->pix_fmt = PIX_FMT_BGR24;
217
218         if ( (buf_size != avctx->width*avctx->height*3+header_size) &&
219              (buf_size != header_size) ) {
220             av_log(avctx, AV_LOG_ERROR,
221                    "Invalid frame length %d (should be %d)\n",
222                    buf_size, avctx->width*avctx->height*3+header_size);
223             return -1;
224         }
225
226         if (avctx->reget_buffer(avctx, f)) {
227             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
228             return -1;
229         }
230         /* bit 31 means same as previous pic */
231         if (header & (1U<<31)) {
232             f->pict_type = AV_PICTURE_TYPE_P;
233             f->key_frame = 0;
234         } else {
235             for(y=0; y<avctx->height; y++)
236                 memcpy(&f->data[0][ (avctx->height-y)*f->linesize[0] ],
237                        &buf[y*avctx->width*3],
238                        3*avctx->width);
239         }
240         break;
241
242     case 2:
243     case 4:
244         /**
245          * Fraps v2 is Huffman-coded YUV420 planes
246          * Fraps v4 is virtually the same
247          */
248         avctx->pix_fmt = PIX_FMT_YUVJ420P;
249         if (avctx->reget_buffer(avctx, f)) {
250             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
251             return -1;
252         }
253         /* skip frame */
254         if(buf_size == 8) {
255             f->pict_type = AV_PICTURE_TYPE_P;
256             f->key_frame = 0;
257             break;
258         }
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 -1;
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 -1;
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, offs[i + 1] - offs[i] - 1024);
274             if (!s->tmpbuf)
275                 return AVERROR(ENOMEM);
276             if(fraps2_decode_plane(s, f->data[i], f->linesize[i], avctx->width >> is_chroma,
277                     avctx->height >> is_chroma, buf + offs[i], offs[i + 1] - offs[i], is_chroma, 1) < 0) {
278                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
279                 return -1;
280             }
281         }
282         break;
283     case 3:
284     case 5:
285         /* Virtually the same as version 4, but is for RGB24 */
286         avctx->pix_fmt = PIX_FMT_BGR24;
287         if (avctx->reget_buffer(avctx, f)) {
288             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
289             return -1;
290         }
291         /* skip frame */
292         if(buf_size == 8) {
293             f->pict_type = AV_PICTURE_TYPE_P;
294             f->key_frame = 0;
295             break;
296         }
297         if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
298             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
299             return -1;
300         }
301         for(i = 0; i < planes; i++) {
302             offs[i] = AV_RL32(buf + 4 + i * 4);
303             if(offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
304                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
305                 return -1;
306             }
307         }
308         offs[planes] = buf_size;
309         for(i = 0; i < planes; i++){
310             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
311             if (!s->tmpbuf)
312                 return AVERROR(ENOMEM);
313             if(fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)), -f->linesize[0],
314                     avctx->width, avctx->height, buf + offs[i], offs[i + 1] - offs[i], 0, 3) < 0) {
315                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
316                 return -1;
317             }
318         }
319         // convert pseudo-YUV into real RGB
320         for(j = 0; j < avctx->height; j++){
321             for(i = 0; i < avctx->width; i++){
322                 f->data[0][0 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
323                 f->data[0][2 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
324             }
325         }
326         break;
327     }
328
329     *frame = *f;
330     *data_size = sizeof(AVFrame);
331
332     return buf_size;
333 }
334
335
336 /**
337  * closes decoder
338  * @param avctx codec context
339  * @return 0 on success or negative if fails
340  */
341 static av_cold int decode_end(AVCodecContext *avctx)
342 {
343     FrapsContext *s = (FrapsContext*)avctx->priv_data;
344
345     if (s->frame.data[0])
346         avctx->release_buffer(avctx, &s->frame);
347
348     av_freep(&s->tmpbuf);
349     return 0;
350 }
351
352
353 AVCodec ff_fraps_decoder = {
354     .name           = "fraps",
355     .type           = AVMEDIA_TYPE_VIDEO,
356     .id             = CODEC_ID_FRAPS,
357     .priv_data_size = sizeof(FrapsContext),
358     .init           = decode_init,
359     .close          = decode_end,
360     .decode         = decode_frame,
361     .capabilities   = CODEC_CAP_DR1,
362     .long_name = NULL_IF_CONFIG_SMALL("Fraps"),
363 };