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