summaryrefslogtreecommitdiffstats
path: root/Graphic_Equalizer/src/runfft.hcc
diff options
context:
space:
mode:
authorMarcel Lauwerijssen <paranoya@morphcore.com>2004-11-29 10:42:33 (GMT)
committerMarcel Lauwerijssen <paranoya@morphcore.com>2004-11-29 10:42:33 (GMT)
commit693f048da689427ec43066fb948df5bbb8a66a9c (patch)
tree972b8dad67ec38b1864c3c97ad88de312a0a4c5a /Graphic_Equalizer/src/runfft.hcc
parent7de7796a3ece7b24b195baa827e229efb8f212a1 (diff)
downloadTASS-693f048da689427ec43066fb948df5bbb8a66a9c.zip
TASS-693f048da689427ec43066fb948df5bbb8a66a9c.tar.gz
TASS-693f048da689427ec43066fb948df5bbb8a66a9c.tar.bz2
Updated doxygen tags
Diffstat (limited to 'Graphic_Equalizer/src/runfft.hcc')
-rw-r--r--Graphic_Equalizer/src/runfft.hcc53
1 files changed, 29 insertions, 24 deletions
diff --git a/Graphic_Equalizer/src/runfft.hcc b/Graphic_Equalizer/src/runfft.hcc
index 5dfb3ae..75b8e0d 100644
--- a/Graphic_Equalizer/src/runfft.hcc
+++ b/Graphic_Equalizer/src/runfft.hcc
@@ -1,25 +1,22 @@
-/****************************************************************
-* *
-* Copyright (C) 1991-2003 Celoxica Ltd. All rights reserved. *
-* *
-*****************************************************************
-* *
-* Project : PAL *
-* Date : 31 JAN 2003 *
-* File : reverb.hcc *
-* Author : Matthew Aubury (MA) *
-* Contributors: *
-* *
-* Description: *
-* Simple audio reverb. *
-* *
-* Date Version Author Reason for change *
-* *
-* 29 OCT 2002 1.00 MA Created *
-* *
-****************************************************************/
-
-
+/*! \file runfft.hcc
+ *
+ * \section generic This module will handle the audio I/O. It will ensure the
+ * audiosamples are correctly buffered and fed correctly to the FFT.\n
+ * This module will also handle the output of the modified audio samples.
+ *
+ * \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"
@@ -61,10 +58,18 @@ signed 16 *audioptr_in1,*audioptr_in2,*audioptr_in3,*audioptr_in4;
signed 16 *audioptr_out1,*audioptr_out2;
+unsigned 6 *displayptr1,*displayptr2,*displayptr3,*displayptr4;
#endif
-/*
- * FFT routine
+/*! \fn macro proc audio_main(AUDIOIN, AUDIOOUT);
+ * \brief Audio I/O component main.
+ *
+ * \param audiodata Pointer to audiodata struct
+ * \param AUDIOIN Handle to audio-input
+ * \param AUDIOOUT Handle to audio-output
+ *
+ * \return Never Returns.
+ * \retval void
*/
macro proc audio_main(audiodata, AUDIOIN, AUDIOOUT)
{