fraps.c 10.2 KB
Newer Older
1 2 3
/*
 * Fraps FPS1 decoder
 * Copyright (c) 2005 Roine Gustafsson
4
 * Copyright (c) 2006 Konstantin Shishkov
5
 *
6 7 8
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
9 10
 * modify it under the terms of the GNU Lesser General Public
 * 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 15 16 17 18
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 30
 * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
 *
31
 * Version 2 files support by Konstantin Shishkov
32
 */
33

34
#include "avcodec.h"
35
#include "get_bits.h"
36 37
#include "huffman.h"
#include "bytestream.h"
38
#include "dsputil.h"
39
#include "thread.h"
40

Mike Melanson's avatar
Mike Melanson committed
41
#define FPS_TAG MKTAG('F', 'P', 'S', 'x')
42 43 44 45

/**
 * local variable storage
 */
46
typedef struct FrapsContext {
47 48
    AVCodecContext *avctx;
    AVFrame frame;
49
    uint8_t *tmpbuf;
50
    int tmpbuf_size;
51
    DSPContext dsp;
52 53 54 55 56 57 58 59
} FrapsContext;


/**
 * initializes decoder
 * @param avctx codec context
 * @return 0 on success or negative if fails
 */
60
static av_cold int decode_init(AVCodecContext *avctx)
61 62 63
{
    FrapsContext * const s = avctx->priv_data;

64
    avcodec_get_frame_defaults(&s->frame);
65
    avctx->coded_frame = &s->frame;
66

67
    s->avctx  = avctx;
68 69
    s->tmpbuf = NULL;

70
    ff_dsputil_init(&s->dsp, avctx);
71 72 73 74

    return 0;
}

75 76 77 78
/**
 * Comparator - our nodes should ascend by count
 * but with preserved symbol order
 */
79 80
static int huff_cmp(const void *va, const void *vb)
{
81
    const Node *a = va, *b = vb;
82 83 84 85 86 87 88
    return (a->count - b->count)*256 + a->sym - b->sym;
}

/**
 * decode Fraps v2 packed plane
 */
static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
89 90
                               int h, const uint8_t *src, int size, int Uoff,
                               const int step)
91
{
92
    int i, j, ret;
93 94
    GetBitContext gb;
    VLC vlc;
95
    Node nodes[512];
96

97
    for (i = 0; i < 256; i++)
98 99
        nodes[i].count = bytestream_get_le32(&src);
    size -= 1024;
100 101 102
    if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
                                  FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
        return ret;
103 104 105
    /* we have built Huffman table and are ready to decode plane */

    /* convert bits so they may be used by standard bitreader */
106
    s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
107 108

    init_get_bits(&gb, s->tmpbuf, size * 8);
109 110
    for (j = 0; j < h; j++) {
        for (i = 0; i < w*step; i += step) {
111
            dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
112 113 114
            /* lines are stored as deltas between previous lines
             * and we need to add 0x80 to the first lines of chroma planes
             */
115 116 117 118
            if (j)
                dst[i] += dst[i - stride];
            else if (Uoff)
                dst[i] += 0x80;
119
            if (get_bits_left(&gb) < 0) {
120
                ff_free_vlc(&vlc);
121
                return AVERROR_INVALIDDATA;
122
            }
123 124 125
        }
        dst += stride;
    }
126
    ff_free_vlc(&vlc);
127 128
    return 0;
}
129

130
static int decode_frame(AVCodecContext *avctx,
131
                        void *data, int *got_frame,
132
                        AVPacket *avpkt)
133 134
{
    FrapsContext * const s = avctx->priv_data;
135 136 137 138
    const uint8_t *buf     = avpkt->data;
    int buf_size           = avpkt->size;
    AVFrame *frame         = data;
    AVFrame * const f      = &s->frame;
139 140 141
    uint32_t header;
    unsigned int version,header_size;
    unsigned int x, y;
Michael Niedermayer's avatar
Michael Niedermayer committed
142
    const uint32_t *buf32;
143
    uint32_t *luma1,*luma2,*cb,*cr;
144
    uint32_t offs[4];
145
    int i, j, ret, is_chroma;
146
    const int planes = 3;
147
    uint8_t *out;
148
    enum AVPixelFormat pix_fmt;
149

150 151
    header      = AV_RL32(buf);
    version     = header & 0xff;
152 153
    header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */

154
    if (version > 5) {
155
        av_log(avctx, AV_LOG_ERROR,
156
               "This file is encoded with Fraps version %d. " \
157
               "This codec can only decode versions <= 5.\n", version);
158
        return AVERROR_PATCHWELCOME;
159 160
    }

161
    buf += header_size;
162

163
    if (version < 2) {
164
        unsigned needed_size = avctx->width * avctx->height * 3;
165 166
        if (version == 0) needed_size /= 2;
        needed_size += header_size;
167 168
        /* bit 31 means same as previous pic */
        if (header & (1U<<31)) {
169
            *got_frame = 0;
170 171
            return buf_size;
        }
172 173 174 175
        if (buf_size != needed_size) {
            av_log(avctx, AV_LOG_ERROR,
                   "Invalid frame length %d (should be %d)\n",
                   buf_size, needed_size);
176
            return AVERROR_INVALIDDATA;
177
        }
178 179 180
    } else {
        /* skip frame */
        if (buf_size == 8) {
181
            *got_frame = 0;
182 183
            return buf_size;
        }
184 185
        if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
            av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
186
            return AVERROR_INVALIDDATA;
187
        }
188
        for (i = 0; i < planes; i++) {
189
            offs[i] = AV_RL32(buf + 4 + i * 4);
190
            if (offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
191
                av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
192
                return AVERROR_INVALIDDATA;
193 194
            }
        }
195
        offs[planes] = buf_size - header_size;
196
        for (i = 0; i < planes; i++) {
197 198 199 200
            av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
            if (!s->tmpbuf)
                return AVERROR(ENOMEM);
        }
201 202
    }

203
    if (f->data[0])
204
        ff_thread_release_buffer(avctx, f);
205 206
    f->pict_type = AV_PICTURE_TYPE_I;
    f->key_frame = 1;
207 208
    f->reference = 0;
    f->buffer_hints = FF_BUFFER_HINTS_VALID;
209

210
    pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
211 212 213 214 215
    if (avctx->pix_fmt != pix_fmt && f->data[0]) {
        avctx->release_buffer(avctx, f);
    }
    avctx->pix_fmt = pix_fmt;

216
    if ((ret = ff_thread_get_buffer(avctx, f))) {
217
        av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
218
        return ret;
219
    }
220

221
    switch (version) {
222 223 224
    case 0:
    default:
        /* Fraps v0 is a reordered YUV420 */
225
        if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
226
            av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
227
                   avctx->width, avctx->height);
228
            return AVERROR_INVALIDDATA;
229 230
        }

231 232 233 234 235 236 237
        buf32 = (const uint32_t*)buf;
        for (y = 0; y < avctx->height / 2; y++) {
            luma1 = (uint32_t*)&f->data[0][  y * 2      * f->linesize[0] ];
            luma2 = (uint32_t*)&f->data[0][ (y * 2 + 1) * f->linesize[0] ];
            cr    = (uint32_t*)&f->data[1][  y          * f->linesize[1] ];
            cb    = (uint32_t*)&f->data[2][  y          * f->linesize[2] ];
            for (x = 0; x < avctx->width; x += 8) {
238 239 240 241 242 243
                *luma1++ = *buf32++;
                *luma1++ = *buf32++;
                *luma2++ = *buf32++;
                *luma2++ = *buf32++;
                *cr++    = *buf32++;
                *cb++    = *buf32++;
244
            }
245
        }
246 247 248 249
        break;

    case 1:
        /* Fraps v1 is an upside-down BGR24 */
250
            for (y = 0; y<avctx->height; y++)
251
                memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
252 253
                       &buf[y * avctx->width * 3],
                       3 * avctx->width);
254 255 256
        break;

    case 2:
257
    case 4:
258
        /**
259
         * Fraps v2 is Huffman-coded YUV420 planes
260
         * Fraps v4 is virtually the same
261
         */
262
        for (i = 0; i < planes; i++) {
263
            is_chroma = !!i;
264 265 266 267 268
            if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
                                           avctx->width  >> is_chroma,
                                           avctx->height >> is_chroma,
                                           buf + offs[i], offs[i + 1] - offs[i],
                                           is_chroma, 1)) < 0) {
269
                av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
270
                return ret;
271 272
            }
        }
273
        break;
274
    case 3:
275 276
    case 5:
        /* Virtually the same as version 4, but is for RGB24 */
277
        for (i = 0; i < planes; i++) {
278 279 280
            if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
                                           -f->linesize[0], avctx->width, avctx->height,
                                           buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
281
                av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
282
                return ret;
283 284
            }
        }
285
        out = f->data[0];
286
        // convert pseudo-YUV into real RGB
287
        for (j = 0; j < avctx->height; j++) {
288 289 290 291 292
            uint8_t *line_end = out + 3*avctx->width;
            while (out < line_end) {
                out[0]  += out[1];
                out[2]  += out[1];
                out += 3;
293
            }
294
            out += f->linesize[0] - 3*avctx->width;
295
        }
296
        break;
297 298 299
    }

    *frame = *f;
300
    *got_frame = 1;
301 302 303 304 305 306 307 308 309 310

    return buf_size;
}


/**
 * closes decoder
 * @param avctx codec context
 * @return 0 on success or negative if fails
 */
311
static av_cold int decode_end(AVCodecContext *avctx)
312 313 314 315 316 317
{
    FrapsContext *s = (FrapsContext*)avctx->priv_data;

    if (s->frame.data[0])
        avctx->release_buffer(avctx, &s->frame);

318
    av_freep(&s->tmpbuf);
319 320 321 322
    return 0;
}


323
AVCodec ff_fraps_decoder = {
324 325
    .name           = "fraps",
    .type           = AVMEDIA_TYPE_VIDEO,
326
    .id             = AV_CODEC_ID_FRAPS,
327 328 329 330
    .priv_data_size = sizeof(FrapsContext),
    .init           = decode_init,
    .close          = decode_end,
    .decode         = decode_frame,
331
    .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
332
    .long_name      = NULL_IF_CONFIG_SMALL("Fraps"),
333
};