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