summaryrefslogtreecommitdiff
path: root/opcodes/faustgen.xml
blob: 2bbc978f723275c8556a0a38d5e3c103187fd9c6 (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
65
66
<refentry id="faustgen">
<indexterm id="Indexfaustgen"><primary>faustgen</primary></indexterm>
  <refentryinfo><title>Faust Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>faustgen</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>faustgen</refname>
    <refpurpose>
      Compiles, Instantiates and runs a compiled Faust program.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Faustgen will invoke the just-in-time compiler, instantiate and run a Faust program.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>ihandle,a1[,a2,...] faustgen</command> SCode[,ain1,...] </synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis><quote>Scode</quote></emphasis> --  a string containing a Faust program.
</para>    
    <para>
      <emphasis><quote>ihandle</quote></emphasis> -- a handle to the Faust DSP instance, which can be used to access
its controls with faustctl.
</para>  
  </refsect1>

  <refsect1>
    <title>Performance</title>
   	<para>
      <emphasis><quote>ain1,...</quote></emphasis> -- input signals
    </para>
	<para>
      <emphasis><quote>a1,...</quote></emphasis> -- output signals
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the faustgen opcode, with a simple program that mixes two inputs:
      <example>
   <para>   
<programlisting>
idsp,a1 <emphasis role="op">faustgen</emphasis> "process=+;",ain1,ain2
 </programlisting>
    </para>
      </example>
    </para>
  </refsect1>
  <refsect1>
    <title>Credits</title>
    <para>Author: &namevictor;, 2013 </para>
  </refsect1>
</refentry>