Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-examples / python / usrp / usrp_wfm_rcv_pll.py
1 #!/usr/bin/env python
2
3 from gnuradio import gr, gru, eng_notation, optfir
4 from gnuradio import audio
5 from gnuradio import usrp
6 from gnuradio import blks
7 from gnuradio.eng_option import eng_option
8 from gnuradio.wxgui import slider, powermate
9 from gnuradio.wxgui import stdgui, fftsink, form, scopesink
10 from optparse import OptionParser
11 import usrp_dbid
12 import sys
13 import math
14 import wx
15
16 def pick_subdevice(u):
17     """
18     The user didn't specify a subdevice on the command line.
19     Try for one of these, in order: TV_RX, BASIC_RX, whatever is on side A.
20
21     @return a subdev_spec
22     """
23     return usrp.pick_subdev(u, (usrp_dbid.TV_RX,
24                                 usrp_dbid.TV_RX_REV_2,
25                                 usrp_dbid.BASIC_RX))
26
27 class wfm_rx_graph (stdgui.gui_flow_graph):
28     def __init__(self,frame,panel,vbox,argv):
29         stdgui.gui_flow_graph.__init__ (self,frame,panel,vbox,argv)
30
31         parser=OptionParser(option_class=eng_option)
32         parser.add_option("-R", "--rx-subdev-spec", type="subdev", default=None,
33                           help="select USRP Rx side A or B (default=A)")
34         parser.add_option("-f", "--freq", type="eng_float", default=100.1e6,
35                           help="set frequency to FREQ", metavar="FREQ")
36         parser.add_option("-g", "--gain", type="eng_float", default=65,
37                           help="set gain in dB (default is midpoint)")
38         parser.add_option("-s", "--squelch", type="eng_float", default=0,
39                           help="set squelch level (default is 0)")
40         parser.add_option("-V", "--volume", type="eng_float", default=None,
41                           help="set volume (default is midpoint)")
42         parser.add_option("-O", "--audio-output", type="string", default="",
43                           help="pcm device name.  E.g., hw:0,0 or surround51 or /dev/dsp")
44
45
46         (options, args) = parser.parse_args()
47         if len(args) != 0:
48             parser.print_help()
49             sys.exit(1)
50         
51         self.frame = frame
52         self.panel = panel
53         
54         self.vol = 0
55         self.state = "FREQ"
56         self.freq = 0
57
58         # build graph
59         
60         self.u = usrp.source_c()                    # usrp is data source
61
62         adc_rate = self.u.adc_rate()                # 64 MS/s
63         usrp_decim = 200
64         self.u.set_decim_rate(usrp_decim)
65         usrp_rate = adc_rate / usrp_decim           # 320 kS/s
66         chanfilt_decim = 1
67         demod_rate = usrp_rate / chanfilt_decim
68         audio_decimation = 10
69         audio_rate = demod_rate / audio_decimation  # 32 kHz
70
71         if options.rx_subdev_spec is None:
72             options.rx_subdev_spec = pick_subdevice(self.u)
73
74         self.u.set_mux(usrp.determine_rx_mux_value(self.u, options.rx_subdev_spec))
75         self.subdev = usrp.selected_subdev(self.u, options.rx_subdev_spec)
76
77
78         chan_filt_coeffs = optfir.low_pass (1,           # gain
79                                             usrp_rate,   # sampling rate
80                                             80e3,        # passband cutoff
81                                             115e3,       # stopband cutoff
82                                             0.1,         # passband ripple
83                                             60)          # stopband attenuation
84         #print len(chan_filt_coeffs)
85         chan_filt = gr.fir_filter_ccf (chanfilt_decim, chan_filt_coeffs)
86
87
88         #self.guts = blks.wfm_rcv (self, demod_rate, audio_decimation)
89         self.guts = blks.wfm_rcv_pll (self, demod_rate, audio_decimation)
90
91         # FIXME rework {add,multiply}_const_* to handle multiple streams
92         self.volume_control_l = gr.multiply_const_ff(self.vol)
93         self.volume_control_r = gr.multiply_const_ff(self.vol)
94
95         # sound card as final sink
96         audio_sink = audio.sink (int (audio_rate),
97                                  options.audio_output,
98                                  False)   # ok_to_block
99         
100         # now wire it all together
101         self.connect (self.u, chan_filt, self.guts)
102         self.connect ((self.guts, 0), self.volume_control_l, (audio_sink, 0))
103         self.connect ((self.guts, 1), self.volume_control_r, (audio_sink, 1))
104         self.guts.stereo_carrier_pll_recovery.squelch_enable(True);
105
106         self._build_gui(vbox, usrp_rate, demod_rate, audio_rate)
107
108         if options.gain is None:
109             # if no gain was specified, use the mid-point in dB
110             g = self.subdev.gain_range()
111             options.gain = float(g[0]+g[1])/2
112
113         if options.volume is None:
114             g = self.volume_range()
115             options.volume = float(g[0]+g[1])/2
116
117         if abs(options.freq) < 1e6:
118             options.freq *= 1e6
119
120         # set initial values
121
122         self.set_gain(options.gain)
123         self.set_vol(options.volume)
124         self.guts.stereo_carrier_pll_recovery.set_lock_threshold(options.squelch);
125         if not(self.set_freq(options.freq)):
126             self._set_status_msg("Failed to set initial frequency")
127
128
129     def _set_status_msg(self, msg, which=0):
130         self.frame.GetStatusBar().SetStatusText(msg, which)
131
132
133     def _build_gui(self, vbox, usrp_rate, demod_rate, audio_rate):
134
135         def _form_set_freq(kv):
136             return self.set_freq(kv['freq'])
137
138
139         if 1:
140             self.src_fft = fftsink.fft_sink_c (self, self.panel, title="Data from USRP",
141                                                fft_size=512, sample_rate=usrp_rate)
142             self.connect (self.u, self.src_fft)
143             vbox.Add (self.src_fft.win, 4, wx.EXPAND)
144
145         if 1:
146             post_fm_demod_fft = fftsink.fft_sink_f (self, self.panel, title="Post FM Demod",
147                                                   fft_size=512, sample_rate=demod_rate,
148                                                   y_per_div=10, ref_level=0)
149             self.connect (self.guts.fm_demod, post_fm_demod_fft)
150             vbox.Add (post_fm_demod_fft.win, 4, wx.EXPAND)
151
152         if 0:
153             post_stereo_carrier_generator_fft = fftsink.fft_sink_c (self, self.panel, title="Post Stereo_carrier_generator",
154                                                   fft_size=512, sample_rate=audio_rate,
155                                                   y_per_div=10, ref_level=0)
156             self.connect (self.guts.stereo_carrier_generator, post_stereo_carrier_generator_fft)
157             vbox.Add (post_stereo_carrier_generator_fft.win, 4, wx.EXPAND)
158
159         if 0:
160             post_deemphasis_left = fftsink.fft_sink_f (self, self.panel, title="Post_Deemphasis_Left",
161                                                   fft_size=512, sample_rate=audio_rate,
162                                                   y_per_div=10, ref_level=0)
163             self.connect (self.guts.deemph_Left, post_deemphasis_left)
164             vbox.Add (post_deemphasis_left.win, 4, wx.EXPAND)
165
166         if 0:
167             post_deemphasis_right = fftsink.fft_sink_f (self, self.panel, title="Post_Deemphasis_Right",
168                                                   fft_size=512, sample_rate=audio_rate,
169                                                   y_per_div=10, ref_level=-20)
170             self.connect (self.guts.deemph_Left, post_deemphasis_right)
171             vbox.Add (post_deemphasis_right.win, 4, wx.EXPAND)
172
173
174         if 0:
175             LmR_fft = fftsink.fft_sink_f (self, self.panel, title="LmR", 
176                                                 fft_size=512, sample_rate=audio_rate,
177                                                 y_per_div=10, ref_level=-20)
178             self.connect (self.guts.LmR_real,LmR_fft)
179             vbox.Add (LmR_fft.win, 4, wx.EXPAND)
180
181         if 0:
182             self.scope = scopesink.scope_sink_f(self, self.panel, sample_rate=demod_rate)
183             self.connect (self.guts.fm_demod_a,self.scope)
184             vbox.Add (self.scope.win,4,wx.EXPAND)
185         
186         # control area form at bottom
187         self.myform = myform = form.form()
188
189         hbox = wx.BoxSizer(wx.HORIZONTAL)
190         hbox.Add((5,0), 0)
191         myform['freq'] = form.float_field(
192             parent=self.panel, sizer=hbox, label="Freq", weight=1,
193             callback=myform.check_input_and_call(_form_set_freq, self._set_status_msg))
194
195         hbox.Add((5,0), 0)
196         myform['freq_slider'] = \
197             form.quantized_slider_field(parent=self.panel, sizer=hbox, weight=3,
198                                         range=(87.9e6, 108.1e6, 0.1e6),
199                                         callback=self.set_freq)
200         hbox.Add((5,0), 0)
201         vbox.Add(hbox, 0, wx.EXPAND)
202
203         hbox = wx.BoxSizer(wx.HORIZONTAL)
204         hbox.Add((5,0), 0)
205
206         myform['volume'] = \
207             form.quantized_slider_field(parent=self.panel, sizer=hbox, label="Volume",
208                                         weight=3, range=self.volume_range(),
209                                         callback=self.set_vol)
210         hbox.Add((5,0), 1)
211
212         myform['gain'] = \
213             form.quantized_slider_field(parent=self.panel, sizer=hbox, label="Gain",
214                                         weight=3, range=self.subdev.gain_range(),
215                                         callback=self.set_gain)
216         hbox.Add((5,0), 0)
217
218         myform['sqlch_thrsh'] = \
219             form.quantized_slider_field(parent=self.panel, sizer=hbox, label="Stereo Squelch Threshold",
220                                         weight=3, range=(0.0,1.0,0.01),
221                                         callback=self.guts.stereo_carrier_pll_recovery.set_lock_threshold)
222         hbox.Add((5,0), 0)
223         vbox.Add(hbox, 0, wx.EXPAND)
224
225         try:
226             self.knob = powermate.powermate(self.frame)
227             self.rot = 0
228             powermate.EVT_POWERMATE_ROTATE (self.frame, self.on_rotate)
229             powermate.EVT_POWERMATE_BUTTON (self.frame, self.on_button)
230         except:
231             print "FYI: No Powermate or Contour Knob found"
232
233
234     def on_rotate (self, event):
235         self.rot += event.delta
236         if (self.state == "FREQ"):
237             if self.rot >= 3:
238                 self.set_freq(self.freq + .1e6)
239                 self.rot -= 3
240             elif self.rot <=-3:
241                 self.set_freq(self.freq - .1e6)
242                 self.rot += 3
243         else:
244             step = self.volume_range()[2]
245             if self.rot >= 3:
246                 self.set_vol(self.vol + step)
247                 self.rot -= 3
248             elif self.rot <=-3:
249                 self.set_vol(self.vol - step)
250                 self.rot += 3
251             
252     def on_button (self, event):
253         if event.value == 0:        # button up
254             return
255         self.rot = 0
256         if self.state == "FREQ":
257             self.state = "VOL"
258         else:
259             self.state = "FREQ"
260         self.update_status_bar ()
261         
262
263     def set_vol (self, vol):
264         g = self.volume_range()
265         self.vol = max(g[0], min(g[1], vol))
266         self.volume_control_l.set_k(10**(self.vol/10))
267         self.volume_control_r.set_k(10**(self.vol/10))
268         self.myform['volume'].set_value(self.vol)
269         self.update_status_bar ()
270                                         
271     def set_freq(self, target_freq):
272         """
273         Set the center frequency we're interested in.
274
275         @param target_freq: frequency in Hz
276         @rypte: bool
277
278         Tuning is a two step process.  First we ask the front-end to
279         tune as close to the desired frequency as it can.  Then we use
280         the result of that operation and our target_frequency to
281         determine the value for the digital down converter.
282         """
283         r = usrp.tune(self.u, 0, self.subdev, target_freq)
284         
285         if r:
286             self.freq = target_freq
287             self.myform['freq'].set_value(target_freq)         # update displayed value
288             self.myform['freq_slider'].set_value(target_freq)  # update displayed value
289             self.update_status_bar()
290             self._set_status_msg("OK", 0)
291             return True
292
293         self._set_status_msg("Failed", 0)
294         return False
295
296     def set_gain(self, gain):
297         self.myform['gain'].set_value(gain)     # update displayed value
298         self.subdev.set_gain(gain)
299
300     def update_status_bar (self):
301         msg = "Volume:%r  Setting:%s" % (self.vol, self.state)
302         self._set_status_msg(msg, 1)
303         self.src_fft.set_baseband_freq(self.freq)
304
305     def volume_range(self):
306         return (-20.0, 0.0, 0.5)
307         
308
309 if __name__ == '__main__':
310     app = stdgui.stdapp (wfm_rx_graph, "USRP WFM RX")
311     app.MainLoop ()