Adding ability for FIR filter with internal buffer to decimate.
[debian/gnuradio] / gnuradio-core / src / lib / filter / qa_gri_fir_filter_with_buffer_fcc.cc
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2010 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <gr_types.h>
28 #include <qa_gri_fir_filter_with_buffer_fcc.h>
29 #include <gri_fir_filter_with_buffer_fcc.h>
30 #include <string.h>
31 #include <iostream>
32 #include <cmath>
33 #include <cppunit/TestAssert.h>
34 #include <random.h>
35 #include <malloc16.h>
36 #include <string.h>
37
38 typedef float           i_type;
39 typedef gr_complex      o_type;
40 typedef gr_complex      tap_type;
41 typedef gr_complex      acc_type;
42
43 using std::vector;
44
45 #define ERR_DELTA       (1e-5)
46
47 #define NELEM(x) (sizeof (x) / sizeof (x[0]))
48
49 static float
50 uniform ()
51 {
52   return 2.0 * ((float) random () / RANDOM_MAX - 0.5);  // uniformly (-1, 1)
53 }
54
55 static void
56 random_floats (float *buf, unsigned n)
57 {
58   for (unsigned i = 0; i < n; i++)
59     buf[i] = (float) rint (uniform () * 32767);
60 }
61
62 static void
63 random_complex (gr_complex *buf, unsigned n)
64 {
65   for (unsigned i = 0; i < n; i++){
66     float re = rint (uniform () * 32767);
67     float im = rint (uniform () * 32767);
68     buf[i] = gr_complex (re, im);
69   }
70 }
71
72 static o_type
73 ref_dotprod (const i_type input[], const tap_type taps[], int ntaps)
74 {
75   acc_type      sum = 0;
76   for (int i = 0; i < ntaps; i++) {
77     sum += input[i] * taps[i];
78   }
79       
80   return sum;
81 }
82
83 void
84 qa_gri_fir_filter_with_buffer_fcc::t1()
85 {
86   test_decimate(1);
87 }
88
89 void
90 qa_gri_fir_filter_with_buffer_fcc::t2()
91 {
92   test_decimate(2);
93 }
94
95 void
96 qa_gri_fir_filter_with_buffer_fcc::t3()
97 {
98   test_decimate(5);
99 }
100
101
102 //
103 // Test for ntaps in [0,9], and input lengths in [0,17].
104 // This ensures that we are building the shifted taps correctly,
105 // and exercises all corner cases on input alignment and length.
106 //
107 void
108 qa_gri_fir_filter_with_buffer_fcc::test_decimate(unsigned int decimate)
109 {
110   const int     MAX_TAPS        = 9;
111   const int     OUTPUT_LEN      = 17;
112   const int     INPUT_LEN       = MAX_TAPS + OUTPUT_LEN;
113
114   // Mem aligned buffer not really necessary, but why not?
115   i_type       *input = (i_type *)malloc16Align(INPUT_LEN * sizeof(i_type));
116   i_type       *dline = (i_type*)malloc16Align(INPUT_LEN * sizeof(i_type));
117   o_type        expected_output[OUTPUT_LEN];
118   o_type        actual_output[OUTPUT_LEN];
119   tap_type      taps[MAX_TAPS];
120
121   srandom (0);  // we want reproducibility
122   memset(dline, 0, INPUT_LEN*sizeof(i_type));
123
124   for (int n = 0; n <= MAX_TAPS; n++){
125     for (int ol = 0; ol <= OUTPUT_LEN; ol++){
126
127       // cerr << "@@@ n:ol " << n << ":" << ol << endl;
128
129       // build random test case
130       random_floats (input, INPUT_LEN);
131       random_complex (taps, MAX_TAPS);
132
133       // compute expected output values
134       memset(dline, 0, INPUT_LEN*sizeof(i_type));
135       for (int o = 0; o < (int)(ol/decimate); o++){
136         // use an actual delay line for this test
137         for(int dd = 0; dd < (int)decimate; dd++) {
138           for(int oo = INPUT_LEN-1; oo > 0; oo--)
139             dline[oo] = dline[oo-1];
140           dline[0] = input[decimate*o+dd];
141         }
142         expected_output[o] = ref_dotprod (dline, taps, n);
143       }
144
145       // build filter
146       vector<tap_type> f1_taps(&taps[0], &taps[n]);
147       gri_fir_filter_with_buffer_fcc *f1 = new gri_fir_filter_with_buffer_fcc(f1_taps);
148
149       // zero the output, then do the filtering
150       memset (actual_output, 0, sizeof (actual_output));
151       f1->filterNdec (actual_output, input, ol/decimate, decimate);
152
153       // check results
154       //
155       // we use a sloppy error margin because on the x86 architecture,
156       // our reference implementation is using 80 bit floating point
157       // arithmetic, while the SSE version is using 32 bit float point
158       // arithmetic.
159       
160       for (int o = 0; o < (int)(ol/decimate); o++){
161         CPPUNIT_ASSERT_COMPLEXES_EQUAL(expected_output[o], actual_output[o],
162                                        abs (expected_output[o]) * ERR_DELTA);
163       }
164       delete f1;
165     }
166   }
167   free16Align(input);
168 }