2007-05-11 01:26:44 +03:00
/*
* H .26 L / H .264 / AVC / JVT / 14496 - 10 / . . . encoder / decoder
* Copyright ( c ) 2003 Michael Niedermayer < michaelni @ gmx . at >
*
* This file is part of FFmpeg .
*
* FFmpeg is free software ; you can redistribute it and / or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation ; either
* version 2.1 of the License , or ( at your option ) any later version .
*
* FFmpeg is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the GNU
* Lesser General Public License for more details .
*
* You should have received a copy of the GNU Lesser General Public
* License along with FFmpeg ; if not , write to the Free Software
* Foundation , Inc . , 51 Franklin Street , Fifth Floor , Boston , MA 02110 - 1301 USA
*/
/**
* @ file h264 . h
* H .264 / AVC / MPEG4 part10 codec .
* @ author Michael Niedermayer < michaelni @ gmx . at >
*/
2008-08-31 10:39:47 +03:00
# ifndef AVCODEC_H264_H
# define AVCODEC_H264_H
2007-05-11 01:26:44 +03:00
# include "dsputil.h"
# include "cabac.h"
# include "mpegvideo.h"
2007-09-05 08:30:08 +03:00
# include "h264pred.h"
2007-05-11 01:26:44 +03:00
# define interlaced_dct interlaced_dct_is_a_bad_name
2007-06-12 21:50:50 +03:00
# define mb_intra mb_intra_is_not_initialized_see_mb_type
2007-05-11 01:26:44 +03:00
# define LUMA_DC_BLOCK_INDEX 25
# define CHROMA_DC_BLOCK_INDEX 26
# define CHROMA_DC_COEFF_TOKEN_VLC_BITS 8
# define COEFF_TOKEN_VLC_BITS 8
# define TOTAL_ZEROS_VLC_BITS 9
# define CHROMA_DC_TOTAL_ZEROS_VLC_BITS 3
# define RUN_VLC_BITS 3
# define RUN7_VLC_BITS 6
# define MAX_SPS_COUNT 32
# define MAX_PPS_COUNT 256
# define MAX_MMCO_COUNT 66
2008-07-16 00:30:04 +03:00
# define MAX_DELAYED_PIC_COUNT 16
2007-05-11 01:26:44 +03:00
/* Compiling in interlaced support reduces the speed
* of progressive decoding by about 2 % . */
# define ALLOW_INTERLACE
2008-07-26 05:27:14 +03:00
# define ALLOW_NOCHROMA
2008-10-29 00:50:16 +02:00
/**
* The maximum number of slices supported by the decoder .
* must be a power of 2
*/
# define MAX_SLICES 16
2007-05-11 01:26:44 +03:00
# ifdef ALLOW_INTERLACE
# define MB_MBAFF h->mb_mbaff
# define MB_FIELD h->mb_field_decoding_flag
# define FRAME_MBAFF h->mb_aff_frame
2007-10-09 15:28:17 +03:00
# define FIELD_PICTURE (s->picture_structure != PICT_FRAME)
2007-05-11 01:26:44 +03:00
# else
# define MB_MBAFF 0
# define MB_FIELD 0
# define FRAME_MBAFF 0
2007-10-04 09:33:26 +03:00
# define FIELD_PICTURE 0
2007-05-11 01:26:44 +03:00
# undef IS_INTERLACED
# define IS_INTERLACED(mb_type) 0
# endif
2007-10-06 08:59:14 +03:00
# define FIELD_OR_MBAFF_PICTURE (FRAME_MBAFF || FIELD_PICTURE)
2007-05-11 01:26:44 +03:00
2008-07-26 05:27:14 +03:00
# ifdef ALLOW_NOCHROMA
# define CHROMA h->sps.chroma_format_idc
# else
# define CHROMA 1
# endif
2008-07-03 00:46:18 +03:00
# ifndef ENABLE_H264_ENCODER
# define ENABLE_H264_ENCODER 0
# endif
2008-10-03 16:30:19 +03:00
# define EXTENDED_SAR 255
2008-11-24 18:08:21 +02:00
# define MB_TYPE_REF0 MB_TYPE_ACPRED //dirty but it fits in 16 bit
# define MB_TYPE_8x8DCT 0x01000000
# define IS_REF0(a) ((a) & MB_TYPE_REF0)
# define IS_8x8DCT(a) ((a) & MB_TYPE_8x8DCT)
2008-10-03 16:30:19 +03:00
/* NAL unit types */
enum {
2008-10-04 04:08:48 +03:00
NAL_SLICE = 1 ,
NAL_DPA ,
NAL_DPB ,
NAL_DPC ,
NAL_IDR_SLICE ,
NAL_SEI ,
NAL_SPS ,
NAL_PPS ,
NAL_AUD ,
NAL_END_SEQUENCE ,
NAL_END_STREAM ,
NAL_FILLER_DATA ,
NAL_SPS_EXT ,
NAL_AUXILIARY_SLICE = 19
2008-10-03 16:30:19 +03:00
} ;
2008-11-04 20:31:48 +02:00
/**
* pic_struct in picture timing SEI message
*/
typedef enum {
SEI_PIC_STRUCT_FRAME = 0 , ///< 0: %frame
SEI_PIC_STRUCT_TOP_FIELD = 1 , ///< 1: top field
SEI_PIC_STRUCT_BOTTOM_FIELD = 2 , ///< 2: bottom field
SEI_PIC_STRUCT_TOP_BOTTOM = 3 , ///< 3: top field, bottom field, in that order
SEI_PIC_STRUCT_BOTTOM_TOP = 4 , ///< 4: bottom field, top field, in that order
SEI_PIC_STRUCT_TOP_BOTTOM_TOP = 5 , ///< 5: top field, bottom field, top field repeated, in that order
SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6 , ///< 6: bottom field, top field, bottom field repeated, in that order
SEI_PIC_STRUCT_FRAME_DOUBLING = 7 , ///< 7: %frame doubling
SEI_PIC_STRUCT_FRAME_TRIPLING = 8 ///< 8: %frame tripling
} SEI_PicStructType ;
2007-05-11 01:26:44 +03:00
/**
* Sequence parameter set
*/
typedef struct SPS {
int profile_idc ;
int level_idc ;
2008-07-26 05:27:14 +03:00
int chroma_format_idc ;
2007-05-11 01:26:44 +03:00
int transform_bypass ; ///< qpprime_y_zero_transform_bypass_flag
int log2_max_frame_num ; ///< log2_max_frame_num_minus4 + 4
int poc_type ; ///< pic_order_cnt_type
int log2_max_poc_lsb ; ///< log2_max_pic_order_cnt_lsb_minus4
int delta_pic_order_always_zero_flag ;
int offset_for_non_ref_pic ;
int offset_for_top_to_bottom_field ;
int poc_cycle_length ; ///< num_ref_frames_in_pic_order_cnt_cycle
int ref_frame_count ; ///< num_ref_frames
int gaps_in_frame_num_allowed_flag ;
2007-10-02 17:25:47 +03:00
int mb_width ; ///< pic_width_in_mbs_minus1 + 1
int mb_height ; ///< pic_height_in_map_units_minus1 + 1
2007-05-11 01:26:44 +03:00
int frame_mbs_only_flag ;
int mb_aff ; ///<mb_adaptive_frame_field_flag
int direct_8x8_inference_flag ;
int crop ; ///< frame_cropping_flag
2008-04-11 15:57:49 +03:00
unsigned int crop_left ; ///< frame_cropping_rect_left_offset
unsigned int crop_right ; ///< frame_cropping_rect_right_offset
unsigned int crop_top ; ///< frame_cropping_rect_top_offset
unsigned int crop_bottom ; ///< frame_cropping_rect_bottom_offset
2007-05-11 01:26:44 +03:00
int vui_parameters_present_flag ;
AVRational sar ;
int timing_info_present_flag ;
uint32_t num_units_in_tick ;
uint32_t time_scale ;
int fixed_frame_rate_flag ;
short offset_for_ref_frame [ 256 ] ; //FIXME dyn aloc?
int bitstream_restriction_flag ;
int num_reorder_frames ;
int scaling_matrix_present ;
uint8_t scaling_matrix4 [ 6 ] [ 16 ] ;
uint8_t scaling_matrix8 [ 2 ] [ 64 ] ;
2008-11-04 20:31:48 +02:00
int nal_hrd_parameters_present_flag ;
int vcl_hrd_parameters_present_flag ;
int pic_struct_present_flag ;
int time_offset_length ;
int cpb_removal_delay_length ; ///< cpb_removal_delay_length_minus1 + 1
int dpb_output_delay_length ; ///< dpb_output_delay_length_minus1 + 1
2007-05-11 01:26:44 +03:00
} SPS ;
/**
* Picture parameter set
*/
typedef struct PPS {
unsigned int sps_id ;
int cabac ; ///< entropy_coding_mode_flag
int pic_order_present ; ///< pic_order_present_flag
int slice_group_count ; ///< num_slice_groups_minus1 + 1
int mb_slice_group_map_type ;
unsigned int ref_count [ 2 ] ; ///< num_ref_idx_l0/1_active_minus1 + 1
int weighted_pred ; ///< weighted_pred_flag
int weighted_bipred_idc ;
int init_qp ; ///< pic_init_qp_minus26 + 26
int init_qs ; ///< pic_init_qs_minus26 + 26
2007-07-06 17:21:37 +03:00
int chroma_qp_index_offset [ 2 ] ;
2007-05-11 01:26:44 +03:00
int deblocking_filter_parameters_present ; ///< deblocking_filter_parameters_present_flag
int constrained_intra_pred ; ///< constrained_intra_pred_flag
int redundant_pic_cnt_present ; ///< redundant_pic_cnt_present_flag
int transform_8x8_mode ; ///< transform_8x8_mode_flag
uint8_t scaling_matrix4 [ 6 ] [ 16 ] ;
uint8_t scaling_matrix8 [ 2 ] [ 64 ] ;
2008-07-22 16:01:10 +03:00
uint8_t chroma_qp_table [ 2 ] [ 64 ] ; ///< pre-scaled (with chroma_qp_index_offset) version of qp_table
2007-07-06 17:21:37 +03:00
int chroma_qp_diff ;
2007-05-11 01:26:44 +03:00
} PPS ;
/**
* Memory management control operation opcode .
*/
typedef enum MMCOOpcode {
MMCO_END = 0 ,
MMCO_SHORT2UNUSED ,
MMCO_LONG2UNUSED ,
MMCO_SHORT2LONG ,
MMCO_SET_MAX_LONG ,
MMCO_RESET ,
MMCO_LONG ,
} MMCOOpcode ;
/**
* Memory management control operation .
*/
typedef struct MMCO {
MMCOOpcode opcode ;
2007-10-02 17:35:20 +03:00
int short_pic_num ; ///< pic_num without wrapping (pic_num & max_pic_num)
int long_arg ; ///< index, pic_num, or num long refs depending on opcode
2007-05-11 01:26:44 +03:00
} MMCO ;
/**
* H264Context
*/
typedef struct H264Context {
MpegEncContext s ;
int nal_ref_idc ;
int nal_unit_type ;
2007-06-20 11:53:53 +03:00
uint8_t * rbsp_buffer [ 2 ] ;
unsigned int rbsp_buffer_size [ 2 ] ;
2007-05-11 01:26:44 +03:00
/**
* Used to parse AVC variant of h264
*/
int is_avc ; ///< this flag is != 0 if codec is avc1
int got_avcC ; ///< flag used to parse avcC data only once
int nal_length_size ; ///< Number of bytes used for nal length (1, 2 or 4)
2007-07-06 17:21:37 +03:00
int chroma_qp [ 2 ] ; //QPc
2007-05-11 01:26:44 +03:00
int prev_mb_skipped ;
int next_mb_skipped ;
//prediction stuff
int chroma_pred_mode ;
int intra16x16_pred_mode ;
int top_mb_xy ;
int left_mb_xy [ 2 ] ;
int8_t intra4x4_pred_mode_cache [ 5 * 8 ] ;
int8_t ( * intra4x4_pred_mode ) [ 8 ] ;
2007-09-05 08:30:08 +03:00
H264PredContext hpc ;
2007-05-11 01:26:44 +03:00
unsigned int topleft_samples_available ;
unsigned int top_samples_available ;
unsigned int topright_samples_available ;
unsigned int left_samples_available ;
uint8_t ( * top_borders [ 2 ] ) [ 16 + 2 * 8 ] ;
uint8_t left_border [ 2 * ( 17 + 2 * 9 ) ] ;
/**
* non zero coeff count cache .
* is 64 if not available .
*/
DECLARE_ALIGNED_8 ( uint8_t , non_zero_count_cache [ 6 * 8 ] ) ;
uint8_t ( * non_zero_count ) [ 16 ] ;
/**
* Motion vector cache .
*/
DECLARE_ALIGNED_8 ( int16_t , mv_cache [ 2 ] [ 5 * 8 ] [ 2 ] ) ;
DECLARE_ALIGNED_8 ( int8_t , ref_cache [ 2 ] [ 5 * 8 ] ) ;
# define LIST_NOT_USED -1 //FIXME rename?
# define PART_NOT_AVAILABLE -2
/**
* is 1 if the specific list MV & references are set to 0 , 0 , - 2.
*/
int mv_cache_clean [ 2 ] ;
/**
* number of neighbors ( top and / or left ) that used 8 x8 dct
*/
int neighbor_transform_size ;
/**
* block_offset [ 0. .23 ] for frame macroblocks
* block_offset [ 24. .47 ] for field macroblocks
*/
int block_offset [ 2 * ( 16 + 8 ) ] ;
uint32_t * mb2b_xy ; //FIXME are these 4 a good idea?
uint32_t * mb2b8_xy ;
int b_stride ; //FIXME use s->b4_stride
int b8_stride ;
int mb_linesize ; ///< may be equal to s->linesize or s->linesize*2, for mbaff
int mb_uvlinesize ;
int emu_edge_width ;
int emu_edge_height ;
int halfpel_flag ;
int thirdpel_flag ;
int unknown_svq3_flag ;
int next_slice_index ;
2007-05-29 17:35:29 +03:00
SPS * sps_buffers [ MAX_SPS_COUNT ] ;
2007-05-11 01:26:44 +03:00
SPS sps ; ///< current sps
2007-05-29 17:35:29 +03:00
PPS * pps_buffers [ MAX_PPS_COUNT ] ;
2007-05-11 01:26:44 +03:00
/**
* current pps
*/
PPS pps ; //FIXME move to Picture perhaps? (->no) do we need that?
uint32_t dequant4_buffer [ 6 ] [ 52 ] [ 16 ] ;
uint32_t dequant8_buffer [ 2 ] [ 52 ] [ 64 ] ;
uint32_t ( * dequant4_coeff [ 6 ] ) [ 16 ] ;
uint32_t ( * dequant8_coeff [ 2 ] ) [ 64 ] ;
int dequant_coeff_pps ; ///< reinit tables when pps changes
int slice_num ;
2008-10-29 00:50:16 +02:00
uint16_t * slice_table_base ;
uint16_t * slice_table ; ///< slice_table_base + 2*mb_stride + 1
2007-05-11 01:26:44 +03:00
int slice_type ;
2008-07-21 21:24:45 +03:00
int slice_type_nos ; ///< S free slice type (SI/SP are remapped to I/P)
2007-05-11 01:26:44 +03:00
int slice_type_fixed ;
//interlacing specific flags
int mb_aff_frame ;
int mb_field_decoding_flag ;
int mb_mbaff ; ///< mb_aff_frame && mb_field_decoding_flag
unsigned int sub_mb_type [ 4 ] ;
//POC stuff
int poc_lsb ;
int poc_msb ;
int delta_poc_bottom ;
int delta_poc [ 2 ] ;
int frame_num ;
int prev_poc_msb ; ///< poc_msb of the last reference pic for POC type 0
int prev_poc_lsb ; ///< poc_lsb of the last reference pic for POC type 0
int frame_num_offset ; ///< for POC type 2
int prev_frame_num_offset ; ///< for POC type 2
int prev_frame_num ; ///< frame_num of the last pic for POC type 1/2
/**
2007-10-04 09:43:58 +03:00
* frame_num for frames or 2 * frame_num + 1 for field pics .
2007-05-11 01:26:44 +03:00
*/
int curr_pic_num ;
/**
* max_frame_num or 2 * max_frame_num for field pics .
*/
int max_pic_num ;
//Weighted pred stuff
int use_weight ;
int use_weight_chroma ;
int luma_log2_weight_denom ;
int chroma_log2_weight_denom ;
int luma_weight [ 2 ] [ 48 ] ;
int luma_offset [ 2 ] [ 48 ] ;
int chroma_weight [ 2 ] [ 48 ] [ 2 ] ;
int chroma_offset [ 2 ] [ 48 ] [ 2 ] ;
int implicit_weight [ 48 ] [ 48 ] ;
//deblock
int deblocking_filter ; ///< disable_deblocking_filter_idc with 1<->0
int slice_alpha_c0_offset ;
int slice_beta_offset ;
int redundant_pic_count ;
int direct_spatial_mv_pred ;
int dist_scale_factor [ 16 ] ;
2008-09-21 05:39:09 +03:00
int dist_scale_factor_field [ 2 ] [ 32 ] ;
2008-09-22 23:43:35 +03:00
int map_col_to_list0 [ 2 ] [ 16 + 32 ] ;
int map_col_to_list0_field [ 2 ] [ 2 ] [ 16 + 32 ] ;
2007-05-11 01:26:44 +03:00
/**
* num_ref_idx_l0 / 1 _active_minus1 + 1
*/
unsigned int ref_count [ 2 ] ; ///< counts frames or fields, depending on current mb mode
unsigned int list_count ;
Picture * short_ref [ 32 ] ;
Picture * long_ref [ 32 ] ;
2007-10-02 17:25:47 +03:00
Picture default_ref_list [ 2 ] [ 32 ] ; ///< base reference list for all slices of a coded picture
Picture ref_list [ 2 ] [ 48 ] ; /**< 0..15: frame refs, 16..47: mbaff field refs.
Reordered version of default_ref_list
according to picture reordering in slice header */
2008-10-29 00:50:16 +02:00
int ref2frm [ MAX_SLICES ] [ 2 ] [ 64 ] ; ///< reference to frame number lists, used in the loop filter, the first 2 are for -2,-1
2008-07-16 00:30:04 +03:00
Picture * delayed_pic [ MAX_DELAYED_PIC_COUNT + 2 ] ; //FIXME size?
2008-07-19 05:53:57 +03:00
int outputed_poc ;
2007-05-11 01:26:44 +03:00
/**
* memory management control operations buffer .
*/
MMCO mmco [ MAX_MMCO_COUNT ] ;
int mmco_index ;
int long_ref_count ; ///< number of actual long term references
int short_ref_count ; ///< number of actual short term references
//data partitioning
GetBitContext intra_gb ;
GetBitContext inter_gb ;
GetBitContext * intra_gb_ptr ;
GetBitContext * inter_gb_ptr ;
2008-02-03 09:05:11 +02:00
DECLARE_ALIGNED_16 ( DCTELEM , mb [ 16 * 24 ] ) ;
2008-03-13 01:58:46 +02:00
DCTELEM mb_padding [ 256 ] ; ///< as mb is addressed by scantable[i] and scantable is uint8_t we can either check that i is not too large or ensure that there is some unused stuff after mb
2007-05-11 01:26:44 +03:00
/**
* Cabac
*/
CABACContext cabac ;
uint8_t cabac_state [ 460 ] ;
int cabac_init_idc ;
/* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0,1,2), 0x0? luma_cbp */
uint16_t * cbp_table ;
int cbp ;
int top_cbp ;
int left_cbp ;
/* chroma_pred_mode for i4x4 or i16x16, else 0 */
uint8_t * chroma_pred_mode_table ;
int last_qscale_diff ;
int16_t ( * mvd_table [ 2 ] ) [ 2 ] ;
DECLARE_ALIGNED_8 ( int16_t , mvd_cache [ 2 ] [ 5 * 8 ] [ 2 ] ) ;
uint8_t * direct_table ;
uint8_t direct_cache [ 5 * 8 ] ;
uint8_t zigzag_scan [ 16 ] ;
uint8_t zigzag_scan8x8 [ 64 ] ;
uint8_t zigzag_scan8x8_cavlc [ 64 ] ;
uint8_t field_scan [ 16 ] ;
uint8_t field_scan8x8 [ 64 ] ;
uint8_t field_scan8x8_cavlc [ 64 ] ;
const uint8_t * zigzag_scan_q0 ;
const uint8_t * zigzag_scan8x8_q0 ;
const uint8_t * zigzag_scan8x8_cavlc_q0 ;
const uint8_t * field_scan_q0 ;
const uint8_t * field_scan8x8_q0 ;
const uint8_t * field_scan8x8_cavlc_q0 ;
int x264_build ;
2007-09-05 19:18:15 +03:00
/**
* @ defgroup multithreading Members for slice based multithreading
* @ {
*/
struct H264Context * thread_context [ MAX_THREADS ] ;
/**
* current slice number , used to initalize slice_num of each thread / context
*/
int current_slice ;
/**
* Max number of threads / contexts .
* This is equal to AVCodecContext . thread_count unless
* multithreaded decoding is impossible , in which case it is
* reduced to 1.
*/
int max_contexts ;
/**
* 1 if the single thread fallback warning has already been
* displayed , 0 otherwise .
*/
int single_decode_warning ;
int last_slice_type ;
/** @} */
2008-05-11 22:16:21 +03:00
int mb_xy ;
2008-10-14 23:30:11 +03:00
uint32_t svq3_watermark_key ;
2008-11-04 20:31:48 +02:00
/**
* pic_struct in picture timing SEI message
*/
SEI_PicStructType sei_pic_struct ;
2008-12-16 22:26:22 +02:00
int is_complex ;
2007-05-11 01:26:44 +03:00
} H264Context ;
2008-08-31 10:39:47 +03:00
# endif /* AVCODEC_H264_H */