Libav
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 "ivi_dsp.h"
34 #include "ivi_common.h"
35 #include "indeo4data.h"
36 
40 enum {
48 };
49 
50 #define IVI4_PIC_SIZE_ESC 7
51 
52 
53 static const struct {
57 } transforms[18] = {
65  { NULL, NULL, 0 }, /* inverse DCT 8x8 */
66  { NULL, NULL, 0 }, /* inverse DCT 8x1 */
67  { NULL, NULL, 0 }, /* inverse DCT 1x8 */
70  { NULL, NULL, 0 }, /* no transform 4x4 */
75  { NULL, NULL, 0 }, /* inverse DCT 4x4 */
76 };
77 
89 {
90  int i;
91 
92  switch (get_bits(gb, 2)) {
93  case 3:
94  return 1;
95  case 2:
96  for (i = 0; i < 4; i++)
97  if (get_bits(gb, 2) != 3)
98  return 0;
99  return 4;
100  default:
101  return 0;
102  }
103 }
104 
105 static inline int scale_tile_size(int def_size, int size_factor)
106 {
107  return size_factor == 15 ? def_size : (size_factor + 1) << 5;
108 }
109 
118 {
119  int pic_size_indx, i, p;
120  IVIPicConfig pic_conf;
121 
122  if (get_bits(&ctx->gb, 18) != 0x3FFF8) {
123  av_log(avctx, AV_LOG_ERROR, "Invalid picture start code!\n");
124  return AVERROR_INVALIDDATA;
125  }
126 
127  ctx->prev_frame_type = ctx->frame_type;
128  ctx->frame_type = get_bits(&ctx->gb, 3);
129  if (ctx->frame_type == 7) {
130  av_log(avctx, AV_LOG_ERROR, "Invalid frame type: %d\n", ctx->frame_type);
131  return AVERROR_INVALIDDATA;
132  }
133 
134 #if IVI4_STREAM_ANALYSER
135  if (ctx->frame_type == FRAMETYPE_BIDIR)
136  ctx->has_b_frames = 1;
137 #endif
138 
139  ctx->transp_status = get_bits1(&ctx->gb);
140 #if IVI4_STREAM_ANALYSER
141  if (ctx->transp_status) {
142  ctx->has_transp = 1;
143  }
144 #endif
145 
146  /* unknown bit: Mac decoder ignores this bit, XANIM returns error */
147  if (get_bits1(&ctx->gb)) {
148  av_log(avctx, AV_LOG_ERROR, "Sync bit is set!\n");
149  return AVERROR_INVALIDDATA;
150  }
151 
152  ctx->data_size = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 24) : 0;
153 
154  /* null frames don't contain anything else so we just return */
155  if (ctx->frame_type >= FRAMETYPE_NULL_FIRST) {
156  av_dlog(avctx, "Null frame encountered!\n");
157  return 0;
158  }
159 
160  /* Check key lock status. If enabled - ignore lock word. */
161  /* Usually we have to prompt the user for the password, but */
162  /* we don't do that because Indeo 4 videos can be decoded anyway */
163  if (get_bits1(&ctx->gb)) {
164  skip_bits_long(&ctx->gb, 32);
165  av_dlog(avctx, "Password-protected clip!\n");
166  }
167 
168  pic_size_indx = get_bits(&ctx->gb, 3);
169  if (pic_size_indx == IVI4_PIC_SIZE_ESC) {
170  pic_conf.pic_height = get_bits(&ctx->gb, 16);
171  pic_conf.pic_width = get_bits(&ctx->gb, 16);
172  } else {
173  pic_conf.pic_height = ivi4_common_pic_sizes[pic_size_indx * 2 + 1];
174  pic_conf.pic_width = ivi4_common_pic_sizes[pic_size_indx * 2 ];
175  }
176 
177  /* Decode tile dimensions. */
178  if (get_bits1(&ctx->gb)) {
179  pic_conf.tile_height = scale_tile_size(pic_conf.pic_height, get_bits(&ctx->gb, 4));
180  pic_conf.tile_width = scale_tile_size(pic_conf.pic_width, get_bits(&ctx->gb, 4));
181 #if IVI4_STREAM_ANALYSER
182  ctx->uses_tiling = 1;
183 #endif
184  } else {
185  pic_conf.tile_height = pic_conf.pic_height;
186  pic_conf.tile_width = pic_conf.pic_width;
187  }
188 
189  /* Decode chroma subsampling. We support only 4:4 aka YVU9. */
190  if (get_bits(&ctx->gb, 2)) {
191  av_log(avctx, AV_LOG_ERROR, "Only YVU9 picture format is supported!\n");
192  return AVERROR_INVALIDDATA;
193  }
194  pic_conf.chroma_height = (pic_conf.pic_height + 3) >> 2;
195  pic_conf.chroma_width = (pic_conf.pic_width + 3) >> 2;
196 
197  /* decode subdivision of the planes */
198  pic_conf.luma_bands = decode_plane_subdivision(&ctx->gb);
199  if (pic_conf.luma_bands)
200  pic_conf.chroma_bands = decode_plane_subdivision(&ctx->gb);
201  ctx->is_scalable = pic_conf.luma_bands != 1 || pic_conf.chroma_bands != 1;
202  if (ctx->is_scalable && (pic_conf.luma_bands != 4 || pic_conf.chroma_bands != 1)) {
203  av_log(avctx, AV_LOG_ERROR, "Scalability: unsupported subdivision! Luma bands: %d, chroma bands: %d\n",
204  pic_conf.luma_bands, pic_conf.chroma_bands);
205  return AVERROR_INVALIDDATA;
206  }
207 
208  /* check if picture layout was changed and reallocate buffers */
209  if (ivi_pic_config_cmp(&pic_conf, &ctx->pic_conf)) {
210  if (ff_ivi_init_planes(ctx->planes, &pic_conf)) {
211  av_log(avctx, AV_LOG_ERROR, "Couldn't reallocate color planes!\n");
212  ctx->pic_conf.luma_bands = 0;
213  return AVERROR(ENOMEM);
214  }
215 
216  ctx->pic_conf = pic_conf;
217 
218  /* set default macroblock/block dimensions */
219  for (p = 0; p <= 2; p++) {
220  for (i = 0; i < (!p ? pic_conf.luma_bands : pic_conf.chroma_bands); i++) {
221  ctx->planes[p].bands[i].mb_size = !p ? (!ctx->is_scalable ? 16 : 8) : 4;
222  ctx->planes[p].bands[i].blk_size = !p ? 8 : 4;
223  }
224  }
225 
227  ctx->pic_conf.tile_height)) {
228  av_log(avctx, AV_LOG_ERROR,
229  "Couldn't reallocate internal structures!\n");
230  return AVERROR(ENOMEM);
231  }
232  }
233 
234  ctx->frame_num = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 20) : 0;
235 
236  /* skip decTimeEst field if present */
237  if (get_bits1(&ctx->gb))
238  skip_bits(&ctx->gb, 8);
239 
240  /* decode macroblock and block huffman codebooks */
241  if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_MB_HUFF, &ctx->mb_vlc, avctx) ||
242  ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF, &ctx->blk_vlc, avctx))
243  return AVERROR_INVALIDDATA;
244 
245  ctx->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
246 
247  ctx->in_imf = get_bits1(&ctx->gb);
248  ctx->in_q = get_bits1(&ctx->gb);
249 
250  ctx->pic_glob_quant = get_bits(&ctx->gb, 5);
251 
252  /* TODO: ignore this parameter if unused */
253  ctx->unknown1 = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 0;
254 
255  ctx->checksum = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 16) : 0;
256 
257  /* skip picture header extension if any */
258  while (get_bits1(&ctx->gb)) {
259  av_dlog(avctx, "Pic hdr extension encountered!\n");
260  skip_bits(&ctx->gb, 8);
261  }
262 
263  if (get_bits1(&ctx->gb)) {
264  av_log(avctx, AV_LOG_ERROR, "Bad blocks bits encountered!\n");
265  }
266 
267  align_get_bits(&ctx->gb);
268 
269  return 0;
270 }
271 
272 
282  AVCodecContext *avctx)
283 {
284  int plane, band_num, indx, transform_id, scan_indx;
285  int i;
286 
287  plane = get_bits(&ctx->gb, 2);
288  band_num = get_bits(&ctx->gb, 4);
289  if (band->plane != plane || band->band_num != band_num) {
290  av_log(avctx, AV_LOG_ERROR, "Invalid band header sequence!\n");
291  return AVERROR_INVALIDDATA;
292  }
293 
294  band->is_empty = get_bits1(&ctx->gb);
295  if (!band->is_empty) {
296  int old_blk_size = band->blk_size;
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  avpriv_request_sample(avctx, "Transform %d", transform_id);
335  return AVERROR_PATCHWELCOME;
336  }
337  if ((transform_id >= 7 && transform_id <= 9) ||
338  transform_id == 17) {
339  avpriv_request_sample(avctx, "DCT transform");
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);
374 
375  if (band->quant_mat == 31)
376  av_log(avctx, AV_LOG_ERROR,
377  "Custom quant matrix encountered!\n");
378  else
379  avpriv_request_sample(avctx, "Quantization matrix %d",
380  band->quant_mat);
381  band->quant_mat = -1;
382  return AVERROR_INVALIDDATA;
383  }
384  } else {
385  if (old_blk_size != band->blk_size) {
386  av_log(avctx, AV_LOG_ERROR,
387  "The band block size does not match the configuration "
388  "inherited\n");
389  return AVERROR_INVALIDDATA;
390  }
391  if (band->quant_mat < 0) {
392  av_log(avctx, AV_LOG_ERROR, "Invalid quant_mat inherited\n");
393  return AVERROR_INVALIDDATA;
394  }
395  }
396 
397  /* decode block huffman codebook */
398  if (!get_bits1(&ctx->gb))
399  band->blk_vlc.tab = ctx->blk_vlc.tab;
400  else
401  if (ff_ivi_dec_huff_desc(&ctx->gb, 1, 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  .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 4"),
643  .type = AVMEDIA_TYPE_VIDEO,
644  .id = AV_CODEC_ID_INDEO4,
645  .priv_data_size = sizeof(IVI45DecContext),
646  .init = decode_init,
649  .capabilities = CODEC_CAP_DR1,
650 };