/[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 1822 by persson, Sun Dec 28 09:53:14 2008 UTC
# Line 49  Line 49 
49                  downloadsout = new Image();                  downloadsout = new Image();
50                  downloadsout.src = dir + "mdownloads.png";                  downloadsout.src = dir + "mdownloads.png";
51    
52                    supportover = new Image();
53                    supportover.src = dir + "msupporthover.png";
54                    supportout = new Image();
55                    supportout.src = dir + "msupport.png";
56    
57                  developersover = new Image();                  developersover = new Image();
58                  developersover.src = dir + "mdevelopershover.png";                  developersover.src = dir + "mdevelopershover.png";
59    
# Line 111  Line 116 
116                          <a id="screenshots" href="screenshots.html" onmouseover="javascript:if(document.images)document.screenshots.src = screenshotsover.src" onmouseout="javascript:if(document.images)document.screenshots.src = screenshotsout.src"><img name="screenshots" src="gfx/mscreenshots.png" alt="screenshots"></a>                          <a id="screenshots" href="screenshots.html" onmouseover="javascript:if(document.images)document.screenshots.src = screenshotsover.src" onmouseout="javascript:if(document.images)document.screenshots.src = screenshotsout.src"><img name="screenshots" src="gfx/mscreenshots.png" alt="screenshots"></a>
117                          <a id="demos" href="demos.html" onmouseover="javascript:if(document.images)document.demos.src = demosover.src" onmouseout="javascript:if(document.images)document.demos.src = demosout.src"><img name="demos" src="gfx/mdemos.png" alt="demos"></a>                          <a id="demos" href="demos.html" onmouseover="javascript:if(document.images)document.demos.src = demosover.src" onmouseout="javascript:if(document.images)document.demos.src = demosout.src"><img name="demos" src="gfx/mdemos.png" alt="demos"></a>
118                          <a id="downloads" href="downloads.html" onmouseover="javascript:if(document.images)document.downloads.src = downloadsover.src" onmouseout="javascript:if(document.images)document.downloads.src = downloadsout.src"><img name="downloads" src="gfx/mdownloads.png" alt="download"></a>                          <a id="downloads" href="downloads.html" onmouseover="javascript:if(document.images)document.downloads.src = downloadsover.src" onmouseout="javascript:if(document.images)document.downloads.src = downloadsout.src"><img name="downloads" src="gfx/mdownloads.png" alt="download"></a>
119                            <a id="support" href="support.html" onmouseover="javascript:if(document.images)document.support.src = supportover.src" onmouseout="javascript:if(document.images)document.support.src = supportout.src"><img name="support" src="gfx/msupport.png" alt="support"></a>
120                          <a id="developers" href="developers.html" onmouseover="javascript:if(document.images)document.developers.src = developersover.src" onmouseout="javascript:if(document.images)document.developers.src = developersout.src"><img name="developers" src="gfx/mdevelopers.png" alt="developers"></a>                          <a id="developers" href="developers.html" onmouseover="javascript:if(document.images)document.developers.src = developersover.src" onmouseout="javascript:if(document.images)document.developers.src = developersout.src"><img name="developers" src="gfx/mdevelopers.png" alt="developers"></a>
121                          <a id="faq" href="faq.html" onmouseover="javascript:if(document.images)document.faq.src = faqover.src" onmouseout="javascript:if(document.images)document.faq.src = faqout.src"><img name="faq" src="gfx/mfaq.png" alt="faq"></a>                          <a id="faq" href="faq.html" onmouseover="javascript:if(document.images)document.faq.src = faqover.src" onmouseout="javascript:if(document.images)document.faq.src = faqout.src"><img name="faq" src="gfx/mfaq.png" alt="faq"></a>
122                          <a id="documentation" href="documentation.html" onmouseover="javascript:if(document.images)document.documentation.src = documentationover.src" onmouseout="javascript:if(document.images)document.documentation.src = documentationout.src"><img name="documentation" src="gfx/mdocumentation.png" alt="documentation"></a>                          <a id="documentation" href="documentation.html" onmouseover="javascript:if(document.images)document.documentation.src = documentationover.src" onmouseout="javascript:if(document.images)document.documentation.src = documentationout.src"><img name="documentation" src="gfx/mdocumentation.png" alt="documentation"></a>
# Line 126  Line 132 
132                          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!
133                          </p>                          </p>
134    
135                            <a name="windows"></a>
136                            <a name="osx"></a>
137                            <a name="debian"></a>
138                            <h2>Howtos</h2>
139                            <p class="default">
140                            To ease new users the first contact with the Linuxsampler applications,
141                            we have written the following short Howtos:
142                            </p>
143          <table class="decorated">
144            <thead>
145              <tr>
146                <td class="decorated_header">Name</td>
147                <td class="decorated_header">Descripton</td>
148              </tr>
149            </thead>
150            <tbody>
151              <tr>
152                <td class="decorated"><a href="windows.html">Windows HOWTO</a></td>
153                <td class="decorated">
154                  LinuxSampler quickstart guide for the MS Windows operating system.
155                </td>
156              </tr>
157              <tr>
158                <td class="decorated"><a href="osx.html">OS X HOWTO</a></td>
159                <td class="decorated">
160                  LinuxSampler quickstart guide for the Apple OS X operating system.
161                </td>
162              </tr>
163              <tr>
164                <td class="decorated"><a href="debian.html">Debian HOWTO</a></td>
165                <td class="decorated">
166                  Guide for how to build optimized Debian packages of LS &amp;
167                  friends for your specific machine.
168                </td>
169              </tr>
170              <tr>
171                <td class="decorated"><a href="msys.html">Windows Build HOWTO</a></td>
172                <td class="decorated">
173                  Guide for how to build libgig, linuxsampler and gigedit
174                  for Windows by using MSYS.
175                </td>
176              </tr>
177            </tbody>
178          </table>
179    
180                            <h2>gigedit</h2>
181                            <p class="default">
182                            This is our graphical instrument editor based on the Gtk toolkit.
183                            It can be used stand-alone or in conjunction with LinuxSampler.
184                            Read the <a href="http://download.linuxsampler.org/doc/gigedit/quickstart/gigedit_quickstart.html">Gigedit Quickstart</a>
185                            for a short tutorial. Please notice that this quickstart document
186                            is automatically generated from CVS and thus might reflect
187                            features and behaviors only available in the very latest, bleeding
188                            edge development version of gigedit from CVS.
189                            </p>
190    
191                            <h2><a  name="jsampler">JSampler</a></h2>
192                            <p class="default">
193                            JSampler is an opensource, platform-independent,
194                            GUI front-end for LinuxSampler, written entirely in Java.
195                            Read the <a href="jsampler/manual/html/jsampler.html">JSampler manual</a>
196                            for more information.<br>
197                            For information about using Fantasia with Miditzer in Puppy Linux VTPO
198                            read this <a href="http://organs.110mb.com/Fantasia.htm" target="_blank">HOWTO</a>.
199                            </p>
200    
201                            <h2>libgig</h2>
202                            <p class="default">
203                            libgig is a C++ library used to load and modify Gigasampler format files.
204                            If you're a developer and might want to use libgig, here is its
205                            <a href="http://download.linuxsampler.org/doc/libgig/api/">API documentation</a>
206                            (automatically daily updated from CVS).
207                            </p>
208    
209                            <a name="lscp_spec"></a>
210                            <a name="lscp_specs"></a>
211                            <h2>liblscp</h2>
212                            <p class="default">
213                            liblscp is C library as convenient wrapper around the <i>LinuxSampler Control Protocol</i>.
214                            If you're a developer and might want to use liblscp, here is its
215                            <a href="http://download.linuxsampler.org/doc/liblscp/">API documentation</a>
216                            (automatically daily updated from CVS).
217                            </p>
218    
219                          <h2>LSCP Reference</h2>                          <h2>LSCP Reference</h2>
220                          <p class="default">                          <p class="default">
221                          The following document defines the network protocol with which LinuxSampler can be controlled.                          The following documents define the <i>LinuxSampler Control Protocol</i>,
222                            a network protocol with which LinuxSampler can be controlled locally as well as remotely.
223                          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
224                          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
225                          ncurses based frontend, so be encouraged and let                          ncurses based frontend, so be encouraged and let
226                          <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
227                          LinuxSampler! This is the protocol specification of the latest                          LinuxSampler!
228                          official release of LinuxSampler (0.3.3):                          </p>
229                          <br>  
230                          </p>        <table class="decorated">
231                          <center>          <thead>
232                          LinuxSampler Control Protocol v1.0            <tr>
233                          (<a href="http://www.linuxsampler.org/api/lscp-1.0.txt">ASCII</a>,              <td class="decorated_header">Protocol Name</td>
234                          <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,              <td class="decorated_header">Document Types</td>
235                          <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>)              <td class="decorated_header">Release Date</td>
236                          </center>              <td class="decorated_header">Description</td>
237                          <p class="default">            </tr>
238                          The following is the very latest draft of the protocol (which          </thead>
239                          usually reflects the latest development state from CVS or may          <tbody>
240                          even not be implemented yet):            <tr>
241                          <br>              <td class="decorated">LSCP&nbsp;draft</td>
242                          </p>              <td class="decorated">
243                          <center>                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.txt">TXT</a>,
244                          LinuxSampler Control Protocol Draft                <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,
245                          (<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>
246                          <a href="http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html">HTML</a>,              </td>
247                          <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>
248                          </center>              <td class="decorated">
249                  Very latest draft of the protocol (which usually reflects the
250                  latest development state from CVS or may even not be implemented
251                  yet).
252                </td>
253              </tr>
254              <tr>
255                <td class="decorated">LSCP&nbsp;1.3</td>
256                <td class="decorated">
257                  <a href="http://www.linuxsampler.org/api/lscp-1.3.txt">TXT</a>,
258                  <a href="http://www.linuxsampler.org/api/lscp-1.3.html">HTML</a>,
259                  <a href="http://www.linuxsampler.org/api/lscp-1.3.xml">XML</a>
260                </td>
261                <td class="decorated">2007-12-06</td>
262                <td class="decorated">
263                  Protocol specification of the latest official release of LinuxSampler (0.5.1).
264                </td>
265              </tr>
266              <tr>
267                <td class="decorated">LSCP&nbsp;1.2</td>
268                <td class="decorated">
269                  <a href="http://www.linuxsampler.org/api/lscp-1.2.txt">TXT</a>,
270                  <a href="http://www.linuxsampler.org/api/lscp-1.2.html">HTML</a>,
271                  <a href="http://www.linuxsampler.org/api/lscp-1.2.xml">XML</a>
272                </td>
273                <td class="decorated">2007-10-15</td>
274                <td class="decorated">
275                  Protocol specification of the previous official release of LinuxSampler (0.5.0).
276                </td>
277              </tr>
278              <tr>
279                <td class="decorated">LSCP&nbsp;1.1</td>
280                <td class="decorated">
281                  <a href="http://www.linuxsampler.org/api/lscp-1.1.txt">TXT</a>,
282                  <a href="http://www.linuxsampler.org/api/lscp-1.1.html">HTML</a>,
283                  <a href="http://www.linuxsampler.org/api/lscp-1.1.xml">XML</a>
284                </td>
285                <td class="decorated">2006-11-25</td>
286                <td class="decorated">
287                  Protocol specification old LinuxSampler release 0.4.0.
288                </td>
289              </tr>
290              <tr>
291                <td class="decorated">LSCP&nbsp;1.0</td>
292                <td class="decorated">
293                  <a href="http://www.linuxsampler.org/api/lscp-1.0.txt">TXT</a>,
294                  <a href="http://www.linuxsampler.org/api/lscp-1.0.html">HTML</a>,
295                  <a href="http://www.linuxsampler.org/api/lscp-1.0.xml">XML</a>
296                </td>
297                <td class="decorated">2005-07-17</td>
298                <td class="decorated">
299                  Protocol specification of ancient LinuxSampler release 0.3.3.
300                </td>
301              </tr>
302            </tbody>
303          </table>
304    
305                          <p class="default">                          <p class="default">
306                          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
307                          <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 317 
317                          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
318                          and send it to the running linuxsampler application with:                          and send it to the running linuxsampler application with:
319                          </p>                          </p>
320                          <table class="default" border="0" cellpadding="1" cellspacing="5">                          <pre class="code">cat yourscript.lscp | netcat localhost 8888</pre>
321                                  <tr>                          <p class="default">
322                                    <td><pre class="code">1</pre>                          Optionally you can also use a graphical frontend like QSampler one time to setup a working
323                                    </td>                          sampler session for your needs and save it. Because you have to know that the files saved
324                                    <td width="100%">                          by our frontends are actually pure LSCP scripts, thus you can i.e. use those files simply with
325                                      <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.
326                                    </td>                          </p>
                                 </tr>  
                         </table>  
327                          <p class="default">                          <p class="default">
328                          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,
329                          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
330                          on that sampler channel:                          on that sampler channel:
331                          </p>                          </p>
332                          <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  
333  SET ECHO 1  SET ECHO 1
334    
335  # load the ALSA audio driver  # load the ALSA audio driver
# Line 248  GET CHANNEL INFO 0 Line 358  GET CHANNEL INFO 0
358    
359  # quit connection  # quit connection
360  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
361                          <p class="default">                          <p class="default">
362                          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
363                          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
364                          something without having to manually connect it e.g. with qjackctl:                          something without having to manually connect it e.g. with qjackctl:
365                          </p>                          </p>
366                          <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  
367  SET ECHO 1  SET ECHO 1
368    
369  # load the JACK audio driver  # load the JACK audio driver
# Line 324  GET CHANNEL INFO 0 Line 395  GET CHANNEL INFO 0
395    
396  # quit connection  # quit connection
397  QUIT</pre>  QUIT</pre>
                                   </td>  
                                 </tr>  
                         </table>  
398                          <p class="default">                          <p class="default">
399                          The next example is a bit more complex.                          The next example is a bit more complex.
400                          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 406  QUIT</pre>
406                          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
407                          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.
408                          </p>                          </p>
409                          <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  
410  SET ECHO 1  SET ECHO 1
411    
412  # load audio and MIDI driver  # load audio and MIDI driver
# Line 442  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J Line 456  SET AUDIO_OUTPUT_CHANNEL_PARAMETER 0 3 J
456  # not necessary, just to see our setup  # not necessary, just to see our setup
457  GET CHANNEL INFO 0  GET CHANNEL INFO 0
458  GET CHANNEL INFO 1</pre>  GET CHANNEL INFO 1</pre>
                                   </td>  
                                 </tr>  
                         </table>  
459                          <p class="default">                          <p class="default">
460                          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>.
461                          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.1822
  ViewVC Help
Powered by ViewVC