indeo4.c
Go to the documentation of this file.
1 /*
2  * Indeo Video Interactive v4 compatible decoder
3  * Copyright (c) 2009-2011 Maxim Poliakovski
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
30 #define BITSTREAM_READER_LE
31 #include "avcodec.h"
32 #include "get_bits.h"
33 #include "dsputil.h"
34 #include "ivi_dsp.h"
35 #include "ivi_common.h"
36 #include "indeo4data.h"
37 
41 enum {
49 };
50 
51 #define IVI4_PIC_SIZE_ESC 7
52 
53 
54 static const struct {
58 } transforms[18] = {
60  { NULL, NULL, 0 }, /* inverse Haar 8x1 */
61  { NULL, NULL, 0 }, /* inverse Haar 1x8 */
66  { NULL, NULL, 0 }, /* inverse DCT 8x8 */
67  { NULL, NULL, 0 }, /* inverse DCT 8x1 */
68  { NULL, NULL, 0 }, /* inverse DCT 1x8 */
69  { NULL, NULL, 0 }, /* inverse Haar 4x4 */
71  { NULL, NULL, 0 }, /* no transform 4x4 */
72  { NULL, NULL, 0 }, /* inverse Haar 1x4 */
73  { NULL, NULL, 0 }, /* inverse Haar 4x1 */
74  { NULL, NULL, 0 }, /* inverse slant 1x4 */
75  { NULL, NULL, 0 }, /* inverse slant 4x1 */
76  { NULL, NULL, 0 }, /* inverse DCT 4x4 */
77 };
78 
90 {
91  int i;
92 
93  switch (get_bits(gb, 2)) {
94  case 3:
95  return 1;
96  case 2:
97  for (i = 0; i < 4; i++)
98  if (get_bits(gb, 2) != 3)
99  return 0;
100  return 4;
101  default:
102  return 0;
103  }
104 }
105 
106 static inline int scale_tile_size(int def_size, int size_factor)
107 {
108  return size_factor == 15 ? def_size : (size_factor + 1) << 5;
109 }
110 
119 {
120  int pic_size_indx, i, p;
121  IVIPicConfig pic_conf;
122 
123  if (get_bits(&ctx->gb, 18) != 0x3FFF8) {
124  av_log(avctx, AV_LOG_ERROR, "Invalid picture start code!\n");
125  return AVERROR_INVALIDDATA;
126  }
127 
128  ctx->prev_frame_type = ctx->frame_type;
129  ctx->frame_type = get_bits(&ctx->gb, 3);
130  if (ctx->frame_type == 7) {
131  av_log(avctx, AV_LOG_ERROR, "Invalid frame type: %d\n", ctx->frame_type);
132  return AVERROR_INVALIDDATA;
133  }
134 
135 #if IVI4_STREAM_ANALYSER
136  if (ctx->frame_type == FRAMETYPE_BIDIR)
137  ctx->has_b_frames = 1;
138 #endif
139 
140  ctx->transp_status = get_bits1(&ctx->gb);
141 #if IVI4_STREAM_ANALYSER
142  if (ctx->transp_status) {
143  ctx->has_transp = 1;
144  }
145 #endif
146 
147  /* unknown bit: Mac decoder ignores this bit, XANIM returns error */
148  if (get_bits1(&ctx->gb)) {
149  av_log(avctx, AV_LOG_ERROR, "Sync bit is set!\n");
150  return AVERROR_INVALIDDATA;
151  }
152 
153  ctx->data_size = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 24) : 0;
154 
155  /* null frames don't contain anything else so we just return */
156  if (ctx->frame_type >= FRAMETYPE_NULL_FIRST) {
157  av_dlog(avctx, "Null frame encountered!\n");
158  return 0;
159  }
160 
161  /* Check key lock status. If enabled - ignore lock word. */
162  /* Usually we have to prompt the user for the password, but */
163  /* we don't do that because Indeo 4 videos can be decoded anyway */
164  if (get_bits1(&ctx->gb)) {
165  skip_bits_long(&ctx->gb, 32);
166  av_dlog(avctx, "Password-protected clip!\n");
167  }
168 
169  pic_size_indx = get_bits(&ctx->gb, 3);
170  if (pic_size_indx == IVI4_PIC_SIZE_ESC) {
171  pic_conf.pic_height = get_bits(&ctx->gb, 16);
172  pic_conf.pic_width = get_bits(&ctx->gb, 16);
173  } else {
174  pic_conf.pic_height = ivi4_common_pic_sizes[pic_size_indx * 2 + 1];
175  pic_conf.pic_width = ivi4_common_pic_sizes[pic_size_indx * 2 ];
176  }
177 
178  /* Decode tile dimensions. */
179  if (get_bits1(&ctx->gb)) {
180  pic_conf.tile_height = scale_tile_size(pic_conf.pic_height, get_bits(&ctx->gb, 4));
181  pic_conf.tile_width = scale_tile_size(pic_conf.pic_width, get_bits(&ctx->gb, 4));
182 #if IVI4_STREAM_ANALYSER
183  ctx->uses_tiling = 1;
184 #endif
185  } else {
186  pic_conf.tile_height = pic_conf.pic_height;
187  pic_conf.tile_width = pic_conf.pic_width;
188  }
189 
190  /* Decode chroma subsampling. We support only 4:4 aka YVU9. */
191  if (get_bits(&ctx->gb, 2)) {
192  av_log(avctx, AV_LOG_ERROR, "Only YVU9 picture format is supported!\n");
193  return AVERROR_INVALIDDATA;
194  }
195  pic_conf.chroma_height = (pic_conf.pic_height + 3) >> 2;
196  pic_conf.chroma_width = (pic_conf.pic_width + 3) >> 2;
197 
198  /* decode subdivision of the planes */
199  pic_conf.luma_bands = decode_plane_subdivision(&ctx->gb);
200  if (pic_conf.luma_bands)
201  pic_conf.chroma_bands = decode_plane_subdivision(&ctx->gb);
202  ctx->is_scalable = pic_conf.luma_bands != 1 || pic_conf.chroma_bands != 1;
203  if (ctx->is_scalable && (pic_conf.luma_bands != 4 || pic_conf.chroma_bands != 1)) {
204  av_log(avctx, AV_LOG_ERROR, "Scalability: unsupported subdivision! Luma bands: %d, chroma bands: %d\n",
205  pic_conf.luma_bands, pic_conf.chroma_bands);
206  return AVERROR_INVALIDDATA;
207  }
208 
209  /* check if picture layout was changed and reallocate buffers */
210  if (ivi_pic_config_cmp(&pic_conf, &ctx->pic_conf)) {
211  if (ff_ivi_init_planes(ctx->planes, &pic_conf)) {
212  av_log(avctx, AV_LOG_ERROR, "Couldn't reallocate color planes!\n");
213  ctx->pic_conf.luma_bands = 0;
214  return AVERROR(ENOMEM);
215  }
216 
217  ctx->pic_conf = pic_conf;
218 
219  /* set default macroblock/block dimensions */
220  for (p = 0; p <= 2; p++) {
221  for (i = 0; i < (!p ? pic_conf.luma_bands : pic_conf.chroma_bands); i++) {
222  ctx->planes[p].bands[i].mb_size = !p ? (!ctx->is_scalable ? 16 : 8) : 4;
223  ctx->planes[p].bands[i].blk_size = !p ? 8 : 4;
224  }
225  }
226 
228  ctx->pic_conf.tile_height)) {
229  av_log(avctx, AV_LOG_ERROR,
230  "Couldn't reallocate internal structures!\n");
231  return AVERROR(ENOMEM);
232  }
233  }
234 
235  ctx->frame_num = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 20) : 0;
236 
237  /* skip decTimeEst field if present */
238  if (get_bits1(&ctx->gb))
239  skip_bits(&ctx->gb, 8);
240 
241  /* decode macroblock and block huffman codebooks */
242  if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_MB_HUFF, &ctx->mb_vlc, avctx) ||
243  ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF, &ctx->blk_vlc, avctx))
244  return AVERROR_INVALIDDATA;
245 
246  ctx->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
247 
248  ctx->in_imf = get_bits1(&ctx->gb);
249  ctx->in_q = get_bits1(&ctx->gb);
250 
251  ctx->pic_glob_quant = get_bits(&ctx->gb, 5);
252 
253  /* TODO: ignore this parameter if unused */
254  ctx->unknown1 = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 0;
255 
256  ctx->checksum = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 16) : 0;
257 
258  /* skip picture header extension if any */
259  while (get_bits1(&ctx->gb)) {
260  av_dlog(avctx, "Pic hdr extension encountered!\n");
261  skip_bits(&ctx->gb, 8);
262  }
263 
264  if (get_bits1(&ctx->gb)) {
265  av_log(avctx, AV_LOG_ERROR, "Bad blocks bits encountered!\n");
266  }
267 
268  align_get_bits(&ctx->gb);
269 
270  return 0;
271 }
272 
273 
283  AVCodecContext *avctx)
284 {
285  int plane, band_num, indx, transform_id, scan_indx;
286  int i;
287 
288  plane = get_bits(&ctx->gb, 2);
289  band_num = get_bits(&ctx->gb, 4);
290  if (band->plane != plane || band->band_num != band_num) {
291  av_log(avctx, AV_LOG_ERROR, "Invalid band header sequence!\n");
292  return AVERROR_INVALIDDATA;
293  }
294 
295  band->is_empty = get_bits1(&ctx->gb);
296  if (!band->is_empty) {
297  /* skip header size
298  * If header size is not given, header size is 4 bytes. */
299  if (get_bits1(&ctx->gb))
300  skip_bits(&ctx->gb, 16);
301 
302  band->is_halfpel = get_bits(&ctx->gb, 2);
303  if (band->is_halfpel >= 2) {
304  av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported mv resolution: %d!\n",
305  band->is_halfpel);
306  return AVERROR_INVALIDDATA;
307  }
308 #if IVI4_STREAM_ANALYSER
309  if (!band->is_halfpel)
310  ctx->uses_fullpel = 1;
311 #endif
312 
313  band->checksum_present = get_bits1(&ctx->gb);
314  if (band->checksum_present)
315  band->checksum = get_bits(&ctx->gb, 16);
316 
317  indx = get_bits(&ctx->gb, 2);
318  if (indx == 3) {
319  av_log(avctx, AV_LOG_ERROR, "Invalid block size!\n");
320  return AVERROR_INVALIDDATA;
321  }
322  band->mb_size = 16 >> indx;
323  band->blk_size = 8 >> (indx >> 1);
324 
325  band->inherit_mv = get_bits1(&ctx->gb);
326  band->inherit_qdelta = get_bits1(&ctx->gb);
327 
328  band->glob_quant = get_bits(&ctx->gb, 5);
329 
330  if (!get_bits1(&ctx->gb) || ctx->frame_type == FRAMETYPE_INTRA) {
331  transform_id = get_bits(&ctx->gb, 5);
332  if (transform_id >= FF_ARRAY_ELEMS(transforms) ||
333  !transforms[transform_id].inv_trans) {
334  av_log_ask_for_sample(avctx, "Unimplemented transform: %d!\n", transform_id);
335  return AVERROR_PATCHWELCOME;
336  }
337  if ((transform_id >= 7 && transform_id <= 9) ||
338  transform_id == 17) {
339  av_log_ask_for_sample(avctx, "DCT transform not supported yet!\n");
340  return AVERROR_PATCHWELCOME;
341  }
342 
343 #if IVI4_STREAM_ANALYSER
344  if ((transform_id >= 0 && transform_id <= 2) || transform_id == 10)
345  ctx->uses_haar = 1;
346 #endif
347 
348  band->inv_transform = transforms[transform_id].inv_trans;
349  band->dc_transform = transforms[transform_id].dc_trans;
350  band->is_2d_trans = transforms[transform_id].is_2d_trans;
351  if (transform_id < 10)
352  band->transform_size = 8;
353  else
354  band->transform_size = 4;
355 
356  if (band->blk_size != band->transform_size)
357  return AVERROR_INVALIDDATA;
358 
359  scan_indx = get_bits(&ctx->gb, 4);
360  if (scan_indx == 15) {
361  av_log(avctx, AV_LOG_ERROR, "Custom scan pattern encountered!\n");
362  return AVERROR_INVALIDDATA;
363  }
364  if (scan_indx > 4 && scan_indx < 10) {
365  if (band->blk_size != 4)
366  return AVERROR_INVALIDDATA;
367  } else if (band->blk_size != 8)
368  return AVERROR_INVALIDDATA;
369 
370  band->scan = scan_index_to_tab[scan_indx];
371 
372  band->quant_mat = get_bits(&ctx->gb, 5);
373  if (band->quant_mat == 31) {
374  av_log(avctx, AV_LOG_ERROR, "Custom quant matrix encountered!\n");
375  return AVERROR_INVALIDDATA;
376  }
378  av_log_ask_for_sample(avctx, "Quantization matrix %d",
379  band->quant_mat);
380  return AVERROR_INVALIDDATA;
381  }
382  }
383 
384  /* decode block huffman codebook */
385  if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF,
386  &band->blk_vlc, avctx))
387  return AVERROR_INVALIDDATA;
388 
389  /* select appropriate rvmap table for this band */
390  band->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
391 
392  /* decode rvmap probability corrections if any */
393  band->num_corr = 0; /* there is no corrections */
394  if (get_bits1(&ctx->gb)) {
395  band->num_corr = get_bits(&ctx->gb, 8); /* get number of correction pairs */
396  if (band->num_corr > 61) {
397  av_log(avctx, AV_LOG_ERROR, "Too many corrections: %d\n",
398  band->num_corr);
399  return AVERROR_INVALIDDATA;
400  }
401 
402  /* read correction pairs */
403  for (i = 0; i < band->num_corr * 2; i++)
404  band->corr[i] = get_bits(&ctx->gb, 8);
405  }
406  }
407 
408  if (band->blk_size == 8) {
410  band->inter_base = &ivi4_quant_8x8_inter[quant_index_to_tab[band->quant_mat]][0];
411  } else {
413  band->inter_base = &ivi4_quant_4x4_inter[quant_index_to_tab[band->quant_mat]][0];
414  }
415 
416  /* Indeo 4 doesn't use scale tables */
417  band->intra_scale = NULL;
418  band->inter_scale = NULL;
419 
420  align_get_bits(&ctx->gb);
421 
422  return 0;
423 }
424 
425 
437  IVITile *tile, AVCodecContext *avctx)
438 {
439  int x, y, mv_x, mv_y, mv_delta, offs, mb_offset, blks_per_mb,
440  mv_scale, mb_type_bits;
441  IVIMbInfo *mb, *ref_mb;
442  int row_offset = band->mb_size * band->pitch;
443 
444  mb = tile->mbs;
445  ref_mb = tile->ref_mbs;
446  offs = tile->ypos * band->pitch + tile->xpos;
447 
448  blks_per_mb = band->mb_size != band->blk_size ? 4 : 1;
449  mb_type_bits = ctx->frame_type == FRAMETYPE_BIDIR ? 2 : 1;
450 
451  /* scale factor for motion vectors */
452  mv_scale = (ctx->planes[0].bands[0].mb_size >> 3) - (band->mb_size >> 3);
453  mv_x = mv_y = 0;
454 
455  for (y = tile->ypos; y < tile->ypos + tile->height; y += band->mb_size) {
456  mb_offset = offs;
457 
458  for (x = tile->xpos; x < tile->xpos + tile->width; x += band->mb_size) {
459  mb->xpos = x;
460  mb->ypos = y;
461  mb->buf_offs = mb_offset;
462 
463  if (get_bits1(&ctx->gb)) {
464  if (ctx->frame_type == FRAMETYPE_INTRA) {
465  av_log(avctx, AV_LOG_ERROR, "Empty macroblock in an INTRA picture!\n");
466  return AVERROR_INVALIDDATA;
467  }
468  mb->type = 1; /* empty macroblocks are always INTER */
469  mb->cbp = 0; /* all blocks are empty */
470 
471  mb->q_delta = 0;
472  if (!band->plane && !band->band_num && ctx->in_q) {
473  mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
474  IVI_VLC_BITS, 1);
475  mb->q_delta = IVI_TOSIGNED(mb->q_delta);
476  }
477 
478  mb->mv_x = mb->mv_y = 0; /* no motion vector coded */
479  if (band->inherit_mv && ref_mb) {
480  /* motion vector inheritance */
481  if (mv_scale) {
482  mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
483  mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
484  } else {
485  mb->mv_x = ref_mb->mv_x;
486  mb->mv_y = ref_mb->mv_y;
487  }
488  }
489  } else {
490  if (band->inherit_mv) {
491  /* copy mb_type from corresponding reference mb */
492  if (!ref_mb)
493  return AVERROR_INVALIDDATA;
494  mb->type = ref_mb->type;
495  } else if (ctx->frame_type == FRAMETYPE_INTRA ||
496  ctx->frame_type == FRAMETYPE_INTRA1) {
497  mb->type = 0; /* mb_type is always INTRA for intra-frames */
498  } else {
499  mb->type = get_bits(&ctx->gb, mb_type_bits);
500  }
501 
502  mb->cbp = get_bits(&ctx->gb, blks_per_mb);
503 
504  mb->q_delta = 0;
505  if (band->inherit_qdelta) {
506  if (ref_mb) mb->q_delta = ref_mb->q_delta;
507  } else if (mb->cbp || (!band->plane && !band->band_num &&
508  ctx->in_q)) {
509  mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
510  IVI_VLC_BITS, 1);
511  mb->q_delta = IVI_TOSIGNED(mb->q_delta);
512  }
513 
514  if (!mb->type) {
515  mb->mv_x = mb->mv_y = 0; /* there is no motion vector in intra-macroblocks */
516  } else {
517  if (band->inherit_mv) {
518  if (ref_mb)
519  /* motion vector inheritance */
520  if (mv_scale) {
521  mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
522  mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
523  } else {
524  mb->mv_x = ref_mb->mv_x;
525  mb->mv_y = ref_mb->mv_y;
526  }
527  } else {
528  /* decode motion vector deltas */
529  mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
530  IVI_VLC_BITS, 1);
531  mv_y += IVI_TOSIGNED(mv_delta);
532  mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
533  IVI_VLC_BITS, 1);
534  mv_x += IVI_TOSIGNED(mv_delta);
535  mb->mv_x = mv_x;
536  mb->mv_y = mv_y;
537  }
538  }
539  }
540 
541  mb++;
542  if (ref_mb)
543  ref_mb++;
544  mb_offset += band->mb_size;
545  }
546 
547  offs += row_offset;
548  }
549 
550  align_get_bits(&ctx->gb);
551 
552  return 0;
553 }
554 
555 
562 {
563  switch (ctx->prev_frame_type) {
564  case FRAMETYPE_INTRA:
565  case FRAMETYPE_INTRA1:
566  case FRAMETYPE_INTER:
567  ctx->buf_switch ^= 1;
568  ctx->dst_buf = ctx->buf_switch;
569  ctx->ref_buf = ctx->buf_switch ^ 1;
570  break;
572  break;
573  }
574 
575  switch (ctx->frame_type) {
576  case FRAMETYPE_INTRA:
577  case FRAMETYPE_INTRA1:
578  ctx->buf_switch = 0;
579  /* FALLTHROUGH */
580  case FRAMETYPE_INTER:
581  ctx->dst_buf = ctx->buf_switch;
582  ctx->ref_buf = ctx->buf_switch ^ 1;
583  break;
586  case FRAMETYPE_NULL_LAST:
587  break;
588  }
589 }
590 
591 
593 {
594  return ctx->frame_type < FRAMETYPE_NULL_FIRST;
595 }
596 
597 
599 {
600  IVI45DecContext *ctx = avctx->priv_data;
601 
603 
604  /* copy rvmap tables in our context so we can apply changes to them */
605  memcpy(ctx->rvmap_tabs, ff_ivi_rvmap_tabs, sizeof(ff_ivi_rvmap_tabs));
606 
607  /* Force allocation of the internal buffers */
608  /* during picture header decoding. */
609  ctx->pic_conf.pic_width = 0;
610  ctx->pic_conf.pic_height = 0;
611 
612  avctx->pix_fmt = AV_PIX_FMT_YUV410P;
613 
619 
620  return 0;
621 }
622 
623 
625  .name = "indeo4",
626  .type = AVMEDIA_TYPE_VIDEO,
627  .id = AV_CODEC_ID_INDEO4,
628  .priv_data_size = sizeof(IVI45DecContext),
629  .init = decode_init,
632  .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 4"),
633  .capabilities = CODEC_CAP_DR1,
634 };