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){
80 const Node *a = va, *b = vb;
81 return (a->count - b->count)*256 + a->sym - b->sym;
85 * decode Fraps v2 packed plane
87 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
88 int h, const uint8_t *src, int size, int Uoff,
96 for(i = 0; i < 256; i++)
97 nodes[i].count = bytestream_get_le32(&src);
99 if (ff_huff_build_tree(s->avctx, &vlc, 256, nodes, huff_cmp,
100 FF_HUFFMAN_FLAG_ZERO_COUNT) < 0)
102 /* we have built Huffman table and are ready to decode plane */
104 /* convert bits so they may be used by standard bitreader */
105 s->dsp.bswap_buf((uint32_t *)s->tmpbuf, (const uint32_t *)src, size >> 2);
107 init_get_bits(&gb, s->tmpbuf, size * 8);
108 for(j = 0; j < h; j++){
109 for(i = 0; i < w*step; i += step){
110 dst[i] = get_vlc2(&gb, vlc.table, 9, 3);
111 /* lines are stored as deltas between previous lines
112 * and we need to add 0x80 to the first lines of chroma planes
114 if(j) dst[i] += dst[i - stride];
115 else if(Uoff) dst[i] += 0x80;
116 if (get_bits_left(&gb) < 0) {
118 return AVERROR_INVALIDDATA;
127 static int decode_frame(AVCodecContext *avctx,
128 void *data, int *data_size,
131 const uint8_t *buf = avpkt->data;
132 int buf_size = avpkt->size;
133 FrapsContext * const s = avctx->priv_data;
134 AVFrame *frame = data;
135 AVFrame * const f = &s->frame;
137 unsigned int version,header_size;
139 const uint32_t *buf32;
140 uint32_t *luma1,*luma2,*cb,*cr;
143 const int planes = 3;
145 enum AVPixelFormat pix_fmt;
148 header = AV_RL32(buf);
149 version = header & 0xff;
150 header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
153 av_log(avctx, AV_LOG_ERROR,
154 "This file is encoded with Fraps version %d. " \
155 "This codec can only decode versions <= 5.\n", version);
156 return AVERROR_PATCHWELCOME;
162 unsigned needed_size = avctx->width*avctx->height*3;
163 if (version == 0) needed_size /= 2;
164 needed_size += header_size;
165 /* bit 31 means same as previous pic */
166 if (header & (1U<<31)) {
170 if (buf_size != needed_size) {
171 av_log(avctx, AV_LOG_ERROR,
172 "Invalid frame length %d (should be %d)\n",
173 buf_size, needed_size);
174 return AVERROR_INVALIDDATA;
182 if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
183 av_log(avctx, AV_LOG_ERROR, "Fraps: error in data stream\n");
184 return AVERROR_INVALIDDATA;
186 for(i = 0; i < planes; i++) {
187 offs[i] = AV_RL32(buf + 4 + i * 4);
188 if(offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
189 av_log(avctx, AV_LOG_ERROR, "Fraps: plane %i offset is out of bounds\n", i);
190 return AVERROR_INVALIDDATA;
193 offs[planes] = buf_size - header_size;
194 for(i = 0; i < planes; i++) {
195 av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
197 return AVERROR(ENOMEM);
202 ff_thread_release_buffer(avctx, f);
203 f->pict_type = AV_PICTURE_TYPE_I;
206 f->buffer_hints = FF_BUFFER_HINTS_VALID;
208 pix_fmt = version & 1 ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
209 if (avctx->pix_fmt != pix_fmt && f->data[0]) {
210 avctx->release_buffer(avctx, f);
212 avctx->pix_fmt = pix_fmt;
214 if ((ret = ff_thread_get_buffer(avctx, f))) {
215 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
222 /* Fraps v0 is a reordered YUV420 */
223 if ( (avctx->width % 8) != 0 || (avctx->height % 2) != 0 ) {
224 av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
225 avctx->width, avctx->height);
226 return AVERROR_INVALIDDATA;
229 buf32=(const uint32_t*)buf;
230 for(y=0; y<avctx->height/2; y++){
231 luma1=(uint32_t*)&f->data[0][ y*2*f->linesize[0] ];
232 luma2=(uint32_t*)&f->data[0][ (y*2+1)*f->linesize[0] ];
233 cr=(uint32_t*)&f->data[1][ y*f->linesize[1] ];
234 cb=(uint32_t*)&f->data[2][ y*f->linesize[2] ];
235 for(x=0; x<avctx->width; x+=8){
247 /* Fraps v1 is an upside-down BGR24 */
248 for(y=0; y<avctx->height; y++)
249 memcpy(&f->data[0][ (avctx->height-y)*f->linesize[0] ],
250 &buf[y*avctx->width*3],
257 * Fraps v2 is Huffman-coded YUV420 planes
258 * Fraps v4 is virtually the same
260 for(i = 0; i < planes; i++){
262 if(fraps2_decode_plane(s, f->data[i], f->linesize[i], avctx->width >> is_chroma,
263 avctx->height >> is_chroma, buf + offs[i], offs[i + 1] - offs[i], is_chroma, 1) < 0) {
264 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
265 return AVERROR_INVALIDDATA;
271 /* Virtually the same as version 4, but is for RGB24 */
272 for(i = 0; i < planes; i++){
273 if(fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)), -f->linesize[0],
274 avctx->width, avctx->height, buf + offs[i], offs[i + 1] - offs[i], 0, 3) < 0) {
275 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
276 return AVERROR_INVALIDDATA;
280 // convert pseudo-YUV into real RGB
281 for(j = 0; j < avctx->height; j++){
282 uint8_t *line_end = out + 3*avctx->width;
283 while (out < line_end) {
288 out += f->linesize[0] - 3*avctx->width;
294 *data_size = sizeof(AVFrame);
302 * @param avctx codec context
303 * @return 0 on success or negative if fails
305 static av_cold int decode_end(AVCodecContext *avctx)
307 FrapsContext *s = (FrapsContext*)avctx->priv_data;
309 if (s->frame.data[0])
310 avctx->release_buffer(avctx, &s->frame);
312 av_freep(&s->tmpbuf);
317 AVCodec ff_fraps_decoder = {
319 .type = AVMEDIA_TYPE_VIDEO,
320 .id = AV_CODEC_ID_FRAPS,
321 .priv_data_size = sizeof(FrapsContext),
324 .decode = decode_frame,
325 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
326 .long_name = NULL_IF_CONFIG_SMALL("Fraps"),