From: Paul Brossier Date: Wed, 2 Sep 2015 10:14:34 +0000 (+0200) Subject: src/*/*.h: remove trailing spaces X-Git-Tag: 0.4.4~301^2~15 X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=a82cedc25a3fd1fe5186f3bc258057254538257f;p=aubio.git src/*/*.h: remove trailing spaces --- diff --git a/src/onset/peakpicker.h b/src/onset/peakpicker.h index ece54048..c137cc86 100644 --- a/src/onset/peakpicker.h +++ b/src/onset/peakpicker.h @@ -18,12 +18,12 @@ */ -/** \file - +/** \file + Peak picking utilities function \example onset/test-peakpicker.c - + */ #ifndef _AUBIO_PEAKPICK_H diff --git a/src/pitch/pitchyinfft.h b/src/pitch/pitchyinfft.h index ee89d0f3..8b9f717f 100644 --- a/src/pitch/pitchyinfft.h +++ b/src/pitch/pitchyinfft.h @@ -19,14 +19,14 @@ */ /** \file - + Pitch detection using a spectral implementation of the YIN algorithm - + This algorithm was derived from the YIN algorithm. In this implementation, a Fourier transform is used to compute a tapered square difference function, which allows spectral weighting. Because the difference function is tapered, the selection of the period is simplified. - + Paul Brossier, [Automatic annotation of musical audio for interactive systems](http://aubio.org/phd/), Chapter 3, Pitch Analysis, PhD thesis, Centre for Digital music, Queen Mary University of London, London, UK, 2006. @@ -45,40 +45,40 @@ extern "C" { /** pitch detection object */ typedef struct _aubio_pitchyinfft_t aubio_pitchyinfft_t; -/** execute pitch detection on an input buffer - +/** execute pitch detection on an input buffer + \param o pitch detection object as returned by new_aubio_pitchyinfft \param samples_in input signal vector (length as specified at creation time) \param cands_out pitch period candidates, in samples - + */ void aubio_pitchyinfft_do (aubio_pitchyinfft_t * o, fvec_t * samples_in, fvec_t * cands_out); /** creation of the pitch detection object - + \param samplerate samplerate of the input signal - \param buf_size size of the input buffer to analyse - + \param buf_size size of the input buffer to analyse + */ aubio_pitchyinfft_t *new_aubio_pitchyinfft (uint_t samplerate, uint_t buf_size); /** deletion of the pitch detection object - + \param o pitch detection object as returned by new_aubio_pitchyinfft() - + */ void del_aubio_pitchyinfft (aubio_pitchyinfft_t * o); -/** get tolerance parameter for YIN algorithm - - \param o YIN pitch detection object +/** get tolerance parameter for YIN algorithm + + \param o YIN pitch detection object \return tolerance parameter for minima selection [default 0.15] */ smpl_t aubio_pitchyinfft_get_tolerance (aubio_pitchyinfft_t * o); -/** set tolerance parameter for YIN algorithm - - \param o YIN pitch detection object +/** set tolerance parameter for YIN algorithm + + \param o YIN pitch detection object \param tol tolerance parameter for minima selection [default 0.15] */ diff --git a/src/spectral/fft.h b/src/spectral/fft.h index 67e268f1..98b984e6 100644 --- a/src/spectral/fft.h +++ b/src/spectral/fft.h @@ -18,7 +18,7 @@ */ -/** \file +/** \file Fast Fourier Transform @@ -39,7 +39,7 @@ extern "C" { #endif /** FFT object - + This object computes forward and backward FFTs. */ @@ -51,7 +51,7 @@ typedef struct _aubio_fft_t aubio_fft_t; */ aubio_fft_t * new_aubio_fft (uint_t size); -/** delete FFT object +/** delete FFT object \param s fft object as returned by new_aubio_fft @@ -61,16 +61,16 @@ void del_aubio_fft(aubio_fft_t * s); /** compute forward FFT \param s fft object as returned by new_aubio_fft - \param input input signal - \param spectrum output spectrum + \param input input signal + \param spectrum output spectrum */ void aubio_fft_do (aubio_fft_t *s, fvec_t * input, cvec_t * spectrum); /** compute backward (inverse) FFT \param s fft object as returned by new_aubio_fft - \param spectrum input spectrum - \param output output signal + \param spectrum input spectrum + \param output output signal */ void aubio_fft_rdo (aubio_fft_t *s, cvec_t * spectrum, fvec_t * output); @@ -78,7 +78,7 @@ void aubio_fft_rdo (aubio_fft_t *s, cvec_t * spectrum, fvec_t * output); /** compute forward FFT \param s fft object as returned by new_aubio_fft - \param input real input signal + \param input real input signal \param compspec complex output fft real/imag */ @@ -86,53 +86,53 @@ void aubio_fft_do_complex (aubio_fft_t *s, fvec_t * input, fvec_t * compspec); /** compute backward (inverse) FFT from real/imag \param s fft object as returned by new_aubio_fft - \param compspec real/imag input fft array - \param output real output array + \param compspec real/imag input fft array + \param output real output array */ void aubio_fft_rdo_complex (aubio_fft_t *s, fvec_t * compspec, fvec_t * output); -/** convert real/imag spectrum to norm/phas spectrum +/** convert real/imag spectrum to norm/phas spectrum - \param compspec real/imag input fft array - \param spectrum cvec norm/phas output array + \param compspec real/imag input fft array + \param spectrum cvec norm/phas output array */ void aubio_fft_get_spectrum(fvec_t * compspec, cvec_t * spectrum); -/** convert real/imag spectrum to norm/phas spectrum +/** convert real/imag spectrum to norm/phas spectrum - \param compspec real/imag input fft array - \param spectrum cvec norm/phas output array + \param compspec real/imag input fft array + \param spectrum cvec norm/phas output array */ void aubio_fft_get_realimag(cvec_t * spectrum, fvec_t * compspec); -/** compute phas spectrum from real/imag parts +/** compute phas spectrum from real/imag parts - \param compspec real/imag input fft array - \param spectrum cvec norm/phas output array + \param compspec real/imag input fft array + \param spectrum cvec norm/phas output array */ void aubio_fft_get_phas(fvec_t * compspec, cvec_t * spectrum); -/** compute imaginary part from the norm/phas cvec +/** compute imaginary part from the norm/phas cvec - \param spectrum norm/phas input array - \param compspec real/imag output fft array + \param spectrum norm/phas input array + \param compspec real/imag output fft array */ void aubio_fft_get_imag(cvec_t * spectrum, fvec_t * compspec); -/** compute norm component from real/imag parts +/** compute norm component from real/imag parts - \param compspec real/imag input fft array - \param spectrum cvec norm/phas output array + \param compspec real/imag input fft array + \param spectrum cvec norm/phas output array */ void aubio_fft_get_norm(fvec_t * compspec, cvec_t * spectrum); -/** compute real part from norm/phas components +/** compute real part from norm/phas components - \param spectrum norm/phas input array - \param compspec real/imag output fft array + \param spectrum norm/phas input array + \param compspec real/imag output fft array */ void aubio_fft_get_real(cvec_t * spectrum, fvec_t * compspec); diff --git a/src/spectral/phasevoc.h b/src/spectral/phasevoc.h index 9b1a3b5f..7d9e6afe 100644 --- a/src/spectral/phasevoc.h +++ b/src/spectral/phasevoc.h @@ -56,14 +56,14 @@ aubio_pvoc_t * new_aubio_pvoc (uint_t win_s, uint_t hop_s); void del_aubio_pvoc(aubio_pvoc_t *pv); /** compute spectral frame - + This function accepts an input vector of size [hop_s]. The analysis buffer is rotated and filled with the new data. After windowing of this signal window, the Fourier transform is computed and returned in fftgrain as two vectors, magnitude and phase. \param pv phase vocoder object as returned by new_aubio_pvoc - \param in new input signal (hop_s long) + \param in new input signal (hop_s long) \param fftgrain output spectral frame */ @@ -74,10 +74,10 @@ void aubio_pvoc_do(aubio_pvoc_t *pv, fvec_t *in, cvec_t * fftgrain); [buf_s] and computes its inverse Fourier transform. Overlap-add synthesis is then computed using the previously synthetised frames, and the output stored in out. - + \param pv phase vocoder object as returned by new_aubio_pvoc \param fftgrain input spectral frame - \param out output signal (hop_s long) + \param out output signal (hop_s long) */ void aubio_pvoc_rdo(aubio_pvoc_t *pv, cvec_t * fftgrain, fvec_t *out); @@ -97,6 +97,6 @@ uint_t aubio_pvoc_get_hop(aubio_pvoc_t* pv); #ifdef __cplusplus } -#endif +#endif #endif /* _AUBIO_PHASEVOC_H */ diff --git a/src/spectral/tss.h b/src/spectral/tss.h index 610e7d63..51b35346 100644 --- a/src/spectral/tss.h +++ b/src/spectral/tss.h @@ -62,7 +62,7 @@ aubio_tss_t *new_aubio_tss (uint_t buf_size, uint_t hop_size); void del_aubio_tss (aubio_tss_t * o); /** split input into transient and steady states components - + \param o tss object as returned by new_aubio_tss() \param input input spectral frame \param trans output transient components @@ -72,8 +72,8 @@ void del_aubio_tss (aubio_tss_t * o); void aubio_tss_do (aubio_tss_t * o, cvec_t * input, cvec_t * trans, cvec_t * stead); -/** set transient / steady state separation threshold - +/** set transient / steady state separation threshold + \param o tss object as returned by new_aubio_tss() \param thrs new threshold value @@ -81,7 +81,7 @@ void aubio_tss_do (aubio_tss_t * o, cvec_t * input, cvec_t * trans, uint_t aubio_tss_set_threshold (aubio_tss_t * o, smpl_t thrs); /** set parameter a, defaults to 3 - + \param o tss object as returned by new_aubio_tss() \param alpha new value for alpha parameter @@ -89,7 +89,7 @@ uint_t aubio_tss_set_threshold (aubio_tss_t * o, smpl_t thrs); uint_t aubio_tss_set_alpha (aubio_tss_t * o, smpl_t alpha); /** set parameter b, defaults to 3 - + \param o tss object as returned by new_aubio_tss() \param beta new value for beta parameter diff --git a/src/utils/parameter.h b/src/utils/parameter.h index 3b7e1443..ef296d08 100644 --- a/src/utils/parameter.h +++ b/src/utils/parameter.h @@ -60,7 +60,7 @@ aubio_parameter_t * new_aubio_parameter(smpl_t min_value, smpl_t max_value, uint */ uint_t aubio_parameter_set_target_value ( aubio_parameter_t * param, smpl_t value ); -/** get next parameter +/** get next parameter \param param parameter, created by ::new_aubio_parameter