/[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 1675 by schoenebeck, Fri Feb 8 14:21:33 2008 UTC
# Line 49  Line 49 
49                  downloadsout = new Image();                  downloadsout = new Image();
50                  downloadsout.src = dir + "mdownloads.png";                  downloadsout.src = dir + "mdownloads.png";
51    
52                    supportover = new Image();
53                    supportover.src = dir + "msupporthover.png";
54                    supportout = new Image();
55                    supportout.src = dir + "msupport.png";
56    
57                  developersover = new Image();                  developersover = new Image();
58                  developersover.src = dir + "mdevelopershover.png";                  developersover.src = dir + "mdevelopershover.png";
59    
# Line 111  Line 116 
116                          <a id="screenshots" href="screenshots.html" onmouseover="javascript:if(document.images)document.screenshots.src = screenshotsover.src" onmouseout="javascript:if(document.images)document.screenshots.src = screenshotsout.src"><img name="screenshots" src="gfx/mscreenshots.png" alt="screenshots"></a>                          <a id="screenshots" href="screenshots.html" onmouseover="javascript:if(document.images)document.screenshots.src = screenshotsover.src" onmouseout="javascript:if(document.images)document.screenshots.src = screenshotsout.src"><img name="screenshots" src="gfx/mscreenshots.png" alt="screenshots"></a>
117                          <a id="demos" href="demos.html" onmouseover="javascript:if(document.images)document.demos.src = demosover.src" onmouseout="javascript:if(document.images)document.demos.src = demosout.src"><img name="demos" src="gfx/mdemos.png" alt="demos"></a>                          <a id="demos" href="demos.html" onmouseover="javascript:if(document.images)document.demos.src = demosover.src" onmouseout="javascript:if(document.images)document.demos.src = demosout.src"><img name="demos" src="gfx/mdemos.png" alt="demos"></a>
118                          <a id="downloads" href="downloads.html" onmouseover="javascript:if(document.images)document.downloads.src = downloadsover.src" onmouseout="javascript:if(document.images)document.downloads.src = downloadsout.src"><img name="downloads" src="gfx/mdownloads.png" alt="download"></a>                          <a id="downloads" href="downloads.html" onmouseover="javascript:if(document.images)document.downloads.src = downloadsover.src" onmouseout="javascript:if(document.images)document.downloads.src = downloadsout.src"><img name="downloads" src="gfx/mdownloads.png" alt="download"></a>
119                            <a id="support" href="support.html" onmouseover="javascript:if(document.images)document.support.src = supportover.src" onmouseout="javascript:if(document.images)document.support.src = supportout.src"><img name="support" src="gfx/msupport.png" alt="support"></a>
120                          <a id="developers" href="developers.html" onmouseover="javascript:if(document.images)document.developers.src = developersover.src" onmouseout="javascript:if(document.images)document.developers.src = developersout.src"><img name="developers" src="gfx/mdevelopers.png" alt="developers"></a>                          <a id="developers" href="developers.html" onmouseover="javascript:if(document.images)document.developers.src = developersover.src" onmouseout="javascript:if(document.images)document.developers.src = developersout.src"><img name="developers" src="gfx/mdevelopers.png" alt="developers"></a>
121                          <a id="faq" href="faq.html" onmouseover="javascript:if(document.images)document.faq.src = faqover.src" onmouseout="javascript:if(document.images)document.faq.src = faqout.src"><img name="faq" src="gfx/mfaq.png" alt="faq"></a>                          <a id="faq" href="faq.html" onmouseover="javascript:if(document.images)document.faq.src = faqover.src" onmouseout="javascript:if(document.images)document.faq.src = faqout.src"><img name="faq" src="gfx/mfaq.png" alt="faq"></a>
122                          <a id="documentation" href="documentation.html" onmouseover="javascript:if(document.images)document.documentation.src = documentationover.src" onmouseout="javascript:if(document.images)document.documentation.src = documentationout.src"><img name="documentation" src="gfx/mdocumentation.png" alt="documentation"></a>                          <a id="documentation" href="documentation.html" onmouseover="javascript:if(document.images)document.documentation.src = documentationover.src" onmouseout="javascript:if(document.images)document.documentation.src = documentationout.src"><img name="documentation" src="gfx/mdocumentation.png" alt="documentation"></a>
# Line 126  Line 132 
132                          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!
133                          </p>                          </p>
134    
135                            <a name="windows"></a>
136                            <a name="osx"></a>
137                            <a name="debian"></a>
138                            <h2>Howtos</h2>
139                            <p class="default">
140                            To ease new users the first contact with the Linuxsampler applications,
141                            we have written the following short Howtos:
142                            </p>
143          <table class="decorated">
144            <thead>
145              <tr>
146                <td class="decorated_header">Name</td>
147                <td class="decorated_header">Descripton</td>
148              </tr>
149            </thead>
150            <tbody>
151              <tr>
152                <td class="decorated"><a href="windows.html">Windows HOWTO</a></td>
153                <td class="decorated">
154                  LinuxSampler quickstart guide for the MS Windows operating system.
155                </td>
156              </tr>
157              <tr>
158                <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
159                <td class="decorated">
160                  LinuxSampler quickstart guide for the Apple OS X operating system.
161                </td>
162              </tr>
163              <tr>
164                <td class="decorated"><a href="debian.html">Debian HOWTO</a></td>
165                <td class="decorated">
166                  Guide for how to build optimized Debian packages of LS &amp;
167                  friends for your specific machine.
168                </td>
169              </tr>
170            </tbody>
171          </table>
172    
173                            <h2>gigedit</h2>
174                            <p class="default">
175                            This is our graphical instrument editor based on the Gtk toolkit.
176                            It can be used stand-alone or in conjunction with LinuxSampler.
177                            Read the <a href="http://download.linuxsampler.org/doc/gigedit/quickstart/gigedit_quickstart.html">Gigedit Quickstart</a>
178                            for a short tutorial. Please notice that this quickstart document
179                            is automatically generated from CVS and thus might reflect
180                            features and behaviors only available in the very latest, bleeding
181                            edge development version of gigedit from CVS.
182                            </p>
183    
184                            <h2>JSampler</h2>
185                            <p class="default">
186                            JSampler is an opensource, platform-independent,
187                            GUI front-end for LinuxSampler, written entirely in Java.
188                            Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
189                            for more information.
190                            </p>
191    
192                            <h2>libgig</h2>
193                            <p class="default">
194                            libgig is a C++ library used to load and modify Gigasampler format files.
195                            If you're a developer and might want to use libgig, here is its
196                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
197                            (automatically daily updated from CVS).
198                            </p>
199    
200                            <a name="lscp_spec"></a>
201                            <a name="lscp_specs"></a>
202                            <h2>liblscp</h2>
203                            <p class="default">
204                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
205                            If you're a developer and might want to use liblscp, here is its
206                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
207                            (automatically daily updated from CVS).
208                            </p>
209    
210                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
211                          <p class="default">                          <p class="default">
212                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
213                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
214                          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
215                          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
216                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
217                          <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
218                          LinuxSampler! This is the protocol specification of the latest                          LinuxSampler!
219                          official release of LinuxSampler (0.3.3):                          </p>
220                          <br>  
221                          </p>        <table class="decorated">
222                          <center>          <thead>
223                          LinuxSampler Control Protocol v1.0            <tr>
224                          (<a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,              <td class="decorated_header">Protocol Name</td>
225                          <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,              <td class="decorated_header">Document Types</td>
226                          <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>)              <td class="decorated_header">Release Date</td>
227                          </center>              <td class="decorated_header">Description</td>
228                          <p class="default">            </tr>
229                          The following is the very latest draft of the protocol (which          </thead>
230                          usually reflects the latest development state from CVS or may          <tbody>
231                          even not be implemented yet):            <tr>
232                          <br>              <td class="decorated">LSCP&nbsp;draft</td>
233                          </p>              <td class="decorated">
234                          <center>                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
235                          LinuxSampler Control Protocol Draft                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
236                          (<a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,                <a href="http://cvs.linuxsampler.org/cgi-bin/viewcvs.cgi/*checkout*/linuxsampler/Documentation/lscp.xml?rev=HEAD&content-type=text/xml">XML</a>
237                          <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,              </td>
238                          <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">unreleased</td>
239                          </center>              <td class="decorated">
240                  Very latest draft of the protocol (which usually reflects the
241                  latest development state from CVS or may even not be implemented
242                  yet).
243                </td>
244              </tr>
245              <tr>
246                <td class="decorated">LSCP&nbsp;1.3</td>
247                <td class="decorated">
248                  <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,
249                  <a href="http://www.linuxsampler.org/api/lscp-1.3.html">HTML</a>,
250                  <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
251                </td>
252                <td class="decorated">2007-12-06</td>
253                <td class="decorated">
254                  Protocol specification of the latest official release of LinuxSampler (0.5.1).
255                </td>
256              </tr>
257              <tr>
258                <td class="decorated">LSCP&nbsp;1.2</td>
259                <td class="decorated">
260                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
261                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
262                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
263                </td>
264                <td class="decorated">2007-10-15</td>
265                <td class="decorated">
266                  Protocol specification of the previous official release of LinuxSampler (0.5.0).
267                </td>
268              </tr>
269              <tr>
270                <td class="decorated">LSCP&nbsp;1.1</td>
271                <td class="decorated">
272                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
273                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
274                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
275                </td>
276                <td class="decorated">2006-11-25</td>
277                <td class="decorated">
278                  Protocol specification old LinuxSampler release 0.4.0.
279                </td>
280              </tr>
281              <tr>
282                <td class="decorated">LSCP&nbsp;1.0</td>
283                <td class="decorated">
284                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
285                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
286                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
287                </td>
288                <td class="decorated">2005-07-17</td>
289                <td class="decorated">
290                  Protocol specification of ancient LinuxSampler release 0.3.3.
291                </td>
292              </tr>
293            </tbody>
294          </table>
295    
296                          <p class="default">                          <p class="default">
297                          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
298                          <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 308 
308                          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
309                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
310                          </p>                          </p>
311                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
312                                  <tr>                          <p class="default">
313                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
314                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
315                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
316                                      <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.
317                                    </td>                          </p>
                                 </tr>  
                         </table>  
318                          <p class="default">                          <p class="default">
319                          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,
320                          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
321                          on that sampler channel:                          on that sampler channel:
322                          </p>                          </p>
323                          <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  
324  SET ECHO 1  SET ECHO 1
325    
326  # load the ALSA audio driver  # load the ALSA audio driver
# Line 248  GET CHANNEL INFO 0 Line 349  GET CHANNEL INFO 0
349    
350  # quit connection  # quit connection
351  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
352                          <p class="default">                          <p class="default">
353                          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
354                          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
355                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
356                          </p>                          </p>
357                          <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  
358  SET ECHO 1  SET ECHO 1
359    
360  # load the JACK audio driver  # load the JACK audio driver
# Line 324  GET CHANNEL INFO 0 Line 386  GET CHANNEL INFO 0
386    
387  # quit connection  # quit connection
388  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
389                          <p class="default">                          <p class="default">
390                          The next example is a bit more complex.                          The next example is a bit more complex.
391                          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 397  QUIT</pre>
397                          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
398                          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.
399                          </p>                          </p>
400                          <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  
401  SET ECHO 1  SET ECHO 1
402    
403  # load audio and MIDI driver  # load audio and MIDI driver
# Line 442  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 447  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
447  # not necessary, just to see our setup  # not necessary, just to see our setup
448  GET CHANNEL INFO 0  GET CHANNEL INFO 0
449  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
450                          <p class="default">                          <p class="default">
451                          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>.
452                          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.1675
  ViewVC Help
Powered by ViewVC