yading@10: /*
yading@10:  * Fraps FPS1 decoder
yading@10:  * Copyright (c) 2005 Roine Gustafsson
yading@10:  * Copyright (c) 2006 Konstantin Shishkov
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * Lossless Fraps 'FPS1' decoder
yading@10:  * @author Roine Gustafsson (roine at users sf net)
yading@10:  * @author Konstantin Shishkov
yading@10:  *
yading@10:  * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
yading@10:  *
yading@10:  * Version 2 files support by Konstantin Shishkov
yading@10:  */
yading@10: 
yading@10: #include "avcodec.h"
yading@10: #include "get_bits.h"
yading@10: #include "huffman.h"
yading@10: #include "bytestream.h"
yading@10: #include "dsputil.h"
yading@10: #include "internal.h"
yading@10: #include "thread.h"
yading@10: 
yading@10: #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
yading@10: 
yading@10: /**
yading@10:  * local variable storage
yading@10:  */
yading@10: typedef struct FrapsContext {
yading@10:     AVCodecContext *avctx;
yading@10:     uint8_t *tmpbuf;
yading@10:     int tmpbuf_size;
yading@10:     DSPContext dsp;
yading@10: } FrapsContext;
yading@10: 
yading@10: 
yading@10: /**
yading@10:  * initializes decoder
yading@10:  * @param avctx codec context
yading@10:  * @return 0 on success or negative if fails
yading@10:  */
yading@10: static av_cold int decode_init(AVCodecContext *avctx)
yading@10: {
yading@10:     FrapsContext * const s = avctx->priv_data;
yading@10: 
yading@10:     s->avctx  = avctx;
yading@10:     s->tmpbuf = NULL;
yading@10: 
yading@10:     ff_dsputil_init(&s->dsp, avctx);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: /**
yading@10:  * Comparator - our nodes should ascend by count
yading@10:  * but with preserved symbol order
yading@10:  */
yading@10: static int huff_cmp(const void *va, const void *vb)
yading@10: {
yading@10:     const Node *a = va, *b = vb;
yading@10:     return (a->count - b->count)*256 + a->sym - b->sym;
yading@10: }
yading@10: 
yading@10: /**
yading@10:  * decode Fraps v2 packed plane
yading@10:  */
yading@10: static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
yading@10:                                int h, const uint8_t *src, int size, int Uoff,
yading@10:                                const int step)
yading@10: {
yading@10:     int i, j, ret;
yading@10:     GetBitContext gb;
yading@10:     VLC vlc;
yading@10:     Node nodes[512];
yading@10: 
yading@10:     for (i = 0; i < 256; i++)
yading@10:         nodes[i].count = bytestream_get_le32(&src);
yading@10:     size -= 1024;
yading@10:     if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
yading@10:                                   FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
yading@10:         return ret;
yading@10:     /* we have built Huffman table and are ready to decode plane */
yading@10: 
yading@10:     /* convert bits so they may be used by standard bitreader */
yading@10:     s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
yading@10: 
yading@10:     init_get_bits(&gb, s->tmpbuf, size * 8);
yading@10:     for (j = 0; j < h; j++) {
yading@10:         for (i = 0; i < w*step; i += step) {
yading@10:             dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
yading@10:             /* lines are stored as deltas between previous lines
yading@10:              * and we need to add 0x80 to the first lines of chroma planes
yading@10:              */
yading@10:             if (j)
yading@10:                 dst[i] += dst[i - stride];
yading@10:             else if (Uoff)
yading@10:                 dst[i] += 0x80;
yading@10:             if (get_bits_left(&gb) < 0) {
yading@10:                 ff_free_vlc(&vlc);
yading@10:                 return AVERROR_INVALIDDATA;
yading@10:             }
yading@10:         }
yading@10:         dst += stride;
yading@10:     }
yading@10:     ff_free_vlc(&vlc);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int decode_frame(AVCodecContext *avctx,
yading@10:                         void *data, int *got_frame,
yading@10:                         AVPacket *avpkt)
yading@10: {
yading@10:     FrapsContext * const s = avctx->priv_data;
yading@10:     const uint8_t *buf     = avpkt->data;
yading@10:     int buf_size           = avpkt->size;
yading@10:     ThreadFrame frame = { .f = data };
yading@10:     AVFrame * const f = data;
yading@10:     uint32_t header;
yading@10:     unsigned int version,header_size;
yading@10:     unsigned int x, y;
yading@10:     const uint32_t *buf32;
yading@10:     uint32_t *luma1,*luma2,*cb,*cr;
yading@10:     uint32_t offs[4];
yading@10:     int i, j, ret, is_chroma;
yading@10:     const int planes = 3;
yading@10:     uint8_t *out;
yading@10: 
yading@10:     header      = AV_RL32(buf);
yading@10:     version     = header & 0xff;
yading@10:     header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
yading@10: 
yading@10:     if (version > 5) {
yading@10:         av_log(avctx, AV_LOG_ERROR,
yading@10:                "This file is encoded with Fraps version %d. " \
yading@10:                "This codec can only decode versions <= 5.\n", version);
yading@10:         return AVERROR_PATCHWELCOME;
yading@10:     }
yading@10: 
yading@10:     buf += header_size;
yading@10: 
yading@10:     if (version < 2) {
yading@10:         unsigned needed_size = avctx->width * avctx->height * 3;
yading@10:         if (version == 0) needed_size /= 2;
yading@10:         needed_size += header_size;
yading@10:         /* bit 31 means same as previous pic */
yading@10:         if (header & (1U<<31)) {
yading@10:             *got_frame = 0;
yading@10:             return buf_size;
yading@10:         }
yading@10:         if (buf_size != needed_size) {
yading@10:             av_log(avctx, AV_LOG_ERROR,
yading@10:                    "Invalid frame length %d (should be %d)\n",
yading@10:                    buf_size, needed_size);
yading@10:             return AVERROR_INVALIDDATA;
yading@10:         }
yading@10:     } else {
yading@10:         /* skip frame */
yading@10:         if (buf_size == 8) {
yading@10:             *got_frame = 0;
yading@10:             return buf_size;
yading@10:         }
yading@10:         if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
yading@10:             av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
yading@10:             return AVERROR_INVALIDDATA;
yading@10:         }
yading@10:         for (i = 0; i < planes; i++) {
yading@10:             offs[i] = AV_RL32(buf + 4 + i * 4);
yading@10:             if (offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
yading@10:                 return AVERROR_INVALIDDATA;
yading@10:             }
yading@10:         }
yading@10:         offs[planes] = buf_size - header_size;
yading@10:         for (i = 0; i < planes; i++) {
yading@10:             av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
yading@10:             if (!s->tmpbuf)
yading@10:                 return AVERROR(ENOMEM);
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     f->pict_type = AV_PICTURE_TYPE_I;
yading@10:     f->key_frame = 1;
yading@10: 
yading@10:     avctx->pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
yading@10: 
yading@10:     if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
yading@10:         return ret;
yading@10: 
yading@10:     switch (version) {
yading@10:     case 0:
yading@10:     default:
yading@10:         /* Fraps v0 is a reordered YUV420 */
yading@10:         if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
yading@10:             av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
yading@10:                    avctx->width, avctx->height);
yading@10:             return AVERROR_INVALIDDATA;
yading@10:         }
yading@10: 
yading@10:         buf32 = (const uint32_t*)buf;
yading@10:         for (y = 0; y < avctx->height / 2; y++) {
yading@10:             luma1 = (uint32_t*)&f->data[0][  y * 2      * f->linesize[0] ];
yading@10:             luma2 = (uint32_t*)&f->data[0][ (y * 2 + 1) * f->linesize[0] ];
yading@10:             cr    = (uint32_t*)&f->data[1][  y          * f->linesize[1] ];
yading@10:             cb    = (uint32_t*)&f->data[2][  y          * f->linesize[2] ];
yading@10:             for (x = 0; x < avctx->width; x += 8) {
yading@10:                 *luma1++ = *buf32++;
yading@10:                 *luma1++ = *buf32++;
yading@10:                 *luma2++ = *buf32++;
yading@10:                 *luma2++ = *buf32++;
yading@10:                 *cr++    = *buf32++;
yading@10:                 *cb++    = *buf32++;
yading@10:             }
yading@10:         }
yading@10:         break;
yading@10: 
yading@10:     case 1:
yading@10:         /* Fraps v1 is an upside-down BGR24 */
yading@10:             for (y = 0; y<avctx->height; y++)
yading@10:                 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
yading@10:                        &buf[y * avctx->width * 3],
yading@10:                        3 * avctx->width);
yading@10:         break;
yading@10: 
yading@10:     case 2:
yading@10:     case 4:
yading@10:         /**
yading@10:          * Fraps v2 is Huffman-coded YUV420 planes
yading@10:          * Fraps v4 is virtually the same
yading@10:          */
yading@10:         for (i = 0; i < planes; i++) {
yading@10:             is_chroma = !!i;
yading@10:             if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
yading@10:                                            avctx->width  >> is_chroma,
yading@10:                                            avctx->height >> is_chroma,
yading@10:                                            buf + offs[i], offs[i + 1] - offs[i],
yading@10:                                            is_chroma, 1)) < 0) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
yading@10:                 return ret;
yading@10:             }
yading@10:         }
yading@10:         break;
yading@10:     case 3:
yading@10:     case 5:
yading@10:         /* Virtually the same as version 4, but is for RGB24 */
yading@10:         for (i = 0; i < planes; i++) {
yading@10:             if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
yading@10:                                            -f->linesize[0], avctx->width, avctx->height,
yading@10:                                            buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
yading@10:                 return ret;
yading@10:             }
yading@10:         }
yading@10:         out = f->data[0];
yading@10:         // convert pseudo-YUV into real RGB
yading@10:         for (j = 0; j < avctx->height; j++) {
yading@10:             uint8_t *line_end = out + 3*avctx->width;
yading@10:             while (out < line_end) {
yading@10:                 out[0]  += out[1];
yading@10:                 out[2]  += out[1];
yading@10:                 out += 3;
yading@10:             }
yading@10:             out += f->linesize[0] - 3*avctx->width;
yading@10:         }
yading@10:         break;
yading@10:     }
yading@10: 
yading@10:     *got_frame = 1;
yading@10: 
yading@10:     return buf_size;
yading@10: }
yading@10: 
yading@10: 
yading@10: /**
yading@10:  * closes decoder
yading@10:  * @param avctx codec context
yading@10:  * @return 0 on success or negative if fails
yading@10:  */
yading@10: static av_cold int decode_end(AVCodecContext *avctx)
yading@10: {
yading@10:     FrapsContext *s = (FrapsContext*)avctx->priv_data;
yading@10: 
yading@10:     av_freep(&s->tmpbuf);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: 
yading@10: AVCodec ff_fraps_decoder = {
yading@10:     .name           = "fraps",
yading@10:     .type           = AVMEDIA_TYPE_VIDEO,
yading@10:     .id             = AV_CODEC_ID_FRAPS,
yading@10:     .priv_data_size = sizeof(FrapsContext),
yading@10:     .init           = decode_init,
yading@10:     .close          = decode_end,
yading@10:     .decode         = decode_frame,
yading@10:     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
yading@10:     .long_name      = NULL_IF_CONFIG_SMALL("Fraps"),
yading@10: };