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
35 #include "ivi_common.h"
36 #include "indeo4data.h"
39 * Indeo 4 frame types.
43 FRAMETYPE_INTRA1 = 1, ///< intra frame with slightly different bitstream coding
44 FRAMETYPE_INTER = 2, ///< non-droppable P-frame
45 FRAMETYPE_BIDIR = 3, ///< bidirectional frame
46 FRAMETYPE_INTER_NOREF = 4, ///< droppable P-frame
47 FRAMETYPE_NULL_FIRST = 5, ///< empty frame with no data
48 FRAMETYPE_NULL_LAST = 6 ///< empty frame with no data
51 #define IVI4_PIC_SIZE_ESC 7
55 InvTransformPtr *inv_trans;
56 DCTransformPtr *dc_trans;
59 { ff_ivi_inverse_haar_8x8, ff_ivi_dc_haar_2d, 1 },
60 { NULL, NULL, 0 }, /* inverse Haar 8x1 */
61 { NULL, NULL, 0 }, /* inverse Haar 1x8 */
62 { ff_ivi_put_pixels_8x8, ff_ivi_put_dc_pixel_8x8, 1 },
63 { ff_ivi_inverse_slant_8x8, ff_ivi_dc_slant_2d, 1 },
64 { ff_ivi_row_slant8, ff_ivi_dc_row_slant, 1 },
65 { ff_ivi_col_slant8, ff_ivi_dc_col_slant, 1 },
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 */
70 { ff_ivi_inverse_slant_4x4, ff_ivi_dc_slant_2d, 1 },
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 */
80 * Decode subdivision of a plane.
81 * This is a simplified version that checks for two supported subdivisions:
82 * - 1 wavelet band per plane, size factor 1:1, code pattern: 3
83 * - 4 wavelet bands per plane, size factor 1:4, code pattern: 2,3,3,3,3
84 * Anything else is either unsupported or corrupt.
86 * @param[in,out] gb the GetBit context
87 * @return number of wavelet bands or 0 on error
89 static int decode_plane_subdivision(GetBitContext *gb)
93 switch (get_bits(gb, 2)) {
97 for (i = 0; i < 4; i++)
98 if (get_bits(gb, 2) != 3)
106 static inline int scale_tile_size(int def_size, int size_factor)
108 return size_factor == 15 ? def_size : (size_factor + 1) << 5;
112 * Decode Indeo 4 picture header.
114 * @param[in,out] ctx pointer to the decoder context
115 * @param[in] avctx pointer to the AVCodecContext
116 * @return result code: 0 = OK, negative number = error
118 static int decode_pic_hdr(IVI45DecContext *ctx, AVCodecContext *avctx)
120 int pic_size_indx, i, p;
121 IVIPicConfig pic_conf;
123 if (get_bits(&ctx->gb, 18) != 0x3FFF8) {
124 av_log(avctx, AV_LOG_ERROR, "Invalid picture start code!\n");
125 return AVERROR_INVALIDDATA;
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;
135 #if IVI4_STREAM_ANALYSER
136 if (ctx->frame_type == FRAMETYPE_BIDIR)
137 ctx->has_b_frames = 1;
140 ctx->transp_status = get_bits1(&ctx->gb);
141 #if IVI4_STREAM_ANALYSER
142 if (ctx->transp_status) {
147 /* unknown bit: Mac decoder ignores this bit, XANIM returns error */
148 if (get_bits1(&ctx->gb)) {
149 av_log(avctx, AV_LOG_ERROR, "Sync bit is set!\n");
150 return AVERROR_INVALIDDATA;
153 ctx->data_size = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 24) : 0;
155 /* null frames don't contain anything else so we just return */
156 if (ctx->frame_type >= FRAMETYPE_NULL_FIRST) {
157 av_dlog(avctx, "Null frame encountered!\n");
161 /* Check key lock status. If enabled - ignore lock word. */
162 /* Usually we have to prompt the user for the password, but */
163 /* we don't do that because Indeo 4 videos can be decoded anyway */
164 if (get_bits1(&ctx->gb)) {
165 skip_bits_long(&ctx->gb, 32);
166 av_dlog(avctx, "Password-protected clip!\n");
169 pic_size_indx = get_bits(&ctx->gb, 3);
170 if (pic_size_indx == IVI4_PIC_SIZE_ESC) {
171 pic_conf.pic_height = get_bits(&ctx->gb, 16);
172 pic_conf.pic_width = get_bits(&ctx->gb, 16);
174 pic_conf.pic_height = ivi4_common_pic_sizes[pic_size_indx * 2 + 1];
175 pic_conf.pic_width = ivi4_common_pic_sizes[pic_size_indx * 2 ];
178 /* Decode tile dimensions. */
179 if (get_bits1(&ctx->gb)) {
180 pic_conf.tile_height = scale_tile_size(pic_conf.pic_height, get_bits(&ctx->gb, 4));
181 pic_conf.tile_width = scale_tile_size(pic_conf.pic_width, get_bits(&ctx->gb, 4));
182 #if IVI4_STREAM_ANALYSER
183 ctx->uses_tiling = 1;
186 pic_conf.tile_height = pic_conf.pic_height;
187 pic_conf.tile_width = pic_conf.pic_width;
190 /* Decode chroma subsampling. We support only 4:4 aka YVU9. */
191 if (get_bits(&ctx->gb, 2)) {
192 av_log(avctx, AV_LOG_ERROR, "Only YVU9 picture format is supported!\n");
193 return AVERROR_INVALIDDATA;
195 pic_conf.chroma_height = (pic_conf.pic_height + 3) >> 2;
196 pic_conf.chroma_width = (pic_conf.pic_width + 3) >> 2;
198 /* decode subdivision of the planes */
199 pic_conf.luma_bands = decode_plane_subdivision(&ctx->gb);
200 if (pic_conf.luma_bands)
201 pic_conf.chroma_bands = decode_plane_subdivision(&ctx->gb);
202 ctx->is_scalable = pic_conf.luma_bands != 1 || pic_conf.chroma_bands != 1;
203 if (ctx->is_scalable && (pic_conf.luma_bands != 4 || pic_conf.chroma_bands != 1)) {
204 av_log(avctx, AV_LOG_ERROR, "Scalability: unsupported subdivision! Luma bands: %d, chroma bands: %d\n",
205 pic_conf.luma_bands, pic_conf.chroma_bands);
206 return AVERROR_INVALIDDATA;
209 /* check if picture layout was changed and reallocate buffers */
210 if (ivi_pic_config_cmp(&pic_conf, &ctx->pic_conf)) {
211 if (ff_ivi_init_planes(ctx->planes, &pic_conf)) {
212 av_log(avctx, AV_LOG_ERROR, "Couldn't reallocate color planes!\n");
213 return AVERROR(ENOMEM);
216 ctx->pic_conf = pic_conf;
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;
226 if (ff_ivi_init_tiles(ctx->planes, ctx->pic_conf.tile_width,
227 ctx->pic_conf.tile_height)) {
228 av_log(avctx, AV_LOG_ERROR,
229 "Couldn't reallocate internal structures!\n");
230 return AVERROR(ENOMEM);
234 ctx->frame_num = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 20) : 0;
236 /* skip decTimeEst field if present */
237 if (get_bits1(&ctx->gb))
238 skip_bits(&ctx->gb, 8);
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;
245 ctx->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
247 ctx->in_imf = get_bits1(&ctx->gb);
248 ctx->in_q = get_bits1(&ctx->gb);
250 ctx->pic_glob_quant = get_bits(&ctx->gb, 5);
252 /* TODO: ignore this parameter if unused */
253 ctx->unknown1 = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 0;
255 ctx->checksum = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 16) : 0;
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);
263 if (get_bits1(&ctx->gb)) {
264 av_log(avctx, AV_LOG_ERROR, "Bad blocks bits encountered!\n");
267 align_get_bits(&ctx->gb);
274 * Decode Indeo 4 band header.
276 * @param[in,out] ctx pointer to the decoder context
277 * @param[in,out] band pointer to the band descriptor
278 * @param[in] avctx pointer to the AVCodecContext
279 * @return result code: 0 = OK, negative number = error
281 static int decode_band_hdr(IVI45DecContext *ctx, IVIBandDesc *band,
282 AVCodecContext *avctx)
284 int plane, band_num, indx, transform_id, scan_indx;
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;
294 band->is_empty = get_bits1(&ctx->gb);
295 if (!band->is_empty) {
297 * If header size is not given, header size is 4 bytes. */
298 if (get_bits1(&ctx->gb))
299 skip_bits(&ctx->gb, 16);
301 band->is_halfpel = get_bits(&ctx->gb, 2);
302 if (band->is_halfpel >= 2) {
303 av_log(avctx, AV_LOG_ERROR, "Invalid/unsupported mv resolution: %d!\n",
305 return AVERROR_INVALIDDATA;
307 #if IVI4_STREAM_ANALYSER
308 if (!band->is_halfpel)
309 ctx->uses_fullpel = 1;
312 band->checksum_present = get_bits1(&ctx->gb);
313 if (band->checksum_present)
314 band->checksum = get_bits(&ctx->gb, 16);
316 indx = get_bits(&ctx->gb, 2);
318 av_log(avctx, AV_LOG_ERROR, "Invalid block size!\n");
319 return AVERROR_INVALIDDATA;
321 band->mb_size = 16 >> indx;
322 band->blk_size = 8 >> (indx >> 1);
324 band->inherit_mv = get_bits1(&ctx->gb);
325 band->inherit_qdelta = get_bits1(&ctx->gb);
327 band->glob_quant = get_bits(&ctx->gb, 5);
329 if (!get_bits1(&ctx->gb) || ctx->frame_type == FRAMETYPE_INTRA) {
330 transform_id = get_bits(&ctx->gb, 5);
331 if (transform_id >= FF_ARRAY_ELEMS(transforms) ||
332 !transforms[transform_id].inv_trans) {
333 av_log_ask_for_sample(avctx, "Unimplemented transform: %d!\n", transform_id);
334 return AVERROR_PATCHWELCOME;
336 if ((transform_id >= 7 && transform_id <= 9) ||
337 transform_id == 17) {
338 av_log_ask_for_sample(avctx, "DCT transform not supported yet!\n");
339 return AVERROR_PATCHWELCOME;
342 #if IVI4_STREAM_ANALYSER
343 if ((transform_id >= 0 && transform_id <= 2) || transform_id == 10)
347 band->inv_transform = transforms[transform_id].inv_trans;
348 band->dc_transform = transforms[transform_id].dc_trans;
349 band->is_2d_trans = transforms[transform_id].is_2d_trans;
351 scan_indx = get_bits(&ctx->gb, 4);
352 if (scan_indx == 15) {
353 av_log(avctx, AV_LOG_ERROR, "Custom scan pattern encountered!\n");
354 return AVERROR_INVALIDDATA;
356 band->scan = scan_index_to_tab[scan_indx];
358 band->quant_mat = get_bits(&ctx->gb, 5);
359 if (band->quant_mat == 31) {
360 av_log(avctx, AV_LOG_ERROR, "Custom quant matrix encountered!\n");
361 return AVERROR_INVALIDDATA;
365 /* decode block huffman codebook */
366 if (ff_ivi_dec_huff_desc(&ctx->gb, get_bits1(&ctx->gb), IVI_BLK_HUFF,
367 &band->blk_vlc, avctx))
368 return AVERROR_INVALIDDATA;
370 /* select appropriate rvmap table for this band */
371 band->rvmap_sel = get_bits1(&ctx->gb) ? get_bits(&ctx->gb, 3) : 8;
373 /* decode rvmap probability corrections if any */
374 band->num_corr = 0; /* there is no corrections */
375 if (get_bits1(&ctx->gb)) {
376 band->num_corr = get_bits(&ctx->gb, 8); /* get number of correction pairs */
377 if (band->num_corr > 61) {
378 av_log(avctx, AV_LOG_ERROR, "Too many corrections: %d\n",
380 return AVERROR_INVALIDDATA;
383 /* read correction pairs */
384 for (i = 0; i < band->num_corr * 2; i++)
385 band->corr[i] = get_bits(&ctx->gb, 8);
389 if (band->blk_size == 8) {
390 band->intra_base = &ivi4_quant_8x8_intra[quant_index_to_tab[band->quant_mat]][0];
391 band->inter_base = &ivi4_quant_8x8_inter[quant_index_to_tab[band->quant_mat]][0];
393 band->intra_base = &ivi4_quant_4x4_intra[quant_index_to_tab[band->quant_mat]][0];
394 band->inter_base = &ivi4_quant_4x4_inter[quant_index_to_tab[band->quant_mat]][0];
397 /* Indeo 4 doesn't use scale tables */
398 band->intra_scale = NULL;
399 band->inter_scale = NULL;
401 align_get_bits(&ctx->gb);
408 * Decode information (block type, cbp, quant delta, motion vector)
409 * for all macroblocks in the current tile.
411 * @param[in,out] ctx pointer to the decoder context
412 * @param[in,out] band pointer to the band descriptor
413 * @param[in,out] tile pointer to the tile descriptor
414 * @param[in] avctx pointer to the AVCodecContext
415 * @return result code: 0 = OK, negative number = 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, blks_per_mb,
421 mv_scale, mb_type_bits;
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;
429 blks_per_mb = band->mb_size != band->blk_size ? 4 : 1;
430 mb_type_bits = ctx->frame_type == FRAMETYPE_BIDIR ? 2 : 1;
432 /* scale factor for motion vectors */
433 mv_scale = (ctx->planes[0].bands[0].mb_size >> 3) - (band->mb_size >> 3);
436 for (y = tile->ypos; y < tile->ypos + tile->height; y += band->mb_size) {
439 for (x = tile->xpos; x < tile->xpos + tile->width; x += band->mb_size) {
442 mb->buf_offs = mb_offset;
444 if (get_bits1(&ctx->gb)) {
445 if (ctx->frame_type == FRAMETYPE_INTRA) {
446 av_log(avctx, AV_LOG_ERROR, "Empty macroblock in an INTRA picture!\n");
447 return AVERROR_INVALIDDATA;
449 mb->type = 1; /* empty macroblocks are always INTER */
450 mb->cbp = 0; /* all blocks are empty */
453 if (!band->plane && !band->band_num && ctx->in_q) {
454 mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
456 mb->q_delta = IVI_TOSIGNED(mb->q_delta);
459 mb->mv_x = mb->mv_y = 0; /* no motion vector coded */
460 if (band->inherit_mv) {
461 /* motion vector inheritance */
463 mb->mv_x = ivi_scale_mv(ref_mb->mv_x, mv_scale);
464 mb->mv_y = ivi_scale_mv(ref_mb->mv_y, mv_scale);
466 mb->mv_x = ref_mb->mv_x;
467 mb->mv_y = ref_mb->mv_y;
471 if (band->inherit_mv) {
472 mb->type = ref_mb->type; /* copy mb_type from corresponding reference mb */
473 } else if (ctx->frame_type == FRAMETYPE_INTRA ||
474 ctx->frame_type == FRAMETYPE_INTRA1) {
475 mb->type = 0; /* mb_type is always INTRA for intra-frames */
477 mb->type = get_bits(&ctx->gb, mb_type_bits);
480 mb->cbp = get_bits(&ctx->gb, blks_per_mb);
483 if (band->inherit_qdelta) {
484 if (ref_mb) mb->q_delta = ref_mb->q_delta;
485 } else if (mb->cbp || (!band->plane && !band->band_num &&
487 mb->q_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
489 mb->q_delta = IVI_TOSIGNED(mb->q_delta);
493 mb->mv_x = mb->mv_y = 0; /* there is no motion vector in intra-macroblocks */
495 if (band->inherit_mv) {
496 /* motion vector inheritance */
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);
501 mb->mv_x = ref_mb->mv_x;
502 mb->mv_y = ref_mb->mv_y;
505 /* decode motion vector deltas */
506 mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
508 mv_y += IVI_TOSIGNED(mv_delta);
509 mv_delta = get_vlc2(&ctx->gb, ctx->mb_vlc.tab->table,
511 mv_x += IVI_TOSIGNED(mv_delta);
521 mb_offset += band->mb_size;
527 align_get_bits(&ctx->gb);
534 * Rearrange decoding and reference buffers.
536 * @param[in,out] ctx pointer to the decoder context
538 static void switch_buffers(IVI45DecContext *ctx)
540 switch (ctx->prev_frame_type) {
541 case FRAMETYPE_INTRA:
542 case FRAMETYPE_INTRA1:
543 case FRAMETYPE_INTER:
544 ctx->buf_switch ^= 1;
545 ctx->dst_buf = ctx->buf_switch;
546 ctx->ref_buf = ctx->buf_switch ^ 1;
548 case FRAMETYPE_INTER_NOREF:
552 switch (ctx->frame_type) {
553 case FRAMETYPE_INTRA:
554 case FRAMETYPE_INTRA1:
557 case FRAMETYPE_INTER:
558 ctx->dst_buf = ctx->buf_switch;
559 ctx->ref_buf = ctx->buf_switch ^ 1;
561 case FRAMETYPE_INTER_NOREF:
562 case FRAMETYPE_NULL_FIRST:
563 case FRAMETYPE_NULL_LAST:
569 static int is_nonnull_frame(IVI45DecContext *ctx)
571 return ctx->frame_type < FRAMETYPE_NULL_FIRST;
575 static av_cold int decode_init(AVCodecContext *avctx)
577 IVI45DecContext *ctx = avctx->priv_data;
579 ff_ivi_init_static_vlc();
581 /* copy rvmap tables in our context so we can apply changes to them */
582 memcpy(ctx->rvmap_tabs, ff_ivi_rvmap_tabs, sizeof(ff_ivi_rvmap_tabs));
584 /* Force allocation of the internal buffers */
585 /* during picture header decoding. */
586 ctx->pic_conf.pic_width = 0;
587 ctx->pic_conf.pic_height = 0;
589 avctx->pix_fmt = AV_PIX_FMT_YUV410P;
591 ctx->decode_pic_hdr = decode_pic_hdr;
592 ctx->decode_band_hdr = decode_band_hdr;
593 ctx->decode_mb_info = decode_mb_info;
594 ctx->switch_buffers = switch_buffers;
595 ctx->is_nonnull_frame = is_nonnull_frame;
601 AVCodec ff_indeo4_decoder = {
603 .type = AVMEDIA_TYPE_VIDEO,
604 .id = AV_CODEC_ID_INDEO4,
605 .priv_data_size = sizeof(IVI45DecContext),
607 .close = ff_ivi_decode_close,
608 .decode = ff_ivi_decode_frame,
609 .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo Video Interactive 4"),
610 .capabilities = CODEC_CAP_DR1,