FFmpeg
fraps.c
Go to the documentation of this file.
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 "config.h"
35 
36 #define CACHED_BITSTREAM_READER HAVE_FAST_64BIT
37 #define UNCHECKED_BITSTREAM_READER 1
38 #include "avcodec.h"
39 #include "get_bits.h"
40 #include "huffman.h"
41 #include "bytestream.h"
42 #include "bswapdsp.h"
43 #include "codec_internal.h"
44 #include "thread.h"
45 
46 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
47 #define VLC_BITS 11
48 
49 /**
50  * local variable storage
51  */
52 typedef struct FrapsContext {
55  uint8_t *tmpbuf;
57 } FrapsContext;
58 
59 
60 /**
61  * initializes decoder
62  * @param avctx codec context
63  * @return 0 on success or negative if fails
64  */
66 {
67  FrapsContext * const s = avctx->priv_data;
68 
69  s->avctx = avctx;
70  s->tmpbuf = NULL;
71 
72  ff_bswapdsp_init(&s->bdsp);
73 
74  return 0;
75 }
76 
77 /**
78  * Comparator - our nodes should ascend by count
79  * but with preserved symbol order
80  */
81 static int huff_cmp(const void *va, const void *vb)
82 {
83  const Node *a = va, *b = vb;
84  return (a->count - b->count)*256 + a->sym - b->sym;
85 }
86 
87 /**
88  * decode Fraps v2 packed plane
89  */
90 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
91  int h, const uint8_t *src, int size, int Uoff,
92  const int step)
93 {
94  int i, j, ret;
95  GetBitContext gb;
96  VLC vlc;
97  Node nodes[512];
98 
99  for (i = 0; i < 256; i++)
100  nodes[i].count = bytestream_get_le32(&src);
101  size -= 1024;
102  if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, VLC_BITS,
103  nodes, huff_cmp,
105  return ret;
106  /* we have built Huffman table and are ready to decode plane */
107 
108  /* convert bits so they may be used by standard bitreader */
109  s->bdsp.bswap_buf((uint32_t *) s->tmpbuf,
110  (const uint32_t *) src, size >> 2);
111 
112  if ((ret = init_get_bits8(&gb, s->tmpbuf, size)) < 0)
113  return ret;
114 
115  for (j = 0; j < h; j++) {
116  for (i = 0; i < w*step; i += step) {
117  dst[i] = get_vlc2(&gb, vlc.table, VLC_BITS, 3);
118  /* lines are stored as deltas between previous lines
119  * and we need to add 0x80 to the first lines of chroma planes
120  */
121  if (j)
122  dst[i] += dst[i - stride];
123  else if (Uoff)
124  dst[i] += 0x80;
125  if (get_bits_left(&gb) < 0) {
126  ff_free_vlc(&vlc);
127  return AVERROR_INVALIDDATA;
128  }
129  }
130  dst += stride;
131  }
132  ff_free_vlc(&vlc);
133  return 0;
134 }
135 
136 static int decode_frame(AVCodecContext *avctx, AVFrame *f,
137  int *got_frame, AVPacket *avpkt)
138 {
139  FrapsContext * const s = avctx->priv_data;
140  const uint8_t *buf = avpkt->data;
141  int buf_size = avpkt->size;
142  uint32_t header;
143  unsigned int version,header_size;
144  const uint32_t *buf32;
145  uint32_t *luma1,*luma2,*cb,*cr;
146  uint32_t offs[4];
147  int i, j, ret, is_chroma;
148  const int planes = 3;
149  int is_pal;
150  uint8_t *out;
151 
152  if (buf_size < 4) {
153  av_log(avctx, AV_LOG_ERROR, "Packet is too short\n");
154  return AVERROR_INVALIDDATA;
155  }
156 
157  header = AV_RL32(buf);
158  version = header & 0xff;
159  is_pal = buf[1] == 2 && version == 1;
160  header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
161 
162  if (version > 5) {
163  avpriv_report_missing_feature(avctx, "Fraps version %u", version);
164  return AVERROR_PATCHWELCOME;
165  }
166 
167  buf += header_size;
168 
169  if (is_pal) {
170  unsigned needed_size = avctx->width * avctx->height + 1024;
171  needed_size += header_size;
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;
177  }
178  } else if (version < 2) {
179  unsigned needed_size = avctx->width * avctx->height * 3;
180  if (version == 0) needed_size /= 2;
181  needed_size += header_size;
182  /* bit 31 means same as previous pic */
183  if (header & (1U<<31)) {
184  *got_frame = 0;
185  return buf_size;
186  }
187  if (buf_size != needed_size) {
188  av_log(avctx, AV_LOG_ERROR,
189  "Invalid frame length %d (should be %d)\n",
190  buf_size, needed_size);
191  return AVERROR_INVALIDDATA;
192  }
193  } else {
194  /* skip frame */
195  if (buf_size == 8) {
196  *got_frame = 0;
197  return buf_size;
198  }
199  if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
200  av_log(avctx, AV_LOG_ERROR, "error in data stream\n");
201  return AVERROR_INVALIDDATA;
202  }
203  for (i = 0; i < planes; i++) {
204  offs[i] = AV_RL32(buf + 4 + i * 4);
205  if (offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
206  av_log(avctx, AV_LOG_ERROR, "plane %i offset is out of bounds\n", i);
207  return AVERROR_INVALIDDATA;
208  }
209  }
210  offs[planes] = buf_size - header_size;
211  for (i = 0; i < planes; i++) {
212  av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
213  if (!s->tmpbuf)
214  return AVERROR(ENOMEM);
215  }
216  }
217 
218  f->pict_type = AV_PICTURE_TYPE_I;
219  f->key_frame = 1;
220 
225 
226  if ((ret = ff_thread_get_buffer(avctx, f, 0)) < 0)
227  return ret;
228 
229  switch (version) {
230  case 0:
231  default:
232  /* Fraps v0 is a reordered YUV420 */
233  if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
234  av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
235  avctx->width, avctx->height);
236  return AVERROR_INVALIDDATA;
237  }
238 
239  buf32 = (const uint32_t*)buf;
240  for (ptrdiff_t y = 0; y < avctx->height / 2; y++) {
241  luma1 = (uint32_t*)&f->data[0][ y * 2 * f->linesize[0] ];
242  luma2 = (uint32_t*)&f->data[0][ (y * 2 + 1) * f->linesize[0] ];
243  cr = (uint32_t*)&f->data[1][ y * f->linesize[1] ];
244  cb = (uint32_t*)&f->data[2][ y * f->linesize[2] ];
245  for (ptrdiff_t x = 0; x < avctx->width; x += 8) {
246  *luma1++ = *buf32++;
247  *luma1++ = *buf32++;
248  *luma2++ = *buf32++;
249  *luma2++ = *buf32++;
250  *cr++ = *buf32++;
251  *cb++ = *buf32++;
252  }
253  }
254  break;
255 
256  case 1:
257  if (is_pal) {
258  uint32_t *pal = (uint32_t *)f->data[1];
259 
260  for (unsigned y = 0; y < 256; y++) {
261  pal[y] = AV_RL32(buf) | 0xFF000000;
262  buf += 4;
263  }
264 
265  for (ptrdiff_t y = 0; y < avctx->height; y++)
266  memcpy(&f->data[0][y * f->linesize[0]],
267  &buf[y * avctx->width],
268  avctx->width);
269  } else {
270  /* Fraps v1 is an upside-down BGR24 */
271  for (ptrdiff_t y = 0; y < avctx->height; y++)
272  memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
273  &buf[y * avctx->width * 3],
274  3 * avctx->width);
275  }
276  break;
277 
278  case 2:
279  case 4:
280  /**
281  * Fraps v2 is Huffman-coded YUV420 planes
282  * Fraps v4 is virtually the same
283  */
284  for (i = 0; i < planes; i++) {
285  is_chroma = !!i;
286  if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
287  avctx->width >> is_chroma,
288  avctx->height >> is_chroma,
289  buf + offs[i], offs[i + 1] - offs[i],
290  is_chroma, 1)) < 0) {
291  av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
292  return ret;
293  }
294  }
295  break;
296  case 3:
297  case 5:
298  /* Virtually the same as version 4, but is for RGB24 */
299  for (i = 0; i < planes; i++) {
300  if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
301  -f->linesize[0], avctx->width, avctx->height,
302  buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
303  av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
304  return ret;
305  }
306  }
307  out = f->data[0];
308  // convert pseudo-YUV into real RGB
309  for (j = 0; j < avctx->height; j++) {
310  uint8_t *line_end = out + 3*avctx->width;
311  while (out < line_end) {
312  out[0] += out[1];
313  out[2] += out[1];
314  out += 3;
315  }
316  out += f->linesize[0] - 3*avctx->width;
317  }
318  break;
319  }
320 
321  *got_frame = 1;
322 
323  return buf_size;
324 }
325 
326 
327 /**
328  * closes decoder
329  * @param avctx codec context
330  * @return 0 on success or negative if fails
331  */
333 {
334  FrapsContext *s = (FrapsContext*)avctx->priv_data;
335 
336  av_freep(&s->tmpbuf);
337  return 0;
338 }
339 
340 
342  .p.name = "fraps",
343  CODEC_LONG_NAME("Fraps"),
344  .p.type = AVMEDIA_TYPE_VIDEO,
345  .p.id = AV_CODEC_ID_FRAPS,
346  .priv_data_size = sizeof(FrapsContext),
347  .init = decode_init,
348  .close = decode_end,
350  .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
351 };
bswapdsp.h
FrapsContext::avctx
AVCodecContext * avctx
Definition: fraps.c:53
get_bits_left
static int get_bits_left(GetBitContext *gb)
Definition: get_bits.h:839
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AVCodecContext::colorspace
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:975
out
FILE * out
Definition: movenc.c:54
Node
Definition: agm.c:897
cb
static double cb(void *priv, double x, double y)
Definition: vf_geq.c:239
ff_fraps_decoder
const FFCodec ff_fraps_decoder
Definition: fraps.c:341
FrapsContext::tmpbuf_size
int tmpbuf_size
Definition: fraps.c:56
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
step
trying all byte sequences megabyte in length and selecting the best looking sequence will yield cases to try But a word about which is also called distortion Distortion can be quantified by almost any quality measurement one chooses the sum of squared differences is used but more complex methods that consider psychovisual effects can be used as well It makes no difference in this discussion First step
Definition: rate_distortion.txt:58
w
uint8_t w
Definition: llviddspenc.c:38
AVCOL_RANGE_JPEG
@ AVCOL_RANGE_JPEG
Full range content.
Definition: pixfmt.h:661
AVPacket::data
uint8_t * data
Definition: packet.h:374
b
#define b
Definition: input.c:41
FFCodec
Definition: codec_internal.h:119
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
decode_end
static av_cold int decode_end(AVCodecContext *avctx)
closes decoder
Definition: fraps.c:332
thread.h
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:123
FF_HUFFMAN_FLAG_ZERO_COUNT
#define FF_HUFFMAN_FLAG_ZERO_COUNT
Definition: huffman.h:40
GetBitContext
Definition: get_bits.h:61
ff_thread_get_buffer
the pkt_dts and pkt_pts fields in AVFrame will work as usual Restrictions on codec whose streams don t reset across will not work because their bitstreams cannot be decoded in parallel *The contents of buffers must not be read before as well as code calling up to before the decode process starts Call have so the codec calls ff_thread_report set FF_CODEC_CAP_ALLOCATE_PROGRESS in AVCodec caps_internal and use ff_thread_get_buffer() to allocate frames. The frames must then be freed with ff_thread_release_buffer(). Otherwise decode directly into the user-supplied frames. Call ff_thread_report_progress() after some part of the current picture has decoded. A good place to put this is where draw_horiz_band() is called - add this if it isn 't called anywhere
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
init_get_bits8
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
Definition: get_bits.h:667
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:298
s
#define s(width, name)
Definition: cbs_vp9.c:256
FrapsContext
local variable storage
Definition: fraps.c:52
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts_bsf.c:363
get_bits.h
planes
static const struct @345 planes[]
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:264
AV_CODEC_CAP_FRAME_THREADS
#define AV_CODEC_CAP_FRAME_THREADS
Codec supports frame-level multithreading.
Definition: codec.h:113
FPS_TAG
#define FPS_TAG
Definition: fraps.c:46
ff_bswapdsp_init
av_cold void ff_bswapdsp_init(BswapDSPContext *c)
Definition: bswapdsp.c:49
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
AVCodecContext::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:982
fraps2_decode_plane
static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w, int h, const uint8_t *src, int size, int Uoff, const int step)
decode Fraps v2 packed plane
Definition: fraps.c:90
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:78
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
get_vlc2
static av_always_inline int get_vlc2(GetBitContext *s, const VLCElem *table, int bits, int max_depth)
Parse a vlc code.
Definition: get_bits.h:787
AVCOL_RANGE_UNSPECIFIED
@ AVCOL_RANGE_UNSPECIFIED
Definition: pixfmt.h:627
decode_frame
static int decode_frame(AVCodecContext *avctx, AVFrame *f, int *got_frame, AVPacket *avpkt)
Definition: fraps.c:136
AV_CODEC_ID_FRAPS
@ AV_CODEC_ID_FRAPS
Definition: codec_id.h:128
f
f
Definition: af_crystalizer.c:122
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:375
codec_internal.h
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
size
int size
Definition: twinvq_data.h:10344
avpriv_report_missing_feature
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
header
static const uint8_t header[24]
Definition: sdr2.c:67
a
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
Definition: undefined.txt:41
FrapsContext::bdsp
BswapDSPContext bdsp
Definition: fraps.c:54
version
version
Definition: libkvazaar.c:313
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
av_fast_padded_malloc
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
Definition: utils.c:49
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
AVCOL_SPC_UNSPECIFIED
@ AVCOL_SPC_UNSPECIFIED
Definition: pixfmt.h:590
AVCodecContext::height
int height
Definition: avcodec.h:571
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
ff_free_vlc
void ff_free_vlc(VLC *vlc)
Definition: vlc.c:375
avcodec.h
stride
#define stride
Definition: h264pred_template.c:537
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
ret
ret
Definition: filter_design.txt:187
ff_huff_build_tree
int ff_huff_build_tree(void *logctx, VLC *vlc, int nb_codes, int nb_bits, Node *nodes, HuffCmp cmp, int flags)
nodes size must be 2*nb_codes first nb_codes nodes.count must be set
Definition: huffman.c:159
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
U
#define U(x)
Definition: vpx_arith.h:37
FrapsContext::tmpbuf
uint8_t * tmpbuf
Definition: fraps.c:55
huff_cmp
static int huff_cmp(const void *va, const void *vb)
Comparator - our nodes should ascend by count but with preserved symbol order.
Definition: fraps.c:81
AVCodecContext
main external API structure.
Definition: avcodec.h:398
VLC
Definition: vlc.h:31
huffman.h
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
initializes decoder
Definition: fraps.c:65
VLC::table
VLCElem * table
Definition: vlc.h:33
VLC_BITS
#define VLC_BITS
Definition: fraps.c:47
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
cr
static double cr(void *priv, double x, double y)
Definition: vf_geq.c:240
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
bytestream.h
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
BswapDSPContext
Definition: bswapdsp.h:24
h
h
Definition: vp9dsp_template.c:2038
AVCOL_SPC_BT709
@ AVCOL_SPC_BT709
also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / derived in SMPTE RP 177 Annex B
Definition: pixfmt.h:589