/[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 542 by senoner, Sun May 15 15:31:45 2005 UTC revision 1620 by schoenebeck, Thu Jan 3 21:45:45 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                            <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                            <a name="osx"></a>
157                            <h2>OS X Howto</h2>
158                            <p class="default">
159                            To ease new users on Mac the first contact with the
160                            Linuxsampler applications <a href="osx.html">here is a short
161                            howto</a>.
162                            </p>
163    
164                            <h2>libgig</h2>
165                            <p class="default">
166                            libgig is a C++ library used to load and modify Gigasampler format files.
167                            If you're a developer and might want to use libgig, here is its
168                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
169                            (automatically daily updated from CVS).
170                            </p>
171    
172                            <a name="lscp_spec"></a>
173                            <a name="lscp_specs"></a>
174                            <h2>liblscp</h2>
175                            <p class="default">
176                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
177                            If you're a developer and might want to use liblscp, here is its
178                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
179                            (automatically daily updated from CVS).
180                            </p>
181    
182                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
183                          <p class="default">                          <p class="default">
184                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
185                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
186                          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
187                          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
188                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
189                          <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
190                          LinuxSampler! This is the latest draft of the protocol:                          LinuxSampler!
                         <br>  
191                          </p>                          </p>
192                          <center>  
193                              LinuxSampler Control Protocol Draft (<a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,        <table class="decorated">
194                                                                      <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>)          <thead>
195                          </center>            <tr>
196                <td class="decorated_header">Protocol Name</td>
197                <td class="decorated_header">Document Types</td>
198                <td class="decorated_header">Release Date</td>
199                <td class="decorated_header">Description</td>
200              </tr>
201            </thead>
202            <tbody>
203              <tr>
204                <td class="decorated">LSCP&nbsp;draft</td>
205                <td class="decorated">
206                  <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
207                  <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
208                  <a href="http://cvs.linuxsampler.org/cgi-bin/viewcvs.cgi/*checkout*/linuxsampler/Documentation/lscp.xml?rev=HEAD&content-type=text/xml">XML</a>
209                </td>
210                <td class="decorated">unreleased</td>
211                <td class="decorated">
212                  Very latest draft of the protocol (which usually reflects the
213                  latest development state from CVS or may even not be implemented
214                  yet).
215                </td>
216              </tr>
217              <tr>
218                <td class="decorated">LSCP&nbsp;1.3</td>
219                <td class="decorated">
220                  <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,
221                  <a href="http://www.linuxsampler.org/api/lscp-1.3.html">HTML</a>,
222                  <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
223                </td>
224                <td class="decorated">2007-12-06</td>
225                <td class="decorated">
226                  Protocol specification of the latest official release of LinuxSampler (0.5.1).
227                </td>
228              </tr>
229              <tr>
230                <td class="decorated">LSCP&nbsp;1.2</td>
231                <td class="decorated">
232                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
233                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
234                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
235                </td>
236                <td class="decorated">2007-10-15</td>
237                <td class="decorated">
238                  Protocol specification of the previous official release of LinuxSampler (0.5.0).
239                </td>
240              </tr>
241              <tr>
242                <td class="decorated">LSCP&nbsp;1.1</td>
243                <td class="decorated">
244                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
245                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
246                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
247                </td>
248                <td class="decorated">2006-11-25</td>
249                <td class="decorated">
250                  Protocol specification old LinuxSampler release 0.4.0.
251                </td>
252              </tr>
253              <tr>
254                <td class="decorated">LSCP&nbsp;1.0</td>
255                <td class="decorated">
256                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
257                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
258                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
259                </td>
260                <td class="decorated">2005-07-17</td>
261                <td class="decorated">
262                  Protocol specification of ancient LinuxSampler release 0.3.3.
263                </td>
264              </tr>
265            </tbody>
266          </table>
267    
268                          <p class="default">                          <p class="default">
269                          The protocol will be extended from time to time. Have a look at the                          The protocol will be extended from time to time. You may look at the
270                          <a href="features.html#LSCP">features</a> site to see which control commands are already implemented and which are not.                          <a href="features.html#LSCP">features</a> site to see which control
271                            commands are already implemented and which are not.
272                          </p>                          </p>
273    
274    
# Line 156  Line 280 
280                          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
281                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
282                          </p>                          </p>
283                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
284                                  <tr>                          <p class="default">
285                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
286                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
287                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
288                                      <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.
289                                    </td>                          </p>
                                 </tr>  
                         </table>  
290                          <p class="default">                          <p class="default">
291                          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,
292                          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
293                          on that sampler channel:                          on that sampler channel:
294                          </p>                          </p>
295                          <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  
296  SET ECHO 1  SET ECHO 1
297    
298  # load the ALSA audio driver  # load the ALSA audio driver
# Line 232  GET CHANNEL INFO 0 Line 321  GET CHANNEL INFO 0
321    
322  # quit connection  # quit connection
323  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
324                          <p class="default">                          <p class="default">
325                          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
326                          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
327                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
328                          </p>                          </p>
329                          <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  
330  SET ECHO 1  SET ECHO 1
331    
332  # load the JACK audio driver  # load the JACK audio driver
# Line 308  GET CHANNEL INFO 0 Line 358  GET CHANNEL INFO 0
358    
359  # quit connection  # quit connection
360  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
361                          <p class="default">                          <p class="default">
362                          The next example is a bit more complex.                          The next example is a bit more complex.
363                          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 322  QUIT</pre> Line 369  QUIT</pre>
369                          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
370                          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.
371                          </p>                          </p>
372                          <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  
373  SET ECHO 1  SET ECHO 1
374    
375  # load audio and MIDI driver  # load audio and MIDI driver
# Line 426  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 419  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
419  # not necessary, just to see our setup  # not necessary, just to see our setup
420  GET CHANNEL INFO 0  GET CHANNEL INFO 0
421  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
422                          <p class="default">                          <p class="default">
423                          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>.
424                          Be welcome to ask details on the mailing list.                          Be welcome to ask details on the mailing list.
Legend:
Removed from v.542  
changed lines
  Added in v.1620
  ViewVC Help
Powered by ViewVC