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_fixed.c | |
| parent | a4998e448f517a825fdc87e95e6c103223480867 (diff) | |
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_fixed.c')
| -rw-r--r-- | libavcodec/ac3enc_fixed.c | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/libavcodec/ac3enc_fixed.c b/libavcodec/ac3enc_fixed.c index adb735279d..202dfb8afd 100644 --- a/libavcodec/ac3enc_fixed.c +++ b/libavcodec/ac3enc_fixed.c @@ -41,6 +41,8 @@ static const AVClass ac3enc_class = { "Fixed-Point AC-3 Encoder", av_default_ite /** * Finalize MDCT and free allocated memory. + * + * @param s AC-3 encoder private context */ av_cold void AC3_NAME(mdct_end)(AC3EncodeContext *s) { @@ -50,7 +52,9 @@ av_cold void AC3_NAME(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 AC3_NAME(mdct_init)(AC3EncodeContext *s) { @@ -60,7 +64,7 @@ av_cold int AC3_NAME(mdct_init)(AC3EncodeContext *s) } -/** +/* * Apply KBD window to input samples prior to MDCT. */ static void apply_window(DSPContext *dsp, int16_t *output, const int16_t *input, @@ -70,11 +74,9 @@ static void apply_window(DSPContext *dsp, int16_t *output, const int16_t *input, } -/** +/* * Normalize the input samples to use the maximum available precision. * This assumes signed 16-bit input samples. - * - * @return exponent shift */ static int normalize_samples(AC3EncodeContext *s) { @@ -87,7 +89,7 @@ static int normalize_samples(AC3EncodeContext *s) } -/** +/* * Scale MDCT coefficients to 25-bit signed fixed-point. */ static void scale_coefficients(AC3EncodeContext *s) @@ -104,7 +106,7 @@ static void scale_coefficients(AC3EncodeContext *s) } -/** +/* * Clip MDCT coefficients to allowable range. */ static void clip_coefficients(DSPContext *dsp, int32_t *coef, unsigned int len) @@ -113,7 +115,7 @@ static void clip_coefficients(DSPContext *dsp, int32_t *coef, unsigned int len) } -/** +/* * Calculate a single coupling coordinate. */ static CoefType calc_cpl_coord(CoefSumType energy_ch, CoefSumType energy_cpl) |