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