Mercurial > libavcodec.hg
changeset 1110:d4096635b7b9 libavcodec
doxy / cosmetics
| author | michaelni |
|---|---|
| date | Thu, 06 Mar 2003 14:37:37 +0000 |
| parents | 3644e555a20a |
| children | 54dc72414a69 |
| files | mpegvideo.h |
| diffstat | 1 files changed, 192 insertions(+), 178 deletions(-) [+] |
line wrap: on
line diff
--- a/mpegvideo.h Thu Mar 06 13:51:18 2003 +0000 +++ b/mpegvideo.h Thu Mar 06 14:37:37 2003 +0000 @@ -27,7 +27,7 @@ #include "dsputil.h" -#define FRAME_SKIPED 100 // return value for header parsers if frame is not coded +#define FRAME_SKIPED 100 ///< return value for header parsers if frame is not coded enum OutputFormat { FMT_MPEG1, @@ -55,10 +55,10 @@ #define MAX_RUN 64 #define MAX_LEVEL 64 -#define I_TYPE FF_I_TYPE // Intra -#define P_TYPE FF_P_TYPE // Predicted -#define B_TYPE FF_B_TYPE // Bi-dir predicted -#define S_TYPE FF_S_TYPE // S(GMC)-VOP MPEG4 +#define I_TYPE FF_I_TYPE ///< Intra +#define P_TYPE FF_P_TYPE ///< Predicted +#define B_TYPE FF_B_TYPE ///< Bi-dir predicted +#define S_TYPE FF_S_TYPE ///< S(GMC)-VOP MPEG4 typedef struct Predictor{ double coeff; @@ -83,18 +83,21 @@ int b_code; }RateControlEntry; +/** + * rate control context. + */ typedef struct RateControlContext{ FILE *stats_file; - int num_entries; /* number of RateControlEntries */ + int num_entries; ///< number of RateControlEntries RateControlEntry *entry; - int buffer_index; /* amount of bits in the video/audio buffer */ + int buffer_index; ///< amount of bits in the video/audio buffer Predictor pred[5]; - double short_term_qsum; /* sum of recent qscales */ - double short_term_qcount; /* count of recent qscales */ - double pass1_rc_eq_output_sum;/* sum of the output of the rc equation, this is used for normalization */ - double pass1_wanted_bits; /* bits which should have been outputed by the pass1 code (including complexity init) */ + double short_term_qsum; ///< sum of recent qscales + double short_term_qcount; ///< count of recent qscales + double pass1_rc_eq_output_sum;///< sum of the output of the rc equation, this is used for normalization + double pass1_wanted_bits; ///< bits which should have been outputed by the pass1 code (including complexity init) double last_qscale; - double last_qscale_for[5]; /* last qscale for a specific pict type, used for max_diff & ipb factor stuff */ + double last_qscale_for[5]; ///< last qscale for a specific pict type, used for max_diff & ipb factor stuff int last_mc_mb_var_sum; int last_mb_var_sum; uint64_t i_cplx_sum[5]; @@ -105,25 +108,31 @@ int last_non_b_pict_type; }RateControlContext; +/** + * Scantable. + */ typedef struct ScanTable{ const uint8_t *scantable; uint8_t permutated[64]; uint8_t raster_end[64]; #ifdef ARCH_POWERPC - /* Used by dct_quantise_alitvec to find last-non-zero */ + /** Used by dct_quantise_alitvec to find last-non-zero */ uint8_t __align8 inverse[64]; #endif } ScanTable; +/** + * Picture. + */ typedef struct Picture{ FF_COMMON_FRAME - int mb_var_sum; /* sum of MB variance for current frame */ - int mc_mb_var_sum; /* motion compensated MB variance for current frame */ - uint16_t *mb_var; /* Table for MB variances */ - uint16_t *mc_mb_var; /* Table for motion compensated MB variances */ - uint8_t *mb_mean; /* Table for MB luminance */ - int32_t *mb_cmp_score; /* Table for MB cmp scores, for mb decission */ + int mb_var_sum; ///< sum of MB variance for current frame + int mc_mb_var_sum; ///< motion compensated MB variance for current frame + uint16_t *mb_var; ///< Table for MB variances + uint16_t *mc_mb_var; ///< Table for motion compensated MB variances + uint8_t *mb_mean; ///< Table for MB luminance + int32_t *mb_cmp_score; ///< Table for MB cmp scores, for mb decission int b_frame_score; /* */ } Picture; @@ -138,21 +147,24 @@ struct MpegEncContext; +/** + * Motion estimation context. + */ typedef struct MotionEstContext{ - int skip; /* set if ME is skiped for the current MB */ - int co_located_mv[4][2]; /* mv from last p frame for direct mode ME */ + int skip; ///< set if ME is skiped for the current MB + int co_located_mv[4][2]; ///< mv from last p frame for direct mode ME int direct_basis_mv[4][2]; - uint8_t *scratchpad; /* data area for the me algo, so that the ME doesnt need to malloc/free */ - uint32_t *map; /* map to avoid duplicate evaluations */ - uint32_t *score_map; /* map to store the scores */ + uint8_t *scratchpad; ///< data area for the me algo, so that the ME doesnt need to malloc/free + uint32_t *map; ///< map to avoid duplicate evaluations + uint32_t *score_map; ///< map to store the scores int map_generation; int pre_penalty_factor; int penalty_factor; int sub_penalty_factor; int mb_penalty_factor; - int pre_pass; /* = 1 for the pre pass */ + int pre_pass; ///< = 1 for the pre pass int dia_size; - uint16_t (*mv_penalty)[MAX_MV*2+1]; /* amount of bits needed to encode a MV */ + uint16_t (*mv_penalty)[MAX_MV*2+1]; ///< amount of bits needed to encode a MV int (*sub_motion_search)(struct MpegEncContext * s, int *mx_ptr, int *my_ptr, int dmin, int xmin, int ymin, int xmax, int ymax, @@ -172,138 +184,141 @@ uint16_t * const mv_penalty); }MotionEstContext; +/** + * MpegEncContext. + */ typedef struct MpegEncContext { struct AVCodecContext *avctx; /* the following parameters must be initialized before encoding */ - int width, height; /* picture size. must be a multiple of 16 */ + int width, height;///< picture size. must be a multiple of 16 int gop_size; - int frame_rate; /* number of frames per second */ - int intra_only; /* if true, only intra pictures are generated */ - int bit_rate; /* wanted bit rate */ - int bit_rate_tolerance; /* amount of +- bits (>0)*/ - enum OutputFormat out_format; /* output format */ - int h263_pred; /* use mpeg4/h263 ac/dc predictions */ + int frame_rate; ///< number of frames per second + int intra_only; ///< if true, only intra pictures are generated + int bit_rate; ///< wanted bit rate + int bit_rate_tolerance; ///< amount of +- bits (>0) + enum OutputFormat out_format; ///< output format + int h263_pred; ///< use mpeg4/h263 ac/dc predictions /* the following codec id fields are deprecated in favor of codec_id */ - int h263_plus; /* h263 plus headers */ - int h263_rv10; /* use RV10 variation for H263 */ - int h263_msmpeg4; /* generate MSMPEG4 compatible stream (deprecated, use msmpeg4_version instead)*/ - int h263_intel; /* use I263 intel h263 header */ + int h263_plus; ///< h263 plus headers + int h263_rv10; ///< use RV10 variation for H263 + int h263_msmpeg4; ///< generate MSMPEG4 compatible stream (deprecated, use msmpeg4_version instead) + int h263_intel; ///< use I263 intel h263 header int codec_id; /* see CODEC_ID_xxx */ - int fixed_qscale; /* fixed qscale if non zero */ - float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0) */ - float qblur; /* amount of qscale smoothing over time (0.0-1.0) */ - int qmin; /* min qscale */ - int qmax; /* max qscale */ - int max_qdiff; /* max qscale difference between frames */ - int encoding; /* true if we are encoding (vs decoding) */ - int flags; /* AVCodecContext.flags (HQ, MV4, ...) */ - int max_b_frames; /* max number of b-frames for encoding */ + int fixed_qscale; ///< fixed qscale if non zero + float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0) + float qblur; ///< amount of qscale smoothing over time (0.0-1.0) + int qmin; ///< min qscale + int qmax; ///< max qscale + int max_qdiff; ///< max qscale difference between frames + int encoding; ///< true if we are encoding (vs decoding) + int flags; ///< AVCodecContext.flags (HQ, MV4, ...) + int max_b_frames; ///< max number of b-frames for encoding int b_frame_strategy; int luma_elim_threshold; int chroma_elim_threshold; - int strict_std_compliance; /* strictly follow the std (MPEG4, ...) */ - int workaround_bugs; /* workaround bugs in encoders which cannot be detected automatically */ + int strict_std_compliance; ///< strictly follow the std (MPEG4, ...) + int workaround_bugs; ///< workaround bugs in encoders which cannot be detected automatically /* the following fields are managed internally by the encoder */ - /* bit output */ + /** bit output */ PutBitContext pb; /* sequence parameters */ int context_initialized; int input_picture_number; int picture_number; - int picture_in_gop_number; /* 0-> first pic in gop, ... */ - int b_frames_since_non_b; /* used for encoding, relative to not yet reordered input */ - int mb_width, mb_height; /* number of MBs horizontally & vertically */ - int h_edge_pos, v_edge_pos;/* horizontal / vertical position of the right/bottom edge (pixel replicateion)*/ - int mb_num; /* number of MBs of a picture */ - int linesize; /* line size, in bytes, may be different from width */ - int uvlinesize; /* line size, for chroma in bytes, may be different from width */ - Picture picture[MAX_PICTURE_COUNT]; /* main picture buffer */ - Picture *input_picture[MAX_PICTURE_COUNT]; /* next pictures on display order for encoding*/ - Picture *reordered_input_picture[MAX_PICTURE_COUNT]; /* pointer to the next pictures in codedorder for encoding*/ - Picture last_picture; /* previous picture */ - Picture next_picture; /* previous picture (for bidir pred) */ - Picture new_picture; /* source picture for encoding */ - Picture current_picture; /* buffer to store the decompressed current picture */ - int last_dc[3]; /* last DC values for MPEG1 */ - int16_t *dc_val[3]; /* used for mpeg4 DC prediction, all 3 arrays must be continuous */ + int picture_in_gop_number; ///< 0-> first pic in gop, ... + int b_frames_since_non_b; ///< used for encoding, relative to not yet reordered input + int mb_width, mb_height; ///< number of MBs horizontally & vertically + int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replicateion) + int mb_num; ///< number of MBs of a picture + int linesize; ///< line size, in bytes, may be different from width + int uvlinesize; ///< line size, for chroma in bytes, may be different from width + Picture picture[MAX_PICTURE_COUNT]; ///< main picture buffer + Picture *input_picture[MAX_PICTURE_COUNT]; ///< next pictures on display order for encoding + Picture *reordered_input_picture[MAX_PICTURE_COUNT]; ///< pointer to the next pictures in codedorder for encoding + Picture last_picture; ///< previous picture + Picture next_picture; ///< previous picture (for bidir pred) + Picture new_picture; ///< source picture for encoding + Picture current_picture; ///< buffer to store the decompressed current picture + int last_dc[3]; ///< last DC values for MPEG1 + int16_t *dc_val[3]; ///< used for mpeg4 DC prediction, all 3 arrays must be continuous int y_dc_scale, c_dc_scale; - uint8_t *y_dc_scale_table; /* qscale -> y_dc_scale table */ - uint8_t *c_dc_scale_table; /* qscale -> c_dc_scale table */ - uint8_t *coded_block; /* used for coded block pattern prediction (msmpeg4v3, wmv1)*/ - int16_t (*ac_val[3])[16]; /* used for for mpeg4 AC prediction, all 3 arrays must be continuous */ + uint8_t *y_dc_scale_table; ///< qscale -> y_dc_scale table + uint8_t *c_dc_scale_table; ///< qscale -> c_dc_scale table + uint8_t *coded_block; ///< used for coded block pattern prediction (msmpeg4v3, wmv1) + int16_t (*ac_val[3])[16]; ///< used for for mpeg4 AC prediction, all 3 arrays must be continuous int ac_pred; - uint8_t *prev_pict_types; /* previous picture types in bitstream order, used for mb skip */ + uint8_t *prev_pict_types; ///< previous picture types in bitstream order, used for mb skip #define PREV_PICT_TYPES_BUFFER_SIZE 256 - int mb_skiped; /* MUST BE SET only during DECODING */ - uint8_t *mbskip_table; /* used to avoid copy if macroblock skipped (for black regions for example) + int mb_skiped; ///< MUST BE SET only during DECODING + uint8_t *mbskip_table; /**< used to avoid copy if macroblock skipped (for black regions for example) and used for b-frame encoding & decoding (contains skip table of next P Frame) */ - uint8_t *mbintra_table; /* used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding */ - uint8_t *cbp_table; /* used to store cbp, ac_pred for partitioned decoding */ - uint8_t *pred_dir_table; /* used to store pred_dir for partitioned decoding */ + uint8_t *mbintra_table; ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding + uint8_t *cbp_table; ///< used to store cbp, ac_pred for partitioned decoding + uint8_t *pred_dir_table; ///< used to store pred_dir for partitioned decoding uint8_t *allocated_edge_emu_buffer; - uint8_t *edge_emu_buffer; /* points into the middle of allocated_edge_emu_buffer */ + uint8_t *edge_emu_buffer; ///< points into the middle of allocated_edge_emu_buffer - int qscale; /* QP */ - float frame_qscale; /* qscale from the frame level rc FIXME remove*/ - int adaptive_quant; /* use adaptive quantization */ - int dquant; /* qscale difference to prev qscale */ - int pict_type; /* I_TYPE, P_TYPE, B_TYPE, ... */ + int qscale; ///< QP + float frame_qscale; ///< qscale from the frame level rc FIXME remove + int adaptive_quant; ///< use adaptive quantization + int dquant; ///< qscale difference to prev qscale + int pict_type; ///< I_TYPE, P_TYPE, B_TYPE, ... int last_pict_type; - int last_non_b_pict_type; /* used for mpeg4 gmc b-frames & ratecontrol */ + int last_non_b_pict_type; ///< used for mpeg4 gmc b-frames & ratecontrol int frame_rate_index; /* motion compensation */ - int unrestricted_mv; /* mv can point outside of the coded picture */ - int h263_long_vectors; /* use horrible h263v1 long vector mode */ + int unrestricted_mv; ///< mv can point outside of the coded picture + int h263_long_vectors; ///< use horrible h263v1 long vector mode - DSPContext dsp; /* pointers for accelerated dsp fucntions */ - int f_code; /* forward MV resolution */ - int b_code; /* backward MV resolution for B Frames (mpeg4) */ - int16_t (*motion_val)[2]; /* used for MV prediction (4MV per MB) */ - int16_t (*p_mv_table)[2]; /* MV table (1MV per MB) p-frame encoding */ - int16_t (*b_forw_mv_table)[2]; /* MV table (1MV per MB) forward mode b-frame encoding */ - int16_t (*b_back_mv_table)[2]; /* MV table (1MV per MB) backward mode b-frame encoding */ - int16_t (*b_bidir_forw_mv_table)[2]; /* MV table (1MV per MB) bidir mode b-frame encoding */ - int16_t (*b_bidir_back_mv_table)[2]; /* MV table (1MV per MB) bidir mode b-frame encoding */ - int16_t (*b_direct_mv_table)[2]; /* MV table (1MV per MB) direct mode b-frame encoding */ - int me_method; /* ME algorithm */ + DSPContext dsp; ///< pointers for accelerated dsp fucntions + int f_code; ///< forward MV resolution + int b_code; ///< backward MV resolution for B Frames (mpeg4) + int16_t (*motion_val)[2]; ///< used for MV prediction (4MV per MB) + int16_t (*p_mv_table)[2]; ///< MV table (1MV per MB) p-frame encoding + int16_t (*b_forw_mv_table)[2]; ///< MV table (1MV per MB) forward mode b-frame encoding + int16_t (*b_back_mv_table)[2]; ///< MV table (1MV per MB) backward mode b-frame encoding + int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding + int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding + int16_t (*b_direct_mv_table)[2]; ///< MV table (1MV per MB) direct mode b-frame encoding + int me_method; ///< ME algorithm int scene_change_score; int mv_dir; #define MV_DIR_BACKWARD 1 #define MV_DIR_FORWARD 2 -#define MV_DIRECT 4 // bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4) +#define MV_DIRECT 4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4) int mv_type; -#define MV_TYPE_16X16 0 /* 1 vector for the whole mb */ -#define MV_TYPE_8X8 1 /* 4 vectors (h263, mpeg4 4MV) */ -#define MV_TYPE_16X8 2 /* 2 vectors, one per 16x8 block */ -#define MV_TYPE_FIELD 3 /* 2 vectors, one per field */ -#define MV_TYPE_DMV 4 /* 2 vectors, special mpeg2 Dual Prime Vectors */ - /* motion vectors for a macroblock +#define MV_TYPE_16X16 0 ///< 1 vector for the whole mb +#define MV_TYPE_8X8 1 ///< 4 vectors (h263, mpeg4 4MV) +#define MV_TYPE_16X8 2 ///< 2 vectors, one per 16x8 block +#define MV_TYPE_FIELD 3 ///< 2 vectors, one per field +#define MV_TYPE_DMV 4 ///< 2 vectors, special mpeg2 Dual Prime Vectors + /**motion vectors for a macroblock first coordinate : 0 = forward 1 = backward second " : depend on type third " : 0 = x, 1 = y */ int mv[2][4][2]; int field_select[2][2]; - int last_mv[2][2][2]; /* last MV, used for MV prediction in MPEG1 & B-frame MPEG4 */ - uint8_t *fcode_tab; /* smallest fcode needed for each MV */ + int last_mv[2][2][2]; ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4 + uint8_t *fcode_tab; ///< smallest fcode needed for each MV MotionEstContext me; - int no_rounding; /* apply no rounding to motion compensation (MPEG4, msmpeg4, ...) + int no_rounding; /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...) for b-frames rounding mode is allways 0 */ - int hurry_up; /* when set to 1 during decoding, b frames will be skiped + int hurry_up; /**< when set to 1 during decoding, b frames will be skiped when set to 2 idct/dequant will be skipped too */ /* macroblock layer */ int mb_x, mb_y; int mb_incr; int mb_intra; - uint8_t *mb_type; /* Table for MB type */ + uint8_t *mb_type; ///< Table for MB type #define MB_TYPE_INTRA 0x01 #define MB_TYPE_INTER 0x02 #define MB_TYPE_INTER4V 0x04 @@ -315,20 +330,20 @@ #define MB_TYPE_BACKWARD 0x40 #define MB_TYPE_BIDIR 0x80 - int block_index[6]; /* index to current MB in block based arrays with edges*/ + int block_index[6]; ///< index to current MB in block based arrays with edges int block_wrap[6]; - /* matrix transmitted in the bitstream */ + /** matrix transmitted in the bitstream */ uint16_t intra_matrix[64]; uint16_t chroma_intra_matrix[64]; uint16_t inter_matrix[64]; uint16_t chroma_inter_matrix[64]; #define QUANT_BIAS_SHIFT 4 - int intra_quant_bias; /* bias for the quantizer */ - int inter_quant_bias; /* bias for the quantizer */ - int min_qcoeff; /* minimum encodable coefficient */ - int max_qcoeff; /* maximum encodable coefficient */ - int ac_esc_length; /* num of bits needed to encode the longest esc */ + int intra_quant_bias; ///< bias for the quantizer + int inter_quant_bias; ///< bias for the quantizer + int min_qcoeff; ///< minimum encodable coefficient + int max_qcoeff; ///< maximum encodable coefficient + int ac_esc_length; ///< num of bits needed to encode the longest esc uint8_t *intra_ac_vlc_length; uint8_t *intra_ac_vlc_last_length; uint8_t *inter_ac_vlc_length; @@ -337,29 +352,29 @@ uint8_t *chroma_dc_vlc_length; #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level)) - /* precomputed matrix (combine qscale and DCT renorm) */ + /** precomputed matrix (combine qscale and DCT renorm) */ int __align8 q_intra_matrix[32][64]; int __align8 q_inter_matrix[32][64]; - /* identical to the above but for MMX & these are not permutated */ + /** identical to the above but for MMX & these are not permutated */ uint16_t __align8 q_intra_matrix16[32][64]; uint16_t __align8 q_inter_matrix16[32][64]; uint16_t __align8 q_intra_matrix16_bias[32][64]; uint16_t __align8 q_inter_matrix16_bias[32][64]; - int block_last_index[6]; /* last non zero coefficient in block */ + int block_last_index[6]; ///< last non zero coefficient in block /* scantables */ ScanTable __align8 intra_scantable; ScanTable intra_h_scantable; ScanTable intra_v_scantable; - ScanTable inter_scantable; // if inter == intra then intra should be used to reduce tha cache usage + ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage - void *opaque; /* private data for the user */ + void *opaque; ///< private data for the user /* bit rate control */ int I_frame_bits; //FIXME used in mpeg12 ... int64_t wanted_bits; int64_t total_bits; - int frame_bits; /* bits used for the current frame */ - RateControlContext rc_context; // contains stuff only accessed in ratecontrol.c + int frame_bits; ///< bits used for the current frame + RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c /* statistics, used for 2-pass encoding */ int mv_bits; @@ -370,12 +385,12 @@ int f_count; int b_count; int skip_count; - int misc_bits; // cbp, mb_type - int last_bits; //temp var used for calculating the above vars + int misc_bits; ///< cbp, mb_type + int last_bits; ///< temp var used for calculating the above vars /* error concealment / resync */ - uint8_t *error_status_table; /* table of the error status of each MB */ -#define VP_START 1 /* current MB is the first after a resync marker */ + uint8_t *error_status_table; ///< table of the error status of each MB +#define VP_START 1 ///< current MB is the first after a resync marker #define AC_ERROR 2 #define DC_ERROR 4 #define MV_ERROR 8 @@ -384,11 +399,11 @@ #define MV_END 64 //FIXME some prefix? - int resync_mb_x; /* x position of last resync marker */ - int resync_mb_y; /* y position of last resync marker */ - GetBitContext last_resync_gb; /* used to search for the next resync marker */ - int mb_num_left; /* number of MBs left in this video packet (for partitioned Slices only)*/ - int next_p_frame_damaged; /* set if the next p frame is damaged, to avoid showing trashed b frames */ + int resync_mb_x; ///< x position of last resync marker + int resync_mb_y; ///< y position of last resync marker + GetBitContext last_resync_gb; ///< used to search for the next resync marker + int mb_num_left; ///< number of MBs left in this video packet (for partitioned Slices only) + int next_p_frame_damaged; ///< set if the next p frame is damaged, to avoid showing trashed b frames int error_resilience; ParseContext parse_context; @@ -398,21 +413,21 @@ int gob_index; /* H.263+ specific */ - int umvplus; /* == H263+ && unrestricted_mv */ - int h263_aic; /* Advanded INTRA Coding (AIC) */ - int h263_aic_dir; /* AIC direction: 0 = left, 1 = top */ + int umvplus; ///< == H263+ && unrestricted_mv + int h263_aic; ///< Advanded INTRA Coding (AIC) + int h263_aic_dir; ///< AIC direction: 0 = left, 1 = top /* mpeg4 specific */ int time_increment_resolution; - int time_increment_bits; /* number of bits to represent the fractional part of time */ + int time_increment_bits; ///< number of bits to represent the fractional part of time int last_time_base; - int time_base; /* time in seconds of last I,P,S Frame */ - int64_t time; /* time of current frame */ + int time_base; ///< time in seconds of last I,P,S Frame + int64_t time; ///< time of current frame int64_t last_non_b_time; - uint16_t pp_time; /* time distance between the last 2 p,s,i frames */ - uint16_t pb_time; /* time distance between the last b and p,s,i frame */ + uint16_t pp_time; ///< time distance between the last 2 p,s,i frames + uint16_t pb_time; ///< time distance between the last b and p,s,i frame uint16_t pp_field_time; - uint16_t pb_field_time; /* like above, just for interlaced */ + uint16_t pb_field_time; ///< like above, just for interlaced int shape; int vol_sprite_usage; int sprite_width; @@ -422,12 +437,12 @@ int sprite_brightness_change; int num_sprite_warping_points; int real_sprite_warping_points; - int sprite_offset[2][2]; /* sprite offset[isChroma][isMVY] */ - int sprite_delta[2][2]; /* sprite_delta [isY][isMVY] */ - int sprite_shift[2]; /* sprite shift [isChroma] */ + int sprite_offset[2][2]; ///< sprite offset[isChroma][isMVY] + int sprite_delta[2][2]; ///< sprite_delta [isY][isMVY] + int sprite_shift[2]; ///< sprite shift [isChroma] int mcsel; int quant_precision; - int quarter_sample; /* 1->qpel, 0->half pel ME/MC */ + int quarter_sample; ///< 1->qpel, 0->half pel ME/MC int scalability; int hierachy_type; int enhancement_type; @@ -438,26 +453,26 @@ int aspected_height; int sprite_warping_accuracy; int low_latency_sprite; - int data_partitioning; /* data partitioning flag from header */ - int partitioned_frame; /* is current frame partitioned */ - int rvlc; /* reversible vlc */ - int resync_marker; /* could this stream contain resync markers*/ - int low_delay; /* no reordering needed / has no b-frames */ + int data_partitioning; ///< data partitioning flag from header + int partitioned_frame; ///< is current frame partitioned + int rvlc; ///< reversible vlc + int resync_marker; ///< could this stream contain resync markers + int low_delay; ///< no reordering needed / has no b-frames int vo_type; - int vol_control_parameters; /* does the stream contain the low_delay flag, used to workaround buggy encoders */ - PutBitContext tex_pb; /* used for data partitioned VOPs */ - PutBitContext pb2; /* used for data partitioned VOPs */ + int vol_control_parameters; ///< does the stream contain the low_delay flag, used to workaround buggy encoders + PutBitContext tex_pb; ///< used for data partitioned VOPs + PutBitContext pb2; ///< used for data partitioned VOPs #define PB_BUFFER_SIZE 1024*256 uint8_t *tex_pb_buffer; uint8_t *pb2_buffer; int mpeg_quant; #define CO_LOCATED_TYPE_4MV 1 #define CO_LOCATED_TYPE_FIELDMV 2 - int8_t *co_located_type_table; /* 4mv & field_mv info for next b frame */ - int16_t (*field_mv_table)[2][2]; /* used for interlaced b frame decoding */ - int8_t (*field_select_table)[2]; /* wtf, no really another table for interlaced b frames */ - int t_frame; /* time distance of first I -> B, used for interlaced b frames */ - int padding_bug_score; /* used to detect the VERY common padding bug in MPEG4 */ + int8_t *co_located_type_table; ///< 4mv & field_mv info for next b frame + int16_t (*field_mv_table)[2][2]; ///< used for interlaced b frame decoding + int8_t (*field_select_table)[2]; ///< wtf, no really another table for interlaced b frames + int t_frame; ///< time distance of first I -> B, used for interlaced b frames + int padding_bug_score; ///< used to detect the VERY common padding bug in MPEG4 /* divx specific, used to workaround (many) bugs in divx5 */ int divx_version; @@ -473,16 +488,15 @@ int lavc_build; /* RV10 specific */ - int rv10_version; /* RV10 version: 0 or 3 */ + int rv10_version; ///< RV10 version: 0 or 3 int rv10_first_dc_coded[3]; /* MJPEG specific */ struct MJpegContext *mjpeg_ctx; - int mjpeg_vsample[3]; /* vertical sampling factors, default = {2, 1, 1} */ - int mjpeg_hsample[3]; /* horizontal sampling factors, default = {2, 1, 1} */ - int mjpeg_write_tables; /* do we want to have quantisation- and - huffmantables in the jpeg file ? */ - int mjpeg_data_only_frames; /* frames only with SOI, SOS and EOI markers */ + int mjpeg_vsample[3]; ///< vertical sampling factors, default = {2, 1, 1} + int mjpeg_hsample[3]; ///< horizontal sampling factors, default = {2, 1, 1} + int mjpeg_write_tables; ///< do we want to have quantisation- and huffmantables in the jpeg file ? + int mjpeg_data_only_frames; ///< frames only with SOI, SOS and EOI markers /* MSMPEG4 specific */ int mv_table_index; @@ -490,14 +504,14 @@ int rl_chroma_table_index; int dc_table_index; int use_skip_mb_code; - int slice_height; /* in macroblocks */ - int first_slice_line; /* used in mpeg4 too to handle resync markers */ + int slice_height; ///< in macroblocks + int first_slice_line; ///< used in mpeg4 too to handle resync markers int flipflop_rounding; - int msmpeg4_version; /* 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8*/ + int msmpeg4_version; ///< 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8 int per_mb_rl_table; int esc3_level_length; int esc3_run_length; - /* [mb_intra][isChroma][level][run][last] */ + /** [mb_intra][isChroma][level][run][last] */ int (*ac_stats)[2][MAX_LEVEL+1][MAX_RUN+1][2]; int inter_intra_pred; int mspel; @@ -506,9 +520,9 @@ GetBitContext gb; /* Mpeg1 specific */ - int fake_picture_number; /* picture number at the bitstream frame rate */ - int gop_picture_number; /* index of the first picture of a GOP based on fake_pic_num & mpeg1 specific */ - int last_mv_dir; /* last mv_dir, used for b frame encoding */ + int fake_picture_number; ///< picture number at the bitstream frame rate + int gop_picture_number; ///< index of the first picture of a GOP based on fake_pic_num & mpeg1 specific + int last_mv_dir; ///< last mv_dir, used for b frame encoding /* MPEG2 specific - I wish I had not to support this mess. */ int progressive_sequence; @@ -544,7 +558,7 @@ uint8_t *ptr_last_mb_line; uint32_t mb_line_avgsize; - DCTELEM (*block)[64]; /* points to one of the following blocks */ + DCTELEM (*block)[64]; ///< points to one of the following blocks DCTELEM blocks[2][6][64] __align8; // for HQ mode we need to keep the best block int (*decode_mb)(struct MpegEncContext *s, DCTELEM block[6][64]); // used by some codecs to avoid a switch() #define SLICE_OK 0 @@ -649,18 +663,18 @@ void ff_mpeg1_encode_init(MpegEncContext *s); -/* h263enc.c */ +/** RLTable. */ typedef struct RLTable { - int n; /* number of entries of table_vlc minus 1 */ - int last; /* number of values for last = 0 */ + int n; ///< number of entries of table_vlc minus 1 + int last; ///< number of values for last = 0 const uint16_t (*table_vlc)[2]; const int8_t *table_run; const int8_t *table_level; - uint8_t *index_run[2]; /* encoding only */ - int8_t *max_level[2]; /* encoding & decoding */ - int8_t *max_run[2]; /* encoding & decoding */ - VLC vlc; /* decoding only deprected FIXME remove*/ - RL_VLC_ELEM *rl_vlc[32]; /* decoding only */ + uint8_t *index_run[2]; ///< encoding only + int8_t *max_level[2]; ///< encoding & decoding + int8_t *max_run[2]; ///< encoding & decoding + VLC vlc; ///< decoding only deprected FIXME remove + RL_VLC_ELEM *rl_vlc[32]; ///< decoding only } RLTable; void init_rl(RLTable *rl);