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