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