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