3 * Copyright (c) 2005 Roine Gustafsson
4 * Copyright (c) 2006 Konstantin Shishkov
6 * This file is part of FFmpeg.
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.
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.
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
25 * Lossless Fraps 'FPS1' decoder
26 * @author Roine Gustafsson (roine at users sf net)
27 * @author Konstantin Shishkov
29 * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
31 * Version 2 files support by Konstantin Shishkov
37 #include "bytestream.h"
41 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
44 * local variable storage
46 typedef struct FrapsContext {
47 AVCodecContext *avctx;
57 * @param avctx codec context
58 * @return 0 on success or negative if fails
60 static av_cold int decode_init(AVCodecContext *avctx)
62 FrapsContext * const s = avctx->priv_data;
64 avcodec_get_frame_defaults(&s->frame);
65 avctx->coded_frame = &s->frame;
70 ff_dsputil_init(&s->dsp, avctx);
76 * Comparator - our nodes should ascend by count
77 * but with preserved symbol order
79 static int huff_cmp(const void *va, const void *vb)
81 const Node *a = va, *b = vb;
82 return (a->count - b->count)*256 + a->sym - b->sym;
86 * decode Fraps v2 packed plane
88 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
89 int h, const uint8_t *src, int size, int Uoff,
97 for (i = 0; i < 256; i++)
98 nodes[i].count = bytestream_get_le32(&src);
100 if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
101 FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
103 /* we have built Huffman table and are ready to decode plane */
105 /* convert bits so they may be used by standard bitreader */
106 s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
108 init_get_bits(&gb, s->tmpbuf, size * 8);
109 for (j = 0; j < h; j++) {
110 for (i = 0; i < w*step; i += step) {
111 dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
112 /* lines are stored as deltas between previous lines
113 * and we need to add 0x80 to the first lines of chroma planes
116 dst[i] += dst[i - stride];
119 if (get_bits_left(&gb) < 0) {
121 return AVERROR_INVALIDDATA;
130 static int decode_frame(AVCodecContext *avctx,
131 void *data, int *got_frame,
134 FrapsContext * const s = avctx->priv_data;
135 const uint8_t *buf = avpkt->data;
136 int buf_size = avpkt->size;
137 AVFrame *frame = data;
138 AVFrame * const f = &s->frame;
140 unsigned int version,header_size;
142 const uint32_t *buf32;
143 uint32_t *luma1,*luma2,*cb,*cr;
145 int i, j, ret, is_chroma;
146 const int planes = 3;
148 enum AVPixelFormat pix_fmt;
150 header = AV_RL32(buf);
151 version = header & 0xff;
152 header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
155 av_log(avctx, AV_LOG_ERROR,
156 "This file is encoded with Fraps version %d. " \
157 "This codec can only decode versions <= 5.\n", version);
158 return AVERROR_PATCHWELCOME;
164 unsigned needed_size = avctx->width * avctx->height * 3;
165 if (version == 0) needed_size /= 2;
166 needed_size += header_size;
167 /* bit 31 means same as previous pic */
168 if (header & (1U<<31)) {
172 if (buf_size != needed_size) {
173 av_log(avctx, AV_LOG_ERROR,
174 "Invalid frame length %d (should be %d)\n",
175 buf_size, needed_size);
176 return AVERROR_INVALIDDATA;
184 if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
185 av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
186 return AVERROR_INVALIDDATA;
188 for (i = 0; i < planes; i++) {
189 offs[i] = AV_RL32(buf + 4 + i * 4);
190 if (offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
191 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
192 return AVERROR_INVALIDDATA;
195 offs[planes] = buf_size - header_size;
196 for (i = 0; i < planes; i++) {
197 av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
199 return AVERROR(ENOMEM);
204 ff_thread_release_buffer(avctx, f);
205 f->pict_type = AV_PICTURE_TYPE_I;
208 f->buffer_hints = FF_BUFFER_HINTS_VALID;
210 pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
211 if (avctx->pix_fmt != pix_fmt && f->data[0]) {
212 avctx->release_buffer(avctx, f);
214 avctx->pix_fmt = pix_fmt;
216 if ((ret = ff_thread_get_buffer(avctx, f))) {
217 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
224 /* Fraps v0 is a reordered YUV420 */
225 if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
226 av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
227 avctx->width, avctx->height);
228 return AVERROR_INVALIDDATA;
231 buf32 = (const uint32_t*)buf;
232 for (y = 0; y < avctx->height / 2; y++) {
233 luma1 = (uint32_t*)&f->data[0][ y * 2 * f->linesize[0] ];
234 luma2 = (uint32_t*)&f->data[0][ (y * 2 + 1) * f->linesize[0] ];
235 cr = (uint32_t*)&f->data[1][ y * f->linesize[1] ];
236 cb = (uint32_t*)&f->data[2][ y * f->linesize[2] ];
237 for (x = 0; x < avctx->width; x += 8) {
249 /* Fraps v1 is an upside-down BGR24 */
250 for (y = 0; y<avctx->height; y++)
251 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
252 &buf[y * avctx->width * 3],
259 * Fraps v2 is Huffman-coded YUV420 planes
260 * Fraps v4 is virtually the same
262 for (i = 0; i < planes; i++) {
264 if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
265 avctx->width >> is_chroma,
266 avctx->height >> is_chroma,
267 buf + offs[i], offs[i + 1] - offs[i],
268 is_chroma, 1)) < 0) {
269 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
276 /* Virtually the same as version 4, but is for RGB24 */
277 for (i = 0; i < planes; i++) {
278 if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
279 -f->linesize[0], avctx->width, avctx->height,
280 buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
281 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
286 // convert pseudo-YUV into real RGB
287 for (j = 0; j < avctx->height; j++) {
288 uint8_t *line_end = out + 3*avctx->width;
289 while (out < line_end) {
294 out += f->linesize[0] - 3*avctx->width;
308 * @param avctx codec context
309 * @return 0 on success or negative if fails
311 static av_cold int decode_end(AVCodecContext *avctx)
313 FrapsContext *s = (FrapsContext*)avctx->priv_data;
315 if (s->frame.data[0])
316 avctx->release_buffer(avctx, &s->frame);
318 av_freep(&s->tmpbuf);
323 AVCodec ff_fraps_decoder = {
325 .type = AVMEDIA_TYPE_VIDEO,
326 .id = AV_CODEC_ID_FRAPS,
327 .priv_data_size = sizeof(FrapsContext),
330 .decode = decode_frame,
331 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
332 .long_name = NULL_IF_CONFIG_SMALL("Fraps"),