/[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 1675 by schoenebeck, Fri Feb 8 14:21:33 2008 UTC revision 3923 by schoenebeck, Mon Jun 14 11:26:48 2021 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();                  supportover = new Image();
59                  supportover.src = dir + "msupporthover.png";                  supportover.src = dir + "msupporthover.png";
60                  supportout = new Image();                  supportout = new Image();
# Line 103  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 116  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>                          <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>
# Line 124  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    <div class="boxed">
136    <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
137    <input type="hidden" name="cmd" value="_s-xclick">
138    <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!">
140    <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
141    </form>
142    <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
143    <input type="hidden" name="cmd" value="_s-xclick">
144    <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!">
146    <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
147    </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    
157    
158                          </td><td valign=top width="100%">                          </td><td valign=top width="100%">
159                          <div id="contents">                          <div id="contents">
160    
161                          <h2>Documentation</h2>                          <h2>Documentation</h2>
162                          <p class="default">                          <p class="default">
163                          This is still quite under construction. Be welcome to help us with writing some documentation!                          We are currently in a transition phase.
164                            Most of the documentation on this page is actually old and out-dated.
165                            We are currently moving (more recent) documentation to the separate site
166                            <a href="http://doc.linuxsampler.org">doc.linuxsampler.org</a>:<br>
167                            <br>
168                            <a href="http://doc.linuxsampler.org">
169                    <img src="gfx/doc_site_shot.png" style="width:520px;" />
170                </a>
171                            <br>
172                            Be invited to help us with <a href="http://doc.linuxsampler.org/Writing_Docs/">writing documentation</a>!
173                            <p class="default">
174                            </p>
175    
176                            <a name="sfz"></a>
177                            <a name="sfz2"></a>
178                            <h2>SFZ(2) format specification and implementation status</h2>
179                            <p class="default">
180                            We are currently in the works of a SFZ(2) format based sampler engine,
181                            as additional powerful sampler engine for LinuxSampler. As there is
182                            currently no official document defining the so called <i>SFZ version 2</i>
183                            format, we created our own <a href="https://docs.google.com/Doc?docid=0AVrDa5LNWylnZGZ6ejk4eHRfNDVjbmsyd3Zmag">SFZ2 reference document</a>,
184                            reflecting the format and the progress of implementation in LinuxSampler's
185                            Subversion developers version. This reference document is currently maintained by
186                            <a href="developers.html#Dahnielson">Anders Dahnielson</a>.
187                          </p>                          </p>
188    
189                          <a name="windows"></a>                          <a name="windows"></a>
# Line 157  Line 211 
211            <tr>            <tr>
212              <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>              <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
213              <td class="decorated">              <td class="decorated">
214                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!).
215              </td>              </td>
216            </tr>            </tr>
217            <tr>            <tr>
# Line 167  Line 221 
221                friends for your specific machine.                friends for your specific machine.
222              </td>              </td>
223            </tr>            </tr>
224              <tr>
225                <td class="decorated"><a href="http://de.musix-wiki.org/index.php?title=LinuxSampler">Debian HOWTO (German)</a></td>
226                <td class="decorated">
227                  Another guide for Debian on an external site, this one in German language.
228                </td>
229              </tr>
230              <tr>
231                <td class="decorated"><a href="msys.html">Windows Build HOWTO</a></td>
232                <td class="decorated">
233                  Guide for how to build libgig, linuxsampler and gigedit
234                  for Windows by using MSYS.
235                </td>
236              </tr>
237          </tbody>          </tbody>
238        </table>        </table>
239    
# Line 178  Line 245 
245                          for a short tutorial. Please notice that this quickstart document                          for a short tutorial. Please notice that this quickstart document
246                          is automatically generated from CVS and thus might reflect                          is automatically generated from CVS and thus might reflect
247                          features and behaviors only available in the very latest, bleeding                          features and behaviors only available in the very latest, bleeding
248                          edge development version of gigedit from CVS.                          edge development version of gigedit from CVS.<br>
249                <br>
250                <b>Note:</b> The gigedit documentation is currently completely out-dated!
251                          </p>                          </p>
252    
253                          <h2>JSampler</h2>                          <h2><a  name="jsampler">JSampler</a></h2>
254                          <p class="default">                          <p class="default">
255                          JSampler is an opensource, platform-independent,                          JSampler is an opensource, platform-independent,
256                          GUI front-end for LinuxSampler, written entirely in Java.                          GUI front-end for LinuxSampler, written entirely in Java.
257                          Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>                          Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
258                          for more information.                          for more information.<br>
259                            For information about using Fantasia with Miditzer in Puppy Linux VTPO
260                            read this <a href="http://organs.110mb.com/Fantasia.htm" target="_blank">HOWTO</a>.
261                          </p>                          </p>
262    
263                          <h2>libgig</h2>                          <h2>libgig</h2>
264                          <p class="default">                          <p class="default">
265                          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,
266                supporting the Gigasampler / GigaStudio file format, SoundFont file
267                format, KORG file format, AKAI disk image format and the DLS
268                (Downloadable Sounds) file format.<br>
269                <br>
270                          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
271                          <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>                          <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
272                          (automatically daily updated from CVS).                          (automatically updated from SVN).
273                          </p>                          </p>
274    
275                          <a name="lscp_spec"></a>                          <a name="lscp_spec"></a>
# Line 204  Line 279 
279                          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>.
280                          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
281                          <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>                          <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
282                          (automatically daily updated from CVS).                          (automatically updated from SVN).
283                          </p>                          </p>
284    
285                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
# Line 233  Line 308 
308              <td class="decorated">              <td class="decorated">
309                <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>,
310                <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>,
311                <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?content-type=text%2Fplain">XML</a>
312              </td>              </td>
313              <td class="decorated">unreleased</td>              <td class="decorated">unreleased</td>
314              <td class="decorated">              <td class="decorated">
315                Very latest draft of the protocol (which usually reflects the                Very latest draft of the protocol (which usually reflects the
316                latest development state from CVS or may even not be implemented                latest development state from SVN or may even not be implemented
317                yet).                yet).
318              </td>              </td>
319            </tr>            </tr>
320            <tr>            <tr>
321                <td class="decorated">LSCP&nbsp;1.7</td>
322                <td class="decorated">
323                  <a href="http://www.linuxsampler.org/api/lscp-1.7.txt">TXT</a>,
324                  <a href="http://www.linuxsampler.org/api/lscp-1.7.html">HTML</a>,
325                  <a href="http://www.linuxsampler.org/api/lscp-1.7.pdf">PDF</a>,
326                  <a href="http://www.linuxsampler.org/api/lscp-1.7.xml">XML</a>
327                </td>
328                <td class="decorated">2015-07-15</td>
329                <td class="decorated">
330                  Protocol specification of latest LinuxSampler release (v2.0.0).
331                </td>
332              </tr>
333              <tr>
334                <td class="decorated">LSCP&nbsp;1.6</td>
335                <td class="decorated">
336                  <a href="http://www.linuxsampler.org/api/lscp-1.6.txt">TXT</a>,
337                  <a href="http://www.linuxsampler.org/api/lscp-1.6.html">HTML</a>,
338                  <a href="http://www.linuxsampler.org/api/lscp-1.6.xml">XML</a>
339                </td>
340                <td class="decorated">2014-01-10</td>
341                <td class="decorated">
342                  Protocol specification of a SVN LinuxSampler version (1.0.0.svn25 - svn r2500).
343                </td>
344              </tr>
345              <tr>
346                <td class="decorated">LSCP&nbsp;1.5</td>
347                <td class="decorated">
348                  <a href="http://www.linuxsampler.org/api/lscp-1.5.txt">TXT</a>,
349                  <a href="http://www.linuxsampler.org/api/lscp-1.5.html">HTML</a>,
350                  <a href="http://www.linuxsampler.org/api/lscp-1.5.xml">XML</a>
351                </td>
352                <td class="decorated">2011-06-24</td>
353                <td class="decorated">
354                  Protocol specification of a SVN LinuxSampler version (svn r2188).
355                </td>
356              </tr>
357              <tr>
358                <td class="decorated">LSCP&nbsp;1.4</td>
359                <td class="decorated">
360                  <a href="http://www.linuxsampler.org/api/lscp-1.4.txt">TXT</a>,
361                  <a href="http://www.linuxsampler.org/api/lscp-1.4.html">HTML</a>,
362                  <a href="http://www.linuxsampler.org/api/lscp-1.4.xml">XML</a>
363                </td>
364                <td class="decorated">2009-07-31</td>
365                <td class="decorated">
366                  Protocol specification of old official LinuxSampler release v1.0.0.
367                </td>
368              </tr>
369              <tr>
370              <td class="decorated">LSCP&nbsp;1.3</td>              <td class="decorated">LSCP&nbsp;1.3</td>
371              <td class="decorated">              <td class="decorated">
372                <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 251  Line 375 
375              </td>              </td>
376              <td class="decorated">2007-12-06</td>              <td class="decorated">2007-12-06</td>
377              <td class="decorated">              <td class="decorated">
378                Protocol specification of the latest official release of LinuxSampler (0.5.1).                Protocol specification of ancient LinuxSampler release (0.5.1).
379              </td>              </td>
380            </tr>            </tr>
381            <tr>            <tr>
# Line 263  Line 387 
387              </td>              </td>
388              <td class="decorated">2007-10-15</td>              <td class="decorated">2007-10-15</td>
389              <td class="decorated">              <td class="decorated">
390                Protocol specification of the previous official release of LinuxSampler (0.5.0).                Protocol specification of ancient LinuxSampler release (0.5.0).
391              </td>              </td>
392            </tr>            </tr>
393            <tr>            <tr>
# Line 275  Line 399 
399              </td>              </td>
400              <td class="decorated">2006-11-25</td>              <td class="decorated">2006-11-25</td>
401              <td class="decorated">              <td class="decorated">
402                Protocol specification old LinuxSampler release 0.4.0.                Protocol specification of ancient LinuxSampler release 0.4.0.
403              </td>              </td>
404            </tr>            </tr>
405            <tr>            <tr>
# Line 363  CREATE AUDIO_OUTPUT_DEVICE JACK Line 487  CREATE AUDIO_OUTPUT_DEVICE JACK
487  # connect to ALSA playback JACK client so we can hear something  # connect to ALSA playback JACK client so we can hear something
488  # (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'
489  #  to get all available JACK clients / ports)  #  to get all available JACK clients / ports)
490  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'
491  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'
492    # Note: above is for JACK2 (a.k.a. jackmp). If you are still using JACK1,
493    # you would need to use this instead:
494    # SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='alsa_pcm:playback_1'
495    # SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'
496    
497  # load the ALSA MIDI driver  # load the ALSA MIDI driver
498  CREATE MIDI_INPUT_DEVICE ALSA  CREATE MIDI_INPUT_DEVICE ALSA
# Line 391  QUIT</pre> Line 519  QUIT</pre>
519                          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,
520                          handle routing of audio channels, it uses JACK again as audio                          handle routing of audio channels, it uses JACK again as audio
521                          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
522                          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
523                          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
524                          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
525                          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 439  SET CHANNEL AUDIO_OUTPUT_CHANNEL 1 1 3 Line 567  SET CHANNEL AUDIO_OUTPUT_CHANNEL 1 1 3
567    
568  # 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
569  # 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 ;-)
570  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
571  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'  #  you have to replace "system" by "alsa_pcm" here)
572  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'
573  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'
574    SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 2 JACK_BINDINGS='system:playback_3'
575    SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 JACK_BINDINGS='system:playback_4'
576    
577  # not necessary, just to see our setup  # not necessary, just to see our setup
578  GET CHANNEL INFO 0  GET CHANNEL INFO 0
Legend:
Removed from v.1675  
changed lines
  Added in v.3923
  ViewVC Help
Powered by ViewVC