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_BIDIR1
137  || ctx->frame_type == FRAMETYPE_BIDIR)
138  ctx->has_b_frames = 1;
139 #endif
140 
141  ctx->transp_status = get_bits1(&ctx->gb);
142 #if IVI4_STREAM_ANALYSER
143  if (ctx->transp_status) {
144  ctx->has_transp = 1;
145  }
146 #endif
147 
148  /* unknown bit: Mac decoder ignores this bit, XANIM returns error */
149  if (get_bits1(&ctx->gb)) {
150  av_log(avctx, AV_LOG_ERROR, "Sync bit is set!\n");
151  return AVERROR_INVALIDDATA;
152  }
153 
154  ctx->data_size = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 24) : 0;
155 
156  /* null frames don't contain anything else so we just return */
157  if (ctx->frame_type >= FRAMETYPE_NULL_FIRST) {
158  av_dlog(avctx, "Null frame encountered!\n");
159  return 0;
160  }
161 
162  /* Check key lock status. If enabled - ignore lock word. */
163  /* Usually we have to prompt the user for the password, but */
164  /* we don't do that because Indeo 4 videos can be decoded anyway */
165  if (get_bits1(&ctx->gb)) {
166  skip_bits_long(&ctx->gb, 32);
167  av_dlog(avctx, "Password-protected clip!\n");
168  }
169 
170  pic_size_indx = get_bits(&ctx->gb, 3);
171  if (pic_size_indx == IVI4_PIC_SIZE_ESC) {
172  pic_conf.pic_height = get_bits(&ctx->gb, 16);
173  pic_conf.pic_width = get_bits(&ctx->gb, 16);
174  } else {
175  pic_conf.pic_height = ivi4_common_pic_sizes[pic_size_indx * 2 + 1];
176  pic_conf.pic_width = ivi4_common_pic_sizes[pic_size_indx * 2 ];
177  }
178 
179  /* Decode tile dimensions. */
180  if (get_bits1(&ctx->gb)) {
181  pic_conf.tile_height = scale_tile_size(pic_conf.pic_height, get_bits(&ctx->gb, 4));
182  pic_conf.tile_width = scale_tile_size(pic_conf.pic_width, get_bits(&ctx->gb, 4));
183 #if IVI4_STREAM_ANALYSER
184  ctx->uses_tiling = 1;
185 #endif
186  } else {
187  pic_conf.tile_height = pic_conf.pic_height;
188  pic_conf.tile_width = pic_conf.pic_width;
189  }
190 
191  /* Decode chroma subsampling. We support only 4:4 aka YVU9. */
192  if (get_bits(&ctx->gb, 2)) {
193  av_log(avctx, AV_LOG_ERROR, "Only YVU9 picture format is supported!\n");
194  return AVERROR_INVALIDDATA;
195  }
196  pic_conf.chroma_height = (pic_conf.pic_height + 3) >> 2;
197  pic_conf.chroma_width = (pic_conf.pic_width + 3) >> 2;
198 
199  /* decode subdivision of the planes */
200  pic_conf.luma_bands = decode_plane_subdivision(&ctx->gb);
201  if (pic_conf.luma_bands)
202  pic_conf.chroma_bands = decode_plane_subdivision(&ctx->gb);
203  ctx->is_scalable = pic_conf.luma_bands != 1 || pic_conf.chroma_bands != 1;
204  if (ctx->is_scalable && (pic_conf.luma_bands != 4 || pic_conf.chroma_bands != 1)) {
205  av_log(avctx, AV_LOG_ERROR, "Scalability: unsupported subdivision! Luma bands: %d, chroma bands: %d\n",
206  pic_conf.luma_bands, pic_conf.chroma_bands);
207  return AVERROR_INVALIDDATA;
208  }
209 
210  /* check if picture layout was changed and reallocate buffers */
211  if (ivi_pic_config_cmp(&pic_conf, &ctx->pic_conf)) {
212  if (ff_ivi_init_planes(ctx->planes, &pic_conf)) {
213  av_log(avctx, AV_LOG_ERROR, "Couldn't reallocate color planes!\n");
214  ctx->pic_conf.luma_bands = 0;
215  return AVERROR(ENOMEM);
216  }
217 
218  ctx->pic_conf = pic_conf;
219 
220  /* set default macroblock/block dimensions */
221  for (p = 0; p <= 2; p++) {
222  for (i = 0; i < (!p ? pic_conf.luma_bands : pic_conf.chroma_bands); i++) {
223  ctx->planes[p].bands[i].mb_size = !p ? (!ctx->is_scalable ? 16 : 8) : 4;
224  ctx->planes[p].bands[i].blk_size = !p ? 8 : 4;
225  }
226  }
227 
229  ctx->pic_conf.tile_height)) {
230  av_log(avctx, AV_LOG_ERROR,
231  "Couldn't reallocate internal structures!\n");
232  return AVERROR(ENOMEM);
233  }
234  }
235 
236  ctx->frame_num = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 20) : 0;
237 
238  /* skip decTimeEst field if present */
239  if (get_bits1(&ctx->gb))
240  skip_bits(&ctx->gb, 8);
241 
242  /* decode macroblock and block huffman codebooks */
243  if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_MB_HUFF, &ctx->mb_vlc, avctx) ||
244  ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF, &ctx->blk_vlc, avctx))
245  return AVERROR_INVALIDDATA;
246 
247  ctx->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
248 
249  ctx->in_imf = get_bits1(&ctx->gb);
250  ctx->in_q = get_bits1(&ctx->gb);
251 
252  ctx->pic_glob_quant = get_bits(&ctx->gb, 5);
253 
254  /* TODO: ignore this parameter if unused */
255  ctx->unknown1 = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 0;
256 
257  ctx->checksum = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 16) : 0;
258 
259  /* skip picture header extension if any */
260  while (get_bits1(&ctx->gb)) {
261  av_dlog(avctx, "Pic hdr extension encountered!\n");
262  skip_bits(&ctx->gb, 8);
263  }
264 
265  if (get_bits1(&ctx->gb)) {
266  av_log(avctx, AV_LOG_ERROR, "Bad blocks bits encountered!\n");
267  }
268 
269  align_get_bits(&ctx->gb);
270 
271  return 0;
272 }
273 
274 
284  AVCodecContext *avctx)
285 {
286  int plane, band_num, indx, transform_id, scan_indx;
287  int i;
288 
289  plane = get_bits(&ctx->gb, 2);
290  band_num = get_bits(&ctx->gb, 4);
291  if (band->plane != plane || band->band_num != band_num) {
292  av_log(avctx, AV_LOG_ERROR, "Invalid band header sequence!\n");
293  return AVERROR_INVALIDDATA;
294  }
295 
296  band->is_empty = get_bits1(&ctx->gb);
297  if (!band->is_empty) {
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);
374  if (band->quant_mat == 31) {
375  av_log(avctx, AV_LOG_ERROR, "Custom quant matrix encountered!\n");
376  return AVERROR_INVALIDDATA;
377  }
379  av_log_ask_for_sample(avctx, "Quantization matrix %d",
380  band->quant_mat);
381  return AVERROR_INVALIDDATA;
382  }
383  }
384 
385  /* decode block huffman codebook */
386  if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF,
387  &band->blk_vlc, avctx))
388  return AVERROR_INVALIDDATA;
389 
390  /* select appropriate rvmap table for this band */
391  band->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
392 
393  /* decode rvmap probability corrections if any */
394  band->num_corr = 0; /* there is no corrections */
395  if (get_bits1(&ctx->gb)) {
396  band->num_corr = get_bits(&ctx->gb, 8); /* get number of correction pairs */
397  if (band->num_corr > 61) {
398  av_log(avctx, AV_LOG_ERROR, "Too many corrections: %d\n",
399  band->num_corr);
400  return AVERROR_INVALIDDATA;
401  }
402 
403  /* read correction pairs */
404  for (i = 0; i < band->num_corr * 2; i++)
405  band->corr[i] = get_bits(&ctx->gb, 8);
406  }
407  }
408 
409  if (band->blk_size == 8) {
411  band->inter_base = &ivi4_quant_8x8_inter[quant_index_to_tab[band->quant_mat]][0];
412  } else {
414  band->inter_base = &ivi4_quant_4x4_inter[quant_index_to_tab[band->quant_mat]][0];
415  }
416 
417  /* Indeo 4 doesn't use scale tables */
418  band->intra_scale = NULL;
419  band->inter_scale = NULL;
420 
421  align_get_bits(&ctx->gb);
422 
423  return 0;
424 }
425 
426 
438  IVITile *tile, AVCodecContext *avctx)
439 {
440  int x, y, mv_x, mv_y, mv_delta, offs, mb_offset, blks_per_mb,
441  mv_scale, mb_type_bits;
442  IVIMbInfo *mb, *ref_mb;
443  int row_offset = band->mb_size * band->pitch;
444 
445  mb = tile->mbs;
446  ref_mb = tile->ref_mbs;
447  offs = tile->ypos * band->pitch + tile->xpos;
448 
449  blks_per_mb = band->mb_size != band->blk_size ? 4 : 1;
450  mb_type_bits = ctx->frame_type == FRAMETYPE_BIDIR ? 2 : 1;
451 
452  /* scale factor for motion vectors */
453  mv_scale = (ctx->planes[0].bands[0].mb_size >> 3) - (band->mb_size >> 3);
454  mv_x = mv_y = 0;
455 
456  for (y = tile->ypos; y < tile->ypos + tile->height; y += band->mb_size) {
457  mb_offset = offs;
458 
459  for (x = tile->xpos; x < tile->xpos + tile->width; x += band->mb_size) {
460  mb->xpos = x;
461  mb->ypos = y;
462  mb->buf_offs = mb_offset;
463 
464  if (get_bits1(&ctx->gb)) {
465  if (ctx->frame_type == FRAMETYPE_INTRA) {
466  av_log(avctx, AV_LOG_ERROR, "Empty macroblock in an INTRA picture!\n");
467  return AVERROR_INVALIDDATA;
468  }
469  mb->type = 1; /* empty macroblocks are always INTER */
470  mb->cbp = 0; /* all blocks are empty */
471 
472  mb->q_delta = 0;
473  if (!band->plane && !band->band_num && ctx->in_q) {
474  mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
475  IVI_VLC_BITS, 1);
476  mb->q_delta = IVI_TOSIGNED(mb->q_delta);
477  }
478 
479  mb->mv_x = mb->mv_y = 0; /* no motion vector coded */
480  if (band->inherit_mv && ref_mb) {
481  /* motion vector inheritance */
482  if (mv_scale) {
483  mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
484  mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
485  } else {
486  mb->mv_x = ref_mb->mv_x;
487  mb->mv_y = ref_mb->mv_y;
488  }
489  }
490  } else {
491  if (band->inherit_mv) {
492  /* copy mb_type from corresponding reference mb */
493  if (!ref_mb)
494  return AVERROR_INVALIDDATA;
495  mb->type = ref_mb->type;
496  } else if (ctx->frame_type == FRAMETYPE_INTRA) {
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_INTER:
566  ctx->buf_switch ^= 1;
567  ctx->dst_buf = ctx->buf_switch;
568  ctx->ref_buf = ctx->buf_switch ^ 1;
569  break;
571  break;
572  }
573 
574  switch (ctx->frame_type) {
575  case FRAMETYPE_INTRA:
576  ctx->buf_switch = 0;
577  /* FALLTHROUGH */
578  case FRAMETYPE_INTER:
579  ctx->dst_buf = ctx->buf_switch;
580  ctx->ref_buf = ctx->buf_switch ^ 1;
581  break;
584  case FRAMETYPE_NULL_LAST:
585  break;
586  }
587 }
588 
589 
591 {
592  return ctx->frame_type < FRAMETYPE_NULL_FIRST;
593 }
594 
595 
597 {
598  IVI45DecContext *ctx = avctx->priv_data;
599 
601 
602  /* copy rvmap tables in our context so we can apply changes to them */
603  memcpy(ctx->rvmap_tabs, ff_ivi_rvmap_tabs, sizeof(ff_ivi_rvmap_tabs));
604 
605  /* Force allocation of the internal buffers */
606  /* during picture header decoding. */
607  ctx->pic_conf.pic_width = 0;
608  ctx->pic_conf.pic_height = 0;
609 
610  avctx->pix_fmt = PIX_FMT_YUV410P;
611 
617 
618  return 0;
619 }
620 
621 
623  .name = "indeo4",
624  .type = AVMEDIA_TYPE_VIDEO,
625  .id = CODEC_ID_INDEO4,
626  .priv_data_size = sizeof(IVI45DecContext),
627  .init = decode_init,
630  .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 4"),
631 };