--- web/trunk/www.linuxsampler.org/documentation.html 2005/07/21 09:47:15 710 +++ web/trunk/www.linuxsampler.org/documentation.html 2008/02/07 14:10:44 1674 @@ -126,37 +126,167 @@ This is still quite under construction. Be welcome to help us with writing some documentation!

+ + + +

Howtos

+

+ To ease new users the first contact with the Linuxsampler applications, + we have written the following short Howtos: +

+ + + + + + + + + + + + + + + + + + + + + +
NameDescripton
Windows HOWTO + LinuxSampler quickstart guide for the MS Windows operating system. +
OS X HOWTO + LinuxSampler quickstart guide for the Apple OS X operating system. +
Debian HOWTO + Guide for how to build optimized Debian packages of LS & + friends for your specific machine. +
+ +

gigedit

+

+ This is our graphical instrument editor based on the Gtk toolkit. + It can be used stand-alone or in conjunction with LinuxSampler. + Read the Gigedit Quickstart + for a short tutorial. Please notice that this quickstart document + is automatically generated from CVS and thus might reflect + features and behaviors only available in the very latest, bleeding + edge development version of gigedit from CVS. +

+ +

JSampler

+

+ JSampler is an opensource, platform-independent, + GUI front-end for LinuxSampler, written entirely in Java. + Read the JSampler manual + for more information. +

+ +

libgig

+

+ libgig is a C++ library used to load and modify Gigasampler format files. + If you're a developer and might want to use libgig, here is its + API documentation + (automatically daily updated from CVS). +

+ + +

liblscp

+

+ liblscp is C library as convenient wrapper around the LinuxSampler Control Protocol. + If you're a developer and might want to use liblscp, here is its + API documentation + (automatically daily updated from CVS). +

LSCP Reference

- The following document defines the network protocol with which LinuxSampler can be controlled. + The following documents define the LinuxSampler Control Protocol, + a network protocol with which LinuxSampler can be controlled locally as well as remotely. As this is a simple ASCII based protocol it's possible to write a frontend for LinuxSampler in any programming language and GUI library. There's still a big demand especially for a Gtk and ncurses based frontend, so be encouraged and let us know if you wrote a frontend for - LinuxSampler! This is the protocol specification of the latest - official release of LinuxSampler (0.3.3): -
-

-
- LinuxSampler Control Protocol v1.0 - (ASCII, - HTML, - XML) -
-

- The following is the very latest draft of the protocol (which - usually reflects the latest development state from CVS or may - even not be implemented yet): -
-

-
- LinuxSampler Control Protocol Draft - (ASCII, - HTML, - XML) -
+ LinuxSampler! +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Protocol NameDocument TypesRelease DateDescription
LSCP draft + TXT, + HTML, + XML + unreleased + Very latest draft of the protocol (which usually reflects the + latest development state from CVS or may even not be implemented + yet). +
LSCP 1.3 + TXT, + HTML, + XML + 2007-12-06 + Protocol specification of the latest official release of LinuxSampler (0.5.1). +
LSCP 1.2 + TXT, + HTML, + XML + 2007-10-15 + Protocol specification of the previous official release of LinuxSampler (0.5.0). +
LSCP 1.1 + TXT, + HTML, + XML + 2006-11-25 + Protocol specification old LinuxSampler release 0.4.0. +
LSCP 1.0 + TXT, + HTML, + XML + 2005-07-17 + Protocol specification of ancient LinuxSampler release 0.3.3. +
+

The protocol will be extended from time to time. You may look at the features site to see which control @@ -172,54 +302,19 @@ examples to give you a good starting point for writing your own ones. Adjust it to your needs and send it to the running linuxsampler application with:

- - - - - -
1
-
-
cat yourscript.lscp | netcat -t localhost 8888
-
+
cat yourscript.lscp | netcat localhost 8888
+

+ Optionally you can also use a graphical frontend like QSampler one time to setup a working + sampler session for your needs and save it. Because you have to know that the files saved + by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with + the mentioned netcat command from above to setup the sampler session without a frontend. +

Here is a simple LSCP example which uses ALSA as MIDI input and as audio output driver as well, it creates only one sampler channel using the Gigasampler engine and loads a Piano instrument on that sampler channel:

- - - - - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-
-
#enable echo mode
+			
#enable echo mode
 SET ECHO 1
 
 # load the ALSA audio driver
@@ -248,51 +343,12 @@
 
 # quit connection
 QUIT
-

The next example uses JACK as audio output driver instead and automatically connects the two output channels of LS's JACK client to the first two ALSA PCM channels, so you can hear something without having to manually connect it e.g. with qjackctl:

- - - - - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-
-
#enable echo mode
+			
#enable echo mode
 SET ECHO 1
 
 # load the JACK audio driver
@@ -324,9 +380,6 @@
 
 # quit connection
 QUIT
-

The next example is a bit more complex. It shows how to setup a more realistic sampler session, handle routing of MIDI input channels, @@ -338,61 +391,7 @@ the second pair of the JACK client's output channels. That way you could e.g. record the output of those two sampler channels independently or apply independent LADSPA effects on it.

- - - - - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-
-
# enable echo mode
+			
# enable echo mode
 SET ECHO 1
 
 # load audio and MIDI driver
@@ -442,9 +441,6 @@
 # not necessary, just to see our setup
 GET CHANNEL INFO 0
 GET CHANNEL INFO 1
-

For a detailed description about LSCP read the LSCP reference. Be welcome to ask details on the mailing list.