Updated license from GPL version 2 or later to GPL version 3 or later.
[debian/gnuradio] / gr-cvsd-vocoder / src / lib / cvsd_decode_bs.cc
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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 /*
24  * config.h is generated by configure.  It contains the results
25  * of probing for features, options etc.  It should be the first
26  * file included in your .cc file.
27  */
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include <cvsd_decode_bs.h>
33 #include <gr_io_signature.h>
34
35 /*
36  * Create a new instance of cvsd_decode_bs and return
37  * a boost shared_ptr.  This is effectively the public constructor.
38  */
39 cvsd_decode_bs_sptr 
40 cvsd_make_decode_bs (short min_step, short max_step, double step_decay,
41                      double accum_decay,  int K, int J,
42                      short pos_accum_max, short neg_accum_max)
43 {
44   return cvsd_decode_bs_sptr (new cvsd_decode_bs (min_step, max_step,
45                                                   step_decay, accum_decay, K, J,
46                                                   pos_accum_max, neg_accum_max));
47 }
48
49 cvsd_decode_bs::cvsd_decode_bs (short min_step, short max_step, double step_decay, 
50                                 double accum_decay, int K, int J,
51                                 short pos_accum_max, short neg_accum_max)
52   : gr_sync_interpolator ("cvsd_decode_bs",
53                           gr_make_io_signature (1, 1, sizeof (unsigned char)),
54                           gr_make_io_signature (1, 1, sizeof (short)),
55                           8),
56     d_min_step (min_step), d_max_step(max_step), d_step_decay(step_decay),
57     d_accum_decay(accum_decay), d_K(K), d_J(J), 
58     d_pos_accum_max(pos_accum_max), d_neg_accum_max(neg_accum_max),
59     d_accum(0), 
60     d_loop_counter(1), 
61     d_runner(0),
62     d_runner_mask(0),
63     d_stepsize(min_step)
64   
65 {
66   assert(d_pos_accum_max <= SHRT_MAX);
67   assert(d_neg_accum_max >= -SHRT_MAX);
68   assert(d_K <= 32);
69   assert(d_J <= d_K);
70   
71   // nothing else required in this example
72 }
73
74
75 cvsd_decode_bs::~cvsd_decode_bs ()
76 {
77   // nothing else required in this example
78 }
79
80 unsigned char cvsd_decode_bs::cvsd_bitwise_sum (unsigned int input)
81 {
82   unsigned int temp=input;
83   unsigned char bits=0;
84   
85   while(temp) {
86     temp=temp&(temp-1);
87     bits++;
88   }
89   return bits;
90 }
91
92 int cvsd_decode_bs::cvsd_round (double input)
93 {
94   double temp;
95   temp=input+0.5;
96   temp=floor(temp);
97   
98   return (int)temp;
99 }
100
101 unsigned int cvsd_decode_bs::cvsd_pow (short radix, short power)
102 {
103   double d_radix = (double) radix;
104   int i_power = (int) power;
105   double output;
106   
107   output=pow(d_radix,i_power);
108   return ( (unsigned int) cvsd_round(output));  
109 }
110
111
112 int 
113 cvsd_decode_bs::work (int noutput_items,
114                       gr_vector_const_void_star &input_items,
115                       gr_vector_void_star &output_items)
116 {
117  
118
119   const unsigned char *in = (const unsigned char *) input_items[0];
120   short *out = (short *) output_items[0];
121
122   int i=0;
123   short output_short=0;          // 2 bytes 0 .. 65,535
124   unsigned char bit_count=0;     // 1 byte, 0 .. 255
125   unsigned int mask=0;           // 4 bytes, 0 .. 4,294,967,295
126   unsigned char input_byte=0;    //  1 bytes
127   unsigned char input_bit=0;     // 1 byte, 0 .. 255
128   
129   // Loop through each input data point
130   for(i = 0; i < noutput_items/8.0; i++) {
131
132     input_byte = in[i];
133     // Initiliaze bit counter
134     bit_count=0;        
135     
136     while(bit_count<8) {
137       // Compute the Appropriate Mask
138       mask=cvsd_pow(2,7-bit_count);
139       
140       // Pull off the corresponding bit
141       input_bit = input_byte & mask;
142       
143       // Update the bit counter
144       bit_count++;
145       
146       // Update runner with the next input bit
147       // Runner is a shift-register; shift left, add on newest output bit
148       d_runner = (d_runner<<1) | ((unsigned int) input_bit);
149       
150       // Run this only if you have >= J bits in your shift register
151       if (d_loop_counter>=d_J) {
152         // Update Step Size
153         d_runner_mask=(cvsd_pow(2,d_J)-1);
154         if ((cvsd_bitwise_sum(d_runner & d_runner_mask)>=d_J)||(cvsd_bitwise_sum((~d_runner) & d_runner_mask)>=d_J)) {
155           // Runs of 1s and 0s
156           d_stepsize = std::min( (short) (d_stepsize + d_min_step), d_max_step);
157         }
158         else {
159           // No runs of 1s and 0s
160           d_stepsize = std::max( (short) cvsd_round(d_stepsize*d_step_decay), d_min_step);
161         }
162       }
163       
164       // Update Accum (i.e. the reference value)
165       if (input_bit) {
166         d_accum=d_accum+d_stepsize;
167       }
168       else {
169         d_accum=d_accum-d_stepsize;
170       }
171       
172       // Multiply by Accum_Decay
173       d_accum=(cvsd_round(d_accum*d_accum_decay));
174       
175       // Check for overflow
176       if (d_accum >=((int) d_pos_accum_max)) {
177         d_accum=(int)d_pos_accum_max;
178       }
179       else if (d_accum <=((int) d_neg_accum_max)) {
180         d_accum=(int)d_neg_accum_max;
181       }
182       
183       // Find the output short to write to the file
184       output_short=((short) d_accum);
185       
186       if (d_loop_counter <= d_K) {
187         d_loop_counter++;
188       }
189       
190       *(out++) = output_short;
191     } // while ()       
192     
193   } // for()
194   
195   return noutput_items;
196 }