3 * Copyright (c) 2005 Roine Gustafsson
4 * Copyright (c) 2006 Konstantin Shishkov
6 * This file is part of Libav.
8 * Libav 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 * Libav 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 Libav; 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 avctx->pix_fmt = AV_PIX_FMT_NONE; /* set in decode_frame */
69 avcodec_get_frame_defaults(&s->frame);
71 ff_dsputil_init(&s->dsp, avctx);
77 * Comparator - our nodes should ascend by count
78 * but with preserved symbol order
80 static int huff_cmp(const void *va, const void *vb)
82 const Node *a = va, *b = vb;
83 return (a->count - b->count)*256 + a->sym - b->sym;
87 * decode Fraps v2 packed plane
89 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
90 int h, const uint8_t *src, int size, int Uoff,
98 for (i = 0; i < 256; i++)
99 nodes[i].count = bytestream_get_le32(&src);
101 if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
102 FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
104 /* we have built Huffman table and are ready to decode plane */
106 /* convert bits so they may be used by standard bitreader */
107 s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
109 init_get_bits(&gb, s->tmpbuf, size * 8);
110 for (j = 0; j < h; j++) {
111 for (i = 0; i < w*step; i += step) {
112 dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
113 /* lines are stored as deltas between previous lines
114 * and we need to add 0x80 to the first lines of chroma planes
117 dst[i] += dst[i - stride];
120 if (get_bits_left(&gb) < 0) {
122 return AVERROR_INVALIDDATA;
131 static int decode_frame(AVCodecContext *avctx,
132 void *data, int *got_frame,
135 FrapsContext * const s = avctx->priv_data;
136 const uint8_t *buf = avpkt->data;
137 int buf_size = avpkt->size;
138 AVFrame *frame = data;
139 AVFrame * const f = &s->frame;
141 unsigned int version,header_size;
143 const uint32_t *buf32;
144 uint32_t *luma1,*luma2,*cb,*cr;
146 int i, j, ret, is_chroma, planes;
147 enum AVPixelFormat pix_fmt;
148 int prev_pic_bit, expected_size;
151 av_log(avctx, AV_LOG_ERROR, "Packet is too short\n");
152 return AVERROR_INVALIDDATA;
155 header = AV_RL32(buf);
156 version = header & 0xff;
157 header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
158 prev_pic_bit = header & (1U << 31); /* bit 31 means same as previous pic */
161 av_log(avctx, AV_LOG_ERROR,
162 "This file is encoded with Fraps version %d. " \
163 "This codec can only decode versions <= 5.\n", version);
164 return AVERROR_PATCHWELCOME;
168 if (header_size == 8)
171 pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
172 if (avctx->pix_fmt != pix_fmt && f->data[0]) {
175 avctx->pix_fmt = pix_fmt;
177 expected_size = header_size;
182 /* Fraps v0 is a reordered YUV420 */
184 expected_size += avctx->width * avctx->height * 3 / 2;
185 if (buf_size != expected_size) {
186 av_log(avctx, AV_LOG_ERROR,
187 "Invalid frame length %d (should be %d)\n",
188 buf_size, expected_size);
189 return AVERROR_INVALIDDATA;
192 if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
193 av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
194 avctx->width, avctx->height);
195 return AVERROR_INVALIDDATA;
198 if ((ret = ff_reget_buffer(avctx, f)) < 0) {
199 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
202 f->pict_type = prev_pic_bit ? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
203 f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
205 if (f->pict_type == AV_PICTURE_TYPE_I) {
206 buf32 = (const uint32_t*)buf;
207 for (y = 0; y < avctx->height / 2; y++) {
208 luma1 = (uint32_t*)&f->data[0][ y * 2 * f->linesize[0]];
209 luma2 = (uint32_t*)&f->data[0][(y * 2 + 1) * f->linesize[0]];
210 cr = (uint32_t*)&f->data[1][ y * f->linesize[1]];
211 cb = (uint32_t*)&f->data[2][ y * f->linesize[2]];
212 for (x = 0; x < avctx->width; x += 8) {
213 *(luma1++) = *(buf32++);
214 *(luma1++) = *(buf32++);
215 *(luma2++) = *(buf32++);
216 *(luma2++) = *(buf32++);
217 *(cr++) = *(buf32++);
218 *(cb++) = *(buf32++);
225 /* Fraps v1 is an upside-down BGR24 */
227 expected_size += avctx->width * avctx->height * 3;
228 if (buf_size != expected_size) {
229 av_log(avctx, AV_LOG_ERROR,
230 "Invalid frame length %d (should be %d)\n",
231 buf_size, expected_size);
232 return AVERROR_INVALIDDATA;
235 if ((ret = ff_reget_buffer(avctx, f)) < 0) {
236 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
239 f->pict_type = prev_pic_bit ? AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
240 f->key_frame = f->pict_type == AV_PICTURE_TYPE_I;
242 if (f->pict_type == AV_PICTURE_TYPE_I) {
243 for (y = 0; y<avctx->height; y++)
244 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
245 &buf[y * avctx->width * 3],
253 * Fraps v2 is Huffman-coded YUV420 planes
254 * Fraps v4 is virtually the same
257 if ((ret = ff_reget_buffer(avctx, f)) < 0) {
258 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
263 f->pict_type = AV_PICTURE_TYPE_P;
267 f->pict_type = AV_PICTURE_TYPE_I;
269 if ((AV_RL32(buf) != FPS_TAG) || (buf_size < (planes * 1024 + 24))) {
270 av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
271 return AVERROR_INVALIDDATA;
273 for (i = 0; i < planes; i++) {
274 offs[i] = AV_RL32(buf + 4 + i * 4);
275 if (offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
276 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
277 return AVERROR_INVALIDDATA;
280 offs[planes] = buf_size;
281 for (i = 0; i < planes; i++) {
283 av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size,
284 offs[i + 1] - offs[i] - 1024);
286 return AVERROR(ENOMEM);
287 if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
288 avctx->width >> is_chroma,
289 avctx->height >> is_chroma,
290 buf + offs[i], offs[i + 1] - offs[i],
291 is_chroma, 1)) < 0) {
292 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
299 /* Virtually the same as version 4, but is for RGB24 */
301 if ((ret = ff_reget_buffer(avctx, f)) < 0) {
302 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
307 f->pict_type = AV_PICTURE_TYPE_P;
311 f->pict_type = AV_PICTURE_TYPE_I;
313 if ((AV_RL32(buf) != FPS_TAG)||(buf_size < (planes*1024 + 24))) {
314 av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
315 return AVERROR_INVALIDDATA;
317 for (i = 0; i < planes; i++) {
318 offs[i] = AV_RL32(buf + 4 + i * 4);
319 if (offs[i] >= buf_size || (i && offs[i] <= offs[i - 1] + 1024)) {
320 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
321 return AVERROR_INVALIDDATA;
324 offs[planes] = buf_size;
325 for (i = 0; i < planes; i++) {
326 av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size,
327 offs[i + 1] - offs[i] - 1024);
329 return AVERROR(ENOMEM);
330 if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
331 -f->linesize[0], avctx->width, avctx->height,
332 buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
333 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
337 // convert pseudo-YUV into real RGB
338 for (j = 0; j < avctx->height; j++) {
339 for (i = 0; i < avctx->width; i++) {
340 f->data[0][0 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
341 f->data[0][2 + i*3 + j*f->linesize[0]] += f->data[0][1 + i*3 + j*f->linesize[0]];
347 if ((ret = av_frame_ref(frame, f)) < 0)
357 * @param avctx codec context
358 * @return 0 on success or negative if fails
360 static av_cold int decode_end(AVCodecContext *avctx)
362 FrapsContext *s = (FrapsContext*)avctx->priv_data;
364 av_frame_unref(&s->frame);
366 av_freep(&s->tmpbuf);
371 AVCodec ff_fraps_decoder = {
373 .long_name = NULL_IF_CONFIG_SMALL("Fraps"),
374 .type = AVMEDIA_TYPE_VIDEO,
375 .id = AV_CODEC_ID_FRAPS,
376 .priv_data_size = sizeof(FrapsContext),
379 .decode = decode_frame,
380 .capabilities = CODEC_CAP_DR1,