Organized python example directory for new hierarchical blocks, cleaned up dial_tone2.py
[debian/gnuradio] / gnuradio-examples / python / hier / audio / dial_tone2.py
1 #!/usr/bin/env python
2 #
3 # Copyright 2004,2005,2006 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
23 from gnuradio import gr
24 from gnuradio import audio
25 from gnuradio.eng_option import eng_option
26 from optparse import OptionParser
27
28 # Top-level block creating a dial tone
29 # Derives from new class gr.hier_block2
30 class dial_tone(gr.hier_block2):
31         def __init__(self, 
32                      sample_rate,  # Audio output sample rate (int)
33                      audio_output, # Audio output device
34                      amplitude):   # Output volume (0.0-1.0)
35
36                 # Call hierarchical block constructor
37                 # Top-level blocks have no inputs or outputs
38                 gr.hier_block2.__init__(self, 
39                                         "dial_tone",            # Block type 
40                                         gr.io_signature(0,0,0), # Input signature
41                                         gr.io_signature(0,0,0)) # Output signature
42
43                 # Hierarchical blocks have a set of 'components' (which may
44                 # be themselves hierarchical blocks), mapped to names.
45                 # 'define_component' takes a string and either a hierarchical 
46                 # block or an instance of a 'leaf node' (gr_block) block
47
48                 # Give names to two sine wave sources and an audio sink
49                 self.define_component("src0", gr.sig_source_f (sample_rate, gr.GR_SIN_WAVE, 350, amplitude))
50                 self.define_component("src1", gr.sig_source_f (sample_rate, gr.GR_SIN_WAVE, 440, amplitude))
51                 self.define_component("dst",  audio.sink(sample_rate, audio_output))
52
53                 # Wire up outputs to inputs. (TODO: convenience functions)
54                 self.connect("src0", 0, "dst", 0)       
55                 self.connect("src1", 0, "dst", 1)
56         
57 if __name__ == '__main__':
58         parser = OptionParser(option_class=eng_option)
59         parser.add_option("-O", "--audio-output", type="string", default="",
60                           help="pcm output device name.  E.g., hw:0,0 or /dev/dsp")
61         parser.add_option("-r", "--sample-rate", type="eng_float", default=48000,
62                           help="set sample rate to RATE (48000)")
63         parser.add_option("-a", "--amplitude", type="eng_float", default=0.1,
64                           help="set output volume to AMPLITUDE (0.1)")
65         (options, args) = parser.parse_args()
66         if len(args) != 0:
67             parser.print_help()
68             raise SystemExit, 1
69
70         # Create an instance of a hierarchical block
71         top_block = dial_tone(int(options.sample_rate), 
72                               options.audio_output, 
73                               options.amplitude)
74                               
75         # Create an instance of a runtime, passing it the top block
76         # to process
77         runtime = gr.runtime(top_block)
78
79         try:    
80                 # Run forever
81                 runtime.run()
82         except KeyboardInterrupt:
83                 # Ctrl-C exits
84                 pass