summaryrefslogtreecommitdiff
path: root/libs/qm-dsp/dsp/signalconditioning/Filter.h
diff options
context:
space:
mode:
Diffstat (limited to 'libs/qm-dsp/dsp/signalconditioning/Filter.h')
-rw-r--r--libs/qm-dsp/dsp/signalconditioning/Filter.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/libs/qm-dsp/dsp/signalconditioning/Filter.h b/libs/qm-dsp/dsp/signalconditioning/Filter.h
index b1c20d506a..9f25945fc1 100644
--- a/libs/qm-dsp/dsp/signalconditioning/Filter.h
+++ b/libs/qm-dsp/dsp/signalconditioning/Filter.h
@@ -20,13 +20,22 @@
#define NULL 0
#endif
+/**
+ * Filter specification. For a filter of order ord, the ACoeffs and
+ * BCoeffs arrays must point to ord+1 values each. ACoeffs provides
+ * the denominator and BCoeffs the numerator coefficients of the
+ * filter.
+ */
struct FilterConfig{
unsigned int ord;
double* ACoeffs;
double* BCoeffs;
};
-class Filter
+/**
+ * Digital filter specified through FilterConfig structure.
+ */
+class Filter
{
public:
Filter( FilterConfig Config );
@@ -36,7 +45,6 @@ public:
void process( double *src, double *dst, unsigned int length );
-
private:
void initialise( FilterConfig Config );
void deInitialise();