Commit adbfc605 authored by Diego Biurrun's avatar Diego Biurrun
Browse files

doxygen: Consistently use '@' instead of '\' for Doxygen markup.


Signed-off-by: default avatarDiego Biurrun <diego@biurrun.de>
parent 9abbe8cc
...@@ -30,11 +30,11 @@ ...@@ -30,11 +30,11 @@
#define PITCH_DELAY_MAX 143 #define PITCH_DELAY_MAX 143
/** /**
* \brief Decode pitch delay of the first subframe encoded by 8 bits with 1/3 * @brief Decode pitch delay of the first subframe encoded by 8 bits with 1/3
* resolution. * resolution.
* \param ac_index adaptive codebook index (8 bits) * @param ac_index adaptive codebook index (8 bits)
* *
* \return pitch delay in 1/3 units * @return pitch delay in 1/3 units
* *
* Pitch delay is coded: * Pitch delay is coded:
* with 1/3 resolution, 19 < pitch_delay < 85 * with 1/3 resolution, 19 < pitch_delay < 85
...@@ -43,18 +43,18 @@ ...@@ -43,18 +43,18 @@
int ff_acelp_decode_8bit_to_1st_delay3(int ac_index); int ff_acelp_decode_8bit_to_1st_delay3(int ac_index);
/** /**
* \brief Decode pitch delay of the second subframe encoded by 5 or 6 bits * @brief Decode pitch delay of the second subframe encoded by 5 or 6 bits
* with 1/3 precision. * with 1/3 precision.
* \param ac_index adaptive codebook index (5 or 6 bits) * @param ac_index adaptive codebook index (5 or 6 bits)
* \param pitch_delay_min lower bound (integer) of pitch delay interval * @param pitch_delay_min lower bound (integer) of pitch delay interval
* for second subframe * for second subframe
* *
* \return pitch delay in 1/3 units * @return pitch delay in 1/3 units
* *
* Pitch delay is coded: * Pitch delay is coded:
* with 1/3 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5 * with 1/3 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5
* *
* \remark The routine is used in G.729 @@8k, AMR @@10.2k, AMR @@7.95k, * @remark The routine is used in G.729 @@8k, AMR @@10.2k, AMR @@7.95k,
* AMR @@7.4k for the second subframe. * AMR @@7.4k for the second subframe.
*/ */
int ff_acelp_decode_5_6_bit_to_2nd_delay3( int ff_acelp_decode_5_6_bit_to_2nd_delay3(
...@@ -62,19 +62,19 @@ int ff_acelp_decode_5_6_bit_to_2nd_delay3( ...@@ -62,19 +62,19 @@ int ff_acelp_decode_5_6_bit_to_2nd_delay3(
int pitch_delay_min); int pitch_delay_min);
/** /**
* \brief Decode pitch delay with 1/3 precision. * @brief Decode pitch delay with 1/3 precision.
* \param ac_index adaptive codebook index (4 bits) * @param ac_index adaptive codebook index (4 bits)
* \param pitch_delay_min lower bound (integer) of pitch delay interval for * @param pitch_delay_min lower bound (integer) of pitch delay interval for
* second subframe * second subframe
* *
* \return pitch delay in 1/3 units * @return pitch delay in 1/3 units
* *
* Pitch delay is coded: * Pitch delay is coded:
* integers only, -6 < pitch_delay - int(prev_pitch_delay) <= -2 * integers only, -6 < pitch_delay - int(prev_pitch_delay) <= -2
* with 1/3 resolution, -2 < pitch_delay - int(prev_pitch_delay) < 1 * with 1/3 resolution, -2 < pitch_delay - int(prev_pitch_delay) < 1
* integers only, 1 <= pitch_delay - int(prev_pitch_delay) < 5 * integers only, 1 <= pitch_delay - int(prev_pitch_delay) < 5
* *
* \remark The routine is used in G.729 @@6.4k, AMR @@6.7k, AMR @@5.9k, * @remark The routine is used in G.729 @@6.4k, AMR @@6.7k, AMR @@5.9k,
* AMR @@5.15k, AMR @@4.75k for the second subframe. * AMR @@5.15k, AMR @@4.75k for the second subframe.
*/ */
int ff_acelp_decode_4bit_to_2nd_delay3( int ff_acelp_decode_4bit_to_2nd_delay3(
...@@ -82,44 +82,44 @@ int ff_acelp_decode_4bit_to_2nd_delay3( ...@@ -82,44 +82,44 @@ int ff_acelp_decode_4bit_to_2nd_delay3(
int pitch_delay_min); int pitch_delay_min);
/** /**
* \brief Decode pitch delay of the first subframe encoded by 9 bits * @brief Decode pitch delay of the first subframe encoded by 9 bits
* with 1/6 precision. * with 1/6 precision.
* \param ac_index adaptive codebook index (9 bits) * @param ac_index adaptive codebook index (9 bits)
* *
* \return pitch delay in 1/6 units * @return pitch delay in 1/6 units
* *
* Pitch delay is coded: * Pitch delay is coded:
* with 1/6 resolution, 17 < pitch_delay < 95 * with 1/6 resolution, 17 < pitch_delay < 95
* integers only, 95 <= pitch_delay <= 143 * integers only, 95 <= pitch_delay <= 143
* *
* \remark The routine is used in AMR @@12.2k for the first and third subframes. * @remark The routine is used in AMR @@12.2k for the first and third subframes.
*/ */
int ff_acelp_decode_9bit_to_1st_delay6(int ac_index); int ff_acelp_decode_9bit_to_1st_delay6(int ac_index);
/** /**
* \brief Decode pitch delay of the second subframe encoded by 6 bits * @brief Decode pitch delay of the second subframe encoded by 6 bits
* with 1/6 precision. * with 1/6 precision.
* \param ac_index adaptive codebook index (6 bits) * @param ac_index adaptive codebook index (6 bits)
* \param pitch_delay_min lower bound (integer) of pitch delay interval for * @param pitch_delay_min lower bound (integer) of pitch delay interval for
* second subframe * second subframe
* *
* \return pitch delay in 1/6 units * @return pitch delay in 1/6 units
* *
* Pitch delay is coded: * Pitch delay is coded:
* with 1/6 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5 * with 1/6 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5
* *
* \remark The routine is used in AMR @@12.2k for the second and fourth subframes. * @remark The routine is used in AMR @@12.2k for the second and fourth subframes.
*/ */
int ff_acelp_decode_6bit_to_2nd_delay6( int ff_acelp_decode_6bit_to_2nd_delay6(
int ac_index, int ac_index,
int pitch_delay_min); int pitch_delay_min);
/** /**
* \brief Update past quantized energies * @brief Update past quantized energies
* \param[in,out] quant_energy past quantized energies (5.10) * @param[in,out] quant_energy past quantized energies (5.10)
* \param gain_corr_factor gain correction factor * @param gain_corr_factor gain correction factor
* \param log2_ma_pred_order log2() of MA prediction order * @param log2_ma_pred_order log2() of MA prediction order
* \param erasure frame erasure flag * @param erasure frame erasure flag
* *
* If frame erasure flag is not equal to zero, memory is updated with * If frame erasure flag is not equal to zero, memory is updated with
* averaged energy, attenuated by 4dB: * averaged energy, attenuated by 4dB:
...@@ -128,7 +128,7 @@ int ff_acelp_decode_6bit_to_2nd_delay6( ...@@ -128,7 +128,7 @@ int ff_acelp_decode_6bit_to_2nd_delay6(
* In normal mode memory is updated with * In normal mode memory is updated with
* Er - Ep = 20 * log10(gain_corr_factor) * Er - Ep = 20 * log10(gain_corr_factor)
* *
* \remark The routine is used in G.729 and AMR (all modes). * @remark The routine is used in G.729 and AMR (all modes).
*/ */
void ff_acelp_update_past_gain( void ff_acelp_update_past_gain(
int16_t* quant_energy, int16_t* quant_energy,
...@@ -137,16 +137,16 @@ void ff_acelp_update_past_gain( ...@@ -137,16 +137,16 @@ void ff_acelp_update_past_gain(
int erasure); int erasure);
/** /**
* \brief Decode the adaptive codebook gain and add * @brief Decode the adaptive codebook gain and add
* correction (4.1.5 and 3.9.1 of G.729). * correction (4.1.5 and 3.9.1 of G.729).
* \param dsp initialized dsputil context * @param dsp initialized dsputil context
* \param gain_corr_factor gain correction factor (2.13) * @param gain_corr_factor gain correction factor (2.13)
* \param fc_v fixed-codebook vector (2.13) * @param fc_v fixed-codebook vector (2.13)
* \param mr_energy mean innovation energy and fixed-point correction (7.13) * @param mr_energy mean innovation energy and fixed-point correction (7.13)
* \param[in,out] quant_energy past quantized energies (5.10) * @param[in,out] quant_energy past quantized energies (5.10)
* \param subframe_size length of subframe * @param subframe_size length of subframe
* *
* \return quantized fixed-codebook gain (14.1) * @return quantized fixed-codebook gain (14.1)
* *
* The routine implements equations 69, 66 and 71 of the G.729 specification (3.9.1) * The routine implements equations 69, 66 and 71 of the G.729 specification (3.9.1)
* *
...@@ -205,7 +205,7 @@ void ff_acelp_update_past_gain( ...@@ -205,7 +205,7 @@ void ff_acelp_update_past_gain(
* *
* mr_energy = Em + 10log(N) + 10log(2^26) * mr_energy = Em + 10log(N) + 10log(2^26)
* *
* \remark The routine is used in G.729 and AMR (all modes). * @remark The routine is used in G.729 and AMR (all modes).
*/ */
int16_t ff_acelp_decode_gain_code( int16_t ff_acelp_decode_gain_code(
DSPContext *dsp, DSPContext *dsp,
......
...@@ -3255,7 +3255,7 @@ void av_resample_close(struct AVResampleContext *c); ...@@ -3255,7 +3255,7 @@ void av_resample_close(struct AVResampleContext *c);
/** /**
* Allocate memory for a picture. Call avpicture_free() to free it. * Allocate memory for a picture. Call avpicture_free() to free it.
* *
* \see avpicture_fill() * @see avpicture_fill()
* *
* @param picture the picture to be filled in * @param picture the picture to be filled in
* @param pix_fmt the format of the picture * @param pix_fmt the format of the picture
...@@ -3302,7 +3302,7 @@ int avpicture_fill(AVPicture *picture, uint8_t *ptr, ...@@ -3302,7 +3302,7 @@ int avpicture_fill(AVPicture *picture, uint8_t *ptr,
* The data is stored compactly, without any gaps for alignment or padding * The data is stored compactly, without any gaps for alignment or padding
* which may be applied by avpicture_fill(). * which may be applied by avpicture_fill().
* *
* \see avpicture_get_size() * @see avpicture_get_size()
* *
* @param[in] src AVPicture containing image data * @param[in] src AVPicture containing image data
* @param[in] pix_fmt The format in which the picture data is stored. * @param[in] pix_fmt The format in which the picture data is stored.
...@@ -3896,7 +3896,7 @@ typedef struct AVCodecParserContext { ...@@ -3896,7 +3896,7 @@ typedef struct AVCodecParserContext {
int64_t offset; ///< byte offset from starting packet start int64_t offset; ///< byte offset from starting packet start
int64_t cur_frame_end[AV_PARSER_PTS_NB]; int64_t cur_frame_end[AV_PARSER_PTS_NB];
/*! /**
* Set by parser to 1 for key frames and 0 for non-key frames. * Set by parser to 1 for key frames and 0 for non-key frames.
* It is initialized to -1, so if the parser doesn't set this flag, * It is initialized to -1, so if the parser doesn't set this flag,
* old-style fallback using AV_PICTURE_TYPE_I picture type as key frames * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
......
...@@ -34,7 +34,7 @@ ...@@ -34,7 +34,7 @@
* *
* fc_out[n] = sum(i,0,len-1){ fc_in[i] * filter[(len + n - i)%len] } * fc_out[n] = sum(i,0,len-1){ fc_in[i] * filter[(len + n - i)%len] }
* *
* \note fc_in and fc_out should not overlap! * @note fc_in and fc_out should not overlap!
*/ */
void ff_celp_convolve_circ(int16_t *fc_out, const int16_t *fc_in, void ff_celp_convolve_circ(int16_t *fc_out, const int16_t *fc_in,
const int16_t *filter, int len); const int16_t *filter, int len);
......
...@@ -119,7 +119,7 @@ extern COSTABLE_CONST FFTSample* const FFT_NAME(ff_cos_tabs)[17]; ...@@ -119,7 +119,7 @@ extern COSTABLE_CONST FFTSample* const FFT_NAME(ff_cos_tabs)[17];
/** /**
* Initialize the cosine table in ff_cos_tabs[index] * Initialize the cosine table in ff_cos_tabs[index]
* \param index index in ff_cos_tabs array of the table to initialize * @param index index in ff_cos_tabs array of the table to initialize
*/ */
void ff_init_ff_cos_tabs(int index); void ff_init_ff_cos_tabs(int index);
......
...@@ -116,7 +116,7 @@ static const G729FormatDescription format_g729d_6k4 = { ...@@ -116,7 +116,7 @@ static const G729FormatDescription format_g729d_6k4 = {
}; };
/** /**
* \brief pseudo random number generator * @brief pseudo random number generator
*/ */
static inline uint16_t g729_prng(uint16_t value) static inline uint16_t g729_prng(uint16_t value)
{ {
......
...@@ -97,7 +97,7 @@ found: ...@@ -97,7 +97,7 @@ found:
return i-(state&5); return i-(state&5);
} }
/*! /**
* Parse NAL units of found picture and decode some basic information. * Parse NAL units of found picture and decode some basic information.
* *
* @param s parser context. * @param s parser context.
......
...@@ -32,25 +32,25 @@ ...@@ -32,25 +32,25 @@
#include "lagarithrac.h" #include "lagarithrac.h"
enum LagarithFrameType { enum LagarithFrameType {
FRAME_RAW = 1, /*!< uncompressed */ FRAME_RAW = 1, /**< uncompressed */
FRAME_U_RGB24 = 2, /*!< unaligned RGB24 */ FRAME_U_RGB24 = 2, /**< unaligned RGB24 */
FRAME_ARITH_YUY2 = 3, /*!< arithmetic coded YUY2 */ FRAME_ARITH_YUY2 = 3, /**< arithmetic coded YUY2 */
FRAME_ARITH_RGB24 = 4, /*!< arithmetic coded RGB24 */ FRAME_ARITH_RGB24 = 4, /**< arithmetic coded RGB24 */
FRAME_SOLID_GRAY = 5, /*!< solid grayscale color frame */ FRAME_SOLID_GRAY = 5, /**< solid grayscale color frame */
FRAME_SOLID_COLOR = 6, /*!< solid non-grayscale color frame */ FRAME_SOLID_COLOR = 6, /**< solid non-grayscale color frame */
FRAME_OLD_ARITH_RGB = 7, /*!< obsolete arithmetic coded RGB (no longer encoded by upstream since version 1.1.0) */ FRAME_OLD_ARITH_RGB = 7, /**< obsolete arithmetic coded RGB (no longer encoded by upstream since version 1.1.0) */
FRAME_ARITH_RGBA = 8, /*!< arithmetic coded RGBA */ FRAME_ARITH_RGBA = 8, /**< arithmetic coded RGBA */
FRAME_SOLID_RGBA = 9, /*!< solid RGBA color frame */ FRAME_SOLID_RGBA = 9, /**< solid RGBA color frame */
FRAME_ARITH_YV12 = 10, /*!< arithmetic coded YV12 */ FRAME_ARITH_YV12 = 10, /**< arithmetic coded YV12 */
FRAME_REDUCED_RES = 11, /*!< reduced resolution YV12 frame */ FRAME_REDUCED_RES = 11, /**< reduced resolution YV12 frame */
}; };
typedef struct LagarithContext { typedef struct LagarithContext {
AVCodecContext *avctx; AVCodecContext *avctx;
AVFrame picture; AVFrame picture;
DSPContext dsp; DSPContext dsp;
int zeros; /*!< number of consecutive zero bytes encountered */ int zeros; /**< number of consecutive zero bytes encountered */
int zeros_rem; /*!< number of zero bytes remaining to output */ int zeros_rem; /**< number of zero bytes remaining to output */
} LagarithContext; } LagarithContext;
/** /**
......
...@@ -40,15 +40,15 @@ typedef struct lag_rac { ...@@ -40,15 +40,15 @@ typedef struct lag_rac {
AVCodecContext *avctx; AVCodecContext *avctx;
unsigned low; unsigned low;
unsigned range; unsigned range;
unsigned scale; /*!< Number of bits of precision in range. */ unsigned scale; /**< Number of bits of precision in range. */
unsigned hash_shift; /*!< Number of bits to shift to calculate hash for radix search. */ unsigned hash_shift; /**< Number of bits to shift to calculate hash for radix search. */
const uint8_t *bytestream_start; /*!< Start of input bytestream. */ const uint8_t *bytestream_start; /**< Start of input bytestream. */
const uint8_t *bytestream; /*!< Current position in input bytestream. */ const uint8_t *bytestream; /**< Current position in input bytestream. */
const uint8_t *bytestream_end; /*!< End position of input bytestream. */ const uint8_t *bytestream_end; /**< End position of input bytestream. */
uint32_t prob[258]; /*!< Table of cumulative probability for each symbol. */ uint32_t prob[258]; /**< Table of cumulative probability for each symbol. */
uint8_t range_hash[256]; /*!< Hash table mapping upper byte to approximate symbol. */ uint8_t range_hash[256]; /**< Hash table mapping upper byte to approximate symbol. */
} lag_rac; } lag_rac;
void lag_rac_init(lag_rac *l, GetBitContext *gb, int length); void lag_rac_init(lag_rac *l, GetBitContext *gb, int length);
......
...@@ -73,8 +73,8 @@ typedef struct LclDecContext { ...@@ -73,8 +73,8 @@ typedef struct LclDecContext {
/** /**
* \param srcptr compressed source buffer, must be padded with at least 5 extra bytes * @param srcptr compressed source buffer, must be padded with at least 5 extra bytes
* \param destptr must be padded sufficiently for av_memcpy_backptr * @param destptr must be padded sufficiently for av_memcpy_backptr
*/ */
static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize) static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize)
{ {
...@@ -119,11 +119,11 @@ static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsign ...@@ -119,11 +119,11 @@ static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsign
#if CONFIG_ZLIB_DECODER #if CONFIG_ZLIB_DECODER
/** /**
* \brief decompress a zlib-compressed data block into decomp_buf * @brief decompress a zlib-compressed data block into decomp_buf
* \param src compressed input buffer * @param src compressed input buffer
* \param src_len data length in input buffer * @param src_len data length in input buffer
* \param offset offset in decomp_buf * @param offset offset in decomp_buf
* \param expected expected decompressed length * @param expected expected decompressed length
*/ */
static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected) static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
{ {
......
...@@ -74,9 +74,9 @@ void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order) ...@@ -74,9 +74,9 @@ void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order)
} }
/** /**
* \brief decodes polynomial coefficients from LSP * @brief decodes polynomial coefficients from LSP
* \param f [out] decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff) * @param f [out] decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
* \param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff) * @param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff)
*/ */
static void lsp2poly(int* f, const int16_t* lsp, int lp_half_order) static void lsp2poly(int* f, const int16_t* lsp, int lp_half_order)
{ {
......
...@@ -30,12 +30,12 @@ ...@@ -30,12 +30,12 @@
*/ */
/** /**
* \brief ensure a minimum distance between LSFs * @brief ensure a minimum distance between LSFs
* \param[in,out] lsfq LSF to check and adjust * @param[in,out] lsfq LSF to check and adjust
* \param lsfq_min_distance minimum distance between LSFs * @param lsfq_min_distance minimum distance between LSFs
* \param lsfq_min minimum allowed LSF value * @param lsfq_min minimum allowed LSF value
* \param lsfq_max maximum allowed LSF value * @param lsfq_max maximum allowed LSF value
* \param lp_order LP filter order * @param lp_order LP filter order
*/ */
void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, int lsfq_max, int lp_order); void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, int lsfq_max, int lp_order);
...@@ -53,12 +53,12 @@ void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, in ...@@ -53,12 +53,12 @@ void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, in
void ff_set_min_dist_lsf(float *lsf, double min_spacing, int size); void ff_set_min_dist_lsf(float *lsf, double min_spacing, int size);
/** /**
* \brief Convert LSF to LSP * @brief Convert LSF to LSP
* \param[out] lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000) * @param[out] lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
* \param lsf normalized LSF coefficients (0 <= (2.13) < 0x2000 * PI) * @param lsf normalized LSF coefficients (0 <= (2.13) < 0x2000 * PI)
* \param lp_order LP filter order * @param lp_order LP filter order
* *
* \remark It is safe to pass the same array into the lsf and lsp parameters. * @remark It is safe to pass the same array into the lsf and lsp parameters.
*/ */
void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *lsf, int lp_order); void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *lsf, int lp_order);
...@@ -68,10 +68,10 @@ void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *lsf, int lp_order); ...@@ -68,10 +68,10 @@ void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *lsf, int lp_order);
void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order); void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order);
/** /**
* \brief LSP to LP conversion (3.2.6 of G.729) * @brief LSP to LP conversion (3.2.6 of G.729)
* \param[out] lp decoded LP coefficients (-0x8000 <= (3.12) < 0x8000) * @param[out] lp decoded LP coefficients (-0x8000 <= (3.12) < 0x8000)
* \param lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000) * @param lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
* \param lp_half_order LP filter order, divided by 2 * @param lp_half_order LP filter order, divided by 2
*/ */
void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_order); void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_order);
...@@ -81,12 +81,12 @@ void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_order); ...@@ -81,12 +81,12 @@ void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_order);
void ff_amrwb_lsp2lpc(const double *lsp, float *lp, int lp_order); void ff_amrwb_lsp2lpc(const double *lsp, float *lp, int lp_order);
/** /**
* \brief Interpolate LSP for the first subframe and convert LSP -> LP for both subframes (3.2.5 and 3.2.6 of G.729) * @brief Interpolate LSP for the first subframe and convert LSP -> LP for both subframes (3.2.5 and 3.2.6 of G.729)
* \param[out] lp_1st decoded LP coefficients for first subframe (-0x8000 <= (3.12) < 0x8000) * @param[out] lp_1st decoded LP coefficients for first subframe (-0x8000 <= (3.12) < 0x8000)
* \param[out] lp_2nd decoded LP coefficients for second subframe (-0x8000 <= (3.12) < 0x8000) * @param[out] lp_2nd decoded LP coefficients for second subframe (-0x8000 <= (3.12) < 0x8000)
* \param lsp_2nd LSP coefficients of the second subframe (-0x8000 <= (0.15) < 0x8000) * @param lsp_2nd LSP coefficients of the second subframe (-0x8000 <= (0.15) < 0x8000)
* \param lsp_prev LSP coefficients from the second subframe of the previous frame (-0x8000 <= (0.15) < 0x8000) * @param lsp_prev LSP coefficients from the second subframe of the previous frame (-0x8000 <= (0.15) < 0x8000)
* \param lp_order LP filter order * @param lp_order LP filter order
*/ */
void ff_acelp_lp_decode(int16_t* lp_1st, int16_t* lp_2nd, const int16_t* lsp_2nd, const int16_t* lsp_prev, int lp_order); void ff_acelp_lp_decode(int16_t* lp_1st, int16_t* lp_2nd, const int16_t* lsp_2nd, const int16_t* lsp_prev, int lp_order);
......
...@@ -248,7 +248,7 @@ static int cmp_internal(MpegEncContext *s, const int x, const int y, const int s ...@@ -248,7 +248,7 @@ static int cmp_internal(MpegEncContext *s, const int x, const int y, const int s
} }
} }
/*! \brief compares a block (either a full macroblock or a partition thereof) /** @brief compares a block (either a full macroblock or a partition thereof)
against a proposed motion-compensated prediction of that block against a proposed motion-compensated prediction of that block
*/ */
static av_always_inline int cmp(MpegEncContext *s, const int x, const int y, const int subx, const int suby, static av_always_inline int cmp(MpegEncContext *s, const int x, const int y, const int subx, const int suby,
......
...@@ -990,8 +990,8 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm ...@@ -990,8 +990,8 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm
return var_diamond_search(s, best, dmin, src_index, ref_index, penalty_factor, size, h, flags); return var_diamond_search(s, best, dmin, src_index, ref_index, penalty_factor, size, h, flags);
} }
/*! /**
\param P[10][2] a list of candidate mvs to check before starting the @param P[10][2] a list of candidate mvs to check before starting the
iterative search. If one of the candidates is close to the optimal mv, then iterative search. If one of the candidates is close to the optimal mv, then
it takes fewer iterations. And it increases the chance that we find the it takes fewer iterations. And it increases the chance that we find the
optimal mv. optimal mv.
...@@ -1001,12 +1001,12 @@ static av_always_inline int epzs_motion_search_internal(MpegEncContext * s, int ...@@ -1001,12 +1001,12 @@ static av_always_inline int epzs_motion_search_internal(MpegEncContext * s, int
int ref_mv_scale, int flags, int size, int h) int ref_mv_scale, int flags, int size, int h)
{ {
MotionEstContext * const c= &s->me; MotionEstContext * const c= &s->me;
int best[2]={0, 0}; /*!< x and y coordinates of the best motion vector. int best[2]={0, 0}; /**< x and y coordinates of the best motion vector.
i.e. the difference between the position of the i.e. the difference between the position of the
block currently being encoded and the position of block currently being encoded and the position of
the block chosen to predict it from. */ the block chosen to predict it from. */
int d; ///< the score (cmp + penalty) of any given mv int d; ///< the score (cmp + penalty) of any given mv
int dmin; /*!< the best value of d, i.e. the score int dmin; /**< the best value of d, i.e. the score
corresponding to the mv stored in best[]. */ corresponding to the mv stored in best[]. */
int map_generation; int map_generation;
int penalty_factor; int penalty_factor;
......
...@@ -154,7 +154,7 @@ typedef struct MotionEstContext{ ...@@ -154,7 +154,7 @@ typedef struct MotionEstContext{
uint32_t *score_map; ///< map to store the scores uint32_t *score_map; ///< map to store the scores
int map_generation; int map_generation;
int pre_penalty_factor; int pre_penalty_factor;
int penalty_factor; /*!< an estimate of the bits required to int penalty_factor; /**< an estimate of the bits required to
code a given mv value, e.g. (1,0) takes code a given mv value, e.g. (1,0) takes
more bits than (0,0). We have to more bits than (0,0). We have to
estimate whether any reduction in estimate whether any reduction in
......
...@@ -63,11 +63,11 @@ static const uint8_t fallback_cquant[] = { ...@@ -63,11 +63,11 @@ static const uint8_t fallback_cquant[] = {
};