/[svn]/web/trunk/www.linuxsampler.org/documentation.html
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/documentation.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 941 by schoenebeck, Sat Nov 25 17:32:17 2006 UTC revision 1576 by schoenebeck, Fri Dec 7 08:14:05 2007 UTC
# Line 126  Line 126 
126                          This is still quite under construction. Be welcome to help us with writing some documentation!                          This is still quite under construction. Be welcome to help us with writing some documentation!
127                          </p>                          </p>
128    
129                            <h2>gigedit</h2>
130                            <p class="default">
131                            This is our graphical instrument editor based on the Gtk toolkit.
132                            It can be used stand-alone or in conjunction with LinuxSampler.
133                            Read the <a href="http://download.linuxsampler.org/doc/gigedit/quickstart/gigedit_quickstart.html">Gigedit Quickstart</a>
134                            for a short tutorial. Please notice that this quickstart document
135                            is automatically generated from CVS and thus might reflect
136                            features and behaviors only available in the very latest, bleeding
137                            edge development version of gigedit from CVS.
138                            </p>
139    
140                            <h2>JSampler</h2>
141                            <p class="default">
142                            JSampler is an opensource, platform-independent,
143                            GUI front-end for LinuxSampler, written entirely in Java.
144                            Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
145                            for more information.
146                            </p>
147    
148                            <a name="windows"></a>
149                            <h2>Windows Howto</h2>
150                            <p class="default">
151                            To ease new users on Windows the first contact with the
152                            Linuxsampler applications <a href="windows.html">here is a short
153                            howto</a>.
154                            </p>
155    
156                            <h2>libgig</h2>
157                            <p class="default">
158                            libgig is a C++ library used to load and modify Gigasampler format files.
159                            If you're a developer and might want to use libgig, here is its
160                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
161                            (automatically daily updated from CVS).
162                            </p>
163    
164                            <a name="lscp_spec"></a>
165                            <a name="lscp_specs"></a>
166                            <h2>liblscp</h2>
167                            <p class="default">
168                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
169                            If you're a developer and might want to use liblscp, here is its
170                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
171                            (automatically daily updated from CVS).
172                            </p>
173    
174                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
175                          <p class="default">                          <p class="default">
176                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
177                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
178                          As this is a simple ASCII based protocol it's possible to write a frontend for LinuxSampler in                          As this is a simple ASCII based protocol it's possible to write a frontend for LinuxSampler in
179                          any programming language and GUI library. There's still a big demand especially for a Gtk and                          any programming language and GUI library. There's still a big demand especially for a Gtk and
180                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
181                          <a href="http://www.linuxsampler.org/developers.html">us</a> know if you wrote a frontend for                          <a href="http://www.linuxsampler.org/developers.html">us</a> know if you wrote a frontend for
182                          LinuxSampler! This is the protocol specification of the old                          LinuxSampler!
183                          official release of LinuxSampler (0.3.3):                          </p>
184                          <br>  
185                          </p>        <table class="decorated">
186                          <center>          <thead>
187                          LinuxSampler Control Protocol v1.0            <tr>
188                          (<a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,              <td class="decorated_header">Protocol Name</td>
189                          <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,              <td class="decorated_header">Document Types</td>
190                          <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>)              <td class="decorated_header">Release Date</td>
191                          </center>              <td class="decorated_header">Description</td>
192                          <p class="default">            </tr>
193                          This is the protocol specification of the latest          </thead>
194                          official release of LinuxSampler (0.4.0):          <tbody>
195                          <br>            <tr>
196                          </p>              <td class="decorated">LSCP&nbsp;draft</td>
197                          <center>              <td class="decorated">
198                          LinuxSampler Control Protocol v1.1                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
199                          (<a href="http://www.linuxsampler.org/api/lscp-1.1.txt">ASCII</a>,                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
200                          <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,                <a href="http://cvs.linuxsampler.org/cgi-bin/viewcvs.cgi/*checkout*/linuxsampler/Documentation/lscp.xml?rev=HEAD&content-type=text/xml">XML</a>
201                          <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>)              </td>
202                          </center>              <td class="decorated">unreleased</td>
203                          <p class="default">              <td class="decorated">
204                          The following is the very latest draft of the protocol (which                Very latest draft of the protocol (which usually reflects the
205                          usually reflects the latest development state from CVS or may                latest development state from CVS or may even not be implemented
206                          even not be implemented yet):                yet).
207                          <br>              </td>
208                          </p>            </tr>
209                          <center>            <tr>
210                          LinuxSampler Control Protocol Draft              <td class="decorated">LSCP&nbsp;1.3</td>
211                          (<a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,              <td class="decorated">
212                          <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,                <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,
213                          <a href="http://cvs.linuxsampler.org/cgi-bin/viewcvs.cgi/*checkout*/linuxsampler/Documentation/lscp.xml?rev=HEAD&content-type=text/xml">XML</a>)                <a href="http://www.linuxsampler.org/api/lscp-1.3.html">HTML</a>,
214                          </center>                <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
215                </td>
216                <td class="decorated">2007-12-06</td>
217                <td class="decorated">
218                  Protocol specification of the latest official release of LinuxSampler (0.5.1).
219                </td>
220              </tr>
221              <tr>
222                <td class="decorated">LSCP&nbsp;1.2</td>
223                <td class="decorated">
224                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
225                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
226                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
227                </td>
228                <td class="decorated">2007-10-15</td>
229                <td class="decorated">
230                  Protocol specification of the previous official release of LinuxSampler (0.5.0).
231                </td>
232              </tr>
233              <tr>
234                <td class="decorated">LSCP&nbsp;1.1</td>
235                <td class="decorated">
236                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
237                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
238                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
239                </td>
240                <td class="decorated">2006-11-25</td>
241                <td class="decorated">
242                  Protocol specification old LinuxSampler release 0.4.0.
243                </td>
244              </tr>
245              <tr>
246                <td class="decorated">LSCP&nbsp;1.0</td>
247                <td class="decorated">
248                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
249                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
250                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
251                </td>
252                <td class="decorated">2005-07-17</td>
253                <td class="decorated">
254                  Protocol specification of ancient LinuxSampler release 0.3.3.
255                </td>
256              </tr>
257            </tbody>
258          </table>
259    
260                          <p class="default">                          <p class="default">
261                          The protocol will be extended from time to time. You may look at the                          The protocol will be extended from time to time. You may look at the
262                          <a href="features.html#LSCP">features</a> site to see which control                          <a href="features.html#LSCP">features</a> site to see which control
# Line 183  Line 272 
272                          examples to give you a good starting point for writing your own ones. Adjust it to your needs                          examples to give you a good starting point for writing your own ones. Adjust it to your needs
273                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
274                          </p>                          </p>
275                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
276                                  <tr>                          <p class="default">
277                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
278                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
279                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
280                                      <pre class="code">cat yourscript.lscp | netcat -t localhost 8888</pre>                          the mentioned netcat command from above to setup the sampler session without a frontend.
281                                    </td>                          </p>
                                 </tr>  
                         </table>  
282                          <p class="default">                          <p class="default">
283                          Here is a simple LSCP example which uses ALSA as MIDI input and as audio output driver as well,                          Here is a simple LSCP example which uses ALSA as MIDI input and as audio output driver as well,
284                          it creates only one sampler channel using the Gigasampler engine and loads a Piano instrument                          it creates only one sampler channel using the Gigasampler engine and loads a Piano instrument
285                          on that sampler channel:                          on that sampler channel:
286                          </p>                          </p>
287                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">#enable echo mode
                                 <tr>  
                                   <td><pre class="code">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</pre>  
                                   </td>  
                                   <td width="100%">  
                                     <pre class="code">#enable echo mode  
288  SET ECHO 1  SET ECHO 1
289    
290  # load the ALSA audio driver  # load the ALSA audio driver
# Line 259  GET CHANNEL INFO 0 Line 313  GET CHANNEL INFO 0
313    
314  # quit connection  # quit connection
315  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
316                          <p class="default">                          <p class="default">
317                          The next example uses JACK as audio output driver instead and automatically connects the two                          The next example uses JACK as audio output driver instead and automatically connects the two
318                          output channels of LS's JACK client to the first two ALSA PCM channels, so you can hear                          output channels of LS's JACK client to the first two ALSA PCM channels, so you can hear
319                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
320                          </p>                          </p>
321                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">#enable echo mode
                                 <tr>  
                                   <td><pre class="code">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</pre>  
                                   </td>  
                                   <td width="100%">  
                                     <pre class="code">#enable echo mode  
322  SET ECHO 1  SET ECHO 1
323    
324  # load the JACK audio driver  # load the JACK audio driver
# Line 335  GET CHANNEL INFO 0 Line 350  GET CHANNEL INFO 0
350    
351  # quit connection  # quit connection
352  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
353                          <p class="default">                          <p class="default">
354                          The next example is a bit more complex.                          The next example is a bit more complex.
355                          It shows how to setup a more realistic sampler session, handle routing of MIDI input channels,                          It shows how to setup a more realistic sampler session, handle routing of MIDI input channels,
# Line 349  QUIT</pre> Line 361  QUIT</pre>
361                          the second pair of the JACK client's output channels. That way you could e.g. record the output                          the second pair of the JACK client's output channels. That way you could e.g. record the output
362                          of those two sampler channels independently or apply independent LADSPA effects on it.                          of those two sampler channels independently or apply independent LADSPA effects on it.
363                          </p>                          </p>
364                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code"># enable echo mode
                                 <tr>  
                                   <td><pre class="code">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</pre>  
                                   </td>  
                                   <td width="100%">  
                                     <pre class="code"># enable echo mode  
365  SET ECHO 1  SET ECHO 1
366    
367  # load audio and MIDI driver  # load audio and MIDI driver
# Line 453  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 411  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
411  # not necessary, just to see our setup  # not necessary, just to see our setup
412  GET CHANNEL INFO 0  GET CHANNEL INFO 0
413  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
414                          <p class="default">                          <p class="default">
415                          For a detailed description about LSCP read the <a href="api/draft-linuxsampler-protocol.html">LSCP reference</a>.                          For a detailed description about LSCP read the <a href="api/draft-linuxsampler-protocol.html">LSCP reference</a>.
416                          Be welcome to ask details on the mailing list.                          Be welcome to ask details on the mailing list.
Legend:
Removed from v.941  
changed lines
  Added in v.1576
  ViewVC Help
Powered by ViewVC