3 * Copyright (c) 2005 Roine Gustafsson
4 * Copyright (c) 2006 Konstantin Shishkov
6 * This file is part of FFmpeg.
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.
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.
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
25 * Lossless Fraps 'FPS1' decoder
26 * @author Roine Gustafsson (roine at users sf net)
27 * @author Konstantin Shishkov
29 * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
31 * Version 2 files support by Konstantin Shishkov
37 #include "bytestream.h"
40 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
43 * local variable storage
45 typedef struct FrapsContext{
46 AVCodecContext *avctx;
56 * @param avctx codec context
57 * @return 0 on success or negative if fails
59 static av_cold int decode_init(AVCodecContext *avctx)
61 FrapsContext * const s = avctx->priv_data;
63 avcodec_get_frame_defaults(&s->frame);
64 avctx->coded_frame = (AVFrame*)&s->frame;
69 dsputil_init(&s->dsp, avctx);
75 * Comparator - our nodes should ascend by count
76 * but with preserved symbol order
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;
84 * decode Fraps v2 packed plane
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,
95 for(i = 0; i < 256; i++)
96 nodes[i].count = bytestream_get_le32(&src);
98 if (ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
99 FF_HUFFMAN_FLAG_ZERO_COUNT) < 0)
101 /* we have built Huffman table and are ready to decode plane */
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);
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
113 if(j) dst[i] += dst[i - stride];
114 else if(Uoff) dst[i] += 0x80;
115 if (get_bits_left(&gb) < 0) {
117 return AVERROR_INVALIDDATA;
126 static int decode_frame(AVCodecContext *avctx,
127 void *data, int *data_size,
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;
136 unsigned int version,header_size;
138 const uint32_t *buf32;
139 uint32_t *luma1,*luma2,*cb,*cr;
141 int i, j, is_chroma, planes;
144 header = AV_RL32(buf);
145 version = header & 0xff;
146 header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
149 av_log(avctx, AV_LOG_ERROR,
150 "This file is encoded with Fraps version %d. " \
151 "This codec can only decode versions <= 5.\n", version);
156 if (header_size == 8)
162 /* Fraps v0 is a reordered YUV420 */
163 avctx->pix_fmt = PIX_FMT_YUVJ420P;
165 if ( (buf_size != avctx->width*avctx->height*3/2+header_size) &&
166 (buf_size != header_size) ) {
167 av_log(avctx, AV_LOG_ERROR,
168 "Invalid frame length %d (should be %d)\n",
169 buf_size, avctx->width*avctx->height*3/2+header_size);
173 if (( (avctx->width % 8) != 0) || ( (avctx->height % 2) != 0 )) {
174 av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
175 avctx->width, avctx->height);
180 f->buffer_hints = FF_BUFFER_HINTS_VALID |
181 FF_BUFFER_HINTS_PRESERVE |
182 FF_BUFFER_HINTS_REUSABLE;
183 if (avctx->reget_buffer(avctx, f)) {
184 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
187 /* bit 31 means same as previous pic */
188 f->pict_type = (header & (1U<<31))? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
189 f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
191 if (f->pict_type == AV_PICTURE_TYPE_I) {
192 buf32=(const uint32_t*)buf;
193 for(y=0; y<avctx->height/2; y++){
194 luma1=(uint32_t*)&f->data[0][ y*2*f->linesize[0] ];
195 luma2=(uint32_t*)&f->data[0][ (y*2+1)*f->linesize[0] ];
196 cr=(uint32_t*)&f->data[1][ y*f->linesize[1] ];
197 cb=(uint32_t*)&f->data[2][ y*f->linesize[2] ];
198 for(x=0; x<avctx->width; x+=8){
199 *(luma1++) = *(buf32++);
200 *(luma1++) = *(buf32++);
201 *(luma2++) = *(buf32++);
202 *(luma2++) = *(buf32++);
203 *(cr++) = *(buf32++);
204 *(cb++) = *(buf32++);
211 /* Fraps v1 is an upside-down BGR24 */
212 avctx->pix_fmt = PIX_FMT_BGR24;
214 if ( (buf_size != avctx->width*avctx->height*3+header_size) &&
215 (buf_size != header_size) ) {
216 av_log(avctx, AV_LOG_ERROR,
217 "Invalid frame length %d (should be %d)\n",
218 buf_size, avctx->width*avctx->height*3+header_size);
223 f->buffer_hints = FF_BUFFER_HINTS_VALID |
224 FF_BUFFER_HINTS_PRESERVE |
225 FF_BUFFER_HINTS_REUSABLE;
226 if (avctx->reget_buffer(avctx, f)) {
227 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
230 /* bit 31 means same as previous pic */
231 f->pict_type = (header & (1U<<31))? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
232 f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
234 if (f->pict_type == AV_PICTURE_TYPE_I) {
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],
245 * Fraps v2 is Huffman-coded YUV420 planes
246 * Fraps v4 is virtually the same
248 avctx->pix_fmt = PIX_FMT_YUVJ420P;
251 f->buffer_hints = FF_BUFFER_HINTS_VALID |
252 FF_BUFFER_HINTS_PRESERVE |
253 FF_BUFFER_HINTS_REUSABLE;
254 if (avctx->reget_buffer(avctx, f)) {
255 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
260 f->pict_type = AV_PICTURE_TYPE_P;
264 f->pict_type = AV_PICTURE_TYPE_I;
266 if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
267 av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
270 for(i = 0; i < planes; i++) {
271 offs[i] = AV_RL32(buf + 4 + i * 4);
272 if(offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
273 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
277 offs[planes] = buf_size;
278 for(i = 0; i < planes; i++){
280 av_fast_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024 + FF_INPUT_BUFFER_PADDING_SIZE);
282 return AVERROR(ENOMEM);
283 if(fraps2_decode_plane(s, f->data[i], f->linesize[i], avctx->width >> is_chroma,
284 avctx->height >> is_chroma, buf + offs[i], offs[i + 1] - offs[i], is_chroma, 1) < 0) {
285 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
292 /* Virtually the same as version 4, but is for RGB24 */
293 avctx->pix_fmt = PIX_FMT_BGR24;
296 f->buffer_hints = FF_BUFFER_HINTS_VALID |
297 FF_BUFFER_HINTS_PRESERVE |
298 FF_BUFFER_HINTS_REUSABLE;
299 if (avctx->reget_buffer(avctx, f)) {
300 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
305 f->pict_type = AV_PICTURE_TYPE_P;
309 f->pict_type = AV_PICTURE_TYPE_I;
311 if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
312 av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
315 for(i = 0; i < planes; i++) {
316 offs[i] = AV_RL32(buf + 4 + i * 4);
317 if(offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
318 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
322 offs[planes] = buf_size;
323 for(i = 0; i < planes; i++){
324 av_fast_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024 + FF_INPUT_BUFFER_PADDING_SIZE);
326 return AVERROR(ENOMEM);
327 if(fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)), -f->linesize[0],
328 avctx->width, avctx->height, buf + offs[i], offs[i + 1] - offs[i], 0, 3) < 0) {
329 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
333 // convert pseudo-YUV into real RGB
334 for(j = 0; j < avctx->height; j++){
335 for(i = 0; i < avctx->width; i++){
336 f->data[0][0 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
337 f->data[0][2 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
344 *data_size = sizeof(AVFrame);
352 * @param avctx codec context
353 * @return 0 on success or negative if fails
355 static av_cold int decode_end(AVCodecContext *avctx)
357 FrapsContext *s = (FrapsContext*)avctx->priv_data;
359 if (s->frame.data[0])
360 avctx->release_buffer(avctx, &s->frame);
362 av_freep(&s->tmpbuf);
367 AVCodec ff_fraps_decoder = {
369 .type = AVMEDIA_TYPE_VIDEO,
370 .id = CODEC_ID_FRAPS,
371 .priv_data_size = sizeof(FrapsContext),
374 .decode = decode_frame,
375 .capabilities = CODEC_CAP_DR1,
376 .long_name = NULL_IF_CONFIG_SMALL("Fraps"),