/[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 1938 by senoner, Mon Jul 13 00:35:50 2009 UTC revision 2657 by schoenebeck, Thu Jun 19 15:04:15 2014 UTC
# Line 109  Line 109 
109    
110  <body>  <body>
111    
112          <div id="mainwindow"><img name="LinuxSampler" src="gfx/lsbackground.jpg" alt="LinuxSampler">          <div id="mainwindow"><div class="lsbackground"><img name="LinuxSampler" src="gfx/lsbackground.jpg" alt="LinuxSampler"></div>
113    
114                  <h1><span class="hidden">The LinuxSampler Project</span></h1>                  <h1><span class="hidden">The LinuxSampler Project</span></h1>
115    
# Line 132  Line 132 
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">  <div class="boxed">
   
136  <form action="https://www.paypal.com/cgi-bin/webscr" method="post">  <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
137  <input type="hidden" name="cmd" value="_s-xclick">  <input type="hidden" name="cmd" value="_s-xclick">
138  <input type="hidden" name="hosted_button_id" value="6746056">  <input type="hidden" name="hosted_button_id" value="6746056">
139  <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!">  <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!">
140  <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">  <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
141  </form>  </form>
   
142  <form action="https://www.paypal.com/cgi-bin/webscr" method="post">  <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
143  <input type="hidden" name="cmd" value="_s-xclick">  <input type="hidden" name="cmd" value="_s-xclick">
144  <input type="hidden" name="hosted_button_id" value="6746149">  <input type="hidden" name="hosted_button_id" value="6746149">
145  <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!">  <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!">
146  <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">  <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
147  </form>  </form>
148    <table><tr>
149    <td><a href="http://en.wikipedia.org/wiki/Bitcoin"><img src="gfx/logos/bitcoin32.png" alt="Bitcoins"></a></td>
150    <td>Or donate Bitcoins at:</td>
151    </tr></table>
152    <pre class="btcaddr">1Q9CK7xUhMNWryqYTZLbUTXbrjpYYtwvng</pre>
153    <hr>
154    <a href="donations.html">Why donate?</a>
155    </div>
156    <p>
157    <div class="">
158    <center>
159    <script type="text/javascript"><!--
160    google_ad_client = "pub-3408196773880325";
161    /* 120x600, created 8/3/09 */
162    google_ad_slot = "2910827959";
163    google_ad_width = 120;
164    google_ad_height = 600;
165    //-->
166    </script>
167    <script type="text/javascript"
168    src="//pagead2.googlesyndication.com/pagead/show_ads.js">
169    </script>
170    </center>
171    </div>
172    
173    
174                          </td><td valign=top width="100%">                          </td><td valign=top width="100%">
175                          <div id="contents">                          <div id="contents">
176    
177                          <h2>Documentation</h2>                          <h2>Documentation</h2>
178                          <p class="default">                          <p class="default">
179                          This is still quite under construction. Be welcome to help us with writing some documentation!              A lot of the documentation here is currently out-dated. Be invited
180                to help us with updating the documentation!
181                            </p>
182    
183                            <a name="sfz"></a>
184                            <a name="sfz2"></a>
185                            <h2>SFZ(2) format specification and implementation status</h2>
186                            <p class="default">
187                            We are currently in the works of a SFZ(2) format based sampler engine,
188                            as additional powerful sampler engine for LinuxSampler. As there is
189                            currently no official document defining the so called <i>SFZ version 2</i>
190                            format, we created our own <a href="https://docs.google.com/Doc?docid=0AVrDa5LNWylnZGZ6ejk4eHRfNDVjbmsyd3Zmag">SFZ2 reference document</a>,
191                            reflecting the format and the progress of implementation in LinuxSampler's
192                            Subversion developers version. This reference document is currently maintained by
193                            <a href="developers.html#Dahnielson">Anders Dahnielson</a>.
194                          </p>                          </p>
195    
196                          <a name="windows"></a>                          <a name="windows"></a>
# Line 181  Line 218 
218            <tr>            <tr>
219              <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>              <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
220              <td class="decorated">              <td class="decorated">
221                LinuxSampler quickstart guide for the Apple OS X operating system.                LinuxSampler quickstart guide for the Apple OS X operating system (<b>Note:</b> Completely out-dated!).
222              </td>              </td>
223            </tr>            </tr>
224            <tr>            <tr>
# Line 192  Line 229 
229              </td>              </td>
230            </tr>            </tr>
231            <tr>            <tr>
232                <td class="decorated"><a href="http://de.musix-wiki.org/index.php?title=LinuxSampler">Debian HOWTO (German)</a></td>
233                <td class="decorated">
234                  Another guide for Debian on an external site, this one in German language.
235                </td>
236              </tr>
237              <tr>
238              <td class="decorated"><a href="msys.html">Windows Build HOWTO</a></td>              <td class="decorated"><a href="msys.html">Windows Build HOWTO</a></td>
239              <td class="decorated">              <td class="decorated">
240                Guide for how to build libgig, linuxsampler and gigedit                Guide for how to build libgig, linuxsampler and gigedit
# Line 209  Line 252 
252                          for a short tutorial. Please notice that this quickstart document                          for a short tutorial. Please notice that this quickstart document
253                          is automatically generated from CVS and thus might reflect                          is automatically generated from CVS and thus might reflect
254                          features and behaviors only available in the very latest, bleeding                          features and behaviors only available in the very latest, bleeding
255                          edge development version of gigedit from CVS.                          edge development version of gigedit from CVS.<br>
256                <br>
257                <b>Note:</b> The gigedit documentation is currently completely out-dated!
258                          </p>                          </p>
259    
260                          <h2><a  name="jsampler">JSampler</a></h2>                          <h2><a  name="jsampler">JSampler</a></h2>
# Line 224  Line 269 
269    
270                          <h2>libgig</h2>                          <h2>libgig</h2>
271                          <p class="default">                          <p class="default">
272                          libgig is a C++ library used to load and modify Gigasampler format files.                          libgig is a C++ library used to load and modify instrument files,
273                supporting the Gigasampler / GigaStudio file format, SoundFont file
274                format, KORG file format, AKAI disk image format and the DLS
275                (Downloadable Sounds) file format.<br>
276                <br>
277                          If you're a developer and might want to use libgig, here is its                          If you're a developer and might want to use libgig, here is its
278                          <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>                          <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
279                          (automatically daily updated from CVS).                          (automatically updated from SVN).
280                          </p>                          </p>
281    
282                          <a name="lscp_spec"></a>                          <a name="lscp_spec"></a>
# Line 237  Line 286 
286                          liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.                          liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
287                          If you're a developer and might want to use liblscp, here is its                          If you're a developer and might want to use liblscp, here is its
288                          <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>                          <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
289                          (automatically daily updated from CVS).                          (automatically updated from SVN).
290                          </p>                          </p>
291    
292                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
# Line 266  Line 315 
315              <td class="decorated">              <td class="decorated">
316                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
317                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
318                <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://svn.linuxsampler.org/cgi-bin/viewvc.cgi/linuxsampler/trunk/Documentation/lscp.xml">XML</a>
319              </td>              </td>
320              <td class="decorated">unreleased</td>              <td class="decorated">unreleased</td>
321              <td class="decorated">              <td class="decorated">
322                Very latest draft of the protocol (which usually reflects the                Very latest draft of the protocol (which usually reflects the
323                latest development state from CVS or may even not be implemented                latest development state from SVN or may even not be implemented
324                yet).                yet).
325              </td>              </td>
326            </tr>            </tr>
327            <tr>            <tr>
328                <td class="decorated">LSCP&nbsp;1.6</td>
329                <td class="decorated">
330                  <a href="http://www.linuxsampler.org/api/lscp-1.6.txt">TXT</a>,
331                  <a href="http://www.linuxsampler.org/api/lscp-1.6.html">HTML</a>,
332                  <a href="http://www.linuxsampler.org/api/lscp-1.6.xml">XML</a>
333                </td>
334                <td class="decorated">2014-01-10</td>
335                <td class="decorated">
336                  Protocol specification of a SVN LinuxSampler version (1.0.0.svn25 - svn r2500).
337                </td>
338              </tr>
339              <tr>
340                <td class="decorated">LSCP&nbsp;1.5</td>
341                <td class="decorated">
342                  <a href="http://www.linuxsampler.org/api/lscp-1.5.txt">TXT</a>,
343                  <a href="http://www.linuxsampler.org/api/lscp-1.5.html">HTML</a>,
344                  <a href="http://www.linuxsampler.org/api/lscp-1.5.xml">XML</a>
345                </td>
346                <td class="decorated">2011-06-24</td>
347                <td class="decorated">
348                  Protocol specification of a SVN LinuxSampler version (svn r2188).
349                </td>
350              </tr>
351              <tr>
352                <td class="decorated">LSCP&nbsp;1.4</td>
353                <td class="decorated">
354                  <a href="http://www.linuxsampler.org/api/lscp-1.4.txt">TXT</a>,
355                  <a href="http://www.linuxsampler.org/api/lscp-1.4.html">HTML</a>,
356                  <a href="http://www.linuxsampler.org/api/lscp-1.4.xml">XML</a>
357                </td>
358                <td class="decorated">2009-07-31</td>
359                <td class="decorated">
360                  Protocol specification of old official LinuxSampler release v1.0.0.
361                </td>
362              </tr>
363              <tr>
364              <td class="decorated">LSCP&nbsp;1.3</td>              <td class="decorated">LSCP&nbsp;1.3</td>
365              <td class="decorated">              <td class="decorated">
366                <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,                <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,
# Line 284  Line 369 
369              </td>              </td>
370              <td class="decorated">2007-12-06</td>              <td class="decorated">2007-12-06</td>
371              <td class="decorated">              <td class="decorated">
372                Protocol specification of the latest official release of LinuxSampler (0.5.1).                Protocol specification of ancient LinuxSampler release (0.5.1).
373              </td>              </td>
374            </tr>            </tr>
375            <tr>            <tr>
# Line 296  Line 381 
381              </td>              </td>
382              <td class="decorated">2007-10-15</td>              <td class="decorated">2007-10-15</td>
383              <td class="decorated">              <td class="decorated">
384                Protocol specification of the previous official release of LinuxSampler (0.5.0).                Protocol specification of ancient LinuxSampler release (0.5.0).
385              </td>              </td>
386            </tr>            </tr>
387            <tr>            <tr>
# Line 308  Line 393 
393              </td>              </td>
394              <td class="decorated">2006-11-25</td>              <td class="decorated">2006-11-25</td>
395              <td class="decorated">              <td class="decorated">
396                Protocol specification old LinuxSampler release 0.4.0.                Protocol specification of ancient LinuxSampler release 0.4.0.
397              </td>              </td>
398            </tr>            </tr>
399            <tr>            <tr>
# Line 396  CREATE AUDIO_OUTPUT_DEVICE JACK Line 481  CREATE AUDIO_OUTPUT_DEVICE JACK
481  # connect to ALSA playback JACK client so we can hear something  # connect to ALSA playback JACK client so we can hear something
482  # (you can use 'GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 0 0 JACK_BINDINGS'  # (you can use 'GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 0 0 JACK_BINDINGS'
483  #  to get all available JACK clients / ports)  #  to get all available JACK clients / ports)
484  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='alsa_pcm:playback_1'  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='system:playback_1'
485  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='system:playback_2'
486    # Note: above is for JACK2 (a.k.a. jackmp). If you are still using JACK1,
487    # you would need to use this instead:
488    # SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='alsa_pcm:playback_1'
489    # SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'
490    
491  # load the ALSA MIDI driver  # load the ALSA MIDI driver
492  CREATE MIDI_INPUT_DEVICE ALSA  CREATE MIDI_INPUT_DEVICE ALSA
# Line 424  QUIT</pre> Line 513  QUIT</pre>
513                          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,
514                          handle routing of audio channels, it uses JACK again as audio                          handle routing of audio channels, it uses JACK again as audio
515                          output driver, but creates the JACK client with four output channels instead, it creates two                          output driver, but creates the JACK client with four output channels instead, it creates two
516                          sampler channels, loads two different instrument on those two sampler channels and alters                          sampler channels, loads two different instruments on those two sampler channels and alters
517                          the audio channel routing so that the two output channels of sampler channel 1 are routed to                          the audio channel routing so that the two output channels of sampler channel 1 are routed to
518                          the first two JACK output channels and the two output channels of sampler channel 2 are routed                          the first two JACK output channels and the two output channels of sampler channel 2 are routed
519                          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
# Line 472  SET CHANNEL AUDIO_OUTPUT_CHANNEL 1 1 3 Line 561  SET CHANNEL AUDIO_OUTPUT_CHANNEL 1 1 3
561    
562  # automatic connection between the four 4 ports of LS's Jack client and the  # automatic connection between the four 4 ports of LS's Jack client and the
563  # ALSA PCM JACK client (assuming your sound card has at least 4 outputs ;-)  # ALSA PCM JACK client (assuming your sound card has at least 4 outputs ;-)
564  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='alsa_pcm:playback_1'  # (assumimg JACK2 a.k.a. jackmp here, if you are still using JACK1 then
565  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'  #  you have to replace "system" by "alsa_pcm" here)
566  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 2 JACK_BINDINGS='alsa_pcm:playback_3'  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='system:playback_1'
567  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 JACK_BINDINGS='alsa_pcm:playback_4'  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='system:playback_2'
568    SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 2 JACK_BINDINGS='system:playback_3'
569    SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 JACK_BINDINGS='system:playback_4'
570    
571  # not necessary, just to see our setup  # not necessary, just to see our setup
572  GET CHANNEL INFO 0  GET CHANNEL INFO 0

Legend:
Removed from v.1938  
changed lines
  Added in v.2657

  ViewVC Help
Powered by ViewVC