root/trunk/libffado/doc/mainpage.dox

Revision 445, 1.3 kB (checked in by pieterpalmers, 16 years ago)

* name change from FreeBoB to FFADO
* replaced tabs by 4 spaces
* got rid of end-of-line spaces
* made all license and copyrights conform

library becomes LGPL, apps become GPL
explicitly state LGPL v2.1 and GPL v2 (don't like v3 draft)

copyrights are 2005-2007 Daniel & Pieter
except for the MotU stuff (C) Jonathan, Pieter

Line 
1 /*
2  * This is the main page of the FFADO reference manual, built using
3  * doxygen.
4  */
5
6 /**
7 @mainpage FFADO - Free Firewire (pro-)Audio Drivers for Linux
8
9 @author Pieter Palmers <pieterpalmers@users.sourceforge.net>
10
11 @section intro Introduction
12
13 FFADO is intended as an intermediate layer between the Linux1394 kernel/userspace layer, and the various audio API's (ALSA, jack, ...) present.
14
15 \note this is a SVN version, therefore it is highly volatile. Certain parts of the documentation can be outdated. This documentation is also auto-generated, and it can occur that unused classes and interfaces appear in the documentation. This pollution will be cleaned up as we go along.
16
17 @see <http://ffado.sourceforge.net>
18
19 @section library Client side library
20
21 FFADO presents an interface that can be used to implement backends for various audio
22 API's. Currently the best support is for the JACK backend. It is also intended to implement configuration applications like mixer controls etc..
23
24 The library API's external C interface is defined in:
25         - @ref ffado.h "<libffado/ffado.h>"
26
27 @section devicesupport Adding support for unsupported devices
28
29 Initial support by FreeBoB was for BeBoB devices only, however the FFADO framework
30 is usable for all FireWire audio devices.
31
32 Take a look at the @ref adding_devices page for a detailed description.
33
34 */
Note: See TracBrowser for help on using the browser.