2 * Indeo Video Interactive v5 compatible decoder
3 * Copyright (c) 2009 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 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
;
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 ctx
->is_scalable
= pic_conf
.luma_bands
!= 1 || pic_conf
.chroma_bands
!= 1;
85 if (ctx
->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 blk_size_changed
= 1; /* force reallocation of the internal structures */
126 for (p
= 0; p
<= 1; p
++) {
127 for (i
= 0; i
< (!p
? pic_conf
.luma_bands
: pic_conf
.chroma_bands
); i
++) {
128 band
= &ctx
->planes
[p
].bands
[i
];
130 band
->is_halfpel
= get_bits1(&ctx
->gb
);
132 mb_size
= get_bits1(&ctx
->gb
);
133 blk_size
= 8 >> get_bits1(&ctx
->gb
);
134 mb_size
= blk_size
<< !mb_size
;
136 blk_size_changed
= mb_size
!= band
->mb_size
|| blk_size
!= band
->blk_size
;
137 if (blk_size_changed
) {
138 band
->mb_size
= mb_size
;
139 band
->blk_size
= blk_size
;
142 if (get_bits1(&ctx
->gb
)) {
143 av_log(avctx
, AV_LOG_ERROR
, "Extended transform info encountered!\n");
147 /* select transform function and scan pattern according to plane and band number */
148 switch ((p
<< 2) + i
) {
150 band
->inv_transform
= ff_ivi_inverse_slant_8x8
;
151 band
->dc_transform
= ff_ivi_dc_slant_2d
;
152 band
->scan
= ff_zigzag_direct
;
156 band
->inv_transform
= ff_ivi_row_slant8
;
157 band
->dc_transform
= ff_ivi_dc_row_slant
;
158 band
->scan
= ff_ivi_vertical_scan_8x8
;
162 band
->inv_transform
= ff_ivi_col_slant8
;
163 band
->dc_transform
= ff_ivi_dc_col_slant
;
164 band
->scan
= ff_ivi_horizontal_scan_8x8
;
168 band
->inv_transform
= ff_ivi_put_pixels_8x8
;
169 band
->dc_transform
= ff_ivi_put_dc_pixel_8x8
;
170 band
->scan
= ff_ivi_horizontal_scan_8x8
;
174 band
->inv_transform
= ff_ivi_inverse_slant_4x4
;
175 band
->dc_transform
= ff_ivi_dc_slant_2d
;
176 band
->scan
= ff_ivi_direct_scan_4x4
;
180 band
->is_2d_trans
= band
->inv_transform
== ff_ivi_inverse_slant_8x8
||
181 band
->inv_transform
== ff_ivi_inverse_slant_4x4
;
183 /* select dequant matrix according to plane and band number */
185 quant_mat
= (pic_conf
.luma_bands
> 1) ? i
+1 : 0;
190 if (band
->blk_size
== 8) {
191 band
->intra_base
= &ivi5_base_quant_8x8_intra
[quant_mat
][0];
192 band
->inter_base
= &ivi5_base_quant_8x8_inter
[quant_mat
][0];
193 band
->intra_scale
= &ivi5_scale_quant_8x8_intra
[quant_mat
][0];
194 band
->inter_scale
= &ivi5_scale_quant_8x8_inter
[quant_mat
][0];
196 band
->intra_base
= ivi5_base_quant_4x4_intra
;
197 band
->inter_base
= ivi5_base_quant_4x4_inter
;
198 band
->intra_scale
= ivi5_scale_quant_4x4_intra
;
199 band
->inter_scale
= ivi5_scale_quant_4x4_inter
;
202 if (get_bits(&ctx
->gb
, 2)) {
203 av_log(avctx
, AV_LOG_ERROR
, "End marker missing!\n");
209 /* copy chroma parameters into the 2nd chroma plane */
210 for (i
= 0; i
< pic_conf
.chroma_bands
; i
++) {
211 band1
= &ctx
->planes
[1].bands
[i
];
212 band2
= &ctx
->planes
[2].bands
[i
];
214 band2
->width
= band1
->width
;
215 band2
->height
= band1
->height
;
216 band2
->mb_size
= band1
->mb_size
;
217 band2
->blk_size
= band1
->blk_size
;
218 band2
->is_halfpel
= band1
->is_halfpel
;
219 band2
->intra_base
= band1
->intra_base
;
220 band2
->inter_base
= band1
->inter_base
;
221 band2
->intra_scale
= band1
->intra_scale
;
222 band2
->inter_scale
= band1
->inter_scale
;
223 band2
->scan
= band1
->scan
;
224 band2
->inv_transform
= band1
->inv_transform
;
225 band2
->dc_transform
= band1
->dc_transform
;
226 band2
->is_2d_trans
= band1
->is_2d_trans
;
229 /* reallocate internal structures if needed */
230 if (blk_size_changed
) {
231 result
= ff_ivi_init_tiles(ctx
->planes
, pic_conf
.tile_width
,
232 pic_conf
.tile_height
);
234 av_log(avctx
, AV_LOG_ERROR
,
235 "Couldn't reallocate internal structures!\n");
240 if (ctx
->gop_flags
& 8) {
241 if (get_bits(&ctx
->gb
, 3)) {
242 av_log(avctx
, AV_LOG_ERROR
, "Alignment bits are not zero!\n");
246 if (get_bits1(&ctx
->gb
))
247 skip_bits_long(&ctx
->gb
, 24); /* skip transparency fill color */
250 align_get_bits(&ctx
->gb
);
252 skip_bits(&ctx
->gb
, 23); /* FIXME: unknown meaning */
254 /* skip GOP extension if any */
255 if (get_bits1(&ctx
->gb
)) {
257 i
= get_bits(&ctx
->gb
, 16);
258 } while (i
& 0x8000);
261 align_get_bits(&ctx
->gb
);
268 * Skip a header extension.
270 * @param[in,out] gb the GetBit context
272 static inline void skip_hdr_extension(GetBitContext
*gb
)
277 len
= get_bits(gb
, 8);
278 for (i
= 0; i
< len
; i
++) skip_bits(gb
, 8);
284 * Decode Indeo5 picture header.
286 * @param[in,out] ctx ptr to the decoder context
287 * @param[in] avctx ptr to the AVCodecContext
288 * @return result code: 0 = OK, -1 = error
290 static int decode_pic_hdr(IVI45DecContext
*ctx
, AVCodecContext
*avctx
)
292 if (get_bits(&ctx
->gb
, 5) != 0x1F) {
293 av_log(avctx
, AV_LOG_ERROR
, "Invalid picture start code!\n");
297 ctx
->prev_frame_type
= ctx
->frame_type
;
298 ctx
->frame_type
= get_bits(&ctx
->gb
, 3);
299 if (ctx
->frame_type
>= 5) {
300 av_log(avctx
, AV_LOG_ERROR
, "Invalid frame type: %d \n", ctx
->frame_type
);
304 ctx
->frame_num
= get_bits(&ctx
->gb
, 8);
306 if (ctx
->frame_type
== FRAMETYPE_INTRA
) {
307 ctx
->gop_invalid
= 1;
308 if (decode_gop_header(ctx
, avctx
)) {
309 av_log(avctx
, AV_LOG_ERROR
, "Invalid GOP header, skipping frames.\n");
310 return AVERROR_INVALIDDATA
;
312 ctx
->gop_invalid
= 0;
315 if (ctx
->frame_type
!= FRAMETYPE_NULL
) {
316 ctx
->frame_flags
= get_bits(&ctx
->gb
, 8);
318 ctx
->pic_hdr_size
= (ctx
->frame_flags
& 1) ? get_bits_long(&ctx
->gb
, 24) : 0;
320 ctx
->checksum
= (ctx
->frame_flags
& 0x10) ? get_bits(&ctx
->gb
, 16) : 0;
322 /* skip unknown extension if any */
323 if (ctx
->frame_flags
& 0x20)
324 skip_hdr_extension(&ctx
->gb
); /* XXX: untested */
326 /* decode macroblock huffman codebook */
327 if (ff_ivi_dec_huff_desc(&ctx
->gb
, ctx
->frame_flags
& 0x40, IVI_MB_HUFF
, &ctx
->mb_vlc
, avctx
))
330 skip_bits(&ctx
->gb
, 3); /* FIXME: unknown meaning! */
333 align_get_bits(&ctx
->gb
);
340 * Decode Indeo5 band header.
342 * @param[in,out] ctx ptr to the decoder context
343 * @param[in,out] band ptr to the band descriptor
344 * @param[in] avctx ptr to the AVCodecContext
345 * @return result code: 0 = OK, -1 = error
347 static int decode_band_hdr(IVI45DecContext
*ctx
, IVIBandDesc
*band
,
348 AVCodecContext
*avctx
)
353 band_flags
= get_bits(&ctx
->gb
, 8);
355 if (band_flags
& 1) {
360 band
->data_size
= (ctx
->frame_flags
& 0x80) ? get_bits_long(&ctx
->gb
, 24) : 0;
362 band
->inherit_mv
= band_flags
& 2;
363 band
->inherit_qdelta
= band_flags
& 8;
364 band
->qdelta_present
= band_flags
& 4;
365 if (!band
->qdelta_present
) band
->inherit_qdelta
= 1;
367 /* decode rvmap probability corrections if any */
368 band
->num_corr
= 0; /* there are no corrections */
369 if (band_flags
& 0x10) {
370 band
->num_corr
= get_bits(&ctx
->gb
, 8); /* get number of correction pairs */
371 if (band
->num_corr
> 61) {
372 av_log(avctx
, AV_LOG_ERROR
, "Too many corrections: %d\n",
377 /* read correction pairs */
378 for (i
= 0; i
< band
->num_corr
* 2; i
++)
379 band
->corr
[i
] = get_bits(&ctx
->gb
, 8);
382 /* select appropriate rvmap table for this band */
383 band
->rvmap_sel
= (band_flags
& 0x40) ? get_bits(&ctx
->gb
, 3) : 8;
385 /* decode block huffman codebook */
386 if (ff_ivi_dec_huff_desc(&ctx
->gb
, band_flags
& 0x80, IVI_BLK_HUFF
, &band
->blk_vlc
, avctx
))
389 band
->checksum_present
= get_bits1(&ctx
->gb
);
390 if (band
->checksum_present
)
391 band
->checksum
= get_bits(&ctx
->gb
, 16);
393 band
->glob_quant
= get_bits(&ctx
->gb
, 5);
395 /* skip unknown extension if any */
396 if (band_flags
& 0x20) { /* XXX: untested */
397 align_get_bits(&ctx
->gb
);
398 skip_hdr_extension(&ctx
->gb
);
401 align_get_bits(&ctx
->gb
);
408 * Decode info (block type, cbp, quant delta, motion vector)
409 * for all macroblocks in the current tile.
411 * @param[in,out] ctx ptr to the decoder context
412 * @param[in,out] band ptr to the band descriptor
413 * @param[in,out] tile ptr to the tile descriptor
414 * @param[in] avctx ptr to the AVCodecContext
415 * @return result code: 0 = OK, -1 = error
417 static int decode_mb_info(IVI45DecContext
*ctx
, IVIBandDesc
*band
,
418 IVITile
*tile
, AVCodecContext
*avctx
)
420 int x
, y
, mv_x
, mv_y
, mv_delta
, offs
, mb_offset
,
421 mv_scale
, blks_per_mb
;
422 IVIMbInfo
*mb
, *ref_mb
;
423 int row_offset
= band
->mb_size
* band
->pitch
;
426 ref_mb
= tile
->ref_mbs
;
427 offs
= tile
->ypos
* band
->pitch
+ tile
->xpos
;
430 ((band
->qdelta_present
&& band
->inherit_qdelta
) || band
->inherit_mv
))
431 return AVERROR_INVALIDDATA
;
433 if (tile
->num_MBs
!= IVI_MBs_PER_TILE(tile
->width
, tile
->height
, band
->mb_size
)) {
434 av_log(avctx
, AV_LOG_ERROR
, "Allocated tile size %d mismatches parameters %d\n",
435 tile
->num_MBs
, IVI_MBs_PER_TILE(tile
->width
, tile
->height
, band
->mb_size
));
436 return AVERROR_INVALIDDATA
;
439 /* scale factor for motion vectors */
440 mv_scale
= (ctx
->planes
[0].bands
[0].mb_size
>> 3) - (band
->mb_size
>> 3);
443 for (y
= tile
->ypos
; y
< (tile
->ypos
+ tile
->height
); y
+= band
->mb_size
) {
446 for (x
= tile
->xpos
; x
< (tile
->xpos
+ tile
->width
); x
+= band
->mb_size
) {
449 mb
->buf_offs
= mb_offset
;
451 if (get_bits1(&ctx
->gb
)) {
452 if (ctx
->frame_type
== FRAMETYPE_INTRA
) {
453 av_log(avctx
, AV_LOG_ERROR
, "Empty macroblock in an INTRA picture!\n");
456 mb
->type
= 1; /* empty macroblocks are always INTER */
457 mb
->cbp
= 0; /* all blocks are empty */
460 if (!band
->plane
&& !band
->band_num
&& (ctx
->frame_flags
& 8)) {
461 mb
->q_delta
= get_vlc2(&ctx
->gb
, ctx
->mb_vlc
.tab
->table
,
463 mb
->q_delta
= IVI_TOSIGNED(mb
->q_delta
);
466 mb
->mv_x
= mb
->mv_y
= 0; /* no motion vector coded */
467 if (band
->inherit_mv
){
468 /* motion vector inheritance */
470 mb
->mv_x
= ivi_scale_mv(ref_mb
->mv_x
, mv_scale
);
471 mb
->mv_y
= ivi_scale_mv(ref_mb
->mv_y
, mv_scale
);
473 mb
->mv_x
= ref_mb
->mv_x
;
474 mb
->mv_y
= ref_mb
->mv_y
;
478 if (band
->inherit_mv
) {
479 mb
->type
= ref_mb
->type
; /* copy mb_type from corresponding reference mb */
480 } else if (ctx
->frame_type
== FRAMETYPE_INTRA
) {
481 mb
->type
= 0; /* mb_type is always INTRA for intra-frames */
483 mb
->type
= get_bits1(&ctx
->gb
);
486 blks_per_mb
= band
->mb_size
!= band
->blk_size
? 4 : 1;
487 mb
->cbp
= get_bits(&ctx
->gb
, blks_per_mb
);
490 if (band
->qdelta_present
) {
491 if (band
->inherit_qdelta
) {
492 if (ref_mb
) mb
->q_delta
= ref_mb
->q_delta
;
493 } else if (mb
->cbp
|| (!band
->plane
&& !band
->band_num
&&
494 (ctx
->frame_flags
& 8))) {
495 mb
->q_delta
= get_vlc2(&ctx
->gb
, ctx
->mb_vlc
.tab
->table
,
497 mb
->q_delta
= IVI_TOSIGNED(mb
->q_delta
);
502 mb
->mv_x
= mb
->mv_y
= 0; /* there is no motion vector in intra-macroblocks */
504 if (band
->inherit_mv
){
505 /* motion vector inheritance */
507 mb
->mv_x
= ivi_scale_mv(ref_mb
->mv_x
, mv_scale
);
508 mb
->mv_y
= ivi_scale_mv(ref_mb
->mv_y
, mv_scale
);
510 mb
->mv_x
= ref_mb
->mv_x
;
511 mb
->mv_y
= ref_mb
->mv_y
;
514 /* decode motion vector deltas */
515 mv_delta
= get_vlc2(&ctx
->gb
, ctx
->mb_vlc
.tab
->table
,
517 mv_y
+= IVI_TOSIGNED(mv_delta
);
518 mv_delta
= get_vlc2(&ctx
->gb
, ctx
->mb_vlc
.tab
->table
,
520 mv_x
+= IVI_TOSIGNED(mv_delta
);
530 mb_offset
+= band
->mb_size
;
536 align_get_bits(&ctx
->gb
);
545 * @param[in,out] ctx ptr to the decoder context
547 static void switch_buffers(IVI45DecContext
*ctx
)
549 switch (ctx
->prev_frame_type
) {
550 case FRAMETYPE_INTRA
:
551 case FRAMETYPE_INTER
:
552 ctx
->buf_switch
^= 1;
553 ctx
->dst_buf
= ctx
->buf_switch
;
554 ctx
->ref_buf
= ctx
->buf_switch
^ 1;
556 case FRAMETYPE_INTER_SCAL
:
557 if (!ctx
->inter_scal
) {
561 FFSWAP(int, ctx
->dst_buf
, ctx
->ref2_buf
);
562 ctx
->ref_buf
= ctx
->ref2_buf
;
564 case FRAMETYPE_INTER_NOREF
:
568 switch (ctx
->frame_type
) {
569 case FRAMETYPE_INTRA
:
572 case FRAMETYPE_INTER
:
574 ctx
->dst_buf
= ctx
->buf_switch
;
575 ctx
->ref_buf
= ctx
->buf_switch
^ 1;
577 case FRAMETYPE_INTER_SCAL
:
578 case FRAMETYPE_INTER_NOREF
:
585 static int is_nonnull_frame(IVI45DecContext
*ctx
)
587 return ctx
->frame_type
!= FRAMETYPE_NULL
;
592 * Initialize Indeo5 decoder.
594 static av_cold
int decode_init(AVCodecContext
*avctx
)
596 IVI45DecContext
*ctx
= avctx
->priv_data
;
599 ff_ivi_init_static_vlc();
601 /* copy rvmap tables in our context so we can apply changes to them */
602 memcpy(ctx
->rvmap_tabs
, ff_ivi_rvmap_tabs
, sizeof(ff_ivi_rvmap_tabs
));
604 /* set the initial picture layout according to the basic profile:
605 there is only one band per plane (no scalability), only one tile (no local decoding)
606 and picture format = YVU9 */
607 ctx
->pic_conf
.pic_width
= avctx
->width
;
608 ctx
->pic_conf
.pic_height
= avctx
->height
;
609 ctx
->pic_conf
.chroma_width
= (avctx
->width
+ 3) >> 2;
610 ctx
->pic_conf
.chroma_height
= (avctx
->height
+ 3) >> 2;
611 ctx
->pic_conf
.tile_width
= avctx
->width
;
612 ctx
->pic_conf
.tile_height
= avctx
->height
;
613 ctx
->pic_conf
.luma_bands
= ctx
->pic_conf
.chroma_bands
= 1;
615 result
= ff_ivi_init_planes(ctx
->planes
, &ctx
->pic_conf
);
617 av_log(avctx
, AV_LOG_ERROR
, "Couldn't allocate color planes!\n");
624 ctx
->decode_pic_hdr
= decode_pic_hdr
;
625 ctx
->decode_band_hdr
= decode_band_hdr
;
626 ctx
->decode_mb_info
= decode_mb_info
;
627 ctx
->switch_buffers
= switch_buffers
;
628 ctx
->is_nonnull_frame
= is_nonnull_frame
;
630 avctx
->pix_fmt
= AV_PIX_FMT_YUV410P
;
636 AVCodec ff_indeo5_decoder
= {
638 .type
= AVMEDIA_TYPE_VIDEO
,
639 .id
= AV_CODEC_ID_INDEO5
,
640 .priv_data_size
= sizeof(IVI45DecContext
),
642 .close
= ff_ivi_decode_close
,
643 .decode
= ff_ivi_decode_frame
,
644 .long_name
= NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 5"),
645 .capabilities
= CODEC_CAP_DR1
,