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