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  int old_blk_size = band->blk_size;
298  /* skip header size
299  * If header size is not given, header size is 4 bytes. */
300  if (get_bits1(&ctx->gb))
301  skip_bits(&ctx->gb, 16);
302 
303  band->is_halfpel = get_bits(&ctx->gb, 2);
304  if (band->is_halfpel >= 2) {
305  av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported mv resolution: %d!\n",
306  band->is_halfpel);
307  return AVERROR_INVALIDDATA;
308  }
309 #if IVI4_STREAM_ANALYSER
310  if (!band->is_halfpel)
311  ctx->uses_fullpel = 1;
312 #endif
313 
314  band->checksum_present = get_bits1(&ctx->gb);
315  if (band->checksum_present)
316  band->checksum = get_bits(&ctx->gb, 16);
317 
318  indx = get_bits(&ctx->gb, 2);
319  if (indx == 3) {
320  av_log(avctx, AV_LOG_ERROR, "Invalid block size!\n");
321  return AVERROR_INVALIDDATA;
322  }
323  band->mb_size = 16 >> indx;
324  band->blk_size = 8 >> (indx >> 1);
325 
326  band->inherit_mv = get_bits1(&ctx->gb);
327  band->inherit_qdelta = get_bits1(&ctx->gb);
328 
329  band->glob_quant = get_bits(&ctx->gb, 5);
330 
331  if (!get_bits1(&ctx->gb) || ctx->frame_type == FRAMETYPE_INTRA) {
332  transform_id = get_bits(&ctx->gb, 5);
333  if (transform_id >= FF_ARRAY_ELEMS(transforms) ||
334  !transforms[transform_id].inv_trans) {
335  av_log_ask_for_sample(avctx, "Unimplemented transform: %d!\n", transform_id);
336  return AVERROR_PATCHWELCOME;
337  }
338  if ((transform_id >= 7 && transform_id <= 9) ||
339  transform_id == 17) {
340  av_log_ask_for_sample(avctx, "DCT transform not supported yet!\n");
341  return AVERROR_PATCHWELCOME;
342  }
343 
344 #if IVI4_STREAM_ANALYSER
345  if ((transform_id >= 0 && transform_id <= 2) || transform_id == 10)
346  ctx->uses_haar = 1;
347 #endif
348 
349  band->inv_transform = transforms[transform_id].inv_trans;
350  band->dc_transform = transforms[transform_id].dc_trans;
351  band->is_2d_trans = transforms[transform_id].is_2d_trans;
352  if (transform_id < 10)
353  band->transform_size = 8;
354  else
355  band->transform_size = 4;
356 
357  if (band->blk_size != band->transform_size)
358  return AVERROR_INVALIDDATA;
359 
360  scan_indx = get_bits(&ctx->gb, 4);
361  if (scan_indx == 15) {
362  av_log(avctx, AV_LOG_ERROR, "Custom scan pattern encountered!\n");
363  return AVERROR_INVALIDDATA;
364  }
365  if (scan_indx > 4 && scan_indx < 10) {
366  if (band->blk_size != 4)
367  return AVERROR_INVALIDDATA;
368  } else if (band->blk_size != 8)
369  return AVERROR_INVALIDDATA;
370 
371  band->scan = scan_index_to_tab[scan_indx];
372 
373  band->quant_mat = get_bits(&ctx->gb, 5);
375  av_log_ask_for_sample(avctx, "Quantization matrix %d",
376  band->quant_mat);
377 
378  if (band->quant_mat == 31)
379  av_log(avctx, AV_LOG_ERROR,
380  "Custom quant matrix encountered!\n");
381  else
382  av_log_ask_for_sample(avctx, "Quantization matrix %d",
383  band->quant_mat);
384  band->quant_mat = -1;
385  return AVERROR_INVALIDDATA;
386  }
387  } else {
388  if (old_blk_size != band->blk_size) {
389  av_log(avctx, AV_LOG_ERROR,
390  "The band block size does not match the configuration "
391  "inherited\n");
392  return AVERROR_INVALIDDATA;
393  }
394  if (band->quant_mat < 0) {
395  av_log(avctx, AV_LOG_ERROR, "Invalid quant_mat inherited\n");
396  return AVERROR_INVALIDDATA;
397  }
398  }
399 
400  /* decode block huffman codebook */
401  if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF,
402  &band->blk_vlc, avctx))
403  return AVERROR_INVALIDDATA;
404 
405  /* select appropriate rvmap table for this band */
406  band->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
407 
408  /* decode rvmap probability corrections if any */
409  band->num_corr = 0; /* there is no corrections */
410  if (get_bits1(&ctx->gb)) {
411  band->num_corr = get_bits(&ctx->gb, 8); /* get number of correction pairs */
412  if (band->num_corr > 61) {
413  av_log(avctx, AV_LOG_ERROR, "Too many corrections: %d\n",
414  band->num_corr);
415  return AVERROR_INVALIDDATA;
416  }
417 
418  /* read correction pairs */
419  for (i = 0; i < band->num_corr * 2; i++)
420  band->corr[i] = get_bits(&ctx->gb, 8);
421  }
422  }
423 
424  if (band->blk_size == 8) {
426  band->inter_base = &ivi4_quant_8x8_inter[quant_index_to_tab[band->quant_mat]][0];
427  } else {
429  band->inter_base = &ivi4_quant_4x4_inter[quant_index_to_tab[band->quant_mat]][0];
430  }
431 
432  /* Indeo 4 doesn't use scale tables */
433  band->intra_scale = NULL;
434  band->inter_scale = NULL;
435 
436  align_get_bits(&ctx->gb);
437 
438  return 0;
439 }
440 
441 
453  IVITile *tile, AVCodecContext *avctx)
454 {
455  int x, y, mv_x, mv_y, mv_delta, offs, mb_offset, blks_per_mb,
456  mv_scale, mb_type_bits;
457  IVIMbInfo *mb, *ref_mb;
458  int row_offset = band->mb_size * band->pitch;
459 
460  mb = tile->mbs;
461  ref_mb = tile->ref_mbs;
462  offs = tile->ypos * band->pitch + tile->xpos;
463 
464  blks_per_mb = band->mb_size != band->blk_size ? 4 : 1;
465  mb_type_bits = ctx->frame_type == FRAMETYPE_BIDIR ? 2 : 1;
466 
467  /* scale factor for motion vectors */
468  mv_scale = (ctx->planes[0].bands[0].mb_size >> 3) - (band->mb_size >> 3);
469  mv_x = mv_y = 0;
470 
471  for (y = tile->ypos; y < tile->ypos + tile->height; y += band->mb_size) {
472  mb_offset = offs;
473 
474  for (x = tile->xpos; x < tile->xpos + tile->width; x += band->mb_size) {
475  mb->xpos = x;
476  mb->ypos = y;
477  mb->buf_offs = mb_offset;
478 
479  if (get_bits1(&ctx->gb)) {
480  if (ctx->frame_type == FRAMETYPE_INTRA) {
481  av_log(avctx, AV_LOG_ERROR, "Empty macroblock in an INTRA picture!\n");
482  return AVERROR_INVALIDDATA;
483  }
484  mb->type = 1; /* empty macroblocks are always INTER */
485  mb->cbp = 0; /* all blocks are empty */
486 
487  mb->q_delta = 0;
488  if (!band->plane && !band->band_num && ctx->in_q) {
489  mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
490  IVI_VLC_BITS, 1);
491  mb->q_delta = IVI_TOSIGNED(mb->q_delta);
492  }
493 
494  mb->mv_x = mb->mv_y = 0; /* no motion vector coded */
495  if (band->inherit_mv && ref_mb) {
496  /* motion vector inheritance */
497  if (mv_scale) {
498  mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
499  mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
500  } else {
501  mb->mv_x = ref_mb->mv_x;
502  mb->mv_y = ref_mb->mv_y;
503  }
504  }
505  } else {
506  if (band->inherit_mv) {
507  /* copy mb_type from corresponding reference mb */
508  if (!ref_mb)
509  return AVERROR_INVALIDDATA;
510  mb->type = ref_mb->type;
511  } else if (ctx->frame_type == FRAMETYPE_INTRA ||
512  ctx->frame_type == FRAMETYPE_INTRA1) {
513  mb->type = 0; /* mb_type is always INTRA for intra-frames */
514  } else {
515  mb->type = get_bits(&ctx->gb, mb_type_bits);
516  }
517 
518  mb->cbp = get_bits(&ctx->gb, blks_per_mb);
519 
520  mb->q_delta = 0;
521  if (band->inherit_qdelta) {
522  if (ref_mb) mb->q_delta = ref_mb->q_delta;
523  } else if (mb->cbp || (!band->plane && !band->band_num &&
524  ctx->in_q)) {
525  mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
526  IVI_VLC_BITS, 1);
527  mb->q_delta = IVI_TOSIGNED(mb->q_delta);
528  }
529 
530  if (!mb->type) {
531  mb->mv_x = mb->mv_y = 0; /* there is no motion vector in intra-macroblocks */
532  } else {
533  if (band->inherit_mv) {
534  if (ref_mb)
535  /* motion vector inheritance */
536  if (mv_scale) {
537  mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
538  mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
539  } else {
540  mb->mv_x = ref_mb->mv_x;
541  mb->mv_y = ref_mb->mv_y;
542  }
543  } else {
544  /* decode motion vector deltas */
545  mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
546  IVI_VLC_BITS, 1);
547  mv_y += IVI_TOSIGNED(mv_delta);
548  mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
549  IVI_VLC_BITS, 1);
550  mv_x += IVI_TOSIGNED(mv_delta);
551  mb->mv_x = mv_x;
552  mb->mv_y = mv_y;
553  }
554  }
555  }
556 
557  mb++;
558  if (ref_mb)
559  ref_mb++;
560  mb_offset += band->mb_size;
561  }
562 
563  offs += row_offset;
564  }
565 
566  align_get_bits(&ctx->gb);
567 
568  return 0;
569 }
570 
571 
578 {
579  switch (ctx->prev_frame_type) {
580  case FRAMETYPE_INTRA:
581  case FRAMETYPE_INTRA1:
582  case FRAMETYPE_INTER:
583  ctx->buf_switch ^= 1;
584  ctx->dst_buf = ctx->buf_switch;
585  ctx->ref_buf = ctx->buf_switch ^ 1;
586  break;
588  break;
589  }
590 
591  switch (ctx->frame_type) {
592  case FRAMETYPE_INTRA:
593  case FRAMETYPE_INTRA1:
594  ctx->buf_switch = 0;
595  /* FALLTHROUGH */
596  case FRAMETYPE_INTER:
597  ctx->dst_buf = ctx->buf_switch;
598  ctx->ref_buf = ctx->buf_switch ^ 1;
599  break;
602  case FRAMETYPE_NULL_LAST:
603  break;
604  }
605 }
606 
607 
609 {
610  return ctx->frame_type < FRAMETYPE_NULL_FIRST;
611 }
612 
613 
615 {
616  IVI45DecContext *ctx = avctx->priv_data;
617 
619 
620  /* copy rvmap tables in our context so we can apply changes to them */
621  memcpy(ctx->rvmap_tabs, ff_ivi_rvmap_tabs, sizeof(ff_ivi_rvmap_tabs));
622 
623  /* Force allocation of the internal buffers */
624  /* during picture header decoding. */
625  ctx->pic_conf.pic_width = 0;
626  ctx->pic_conf.pic_height = 0;
627 
628  avctx->pix_fmt = AV_PIX_FMT_YUV410P;
629 
635 
636  return 0;
637 }
638 
639 
641  .name = "indeo4",
642  .type = AVMEDIA_TYPE_VIDEO,
643  .id = AV_CODEC_ID_INDEO4,
644  .priv_data_size = sizeof(IVI45DecContext),
645  .init = decode_init,
648  .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 4"),
649  .capabilities = CODEC_CAP_DR1,
650 };