/[svn]/linuxsampler/trunk/README
ViewVC logotype

Contents of /linuxsampler/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 697 - (show annotations) (download)
Tue Jul 19 15:43:40 2005 UTC (18 years, 8 months ago) by schoenebeck
File size: 3436 byte(s)
* install necessary development header files for allowing 3rd party
  applications to link against liblinuxsampler
* liblinuxsampler's API documentation can be generated with 'make docs'
  (Doxygen required)

1 LinuxSampler - modular, streaming capable sampler
2
3 by Benno Senoner (benno@gardena.net)
4 and Christian Schoenebeck (cuse@users.sourceforge.net)
5
6 This software is distributed under the GNU General Public License (see
7 COPYING file), and may not be used in commercial applications without asking
8 the authors for permission.
9
10 LinuxSampler is sampler backend, thus server-like console application. It
11 provides a TCP based network interface with a custom ASCII based protocol
12 called "LSCP" to control the sampler and manage sampler sessions. You either
13 have to send commands manually to LinuxSampler, e.g. by connecting via
14 'telnet' or by using 'netcat' or you might want to use a graphical user
15 interface (frontend) like QSampler.
16
17 For more informations visit http://www.linuxsampler.org/documentation.html
18
19
20 Requirements on Linux
21 ---------------------
22
23 o A low latency enabled kernel
24 (see http://www.linuxsampler.org/faq.html#dropouts).
25 o At least ALSA and optionally JACK and their respective development
26 (header) files as MIDI input and audio output drivers.
27 o libgig and its development (header) files for loading Gigasampler
28 format files.
29 o libtool
30 o If you are compiling from CVS you need to have the autotools installed
31 (autoconf, automake (>= 1.5)).
32 o If you want to generate the liblinuxsampler API documentation you
33 need to have Doxygen installed.
34
35
36 Compiling on Linux
37 ------------------
38
39 a) Compiling and installing directly
40
41 The general procedure by calling './configure && make' on the source's
42 toplevel directory will compile and 'make install' as root will install
43 LinuxSampler on your system.
44
45 Note: if you are compiling from CVS you have to explicitly call
46 'make -f Makefile.cvs' before doing the above procedure. This will
47 generate all autotools managed build files.
48
49 LinuxSampler itself is a library called liblinuxsampler. You can
50 generate the API documenation for liblinuxsampler by explicitly calling
51 'make docs'.
52
53
54 b) Creating Debian packages
55
56 Simply calling 'dpkg-buildpackage -rfakeroot -b' from the source's
57 toplevel directory will compile and build the Debian binary package.
58 The Debian package will be placed one directory above the source's
59 toplevel directory (thus ../).
60
61
62 c) Creating Redhat packages
63
64 You need to have the rpmbuild tool installed and properly configured to
65 create RPM packages. To create the RPM packages do the following:
66
67 * Get .spec file generated by ./configure and edit it as appropriate.
68
69 * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
70 where <rpmdir> is dependent to the system you are using. For SuSE
71 <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
72 Redhat / Fedora <rpmdir> always equals "redhat".
73
74 * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
75 command line.
76
77 On success, the resulting rpm(s) can usually be found under the proper
78 "/usr/src/<rpmdir>/RPMS/<arch>" directory.
79
80
81 Compilation on OSX : Stephane Letz (letz@grame.fr)
82 --------------------------------------------------
83
84 The compilation on OSX currently uses an XCode project.
85
86 - Download and install the JackOSX package (www.jackosx.com)
87
88 - In the "osx" folder, possibly manually edit the version.h to change the version number
89
90 - In the XCode project, build the "LinuxSampler" target
91

  ViewVC Help
Powered by ViewVC