git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/filter/gr_pfb_clock_sync_ccf.cc

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2009 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 <cstdio>
  28 #include <cmath>
  29
  30 #include <gr_pfb_clock_sync_ccf.h>
  31 #include <gr_fir_ccf.h>
  32 #include <gr_fir_util.h>
  33 #include <gr_io_signature.h>
  34 #include <gr_math.h>
  35
  36 gr_pfb_clock_sync_ccf_sptr gr_make_pfb_clock_sync_ccf (double sps, float gain,
  37                                                        const std::vector<float> &taps,
  38                                                        unsigned int filter_size,
  39                                                        float init_phase,
  40                                                        float max_rate_deviation)
  41 {
  42   return gr_pfb_clock_sync_ccf_sptr (new gr_pfb_clock_sync_ccf (sps, gain, taps,
  43                                                                 filter_size,
  44                                                                 init_phase,
  45                                                                 max_rate_deviation));
  46 }
  47
  48 int ios[] = {sizeof(gr_complex), sizeof(float), sizeof(float), sizeof(float)};
  49 std::vector<int> iosig(ios, ios+sizeof(ios)/sizeof(int));
  50 gr_pfb_clock_sync_ccf::gr_pfb_clock_sync_ccf (double sps, float gain,
  51                                               const std::vector<float> &taps,
  52                                               unsigned int filter_size,
  53                                               float init_phase,
  54                                               float max_rate_deviation)
  55   : gr_block ("pfb_clock_sync_ccf",
  56               gr_make_io_signature (1, 1, sizeof(gr_complex)),
  57               gr_make_io_signaturev (1, 4, iosig)),
  58     d_updated (false), d_nfilters(filter_size),
  59     d_max_dev(max_rate_deviation)
  60 {
  61   d_nfilters = filter_size;
  62   d_sps = floor(sps);
  63
  64   // Store the last filter between calls to work
  65   // The accumulator keeps track of overflow to increment the stride correctly.
  66   // set it here to the fractional difference based on the initial phaes
  67   set_alpha(gain);
  68   set_beta(0.25*gain*gain);
  69   d_k = init_phase;
  70   d_rate = (sps-floor(sps))*(double)d_nfilters;
  71   d_filtnum = (int)floor(d_k);
  72
  73   d_filters = std::vector<gr_fir_ccf*>(d_nfilters);
  74   d_diff_filters = std::vector<gr_fir_ccf*>(d_nfilters);
  75
  76   // Create an FIR filter for each channel and zero out the taps
  77   std::vector<float> vtaps(0, d_nfilters);
  78   for(unsigned int i = 0; i < d_nfilters; i++) {
  79     d_filters[i] = gr_fir_util::create_gr_fir_ccf(vtaps);
  80     d_diff_filters[i] = gr_fir_util::create_gr_fir_ccf(vtaps);
  81   }
  82
  83   // Now, actually set the filters' taps
  84   std::vector<float> dtaps;
  85   create_diff_taps(taps, dtaps);
  86   set_taps(taps, d_taps, d_filters);
  87   set_taps(dtaps, d_dtaps, d_diff_filters);
  88 }
  89
  90 gr_pfb_clock_sync_ccf::~gr_pfb_clock_sync_ccf ()
  91 {
  92   for(unsigned int i = 0; i < d_nfilters; i++) {
  93     delete d_filters[i];
  94   }
  95 }
  96
  97 void
  98 gr_pfb_clock_sync_ccf::set_taps (const std::vector<float> &newtaps,
  99                                  std::vector< std::vector<float> > &ourtaps,
 100                                  std::vector<gr_fir_ccf*> &ourfilter)
 101 {
 102   int i,j;
 103
 104   unsigned int ntaps = newtaps.size();
 105   d_taps_per_filter = (unsigned int)ceil((double)ntaps/(double)d_nfilters);
 106
 107   // Create d_numchan vectors to store each channel's taps
 108   ourtaps.resize(d_nfilters);
 109
 110   // Make a vector of the taps plus fill it out with 0's to fill
 111   // each polyphase filter with exactly d_taps_per_filter
 112   std::vector<float> tmp_taps;
 113   tmp_taps = newtaps;
 114   while((float)(tmp_taps.size()) < d_nfilters*d_taps_per_filter) {
 115     tmp_taps.push_back(0.0);
 116   }
 117
 118   // Partition the filter
 119   for(i = 0; i < d_nfilters; i++) {
 120     // Each channel uses all d_taps_per_filter with 0's if not enough taps to fill out
 121     ourtaps[d_nfilters-1-i] = std::vector<float>(d_taps_per_filter, 0);
 122     for(j = 0; j < d_taps_per_filter; j++) {
 123       ourtaps[d_nfilters - 1 - i][j] = tmp_taps[i + j*d_nfilters];
 124     }
 125
 126     // Build a filter for each channel and add it's taps to it
 127     ourfilter[i]->set_taps(ourtaps[d_nfilters-1-i]);
 128   }
 129
 130   // Set the history to ensure enough input items for each filter
 131   set_history (d_taps_per_filter + d_sps);
 132
 133   d_updated = true;
 134 }
 135
 136 void
 137 gr_pfb_clock_sync_ccf::create_diff_taps(const std::vector<float> &newtaps,
 138                                         std::vector<float> &difftaps)
 139 {
 140   difftaps.clear();
 141   difftaps.push_back(0); //newtaps[0]);
 142   for(unsigned int i = 1; i < newtaps.size()-1; i++) {
 143     float tap = newtaps[i+1] - newtaps[i-1];
 144     difftaps.push_back(tap);
 145   }
 146   difftaps.push_back(0);//-newtaps[newtaps.size()-1]);
 147 }
 148
 149 void
 150 gr_pfb_clock_sync_ccf::print_taps()
 151 {
 152   unsigned int i, j;
 153   printf("[ ");
 154   for(i = 0; i < d_nfilters; i++) {
 155     printf("[%.4e, ", d_taps[i][0]);
 156     for(j = 1; j < d_taps_per_filter-1; j++) {
 157       printf("%.4e,", d_taps[i][j]);
 158     }
 159     printf("%.4e],", d_taps[i][j]);
 160   }
 161   printf(" ]\n");
 162 }
 163
 164 void
 165 gr_pfb_clock_sync_ccf::print_diff_taps()
 166 {
 167   unsigned int i, j;
 168   printf("[ ");
 169   for(i = 0; i < d_nfilters; i++) {
 170     printf("[%.4e, ", d_dtaps[i][0]);
 171     for(j = 1; j < d_taps_per_filter-1; j++) {
 172       printf("%.4e,", d_dtaps[i][j]);
 173     }
 174     printf("%.4e],", d_dtaps[i][j]);
 175   }
 176   printf(" ]\n");
 177 }
 178
 179
 180 std::vector<float>
 181 gr_pfb_clock_sync_ccf::channel_taps(int channel)
 182 {
 183   std::vector<float> taps;
 184   unsigned int i;
 185   for(i = 0; i < d_taps_per_filter; i++) {
 186     taps.push_back(d_taps[channel][i]);
 187   }
 188   return taps;
 189 }
 190
 191 std::vector<float>
 192 gr_pfb_clock_sync_ccf::diff_channel_taps(int channel)
 193 {
 194   std::vector<float> taps;
 195   unsigned int i;
 196   for(i = 0; i < d_taps_per_filter; i++) {
 197     taps.push_back(d_dtaps[channel][i]);
 198   }
 199   return taps;
 200 }
 201
 202
 203 int
 204 gr_pfb_clock_sync_ccf::general_work (int noutput_items,
 205                                      gr_vector_int &ninput_items,
 206                                      gr_vector_const_void_star &input_items,
 207                                      gr_vector_void_star &output_items)
 208 {
 209   gr_complex *in = (gr_complex *) input_items[0];
 210   gr_complex *out = (gr_complex *) output_items[0];
 211
 212   float *err, *outrate, *outk;
 213   if(output_items.size() > 2) {
 214     err = (float *) output_items[1];
 215     outrate = (float*)output_items[2];
 216     outk = (float*)output_items[3];
 217   }
 218
 219   if (d_updated) {
 220     d_updated = false;
 221     return 0;                // history requirements may have changed.
 222   }
 223
 224   // We need this many to process one output
 225   int nrequired = ninput_items[0] - d_taps_per_filter;
 226
 227   int i = 0, count = 0;
 228   float error, error_r, error_i;
 229
 230   // produce output as long as we can and there are enough input samples
 231   while((i < noutput_items) && (count < nrequired)) {
 232     d_filtnum = (int)floor(d_k);
 233
 234     // Keep the current filter number in [0, d_nfilters]
 235     // If we've run beyond the last filter, wrap around and go to next sample
 236     // If we've go below 0, wrap around and go to previous sample
 237     while(d_filtnum >= d_nfilters) {
 238       d_k -= d_nfilters;
 239       d_filtnum -= d_nfilters;
 240       count += 1;
 241     }
 242     while(d_filtnum < 0) {
 243       d_k += d_nfilters;
 244       d_filtnum += d_nfilters;
 245       count -= 1;
 246     }
 247
 248     out[i] = d_filters[d_filtnum]->filter(&in[count]);
 249     gr_complex diff = d_diff_filters[d_filtnum]->filter(&in[count]);
 250     error_r  = out[i].real() * diff.real();
 251     error_i  = out[i].imag() * diff.imag();
 252     error = (error_i + error_r) / 2.0;       // average error from I&Q channel
 253
 254     // Run the control loop to update the current phase (k) and tracking rate
 255     d_k = d_k + d_alpha*error + d_rate;
 256     d_rate = d_rate + d_beta*error;
 257
 258     // Keep our rate within a good range
 259     d_rate = gr_branchless_clip(d_rate, d_max_dev);
 260
 261     i++;
 262     count += (int)floor(d_sps);
 263
 264     if(output_items.size() > 2) {
 265       err[i] = error;
 266       outrate[i] = d_rate;
 267       outk[i] = d_k;
 268     }
 269   }
 270   consume_each(count);
 271
 272   return i;
 273 }