/[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 710 by schoenebeck, Thu Jul 21 09:47:15 2005 UTC revision 1290 by iliev, Fri Aug 10 22:45:25 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                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
149                          <p class="default">                          <p class="default">
150                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
151                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
152                          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
153                          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
154                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
155                          <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
156                          LinuxSampler! This is the protocol specification of the latest                          LinuxSampler!
                         official release of LinuxSampler (0.3.3):  
                         <br>  
                         </p>  
                         <center>  
                         LinuxSampler Control Protocol v1.0  
                         (<a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,  
                         <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,  
                         <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>)  
                         </center>  
                         <p class="default">  
                         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):  
                         <br>  
157                          </p>                          </p>
158                          <center>  
159                          LinuxSampler Control Protocol Draft        <table class="decorated">
160                          (<a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,          <thead>
161                          <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,            <tr>
162                          <a href="http://cvs.linuxsampler.org/cgi-bin/viewcvs.cgi/*checkout*/linuxsampler/Documentation/lscp.xml?rev=HEAD&content-type=text/xml">XML</a>)              <td class="decorated_header">Protocol Name</td>
163                          </center>              <td class="decorated_header">Document Types</td>
164                <td class="decorated_header">Description</td>
165              </tr>
166            </thead>
167            <tbody>
168              <tr>
169                <td class="decorated">LSCP&nbsp;1.0</td>
170                <td class="decorated">
171                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,
172                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
173                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
174                </td>
175                <td class="decorated">
176                  Protocol specification of the old official release of LinuxSampler (0.3.3).
177                </td>
178              </tr>
179              <tr>
180                <td class="decorated">LSCP&nbsp;1.1</td>
181                <td class="decorated">
182                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">ASCII</a>,
183                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
184                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
185                </td>
186                <td class="decorated">
187                  Protocol specification of the latest official release of LinuxSampler (0.4.0).
188                </td>
189              </tr>
190              <tr>
191                <td class="decorated">LSCP&nbsp;draft</td>
192                <td class="decorated">
193                  <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,
194                  <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
195                  <a href="http://cvs.linuxsampler.org/cgi-bin/viewcvs.cgi/*checkout*/linuxsampler/Documentation/lscp.xml?rev=HEAD&content-type=text/xml">XML</a>
196                </td>
197                <td class="decorated">
198                  Very latest draft of the protocol (which usually reflects the
199                  latest development state from CVS or may even not be implemented
200                  yet).
201                </td>
202              </tr>
203            </tbody>
204          </table>
205    
206                          <p class="default">                          <p class="default">
207                          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
208                          <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 172  Line 218 
218                          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
219                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
220                          </p>                          </p>
221                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
222                                  <tr>                          <p class="default">
223                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
224                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
225                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
226                                      <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.
227                                    </td>                          </p>
                                 </tr>  
                         </table>  
228                          <p class="default">                          <p class="default">
229                          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,
230                          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
231                          on that sampler channel:                          on that sampler channel:
232                          </p>                          </p>
233                          <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  
234  SET ECHO 1  SET ECHO 1
235    
236  # load the ALSA audio driver  # load the ALSA audio driver
# Line 248  GET CHANNEL INFO 0 Line 259  GET CHANNEL INFO 0
259    
260  # quit connection  # quit connection
261  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
262                          <p class="default">                          <p class="default">
263                          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
264                          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
265                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
266                          </p>                          </p>
267                          <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  
268  SET ECHO 1  SET ECHO 1
269    
270  # load the JACK audio driver  # load the JACK audio driver
# Line 324  GET CHANNEL INFO 0 Line 296  GET CHANNEL INFO 0
296    
297  # quit connection  # quit connection
298  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
299                          <p class="default">                          <p class="default">
300                          The next example is a bit more complex.                          The next example is a bit more complex.
301                          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 338  QUIT</pre> Line 307  QUIT</pre>
307                          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
308                          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.
309                          </p>                          </p>
310                          <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  
311  SET ECHO 1  SET ECHO 1
312    
313  # load audio and MIDI driver  # load audio and MIDI driver
# Line 442  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 357  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
357  # not necessary, just to see our setup  # not necessary, just to see our setup
358  GET CHANNEL INFO 0  GET CHANNEL INFO 0
359  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
360                          <p class="default">                          <p class="default">
361                          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>.
362                          Be welcome to ask details on the mailing list.                          Be welcome to ask details on the mailing list.
Legend:
Removed from v.710  
changed lines
  Added in v.1290
  ViewVC Help
Powered by ViewVC