Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Aron Vince Szakacs committed Jul 10, 2021
1 parent 85bbc5d commit 206a9c6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
2 changes: 2 additions & 0 deletions src/TransformFunctions/plp_dct2_f32.c
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@
@param[in] pShift points to twiddle coefficient table of 4*FFTLength,
of which only the first quadrant of the complex
unit circle is used.
For example, if S contains twiddleCoef_rfft_32,
pShift can be set to twiddleCoef_rfft_128.
@param[in] pSrc points to the input buffer (real data) of size
FFTLength.
@param[out] pBuf points to buffer of size 2*FFTLength, used for
Expand Down
14 changes: 8 additions & 6 deletions src/TransformFunctions/plp_mfcc_f32.c
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@
*/

/**
@defgroup fft FFT transforms
This module contains the code to perform FFT transforms.
@defgroup feature feature transforms
This module contains the code to perform feature transforms.
*/

/**
@addtogroup fft
@addtogroup feature
@{
*/

Expand All @@ -58,9 +58,11 @@
FFTLength = 4*n_mels. Only first quarter necessary.
@param[in] filterBank points to plp_triangular_filter_f32 instance with
nFilters = n_mels.
@param[in] window vector to use for windowing
@param[in] orthoNorm whether to use dct orthonormalisation or not
@param[in] pSrc points to the input buffer (real data, size n_fft)
@param[out] pDst points to the output buffer (complex data).
Must be of length at least 3*n_fft.
@param[out] pDst points to the output buffer
of length at least 3*n_fft.
pSrc and pDst must not overlap, the calculation can
not be done in place.
MFCCs are returned in the first n_mels spots.
Expand Down Expand Up @@ -127,5 +129,5 @@ void plp_mfcc_f32(const plp_fft_instance_f32 *SFFT,
}

/**
@} end of FFT group
@} end of feature group
*/

0 comments on commit 206a9c6

Please sign in to comment.