/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Diff of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2790 by schoenebeck, Wed Jul 15 20:57:03 2015 UTC revision 3502 by schoenebeck, Mon Mar 11 15:42:54 2019 UTC
# Line 1  Line 1 
1  <?xml version="1.0" encoding="UTF-8"?>  <?xml version="1.0" encoding="UTF-8"?>
2    
3    <!-- NOTE: Use xml2rfc -n switch to avoid irrelevant DTD errors for now. -->
4    
5  <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [  <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
6      <!ENTITY rfc2119 PUBLIC ''      <!ENTITY rfc2119 PUBLIC ''
7        'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>        'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
# Line 16  Line 18 
18       to an annoying "missing Normative/Informative References" error message -->       to an annoying "missing Normative/Informative References" error message -->
19  <?rfc strict="no" ?>  <?rfc strict="no" ?>
20    
21  <rfc category="std" ipr="full3978" docName="LSCP 1.7">  <rfc category="info" ipr="noDerivativesTrust200902" docName="LSCP 1.7">
22      <front>      <front>
23          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
24          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
25  Schoenebeck'>  Schoenebeck' role="editor">
26              <organization>              <organization>
27                  LinuxSampler.org                  LinuxSampler.org
28              </organization>              </organization>
# Line 36  Schoenebeck'> Line 38  Schoenebeck'>
38                  <email>cuse@users.sf.net</email>                  <email>cuse@users.sf.net</email>
39              </address>              </address>
40          </author>          </author>
41          <date month="July" year="2015"/>          <date month="March" year="2019"/>
42          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
43          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
44          <abstract>          <abstract>
# Line 3551  Schoenebeck'> Line 3553  Schoenebeck'>
3553                      encapsulated into apostrophes and supports escape sequences as described in chapter                      encapsulated into apostrophes and supports escape sequences as described in chapter
3554                      "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>                      "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3555    
3556                      <t>By default, that is as initial routing, the effect send's audio channels                      <t>Note: there are two possible approaches to apply audio effects with FX sends:
3557                      are automatically routed to the last audio channels of the sampler channel's                         you can either use a) internal effects or b) external effects.
3558                      audio output device, that way you can i.e. first increase the amount of audio                         By default, that is as initial routing, effect sends are automatically routed
3559                      channels on the audio output device for having dedicated effect send output                         directly to the sampler channel's audio output device and the effect send's
3560                      channels and when "CREATE FX_SEND" is called, those channels will automatically                         audio channels are by default automatically routed to the last audio channels
3561                      be picked. You can alter the destination channels however with                         of that audio output device (for the purpose of applying effects externally that is,
3562                      <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.                         e.g. by using another application), that way you can i.e. first increase the
3563                           amount of audio channels on the audio output device for having dedicated effect
3564                           send output channels and when "CREATE FX_SEND" is called, those channels will
3565                           automatically be picked. You can alter the destination channels however with
3566                           <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3567                           If your intention is rather to use internal effects instead of external effects,
3568                           then you first need to <xref target="effects">load those internal effects</xref>
3569                           and then assign the FX sends to the desired internal effect by sending
3570                           <xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref>.
3571                      </t>                      </t>
3572    
3573                      <t>Note: Create effect sends on a sampler channel only when needed, because having effect                      <t>Note: Create effect sends on a sampler channel only when needed, because having effect
# Line 3875  Schoenebeck'> Line 3885  Schoenebeck'>
3885                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3886                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3887                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3888                      the audio channel of the selected audio output device where &lt;audio-src&gt;                      either a) the audio output channel of the sampler channel's audio output
3889                      should be routed to. If an internal send effect is assigned                      device (i.e. if external effect shall be applied) or b) of the audio
3890                      to the effect send, then this setting defines the audio                      input channel of an internal effect assigned to the FX send where
3891                      channel routing to that effect instance respectively.</t>                      &lt;audio-src&gt; should be routed to.</t>
3892    
3893                      <t>Note that effect sends can only route audio to the same audio output                      <t>Note that effect sends can only route audio to the same audio output
3894                      device as assigned to the effect send's sampler channel. Also note that an                      device as assigned to the effect send's sampler channel. Also note that an
# Line 3922  Schoenebeck'> Line 3932  Schoenebeck'>
3932                  </section>                  </section>
3933    
3934                  <section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT" lscp_cmd="true">                  <section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT" lscp_cmd="true">
3935                      <t>The front-end can (re-)assign a destination effect to an                      <t>The front-end can (re-)assign an internal destination effect to an
3936                      effect send by sending the following command:</t>                      effect send by sending the following command:</t>
3937                      <t>                      <t>
3938                          <list>                          <list>
# Line 3944  Schoenebeck'> Line 3954  Schoenebeck'>
3954                      chain position in the effect chain which hosts the actual                      chain position in the effect chain which hosts the actual
3955                      destination effect.</t>                      destination effect.</t>
3956    
3957                        <t>Note: This command MUST NOT be used if you want to apply
3958                           audio effects externally! By default FX sends are routed directly
3959                           to the audio output device for that purpose.
3960                           You can also revert this command later on by sending
3961                           <xref target="REMOVE FX_SEND EFFECT">"REMOVE FX_SEND EFFECT"</xref>,
3962                           which will cause the FX send to be routed directly to the sampler channel's
3963                           audio output device instead (i.e. for using external effects instead of
3964                           internal effects).
3965                        </t>
3966    
3967                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3968                      <t>                      <t>
3969                          <list>                          <list>
# Line 4440  Schoenebeck'> Line 4460  Schoenebeck'>
4460                      </t>                      </t>
4461                  </section>                  </section>
4462    
4463                  <section title="General sampler informations" anchor="GET SERVER INFO" lscp_cmd="true">                  <section title="General sampler information" anchor="GET SERVER INFO" lscp_cmd="true">
4464                      <t>The client can ask for general informations about the LinuxSampler                      <t>The client can ask for general information about the LinuxSampler
4465                         instance by sending the following command:</t>                         instance by sending the following command:</t>
4466                      <t>                      <t>
4467                          <list>                          <list>
# Line 5222  Schoenebeck'> Line 5242  Schoenebeck'>
5242                              just reflects the key of the respective map entry,                              just reflects the key of the respective map entry,
5243                              thus subsequent                              thus subsequent
5244                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
5245                              command(s) are necessary to retrieve detailed informations                              command(s) are necessary to retrieve detailed information
5246                              about each entry.</t>                              about each entry.</t>
5247                          </list>                          </list>
5248                      </t>                      </t>
# Line 6766  Schoenebeck'> Line 6786  Schoenebeck'>
6786              </section>              </section>
6787    
6788              <section title="Managing Files" anchor="file_management">              <section title="Managing Files" anchor="file_management">
6789                  <t>You can query detailed informations about files located                  <t>You can query detailed information about files located
6790                  at the same system where the sampler instance is running on.                  at the same system where the sampler instance is running on.
6791                  Using this command set allows to retrieve file informations                  Using this command set allows to retrieve file information
6792                  even remotely from another machine.</t>                  even remotely from another machine.</t>
6793    
6794                  <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS" lscp_cmd="true">                  <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS" lscp_cmd="true">
# Line 6858  Schoenebeck'> Line 6878  Schoenebeck'>
6878                      </t>                      </t>
6879                  </section>                  </section>
6880    
6881                  <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO" lscp_cmd="true">                  <section title="Retrieving information about one instrument in a file" anchor="GET FILE INSTRUMENT INFO" lscp_cmd="true">
6882                      <t>The front-end can retrieve detailed informations                      <t>The front-end can retrieve detailed information
6883                      about a specific instrument within a given instrument                      about a specific instrument within a given instrument
6884                      file by sending the following command:</t>                      file by sending the following command:</t>
6885                      <t>                      <t>
# Line 6879  Schoenebeck'> Line 6899  Schoenebeck'>
6899    
6900                      <t>The sampler will try to ask all sampler engines,                      <t>The sampler will try to ask all sampler engines,
6901                      whether they support the given file and ask the first                      whether they support the given file and ask the first
6902                      engine with a positive answer for informations about the                      engine with a positive answer for information about the
6903                      specific instrument in the given file.</t>                      specific instrument in the given file.</t>
6904    
6905                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 6959  Schoenebeck'> Line 6979  Schoenebeck'>
6979                  </section>                  </section>
6980              </section>              </section>
6981              <section title="Managing Effects" anchor="effects">              <section title="Managing Effects" anchor="effects">
6982                  <t>Audio effects (e.g. reverb, delay, compression) can be                  <t>There are two possible approaches to apply audio effects
6983                  applied to the audio signals generated by the sampler. The                  (e.g. reverb, delay, compression).
6984                  sampler usually provides a set of internal audio effects for                  You can either a) load and apply internal effects or you can b) route
6985                  this task. The exact set of effects depends on the availability                  effect sends directly to dedicated output channels of your
6986                    audio device and apply effects externally (e.g. by routing
6987                    those dedicated output channels to another application).</t>
6988                    <t>This chapter describes how to load and manage internal effects.
6989                    If your intention is rather to apply effects externally, then
6990                    you can omit this chapter. For applying effects externally, you
6991                    just need to <xref target="CREATE FX_SEND">create FX sends</xref>
6992                    on the respective sampler channel(s)
6993                    and <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">adjust their destination audio channels</xref>
6994                    appropriately, because by default FX sends are automatically routed
6995                    directly to the audio output device.</t>
6996                    <t>The sampler usually provides a set of internal audio effects.
6997                    The exact set of effects depends on the availability
6998                  of third party effect plugins installed on the system where the                  of third party effect plugins installed on the system where the
6999                  sampler runs on.</t>                  sampler runs on (e.g. LADSPA plugins).</t>
7000                  <t>At the moment only "send effects" are supported. Support for                  <t>At the moment only "send effects" are supported. Support for
7001                  "insert effects" and "master effects" is planned to be added at                  "insert effects" and "master effects" is planned to be added at
7002                  a later point.</t>                  a later point.</t>
7003                  <t>The following commands allow to retrieve the set of internal                  <t>The following commands allow to retrieve the set of internal
7004                  effects available to the sampler, detailed informations about                  effects available to the sampler, detailed information about
7005                  those effects and to create and destroy instances of such                  those effects and to create and destroy instances of such
7006                  effects. After an instance of an effect is created, the effect                  effects. After an instance of an effect is created, the effect
7007                  instance can be inserted into the audio signal path of the                  instance can be inserted into the audio signal path of the
# Line 7049  Schoenebeck'> Line 7081  Schoenebeck'>
7081                  </section>                  </section>
7082    
7083                  <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO" lscp_cmd="true">                  <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO" lscp_cmd="true">
7084                      <t>The front-end can ask for general informations about an                      <t>The front-end can ask for general information about an
7085                      effect by sending the following command:</t>                      effect by sending the following command:</t>
7086                      <t>                      <t>
7087                          <list>                          <list>
# Line 7359  Schoenebeck'> Line 7391  Schoenebeck'>
7391                  </section>                  </section>
7392    
7393                  <section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO" lscp_cmd="true">                  <section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO" lscp_cmd="true">
7394                      <t>The front-end can ask for the current informations about                      <t>The front-end can ask for the current information about
7395                      a particular effect instance by sending the following command:</t>                      a particular effect instance by sending the following command:</t>
7396                      <t>                      <t>
7397                          <list>                          <list>
# Line 7455  Schoenebeck'> Line 7487  Schoenebeck'>
7487                      (e.g. depth of a reverb effect, duration of a delay effect,                      (e.g. depth of a reverb effect, duration of a delay effect,
7488                      dry / wet signal ratio). Those controllable effect parameters                      dry / wet signal ratio). Those controllable effect parameters
7489                      are called "input controls". The front-end can ask for the                      are called "input controls". The front-end can ask for the
7490                      current informations of an effect instance's input control                      current information of an effect instance's input control
7491                      by sending the following command:</t>                      by sending the following command:</t>
7492                      <t>                      <t>
7493                          <list>                          <list>
# Line 7760  Schoenebeck'> Line 7792  Schoenebeck'>
7792                  </section>                  </section>
7793    
7794                  <section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO" lscp_cmd="true">                  <section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO" lscp_cmd="true">
7795                      <t>The front-end can ask for informations of a send effect                      <t>The front-end can ask for information of a send effect
7796                      chain by sending the following command:</t>                      chain by sending the following command:</t>
7797                      <t>                      <t>
7798                          <list>                          <list>
Legend:
Removed from v.2790  
changed lines
  Added in v.3502
  ViewVC Help
Powered by ViewVC