- 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 old
- official release of LinuxSampler (0.3.3):
-
+ LinuxSampler!
- This is the protocol specification of the latest
- official release of LinuxSampler (0.4.0):
-
-
- 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):
-
-
| Protocol Name | +Document Types | +Description | +
| LSCP 1.0 | ++ ASCII, + HTML, + XML + | ++ Protocol specification of the old official release of LinuxSampler (0.3.3). + | +
| LSCP 1.1 | ++ ASCII, + HTML, + XML + | ++ Protocol specification of the latest official release of LinuxSampler (0.4.0). + | +
| LSCP draft | ++ ASCII, + HTML, + XML + | ++ Very latest draft of the protocol (which usually reflects the + latest development state from CVS or may even not be implemented + yet). + | +
The protocol will be extended from time to time. You may look at the features site to see which control @@ -192,15 +210,7 @@ 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 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 @@ -212,40 +222,7 @@ 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 @@ -274,51 +251,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 @@ -350,9 +288,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, @@ -364,61 +299,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 @@ -468,9 +349,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.