[FFmpeg-soc] [soc]: r2298 - eac3/ac3dec.h
jbr
subversion at mplayerhq.hu
Sun Jun 1 20:18:50 CEST 2008
Author: jbr
Date: Sun Jun 1 20:18:50 2008
New Revision: 2298
Log:
cosmetics: fix inconsistent and unnecessary capitalization in comments
Modified:
eac3/ac3dec.h
Modified: eac3/ac3dec.h
==============================================================================
--- eac3/ac3dec.h (original)
+++ eac3/ac3dec.h Sun Jun 1 20:18:50 2008
@@ -51,98 +51,98 @@
#define MAX_SPX_CODES 18
typedef struct AC3DecodeContext {
- AVCodecContext *avctx; ///< Parent context
- GetBitContext gbc; ///< Bitstream reader
+ AVCodecContext *avctx; ///< parent context
+ GetBitContext gbc; ///< bitstream reader
uint8_t *input_buffer; ///< temp buffer to prevent overread
-///@defgroup bsi Bit Stream Information
+///@defgroup bsi bit stream information
///@{
- int frame_type; ///< Frame type (strmtyp)
- int substreamid; ///< Substream identification
- int frame_size; ///< Frame size, in bytes
- int bit_rate; ///< Bitrate, in bits-per-second
- int sample_rate; ///< Sample rate, in Hz
- int num_blocks; ///< Number of audio blocks
- int channel_mode; ///< Channel mode (acmod)
- int lfe_on; ///< Low frequency effect channel on (lfeon)
- int channel_map; ///< Custom channel map
- int bitstream_id; ///< Bit stream identification (bsid)
- int center_mix_level; ///< Center mix level index
- int surround_mix_level; ///< Surround mix level index
- int eac3; ///< indicates if current frame is E-AC3
+ int frame_type; ///< frame type (strmtyp)
+ int substreamid; ///< substream identification
+ int frame_size; ///< frame size, in bytes
+ int bit_rate; ///< bitrate, in bits-per-second
+ int sample_rate; ///< sample rate, in Hz
+ int num_blocks; ///< number of audio blocks
+ int channel_mode; ///< channel mode (acmod)
+ int lfe_on; ///< low frequency effect channel on (lfeon)
+ int channel_map; ///< custom channel map
+ int bitstream_id; ///< bit stream identification (bsid)
+ int center_mix_level; ///< center mix level index
+ int surround_mix_level; ///< surround mix level index
+ int eac3; ///< indicates if current frame is E-AC-3
///@}
-///@defgroup audfrm Frame Syntax Parameters
+///@defgroup audfrm frame syntax parameters
int snr_offset_strategy; ///< SNR offset strategy (snroffststr)
- int block_switch_syntax; ///< Block switch syntax enabled (blkswe)
- int dither_flag_syntax; ///< Dither flag syntax enabled (dithflage)
- int bit_allocation_syntax; ///< Bit allocation model syntax enabled (bamode)
- int fast_gain_syntax; ///< Fast gain codes enabled (frmfgaincode)
- int dba_syntax; ///< Delta bit allocation syntax enabled (dbaflde)
- int skip_syntax; ///< Skip Filed syntax enabled (skipflde)
+ int block_switch_syntax; ///< block switch syntax enabled (blkswe)
+ int dither_flag_syntax; ///< dither flag syntax enabled (dithflage)
+ int bit_allocation_syntax; ///< bit allocation model syntax enabled (bamode)
+ int fast_gain_syntax; ///< fast gain codes enabled (frmfgaincode)
+ int dba_syntax; ///< delta bit allocation syntax enabled (dbaflde)
+ int skip_syntax; ///< skip field syntax enabled (skipflde)
///@}
///@defgroup cpl Standard Coupling
- int cpl_in_use[MAX_BLOCKS]; ///< Coupling in use (cplinu)
- int cpl_strategy_exists[MAX_BLOCKS]; ///< Coupling strategy exists (cplstre)
- int channel_in_cpl[AC3_MAX_CHANNELS]; ///< Channel in coupling (chincpl)
- int phase_flags_in_use; ///< Phase flag in use (phsflginu)
- int phase_flags[18]; ///< Phase flag
- int num_cpl_subbands; ///< Number of coupling sub bands (ncplsubnd)
- int num_cpl_bands; ///< Number of coupling bands (ncplbnd)
- int cpl_band_struct[18]; ///< Coupling band structure (cplbndstrc)
- int firstchincpl; ///< First channel in coupling
- int first_cpl_coords[AC3_MAX_CHANNELS]; ///< First coupling coordinates states (firstcplcos)
+ int cpl_in_use[MAX_BLOCKS]; ///< coupling in use (cplinu)
+ int cpl_strategy_exists[MAX_BLOCKS]; ///< coupling strategy exists (cplstre)
+ int channel_in_cpl[AC3_MAX_CHANNELS]; ///< channel in coupling (chincpl)
+ int phase_flags_in_use; ///< phase flag in use (phsflginu)
+ int phase_flags[18]; ///< phase flag
+ int num_cpl_subbands; ///< number of coupling sub bands (ncplsubnd)
+ int num_cpl_bands; ///< number of coupling bands (ncplbnd)
+ int cpl_band_struct[18]; ///< coupling band structure (cplbndstrc)
+ int firstchincpl; ///< first channel in coupling
+ int first_cpl_coords[AC3_MAX_CHANNELS]; ///< first coupling coordinates states (firstcplcos)
int cpl_coords[AC3_MAX_CHANNELS][18]; ///< coupling coordinates (cplco)
///@}
-///@defgroup aht Adaptive Hybrid Transform
- int channel_uses_aht[AC3_MAX_CHANNELS]; ///< Channel AHT in use (chahtinu)
- int pre_mantissa[6][AC3_MAX_CHANNELS][256]; ///< Pre-IDCT mantissas
+///@defgroup aht adaptive hybrid transform
+ int channel_uses_aht[AC3_MAX_CHANNELS]; ///< channel AHT in use (chahtinu)
+ int pre_mantissa[6][AC3_MAX_CHANNELS][256]; ///< pre-IDCT mantissas
///@}
#if TEST_SPX
-///@defgroup spx Spectral Extension
- int channel_uses_spx[AC3_MAX_CHANNELS]; ///< Channel in spectral extension attenuation process (chinspxatten)
+///@defgroup spx spectral extension
+ int channel_uses_spx[AC3_MAX_CHANNELS]; ///< channel in spectral extension attenuation process (chinspxatten)
int spx_atten_code[AC3_MAX_CHANNELS]; ///< spectral extension attenuation code (spxattencod)
int spx_in_use; ///< spectral extension in use
- int chinspx[AC3_MAX_CHANNELS]; ///< Channel in spectral extension
- int spxstrtf; ///< Spectral extension start copy frequency code
- int spxbegf; ///< Spectral extension begin frequency code
- int spxendf; ///< Spectral extension end frequency code
- int nspxbnds; ///< Number of structured spectral extension bands
- int spxbndsztab[MAX_SPX_CODES]; ///< Sizes of spectral extension bands
- int spxbndstrc[MAX_SPX_CODES]; ///< Spectral extension band structure
- int spxcoe[AC3_MAX_CHANNELS]; ///< Spectral extension coordinates exists
- int spxblnd[AC3_MAX_CHANNELS]; ///< Spectral extension blend
- int firstspxcos[AC3_MAX_CHANNELS]; ///< First spectral extension coordinates states
- float spxco[AC3_MAX_CHANNELS][18]; ///< Spectral extension coordinates
+ int chinspx[AC3_MAX_CHANNELS]; ///< channel in spectral extension
+ int spxstrtf; ///< spectral extension start copy frequency code
+ int spxbegf; ///< spectral extension begin frequency code
+ int spxendf; ///< spectral extension end frequency code
+ int nspxbnds; ///< number of structured spectral extension bands
+ int spxbndsztab[MAX_SPX_CODES]; ///< sizes of spectral extension bands
+ int spxbndstrc[MAX_SPX_CODES]; ///< spectral extension band structure
+ int spxcoe[AC3_MAX_CHANNELS]; ///< spectral extension coordinates exists
+ int spxblnd[AC3_MAX_CHANNELS]; ///< spectral extension blend
+ int firstspxcos[AC3_MAX_CHANNELS]; ///< first spectral extension coordinates states
+ float spxco[AC3_MAX_CHANNELS][18]; ///< spectral extension coordinates
///@}
#endif
#if TEST_ECPL
-///@defgroup ecpl Enhanced Coupling
- int ecpl_in_use; ///< Enhanced coupling in use
- int ecplbegf; ///< Enhanced coupling begin frequency code
- int ecplendf; ///< Enhanced coupling end frequency code
- int ecpl_start_subbnd; ///< Enhanced coupling begin frequency
- int ecpl_end_subbnd; ///< Enhanced coupling end frequency
- int necplbnd; ///< Number of structured enhanced coupling bands
- int ecplbndstrc[23]; ///< Enhanced coupling band structure
- int ecplangleintrp; ///< Enhanced coupling angle interpolation flag
- int ecplparam1e[AC3_MAX_CHANNELS]; ///< Enhanced coupling parameters 1 exists
- int ecplparam2e[AC3_MAX_CHANNELS]; ///< Enhanced coupling parameters 2 exists
- int ecplamp[AC3_MAX_CHANNELS][23]; ///< Enhanced coupling amplitude scaling
- int ecplangle[AC3_MAX_CHANNELS][23]; ///< Enhanced coupling angle
- int ecplchaos[AC3_MAX_CHANNELS][23]; ///< Enhanced coupling chaos
- int ecpltrans[AC3_MAX_CHANNELS]; ///< Enhanced coupling transient present
+///@defgroup ecpl enhanced coupling
+ int ecpl_in_use; ///< enhanced coupling in use
+ int ecplbegf; ///< enhanced coupling begin frequency code
+ int ecplendf; ///< enhanced coupling end frequency code
+ int ecpl_start_subbnd; ///< enhanced coupling begin frequency
+ int ecpl_end_subbnd; ///< enhanced coupling end frequency
+ int necplbnd; ///< number of structured enhanced coupling bands
+ int ecplbndstrc[23]; ///< enhanced coupling band structure
+ int ecplangleintrp; ///< enhanced coupling angle interpolation flag
+ int ecplparam1e[AC3_MAX_CHANNELS]; ///< enhanced coupling parameters 1 exists
+ int ecplparam2e[AC3_MAX_CHANNELS]; ///< enhanced coupling parameters 2 exists
+ int ecplamp[AC3_MAX_CHANNELS][23]; ///< enhanced coupling amplitude scaling
+ int ecplangle[AC3_MAX_CHANNELS][23]; ///< enhanced coupling angle
+ int ecplchaos[AC3_MAX_CHANNELS][23]; ///< enhanced coupling chaos
+ int ecpltrans[AC3_MAX_CHANNELS]; ///< enhanced coupling transient present
///@}
#endif
-///@defgroup channel Channel
- int fbw_channels; ///< Number of fbw channels
- int channels; ///< Total of all channels
- int lfe_ch; ///< Index of LFE channel
+///@defgroup channel channel
+ int fbw_channels; ///< number of full bandwidth channels
+ int channels; ///< total of all channels
+ int lfe_ch; ///< index of LFE channel
float downmix_coeffs[AC3_MAX_CHANNELS][2]; ///< stereo downmix coefficients
float downmix_coeff_adjust[2]; ///< adjustment needed for each output channel when downmixing
int downmixed; ///< indicates if transform coeffs are currently downmixed
@@ -150,55 +150,55 @@ typedef struct AC3DecodeContext {
int out_channels; ///< number of output channels
///@}
-///@defgroup dynrng Dynamic Range
- float dynamic_range[2]; ///< Dynamic range gain (dynrng)
+///@defgroup dynrng dynamic range
+ float dynamic_range[2]; ///< dynamic range gain (dynrng)
///@}
-///@defgroup bandwidth Bandwidth
- int start_freq[AC3_MAX_CHANNELS]; ///< Start frequency bin (strtmant)
- int end_freq[AC3_MAX_CHANNELS]; ///< End frequency bin (endmant)
+///@defgroup bandwidth bandwidth
+ int start_freq[AC3_MAX_CHANNELS]; ///< start frequency bin (strtmant)
+ int end_freq[AC3_MAX_CHANNELS]; ///< end frequency bin (endmant)
///@}
-///@defgroup rematrixing Rematrixing
- int num_rematrixing_bands; ///< Number of rematrixing bands (nrematbnds)
- int rematrixing_flags[4]; ///< Rematrixing flags (rematflg)
+///@defgroup rematrixing rematrixing
+ int num_rematrixing_bands; ///< number of rematrixing bands (nrematbnds)
+ int rematrixing_flags[4]; ///< rematrixing flags (rematflg)
///@}
-///@defgroup exponents Exponents
- int num_exp_groups[AC3_MAX_CHANNELS]; ///< Number of exponent groups
- uint8_t dexps[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< Differential exponents
- int exp_strategy[MAX_BLOCKS][AC3_MAX_CHANNELS]; ///< Channel exponent strategy (chexpstr)
+///@defgroup exponents exponents
+ int num_exp_groups[AC3_MAX_CHANNELS]; ///< number of exponent groups
+ uint8_t dexps[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< differential exponents
+ int exp_strategy[MAX_BLOCKS][AC3_MAX_CHANNELS]; ///< channel exponent strategy (chexpstr)
///@}
-///@defgroup bitalloc Bit Allocation
- AC3BitAllocParameters bit_alloc_params; ///< Bit allocation parameters
- int first_cpl_leak; ///< First coupling leak state (firstcplleak)
+///@defgroup bitalloc bit allocation
+ AC3BitAllocParameters bit_alloc_params; ///< bit allocation parameters
+ int first_cpl_leak; ///< first coupling leak state (firstcplleak)
int snr_offset[AC3_MAX_CHANNELS]; ///< SNR offset (snroffst)
- int fast_gain[AC3_MAX_CHANNELS]; ///< Channel fast gain (fgain)
+ int fast_gain[AC3_MAX_CHANNELS]; ///< channel fast gain (fgain)
uint8_t bap[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< bit allocation pointers
int16_t psd[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< scaled exponents
int16_t band_psd[AC3_MAX_CHANNELS][50]; ///< interpolated exponents (bndpsd)
int16_t mask[AC3_MAX_CHANNELS][50]; ///< masking values
- uint8_t dba_mode[AC3_MAX_CHANNELS]; ///< Delta bit allocation mode (deltbae)
- uint8_t dba_nsegs[AC3_MAX_CHANNELS]; ///< Number of delta segments (deltnseg)
- uint8_t dba_offsets[AC3_MAX_CHANNELS][9]; ///< Delta segment offsets (deltoffst)
- uint8_t dba_lengths[AC3_MAX_CHANNELS][9]; ///< Delta segment lengths (deltlen)
- uint8_t dba_values[AC3_MAX_CHANNELS][9]; ///< Delta values for each segment (deltba)
+ uint8_t dba_mode[AC3_MAX_CHANNELS]; ///< delta bit allocation mode (deltbae)
+ uint8_t dba_nsegs[AC3_MAX_CHANNELS]; ///< number of delta segments (deltnseg)
+ uint8_t dba_offsets[AC3_MAX_CHANNELS][9]; ///< delta segment offsets (deltoffst)
+ uint8_t dba_lengths[AC3_MAX_CHANNELS][9]; ///< delta segment lengths (deltlen)
+ uint8_t dba_values[AC3_MAX_CHANNELS][9]; ///< delta values for each segment (deltba)
///@}
-///@defgroup dithering Zero-Mantissa Dithering
- int dither_all; ///< Indicates whether all channels use dithering
- int dither_flag[AC3_MAX_CHANNELS]; ///< Dither flag (dithflag)
+///@defgroup dithering zero-mantissa dithering
+ int dither_all; ///< indicates whether all channels use dithering
+ int dither_flag[AC3_MAX_CHANNELS]; ///< dither flag (dithflag)
AVRandomState dith_state; ///< for dither generation
///@}
///@defgroup imdct IMDCT
- int block_switch[AC3_MAX_CHANNELS]; ///< Block switch flag (blksw)
+ int block_switch[AC3_MAX_CHANNELS]; ///< block switch flag (blksw)
MDCTContext imdct_512; ///< for 512 sample imdct transform
MDCTContext imdct_256; ///< for 256 sample imdct transform
///@}
-///@defgroup opt Optimization
+///@defgroup opt optimization
DSPContext dsp; ///< for optimization
float add_bias; ///< offset for float_to_int16 conversion
float mul_bias; ///< scaling for float_to_int16 conversion
@@ -206,13 +206,13 @@ typedef struct AC3DecodeContext {
int fixed_coeffs[AC3_MAX_CHANNELS][256]; ///< fixed-point transform coefficients
-///@defgroup arrays Aligned Arrays
- DECLARE_ALIGNED_16(float, transform_coeffs[AC3_MAX_CHANNELS][AC3_MAX_COEFS]); ///< Frequency Coefficients
+///@defgroup arrays aligned arrays
+ DECLARE_ALIGNED_16(float, transform_coeffs[AC3_MAX_CHANNELS][AC3_MAX_COEFS]); ///< frequency coefficients
DECLARE_ALIGNED_16(float, delay[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE]); ///< delay - added to the next block
DECLARE_ALIGNED_16(float, window[AC3_BLOCK_SIZE]); ///< window coefficients
DECLARE_ALIGNED_16(float, tmp_output[AC3_BLOCK_SIZE * 24]); ///< temp storage for output before windowing
DECLARE_ALIGNED_16(float, tmp_imdct[AC3_BLOCK_SIZE * 24]); ///< temp storage for imdct transform
- DECLARE_ALIGNED_16(float, output[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE]); ///< output after imdct transform and windowing
+ DECLARE_ALIGNED_16(float, output[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE]); ///< output after IMDCT transform and windowing
DECLARE_ALIGNED_16(int16_t, int_output[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE]); ///< final 16-bit integer output
///@}
} AC3DecodeContext;
More information about the FFmpeg-soc
mailing list