generic-library/ffmpeg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doxygen syntax consistency.

Browse Source 
Originally committed as revision 14899 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Michael Niedermayer 2008-08-21 23:45:20 +00:00
parent 8c5da74bc1
commit ec5bd476ac
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
libavcodec/acelp_math.h
View File

@ -26,38 +26,38 @@
#include <stdint.h> #include <stdint.h>
/** /**
* \brief fixed-point implementation of cosine in [0; PI) domain * fixed-point implementation of cosine in [0; PI) domain.
* \param arg fixed-point cosine argument, 0 <= arg < 0x4000 * @param arg fixed-point cosine argument, 0 <= arg < 0x4000
* *
* \return value of (1<<15) * cos(arg * PI / (1<<14)), -0x8000 <= result <= 0x7fff * @return value of (1<<15) * cos(arg * PI / (1<<14)), -0x8000 <= result <= 0x7fff
*/ */
int16_t ff_cos(uint16_t arg); int16_t ff_cos(uint16_t arg);
/** /**
* \brief fixed-point implementation of exp2(x) in [0; 1] domain * fixed-point implementation of exp2(x) in [0; 1] domain.
* \param power argument to exp2, 0 <= power <= 0x7fff * @param power argument to exp2, 0 <= power <= 0x7fff
* *
* \return value of (1<<20) * exp2(power / (1<<15)) * @return value of (1<<20) * exp2(power / (1<<15))
* 0x8000c <= result <= 0xfffea * 0x8000c <= result <= 0xfffea
*/ */
int ff_exp2(uint16_t power); int ff_exp2(uint16_t power);
/** /**
* \brief Calculates log2(x) * Calculates log2(x).
* \param value function argument, 0 < value <= 7fff ffff * @param value function argument, 0 < value <= 7fff ffff
* *
* \return value of (1<<15) * log2(value) * @return value of (1<<15) * log2(value)
*/ */
int ff_log2(uint32_t value); int ff_log2(uint32_t value);
/** /**
* \brief returns the dot product * returns the dot product.
* \param a input data array * @param a input data array
* \param b input data array * @param b input data array
* \param length number of elements * @param length number of elements
* \param shift right shift by this value will be done after multiplication * @param shift right shift by this value will be done after multiplication
* *
* \return dot product = sum of elementwise products * @return dot product = sum of elementwise products
*/ */
static int dot_product(const int16_t* a, const int16_t* b, int length, int shift) static int dot_product(const int16_t* a, const int16_t* b, int length, int shift)
{ {
@ -71,11 +71,11 @@ static int dot_product(const int16_t* a, const int16_t* b, int length, int shift
} }
/** /**
* \brief Shift value left or right depending on sign of offset parameter. * Shift value left or right depending on sign of offset parameter.
* \param value value to shift * @param value value to shift
* \param offset shift offset * @param offset shift offset
* *
* \return value << offset, if offset>=0; value >> -offset - otherwise * @return value << offset, if offset>=0; value >> -offset - otherwise
*/ */
static inline int bidir_sal(int value, int offset) static inline int bidir_sal(int value, int offset)
{ {