root/branches/libffado-2.0/README

Revision 1619, 10.2 kB (checked in by jwoithe, 8 years ago)

Note changes to URLs for SIP and PyQt?

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 FFADO v2.0
2 ==========
3
4 The FFADO project aims to provide a free driver implemenation for FireWire
5 (IEEE1394, iLink) based (semi-) professional audio interfaces. The focus of
6 the project are on audio/music production rather than consumer audio. This
7 means that, although we intend to supported all features at some point,
8 consumer features are considered less important. The most obvious example of
9 a consumer feature is AC3/DTS passthrough support, which is unsupported at
10 the moment.
11
12 This package provides the libffado shared library that provides a unified
13 programming interface to configure and use all supported devices. Currently
14 this library is used by the 'firewire' backends of the jack audio connection
15 kit sound server (jackaudio.org). This backend provides audio and midi support,
16 and is available both in jackd and it's multiprocessor variant jackdmp.
17 (note: At the moment there is no support for ALSA nor for pulseaudio.)
18
19 Access to the device internal configuration (e,g, internal mixer) is exposed
20 using the ffado-dbus-server daemon. This daemon exposes the configurable
21 parameters of all detected devices through DBUS. The ffadomixer application in
22 support/mixer presents a GUI to control these parameters (only for officially
23 supported devices).
24
25 Features
26 --------
27 * 24-bit audio input/output (unlimited number of channels)
28 * supports for all samplerates a device supports
29 * MIDI input/output (unlimited number of channels)
30 * Support for S/PDIF and ADAT/SMUX I/O
31 * Internal mixer and device control support for all officially supported
32   devices (NOTE: no support for internal DSP)
33 * Support for device aggregation (limited to devices on the same bus)
34
35 Device Support
36 --------------
37
38 The devices officially supported are:
39 * ESI Quatafire 610
40 * Terratec Producer Phase 88
41 * Focusrite Saffire (original/white)
42 * Focusrite Saffire LE (black)
43 * Focusrite Saffire PRO10
44 * Focusrite Saffire PRO26
45 * ECHO AudioFire2, AudioFire4, AudioFire8, AudioFire12
46 * Mackie Onyx Mixer FireWire expansion
47
48 The 'officially supported' label is only given to devices that fullfil the
49 following:
50 * at least one of the developers has the device, or a closely related one
51 * the vendor provides development support (access to information)
52 * the device works
53
54 Through reverse-engineering the following devices will also work:
55 * MOTU traveller
56 * MOTU 828mkII
57 Note: the support for these devices is based on a significant reverse
58 engineering effort. This means that the developers had no support from the
59 device vendor, and this of course limits the extent to which problems can
60 be solved. You have been warned. Please do not buy devices for which support
61 is based upon reverse engineering, nor from vendors that are Linux-hostile
62 (e.g. MOTU). Value the support that some vendors provide and buy their
63 stuff. Check ffado.org for details. It can't be said enough: currently it is
64 extremely unwise to buy a MOTU device if you intend to use Linux.
65
66 The driver is written to provide generic support for all devices it might be
67 able to handle. This means that most devices based on the BridgeCo BeBoB or
68 the ECHO FireWorks platform will work, at least to a certain extent.
69
70 Devices that have been reported to (partially) work with the generic support:
71 * Presonus FireBox
72 * Presonus FirePod / FP10
73 * Terratec Producer Phase 24
74 * Terratec Producer Phase X24
75
76 Unsupported devices (non-functional):
77 * Presonus FireStation
78 * Presonus FireStudio (all variants)
79 * TC Konnekt (all variants)
80 * Alesis devices
81 * Metric Halo devices
82 * RME Firewire devices
83 * M-Audio FireWire 410
84 * M-Audio FireWire 1814
85 * M-Audio ProFire 2626
86
87 We constantly try to persuade vendors to help us extend our device support. Don't
88 hesitate to let a vendor know that you would like to have their device(s) supported.
89
90 Dependencies
91 ------------
92
93 To build libffado you need several libraries. For all libraries a
94 version is provided which is a 'known good' version.  The first few
95 libraries it seems it is not necessary that the version must
96 match. The chances that it works also with an older versions are good:
97
98 libxml++2   (>= 2.6.13)
99
100 These libraries here should be at least the version listed:
101
102 libraw1394  (>= 1.3.0),  http://www.linux1394.org
103 libiec61883 (>= 1.1.0),  http://www.linux1394.org
104 dbus-1      (>= 1.0),    http://dbus.freedesktop.org
105
106 Currently only the jackd audio server is supported.
107
108 jackd (>= 0.109.12), http://jackaudio.org
109
110 Optionally, but recommended is that you install qjackctl:
111
112 qjackctl (>= 0.2.20.10), http://sourceforge.net/projects/qjackctl
113
114 To build the optional ffado device mixer control utility you also require:
115
116 Qt  >= 4.0,            http://trolltech.com/products/qt
117 SIP >= 4.7.0,          http://www.riverbankcomputing.co.uk/software/sip/intro
118 PyQt (note below),     http://www.riverbankcomputing.co.uk/software/pyqt/intro
119 dbus-python >= 0.82.0, http://dbus.freedesktop.org/releases/dbus-python/
120
121 The mixer applets are available for both QT3 and QT4. However, the QT3 versions
122 are no longer actively developed. The build script will automatically fallback
123 to the QT3 version if you don't have QT4 installed.
124
125 The version of PyQt must be chosen to exactly match the version of Qt in use.
126 For Qt 4.x use PyQt 4.x.
127
128 SIP is only required to compile PyQt.  If using a binary package of PyQt
129 SIP should not be needed.
130
131 How to build
132 ------------
133
134 If you want to build the release version you can simply do following:
135
136 $ scons
137 $ scons install
138
139 If you want some debug information (because something seems not
140 to work correctly) you can try to do following:
141
142 $ scons DEBUG=yes
143 $ scons install
144
145 More extended instructions can be found here:
146 http://subversion.ffado.org/wiki/CompilationGuides
147
148 NOTE: In order to build jackd with ffado support, you have
149 to install libffado before you build jackd. The backend to use in jackd is
150 firewire.
151
152 NOTE: the beta versions are distributed with debugging enabled by default.
153
154 DISTRIBUTION PACKAGERS NOTE: Please do not enable support for devices
155 if it is not on by default. If device support for a specific device
156 is not turned on by default by the developers, it means that it is not
157 ready yet. Most of the time it is placeholder code for future devices.
158
159 Running jackd
160 -------------
161
162 The easiest way to run this is using qjackctl. There are only minor
163 differences with the other backends, however you should change some
164 of the default values:
165 - It is recommended to change the 'periods/buffer' field to 3, especially
166   if you use low period sizes (=< 128)
167 - It is recommended to raise the RT priority to 70.
168
169 In order to get it running from the command line, you need to provide some
170 arguments to jackd.
171
172 Run
173
174 $ jackd -d firewire --help
175
176 to see the backend options. You can easily figure out how to set them using
177 the remarks given above (for qjackctl).
178
179 For the other aspects of jackd usage, consult the jackd documentation.
180
181 Here is a sample session (without realtime support enabled):
182
183     $ jackd -d firewire
184     no message buffer overruns
185     jackd 0.111.0
186     Copyright 2001-2005 Paul Davis and others.
187     jackd comes with ABSOLUTELY NO WARRANTY
188     This is free software, and you are welcome to redistribute it
189     under certain conditions; see the file COPYING for details
190    
191     JACK compiled with System V SHM support.
192     loading driver ..
193     3106528665:  (ffado.cpp)[  99] ffado_streaming_init: libffado 1.999.20 built Apr 26 2008 20:26:32
194     libiec61883 warning: Established connection on channel 0.
195     You may need to manually set the channel on the receiving node.
196     libiec61883 warning: Established connection on channel 1.
197     You may need to manually set the channel on the transmitting node.
198
199 (Note: you can safely ignore the libiec61883 warnings, they are normal.)
200
201 An important remark is that for good performance, one should always run jack
202 with the -R flag to enable realtime scheduling for critical threads:
203     $ jackd -R -d firewire
204
205 In case of problems
206 -------------------
207
208 First of all, check whether your problem is in fact a problem, and
209 whether it is a FFADO problem. The magic tool for this is google.
210
211 User support is a rather annoying occupation, especially since it sucks
212 time from developers that are not paid for developing, let alone for doing
213 user support. Please make sure that you have checked the following places:
214     http://www.ffado.org/
215     http://subversion.ffado.org/
216     http://www.google.com/
217       (the terms "ffado-devel" "ffado-user" or "freebob-user" work great)
218 Some might consider this a bit arrogant or "newbie-unfriendly", but personally
219 I (Pieter Palmers) consider this a matter of politeness towards the developers.
220
221 If you have tried to find a solution to your problem, but you couldn't find
222 one or are confused, don't hesitate to ask for help. The preferred way is by
223 signing up to the mailing list as described on http://www.ffado.org/?q=contact.
224
225 Writing a bug report
226 --------------------
227
228 Note that the more effort you put in your bug report, the more effort we
229 will put into helping you.
230
231 Make sure you have compiled a DEBUG=yes version of
232 libffado. If not there is no way we can trace the problem.
233
234 When reporting a problem, please run jackd with the --verbose option,
235 and add the -v6 option to the firewire backend:
236     $ jackd --verbose [...] -d firewire -v6 [...]
237
238     ( [...] = other options )
239
240 This will generate an increadible amount of debug output that should
241 contain what we need to track down the problem. If you have troubles
242 saving the output, try redirecting it to a file:
243
244     $ jackd --verbose -d firewire -v6 2> ffado-jack.log
245
246 this will create a ffado.log file containing the output. Use CTRL-C
247 to exit jack if necessary.
248
249 The distribution contains a tool to gather some information about your
250 system. you can run it as follows:
251
252     $ cd support/tools
253     $ python ffado-diag.py > ffado-diag.log
254
255 It will check your system for basic problems and gather some information
256 regarding your hardware configuration. This will allow us to diagnose
257 your problem faster.
258
259 Once the logs have been created you can create a support ticket at
260 http://subversion.ffado.org/newticket
261
262 Be sure to include the following information:
263 * the log file(s) (zipped/tar.gz'ed and attached)
264 * the device you're trying to use
265 * a description of what went wrong and how to reproduce it. You
266   preferrably try to figure out a sequence of steps that can reliably
267   reproduce the issue on your system. A one-time failure is very difficult
268   to diagnose and/or fix.
269 * the distribution and its version
270
271
Note: See TracBrowser for help on using the browser.