Chiebot-Mirror
/
FFmpeg
mirror of https://github.com/FFmpeg/FFmpeg.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix Doxygen @param command attribute syntax.

Browse Source 
The [in] and [out] attributes have to be appended to the @param command.

Originally committed as revision 24283 to svn://svn.ffmpeg.org/ffmpeg/trunk
oldabi
Diego Biurrun 15 years ago
parent 23ccf3c7a7
commit 0c733da8e2
8 changed files with 102 additions and 102 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      libavcodec/acelp_filters.h
  2. 4
      libavcodec/acelp_pitch_delay.h
  3. 6
      libavcodec/acelp_vectors.h
  4. 6
      libavcodec/celp_filters.h
  5. 32
      libavcodec/indeo5.c
  6. 58
      libavcodec/ivi_common.h
  7. 80
      libavcodec/ivi_dsp.h
  8. 12
      libavcodec/lsp.h

6
libavcodec/acelp_filters.h
Unescape View File

@ -38,7 +38,7 @@ extern const int16_t ff_acelp_interp_filter[61];
/** /**
* Generic FIR interpolation routine. * Generic FIR interpolation routine.
* @param out [out] buffer for interpolated data * @param[out] out buffer for interpolated data
* @param in input data * @param in input data
* @param filter_coeffs interpolation filter coefficients (0.15) * @param filter_coeffs interpolation filter coefficients (0.15)
* @param precision sub sample factor, that is the precision of the position * @param precision sub sample factor, that is the precision of the position
@ -65,8 +65,8 @@ void ff_acelp_interpolatef(float *out, const float *in,
/** /**
* high-pass filtering and upscaling (4.2.5 of G.729). * high-pass filtering and upscaling (4.2.5 of G.729).
* @param out [out] output buffer for filtered speech data * @param[out] out output buffer for filtered speech data
* @param hpf_f [in/out] past filtered data from previous (2 items long) * @param[in,out] hpf_f past filtered data from previous (2 items long)
* frames (-0x20000000 <= (14.13) < 0x20000000) * frames (-0x20000000 <= (14.13) < 0x20000000)
* @param in speech data to process * @param in speech data to process
* @param length input data size * @param length input data size

4
libavcodec/acelp_pitch_delay.h
Unescape View File

@ -116,7 +116,7 @@ int ff_acelp_decode_6bit_to_2nd_delay6(
/** /**
* \brief Update past quantized energies * \brief Update past quantized energies
* \param quant_energy [in/out] 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
@ -143,7 +143,7 @@ void ff_acelp_update_past_gain(
* \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 quant_energy [in/out] 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)

6
libavcodec/acelp_vectors.h
Unescape View File

@ -134,7 +134,7 @@ extern const float ff_pow_0_55[10];
/** /**
* Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR). * Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
* @param fc_v [out] decoded fixed codebook vector (2.13) * @param[out] fc_v decoded fixed codebook vector (2.13)
* @param tab1 table used for first pulse_count pulses * @param tab1 table used for first pulse_count pulses
* @param tab2 table used for last pulse * @param tab2 table used for last pulse
* @param pulse_indexes fixed codebook indexes * @param pulse_indexes fixed codebook indexes
@ -174,7 +174,7 @@ void ff_decode_10_pulses_35bits(const int16_t *fixed_index,
/** /**
* weighted sum of two vectors with rounding. * weighted sum of two vectors with rounding.
* @param out [out] result of addition * @param[out] out result of addition
* @param in_a first vector * @param in_a first vector
* @param in_b second vector * @param in_b second vector
* @param weight_coeff_a first vector weight coefficient * @param weight_coeff_a first vector weight coefficient
@ -198,7 +198,7 @@ void ff_acelp_weighted_vector_sum(int16_t* out,
/** /**
* float implementation of weighted sum of two vectors. * float implementation of weighted sum of two vectors.
* @param out [out] result of addition * @param[out] out result of addition
* @param in_a first vector * @param in_a first vector
* @param in_b second vector * @param in_b second vector
* @param weight_coeff_a first vector weight coefficient * @param weight_coeff_a first vector weight coefficient

6
libavcodec/celp_filters.h
Unescape View File

@ -56,7 +56,7 @@ void ff_celp_circ_addf(float *out, const float *in,
/** /**
* LP synthesis filter. * LP synthesis filter.
* @param out [out] pointer to output buffer * @param[out] out pointer to output buffer
* @param filter_coeffs filter coefficients (-0x8000 <= (3.12) < 0x8000) * @param filter_coeffs filter coefficients (-0x8000 <= (3.12) < 0x8000)
* @param in input signal * @param in input signal
* @param buffer_length amount of data to process * @param buffer_length amount of data to process
@ -79,7 +79,7 @@ int ff_celp_lp_synthesis_filter(int16_t *out, const int16_t *filter_coeffs,
/** /**
* LP synthesis filter. * LP synthesis filter.
* @param out [out] pointer to output buffer * @param[out] out pointer to output buffer
* - the array out[-filter_length, -1] must * - the array out[-filter_length, -1] must
* contain the previous result of this filter * contain the previous result of this filter
* @param filter_coeffs filter coefficients. * @param filter_coeffs filter coefficients.
@ -99,7 +99,7 @@ void ff_celp_lp_synthesis_filterf(float *out, const float *filter_coeffs,
/** /**
* LP zero synthesis filter. * LP zero synthesis filter.
* @param out [out] pointer to output buffer * @param[out] out pointer to output buffer
* @param filter_coeffs filter coefficients. * @param filter_coeffs filter coefficients.
* @param in input signal * @param in input signal
* - the array in[-filter_length, -1] must * - the array in[-filter_length, -1] must

32
libavcodec/indeo5.c
Unescape View File

@ -84,8 +84,8 @@ typedef struct {
* This header is present in key frames only. * This header is present in key frames only.
* It defines parameters for all frames in a GOP. * It defines parameters for all frames in a GOP.
* *
* @param ctx [in,out] ptr to the decoder context * @param[in,out] ctx ptr to the decoder context
* @param avctx [in] ptr to the AVCodecContext * @param[in] avctx ptr to the AVCodecContext
* @return result code: 0 = OK, -1 = error * @return result code: 0 = OK, -1 = error
*/ */
static int decode_gop_header(IVI5DecContext *ctx, AVCodecContext *avctx) static int decode_gop_header(IVI5DecContext *ctx, AVCodecContext *avctx)
@ -298,7 +298,7 @@ static int decode_gop_header(IVI5DecContext *ctx, AVCodecContext *avctx)
/** /**
* Skip a header extension. * Skip a header extension.
* *
* @param gb [in,out] the GetBit context * @param[in,out] gb the GetBit context
*/ */
static inline void skip_hdr_extension(GetBitContext *gb) static inline void skip_hdr_extension(GetBitContext *gb)
{ {
@ -314,8 +314,8 @@ static inline void skip_hdr_extension(GetBitContext *gb)
/** /**
* Decode Indeo5 picture header. * Decode Indeo5 picture header.
* *
* @param ctx [in,out] ptr to the decoder context * @param[in,out] ctx ptr to the decoder context
* @param avctx [in] ptr to the AVCodecContext * @param[in] avctx ptr to the AVCodecContext
* @return result code: 0 = OK, -1 = error * @return result code: 0 = OK, -1 = error
*/ */
static int decode_pic_hdr(IVI5DecContext *ctx, AVCodecContext *avctx) static int decode_pic_hdr(IVI5DecContext *ctx, AVCodecContext *avctx)
@ -366,9 +366,9 @@ static int decode_pic_hdr(IVI5DecContext *ctx, AVCodecContext *avctx)
/** /**
* Decode Indeo5 band header. * Decode Indeo5 band header.
* *
* @param ctx [in,out] ptr to the decoder context * @param[in,out] ctx ptr to the decoder context
* @param band [in,out] ptr to the band descriptor * @param[in,out] band ptr to the band descriptor
* @param avctx [in] ptr to the AVCodecContext * @param[in] avctx ptr to the AVCodecContext
* @return result code: 0 = OK, -1 = error * @return result code: 0 = OK, -1 = error
*/ */
static int decode_band_hdr(IVI5DecContext *ctx, IVIBandDesc *band, static int decode_band_hdr(IVI5DecContext *ctx, IVIBandDesc *band,
@ -435,10 +435,10 @@ static int decode_band_hdr(IVI5DecContext *ctx, IVIBandDesc *band,
* Decode info (block type, cbp, quant delta, motion vector) * Decode info (block type, cbp, quant delta, motion vector)
* for all macroblocks in the current tile. * for all macroblocks in the current tile.
* *
* @param ctx [in,out] ptr to the decoder context * @param[in,out] ctx ptr to the decoder context
* @param band [in,out] ptr to the band descriptor * @param[in,out] band ptr to the band descriptor
* @param tile [in,out] ptr to the tile descriptor * @param[in,out] tile ptr to the tile descriptor
* @param avctx [in] ptr to the AVCodecContext * @param[in] avctx ptr to the AVCodecContext
* @return result code: 0 = OK, -1 = error * @return result code: 0 = OK, -1 = error
*/ */
static int decode_mb_info(IVI5DecContext *ctx, IVIBandDesc *band, static int decode_mb_info(IVI5DecContext *ctx, IVIBandDesc *band,
@ -559,9 +559,9 @@ static int decode_mb_info(IVI5DecContext *ctx, IVIBandDesc *band,
/** /**
* Decode an Indeo5 band. * Decode an Indeo5 band.
* *
* @param ctx [in,out] ptr to the decoder context * @param[in,out] ctx ptr to the decoder context
* @param band [in,out] ptr to the band descriptor * @param[in,out] band ptr to the band descriptor
* @param avctx [in] ptr to the AVCodecContext * @param[in] avctx ptr to the AVCodecContext
* @return result code: 0 = OK, -1 = error * @return result code: 0 = OK, -1 = error
*/ */
static int decode_band(IVI5DecContext *ctx, int plane_num, static int decode_band(IVI5DecContext *ctx, int plane_num,
@ -649,7 +649,7 @@ static int decode_band(IVI5DecContext *ctx, int plane_num,
/** /**
* Switch buffers. * Switch buffers.
* *
* @param ctx [in,out] ptr to the decoder context * @param[in,out] ctx ptr to the decoder context
*/ */
static void switch_buffers(IVI5DecContext *ctx) static void switch_buffers(IVI5DecContext *ctx)
{ {

58
libavcodec/ivi_common.h
Unescape View File

@ -223,9 +223,9 @@ static inline int ivi_scale_mv(int mv, int mv_scale)
* Generate a huffman codebook from the given descriptor * Generate a huffman codebook from the given descriptor
* and convert it into the FFmpeg VLC table. * and convert it into the FFmpeg VLC table.
* *
* @param cb [in] pointer to codebook descriptor * @param[in] cb pointer to codebook descriptor
* @param vlc [out] where to place the generated VLC table * @param[out] vlc where to place the generated VLC table
* @param flag [in] flag: 1 - for static or 0 for dynamic tables * @param[in] flag flag: 1 - for static or 0 for dynamic tables
* @return result code: 0 - OK, -1 = error (invalid codebook descriptor) * @return result code: 0 - OK, -1 = error (invalid codebook descriptor)
*/ */
int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag); int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
@ -239,11 +239,11 @@ void ff_ivi_init_static_vlc(void);
* Decode a huffman codebook descriptor from the bitstream * Decode a huffman codebook descriptor from the bitstream
* and select specified huffman table. * and select specified huffman table.
* *
* @param gb [in,out] the GetBit context * @param[in,out] gb the GetBit context
* @param desc_coded [in] flag signalling if table descriptor was coded * @param[in] desc_coded flag signalling if table descriptor was coded
* @param which_tab [in] codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF) * @param[in] which_tab codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
* @param huff_tab [out] pointer to the descriptor of the selected table * @param[out] huff_tab pointer to the descriptor of the selected table
* @param avctx [in] AVCodecContext pointer * @param[in] avctx AVCodecContext pointer
* @return zero on success, negative value otherwise * @return zero on success, negative value otherwise
*/ */
int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab, int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
@ -252,8 +252,8 @@ int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
/** /**
* Compare two huffman codebook descriptors. * Compare two huffman codebook descriptors.
* *
* @param desc1 [in] ptr to the 1st descriptor to compare * @param[in] desc1 ptr to the 1st descriptor to compare
* @param desc2 [in] ptr to the 2nd descriptor to compare * @param[in] desc2 ptr to the 2nd descriptor to compare
* @return comparison result: 0 - equal, 1 - not equal * @return comparison result: 0 - equal, 1 - not equal
*/ */
int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2); int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
@ -261,16 +261,16 @@ int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
/** /**
* Copy huffman codebook descriptors. * Copy huffman codebook descriptors.
* *
* @param dst [out] ptr to the destination descriptor * @param[out] dst ptr to the destination descriptor
* @param src [in] ptr to the source descriptor * @param[in] src ptr to the source descriptor
*/ */
void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src); void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
/** /**
* Initialize planes (prepares descriptors, allocates buffers etc). * Initialize planes (prepares descriptors, allocates buffers etc).
* *
* @param planes [in,out] pointer to the array of the plane descriptors * @param[in,out] planes pointer to the array of the plane descriptors
* @param cfg [in] pointer to the ivi_pic_config structure describing picture layout * @param[in] cfg pointer to the ivi_pic_config structure describing picture layout
* @return result code: 0 - OK * @return result code: 0 - OK
*/ */
int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg); int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
@ -278,16 +278,16 @@ int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
/** /**
* Free planes, bands and macroblocks buffers. * Free planes, bands and macroblocks buffers.
* *
* @param planes [in] pointer to the array of the plane descriptors * @param[in] planes pointer to the array of the plane descriptors
*/ */
void ff_ivi_free_buffers(IVIPlaneDesc *planes); void ff_ivi_free_buffers(IVIPlaneDesc *planes);
/** /**
* Initialize tile and macroblock descriptors. * Initialize tile and macroblock descriptors.
* *
* @param planes [in,out] pointer to the array of the plane descriptors * @param[in,out] planes pointer to the array of the plane descriptors
* @param tile_width [in] tile width * @param[in] tile_width tile width
* @param tile_height [in] tile height * @param[in] tile_height tile height
* @return result code: 0 - OK * @return result code: 0 - OK
*/ */
int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height); int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
@ -299,7 +299,7 @@ int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
* if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3 * if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
* where X1-X3 is size of the tile data * where X1-X3 is size of the tile data
* *
* @param gb [in,out] the GetBit context * @param[in,out] gb the GetBit context
* @return size of the tile data in bytes * @return size of the tile data in bytes
*/ */
int ff_ivi_dec_tile_data_size(GetBitContext *gb); int ff_ivi_dec_tile_data_size(GetBitContext *gb);
@ -310,9 +310,9 @@ int ff_ivi_dec_tile_data_size(GetBitContext *gb);
* dequantize them, apply inverse transform and motion compensation * dequantize them, apply inverse transform and motion compensation
* in order to reconstruct the picture. * in order to reconstruct the picture.
* *
* @param gb [in,out] the GetBit context * @param[in,out] gb the GetBit context
* @param band [in] pointer to the band descriptor * @param[in] band pointer to the band descriptor
* @param tile [in] pointer to the tile descriptor * @param[in] tile pointer to the tile descriptor
* @return result code: 0 - OK, -1 = error (corrupted blocks data) * @return result code: 0 - OK, -1 = error (corrupted blocks data)
*/ */
int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile); int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
@ -321,10 +321,10 @@ int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
* Handle empty tiles by performing data copying and motion * Handle empty tiles by performing data copying and motion
* compensation respectively. * compensation respectively.
* *
* @param avctx [in] ptr to the AVCodecContext * @param[in] avctx ptr to the AVCodecContext
* @param band [in] pointer to the band descriptor * @param[in] band pointer to the band descriptor
* @param tile [in] pointer to the tile descriptor * @param[in] tile pointer to the tile descriptor
* @param mv_scale [in] scaling factor for motion vectors * @param[in] mv_scale scaling factor for motion vectors
*/ */
void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band, void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
IVITile *tile, int32_t mv_scale); IVITile *tile, int32_t mv_scale);
@ -334,9 +334,9 @@ void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
* This conversion is done by adding back the bias value of 128 * This conversion is done by adding back the bias value of 128
* (subtracted in the encoder) and clipping the result. * (subtracted in the encoder) and clipping the result.
* *
* @param plane [in] pointer to the descriptor of the plane being processed * @param[in] plane pointer to the descriptor of the plane being processed
* @param dst [out] pointer to the buffer receiving converted pixels * @param[out] dst pointer to the buffer receiving converted pixels
* @param dst_pitch [in] pitch for moving to the next y line * @param[in] dst_pitch pitch for moving to the next y line
*/ */
void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch); void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);

80
libavcodec/ivi_dsp.h
Unescape View File

@ -35,10 +35,10 @@
/** /**
* 5/3 wavelet recomposition filter for Indeo5 * 5/3 wavelet recomposition filter for Indeo5
* *
* @param plane [in] pointer to the descriptor of the plane being processed * @param[in] plane pointer to the descriptor of the plane being processed
* @param dst [out] pointer to the destination buffer * @param[out] dst pointer to the destination buffer
* @param dst_pitch [in] pitch of the destination buffer * @param[in] dst_pitch pitch of the destination buffer
* @param num_bands [in] number of wavelet bands to be processed * @param[in] num_bands number of wavelet bands to be processed
*/ */
void ff_ivi_recompose53(const IVIPlaneDesc *plane, uint8_t *dst, void ff_ivi_recompose53(const IVIPlaneDesc *plane, uint8_t *dst,
const int dst_pitch, const int num_bands); const int dst_pitch, const int num_bands);
@ -46,10 +46,10 @@ void ff_ivi_recompose53(const IVIPlaneDesc *plane, uint8_t *dst,
/** /**
* two-dimensional inverse slant 8x8 transform * two-dimensional inverse slant 8x8 transform
* *
* @param in [in] pointer to the vector of transform coefficients * @param[in] in pointer to the vector of transform coefficients
* @param out [out] pointer to the output buffer (frame) * @param[out] out pointer to the output buffer (frame)
* @param pitch [in] pitch to move to the next y line * @param[in] pitch pitch to move to the next y line
* @param flags [in] pointer to the array of column flags: * @param[in] flags pointer to the array of column flags:
* != 0 - non_empty column, 0 - empty one * != 0 - non_empty column, 0 - empty one
* (this array must be filled by caller) * (this array must be filled by caller)
*/ */
@ -59,10 +59,10 @@ void ff_ivi_inverse_slant_8x8(const int32_t *in, int16_t *out, uint32_t pitch,
/** /**
* two-dimensional inverse slant 4x4 transform * two-dimensional inverse slant 4x4 transform
* *
* @param in [in] pointer to the vector of transform coefficients * @param[in] in pointer to the vector of transform coefficients
* @param out [out] pointer to the output buffer (frame) * @param[out] out pointer to the output buffer (frame)
* @param pitch [in] pitch to move to the next y line * @param[in] pitch pitch to move to the next y line
* @param flags [in] pointer to the array of column flags: * @param[in] flags pointer to the array of column flags:
* != 0 - non_empty column, 0 - empty one * != 0 - non_empty column, 0 - empty one
* (this array must be filled by caller) * (this array must be filled by caller)
*/ */
@ -75,20 +75,20 @@ void ff_ivi_inverse_slant_4x4(const int32_t *in, int16_t *out, uint32_t pitch,
* spreading (DC_coeff + 1)/2 over the whole block. * spreading (DC_coeff + 1)/2 over the whole block.
* It works much faster than performing the slant transform on a vector of zeroes. * It works much faster than performing the slant transform on a vector of zeroes.
* *
* @param in [in] pointer to the dc coefficient * @param[in] in pointer to the dc coefficient
* @param out [out] pointer to the output buffer (frame) * @param[out] out pointer to the output buffer (frame)
* @param pitch [in] pitch to move to the next y line * @param[in] pitch pitch to move to the next y line
* @param blk_size [in] transform block size * @param[in] blk_size transform block size
*/ */
void ff_ivi_dc_slant_2d(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size); void ff_ivi_dc_slant_2d(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
/** /**
* inverse 1D row slant transform * inverse 1D row slant transform
* *
* @param in [in] pointer to the vector of transform coefficients * @param[in] in pointer to the vector of transform coefficients
* @param out [out] pointer to the output buffer (frame) * @param[out] out pointer to the output buffer (frame)
* @param pitch [in] pitch to move to the next y line * @param[in] pitch pitch to move to the next y line
* @param flags [in] pointer to the array of column flags (unused here) * @param[in] flags pointer to the array of column flags (unused here)
*/ */
void ff_ivi_row_slant8(const int32_t *in, int16_t *out, uint32_t pitch, void ff_ivi_row_slant8(const int32_t *in, int16_t *out, uint32_t pitch,
const uint8_t *flags); const uint8_t *flags);
@ -96,10 +96,10 @@ void ff_ivi_row_slant8(const int32_t *in, int16_t *out, uint32_t pitch,
/** /**
* inverse 1D column slant transform * inverse 1D column slant transform
* *
* @param in [in] pointer to the vector of transform coefficients * @param[in] in pointer to the vector of transform coefficients
* @param out [out] pointer to the output buffer (frame) * @param[out] out pointer to the output buffer (frame)
* @param pitch [in] pitch to move to the next y line * @param[in] pitch pitch to move to the next y line
* @param flags [in] pointer to the array of column flags: * @param[in] flags pointer to the array of column flags:
* != 0 - non_empty column, 0 - empty one * != 0 - non_empty column, 0 - empty one
* (this array must be filled by caller) * (this array must be filled by caller)
*/ */
@ -130,40 +130,40 @@ void ff_ivi_put_dc_pixel_8x8(const int32_t *in, int16_t *out, uint32_t pitch, in
/** /**
* 8x8 block motion compensation with adding delta * 8x8 block motion compensation with adding delta
* *
* @param buf [in,out] pointer to the block in the current frame buffer containing delta * @param[in,out] buf pointer to the block in the current frame buffer containing delta
* @param ref_buf [in] pointer to the corresponding block in the reference frame * @param[in] ref_buf pointer to the corresponding block in the reference frame
* @param pitch [in] pitch for moving to the next y line * @param[in] pitch pitch for moving to the next y line
* @param mc_type [in] interpolation type * @param[in] mc_type interpolation type
*/ */
void ff_ivi_mc_8x8_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); void ff_ivi_mc_8x8_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
/** /**
* 4x4 block motion compensation with adding delta * 4x4 block motion compensation with adding delta
* *
* @param buf [in,out] pointer to the block in the current frame buffer containing delta * @param[in,out] buf pointer to the block in the current frame buffer containing delta
* @param ref_buf [in] pointer to the corresponding block in the reference frame * @param[in] ref_buf pointer to the corresponding block in the reference frame
* @param pitch [in] pitch for moving to the next y line * @param[in] pitch pitch for moving to the next y line
* @param mc_type [in] interpolation type * @param[in] mc_type interpolation type
*/ */
void ff_ivi_mc_4x4_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); void ff_ivi_mc_4x4_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
/** /**
* motion compensation without adding delta * motion compensation without adding delta
* *
* @param buf [in,out] pointer to the block in the current frame receiving the result * @param[in,out] buf pointer to the block in the current frame receiving the result
* @param ref_buf [in] pointer to the corresponding block in the reference frame * @param[in] ref_buf pointer to the corresponding block in the reference frame
* @param pitch [in] pitch for moving to the next y line * @param[in] pitch pitch for moving to the next y line
* @param mc_type [in] interpolation type * @param[in] mc_type interpolation type
*/ */
void ff_ivi_mc_8x8_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); void ff_ivi_mc_8x8_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
/** /**
* 4x4 block motion compensation without adding delta * 4x4 block motion compensation without adding delta
* *
* @param buf [in,out] pointer to the block in the current frame receiving the result * @param[in,out] buf pointer to the block in the current frame receiving the result
* @param ref_buf [in] pointer to the corresponding block in the reference frame * @param[in] ref_buf pointer to the corresponding block in the reference frame
* @param pitch [in] pitch for moving to the next y line * @param[in] pitch pitch for moving to the next y line
* @param mc_type [in] interpolation type * @param[in] mc_type interpolation type
*/ */
void ff_ivi_mc_4x4_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); void ff_ivi_mc_4x4_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);

12
libavcodec/lsp.h
Unescape View File

@ -31,7 +31,7 @@
/** /**
* \brief ensure a minimum distance between LSFs * \brief ensure a minimum distance between LSFs
* \param lsfq [in/out] 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
@ -54,7 +54,7 @@ void ff_set_min_dist_lsf(float *lsf, double min_spacing, int size);
/** /**
* \brief Convert LSF to LSP * \brief Convert LSF to LSP
* \param lsp [out] 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
* *
@ -64,7 +64,7 @@ void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *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 lp [out] 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
*/ */
@ -72,8 +72,8 @@ void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_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 lp_1st [out] 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 lp_2nd [out] 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
@ -111,7 +111,7 @@ void ff_sort_nearly_sorted_floats(float *vals, int len);
* We only need to calculate the 6 first elements of the polynomial. * We only need to calculate the 6 first elements of the polynomial.
* *
* @param lsp line spectral pairs in cosine domain * @param lsp line spectral pairs in cosine domain
* @param f [out] polynomial input/output as a vector * @param[out] f polynomial input/output as a vector
* *
* TIA/EIA/IS-733 2.4.3.3.5-1/2 * TIA/EIA/IS-733 2.4.3.3.5-1/2
*/ */

Write Preview
Loading…
Cancel
Save