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