diff options
| author | Justin Ruggles <justin.ruggles@gmail.com> | 2011-11-02 10:38:10 -0400 |
|---|---|---|
| committer | Justin Ruggles <justin.ruggles@gmail.com> | 2011-11-02 17:21:45 -0400 |
| commit | c2d9a65bc08cdb61f13b4101c5bbec7b86d30f9f (patch) | |
| tree | 897225de9244795d8f3c4af2beffb8214d5c573c /libavcodec/ac3enc_float.c | |
| parent | a4998e448f517a825fdc87e95e6c103223480867 (diff) | |
| download | ffmpeg-c2d9a65bc08cdb61f13b4101c5bbec7b86d30f9f.tar.gz | |
ac3enc: doxygen update.
Add some parameters to existing function documentation.
Remove some unneeded documentation.
Convert some static function documentation to non-doxygen style.
Diffstat (limited to 'libavcodec/ac3enc_float.c')
| -rw-r--r-- | libavcodec/ac3enc_float.c | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/libavcodec/ac3enc_float.c b/libavcodec/ac3enc_float.c index 598c69db1b..a4abd89d4d 100644 --- a/libavcodec/ac3enc_float.c +++ b/libavcodec/ac3enc_float.c @@ -44,6 +44,8 @@ static const AVClass ac3enc_class = { "AC-3 Encoder", av_default_item_name, /** * Finalize MDCT and free allocated memory. + * + * @param s AC-3 encoder private context */ av_cold void ff_ac3_float_mdct_end(AC3EncodeContext *s) { @@ -54,7 +56,9 @@ av_cold void ff_ac3_float_mdct_end(AC3EncodeContext *s) /** * Initialize MDCT tables. - * @param nbits log2(MDCT size) + * + * @param s AC-3 encoder private context + * @return 0 on success, negative error code on failure */ av_cold int ff_ac3_float_mdct_init(AC3EncodeContext *s) { @@ -78,7 +82,7 @@ av_cold int ff_ac3_float_mdct_init(AC3EncodeContext *s) } -/** +/* * Apply KBD window to input samples prior to MDCT. */ static void apply_window(DSPContext *dsp, float *output, const float *input, @@ -88,7 +92,7 @@ static void apply_window(DSPContext *dsp, float *output, const float *input, } -/** +/* * Normalize the input samples. * Not needed for the floating-point encoder. */ @@ -98,7 +102,7 @@ static int normalize_samples(AC3EncodeContext *s) } -/** +/* * Scale MDCT coefficients from float to 24-bit fixed-point. */ static void scale_coefficients(AC3EncodeContext *s) @@ -111,7 +115,7 @@ static void scale_coefficients(AC3EncodeContext *s) } -/** +/* * Clip MDCT coefficients to allowable range. */ static void clip_coefficients(DSPContext *dsp, float *coef, unsigned int len) @@ -120,7 +124,7 @@ static void clip_coefficients(DSPContext *dsp, float *coef, unsigned int len) } -/** +/* * Calculate a single coupling coordinate. */ static CoefType calc_cpl_coord(CoefSumType energy_ch, CoefSumType energy_cpl) |