2 * Indeo Video Interactive v4 compatible decoder
3 * Copyright (c) 2009-2011 Maxim Poliakovski
5 * This file is part of Libav.
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.
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.
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
24 * Indeo Video Interactive version 4 decoder
26 * Indeo 4 data is usually transported within .avi or .mov files.
27 * Known FOURCCs: 'IV41'
30 #define BITSTREAM_READER_LE
34 #include "ivi_common.h"
35 #include "indeo4data.h"
38 * Indeo 4 frame types.
42 FRAMETYPE_INTRA1 = 1, ///< intra frame with slightly different bitstream coding
43 FRAMETYPE_INTER = 2, ///< non-droppable P-frame
44 FRAMETYPE_BIDIR = 3, ///< bidirectional frame
45 FRAMETYPE_INTER_NOREF = 4, ///< droppable P-frame
46 FRAMETYPE_NULL_FIRST = 5, ///< empty frame with no data
47 FRAMETYPE_NULL_LAST = 6 ///< empty frame with no data
50 #define IVI4_PIC_SIZE_ESC 7
54 InvTransformPtr *inv_trans;
55 DCTransformPtr *dc_trans;
58 { ff_ivi_inverse_haar_8x8, ff_ivi_dc_haar_2d, 1 },
59 { ff_ivi_row_haar8, ff_ivi_dc_haar_2d, 0 },
60 { ff_ivi_col_haar8, ff_ivi_dc_haar_2d, 0 },
61 { ff_ivi_put_pixels_8x8, ff_ivi_put_dc_pixel_8x8, 1 },
62 { ff_ivi_inverse_slant_8x8, ff_ivi_dc_slant_2d, 1 },
63 { ff_ivi_row_slant8, ff_ivi_dc_row_slant, 1 },
64 { ff_ivi_col_slant8, ff_ivi_dc_col_slant, 1 },
65 { NULL, NULL, 0 }, /* inverse DCT 8x8 */
66 { NULL, NULL, 0 }, /* inverse DCT 8x1 */
67 { NULL, NULL, 0 }, /* inverse DCT 1x8 */
68 { ff_ivi_inverse_haar_4x4, ff_ivi_dc_haar_2d, 1 },
69 { ff_ivi_inverse_slant_4x4, ff_ivi_dc_slant_2d, 1 },
70 { NULL, NULL, 0 }, /* no transform 4x4 */
71 { ff_ivi_row_haar4, ff_ivi_dc_haar_2d, 0 },
72 { ff_ivi_col_haar4, ff_ivi_dc_haar_2d, 0 },
73 { ff_ivi_row_slant4, ff_ivi_dc_row_slant, 0 },
74 { ff_ivi_col_slant4, ff_ivi_dc_col_slant, 0 },
75 { NULL, NULL, 0 }, /* inverse DCT 4x4 */
79 * Decode subdivision of a plane.
80 * This is a simplified version that checks for two supported subdivisions:
81 * - 1 wavelet band per plane, size factor 1:1, code pattern: 3
82 * - 4 wavelet bands per plane, size factor 1:4, code pattern: 2,3,3,3,3
83 * Anything else is either unsupported or corrupt.
85 * @param[in,out] gb the GetBit context
86 * @return number of wavelet bands or 0 on error
88 static int decode_plane_subdivision(GetBitContext *gb)
92 switch (get_bits(gb, 2)) {
96 for (i = 0; i < 4; i++)
97 if (get_bits(gb, 2) != 3)
105 static inline int scale_tile_size(int def_size, int size_factor)
107 return size_factor == 15 ? def_size : (size_factor + 1) << 5;
111 * Decode Indeo 4 picture header.
113 * @param[in,out] ctx pointer to the decoder context
114 * @param[in] avctx pointer to the AVCodecContext
115 * @return result code: 0 = OK, negative number = error
117 static int decode_pic_hdr(IVI45DecContext *ctx, AVCodecContext *avctx)
119 int pic_size_indx, i, p;
120 IVIPicConfig pic_conf;
122 if (get_bits(&ctx->gb, 18) != 0x3FFF8) {
123 av_log(avctx, AV_LOG_ERROR, "Invalid picture start code!\n");
124 return AVERROR_INVALIDDATA;
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;
134 #if IVI4_STREAM_ANALYSER
135 if (ctx->frame_type == FRAMETYPE_BIDIR)
136 ctx->has_b_frames = 1;
139 ctx->transp_status = get_bits1(&ctx->gb);
140 #if IVI4_STREAM_ANALYSER
141 if (ctx->transp_status) {
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;
152 ctx->data_size = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 24) : 0;
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");
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");
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);
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 ];
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;
185 pic_conf.tile_height = pic_conf.pic_height;
186 pic_conf.tile_width = pic_conf.pic_width;
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;
194 pic_conf.chroma_height = (pic_conf.pic_height + 3) >> 2;
195 pic_conf.chroma_width = (pic_conf.pic_width + 3) >> 2;
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;
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 return AVERROR(ENOMEM);
215 ctx->pic_conf = pic_conf;
217 /* set default macroblock/block dimensions */
218 for (p = 0; p <= 2; p++) {
219 for (i = 0; i < (!p ? pic_conf.luma_bands : pic_conf.chroma_bands); i++) {
220 ctx->planes[p].bands[i].mb_size = !p ? (!ctx->is_scalable ? 16 : 8) : 4;
221 ctx->planes[p].bands[i].blk_size = !p ? 8 : 4;
225 if (ff_ivi_init_tiles(ctx->planes, ctx->pic_conf.tile_width,
226 ctx->pic_conf.tile_height)) {
227 av_log(avctx, AV_LOG_ERROR,
228 "Couldn't reallocate internal structures!\n");
229 return AVERROR(ENOMEM);
233 ctx->frame_num = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 20) : 0;
235 /* skip decTimeEst field if present */
236 if (get_bits1(&ctx->gb))
237 skip_bits(&ctx->gb, 8);
239 /* decode macroblock and block huffman codebooks */
240 if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_MB_HUFF, &ctx->mb_vlc, avctx) ||
241 ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF, &ctx->blk_vlc, avctx))
242 return AVERROR_INVALIDDATA;
244 ctx->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
246 ctx->in_imf = get_bits1(&ctx->gb);
247 ctx->in_q = get_bits1(&ctx->gb);
249 ctx->pic_glob_quant = get_bits(&ctx->gb, 5);
251 /* TODO: ignore this parameter if unused */
252 ctx->unknown1 = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 0;
254 ctx->checksum = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 16) : 0;
256 /* skip picture header extension if any */
257 while (get_bits1(&ctx->gb)) {
258 av_dlog(avctx, "Pic hdr extension encountered!\n");
259 skip_bits(&ctx->gb, 8);
262 if (get_bits1(&ctx->gb)) {
263 av_log(avctx, AV_LOG_ERROR, "Bad blocks bits encountered!\n");
266 align_get_bits(&ctx->gb);
273 * Decode Indeo 4 band header.
275 * @param[in,out] ctx pointer to the decoder context
276 * @param[in,out] band pointer to the band descriptor
277 * @param[in] avctx pointer to the AVCodecContext
278 * @return result code: 0 = OK, negative number = error
280 static int decode_band_hdr(IVI45DecContext *ctx, IVIBandDesc *band,
281 AVCodecContext *avctx)
283 int plane, band_num, indx, transform_id, scan_indx;
286 plane = get_bits(&ctx->gb, 2);
287 band_num = get_bits(&ctx->gb, 4);
288 if (band->plane != plane || band->band_num != band_num) {
289 av_log(avctx, AV_LOG_ERROR, "Invalid band header sequence!\n");
290 return AVERROR_INVALIDDATA;
293 band->is_empty = get_bits1(&ctx->gb);
294 if (!band->is_empty) {
296 * If header size is not given, header size is 4 bytes. */
297 if (get_bits1(&ctx->gb))
298 skip_bits(&ctx->gb, 16);
300 band->is_halfpel = get_bits(&ctx->gb, 2);
301 if (band->is_halfpel >= 2) {
302 av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported mv resolution: %d!\n",
304 return AVERROR_INVALIDDATA;
306 #if IVI4_STREAM_ANALYSER
307 if (!band->is_halfpel)
308 ctx->uses_fullpel = 1;
311 band->checksum_present = get_bits1(&ctx->gb);
312 if (band->checksum_present)
313 band->checksum = get_bits(&ctx->gb, 16);
315 indx = get_bits(&ctx->gb, 2);
317 av_log(avctx, AV_LOG_ERROR, "Invalid block size!\n");
318 return AVERROR_INVALIDDATA;
320 band->mb_size = 16 >> indx;
321 band->blk_size = 8 >> (indx >> 1);
323 band->inherit_mv = get_bits1(&ctx->gb);
324 band->inherit_qdelta = get_bits1(&ctx->gb);
326 band->glob_quant = get_bits(&ctx->gb, 5);
328 if (!get_bits1(&ctx->gb) || ctx->frame_type == FRAMETYPE_INTRA) {
329 transform_id = get_bits(&ctx->gb, 5);
330 if (transform_id >= FF_ARRAY_ELEMS(transforms) ||
331 !transforms[transform_id].inv_trans) {
332 avpriv_request_sample(avctx, "Transform %d", transform_id);
333 return AVERROR_PATCHWELCOME;
335 if ((transform_id >= 7 && transform_id <= 9) ||
336 transform_id == 17) {
337 avpriv_request_sample(avctx, "DCT transform");
338 return AVERROR_PATCHWELCOME;
341 #if IVI4_STREAM_ANALYSER
342 if ((transform_id >= 0 && transform_id <= 2) || transform_id == 10)
346 band->inv_transform = transforms[transform_id].inv_trans;
347 band->dc_transform = transforms[transform_id].dc_trans;
348 band->is_2d_trans = transforms[transform_id].is_2d_trans;
350 scan_indx = get_bits(&ctx->gb, 4);
351 if (scan_indx == 15) {
352 av_log(avctx, AV_LOG_ERROR, "Custom scan pattern encountered!\n");
353 return AVERROR_INVALIDDATA;
355 band->scan = scan_index_to_tab[scan_indx];
357 band->quant_mat = get_bits(&ctx->gb, 5);
358 if (band->quant_mat == 31) {
359 av_log(avctx, AV_LOG_ERROR, "Custom quant matrix encountered!\n");
360 return AVERROR_INVALIDDATA;
364 /* decode block huffman codebook */
365 if (!get_bits1(&ctx->gb))
366 band->blk_vlc.tab = ctx->blk_vlc.tab;
368 if (ff_ivi_dec_huff_desc(&ctx->gb, 1, IVI_BLK_HUFF,
369 &band->blk_vlc, avctx))
370 return AVERROR_INVALIDDATA;
372 /* select appropriate rvmap table for this band */
373 band->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
375 /* decode rvmap probability corrections if any */
376 band->num_corr = 0; /* there is no corrections */
377 if (get_bits1(&ctx->gb)) {
378 band->num_corr = get_bits(&ctx->gb, 8); /* get number of correction pairs */
379 if (band->num_corr > 61) {
380 av_log(avctx, AV_LOG_ERROR, "Too many corrections: %d\n",
382 return AVERROR_INVALIDDATA;
385 /* read correction pairs */
386 for (i = 0; i < band->num_corr * 2; i++)
387 band->corr[i] = get_bits(&ctx->gb, 8);
391 if (band->blk_size == 8) {
392 band->intra_base = &ivi4_quant_8x8_intra[quant_index_to_tab[band->quant_mat]][0];
393 band->inter_base = &ivi4_quant_8x8_inter[quant_index_to_tab[band->quant_mat]][0];
395 band->intra_base = &ivi4_quant_4x4_intra[quant_index_to_tab[band->quant_mat]][0];
396 band->inter_base = &ivi4_quant_4x4_inter[quant_index_to_tab[band->quant_mat]][0];
399 /* Indeo 4 doesn't use scale tables */
400 band->intra_scale = NULL;
401 band->inter_scale = NULL;
403 align_get_bits(&ctx->gb);
410 * Decode information (block type, cbp, quant delta, motion vector)
411 * for all macroblocks in the current tile.
413 * @param[in,out] ctx pointer to the decoder context
414 * @param[in,out] band pointer to the band descriptor
415 * @param[in,out] tile pointer to the tile descriptor
416 * @param[in] avctx pointer to the AVCodecContext
417 * @return result code: 0 = OK, negative number = error
419 static int decode_mb_info(IVI45DecContext *ctx, IVIBandDesc *band,
420 IVITile *tile, AVCodecContext *avctx)
422 int x, y, mv_x, mv_y, mv_delta, offs, mb_offset, blks_per_mb,
423 mv_scale, mb_type_bits;
424 IVIMbInfo *mb, *ref_mb;
425 int row_offset = band->mb_size * band->pitch;
428 ref_mb = tile->ref_mbs;
429 offs = tile->ypos * band->pitch + tile->xpos;
431 blks_per_mb = band->mb_size != band->blk_size ? 4 : 1;
432 mb_type_bits = ctx->frame_type == FRAMETYPE_BIDIR ? 2 : 1;
434 /* scale factor for motion vectors */
435 mv_scale = (ctx->planes[0].bands[0].mb_size >> 3) - (band->mb_size >> 3);
438 for (y = tile->ypos; y < tile->ypos + tile->height; y += band->mb_size) {
441 for (x = tile->xpos; x < tile->xpos + tile->width; x += band->mb_size) {
444 mb->buf_offs = mb_offset;
446 if (get_bits1(&ctx->gb)) {
447 if (ctx->frame_type == FRAMETYPE_INTRA) {
448 av_log(avctx, AV_LOG_ERROR, "Empty macroblock in an INTRA picture!\n");
449 return AVERROR_INVALIDDATA;
451 mb->type = 1; /* empty macroblocks are always INTER */
452 mb->cbp = 0; /* all blocks are empty */
455 if (!band->plane && !band->band_num && ctx->in_q) {
456 mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
458 mb->q_delta = IVI_TOSIGNED(mb->q_delta);
461 mb->mv_x = mb->mv_y = 0; /* no motion vector coded */
462 if (band->inherit_mv) {
463 /* motion vector inheritance */
465 mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
466 mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
468 mb->mv_x = ref_mb->mv_x;
469 mb->mv_y = ref_mb->mv_y;
473 if (band->inherit_mv) {
474 mb->type = ref_mb->type; /* copy mb_type from corresponding reference mb */
475 } else if (ctx->frame_type == FRAMETYPE_INTRA ||
476 ctx->frame_type == FRAMETYPE_INTRA1) {
477 mb->type = 0; /* mb_type is always INTRA for intra-frames */
479 mb->type = get_bits(&ctx->gb, mb_type_bits);
482 mb->cbp = get_bits(&ctx->gb, blks_per_mb);
485 if (band->inherit_qdelta) {
486 if (ref_mb) mb->q_delta = ref_mb->q_delta;
487 } else if (mb->cbp || (!band->plane && !band->band_num &&
489 mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
491 mb->q_delta = IVI_TOSIGNED(mb->q_delta);
495 mb->mv_x = mb->mv_y = 0; /* there is no motion vector in intra-macroblocks */
497 if (band->inherit_mv) {
498 /* motion vector inheritance */
500 mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
501 mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
503 mb->mv_x = ref_mb->mv_x;
504 mb->mv_y = ref_mb->mv_y;
507 /* decode motion vector deltas */
508 mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
510 mv_y += IVI_TOSIGNED(mv_delta);
511 mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
513 mv_x += IVI_TOSIGNED(mv_delta);
523 mb_offset += band->mb_size;
529 align_get_bits(&ctx->gb);
536 * Rearrange decoding and reference buffers.
538 * @param[in,out] ctx pointer to the decoder context
540 static void switch_buffers(IVI45DecContext *ctx)
542 switch (ctx->prev_frame_type) {
543 case FRAMETYPE_INTRA:
544 case FRAMETYPE_INTRA1:
545 case FRAMETYPE_INTER:
546 ctx->buf_switch ^= 1;
547 ctx->dst_buf = ctx->buf_switch;
548 ctx->ref_buf = ctx->buf_switch ^ 1;
550 case FRAMETYPE_INTER_NOREF:
554 switch (ctx->frame_type) {
555 case FRAMETYPE_INTRA:
556 case FRAMETYPE_INTRA1:
559 case FRAMETYPE_INTER:
560 ctx->dst_buf = ctx->buf_switch;
561 ctx->ref_buf = ctx->buf_switch ^ 1;
563 case FRAMETYPE_INTER_NOREF:
564 case FRAMETYPE_NULL_FIRST:
565 case FRAMETYPE_NULL_LAST:
571 static int is_nonnull_frame(IVI45DecContext *ctx)
573 return ctx->frame_type < FRAMETYPE_NULL_FIRST;
577 static av_cold int decode_init(AVCodecContext *avctx)
579 IVI45DecContext *ctx = avctx->priv_data;
581 ff_ivi_init_static_vlc();
583 /* copy rvmap tables in our context so we can apply changes to them */
584 memcpy(ctx->rvmap_tabs, ff_ivi_rvmap_tabs, sizeof(ff_ivi_rvmap_tabs));
586 /* Force allocation of the internal buffers */
587 /* during picture header decoding. */
588 ctx->pic_conf.pic_width = 0;
589 ctx->pic_conf.pic_height = 0;
591 avctx->pix_fmt = AV_PIX_FMT_YUV410P;
593 ctx->decode_pic_hdr = decode_pic_hdr;
594 ctx->decode_band_hdr = decode_band_hdr;
595 ctx->decode_mb_info = decode_mb_info;
596 ctx->switch_buffers = switch_buffers;
597 ctx->is_nonnull_frame = is_nonnull_frame;
603 AVCodec ff_indeo4_decoder = {
605 .type = AVMEDIA_TYPE_VIDEO,
606 .id = AV_CODEC_ID_INDEO4,
607 .priv_data_size = sizeof(IVI45DecContext),
609 .close = ff_ivi_decode_close,
610 .decode = ff_ivi_decode_frame,
611 .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 4"),
612 .capabilities = CODEC_CAP_DR1,