3 * Copyright (c) 2001 Fabrice Bellard
4 * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
6 * This file is part of Libav.
8 * Libav is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * Libav is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with Libav; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 #include "libavutil/cpu.h"
30 #include "error_resilience.h"
33 #include "h263_parser.h"
36 #include "mpeg4video.h"
37 #include "mpeg4video_parser.h"
38 #include "mpegutils.h"
39 #include "mpegvideo.h"
45 static enum AVPixelFormat h263_get_format(AVCodecContext *avctx)
47 if (avctx->codec->id == AV_CODEC_ID_MSS2)
48 return AV_PIX_FMT_YUV420P;
50 return avctx->pix_fmt = ff_get_format(avctx, avctx->codec->pix_fmts);
53 av_cold int ff_h263_decode_init(AVCodecContext *avctx)
55 MpegEncContext *s = avctx->priv_data;
59 s->out_format = FMT_H263;
60 s->width = avctx->coded_width;
61 s->height = avctx->coded_height;
62 s->workaround_bugs = avctx->workaround_bugs;
65 ff_mpv_decode_defaults(s);
66 s->quant_precision = 5;
67 s->decode_mb = ff_h263_decode_mb;
69 s->unrestricted_mv = 1;
71 /* select sub codec */
72 switch (avctx->codec->id) {
73 case AV_CODEC_ID_H263:
74 s->unrestricted_mv = 0;
75 avctx->chroma_sample_location = AVCHROMA_LOC_CENTER;
77 case AV_CODEC_ID_MPEG4:
79 case AV_CODEC_ID_MSMPEG4V1:
81 s->msmpeg4_version = 1;
83 case AV_CODEC_ID_MSMPEG4V2:
85 s->msmpeg4_version = 2;
87 case AV_CODEC_ID_MSMPEG4V3:
89 s->msmpeg4_version = 3;
91 case AV_CODEC_ID_WMV1:
93 s->msmpeg4_version = 4;
95 case AV_CODEC_ID_WMV2:
97 s->msmpeg4_version = 5;
100 case AV_CODEC_ID_WMV3:
101 case AV_CODEC_ID_VC1IMAGE:
102 case AV_CODEC_ID_WMV3IMAGE:
103 case AV_CODEC_ID_MSS2:
105 s->msmpeg4_version = 6;
106 avctx->chroma_sample_location = AVCHROMA_LOC_LEFT;
108 case AV_CODEC_ID_H263I:
110 case AV_CODEC_ID_FLV1:
114 av_log(avctx, AV_LOG_ERROR, "Unsupported codec %d\n",
116 return AVERROR(ENOSYS);
118 s->codec_id = avctx->codec->id;
120 /* for H.263, we allocate the images after having read the header */
121 if (avctx->codec->id != AV_CODEC_ID_H263 &&
122 avctx->codec->id != AV_CODEC_ID_MPEG4) {
123 avctx->pix_fmt = h263_get_format(avctx);
125 if ((ret = ff_mpv_common_init(s)) < 0)
129 ff_h263dsp_init(&s->h263dsp);
130 ff_qpeldsp_init(&s->qdsp);
131 ff_h263_decode_init_vlc();
136 av_cold int ff_h263_decode_end(AVCodecContext *avctx)
138 MpegEncContext *s = avctx->priv_data;
140 ff_mpv_common_end(s);
145 * Return the number of bytes consumed for building the current frame.
147 static int get_consumed_bytes(MpegEncContext *s, int buf_size)
149 int pos = (get_bits_count(&s->gb) + 7) >> 3;
151 if (s->divx_packed || s->avctx->hwaccel) {
152 /* We would have to scan through the whole buf to handle the weird
155 } else if (s->avctx->flags & AV_CODEC_FLAG_TRUNCATED) {
156 pos -= s->parse_context.last_index;
157 // padding is not really read so this might be -1
162 // avoid infinite loops (maybe not needed...)
166 if (pos + 10 > buf_size)
173 static int decode_slice(MpegEncContext *s)
175 const int part_mask = s->partitioned_frame
176 ? (ER_AC_END | ER_AC_ERROR) : 0x7F;
177 const int mb_size = 16;
180 s->last_resync_gb = s->gb;
181 s->first_slice_line = 1;
182 s->resync_mb_x = s->mb_x;
183 s->resync_mb_y = s->mb_y;
185 ff_set_qscale(s, s->qscale);
187 if (s->avctx->hwaccel) {
188 const uint8_t *start = s->gb.buffer + get_bits_count(&s->gb) / 8;
189 const uint8_t *end = ff_h263_find_resync_marker(start + 1,
191 skip_bits_long(&s->gb, 8 * (end - start));
192 return s->avctx->hwaccel->decode_slice(s->avctx, start, end - start);
195 if (s->partitioned_frame) {
196 const int qscale = s->qscale;
198 if (CONFIG_MPEG4_DECODER && s->codec_id == AV_CODEC_ID_MPEG4)
199 if ((ret = ff_mpeg4_decode_partitions(s->avctx->priv_data)) < 0)
202 /* restore variables which were modified */
203 s->first_slice_line = 1;
204 s->mb_x = s->resync_mb_x;
205 s->mb_y = s->resync_mb_y;
206 ff_set_qscale(s, qscale);
209 for (; s->mb_y < s->mb_height; s->mb_y++) {
210 /* per-row end of slice checks */
211 if (s->msmpeg4_version) {
212 if (s->resync_mb_y + s->slice_height == s->mb_y) {
213 ff_er_add_slice(&s->er, s->resync_mb_x, s->resync_mb_y,
214 s->mb_x - 1, s->mb_y, ER_MB_END);
220 if (s->msmpeg4_version == 1) {
226 ff_init_block_index(s);
227 for (; s->mb_x < s->mb_width; s->mb_x++) {
230 ff_update_block_index(s);
232 if (s->resync_mb_x == s->mb_x && s->resync_mb_y + 1 == s->mb_y)
233 s->first_slice_line = 0;
237 s->mv_dir = MV_DIR_FORWARD;
238 s->mv_type = MV_TYPE_16X16;
239 ff_dlog(s, "%d %06X\n",
240 get_bits_count(&s->gb), show_bits(&s->gb, 24));
241 ret = s->decode_mb(s, s->block);
243 if (s->pict_type != AV_PICTURE_TYPE_B)
244 ff_h263_update_motion_val(s);
247 const int xy = s->mb_x + s->mb_y * s->mb_stride;
248 if (ret == SLICE_END) {
249 ff_mpv_decode_mb(s, s->block);
251 ff_h263_loop_filter(s);
253 ff_er_add_slice(&s->er, s->resync_mb_x, s->resync_mb_y,
254 s->mb_x, s->mb_y, ER_MB_END & part_mask);
256 s->padding_bug_score--;
258 if (++s->mb_x >= s->mb_width) {
260 ff_mpeg_draw_horiz_band(s, s->mb_y * mb_size, mb_size);
261 ff_mpv_report_decode_progress(s);
265 } else if (ret == SLICE_NOEND) {
266 av_log(s->avctx, AV_LOG_ERROR,
267 "Slice mismatch at MB: %d\n", xy);
268 ff_er_add_slice(&s->er, s->resync_mb_x, s->resync_mb_y,
269 s->mb_x + 1, s->mb_y,
270 ER_MB_END & part_mask);
271 return AVERROR_INVALIDDATA;
273 av_log(s->avctx, AV_LOG_ERROR, "Error at MB: %d\n", xy);
274 ff_er_add_slice(&s->er, s->resync_mb_x, s->resync_mb_y,
275 s->mb_x, s->mb_y, ER_MB_ERROR & part_mask);
277 return AVERROR_INVALIDDATA;
280 ff_mpv_decode_mb(s, s->block);
282 ff_h263_loop_filter(s);
285 ff_mpeg_draw_horiz_band(s, s->mb_y * mb_size, mb_size);
286 ff_mpv_report_decode_progress(s);
291 assert(s->mb_x == 0 && s->mb_y == s->mb_height);
293 if (s->codec_id == AV_CODEC_ID_MPEG4 &&
294 (s->workaround_bugs & FF_BUG_AUTODETECT) &&
295 get_bits_left(&s->gb) >= 48 &&
296 show_bits(&s->gb, 24) == 0x4010 &&
297 !s->data_partitioning)
298 s->padding_bug_score += 32;
300 /* try to detect the padding bug */
301 if (s->codec_id == AV_CODEC_ID_MPEG4 &&
302 (s->workaround_bugs & FF_BUG_AUTODETECT) &&
303 get_bits_left(&s->gb) >= 0 &&
304 get_bits_left(&s->gb) < 48 &&
305 !s->data_partitioning) {
306 const int bits_count = get_bits_count(&s->gb);
307 const int bits_left = s->gb.size_in_bits - bits_count;
309 if (bits_left == 0) {
310 s->padding_bug_score += 16;
311 } else if (bits_left != 1) {
312 int v = show_bits(&s->gb, 8);
313 v |= 0x7F >> (7 - (bits_count & 7));
315 if (v == 0x7F && bits_left <= 8)
316 s->padding_bug_score--;
317 else if (v == 0x7F && ((get_bits_count(&s->gb) + 8) & 8) &&
319 s->padding_bug_score += 4;
321 s->padding_bug_score++;
325 if (s->workaround_bugs & FF_BUG_AUTODETECT) {
326 if (s->codec_id == AV_CODEC_ID_H263 ||
327 (s->padding_bug_score > -2 && !s->data_partitioning))
328 s->workaround_bugs |= FF_BUG_NO_PADDING;
330 s->workaround_bugs &= ~FF_BUG_NO_PADDING;
333 // handle formats which don't have unique end markers
334 if (s->msmpeg4_version || (s->workaround_bugs & FF_BUG_NO_PADDING)) { // FIXME perhaps solve this more cleanly
335 int left = get_bits_left(&s->gb);
338 /* no markers in M$ crap */
339 if (s->msmpeg4_version && s->pict_type == AV_PICTURE_TYPE_I)
342 /* buggy padding but the frame should still end approximately at
343 * the bitstream end */
344 if ((s->workaround_bugs & FF_BUG_NO_PADDING) &&
345 (s->avctx->err_recognition & AV_EF_BUFFER))
347 else if ((s->workaround_bugs & FF_BUG_NO_PADDING))
348 max_extra += 256 * 256 * 256 * 64;
350 if (left > max_extra)
351 av_log(s->avctx, AV_LOG_ERROR,
352 "discarding %d junk bits at end, next would be %X\n",
353 left, show_bits(&s->gb, 24));
355 av_log(s->avctx, AV_LOG_ERROR, "overreading %d bits\n", -left);
357 ff_er_add_slice(&s->er, s->resync_mb_x, s->resync_mb_y,
358 s->mb_x - 1, s->mb_y, ER_MB_END);
363 av_log(s->avctx, AV_LOG_ERROR,
364 "slice end not reached but screenspace end (%d left %06X, score= %d)\n",
365 get_bits_left(&s->gb), show_bits(&s->gb, 24), s->padding_bug_score);
367 ff_er_add_slice(&s->er, s->resync_mb_x, s->resync_mb_y, s->mb_x, s->mb_y,
368 ER_MB_END & part_mask);
370 return AVERROR_INVALIDDATA;
373 int ff_h263_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
376 const uint8_t *buf = avpkt->data;
377 int buf_size = avpkt->size;
378 MpegEncContext *s = avctx->priv_data;
380 AVFrame *pict = data;
382 /* no supplementary picture */
384 /* special case for last picture */
385 if (s->low_delay == 0 && s->next_picture_ptr) {
386 if ((ret = av_frame_ref(pict, s->next_picture_ptr->f)) < 0)
388 s->next_picture_ptr = NULL;
396 if (s->avctx->flags & AV_CODEC_FLAG_TRUNCATED) {
399 if (CONFIG_MPEG4_DECODER && s->codec_id == AV_CODEC_ID_MPEG4) {
400 next = ff_mpeg4_find_frame_end(&s->parse_context, buf, buf_size);
401 } else if (CONFIG_H263_DECODER && s->codec_id == AV_CODEC_ID_H263) {
402 next = ff_h263_find_frame_end(&s->parse_context, buf, buf_size);
404 av_log(s->avctx, AV_LOG_ERROR,
405 "this codec does not support truncated bitstreams\n");
406 return AVERROR(ENOSYS);
409 if (ff_combine_frame(&s->parse_context, next, (const uint8_t **)&buf,
414 if (s->bitstream_buffer_size && (s->divx_packed || buf_size < 20)) // divx 5.01+/xvid frame reorder
415 ret = init_get_bits8(&s->gb, s->bitstream_buffer,
416 s->bitstream_buffer_size);
418 ret = init_get_bits8(&s->gb, buf, buf_size);
419 s->bitstream_buffer_size = 0;
424 if (!s->context_initialized)
425 // we need the idct permutation for reading a custom matrix
429 if (CONFIG_WMV2_DECODER && s->msmpeg4_version == 5) {
430 ret = ff_wmv2_decode_picture_header(s);
431 } else if (CONFIG_MSMPEG4_DECODER && s->msmpeg4_version) {
432 ret = ff_msmpeg4_decode_picture_header(s);
433 } else if (CONFIG_MPEG4_DECODER && avctx->codec_id == AV_CODEC_ID_MPEG4) {
434 if (s->avctx->extradata_size && s->picture_number == 0) {
437 ret = init_get_bits8(&gb, s->avctx->extradata,
438 s->avctx->extradata_size);
441 ff_mpeg4_decode_picture_header(avctx->priv_data, &gb);
443 ret = ff_mpeg4_decode_picture_header(avctx->priv_data, &s->gb);
444 } else if (CONFIG_H263I_DECODER && s->codec_id == AV_CODEC_ID_H263I) {
445 ret = ff_intel_h263_decode_picture_header(s);
446 } else if (CONFIG_FLV_DECODER && s->h263_flv) {
447 ret = ff_flv_decode_picture_header(s);
449 ret = ff_h263_decode_picture_header(s);
452 if (ret == FRAME_SKIPPED)
453 return get_consumed_bytes(s, buf_size);
455 /* skip if the header was thrashed */
457 av_log(s->avctx, AV_LOG_ERROR, "header damaged\n");
461 if (!s->context_initialized) {
462 avctx->pix_fmt = h263_get_format(avctx);
463 if ((ret = ff_mpv_common_init(s)) < 0)
467 if (!s->current_picture_ptr || s->current_picture_ptr->f->data[0]) {
468 int i = ff_find_unused_picture(s->avctx, s->picture, 0);
471 s->current_picture_ptr = &s->picture[i];
474 avctx->has_b_frames = !s->low_delay;
476 #define SET_QPEL_FUNC(postfix1, postfix2) \
477 s->qdsp.put_ ## postfix1 = ff_put_ ## postfix2; \
478 s->qdsp.put_no_rnd_ ## postfix1 = ff_put_no_rnd_ ## postfix2; \
479 s->qdsp.avg_ ## postfix1 = ff_avg_ ## postfix2;
481 if (s->workaround_bugs & FF_BUG_STD_QPEL) {
482 SET_QPEL_FUNC(qpel_pixels_tab[0][5], qpel16_mc11_old_c)
483 SET_QPEL_FUNC(qpel_pixels_tab[0][7], qpel16_mc31_old_c)
484 SET_QPEL_FUNC(qpel_pixels_tab[0][9], qpel16_mc12_old_c)
485 SET_QPEL_FUNC(qpel_pixels_tab[0][11], qpel16_mc32_old_c)
486 SET_QPEL_FUNC(qpel_pixels_tab[0][13], qpel16_mc13_old_c)
487 SET_QPEL_FUNC(qpel_pixels_tab[0][15], qpel16_mc33_old_c)
489 SET_QPEL_FUNC(qpel_pixels_tab[1][5], qpel8_mc11_old_c)
490 SET_QPEL_FUNC(qpel_pixels_tab[1][7], qpel8_mc31_old_c)
491 SET_QPEL_FUNC(qpel_pixels_tab[1][9], qpel8_mc12_old_c)
492 SET_QPEL_FUNC(qpel_pixels_tab[1][11], qpel8_mc32_old_c)
493 SET_QPEL_FUNC(qpel_pixels_tab[1][13], qpel8_mc13_old_c)
494 SET_QPEL_FUNC(qpel_pixels_tab[1][15], qpel8_mc33_old_c)
497 /* After H.263 & MPEG-4 header decode we have the height, width,
498 * and other parameters. So then we could init the picture.
499 * FIXME: By the way H.263 decoder is evolving it should have
500 * an H263EncContext */
501 if (s->width != avctx->coded_width ||
502 s->height != avctx->coded_height ||
504 /* H.263 could change picture size any time */
505 s->context_reinit = 0;
507 ret = ff_set_dimensions(avctx, s->width, s->height);
511 ff_set_sar(avctx, avctx->sample_aspect_ratio);
513 if ((ret = ff_mpv_common_frame_size_change(s)))
516 if (avctx->pix_fmt != h263_get_format(avctx)) {
517 av_log(avctx, AV_LOG_ERROR, "format change not supported\n");
518 avctx->pix_fmt = AV_PIX_FMT_NONE;
519 return AVERROR_UNKNOWN;
523 if (s->codec_id == AV_CODEC_ID_H263 ||
524 s->codec_id == AV_CODEC_ID_H263P ||
525 s->codec_id == AV_CODEC_ID_H263I)
526 s->gob_index = H263_GOB_HEIGHT(s->height);
528 // for skipping the frame
529 s->current_picture.f->pict_type = s->pict_type;
530 s->current_picture.f->key_frame = s->pict_type == AV_PICTURE_TYPE_I;
532 /* skip B-frames if we don't have reference frames */
533 if (!s->last_picture_ptr &&
534 (s->pict_type == AV_PICTURE_TYPE_B || s->droppable))
535 return get_consumed_bytes(s, buf_size);
536 if ((avctx->skip_frame >= AVDISCARD_NONREF &&
537 s->pict_type == AV_PICTURE_TYPE_B) ||
538 (avctx->skip_frame >= AVDISCARD_NONKEY &&
539 s->pict_type != AV_PICTURE_TYPE_I) ||
540 avctx->skip_frame >= AVDISCARD_ALL)
541 return get_consumed_bytes(s, buf_size);
543 if (s->next_p_frame_damaged) {
544 if (s->pict_type == AV_PICTURE_TYPE_B)
545 return get_consumed_bytes(s, buf_size);
547 s->next_p_frame_damaged = 0;
550 if ((!s->no_rounding) || s->pict_type == AV_PICTURE_TYPE_B) {
551 s->me.qpel_put = s->qdsp.put_qpel_pixels_tab;
552 s->me.qpel_avg = s->qdsp.avg_qpel_pixels_tab;
554 s->me.qpel_put = s->qdsp.put_no_rnd_qpel_pixels_tab;
555 s->me.qpel_avg = s->qdsp.avg_qpel_pixels_tab;
558 if ((ret = ff_mpv_frame_start(s, avctx)) < 0)
562 ff_thread_finish_setup(avctx);
564 if (avctx->hwaccel) {
565 ret = avctx->hwaccel->start_frame(avctx, s->gb.buffer,
566 s->gb.buffer_end - s->gb.buffer);
571 ff_mpeg_er_frame_start(s);
573 /* the second part of the wmv2 header contains the MB skip bits which
574 * are stored in current_picture->mb_type which is not available before
575 * ff_mpv_frame_start() */
576 if (CONFIG_WMV2_DECODER && s->msmpeg4_version == 5) {
577 ret = ff_wmv2_decode_secondary_picture_header(s);
581 goto intrax8_decoded;
584 /* decode each macroblock */
588 ret = decode_slice(s);
589 while (s->mb_y < s->mb_height) {
590 if (s->msmpeg4_version) {
591 if (s->slice_height == 0 || s->mb_x != 0 ||
592 (s->mb_y % s->slice_height) != 0 || get_bits_left(&s->gb) < 0)
595 int prev_x = s->mb_x, prev_y = s->mb_y;
596 if (ff_h263_resync(s) < 0)
598 if (prev_y * s->mb_width + prev_x < s->mb_y * s->mb_width + s->mb_x)
599 s->er.error_occurred = 1;
602 if (s->msmpeg4_version < 4 && s->h263_pred)
603 ff_mpeg4_clean_buffers(s);
605 if (decode_slice(s) < 0)
606 ret = AVERROR_INVALIDDATA;
609 if (s->msmpeg4_version && s->msmpeg4_version < 4 &&
610 s->pict_type == AV_PICTURE_TYPE_I)
611 if (!CONFIG_MSMPEG4_DECODER ||
612 ff_msmpeg4_decode_ext_header(s, buf_size) < 0)
613 s->er.error_status_table[s->mb_num - 1] = ER_MB_ERROR;
615 assert(s->bitstream_buffer_size == 0);
617 if (CONFIG_MPEG4_DECODER && avctx->codec_id == AV_CODEC_ID_MPEG4)
618 ff_mpeg4_frame_end(avctx, buf, buf_size);
621 ff_er_frame_end(&s->er);
623 if (avctx->hwaccel) {
624 ret = avctx->hwaccel->end_frame(avctx);
631 if (!s->divx_packed && avctx->hwaccel)
632 ff_thread_finish_setup(avctx);
634 assert(s->current_picture.f->pict_type ==
635 s->current_picture_ptr->f->pict_type);
636 assert(s->current_picture.f->pict_type == s->pict_type);
637 if (s->pict_type == AV_PICTURE_TYPE_B || s->low_delay) {
638 if ((ret = av_frame_ref(pict, s->current_picture_ptr->f)) < 0)
640 ff_print_debug_info(s, s->current_picture_ptr);
641 } else if (s->last_picture_ptr) {
642 if ((ret = av_frame_ref(pict, s->last_picture_ptr->f)) < 0)
644 ff_print_debug_info(s, s->last_picture_ptr);
647 if (s->last_picture_ptr || s->low_delay)
650 if (ret && (avctx->err_recognition & AV_EF_EXPLODE))
653 return get_consumed_bytes(s, buf_size);
656 const enum AVPixelFormat ff_h263_hwaccel_pixfmt_list_420[] = {
657 #if CONFIG_H263_VAAPI_HWACCEL || CONFIG_MPEG4_VAAPI_HWACCEL
660 #if CONFIG_MPEG4_VDPAU_HWACCEL
667 AVCodec ff_h263_decoder = {
669 .long_name = NULL_IF_CONFIG_SMALL("H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2"),
670 .type = AVMEDIA_TYPE_VIDEO,
671 .id = AV_CODEC_ID_H263,
672 .priv_data_size = sizeof(MpegEncContext),
673 .init = ff_h263_decode_init,
674 .close = ff_h263_decode_end,
675 .decode = ff_h263_decode_frame,
676 .capabilities = AV_CODEC_CAP_DRAW_HORIZ_BAND | AV_CODEC_CAP_DR1 |
677 AV_CODEC_CAP_TRUNCATED | AV_CODEC_CAP_DELAY,
678 .flush = ff_mpeg_flush,
679 .pix_fmts = ff_h263_hwaccel_pixfmt_list_420,