2 * Indeo Video Interactive v5 compatible decoder
3 * Copyright (c) 2009 Maxim Poliakovski
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 5 decoder
26 * Indeo5 data is usually transported within .avi or .mov files.
27 * Known FOURCCs: 'IV50'
30 #define BITSTREAM_READER_LE
35 #include "ivi_common.h"
36 #include "indeo5data.h"
43 FRAMETYPE_INTER = 1, ///< non-droppable P-frame
44 FRAMETYPE_INTER_SCAL = 2, ///< droppable P-frame used in the scalability mode
45 FRAMETYPE_INTER_NOREF = 3, ///< droppable P-frame
46 FRAMETYPE_NULL = 4 ///< empty frame with no data
49 #define IVI5_PIC_SIZE_ESC 15
52 * Decode Indeo5 GOP (Group of pictures) header.
53 * This header is present in key frames only.
54 * It defines parameters for all frames in a GOP.
56 * @param[in,out] ctx ptr to the decoder context
57 * @param[in] avctx ptr to the AVCodecContext
58 * @return result code: 0 = OK, -1 = error
60 static int decode_gop_header(IVI45DecContext *ctx, AVCodecContext *avctx)
62 int result, i, p, tile_size, pic_size_indx, mb_size, blk_size, is_scalable;
63 int quant_mat, blk_size_changed = 0;
64 IVIBandDesc *band, *band1, *band2;
65 IVIPicConfig pic_conf;
67 ctx->gop_flags = get_bits(&ctx->gb, 8);
69 ctx->gop_hdr_size = (ctx->gop_flags & 1) ? get_bits(&ctx->gb, 16) : 0;
71 if (ctx->gop_flags & IVI5_IS_PROTECTED)
72 ctx->lock_word = get_bits_long(&ctx->gb, 32);
74 tile_size = (ctx->gop_flags & 0x40) ? 64 << get_bits(&ctx->gb, 2) : 0;
75 if (tile_size > 256) {
76 av_log(avctx, AV_LOG_ERROR, "Invalid tile size: %d\n", tile_size);
80 /* decode number of wavelet bands */
81 /* num_levels * 3 + 1 */
82 pic_conf.luma_bands = get_bits(&ctx->gb, 2) * 3 + 1;
83 pic_conf.chroma_bands = get_bits1(&ctx->gb) * 3 + 1;
84 is_scalable = pic_conf.luma_bands != 1 || pic_conf.chroma_bands != 1;
85 if (is_scalable && (pic_conf.luma_bands != 4 || pic_conf.chroma_bands != 1)) {
86 av_log(avctx, AV_LOG_ERROR, "Scalability: unsupported subdivision! Luma bands: %d, chroma bands: %d\n",
87 pic_conf.luma_bands, pic_conf.chroma_bands);
91 pic_size_indx = get_bits(&ctx->gb, 4);
92 if (pic_size_indx == IVI5_PIC_SIZE_ESC) {
93 pic_conf.pic_height = get_bits(&ctx->gb, 13);
94 pic_conf.pic_width = get_bits(&ctx->gb, 13);
96 pic_conf.pic_height = ivi5_common_pic_sizes[pic_size_indx * 2 + 1] << 2;
97 pic_conf.pic_width = ivi5_common_pic_sizes[pic_size_indx * 2 ] << 2;
100 if (ctx->gop_flags & 2) {
101 av_log(avctx, AV_LOG_ERROR, "YV12 picture format not supported!\n");
105 pic_conf.chroma_height = (pic_conf.pic_height + 3) >> 2;
106 pic_conf.chroma_width = (pic_conf.pic_width + 3) >> 2;
109 pic_conf.tile_height = pic_conf.pic_height;
110 pic_conf.tile_width = pic_conf.pic_width;
112 pic_conf.tile_height = pic_conf.tile_width = tile_size;
115 /* check if picture layout was changed and reallocate buffers */
116 if (ivi_pic_config_cmp(&pic_conf, &ctx->pic_conf)) {
117 result = ff_ivi_init_planes(ctx->planes, &pic_conf);
119 av_log(avctx, AV_LOG_ERROR, "Couldn't reallocate color planes!\n");
122 ctx->pic_conf = pic_conf;
123 ctx->is_scalable = is_scalable;
124 blk_size_changed = 1; /* force reallocation of the internal structures */
127 for (p = 0; p <= 1; p++) {
128 for (i = 0; i < (!p ? pic_conf.luma_bands : pic_conf.chroma_bands); i++) {
129 band = &ctx->planes[p].bands[i];
131 band->is_halfpel = get_bits1(&ctx->gb);
133 mb_size = get_bits1(&ctx->gb);
134 blk_size = 8 >> get_bits1(&ctx->gb);
135 mb_size = blk_size << !mb_size;
137 if (p==0 && blk_size==4) {
138 av_log(avctx, AV_LOG_ERROR, "4x4 luma blocks are unsupported!\n");
139 return AVERROR_PATCHWELCOME;
142 blk_size_changed = mb_size != band->mb_size || blk_size != band->blk_size;
143 if (blk_size_changed) {
144 band->mb_size = mb_size;
145 band->blk_size = blk_size;
148 if (get_bits1(&ctx->gb)) {
149 av_log(avctx, AV_LOG_ERROR, "Extended transform info encountered!\n");
153 /* select transform function and scan pattern according to plane and band number */
154 switch ((p << 2) + i) {
156 band->inv_transform = ff_ivi_inverse_slant_8x8;
157 band->dc_transform = ff_ivi_dc_slant_2d;
158 band->scan = ff_zigzag_direct;
159 band->transform_size= 8;
163 band->inv_transform = ff_ivi_row_slant8;
164 band->dc_transform = ff_ivi_dc_row_slant;
165 band->scan = ff_ivi_vertical_scan_8x8;
166 band->transform_size= 8;
170 band->inv_transform = ff_ivi_col_slant8;
171 band->dc_transform = ff_ivi_dc_col_slant;
172 band->scan = ff_ivi_horizontal_scan_8x8;
173 band->transform_size= 8;
177 band->inv_transform = ff_ivi_put_pixels_8x8;
178 band->dc_transform = ff_ivi_put_dc_pixel_8x8;
179 band->scan = ff_ivi_horizontal_scan_8x8;
180 band->transform_size= 8;
184 band->inv_transform = ff_ivi_inverse_slant_4x4;
185 band->dc_transform = ff_ivi_dc_slant_2d;
186 band->scan = ff_ivi_direct_scan_4x4;
187 band->transform_size= 4;
191 band->is_2d_trans = band->inv_transform == ff_ivi_inverse_slant_8x8 ||
192 band->inv_transform == ff_ivi_inverse_slant_4x4;
194 /* select dequant matrix according to plane and band number */
196 quant_mat = (pic_conf.luma_bands > 1) ? i+1 : 0;
201 if (band->blk_size == 8) {
203 av_log(avctx, AV_LOG_ERROR, "quant_mat %d too large!\n", quant_mat);
206 band->intra_base = &ivi5_base_quant_8x8_intra[quant_mat][0];
207 band->inter_base = &ivi5_base_quant_8x8_inter[quant_mat][0];
208 band->intra_scale = &ivi5_scale_quant_8x8_intra[quant_mat][0];
209 band->inter_scale = &ivi5_scale_quant_8x8_inter[quant_mat][0];
211 band->intra_base = ivi5_base_quant_4x4_intra;
212 band->inter_base = ivi5_base_quant_4x4_inter;
213 band->intra_scale = ivi5_scale_quant_4x4_intra;
214 band->inter_scale = ivi5_scale_quant_4x4_inter;
217 if (get_bits(&ctx->gb, 2)) {
218 av_log(avctx, AV_LOG_ERROR, "End marker missing!\n");
224 /* copy chroma parameters into the 2nd chroma plane */
225 for (i = 0; i < pic_conf.chroma_bands; i++) {
226 band1 = &ctx->planes[1].bands[i];
227 band2 = &ctx->planes[2].bands[i];
229 band2->width = band1->width;
230 band2->height = band1->height;
231 band2->mb_size = band1->mb_size;
232 band2->blk_size = band1->blk_size;
233 band2->is_halfpel = band1->is_halfpel;
234 band2->intra_base = band1->intra_base;
235 band2->inter_base = band1->inter_base;
236 band2->intra_scale = band1->intra_scale;
237 band2->inter_scale = band1->inter_scale;
238 band2->scan = band1->scan;
239 band2->inv_transform = band1->inv_transform;
240 band2->dc_transform = band1->dc_transform;
241 band2->is_2d_trans = band1->is_2d_trans;
242 band2->transform_size= band1->transform_size;
245 /* reallocate internal structures if needed */
246 if (blk_size_changed) {
247 result = ff_ivi_init_tiles(ctx->planes, pic_conf.tile_width,
248 pic_conf.tile_height);
250 av_log(avctx, AV_LOG_ERROR,
251 "Couldn't reallocate internal structures!\n");
256 if (ctx->gop_flags & 8) {
257 if (get_bits(&ctx->gb, 3)) {
258 av_log(avctx, AV_LOG_ERROR, "Alignment bits are not zero!\n");
262 if (get_bits1(&ctx->gb))
263 skip_bits_long(&ctx->gb, 24); /* skip transparency fill color */
266 align_get_bits(&ctx->gb);
268 skip_bits(&ctx->gb, 23); /* FIXME: unknown meaning */
270 /* skip GOP extension if any */
271 if (get_bits1(&ctx->gb)) {
273 i = get_bits(&ctx->gb, 16);
274 } while (i & 0x8000);
277 align_get_bits(&ctx->gb);
284 * Skip a header extension.
286 * @param[in,out] gb the GetBit context
288 static inline void skip_hdr_extension(GetBitContext *gb)
293 len = get_bits(gb, 8);
294 for (i = 0; i < len; i++) skip_bits(gb, 8);
300 * Decode Indeo5 picture header.
302 * @param[in,out] ctx ptr to the decoder context
303 * @param[in] avctx ptr to the AVCodecContext
304 * @return result code: 0 = OK, -1 = error
306 static int decode_pic_hdr(IVI45DecContext *ctx, AVCodecContext *avctx)
308 if (get_bits(&ctx->gb, 5) != 0x1F) {
309 av_log(avctx, AV_LOG_ERROR, "Invalid picture start code!\n");
313 ctx->prev_frame_type = ctx->frame_type;
314 ctx->frame_type = get_bits(&ctx->gb, 3);
315 if (ctx->frame_type >= 5) {
316 av_log(avctx, AV_LOG_ERROR, "Invalid frame type: %d \n", ctx->frame_type);
320 ctx->frame_num = get_bits(&ctx->gb, 8);
322 if (ctx->frame_type == FRAMETYPE_INTRA) {
323 ctx->gop_invalid = 1;
324 if (decode_gop_header(ctx, avctx))
326 ctx->gop_invalid = 0;
329 if (ctx->frame_type == FRAMETYPE_INTER_SCAL && !ctx->is_scalable) {
330 av_log(avctx, AV_LOG_ERROR, "Scalable inter frame in non scaleable stream\n");
331 ctx->frame_type = FRAMETYPE_INTER;
332 return AVERROR_INVALIDDATA;
335 if (ctx->frame_type != FRAMETYPE_NULL) {
336 ctx->frame_flags = get_bits(&ctx->gb, 8);
338 ctx->pic_hdr_size = (ctx->frame_flags & 1) ? get_bits_long(&ctx->gb, 24) : 0;
340 ctx->checksum = (ctx->frame_flags & 0x10) ? get_bits(&ctx->gb, 16) : 0;
342 /* skip unknown extension if any */
343 if (ctx->frame_flags & 0x20)
344 skip_hdr_extension(&ctx->gb); /* XXX: untested */
346 /* decode macroblock huffman codebook */
347 if (ff_ivi_dec_huff_desc(&ctx->gb, ctx->frame_flags & 0x40, IVI_MB_HUFF, &ctx->mb_vlc, avctx))
350 skip_bits(&ctx->gb, 3); /* FIXME: unknown meaning! */
353 align_get_bits(&ctx->gb);
360 * Decode Indeo5 band header.
362 * @param[in,out] ctx ptr to the decoder context
363 * @param[in,out] band ptr to the band descriptor
364 * @param[in] avctx ptr to the AVCodecContext
365 * @return result code: 0 = OK, -1 = error
367 static int decode_band_hdr(IVI45DecContext *ctx, IVIBandDesc *band,
368 AVCodecContext *avctx)
373 band_flags = get_bits(&ctx->gb, 8);
375 if (band_flags & 1) {
380 band->data_size = (ctx->frame_flags & 0x80) ? get_bits_long(&ctx->gb, 24) : 0;
382 band->inherit_mv = band_flags & 2;
383 band->inherit_qdelta = band_flags & 8;
384 band->qdelta_present = band_flags & 4;
385 if (!band->qdelta_present) band->inherit_qdelta = 1;
387 /* decode rvmap probability corrections if any */
388 band->num_corr = 0; /* there are no corrections */
389 if (band_flags & 0x10) {
390 band->num_corr = get_bits(&ctx->gb, 8); /* get number of correction pairs */
391 if (band->num_corr > 61) {
392 av_log(avctx, AV_LOG_ERROR, "Too many corrections: %d\n",
397 /* read correction pairs */
398 for (i = 0; i < band->num_corr * 2; i++)
399 band->corr[i] = get_bits(&ctx->gb, 8);
402 /* select appropriate rvmap table for this band */
403 band->rvmap_sel = (band_flags & 0x40) ? get_bits(&ctx->gb, 3) : 8;
405 /* decode block huffman codebook */
406 if (ff_ivi_dec_huff_desc(&ctx->gb, band_flags & 0x80, IVI_BLK_HUFF, &band->blk_vlc, avctx))
409 band->checksum_present = get_bits1(&ctx->gb);
410 if (band->checksum_present)
411 band->checksum = get_bits(&ctx->gb, 16);
413 band->glob_quant = get_bits(&ctx->gb, 5);
415 /* skip unknown extension if any */
416 if (band_flags & 0x20) { /* XXX: untested */
417 align_get_bits(&ctx->gb);
418 skip_hdr_extension(&ctx->gb);
421 align_get_bits(&ctx->gb);
428 * Decode info (block type, cbp, quant delta, motion vector)
429 * for all macroblocks in the current tile.
431 * @param[in,out] ctx ptr to the decoder context
432 * @param[in,out] band ptr to the band descriptor
433 * @param[in,out] tile ptr to the tile descriptor
434 * @param[in] avctx ptr to the AVCodecContext
435 * @return result code: 0 = OK, -1 = error
437 static int decode_mb_info(IVI45DecContext *ctx, IVIBandDesc *band,
438 IVITile *tile, AVCodecContext *avctx)
440 int x, y, mv_x, mv_y, mv_delta, offs, mb_offset,
441 mv_scale, blks_per_mb, s;
442 IVIMbInfo *mb, *ref_mb;
443 int row_offset = band->mb_size * band->pitch;
446 ref_mb = tile->ref_mbs;
447 offs = tile->ypos * band->pitch + tile->xpos;
450 ((band->qdelta_present && band->inherit_qdelta) || band->inherit_mv))
451 return AVERROR_INVALIDDATA;
453 if( tile->num_MBs != IVI_MBs_PER_TILE(tile->width, tile->height, band->mb_size) ){
454 av_log(avctx, AV_LOG_ERROR, "allocated tile size %d mismatches parameters %d\n",
455 tile->num_MBs, IVI_MBs_PER_TILE(tile->width, tile->height, band->mb_size));
456 return AVERROR_INVALIDDATA;
459 /* scale factor for motion vectors */
460 mv_scale = (ctx->planes[0].bands[0].mb_size >> 3) - (band->mb_size >> 3);
463 for (y = tile->ypos; y < (tile->ypos + tile->height); y += band->mb_size) {
466 for (x = tile->xpos; x < (tile->xpos + tile->width); x += band->mb_size) {
469 mb->buf_offs = mb_offset;
471 if (get_bits1(&ctx->gb)) {
472 if (ctx->frame_type == FRAMETYPE_INTRA) {
473 av_log(avctx, AV_LOG_ERROR, "Empty macroblock in an INTRA picture!\n");
476 mb->type = 1; /* empty macroblocks are always INTER */
477 mb->cbp = 0; /* all blocks are empty */
480 if (!band->plane && !band->band_num && (ctx->frame_flags & 8)) {
481 mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
483 mb->q_delta = IVI_TOSIGNED(mb->q_delta);
486 mb->mv_x = mb->mv_y = 0; /* no motion vector coded */
487 if (band->inherit_mv && ref_mb){
488 /* motion vector inheritance */
490 mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
491 mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
493 mb->mv_x = ref_mb->mv_x;
494 mb->mv_y = ref_mb->mv_y;
498 if (band->inherit_mv && ref_mb) {
499 mb->type = ref_mb->type; /* copy mb_type from corresponding reference mb */
500 } else if (ctx->frame_type == FRAMETYPE_INTRA) {
501 mb->type = 0; /* mb_type is always INTRA for intra-frames */
503 mb->type = get_bits1(&ctx->gb);
506 blks_per_mb = band->mb_size != band->blk_size ? 4 : 1;
507 mb->cbp = get_bits(&ctx->gb, blks_per_mb);
510 if (band->qdelta_present) {
511 if (band->inherit_qdelta) {
512 if (ref_mb) mb->q_delta = ref_mb->q_delta;
513 } else if (mb->cbp || (!band->plane && !band->band_num &&
514 (ctx->frame_flags & 8))) {
515 mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
517 mb->q_delta = IVI_TOSIGNED(mb->q_delta);
522 mb->mv_x = mb->mv_y = 0; /* there is no motion vector in intra-macroblocks */
524 if (band->inherit_mv && ref_mb){
525 /* motion vector inheritance */
527 mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
528 mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
530 mb->mv_x = ref_mb->mv_x;
531 mb->mv_y = ref_mb->mv_y;
534 /* decode motion vector deltas */
535 mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
537 mv_y += IVI_TOSIGNED(mv_delta);
538 mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
540 mv_x += IVI_TOSIGNED(mv_delta);
549 if ( x + (mb->mv_x >>s) + (y+ (mb->mv_y >>s))*band->pitch < 0 ||
550 x + ((mb->mv_x+s)>>s) + band->mb_size - 1
551 + (y+band->mb_size - 1 +((mb->mv_y+s)>>s))*band->pitch > band->bufsize - 1) {
552 av_log(avctx, AV_LOG_ERROR, "motion vector %d %d outside reference\n", x*s + mb->mv_x, y*s + mb->mv_y);
553 return AVERROR_INVALIDDATA;
559 mb_offset += band->mb_size;
565 align_get_bits(&ctx->gb);
574 * @param[in,out] ctx ptr to the decoder context
576 static void switch_buffers(IVI45DecContext *ctx)
578 switch (ctx->prev_frame_type) {
579 case FRAMETYPE_INTRA:
580 case FRAMETYPE_INTER:
581 ctx->buf_switch ^= 1;
582 ctx->dst_buf = ctx->buf_switch;
583 ctx->ref_buf = ctx->buf_switch ^ 1;
585 case FRAMETYPE_INTER_SCAL:
586 if (!ctx->inter_scal) {
590 FFSWAP(int, ctx->dst_buf, ctx->ref2_buf);
591 ctx->ref_buf = ctx->ref2_buf;
593 case FRAMETYPE_INTER_NOREF:
597 switch (ctx->frame_type) {
598 case FRAMETYPE_INTRA:
601 case FRAMETYPE_INTER:
603 ctx->dst_buf = ctx->buf_switch;
604 ctx->ref_buf = ctx->buf_switch ^ 1;
606 case FRAMETYPE_INTER_SCAL:
607 case FRAMETYPE_INTER_NOREF:
614 static int is_nonnull_frame(IVI45DecContext *ctx)
616 return ctx->frame_type != FRAMETYPE_NULL;
621 * Initialize Indeo5 decoder.
623 static av_cold int decode_init(AVCodecContext *avctx)
625 IVI45DecContext *ctx = avctx->priv_data;
628 ff_ivi_init_static_vlc();
630 /* copy rvmap tables in our context so we can apply changes to them */
631 memcpy(ctx->rvmap_tabs, ff_ivi_rvmap_tabs, sizeof(ff_ivi_rvmap_tabs));
633 /* set the initial picture layout according to the basic profile:
634 there is only one band per plane (no scalability), only one tile (no local decoding)
635 and picture format = YVU9 */
636 ctx->pic_conf.pic_width = avctx->width;
637 ctx->pic_conf.pic_height = avctx->height;
638 ctx->pic_conf.chroma_width = (avctx->width + 3) >> 2;
639 ctx->pic_conf.chroma_height = (avctx->height + 3) >> 2;
640 ctx->pic_conf.tile_width = avctx->width;
641 ctx->pic_conf.tile_height = avctx->height;
642 ctx->pic_conf.luma_bands = ctx->pic_conf.chroma_bands = 1;
644 avcodec_get_frame_defaults(&ctx->frame);
646 result = ff_ivi_init_planes(ctx->planes, &ctx->pic_conf);
648 av_log(avctx, AV_LOG_ERROR, "Couldn't allocate color planes!\n");
655 ctx->decode_pic_hdr = decode_pic_hdr;
656 ctx->decode_band_hdr = decode_band_hdr;
657 ctx->decode_mb_info = decode_mb_info;
658 ctx->switch_buffers = switch_buffers;
659 ctx->is_nonnull_frame = is_nonnull_frame;
661 avctx->pix_fmt = PIX_FMT_YUV410P;
666 AVCodec ff_indeo5_decoder = {
668 .type = AVMEDIA_TYPE_VIDEO,
669 .id = CODEC_ID_INDEO5,
670 .priv_data_size = sizeof(IVI45DecContext),
672 .close = ff_ivi_decode_close,
673 .decode = ff_ivi_decode_frame,
674 .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 5"),