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