Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_fxpt_nco.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2002,2004 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 2, 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 #ifndef INCLUDED_GR_FXPT_NCO_H
23 #define INCLUDED_GR_FXPT_NCO_H
24
25 #include <gr_fxpt.h>
26 #include <gr_complex.h>
27
28 /*!
29  * \brief Numerically Controlled Oscillator (NCO)
30  */
31 class gr_fxpt_nco {
32   gr_int32      d_phase;
33   gr_int32      d_phase_inc;
34
35 public:
36   gr_fxpt_nco () : d_phase (0), d_phase_inc (0) {}
37
38   ~gr_fxpt_nco () {}
39
40   // radians
41   void set_phase (float angle) {
42     d_phase = gr_fxpt::float_to_fixed (angle);
43   }
44
45   void adjust_phase (float delta_phase) {
46     d_phase += gr_fxpt::float_to_fixed (delta_phase);
47   }
48
49   // angle_rate is in radians / step
50   void set_freq (float angle_rate){
51     d_phase_inc = gr_fxpt::float_to_fixed (angle_rate);
52   }
53
54   // angle_rate is a delta in radians / step
55   void adjust_freq (float delta_angle_rate)
56   {
57     d_phase_inc += gr_fxpt::float_to_fixed (delta_angle_rate);
58   }
59
60   // increment current phase angle
61
62   void step () 
63   { 
64     d_phase += d_phase_inc;
65   }
66
67   void step (int n)
68   {
69     d_phase += d_phase_inc * n;
70   }
71
72   // units are radians / step
73   float get_phase () const { return gr_fxpt::fixed_to_float (d_phase); }
74   float get_freq () const { return gr_fxpt::fixed_to_float (d_phase_inc); }
75
76   // compute sin and cos for current phase angle
77   void sincos (float *sinx, float *cosx) const
78   {
79     *sinx = gr_fxpt::sin (d_phase);
80     *cosx = gr_fxpt::cos (d_phase);
81   }
82
83   // compute cos and sin for a block of phase angles
84   void sincos (gr_complex *output, int noutput_items, double ampl=1.0)
85   {
86     for (int i = 0; i < noutput_items; i++){
87       output[i]   = gr_complex(gr_fxpt::cos (d_phase) * ampl, gr_fxpt::sin (d_phase) * ampl);
88       step ();
89     }
90   }
91
92   // compute sin for a block of phase angles
93   void sin (float *output, int noutput_items, double ampl=1.0)
94   {
95     for (int i = 0; i < noutput_items; i++){
96       output[i] = (float)(gr_fxpt::sin (d_phase) * ampl);
97       step ();
98     }
99   }
100
101   // compute cos for a block of phase angles
102   void cos (float *output, int noutput_items, double ampl=1.0)
103   {
104     for (int i = 0; i < noutput_items; i++){
105       output[i] = (float)(gr_fxpt::cos (d_phase) * ampl);
106       step ();
107     }
108   }
109
110   // compute sin for a block of phase angles
111   void sin (short *output, int noutput_items, double ampl=1.0)
112   {
113     for (int i = 0; i < noutput_items; i++){
114       output[i] = (short)(gr_fxpt::sin (d_phase) * ampl);
115       step ();
116     }
117   }
118
119   // compute cos for a block of phase angles
120   void cos (short *output, int noutput_items, double ampl=1.0)
121   {
122     for (int i = 0; i < noutput_items; i++){
123       output[i] = (short)(gr_fxpt::cos (d_phase) * ampl);
124       step ();
125     }
126   }
127
128   // compute sin for a block of phase angles
129   void sin (int *output, int noutput_items, double ampl=1.0)
130   {
131     for (int i = 0; i < noutput_items; i++){
132       output[i] = (int)(gr_fxpt::sin (d_phase) * ampl);
133       step ();
134     }
135   }
136
137   // compute cos for a block of phase angles
138   void cos (int *output, int noutput_items, double ampl=1.0)
139   {
140     for (int i = 0; i < noutput_items; i++){
141       output[i] = (int)(gr_fxpt::cos (d_phase) * ampl);
142       step ();
143     }
144   }
145
146   // compute cos or sin for current phase angle
147   float cos () const { return gr_fxpt::cos (d_phase); }
148   float sin () const { return gr_fxpt::sin (d_phase); }
149 };
150
151 #endif /* INCLUDED_GR_FXPT_NCO_H */