/[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 1674 by schoenebeck, Thu Feb 7 14:10:44 2008 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                            <a name="windows"></a>
130                            <a name="osx"></a>
131                            <a name="debian"></a>
132                            <h2>Howtos</h2>
133                            <p class="default">
134                            To ease new users the first contact with the Linuxsampler applications,
135                            we have written the following short Howtos:
136                            </p>
137          <table class="decorated">
138            <thead>
139              <tr>
140                <td class="decorated_header">Name</td>
141                <td class="decorated_header">Descripton</td>
142              </tr>
143            </thead>
144            <tbody>
145              <tr>
146                <td class="decorated"><a href="windows.html">Windows HOWTO</a></td>
147                <td class="decorated">
148                  LinuxSampler quickstart guide for the MS Windows operating system.
149                </td>
150              </tr>
151              <tr>
152                <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
153                <td class="decorated">
154                  LinuxSampler quickstart guide for the Apple OS X operating system.
155                </td>
156              </tr>
157              <tr>
158                <td class="decorated"><a href="debian.html">Debian HOWTO</a></td>
159                <td class="decorated">
160                  Guide for how to build optimized Debian packages of LS &amp;
161                  friends for your specific machine.
162                </td>
163              </tr>
164            </tbody>
165          </table>
166    
167                            <h2>gigedit</h2>
168                            <p class="default">
169                            This is our graphical instrument editor based on the Gtk toolkit.
170                            It can be used stand-alone or in conjunction with LinuxSampler.
171                            Read the <a href="http://download.linuxsampler.org/doc/gigedit/quickstart/gigedit_quickstart.html">Gigedit Quickstart</a>
172                            for a short tutorial. Please notice that this quickstart document
173                            is automatically generated from CVS and thus might reflect
174                            features and behaviors only available in the very latest, bleeding
175                            edge development version of gigedit from CVS.
176                            </p>
177    
178                            <h2>JSampler</h2>
179                            <p class="default">
180                            JSampler is an opensource, platform-independent,
181                            GUI front-end for LinuxSampler, written entirely in Java.
182                            Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
183                            for more information.
184                            </p>
185    
186                            <h2>libgig</h2>
187                            <p class="default">
188                            libgig is a C++ library used to load and modify Gigasampler format files.
189                            If you're a developer and might want to use libgig, here is its
190                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
191                            (automatically daily updated from CVS).
192                            </p>
193    
194                            <a name="lscp_spec"></a>
195                            <a name="lscp_specs"></a>
196                            <h2>liblscp</h2>
197                            <p class="default">
198                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
199                            If you're a developer and might want to use liblscp, here is its
200                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
201                            (automatically daily updated from CVS).
202                            </p>
203    
204                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
205                          <p class="default">                          <p class="default">
206                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
207                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
208                          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
209                          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
210                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
211                          <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
212                          LinuxSampler! This is the protocol specification of the old                          LinuxSampler!
213                          official release of LinuxSampler (0.3.3):                          </p>
214                          <br>  
215                          </p>        <table class="decorated">
216                          <center>          <thead>
217                          LinuxSampler Control Protocol v1.0            <tr>
218                          (<a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,              <td class="decorated_header">Protocol Name</td>
219                          <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,              <td class="decorated_header">Document Types</td>
220                          <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>)              <td class="decorated_header">Release Date</td>
221                          </center>              <td class="decorated_header">Description</td>
222                          <p class="default">            </tr>
223                          This is the protocol specification of the latest          </thead>
224                          official release of LinuxSampler (0.4.0):          <tbody>
225                          <br>            <tr>
226                          </p>              <td class="decorated">LSCP&nbsp;draft</td>
227                          <center>              <td class="decorated">
228                          LinuxSampler Control Protocol v1.1                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
229                          (<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>,
230                          <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>
231                          <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>)              </td>
232                          </center>              <td class="decorated">unreleased</td>
233                          <p class="default">              <td class="decorated">
234                          The following is the very latest draft of the protocol (which                Very latest draft of the protocol (which usually reflects the
235                          usually reflects the latest development state from CVS or may                latest development state from CVS or may even not be implemented
236                          even not be implemented yet):                yet).
237                          <br>              </td>
238                          </p>            </tr>
239                          <center>            <tr>
240                          LinuxSampler Control Protocol Draft              <td class="decorated">LSCP&nbsp;1.3</td>
241                          (<a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,              <td class="decorated">
242                          <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>,
243                          <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>,
244                          </center>                <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
245                </td>
246                <td class="decorated">2007-12-06</td>
247                <td class="decorated">
248                  Protocol specification of the latest official release of LinuxSampler (0.5.1).
249                </td>
250              </tr>
251              <tr>
252                <td class="decorated">LSCP&nbsp;1.2</td>
253                <td class="decorated">
254                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
255                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
256                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
257                </td>
258                <td class="decorated">2007-10-15</td>
259                <td class="decorated">
260                  Protocol specification of the previous official release of LinuxSampler (0.5.0).
261                </td>
262              </tr>
263              <tr>
264                <td class="decorated">LSCP&nbsp;1.1</td>
265                <td class="decorated">
266                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
267                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
268                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
269                </td>
270                <td class="decorated">2006-11-25</td>
271                <td class="decorated">
272                  Protocol specification old LinuxSampler release 0.4.0.
273                </td>
274              </tr>
275              <tr>
276                <td class="decorated">LSCP&nbsp;1.0</td>
277                <td class="decorated">
278                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
279                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
280                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
281                </td>
282                <td class="decorated">2005-07-17</td>
283                <td class="decorated">
284                  Protocol specification of ancient LinuxSampler release 0.3.3.
285                </td>
286              </tr>
287            </tbody>
288          </table>
289    
290                          <p class="default">                          <p class="default">
291                          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
292                          <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 302 
302                          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
303                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
304                          </p>                          </p>
305                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
306                                  <tr>                          <p class="default">
307                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
308                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
309                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
310                                      <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.
311                                    </td>                          </p>
                                 </tr>  
                         </table>  
312                          <p class="default">                          <p class="default">
313                          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,
314                          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
315                          on that sampler channel:                          on that sampler channel:
316                          </p>                          </p>
317                          <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  
318  SET ECHO 1  SET ECHO 1
319    
320  # load the ALSA audio driver  # load the ALSA audio driver
# Line 259  GET CHANNEL INFO 0 Line 343  GET CHANNEL INFO 0
343    
344  # quit connection  # quit connection
345  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
346                          <p class="default">                          <p class="default">
347                          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
348                          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
349                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
350                          </p>                          </p>
351                          <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  
352  SET ECHO 1  SET ECHO 1
353    
354  # load the JACK audio driver  # load the JACK audio driver
# Line 335  GET CHANNEL INFO 0 Line 380  GET CHANNEL INFO 0
380    
381  # quit connection  # quit connection
382  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
383                          <p class="default">                          <p class="default">
384                          The next example is a bit more complex.                          The next example is a bit more complex.
385                          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 391  QUIT</pre>
391                          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
392                          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.
393                          </p>                          </p>
394                          <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  
395  SET ECHO 1  SET ECHO 1
396    
397  # load audio and MIDI driver  # load audio and MIDI driver
# Line 453  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 441  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
441  # not necessary, just to see our setup  # not necessary, just to see our setup
442  GET CHANNEL INFO 0  GET CHANNEL INFO 0
443  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
444                          <p class="default">                          <p class="default">
445                          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>.
446                          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.1674
  ViewVC Help
Powered by ViewVC