/[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 1935 by schoenebeck, Sun Jul 12 17:35:36 2009 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 118  Line 124 
124                          <a id="instruments" href="instruments.html" onmouseover="javascript:if(document.images)document.instruments.src = instrumentsover.src" onmouseout="javascript:if(document.images)document.instruments.src = instrumentsout.src"><img name="instruments" src="gfx/minstruments.png" alt="instruments"></a>                          <a id="instruments" href="instruments.html" onmouseover="javascript:if(document.images)document.instruments.src = instrumentsover.src" onmouseout="javascript:if(document.images)document.instruments.src = instrumentsout.src"><img name="instruments" src="gfx/minstruments.png" alt="instruments"></a>
125                          <a id="links" href="links.html" onmouseover="javascript:if(document.images)document.links.src = linksover.src" onmouseout="javascript:if(document.images)document.links.src = linksout.src"><img name="links" src="gfx/mlinks.png" alt="links"></a>                          <a id="links" href="links.html" onmouseover="javascript:if(document.images)document.links.src = linksover.src" onmouseout="javascript:if(document.images)document.links.src = linksout.src"><img name="links" src="gfx/mlinks.png" alt="links"></a>
126                          <a id="credits" href="credits.html" onmouseover="javascript:if(document.images)document.credits.src = creditsover.src" onmouseout="javascript:if(document.images)document.credits.src = creditsout.src"><img name="credits" src="gfx/mcredits.png" alt="credits"></a>                          <a id="credits" href="credits.html" onmouseover="javascript:if(document.images)document.credits.src = creditsover.src" onmouseout="javascript:if(document.images)document.credits.src = creditsout.src"><img name="credits" src="gfx/mcredits.png" alt="credits"></a>
127    
128    <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="10" height="20">
129    
130    <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
131    <input type="hidden" name="cmd" value="_s-xclick">
132    <input type="hidden" name="hosted_button_id" value="6746056">
133    <input type="image" src="https://www.paypal.com/en_US/i/btn/btn_subscribeCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
134    <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
135    </form>
136    
137    <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
138    <input type="hidden" name="cmd" value="_s-xclick">
139    <input type="hidden" name="hosted_button_id" value="6746149">
140    <input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
141    <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
142    </form>
143    
144                          </td><td valign=top width="100%">                          </td><td valign=top width="100%">
145                          <div id="contents">                          <div id="contents">
146    
# Line 126  Line 149 
149                          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!
150                          </p>                          </p>
151    
152                            <a name="windows"></a>
153                            <a name="osx"></a>
154                            <a name="debian"></a>
155                            <h2>Howtos</h2>
156                            <p class="default">
157                            To ease new users the first contact with the Linuxsampler applications,
158                            we have written the following short Howtos:
159                            </p>
160          <table class="decorated">
161            <thead>
162              <tr>
163                <td class="decorated_header">Name</td>
164                <td class="decorated_header">Descripton</td>
165              </tr>
166            </thead>
167            <tbody>
168              <tr>
169                <td class="decorated"><a href="windows.html">Windows HOWTO</a></td>
170                <td class="decorated">
171                  LinuxSampler quickstart guide for the MS Windows operating system.
172                </td>
173              </tr>
174              <tr>
175                <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
176                <td class="decorated">
177                  LinuxSampler quickstart guide for the Apple OS X operating system.
178                </td>
179              </tr>
180              <tr>
181                <td class="decorated"><a href="debian.html">Debian HOWTO</a></td>
182                <td class="decorated">
183                  Guide for how to build optimized Debian packages of LS &amp;
184                  friends for your specific machine.
185                </td>
186              </tr>
187              <tr>
188                <td class="decorated"><a href="msys.html">Windows Build HOWTO</a></td>
189                <td class="decorated">
190                  Guide for how to build libgig, linuxsampler and gigedit
191                  for Windows by using MSYS.
192                </td>
193              </tr>
194            </tbody>
195          </table>
196    
197                            <h2>gigedit</h2>
198                            <p class="default">
199                            This is our graphical instrument editor based on the Gtk toolkit.
200                            It can be used stand-alone or in conjunction with LinuxSampler.
201                            Read the <a href="http://download.linuxsampler.org/doc/gigedit/quickstart/gigedit_quickstart.html">Gigedit Quickstart</a>
202                            for a short tutorial. Please notice that this quickstart document
203                            is automatically generated from CVS and thus might reflect
204                            features and behaviors only available in the very latest, bleeding
205                            edge development version of gigedit from CVS.
206                            </p>
207    
208                            <h2><a  name="jsampler">JSampler</a></h2>
209                            <p class="default">
210                            JSampler is an opensource, platform-independent,
211                            GUI front-end for LinuxSampler, written entirely in Java.
212                            Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
213                            for more information.<br>
214                            For information about using Fantasia with Miditzer in Puppy Linux VTPO
215                            read this <a href="http://organs.110mb.com/Fantasia.htm" target="_blank">HOWTO</a>.
216                            </p>
217    
218                            <h2>libgig</h2>
219                            <p class="default">
220                            libgig is a C++ library used to load and modify Gigasampler format files.
221                            If you're a developer and might want to use libgig, here is its
222                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
223                            (automatically daily updated from CVS).
224                            </p>
225    
226                            <a name="lscp_spec"></a>
227                            <a name="lscp_specs"></a>
228                            <h2>liblscp</h2>
229                            <p class="default">
230                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
231                            If you're a developer and might want to use liblscp, here is its
232                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
233                            (automatically daily updated from CVS).
234                            </p>
235    
236                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
237                          <p class="default">                          <p class="default">
238                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
239                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
240                          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
241                          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
242                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
243                          <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
244                          LinuxSampler! This is the protocol specification of the old                          LinuxSampler!
245                          official release of LinuxSampler (0.3.3):                          </p>
246                          <br>  
247                          </p>        <table class="decorated">
248                          <center>          <thead>
249                          LinuxSampler Control Protocol v1.0            <tr>
250                          (<a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,              <td class="decorated_header">Protocol Name</td>
251                          <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,              <td class="decorated_header">Document Types</td>
252                          <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>)              <td class="decorated_header">Release Date</td>
253                          </center>              <td class="decorated_header">Description</td>
254                          <p class="default">            </tr>
255                          This is the protocol specification of the latest          </thead>
256                          official release of LinuxSampler (0.4.0):          <tbody>
257                          <br>            <tr>
258                          </p>              <td class="decorated">LSCP&nbsp;draft</td>
259                          <center>              <td class="decorated">
260                          LinuxSampler Control Protocol v1.1                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
261                          (<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>,
262                          <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>
263                          <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>)              </td>
264                          </center>              <td class="decorated">unreleased</td>
265                          <p class="default">              <td class="decorated">
266                          The following is the very latest draft of the protocol (which                Very latest draft of the protocol (which usually reflects the
267                          usually reflects the latest development state from CVS or may                latest development state from CVS or may even not be implemented
268                          even not be implemented yet):                yet).
269                          <br>              </td>
270                          </p>            </tr>
271                          <center>            <tr>
272                          LinuxSampler Control Protocol Draft              <td class="decorated">LSCP&nbsp;1.3</td>
273                          (<a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,              <td class="decorated">
274                          <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>,
275                          <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>,
276                          </center>                <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
277                </td>
278                <td class="decorated">2007-12-06</td>
279                <td class="decorated">
280                  Protocol specification of the latest official release of LinuxSampler (0.5.1).
281                </td>
282              </tr>
283              <tr>
284                <td class="decorated">LSCP&nbsp;1.2</td>
285                <td class="decorated">
286                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
287                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
288                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
289                </td>
290                <td class="decorated">2007-10-15</td>
291                <td class="decorated">
292                  Protocol specification of the previous official release of LinuxSampler (0.5.0).
293                </td>
294              </tr>
295              <tr>
296                <td class="decorated">LSCP&nbsp;1.1</td>
297                <td class="decorated">
298                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
299                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
300                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
301                </td>
302                <td class="decorated">2006-11-25</td>
303                <td class="decorated">
304                  Protocol specification old LinuxSampler release 0.4.0.
305                </td>
306              </tr>
307              <tr>
308                <td class="decorated">LSCP&nbsp;1.0</td>
309                <td class="decorated">
310                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
311                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
312                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
313                </td>
314                <td class="decorated">2005-07-17</td>
315                <td class="decorated">
316                  Protocol specification of ancient LinuxSampler release 0.3.3.
317                </td>
318              </tr>
319            </tbody>
320          </table>
321    
322                          <p class="default">                          <p class="default">
323                          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
324                          <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 334 
334                          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
335                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
336                          </p>                          </p>
337                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
338                                  <tr>                          <p class="default">
339                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
340                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
341                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
342                                      <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.
343                                    </td>                          </p>
                                 </tr>  
                         </table>  
344                          <p class="default">                          <p class="default">
345                          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,
346                          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
347                          on that sampler channel:                          on that sampler channel:
348                          </p>                          </p>
349                          <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  
350  SET ECHO 1  SET ECHO 1
351    
352  # load the ALSA audio driver  # load the ALSA audio driver
# Line 259  GET CHANNEL INFO 0 Line 375  GET CHANNEL INFO 0
375    
376  # quit connection  # quit connection
377  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
378                          <p class="default">                          <p class="default">
379                          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
380                          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
381                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
382                          </p>                          </p>
383                          <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  
384  SET ECHO 1  SET ECHO 1
385    
386  # load the JACK audio driver  # load the JACK audio driver
# Line 335  GET CHANNEL INFO 0 Line 412  GET CHANNEL INFO 0
412    
413  # quit connection  # quit connection
414  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
415                          <p class="default">                          <p class="default">
416                          The next example is a bit more complex.                          The next example is a bit more complex.
417                          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 423  QUIT</pre>
423                          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
424                          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.
425                          </p>                          </p>
426                          <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  
427  SET ECHO 1  SET ECHO 1
428    
429  # load audio and MIDI driver  # load audio and MIDI driver
# Line 453  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 473  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
473  # not necessary, just to see our setup  # not necessary, just to see our setup
474  GET CHANNEL INFO 0  GET CHANNEL INFO 0
475  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
476                          <p class="default">                          <p class="default">
477                          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>.
478                          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.1935
  ViewVC Help
Powered by ViewVC