summaryrefslogtreecommitdiffstats
path: root/Graphic_Equalizer/src
diff options
context:
space:
mode:
authorMarcel Lauwerijssen <paranoya@morphcore.com>2004-11-29 10:35:50 (GMT)
committerMarcel Lauwerijssen <paranoya@morphcore.com>2004-11-29 10:35:50 (GMT)
commit7de7796a3ece7b24b195baa827e229efb8f212a1 (patch)
treee7cfe923aadbb1d43fe2793be6101be59e82ac4b /Graphic_Equalizer/src
parent7870abe95758f73eb485dcbcf8b0880cc7fb5030 (diff)
downloadTASS-7de7796a3ece7b24b195baa827e229efb8f212a1.zip
TASS-7de7796a3ece7b24b195baa827e229efb8f212a1.tar.gz
TASS-7de7796a3ece7b24b195baa827e229efb8f212a1.tar.bz2
Updated doxygen tags
Diffstat (limited to 'Graphic_Equalizer/src')
-rw-r--r--Graphic_Equalizer/src/fft.hcc152
1 files changed, 75 insertions, 77 deletions
diff --git a/Graphic_Equalizer/src/fft.hcc b/Graphic_Equalizer/src/fft.hcc
index 626b1b7..c353d8f 100644
--- a/Graphic_Equalizer/src/fft.hcc
+++ b/Graphic_Equalizer/src/fft.hcc
@@ -1,3 +1,22 @@
+/*! \file eventhandler.hcc
+ *
+ * \section generic This modules coordinates all events. Thus for example
+ * when the mousehandler registers a 'click' we coordinate
+ * the actions that follow that click.
+ *
+ * \section project Project information.
+ * Project Graphic Equalizer\n
+ * \author M. Lauwerijssen
+ * \date 20041110
+ * \version 0.1
+ *
+ * \section copyright Copyright
+ * Copyright ©2004 Koninklijke Philips Electronics N.V. All rights reserved
+ *
+ * \section history Change history
+ * 20041110: M. Lauwerijssen\n Initial version
+ *
+ ********************************************************************/
#include <stdlib.hch>
#include "pal_master.hch"
@@ -41,19 +60,16 @@ mpram
ram signed 7 eq_settings[16] = {0,2,4,7,10,13,16,19,22,26,30,35,41,48,55,63};
-/****************************************************************
-* Function: multiply *
-* *
-* Arguments *
-* x,y signed variables *
-* *
-* Description *
-* Just a multiplier. But by doing this in a function the *
-* FPGA space needed is reduced. *
-* *
-* Return Values *
-* The result after multiplication *
-****************************************************************/
+/*! \fn macro proc multiply(result, op_a, op_b);
+ * \brief Procedure used for multiply-ing
+ *
+ * \param result variable containing the result of the multiply procedure
+ * \param op_a integer value to be multiplied.
+ * \param op_b integer value to be multiplied.
+ *
+ * \return Procedure returns through variable.
+ * \retval signed 36
+ */
macro proc multiply(result, op_a, op_b)
{
#if HARDWARE_MULTIPLY
@@ -66,18 +82,16 @@ macro proc multiply(result, op_a, op_b)
-/************************************************************************
-* Function: calculate_fft *
-* *
-* Arguments *
-* select_inverse Boolean that indicates FFT or iFFT calculation *
-* *
-* Description *
-* This routine performs the Fast Fourier Transform for *
-* calculation of the frequency spectrum *
-* *
-* Cost: 12391 cycles *
-************************************************************************/
+/*! \fn void calculate_fft(unsigned 1 select_inverse)
+ * \brief This routine performs the Fast Fourier Transform for calculation of the frequency spectrum
+ *
+ * \param select_inverse determines if a FFT or iFFT has to be calculated
+ *
+ * \return nothing
+ * \retval void
+ *
+ * cost 12391 cycles
+ */
void calculate_fft(unsigned 1 select_inverse)
{
unsigned 4 level;
@@ -219,20 +233,17 @@ void calculate_fft(unsigned 1 select_inverse)
}
-/*******************************************************************
-* Function: perform_fft *
-* *
-* Arguments *
-* pcm_audio Pointer to the array containing the audio data *
-* *
-* Description *
-* This routine obtains the audio data from the audio I/O *
-* component and copies this data to local arrays for *
-* calculating purposes, and calls the FFT algorithm. *
-* *
-* Cost: 259 cycles (excl. the calculate FFT function) *
-* *
-*******************************************************************/
+/*! \fn void perform_fft(signed 18 *pcm_audio)
+ * \brief This routine obtains the audio data from the audio I/O component and copies this
+ * data to local arrays for calculating purposes, and calls the FFT algorithm.
+ *
+ * \param *pcm_audio pointer to array containg the audio data
+ *
+ * \return nothing
+ * \retval void
+ *
+ * cost 258 cycles (excl. the calculate FFT function)
+ */
#if HARDWARE_MULTIPLY
void perform_fft(signed 18 *pcm_audio)
#else
@@ -285,27 +296,19 @@ void perform_fft(signed 16 *pcm_audio)
}
-/*******************************************************************
-* Function: perform_ifft *
-* *
-* Arguments *
-* modified_audio Pointer to the array containing the audio data *
-* *
-* ifft_info Pointer to the ifft_info array containing the *
-* modified waveform data for display purposes*
-* *
-* *
-* Description *
-* This routine calls the ifft algorithm and after completing that*
-* it obtains the modified audio data and copies that to the *
-* output arrays of the audio I/O component. Besides that it *
-* also fills the array used by the display routine for *
-* displaying the waveform . *
-* *
-* *
-* Cost: 259 cycles (excl. the calculate FFT function) *
-* *
-*******************************************************************/
+/*! \fn void perform_ifft(signed 18 *modified_audio, unsigned 6 *ifft_info)
+ * \brief This routine calls the ifft algorithm and after completing that it obtains the
+ * modified audio data and copies that to the output arrays of the audio I/O component.
+ * Besides that it also fills the array used by the display routine for displaying the waveform.
+ *
+ * \param *modified_audio pointer to array containg the audio data
+ * \param *ifft_info Pointer to the ifft_info array containing the modified waveform data for display purposes
+ *
+ * \return nothing
+ * \retval void
+ *
+ * cost 258 cycles (excl. the calculate iFFT function)
+ */
#if HARDWARE_MULTIPLY
void perform_ifft(signed 18 *modified_audio, unsigned 6 *ifft_info)
#else
@@ -371,23 +374,18 @@ void perform_ifft(signed 16 *modified_audio, unsigned 6 *ifft_info)
} while(k);
}
-/*******************************************************************
-* Function: equalize_audio *
-* *
-* Arguments *
-* audiodata Pointer to the audiodata structure *
-* *
-* *
-* *
-* Description *
-* This routine equalizes the frequencies derived by the FFT *
-* calculation, according to the settings of the equalizer *
-* bars. *
-* *
-* *
-* Cost: 3844 cycles (Maximum) *
-* *
-*******************************************************************/
+/*! \fn void equalize_audio(audiodata_t *audiodata)
+ * \brief This routine equalizes the frequencies derived by the FFT calculation,
+ * according to the settings of the equalizer bars.
+ *
+ * \param *audiodata pointer to the audiodata struct, containing the eq_info, etc.
+ *
+ * \return nothing
+ * \retval void
+ *
+ * cost 3844 cycles (Maximum)
+ *
+ */
void equalize_audio(audiodata_t *audiodata)
{
#if HARDWARE_MULTIPLY