summaryrefslogtreecommitdiff
path: root/opcodes/dssiaudio.xml
blob: 9f44b43ec0bfe0de70c029b0efd5720c17e1cb8a (plain)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<refentry id="dssiaudio">
<indexterm id="IndexDssiAudio"><primary>dssiaudio</primary></indexterm>
  <refentryinfo><title>Plugin Hosting:DSSI and LADSPA</title></refentryinfo>
  <refmeta>
    <refentrytitle>dssiaudio</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>dssiaudio</refname>
    <refpurpose>Processes audio using a LADSPA or DSSI plugin.
    </refpurpose>
  </refnamediv>
  <refsect1>
    <title>Syntax</title>
    <synopsis>aout1 [, aout2, aout3, aout4] <command>dssiaudio</command> ihandle, ain1 [,ain2, ain3, ain4] </synopsis>
  </refsect1>
  <refsect1>
    <title>Description</title>
    <para><emphasis>dssiaudio</emphasis> generates audio by processing an input signal through a LADSPA plugin.</para>
  </refsect1>
  <refsect1>
    <title>Initialization</title> 
    <para>
      <emphasis>ihandle</emphasis>  - handle for the plugin returned by <link linkend="dssiinit"><citetitle>dssiinit</citetitle></link>
    </para>
  </refsect1>
  <refsect1>
    <title>Performance</title> 
    <para>
      <emphasis>aout1, aout2, etc</emphasis> - Audio ouput generated by the plugin
    </para>
    <para>
      <emphasis>ain1, ain2, etc</emphasis> - Audio provided to the plugin for processing
    </para>
    <para>
      <emphasis>dssiaudio</emphasis> runs a plugin on the provided audio and produces audio output. Currently upto four inputs and outputs are provided. You should provide signal for all the plugins audio inputs, otherwise unpredictable results may occur. If the plugin doesn't have any input (e.g Noise generator) you must still provide at least one input variable, which will be ignored with a message.
    </para>
    <para>
      Only one <emphasis>dssiaudio</emphasis> should be executed once per plugin, or strange results may occur.
    </para>
  </refsect1>  
  
    <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the dssiaudio opcode. It uses the file <ulink url="examples/dssiaudio.csd"><citetitle>dssiaudio.csd</citetitle></ulink>.
            <example>
        <title>Example of the dssiaudio opcode.</title>
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/dssiaudio.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
  
   
  
  <refsect1>
    <title>Credits</title>
    <para>2005</para>
    <para>By: &nameandres;</para>
    <para>Uses code from Richard Furse's LADSPA sdk.</para>
  </refsect1>
  
</refentry>