root/trunk/libffado/README

Revision 742, 7.0 kB (checked in by ppalmers, 13 years ago)

- Remove some obsolete support files and dirs

- Clean up the license statements in the source files. Everything is

GPL version 3 now.

- Add license and copyright notices to scons scripts

- Clean up some other text files

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 FFADO version 1.999.7
2 =====================
3
4 This project aims to provide a free driver implemenation for the BeBoB
5 platform.  The BeBoB is used in many available IEEE 1394 based break-out
6 boxes.
7
8 Dependencies
9 ------------
10
11 To build libffado you need several libraries. For all libraries a
12 version is provided which is a 'known good' version.  The first few
13 libraries it seems it is not necessary that the version must
14 match. The chances that it works also with an older versions are good:
15
16 alsa        (>= 1.0.0)
17 libxml++2   (>= 2.13.0)
18
19 These libraries here should be at least the version listed:
20
21 libraw1394  (>= 1.3.0),  http://www.linux1394.org
22 libiec61883 (>= 1.1.0),  http://www.linux1394.org
23 libavc1394  (>= 0.5.3),  http://sourceforge.net/projects/libavc1394
24 dbus-1      (>= 1.0),    http://dbus.freedesktop.org
25
26 Currently only the jackd audio server is supported.
27
28 jackd (>= 0.107.6), http://jackaudio.org
29
30 Optionally, but recommended is that you install qjackctl:
31
32 qjackctl (>= 0.2.20.10), http://sourceforge.net/projects/qjackctl
33
34 How to build
35 ------------
36
37 Building the code is straight forward if PKG_CONFIG_PATH, LD_LIBRARY_PATH
38 and INCLUDE_PATH is correctly set up.
39
40 E.g on my system I have installed libraw1394, libiec61883 and libavc1394
41 under /usr/local:
42
43 $ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
44 $ export LD_LIBRARY_PATH=/usr/local/lib
45
46 If you want to build the release version you can do following:
47
48 $ scons
49 $ scons install
50
51 If you want some debug information (because something seems not
52 to work correctly) you can try to do following:
53
54 $ scons DEBUG=yes
55 $ scons install
56
57 NOTE: In order to build jackd with ffado support, you have
58 to install libffado before you build jackd. The backend to use in jackd is
59 firewire.
60
61 DISTRIBUTION PACKAGERS NOTE: Please do not enable support for devices
62 if it is not on by default. If device support for a specific device
63 is not turned on by default by the developers, it means that it is not
64 ready yet. Most of the time it is placeholder code for future devices.
65
66 Running jackd
67 -------------
68
69 The easiest way to run this is using qjackctl. There are only minor
70 differences with the other backends, however you should change some
71 of the default values:
72 - The 'interface' field should contain only a number. This number is
73   the port number of the IEEE1394 host controller the audio device
74   is connected to. For most people this will be '0', but if you have
75   multiple controllers, you have to change this number.
76 - The 'Input channels' and 'Output channels' fields indicate if the
77   backend should provide capture and/or playback channels. If you set
78   these to 0, no channels are created. In order to enable capture and/or
79   playback, you have to set them to a nonzero value.
80 - It is recommended to change the 'periods/buffer' field to 3, especially
81   if you use low period sizes (=< 128)
82 - It is recommended to raise the RT priority to 70.
83
84 In order to get it running from the command line, you need to provide some
85 arguments to jackd.
86
87 Run
88
89 $ jackd -d firewire --help
90
91 to see the backend options. You can easily figure out how to set them using
92 the remarks given above (for qjackctl).
93
94 For the other aspects of jackd usage, consult the jackd documentation.
95
96 Here is a sample session (without realtime support enabled):
97
98 [wagi@halo ~]$ jackd -d firewire
99 jackd 0.102.9
100 Copyright 2001-2005 Paul Davis and others.
101 jackd comes with ABSOLUTELY NO WARRANTY
102 This is free software, and you are welcome to redistribute it
103 under certain conditions; see the file COPYING for details
104
105 JACK compiled with System V SHM support.
106 loading driver ..
107 Freebob using Firewire port 0, node -1
108 libiec61883 warning: Established connection on channel 0.
109 You may need to manually set the channel on the receiving node.
110 libiec61883 warning: Established connection on channel 1.
111 You may need to manually set the channel on the transmitting node.
112
113 In case of problems
114 -------------------
115
116 Under the tests directory there is a test program. You should first
117 try to run this.
118
119 If you don't have installed libffado then you can adapt your
120 LD_LIBRARY_PATH environment variable to
121
122 $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:../src/.libs
123
124 Then you can try running the program without having to install it.
125
126 With the release version you see something like this:
127
128 wagi@cruxam:~/src/libffado/tests$ ./test-ffado discover
129 verbose level = 0
130 Using ffado library version: libffado 0.9.0
131
132   port = 2, devices_on_bus = 1
133   get info for device = 0, node = 1
134 Direction:              0 (capture)
135
136 Connection Info
137 ===============
138
139 Number of connections:  1
140
141   Connection  0
142   -------------
143     [ 0] Id:         0
144     [ 0] Port:       2
145     [ 0] Node:       1
146     [ 0] Plug:       0
147     [ 0] Dimension:  7
148     [ 0] Samplerate: 44100
149     [ 0] IsoChannel: -1
150     [ 0] IsMaster:   0
151     [ 0] Number of stream infos: 8
152
153     StreamId  Position Location Format Type DPort Name
154     --------------------------------------------------
155     [ 0]:[ 0] 0x01     0x01     0x06   0x02 0x00  MicIn 1+2 left
156     [ 0]:[ 1] 0x04     0x02     0x06   0x02 0x00  MicIn 1+2 right
157     [ 0]:[ 2] 0x02     0x01     0x06   0x03 0x00  LineIn 1+2 left
158     [ 0]:[ 3] 0x05     0x02     0x06   0x03 0x00  LineIn 1+2 right
159     [ 0]:[ 4] 0x00     0x01     0x06   0x04 0x00  SpdifIn 1 left
160     [ 0]:[ 5] 0x03     0x02     0x06   0x04 0x00  SpdifIn 1 right
161     [ 0]:[ 6] 0x06     0x01     0x0d   0x0a 0x00  MidiIn2
162     [ 0]:[ 7] 0x06     0x02     0x0d   0x0a 0x00  MidiIn2
163
164
165 Direction:              1 (playback)
166
167 Connection Info
168 ===============
169
170 Number of connections:  1
171
172   Connection  0
173   -------------
174     [ 0] Id:         0
175     [ 0] Port:       2
176     [ 0] Node:       1
177     [ 0] Plug:       0
178     [ 0] Dimension:  11
179     [ 0] Samplerate: 44100
180     [ 0] IsoChannel: -1
181     [ 0] IsMaster:   0
182     [ 0] Number of stream infos: 12
183
184     StreamId  Position Location Format Type DPort Name
185     --------------------------------------------------
186     [ 0]:[ 0] 0x01     0x01     0x06   0x03 0x00  MultiChannel 7.1 Front left
187     [ 0]:[ 1] 0x06     0x02     0x06   0x03 0x00  MultiChannel 7.1 Front right
188     [ 0]:[ 2] 0x02     0x03     0x06   0x03 0x00  MultiChannel 7.1 Center
189     [ 0]:[ 3] 0x07     0x04     0x06   0x03 0x00  MultiChannel 7.1 Subwoofer
190     [ 0]:[ 4] 0x03     0x05     0x06   0x03 0x00  MultiChannel 7.1 Rear left
191     [ 0]:[ 5] 0x08     0x06     0x06   0x03 0x00  MultiChannel 7.1 Rear right
192     [ 0]:[ 6] 0x04     0x07     0x06   0x03 0x00  MultiChannel 7.1 Surround left
193     [ 0]:[ 7] 0x09     0x08     0x06   0x03 0x00  MultiChannel 7.1 Surround right
194     [ 0]:[ 8] 0x00     0x01     0x06   0x04 0x00  SpdifOut 1 left
195     [ 0]:[ 9] 0x05     0x02     0x06   0x04 0x00  SpdifOut 1 right
196     [ 0]:[10] 0x0a     0x01     0x0d   0x0a 0x00  MidiOut2
197     [ 0]:[11] 0x0a     0x02     0x0d   0x0a 0x00  MidiOut2
198
199
200 If you don't get this, check if you have multiple host controllers, and
201 use the -p parameter to specify them. If you get any error messages, the
202 best way to help us figure out what the problem might be is to build the
203 debug version (scons ENABLE_DEBUG=1). You can then rerun the test
204 application and send us its output.
205
Note: See TracBrowser for help on using the browser.