comparison h264.h @ 12024:fdafbcef52f5 libavcodec

Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 51abd780bda6
children 05f91a88f986
comparison
equal deleted inserted replaced
12023:c7455450364d 12024:fdafbcef52f5
618 * Decode PPS 618 * Decode PPS
619 */ 619 */
620 int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length); 620 int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length);
621 621
622 /** 622 /**
623 * Decodes a network abstraction layer unit. 623 * Decode a network abstraction layer unit.
624 * @param consumed is the number of bytes used as input 624 * @param consumed is the number of bytes used as input
625 * @param length is the length of the array 625 * @param length is the length of the array
626 * @param dst_length is the number of decoded bytes FIXME here or a decode rbsp tailing? 626 * @param dst_length is the number of decoded bytes FIXME here or a decode rbsp tailing?
627 * @return decoded bytes, might be src+1 if no escapes 627 * @return decoded bytes, might be src+1 if no escapes
628 */ 628 */
629 const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src, int *dst_length, int *consumed, int length); 629 const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src, int *dst_length, int *consumed, int length);
630 630
631 /** 631 /**
632 * identifies the exact end of the bitstream 632 * Identify the exact end of the bitstream
633 * @return the length of the trailing, or 0 if damaged 633 * @return the length of the trailing, or 0 if damaged
634 */ 634 */
635 int ff_h264_decode_rbsp_trailing(H264Context *h, const uint8_t *src); 635 int ff_h264_decode_rbsp_trailing(H264Context *h, const uint8_t *src);
636 636
637 /** 637 /**
638 * frees any data that may have been allocated in the H264 context like SPS, PPS etc. 638 * Free any data that may have been allocated in the H264 context like SPS, PPS etc.
639 */ 639 */
640 av_cold void ff_h264_free_context(H264Context *h); 640 av_cold void ff_h264_free_context(H264Context *h);
641 641
642 /** 642 /**
643 * reconstructs bitstream slice_type. 643 * Reconstruct bitstream slice_type.
644 */ 644 */
645 int ff_h264_get_slice_type(const H264Context *h); 645 int ff_h264_get_slice_type(const H264Context *h);
646 646
647 /** 647 /**
648 * allocates tables. 648 * Allocate tables.
649 * needs width/height 649 * needs width/height
650 */ 650 */
651 int ff_h264_alloc_tables(H264Context *h); 651 int ff_h264_alloc_tables(H264Context *h);
652 652
653 /** 653 /**
654 * fills the default_ref_list. 654 * Fill the default_ref_list.
655 */ 655 */
656 int ff_h264_fill_default_ref_list(H264Context *h); 656 int ff_h264_fill_default_ref_list(H264Context *h);
657 657
658 int ff_h264_decode_ref_pic_list_reordering(H264Context *h); 658 int ff_h264_decode_ref_pic_list_reordering(H264Context *h);
659 void ff_h264_fill_mbaff_ref_list(H264Context *h); 659 void ff_h264_fill_mbaff_ref_list(H264Context *h);
660 void ff_h264_remove_all_refs(H264Context *h); 660 void ff_h264_remove_all_refs(H264Context *h);
661 661
662 /** 662 /**
663 * Executes the reference picture marking (memory management control operations). 663 * Execute the reference picture marking (memory management control operations).
664 */ 664 */
665 int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count); 665 int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count);
666 666
667 int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb); 667 int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb);
668 668
669 669
670 /** 670 /**
671 * checks if the top & left blocks are available if needed & changes the dc mode so it only uses the available blocks. 671 * Check if the top & left blocks are available if needed & change the dc mode so it only uses the available blocks.
672 */ 672 */
673 int ff_h264_check_intra4x4_pred_mode(H264Context *h); 673 int ff_h264_check_intra4x4_pred_mode(H264Context *h);
674 674
675 /** 675 /**
676 * checks if the top & left blocks are available if needed & changes the dc mode so it only uses the available blocks. 676 * Check if the top & left blocks are available if needed & change the dc mode so it only uses the available blocks.
677 */ 677 */
678 int ff_h264_check_intra_pred_mode(H264Context *h, int mode); 678 int ff_h264_check_intra_pred_mode(H264Context *h, int mode);
679 679
680 void ff_h264_write_back_intra_pred_mode(H264Context *h); 680 void ff_h264_write_back_intra_pred_mode(H264Context *h);
681 void ff_h264_hl_decode_mb(H264Context *h); 681 void ff_h264_hl_decode_mb(H264Context *h);
684 av_cold int ff_h264_decode_init(AVCodecContext *avctx); 684 av_cold int ff_h264_decode_init(AVCodecContext *avctx);
685 av_cold int ff_h264_decode_end(AVCodecContext *avctx); 685 av_cold int ff_h264_decode_end(AVCodecContext *avctx);
686 av_cold void ff_h264_decode_init_vlc(void); 686 av_cold void ff_h264_decode_init_vlc(void);
687 687
688 /** 688 /**
689 * decodes a macroblock 689 * Decode a macroblock
690 * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed 690 * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
691 */ 691 */
692 int ff_h264_decode_mb_cavlc(H264Context *h); 692 int ff_h264_decode_mb_cavlc(H264Context *h);
693 693
694 /** 694 /**
695 * decodes a CABAC coded macroblock 695 * Decode a CABAC coded macroblock
696 * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed 696 * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
697 */ 697 */
698 int ff_h264_decode_mb_cabac(H264Context *h); 698 int ff_h264_decode_mb_cabac(H264Context *h);
699 699
700 void ff_h264_init_cabac_states(H264Context *h); 700 void ff_h264_init_cabac_states(H264Context *h);