Imported Upstream version 3.0
[debian/gnuradio] / gr-audio-portaudio / README
1 These instructions are intended for Linux. On other systems you will have to
2 construct something compatible to build gr-audio-portaudio.
3
4 In order to use portaudio with gnuradio you will need to download and install
5 a late version of portaudio.  Please cd to a directory where the cvs command
6 below will be allowed to build the portaudio directory tree.
7
8 cvs -d:pserver:anonymous@www.portaudio.com:/home/cvs co -r v19-devel portaudio
9
10 This will make a directory portaudio unless you already have one.  It will
11 check out the Portaudio API version 2 release 1.9.
12
13 In the directory where this README is found, there is a patch file.  Hopefully
14 this patch will not be needed for long.  Portaudio is working with us to use
15 auto*, libtool, etc.  The patch is autoconfiscate.patch.  
16
17 cd to the portaudio directory and run
18
19 patch -p0 <autoconfiscate.patch
20
21 this will modify the portaudio source tree to use standard tools and prepare
22 it for use with gnuradio.  Now run
23
24 chmod u+x bootstrap
25
26 you may need to edit bootstrap and remove the 2.50 at the end of some of the
27 commands (on SUSE 10.0 for example).
28
29 ./bootstrap
30
31 ./configure --help 
32
33
34 will reveal the options for configure that are available to you. If you do not
35 understand the options or wish to accept the defaults please just run
36
37 ./configure
38
39 If you do not want the includes and libraries install in /usr/local (standard)
40 then enter the prefix arguments to ./configure.  This document will assume you
41 are doing the standard installation and that will be into /usr/local.
42
43 On Linux if you have the jack tool available from 
44
45 http://jackit.sourceforge.net
46
47 the portaudio configure will enable the library to talk to jack.
48
49 Now you are ready to make the portaudio library.
50
51 make; sudo make install;sudo ldconfig  (possibly /sbin/ldconfig).
52
53 will make the code and install it into the prefix (/usr/local) selected and
54 will cache the configuration information for other programs to use for their
55 configuration options.
56
57 Now you are ready to install gr-audio-portaudio.  In the gr-build directory
58 you may run
59
60 cvs co gr-audio-portaudio
61
62 cd gr-audio-portaudio
63 ../buildit
64
65 will configure, make, and install the portaudio sink and source.
66
67 In gnuradio-examples/python/audio please test by running
68
69 ./mono_tone_portaudio.py
70
71
72 If this runs you are likely in business but this chooses the default device
73 (typically /dev/dsp which is being run by alsa under oss emulation and on a
74 Mac it will choose coreaudio).
75
76 ./mono_tone_portaudio.py -O hw:0,0
77
78 chooses the default alsa device.
79
80 ./mono_tone_portaudio.py -O /dev/dsp
81
82 will force the use of OSS and the default oss device. To run with jack,  you
83 will probably enter the following command:
84
85 ./mono_tone_portaudio.py -O alsa_pcm
86
87
88 In the portaudio directory,  you may list the devices visible to portaudio by
89 searching for and running the command
90
91 pa_devs
92