/[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 1290 by iliev, Fri Aug 10 22:45:25 2007 UTC revision 2333 by schoenebeck, Wed Mar 14 22:07:33 2012 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 98  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 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    <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    <a href="donations.html">Why donate?</a>
149    </div>
150    <p>
151    <div class="">
152    <center>
153    <script type="text/javascript"><!--
154    google_ad_client = "pub-3408196773880325";
155    /* 120x600, created 8/3/09 */
156    google_ad_slot = "2910827959";
157    google_ad_width = 120;
158    google_ad_height = 600;
159    //-->
160    </script>
161    <script type="text/javascript"
162    src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
163    </script>
164    </center>
165    </div>
166    
167    
168                          </td><td valign=top width="100%">                          </td><td valign=top width="100%">
169                          <div id="contents">                          <div id="contents">
170    
# Line 126  Line 173 
173                          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!
174                          </p>                          </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>
188    
189                            <a name="windows"></a>
190                            <a name="osx"></a>
191                            <a name="debian"></a>
192                            <h2>Howtos</h2>
193                            <p class="default">
194                            To ease new users the first contact with the Linuxsampler applications,
195                            we have written the following short Howtos:
196                            </p>
197          <table class="decorated">
198            <thead>
199              <tr>
200                <td class="decorated_header">Name</td>
201                <td class="decorated_header">Descripton</td>
202              </tr>
203            </thead>
204            <tbody>
205              <tr>
206                <td class="decorated"><a href="windows.html">Windows HOWTO</a></td>
207                <td class="decorated">
208                  LinuxSampler quickstart guide for the MS Windows operating system.
209                </td>
210              </tr>
211              <tr>
212                <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
213                <td class="decorated">
214                  LinuxSampler quickstart guide for the Apple OS X operating system.
215                </td>
216              </tr>
217              <tr>
218                <td class="decorated"><a href="debian.html">Debian HOWTO</a></td>
219                <td class="decorated">
220                  Guide for how to build optimized Debian packages of LS &amp;
221                  friends for your specific machine.
222                </td>
223              </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>
238          </table>
239    
240                          <h2>gigedit</h2>                          <h2>gigedit</h2>
241                          <p class="default">                          <p class="default">
242                          This is our graphical instrument editor based on the Gtk toolkit.                          This is our graphical instrument editor based on the Gtk toolkit.
# Line 137  Line 248 
248                          edge development version of gigedit from CVS.                          edge development version of gigedit from CVS.
249                          </p>                          </p>
250    
251                          <h2>JSampler</h2>                          <h2><a  name="jsampler">JSampler</a></h2>
252                          <p class="default">                          <p class="default">
253                          JSampler is an opensource, platform-independent,                          JSampler is an opensource, platform-independent,
254                          GUI front-end for LinuxSampler, written entirely in Java.                          GUI front-end for LinuxSampler, written entirely in Java.
255                          Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>                          Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
256                          for more information.                          for more information.<br>
257                            For information about using Fantasia with Miditzer in Puppy Linux VTPO
258                            read this <a href="http://organs.110mb.com/Fantasia.htm" target="_blank">HOWTO</a>.
259                            </p>
260    
261                            <h2>libgig</h2>
262                            <p class="default">
263                            libgig is a C++ library used to load and modify Gigasampler format files.
264                            If you're a developer and might want to use libgig, here is its
265                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
266                            (automatically daily updated from CVS).
267                            </p>
268    
269                            <a name="lscp_spec"></a>
270                            <a name="lscp_specs"></a>
271                            <h2>liblscp</h2>
272                            <p class="default">
273                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
274                            If you're a developer and might want to use liblscp, here is its
275                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
276                            (automatically daily updated from CVS).
277                          </p>                          </p>
278    
279                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
# Line 161  Line 292 
292            <tr>            <tr>
293              <td class="decorated_header">Protocol Name</td>              <td class="decorated_header">Protocol Name</td>
294              <td class="decorated_header">Document Types</td>              <td class="decorated_header">Document Types</td>
295                <td class="decorated_header">Release Date</td>
296              <td class="decorated_header">Description</td>              <td class="decorated_header">Description</td>
297            </tr>            </tr>
298          </thead>          </thead>
299          <tbody>          <tbody>
300            <tr>            <tr>
301              <td class="decorated">LSCP&nbsp;1.0</td>              <td class="decorated">LSCP&nbsp;draft</td>
302              <td class="decorated">              <td class="decorated">
303                <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
304                <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
305                <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>                <a href="http://svn.linuxsampler.org/cgi-bin/viewvc.cgi/linuxsampler/trunk/Documentation/lscp.xml">XML</a>
306                </td>
307                <td class="decorated">unreleased</td>
308                <td class="decorated">
309                  Very latest draft of the protocol (which usually reflects the
310                  latest development state from CVS or may even not be implemented
311                  yet).
312                </td>
313              </tr>
314              <tr>
315                <td class="decorated">LSCP&nbsp;1.4</td>
316                <td class="decorated">
317                  <a href="http://www.linuxsampler.org/api/lscp-1.4.txt">TXT</a>,
318                  <a href="http://www.linuxsampler.org/api/lscp-1.4.html">HTML</a>,
319                  <a href="http://www.linuxsampler.org/api/lscp-1.4.xml">XML</a>
320              </td>              </td>
321                <td class="decorated">2009-07-31</td>
322              <td class="decorated">              <td class="decorated">
323                Protocol specification of the old official release of LinuxSampler (0.3.3).                Protocol specification of the latest official release of LinuxSampler (1.0.0).
324                </td>
325              </tr>
326              <tr>
327                <td class="decorated">LSCP&nbsp;1.3</td>
328                <td class="decorated">
329                  <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,
330                  <a href="http://www.linuxsampler.org/api/lscp-1.3.html">HTML</a>,
331                  <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
332                </td>
333                <td class="decorated">2007-12-06</td>
334                <td class="decorated">
335                  Protocol specification of the previous official release of LinuxSampler (0.5.1).
336                </td>
337              </tr>
338              <tr>
339                <td class="decorated">LSCP&nbsp;1.2</td>
340                <td class="decorated">
341                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
342                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
343                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
344                </td>
345                <td class="decorated">2007-10-15</td>
346                <td class="decorated">
347                  Protocol specification old LinuxSampler release (0.5.0).
348              </td>              </td>
349            </tr>            </tr>
350            <tr>            <tr>
351              <td class="decorated">LSCP&nbsp;1.1</td>              <td class="decorated">LSCP&nbsp;1.1</td>
352              <td class="decorated">              <td class="decorated">
353                <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">ASCII</a>,                <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
354                <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,                <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
355                <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>                <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
356              </td>              </td>
357                <td class="decorated">2006-11-25</td>
358              <td class="decorated">              <td class="decorated">
359                Protocol specification of the latest official release of LinuxSampler (0.4.0).                Protocol specification of ancient LinuxSampler release 0.4.0.
360              </td>              </td>
361            </tr>            </tr>
362            <tr>            <tr>
363              <td class="decorated">LSCP&nbsp;draft</td>              <td class="decorated">LSCP&nbsp;1.0</td>
364              <td class="decorated">              <td class="decorated">
365                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">ASCII</a>,                <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
366                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,                <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
367                <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.0.xml">XML</a>
368              </td>              </td>
369                <td class="decorated">2005-07-17</td>
370              <td class="decorated">              <td class="decorated">
371                Very latest draft of the protocol (which usually reflects the                Protocol specification of ancient LinuxSampler release 0.3.3.
               latest development state from CVS or may even not be implemented  
               yet).  
372              </td>              </td>
373            </tr>            </tr>
374          </tbody>          </tbody>
# Line 273  CREATE AUDIO_OUTPUT_DEVICE JACK Line 444  CREATE AUDIO_OUTPUT_DEVICE JACK
444  # connect to ALSA playback JACK client so we can hear something  # connect to ALSA playback JACK client so we can hear something
445  # (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'
446  #  to get all available JACK clients / ports)  #  to get all available JACK clients / ports)
447  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'
448  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'
449    # Note: above is for JACK2 (a.k.a. jackmp). If you are still using JACK1,
450    # you would need to use this instead:
451    # SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 0 JACK_BINDINGS='alsa_pcm:playback_1'
452    # SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'
453    
454  # load the ALSA MIDI driver  # load the ALSA MIDI driver
455  CREATE MIDI_INPUT_DEVICE ALSA  CREATE MIDI_INPUT_DEVICE ALSA
# Line 301  QUIT</pre> Line 476  QUIT</pre>
476                          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,
477                          handle routing of audio channels, it uses JACK again as audio                          handle routing of audio channels, it uses JACK again as audio
478                          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
479                          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
480                          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
481                          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
482                          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 349  SET CHANNEL AUDIO_OUTPUT_CHANNEL 1 1 3 Line 524  SET CHANNEL AUDIO_OUTPUT_CHANNEL 1 1 3
524    
525  # 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
526  # 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 ;-)
527  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
528  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 1 JACK_BINDINGS='alsa_pcm:playback_2'  #  you have to replace "system" by "alsa_pcm" here)
529  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'
530  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'
531    SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 2 JACK_BINDINGS='system:playback_3'
532    SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 JACK_BINDINGS='system:playback_4'
533    
534  # not necessary, just to see our setup  # not necessary, just to see our setup
535  GET CHANNEL INFO 0  GET CHANNEL INFO 0
Legend:
Removed from v.1290  
changed lines
  Added in v.2333
  ViewVC Help
Powered by ViewVC