FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
eatgv.c
Go to the documentation of this file.
1 /*
2  * Electronic Arts TGV Video Decoder
3  * Copyright (c) 2007-2008 Peter Ross
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * Electronic Arts TGV Video Decoder
25  * by Peter Ross (pross@xvid.org)
26  *
27  * Technical details here:
28  * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_TGV
29  */
30 
31 #include "avcodec.h"
32 #define BITSTREAM_READER_LE
33 #include "get_bits.h"
34 #include "internal.h"
35 #include "libavutil/imgutils.h"
36 #include "libavutil/mem.h"
37 
38 #define EA_PREAMBLE_SIZE 8
39 #define kVGT_TAG MKTAG('k', 'V', 'G', 'T')
40 
41 typedef struct TgvContext {
47 
48  int (*mv_codebook)[2];
50  int num_mvs; ///< current length of mv_codebook
51  int num_blocks_packed; ///< current length of block_codebook
52 } TgvContext;
53 
55 {
56  TgvContext *s = avctx->priv_data;
57  s->avctx = avctx;
58  avctx->framerate = (AVRational){ 15, 1 };
59  avctx->pix_fmt = AV_PIX_FMT_PAL8;
60 
62  if (!s->last_frame)
63  return AVERROR(ENOMEM);
64 
65  return 0;
66 }
67 
68 /**
69  * Unpack buffer
70  * @return 0 on success, -1 on critical buffer underflow
71  */
72 static int unpack(const uint8_t *src, const uint8_t *src_end,
73  uint8_t *dst, int width, int height)
74 {
75  uint8_t *dst_end = dst + width*height;
76  int size, size1, size2, offset, run;
77  uint8_t *dst_start = dst;
78 
79  if (src[0] & 0x01)
80  src += 5;
81  else
82  src += 2;
83 
84  if (src_end - src < 3)
85  return AVERROR_INVALIDDATA;
86  size = AV_RB24(src);
87  src += 3;
88 
89  while (size > 0 && src < src_end) {
90 
91  /* determine size1 and size2 */
92  size1 = (src[0] & 3);
93  if (src[0] & 0x80) { // 1
94  if (src[0] & 0x40 ) { // 11
95  if (src[0] & 0x20) { // 111
96  if (src[0] < 0xFC) // !(111111)
97  size1 = (((src[0] & 31) + 1) << 2);
98  src++;
99  size2 = 0;
100  } else { // 110
101  offset = ((src[0] & 0x10) << 12) + AV_RB16(&src[1]) + 1;
102  size2 = ((src[0] & 0xC) << 6) + src[3] + 5;
103  src += 4;
104  }
105  } else { // 10
106  size1 = ((src[1] & 0xC0) >> 6);
107  offset = (AV_RB16(&src[1]) & 0x3FFF) + 1;
108  size2 = (src[0] & 0x3F) + 4;
109  src += 3;
110  }
111  } else { // 0
112  offset = ((src[0] & 0x60) << 3) + src[1] + 1;
113  size2 = ((src[0] & 0x1C) >> 2) + 3;
114  src += 2;
115  }
116 
117 
118  /* fetch strip from src */
119  if (size1 > src_end - src)
120  break;
121 
122  if (size1 > 0) {
123  size -= size1;
124  run = FFMIN(size1, dst_end - dst);
125  memcpy(dst, src, run);
126  dst += run;
127  src += run;
128  }
129 
130  if (size2 > 0) {
131  if (dst - dst_start < offset)
132  return 0;
133  size -= size2;
134  run = FFMIN(size2, dst_end - dst);
135  av_memcpy_backptr(dst, offset, run);
136  dst += run;
137  }
138  }
139 
140  return 0;
141 }
142 
143 /**
144  * Decode inter-frame
145  * @return 0 on success, -1 on critical buffer underflow
146  */
148  const uint8_t *buf, const uint8_t *buf_end)
149 {
150  int num_mvs;
151  int num_blocks_raw;
152  int num_blocks_packed;
153  int vector_bits;
154  int i,j,x,y;
155  GetBitContext gb;
156  int mvbits;
157  const uint8_t *blocks_raw;
158 
159  if(buf_end - buf < 12)
160  return AVERROR_INVALIDDATA;
161 
162  num_mvs = AV_RL16(&buf[0]);
163  num_blocks_raw = AV_RL16(&buf[2]);
164  num_blocks_packed = AV_RL16(&buf[4]);
165  vector_bits = AV_RL16(&buf[6]);
166  buf += 12;
167 
168  if (vector_bits > MIN_CACHE_BITS || !vector_bits) {
170  "Invalid value for motion vector bits: %d\n", vector_bits);
171  return AVERROR_INVALIDDATA;
172  }
173 
174  /* allocate codebook buffers as necessary */
175  if (num_mvs > s->num_mvs) {
176  int err = av_reallocp_array(&s->mv_codebook, num_mvs, sizeof(*s->mv_codebook));
177  if (err < 0) {
178  s->num_mvs = 0;
179  return err;
180  }
181  s->num_mvs = num_mvs;
182  }
183 
184  if (num_blocks_packed > s->num_blocks_packed) {
185  int err;
186  if ((err = av_reallocp(&s->block_codebook, num_blocks_packed * 16)) < 0) {
187  s->num_blocks_packed = 0;
188  return err;
189  }
190  s->num_blocks_packed = num_blocks_packed;
191  }
192 
193  /* read motion vectors */
194  mvbits = (num_mvs * 2 * 10 + 31) & ~31;
195 
196  if (buf_end - buf < (mvbits>>3) + 16*num_blocks_raw + 8*num_blocks_packed)
197  return AVERROR_INVALIDDATA;
198 
199  init_get_bits(&gb, buf, mvbits);
200  for (i = 0; i < num_mvs; i++) {
201  s->mv_codebook[i][0] = get_sbits(&gb, 10);
202  s->mv_codebook[i][1] = get_sbits(&gb, 10);
203  }
204  buf += mvbits >> 3;
205 
206  /* note ptr to uncompressed blocks */
207  blocks_raw = buf;
208  buf += num_blocks_raw * 16;
209 
210  /* read compressed blocks */
211  init_get_bits(&gb, buf, (buf_end - buf) << 3);
212  for (i = 0; i < num_blocks_packed; i++) {
213  int tmp[4];
214  for (j = 0; j < 4; j++)
215  tmp[j] = get_bits(&gb, 8);
216  for (j = 0; j < 16; j++)
217  s->block_codebook[i][15-j] = tmp[get_bits(&gb, 2)];
218  }
219 
220  if (get_bits_left(&gb) < vector_bits *
221  (s->avctx->height / 4) * (s->avctx->width / 4))
222  return AVERROR_INVALIDDATA;
223 
224  /* read vectors and build frame */
225  for (y = 0; y < s->avctx->height / 4; y++)
226  for (x = 0; x < s->avctx->width / 4; x++) {
227  unsigned int vector = get_bits(&gb, vector_bits);
228  const uint8_t *src;
229  int src_stride;
230 
231  if (vector < num_mvs) {
232  int mx = x * 4 + s->mv_codebook[vector][0];
233  int my = y * 4 + s->mv_codebook[vector][1];
234 
235  if (mx < 0 || mx + 4 > s->avctx->width ||
236  my < 0 || my + 4 > s->avctx->height) {
237  av_log(s->avctx, AV_LOG_ERROR, "MV %d %d out of picture\n", mx, my);
238  continue;
239  }
240 
241  src = s->last_frame->data[0] + mx + my * s->last_frame->linesize[0];
242  src_stride = s->last_frame->linesize[0];
243  } else {
244  int offset = vector - num_mvs;
245  if (offset < num_blocks_raw)
246  src = blocks_raw + 16*offset;
247  else if (offset - num_blocks_raw < num_blocks_packed)
248  src = s->block_codebook[offset - num_blocks_raw];
249  else
250  continue;
251  src_stride = 4;
252  }
253 
254  for (j = 0; j < 4; j++)
255  for (i = 0; i < 4; i++)
256  frame->data[0][(y * 4 + j) * frame->linesize[0] + (x * 4 + i)] =
257  src[j * src_stride + i];
258  }
259 
260  return 0;
261 }
262 
264  void *data, int *got_frame,
265  AVPacket *avpkt)
266 {
267  const uint8_t *buf = avpkt->data;
268  int buf_size = avpkt->size;
269  TgvContext *s = avctx->priv_data;
270  const uint8_t *buf_end = buf + buf_size;
271  AVFrame *frame = data;
272  int chunk_type, ret;
273 
274  if (buf_end - buf < EA_PREAMBLE_SIZE)
275  return AVERROR_INVALIDDATA;
276 
277  chunk_type = AV_RL32(&buf[0]);
278  buf += EA_PREAMBLE_SIZE;
279 
280  if (chunk_type == kVGT_TAG) {
281  int pal_count, i;
282  if(buf_end - buf < 12) {
283  av_log(avctx, AV_LOG_WARNING, "truncated header\n");
284  return AVERROR_INVALIDDATA;
285  }
286 
287  s->width = AV_RL16(&buf[0]);
288  s->height = AV_RL16(&buf[2]);
289  if (s->avctx->width != s->width || s->avctx->height != s->height) {
290  av_freep(&s->frame_buffer);
292  if ((ret = ff_set_dimensions(s->avctx, s->width, s->height)) < 0)
293  return ret;
294  }
295 
296  pal_count = AV_RL16(&buf[6]);
297  buf += 12;
298  for(i = 0; i < pal_count && i < AVPALETTE_COUNT && buf_end - buf >= 3; i++) {
299  s->palette[i] = 0xFFU << 24 | AV_RB24(buf);
300  buf += 3;
301  }
302  }
303 
304  if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
305  return ret;
306 
307  memcpy(frame->data[1], s->palette, AVPALETTE_SIZE);
308 
309  if (chunk_type == kVGT_TAG) {
310  int y;
311  frame->key_frame = 1;
312  frame->pict_type = AV_PICTURE_TYPE_I;
313 
314  if (!s->frame_buffer &&
315  !(s->frame_buffer = av_mallocz(s->width * s->height)))
316  return AVERROR(ENOMEM);
317 
318  if (unpack(buf, buf_end, s->frame_buffer, s->avctx->width, s->avctx->height) < 0) {
319  av_log(avctx, AV_LOG_WARNING, "truncated intra frame\n");
320  return AVERROR_INVALIDDATA;
321  }
322  for (y = 0; y < s->height; y++)
323  memcpy(frame->data[0] + y * frame->linesize[0],
324  s->frame_buffer + y * s->width,
325  s->width);
326  } else {
327  if (!s->last_frame->data[0]) {
328  av_log(avctx, AV_LOG_WARNING, "inter frame without corresponding intra frame\n");
329  return buf_size;
330  }
331  frame->key_frame = 0;
332  frame->pict_type = AV_PICTURE_TYPE_P;
333  if (tgv_decode_inter(s, frame, buf, buf_end) < 0) {
334  av_log(avctx, AV_LOG_WARNING, "truncated inter frame\n");
335  return AVERROR_INVALIDDATA;
336  }
337  }
338 
340  if ((ret = av_frame_ref(s->last_frame, frame)) < 0)
341  return ret;
342 
343  *got_frame = 1;
344 
345  return buf_size;
346 }
347 
349 {
350  TgvContext *s = avctx->priv_data;
352  av_freep(&s->frame_buffer);
353  av_freep(&s->mv_codebook);
355  return 0;
356 }
357 
359  .name = "eatgv",
360  .long_name = NULL_IF_CONFIG_SMALL("Electronic Arts TGV video"),
361  .type = AVMEDIA_TYPE_VIDEO,
362  .id = AV_CODEC_ID_TGV,
363  .priv_data_size = sizeof(TgvContext),
365  .close = tgv_decode_end,
367  .capabilities = AV_CODEC_CAP_DR1,
368 };
int height
Definition: eatgv.c:45
AVRational framerate
Definition: avcodec.h:3331
const char * s
Definition: avisynth_c.h:631
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AVFrame * last_frame
Definition: eatgv.c:43
This structure describes decoded (raw) audio or video data.
Definition: frame.h:180
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
misc image utilities
static unsigned int get_bits(GetBitContext *s, int n)
Read 1-25 bits.
Definition: get_bits.h:260
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int width
Definition: eatgv.c:45
memory handling functions
int ff_set_dimensions(AVCodecContext *s, int width, int height)
Check that the provided frame dimensions are valid and set them on the codec context.
Definition: utils.c:210
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1578
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1870
uint8_t run
Definition: svq3.c:192
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:87
AVCodec.
Definition: avcodec.h:3535
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
static int get_sbits(GetBitContext *s, int n)
Definition: get_bits.h:245
uint8_t
#define av_cold
Definition: attributes.h:82
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:140
8 bit with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:73
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:374
#define kVGT_TAG
Definition: eatgv.c:39
AVCodecContext * avctx
Definition: eatgv.c:42
static AVFrame * frame
uint8_t * data
Definition: avcodec.h:1577
bitstream reader API header.
ptrdiff_t size
Definition: opengl_enc.c:101
#define av_log(a,...)
int(* mv_codebook)[2]
Definition: eatgv.c:48
#define U(x)
Definition: vp56_arith.h:37
static int get_bits_left(GetBitContext *gb)
Definition: get_bits.h:607
int av_reallocp_array(void *ptr, size_t nmemb, size_t size)
Definition: mem.c:215
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AVERROR(e)
Definition: error.h:43
static av_cold int tgv_decode_end(AVCodecContext *avctx)
Definition: eatgv.c:348
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:153
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
int num_mvs
current length of mv_codebook
Definition: eatgv.c:50
const char * name
Name of the codec implementation.
Definition: avcodec.h:3542
static const uint8_t offset[127][2]
Definition: vf_spp.c:92
uint32_t palette[AVPALETTE_COUNT]
Definition: eatgv.c:46
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:254
#define FFMIN(a, b)
Definition: common.h:96
uint8_t(* block_codebook)[16]
Definition: eatgv.c:49
int width
picture width / height.
Definition: avcodec.h:1829
static uint8_t tmp[8]
Definition: des-test.c:38
#define width
#define src
Definition: vp9dsp.c:530
AVCodec ff_eatgv_decoder
Definition: eatgv.c:358
uint8_t * frame_buffer
Definition: eatgv.c:44
int num_blocks_packed
current length of block_codebook
Definition: eatgv.c:51
#define EA_PREAMBLE_SIZE
Definition: eatgv.c:38
Libavcodec external API header.
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_RB24
Definition: bytestream.h:87
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:211
main external API structure.
Definition: avcodec.h:1642
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: utils.c:928
void * buf
Definition: avisynth_c.h:553
static int tgv_decode_inter(TgvContext *s, AVFrame *frame, const uint8_t *buf, const uint8_t *buf_end)
Decode inter-frame.
Definition: eatgv.c:147
rational number numerator/denominator
Definition: rational.h:43
static int init_get_bits(GetBitContext *s, const uint8_t *buffer, int bit_size)
Initialize GetBitContext.
Definition: get_bits.h:418
static av_cold int tgv_decode_init(AVCodecContext *avctx)
Definition: eatgv.c:54
#define AVPALETTE_COUNT
Definition: pixfmt.h:33
#define MIN_CACHE_BITS
Definition: get_bits.h:125
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:481
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:194
static int unpack(const uint8_t *src, const uint8_t *src_end, uint8_t *dst, int width, int height)
Unpack buffer.
Definition: eatgv.c:72
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:722
common internal api header.
int av_reallocp(void *ptr, size_t size)
Allocate or reallocate a block of memory.
Definition: mem.c:187
static const int num_mvs[RV34_MB_TYPES]
number of motion vectors in each macroblock type
Definition: rv34.c:851
void * priv_data
Definition: avcodec.h:1684
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:249
#define av_freep(p)
void av_memcpy_backptr(uint8_t *dst, int back, int cnt)
deliberately overlapping memcpy implementation
Definition: mem.c:430
static int tgv_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: eatgv.c:263
#define height
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1554
#define AV_GET_BUFFER_FLAG_REF
The decoder will keep a reference to the frame and may reuse it later.
Definition: avcodec.h:1338
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:252
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:953
Predicted.
Definition: avutil.h:267