git.sesse.net Git - ffmpeg/blob - 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 #include "internal.h"
  40 #include "thread.h"
  41
  42 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
  43 #define VLC_BITS 11
  44
  45 /**
  46  * local variable storage
  47  */
  48 typedef struct FrapsContext {
  49     AVCodecContext *avctx;
  50     uint8_t *tmpbuf;
  51     int tmpbuf_size;
  52     DSPContext dsp;
  53 } FrapsContext;
  54
  55
  56 /**
  57  * initializes decoder
  58  * @param avctx codec context
  59  * @return 0 on success or negative if fails
  60  */
  61 static av_cold int decode_init(AVCodecContext *avctx)
  62 {
  63     FrapsContext * const s = avctx->priv_data;
  64
  65     s->avctx  = avctx;
  66     s->tmpbuf = NULL;
  67
  68     ff_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 {
  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, ret;
  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 ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, VLC_BITS,
  99                                   nodes, huff_cmp,
 100                                   FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
 101         return ret;
 102     /* we have built Huffman table and are ready to decode plane */
 103
 104     /* convert bits so they may be used by standard bitreader */
 105     s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
 106
 107     init_get_bits(&gb, s->tmpbuf, size * 8);
 108     for (j = 0; j < h; j++) {
 109         for (i = 0; i < w*step; i += step) {
 110             dst[i] = get_vlc2(&gb, vlc.table, VLC_BITS, 3);
 111             /* lines are stored as deltas between previous lines
 112              * and we need to add 0x80 to the first lines of chroma planes
 113              */
 114             if (j)
 115                 dst[i] += dst[i - stride];
 116             else if (Uoff)
 117                 dst[i] += 0x80;
 118             if (get_bits_left(&gb) < 0) {
 119                 ff_free_vlc(&vlc);
 120                 return AVERROR_INVALIDDATA;
 121             }
 122         }
 123         dst += stride;
 124     }
 125     ff_free_vlc(&vlc);
 126     return 0;
 127 }
 128
 129 static int decode_frame(AVCodecContext *avctx,
 130                         void *data, int *got_frame,
 131                         AVPacket *avpkt)
 132 {
 133     FrapsContext * const s = avctx->priv_data;
 134     const uint8_t *buf     = avpkt->data;
 135     int buf_size           = avpkt->size;
 136     ThreadFrame frame = { .f = data };
 137     AVFrame * const f = data;
 138     uint32_t header;
 139     unsigned int version,header_size;
 140     unsigned int x, y;
 141     const uint32_t *buf32;
 142     uint32_t *luma1,*luma2,*cb,*cr;
 143     uint32_t offs[4];
 144     int i, j, ret, is_chroma;
 145     const int planes = 3;
 146     uint8_t *out;
 147
 148     if (buf_size < 4) {
 149         av_log(avctx, AV_LOG_ERROR, "Packet is too short\n");
 150         return AVERROR_INVALIDDATA;
 151     }
 152
 153     header      = AV_RL32(buf);
 154     version     = header & 0xff;
 155     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
 156
 157     if (version > 5) {
 158         av_log(avctx, AV_LOG_ERROR,
 159                "This file is encoded with Fraps version %d. " \
 160                "This codec can only decode versions <= 5.\n", version);
 161         return AVERROR_PATCHWELCOME;
 162     }
 163
 164     buf += header_size;
 165
 166     if (version < 2) {
 167         unsigned needed_size = avctx->width * avctx->height * 3;
 168         if (version == 0) needed_size /= 2;
 169         needed_size += header_size;
 170         /* bit 31 means same as previous pic */
 171         if (header & (1U<<31)) {
 172             *got_frame = 0;
 173             return buf_size;
 174         }
 175         if (buf_size != needed_size) {
 176             av_log(avctx, AV_LOG_ERROR,
 177                    "Invalid frame length %d (should be %d)\n",
 178                    buf_size, needed_size);
 179             return AVERROR_INVALIDDATA;
 180         }
 181     } else {
 182         /* skip frame */
 183         if (buf_size == 8) {
 184             *got_frame = 0;
 185             return buf_size;
 186         }
 187         if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
 188             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
 189             return AVERROR_INVALIDDATA;
 190         }
 191         for (i = 0; i < planes; i++) {
 192             offs[i] = AV_RL32(buf + 4 + i * 4);
 193             if (offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
 194                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
 195                 return AVERROR_INVALIDDATA;
 196             }
 197         }
 198         offs[planes] = buf_size - header_size;
 199         for (i = 0; i < planes; i++) {
 200             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
 201             if (!s->tmpbuf)
 202                 return AVERROR(ENOMEM);
 203         }
 204     }
 205
 206     f->pict_type = AV_PICTURE_TYPE_I;
 207     f->key_frame = 1;
 208
 209     avctx->pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
 210     avctx->color_range = version & 1 ? AVCOL_RANGE_UNSPECIFIED : AVCOL_RANGE_JPEG;
 211     avctx->colorspace = version & 1 ? AVCOL_SPC_UNSPECIFIED : AVCOL_SPC_BT709;
 212
 213     if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
 214         return ret;
 215
 216     switch (version) {
 217     case 0:
 218     default:
 219         /* Fraps v0 is a reordered YUV420 */
 220         if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
 221             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
 222                    avctx->width, avctx->height);
 223             return AVERROR_INVALIDDATA;
 224         }
 225
 226         buf32 = (const uint32_t*)buf;
 227         for (y = 0; y < avctx->height / 2; y++) {
 228             luma1 = (uint32_t*)&f->data[0][  y * 2      * f->linesize[0] ];
 229             luma2 = (uint32_t*)&f->data[0][ (y * 2 + 1) * f->linesize[0] ];
 230             cr    = (uint32_t*)&f->data[1][  y          * f->linesize[1] ];
 231             cb    = (uint32_t*)&f->data[2][  y          * f->linesize[2] ];
 232             for (x = 0; x < avctx->width; x += 8) {
 233                 *luma1++ = *buf32++;
 234                 *luma1++ = *buf32++;
 235                 *luma2++ = *buf32++;
 236                 *luma2++ = *buf32++;
 237                 *cr++    = *buf32++;
 238                 *cb++    = *buf32++;
 239             }
 240         }
 241         break;
 242
 243     case 1:
 244         /* Fraps v1 is an upside-down BGR24 */
 245             for (y = 0; y<avctx->height; y++)
 246                 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
 247                        &buf[y * avctx->width * 3],
 248                        3 * avctx->width);
 249         break;
 250
 251     case 2:
 252     case 4:
 253         /**
 254          * Fraps v2 is Huffman-coded YUV420 planes
 255          * Fraps v4 is virtually the same
 256          */
 257         for (i = 0; i < planes; i++) {
 258             is_chroma = !!i;
 259             if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
 260                                            avctx->width  >> is_chroma,
 261                                            avctx->height >> is_chroma,
 262                                            buf + offs[i], offs[i + 1] - offs[i],
 263                                            is_chroma, 1)) < 0) {
 264                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
 265                 return ret;
 266             }
 267         }
 268         break;
 269     case 3:
 270     case 5:
 271         /* Virtually the same as version 4, but is for RGB24 */
 272         for (i = 0; i < planes; i++) {
 273             if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
 274                                            -f->linesize[0], avctx->width, avctx->height,
 275                                            buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
 276                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
 277                 return ret;
 278             }
 279         }
 280         out = f->data[0];
 281         // convert pseudo-YUV into real RGB
 282         for (j = 0; j < avctx->height; j++) {
 283             uint8_t *line_end = out + 3*avctx->width;
 284             while (out < line_end) {
 285                 out[0]  += out[1];
 286                 out[2]  += out[1];
 287                 out += 3;
 288             }
 289             out += f->linesize[0] - 3*avctx->width;
 290         }
 291         break;
 292     }
 293
 294     *got_frame = 1;
 295
 296     return buf_size;
 297 }
 298
 299
 300 /**
 301  * closes decoder
 302  * @param avctx codec context
 303  * @return 0 on success or negative if fails
 304  */
 305 static av_cold int decode_end(AVCodecContext *avctx)
 306 {
 307     FrapsContext *s = (FrapsContext*)avctx->priv_data;
 308
 309     av_freep(&s->tmpbuf);
 310     return 0;
 311 }
 312
 313
 314 AVCodec ff_fraps_decoder = {
 315     .name           = "fraps",
 316     .long_name      = NULL_IF_CONFIG_SMALL("Fraps"),
 317     .type           = AVMEDIA_TYPE_VIDEO,
 318     .id             = AV_CODEC_ID_FRAPS,
 319     .priv_data_size = sizeof(FrapsContext),
 320     .init           = decode_init,
 321     .close          = decode_end,
 322     .decode         = decode_frame,
 323     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
 324 };