Implement avcodec_decode_video2(), _audio3() and _subtitle2() which takes an
[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 libavcodec/fraps.c
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 "bitstream.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->frame.data[0] = NULL;
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         }
116         dst += stride;
117     }
118     free_vlc(&vlc);
119     return 0;
120 }
121
122 /**
123  * decode a frame
124  * @param avctx codec context
125  * @param data output AVFrame
126  * @param data_size size of output data or 0 if no picture is returned
127  * @param buf input data frame
128  * @param buf_size size of input data frame
129  * @return number of consumed bytes on success or negative if decode fails
130  */
131 static int decode_frame(AVCodecContext *avctx,
132                         void *data, int *data_size,
133                         AVPacket *avpkt)
134 {
135     const uint8_t *buf = avpkt->data;
136     int buf_size = avpkt->size;
137     FrapsContext * const s = avctx->priv_data;
138     AVFrame *frame = data;
139     AVFrame * const f = (AVFrame*)&s->frame;
140     uint32_t header;
141     unsigned int version,header_size;
142     unsigned int x, y;
143     const uint32_t *buf32;
144     uint32_t *luma1,*luma2,*cb,*cr;
145     uint32_t offs[4];
146     int i, j, is_chroma, planes;
147
148
149     header = AV_RL32(buf);
150     version = header & 0xff;
151     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
152
153     if (version > 5) {
154         av_log(avctx, AV_LOG_ERROR,
155                "This file is encoded with Fraps version %d. " \
156                "This codec can only decode versions <= 5.\n", version);
157         return -1;
158     }
159
160     buf+=4;
161     if (header_size == 8)
162         buf+=4;
163
164     switch(version) {
165     case 0:
166     default:
167         /* Fraps v0 is a reordered YUV420 */
168         avctx->pix_fmt = PIX_FMT_YUV420P;
169
170         if ( (buf_size != avctx->width*avctx->height*3/2+header_size) &&
171              (buf_size != header_size) ) {
172             av_log(avctx, AV_LOG_ERROR,
173                    "Invalid frame length %d (should be %d)\n",
174                    buf_size, avctx->width*avctx->height*3/2+header_size);
175             return -1;
176         }
177
178         if (( (avctx->width % 8) != 0) || ( (avctx->height % 2) != 0 )) {
179             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
180                    avctx->width, avctx->height);
181             return -1;
182         }
183
184         f->reference = 1;
185         f->buffer_hints = FF_BUFFER_HINTS_VALID |
186                           FF_BUFFER_HINTS_PRESERVE |
187                           FF_BUFFER_HINTS_REUSABLE;
188         if (avctx->reget_buffer(avctx, f)) {
189             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
190             return -1;
191         }
192         /* bit 31 means same as previous pic */
193         f->pict_type = (header & (1<<31))? FF_P_TYPE : FF_I_TYPE;
194         f->key_frame = f->pict_type == FF_I_TYPE;
195
196         if (f->pict_type == FF_I_TYPE) {
197             buf32=(const uint32_t*)buf;
198             for(y=0; y<avctx->height/2; y++){
199                 luma1=(uint32_t*)&f->data[0][ y*2*f->linesize[0] ];
200                 luma2=(uint32_t*)&f->data[0][ (y*2+1)*f->linesize[0] ];
201                 cr=(uint32_t*)&f->data[1][ y*f->linesize[1] ];
202                 cb=(uint32_t*)&f->data[2][ y*f->linesize[2] ];
203                 for(x=0; x<avctx->width; x+=8){
204                     *(luma1++) = *(buf32++);
205                     *(luma1++) = *(buf32++);
206                     *(luma2++) = *(buf32++);
207                     *(luma2++) = *(buf32++);
208                     *(cr++) = *(buf32++);
209                     *(cb++) = *(buf32++);
210                 }
211             }
212         }
213         break;
214
215     case 1:
216         /* Fraps v1 is an upside-down BGR24 */
217         avctx->pix_fmt = PIX_FMT_BGR24;
218
219         if ( (buf_size != avctx->width*avctx->height*3+header_size) &&
220              (buf_size != header_size) ) {
221             av_log(avctx, AV_LOG_ERROR,
222                    "Invalid frame length %d (should be %d)\n",
223                    buf_size, avctx->width*avctx->height*3+header_size);
224             return -1;
225         }
226
227         f->reference = 1;
228         f->buffer_hints = FF_BUFFER_HINTS_VALID |
229                           FF_BUFFER_HINTS_PRESERVE |
230                           FF_BUFFER_HINTS_REUSABLE;
231         if (avctx->reget_buffer(avctx, f)) {
232             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
233             return -1;
234         }
235         /* bit 31 means same as previous pic */
236         f->pict_type = (header & (1<<31))? FF_P_TYPE : FF_I_TYPE;
237         f->key_frame = f->pict_type == FF_I_TYPE;
238
239         if (f->pict_type == FF_I_TYPE) {
240             for(y=0; y<avctx->height; y++)
241                 memcpy(&f->data[0][ (avctx->height-y)*f->linesize[0] ],
242                        &buf[y*avctx->width*3],
243                        f->linesize[0]);
244         }
245         break;
246
247     case 2:
248     case 4:
249         /**
250          * Fraps v2 is Huffman-coded YUV420 planes
251          * Fraps v4 is virtually the same
252          */
253         avctx->pix_fmt = PIX_FMT_YUV420P;
254         planes = 3;
255         f->reference = 1;
256         f->buffer_hints = FF_BUFFER_HINTS_VALID |
257                           FF_BUFFER_HINTS_PRESERVE |
258                           FF_BUFFER_HINTS_REUSABLE;
259         if (avctx->reget_buffer(avctx, f)) {
260             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
261             return -1;
262         }
263         /* skip frame */
264         if(buf_size == 8) {
265             f->pict_type = FF_P_TYPE;
266             f->key_frame = 0;
267             break;
268         }
269         f->pict_type = FF_I_TYPE;
270         f->key_frame = 1;
271         if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
272             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
273             return -1;
274         }
275         for(i = 0; i < planes; i++) {
276             offs[i] = AV_RL32(buf + 4 + i * 4);
277             if(offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
278                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
279                 return -1;
280             }
281         }
282         offs[planes] = buf_size;
283         for(i = 0; i < planes; i++){
284             is_chroma = !!i;
285             s->tmpbuf = av_realloc(s->tmpbuf, offs[i + 1] - offs[i] - 1024 + FF_INPUT_BUFFER_PADDING_SIZE);
286             if(fraps2_decode_plane(s, f->data[i], f->linesize[i], avctx->width >> is_chroma,
287                     avctx->height >> is_chroma, buf + offs[i], offs[i + 1] - offs[i], is_chroma, 1) < 0) {
288                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
289                 return -1;
290             }
291         }
292         break;
293     case 3:
294     case 5:
295         /* Virtually the same as version 4, but is for RGB24 */
296         avctx->pix_fmt = PIX_FMT_BGR24;
297         planes = 3;
298         f->reference = 1;
299         f->buffer_hints = FF_BUFFER_HINTS_VALID |
300                           FF_BUFFER_HINTS_PRESERVE |
301                           FF_BUFFER_HINTS_REUSABLE;
302         if (avctx->reget_buffer(avctx, f)) {
303             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
304             return -1;
305         }
306         /* skip frame */
307         if(buf_size == 8) {
308             f->pict_type = FF_P_TYPE;
309             f->key_frame = 0;
310             break;
311         }
312         f->pict_type = FF_I_TYPE;
313         f->key_frame = 1;
314         if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
315             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
316             return -1;
317         }
318         for(i = 0; i < planes; i++) {
319             offs[i] = AV_RL32(buf + 4 + i * 4);
320             if(offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
321                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
322                 return -1;
323             }
324         }
325         offs[planes] = buf_size;
326         for(i = 0; i < planes; i++){
327             s->tmpbuf = av_realloc(s->tmpbuf, offs[i + 1] - offs[i] - 1024 + FF_INPUT_BUFFER_PADDING_SIZE);
328             if(fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)), -f->linesize[0],
329                     avctx->width, avctx->height, buf + offs[i], offs[i + 1] - offs[i], 0, 3) < 0) {
330                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
331                 return -1;
332             }
333         }
334         // convert pseudo-YUV into real RGB
335         for(j = 0; j < avctx->height; j++){
336             for(i = 0; i < avctx->width; i++){
337                 f->data[0][0 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
338                 f->data[0][2 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
339             }
340         }
341         break;
342     }
343
344     *frame = *f;
345     *data_size = sizeof(AVFrame);
346
347     return buf_size;
348 }
349
350
351 /**
352  * closes decoder
353  * @param avctx codec context
354  * @return 0 on success or negative if fails
355  */
356 static av_cold int decode_end(AVCodecContext *avctx)
357 {
358     FrapsContext *s = (FrapsContext*)avctx->priv_data;
359
360     if (s->frame.data[0])
361         avctx->release_buffer(avctx, &s->frame);
362
363     av_freep(&s->tmpbuf);
364     return 0;
365 }
366
367
368 AVCodec fraps_decoder = {
369     "fraps",
370     CODEC_TYPE_VIDEO,
371     CODEC_ID_FRAPS,
372     sizeof(FrapsContext),
373     decode_init,
374     NULL,
375     decode_end,
376     decode_frame,
377     CODEC_CAP_DR1,
378     .long_name = NULL_IF_CONFIG_SMALL("Fraps"),
379 };