summaryrefslogtreecommitdiff
path: root/opcodes/pan2.xml
blob: 6fe53fa11564304bbaca7ed7e367dcade531951c (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
67
68
69
70
71
72
73
74
75
76
77
78
<refentry id="pan2">
<indexterm id="IndexPan2"><primary>pan2</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Panning and Spatialization</title></refentryinfo>
  <refmeta>
    <refentrytitle>pan2</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>pan2</refname>
    <refpurpose>
      Distribute an audio signal across two channels.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Distribute an audio signal across two channels with a choice of methods.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>a1, a2 <command>pan2</command> asig, xp [, imode]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>imode</emphasis> (optional) -- mode of the stereo
      positioning algorithm. 0 signifies equal power (harmonic)
      panning, 1 means the square root method, 2 means simple linear
      and 3 means an alternative equal-power pan (based on an UDO). The default value is 0.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>pan2</emphasis> takes an input
      signal <emphasis>asig</emphasis> and distributes it across two
      outputs (essentially stereo speakers) according to the
      control <emphasis>xp</emphasis> which can be k- or a-rate.  A
      zero value for <emphasis>xp</emphasis> indicates hard left, and
      a 1 is hard right.
    </para>

  </refsect1>
 

  <refsect1>
    <title>Example</title>
    <para>
      Here is an example of the pan2 opcodes. It uses the file <ulink url="examples/pan2.csd"><citetitle>pan2.csd</citetitle></ulink>.
      <example>
        <title>Example of the pan2 opcodes.</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/pan2.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>University of Bath, Codemist Ltd.</member>
        <member>Bath, UK</member>
        <member>September 2007</member>
      </simplelist>
    <para>New in version 5.07</para>
    </para>
  </refsect1>
</refentry>