~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

« back to all changes in this revision

Viewing changes to opcodes/hrtfer.xml

  • Committer: Bazaar Package Importer
  • Author(s): Felipe Sateler
  • Date: 2011-08-01 22:21:58 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110801222158-90kslkp5ujci2f5d
Tags: 1:5.13~dfsg-1
* New upstream release
 - Add Menno Knevel to the copyright file
 - Refresh patch 2000-stripped-opcodes.diff
 - Update copyright hints file
* Update Vcs-* headers
* Bump Standards-Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
 
2
 
<refentry id="hrtfer">
3
 
<indexterm id="IndexHrtfer"><primary>hrtfer</primary></indexterm>
4
 
  <refentryinfo><title>Signal Modifiers:Panning and Spatialization</title></refentryinfo>
5
 
  <refmeta>
6
 
    <refentrytitle>hrtfer</refentrytitle>
7
 
  </refmeta>
8
 
 
9
 
  <refnamediv>
10
 
    <refname>hrtfer</refname>
11
 
    <refpurpose>
12
 
      Creates 3D audio for two speakers.
13
 
          </refpurpose>
14
 
  </refnamediv>
15
 
 
16
 
  <refsect1>
17
 
    <title>Description</title>
18
 
    <para>
19
 
      Output is binaural (headphone) 3D audio.
20
 
    </para>
21
 
  </refsect1>
22
 
 
23
 
  <refsect1>
24
 
    <title>Syntax</title>
25
 
    <synopsis>aleft, aright <command>hrtfer</command> asig, kaz, kelev, <quote>HRTFcompact</quote></synopsis>
26
 
  </refsect1>
27
 
 
28
 
  <refsect1>
29
 
    <title>Initialization</title>
30
 
    <para>
31
 
      <emphasis>kAz</emphasis> -- azimuth value in degrees. Positive values represent position on the right, negative values are positions on the left.
32
 
    </para>
33
 
 
34
 
    <para>
35
 
      <emphasis>kElev</emphasis> -- elevation value in degrees. Positive values represent position above horizontal, negative values are positions above horizontal.
36
 
    </para>
37
 
 
38
 
    <para>
39
 
      At present, the only file which can be used with <emphasis>hrtfer</emphasis> is <ulink url="examples/HRTFcompact"><citetitle>HRTFcompact</citetitle></ulink>. It must be passed to the opcode as the last argument within quotes as shown above.
40
 
    </para>
41
 
 
42
 
    <para>
43
 
      HRTFcompact may also be obtained via anonymous ftp from: <ulink url="ftp://ftp.cs.bath.ac.uk/pub/dream/utilities/Analysis/HRTFcompact"><citetitle>ftp://ftp.cs.bath.ac.uk/pub/dream/utilities/Analysis/HRTFcompact</citetitle></ulink>
44
 
    </para>
45
 
  </refsect1>
46
 
 
47
 
  <refsect1>
48
 
    <title>Performance</title>
49
 
    <para>
50
 
      These unit generators place a mono input signal in a virtual 3D space around the listener by convolving the input with the appropriate HRTF data specified by the opcode's azimuth and elevation values. <emphasis>hrtfer</emphasis> allows these values to be k-values, allowing for dynamic spatialization. <emphasis>hrtfer</emphasis> can only place the input at the requested position because the HRTF is loaded in at i-time (remember that currently, CSound has a limit of 20 files it can hold in memory, otherwise it causes a segmentation fault). The output will need to be scaled either by using balance or by multiplying the output by some scaling constant.
51
 
    </para>
52
 
 
53
 
    <note>
54
 
      <title>Note</title>
55
 
      <para>
56
 
        The sampling rate of the orchestra must be 44.1kHz. This is because 44.1kHz is the sampling rate at which the HRTFs were measured. In order to be used at a different rate, the HRTFs would need to be re-sampled at the desired rate.
57
 
      </para>
58
 
    </note>
59
 
  </refsect1>
60
 
 
61
 
  <refsect1>
62
 
    <title>Examples</title>
63
 
    <para>
64
 
      Here is an example of the hrtfer opcode. It uses the file <ulink url="examples/hrtfer.csd"><citetitle>hrtfer.csd</citetitle></ulink>,  <ulink url="examples/HRTFcompact"><citetitle>HRTFcompact</citetitle></ulink>, and <ulink url="examples/beats.wav"><citetitle>beats.wav</citetitle></ulink>.
65
 
      <example>
66
 
        <title>Example of the hrtfer opcode.</title>
67
 
        <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>
68
 
          <xi:include href="examples-xml/hrtfer.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
69
 
      </example>
70
 
    </para>
71
 
  </refsect1>
72
 
 
73
 
  <refsect1>
74
 
    <title>See Also</title>
75
 
    <para>
76
 
      <link linkend="hrtfmove"><citetitle>hrtfmove</citetitle></link>,
77
 
      <link linkend="hrtfmove2"><citetitle>hrtfmove2</citetitle></link>,
78
 
      <link linkend="hrtfstat"><citetitle>hrtfstat</citetitle></link>.
79
 
    </para>
80
 
  </refsect1>
81
 
 
82
 
  <refsect1>
83
 
    <title>Credits</title>
84
 
    <para>
85
 
      <simplelist>
86
 
        <member>Authors: Eli Breder and David MacIntyre</member>
87
 
        <member>Montreal</member>
88
 
        <member>1996</member>
89
 
      </simplelist>
90
 
    </para>
91
 
 
92
 
    <para>Fixed the example thanks to a message from &nameistvan;.</para>
93
 
  </refsect1>
94
 
</refentry> 
 
1
 
 
2
<refentry id="hrtfer">
 
3
<indexterm id="IndexHrtfer"><primary>hrtfer</primary></indexterm>
 
4
  <refentryinfo><title>Signal Modifiers:Panning and Spatialization</title></refentryinfo>
 
5
  <refmeta>
 
6
    <refentrytitle>hrtfer</refentrytitle>
 
7
  </refmeta>
 
8
 
 
9
  <refnamediv>
 
10
    <refname>hrtfer</refname>
 
11
    <refpurpose>
 
12
      Creates 3D audio for two speakers.
 
13
    </refpurpose>
 
14
  </refnamediv>
 
15
 
 
16
  <refsect1>
 
17
    <title>Description</title>
 
18
    <para>
 
19
      Output is binaural (headphone) 3D audio.
 
20
    </para>
 
21
  </refsect1>
 
22
 
 
23
  <refsect1>
 
24
    <title>Syntax</title>
 
25
    <synopsis>aleft, aright <command>hrtfer</command> asig, kaz, kelev, <quote>HRTFcompact</quote></synopsis>
 
26
  </refsect1>
 
27
 
 
28
  <refsect1>
 
29
    <title>Initialization</title>
 
30
    <para>
 
31
      <emphasis>kAz</emphasis> -- azimuth value in degrees. Positive values represent position on the right, negative values are positions on the left.
 
32
    </para>
 
33
 
 
34
    <para>
 
35
      <emphasis>kElev</emphasis> -- elevation value in degrees. Positive values represent position above horizontal, negative values are positions under horizontal.
 
36
    </para>
 
37
 
 
38
    <para>
 
39
      At present, the only file which can be used with <emphasis>hrtfer</emphasis> is <ulink url="examples/HRTFcompact"><citetitle>HRTFcompact</citetitle></ulink>. It must be passed to the opcode as the last argument within quotes as shown above.
 
40
    </para>
 
41
 
 
42
    <para>
 
43
      HRTFcompact may also be obtained via anonymous ftp from: <ulink url="ftp://ftp.cs.bath.ac.uk/pub/dream/utilities/Analysis/HRTFcompact"><citetitle>ftp://ftp.cs.bath.ac.uk/pub/dream/utilities/Analysis/HRTFcompact</citetitle></ulink>
 
44
    </para>
 
45
  </refsect1>
 
46
 
 
47
  <refsect1>
 
48
    <title>Performance</title>
 
49
    <para>
 
50
      These unit generators place a mono input signal in a virtual 3D space around the listener by convolving the input with the appropriate HRTF data specified by the opcode's azimuth and elevation values. <emphasis>hrtfer</emphasis> allows these values to be k-values, allowing for dynamic spatialization. <emphasis>hrtfer</emphasis> can only place the input at the requested position because the HRTF is loaded in at i-time (remember that currently, CSound has a limit of 20 files it can hold in memory, otherwise it causes a segmentation fault). The output will need to be scaled either by using <link linkend="balance"><citetitle>balance</citetitle></link> or by multiplying the output by some scaling constant.
 
51
    </para>
 
52
 
 
53
    <note>
 
54
      <title>Note</title>
 
55
      <para>
 
56
        The sampling rate of the orchestra must be 44.1kHz. This is because 44.1kHz is the sampling rate at which the HRTFs were measured. In order to be used at a different rate, the HRTFs would need to be re-sampled at the desired rate.
 
57
      </para>
 
58
    </note>
 
59
  </refsect1>
 
60
 
 
61
  <refsect1>
 
62
    <title>Examples</title>
 
63
    <para>
 
64
      Here is an example of the hrtfer opcode. It uses the file <ulink url="examples/hrtfer.csd"><citetitle>hrtfer.csd</citetitle></ulink>,  <ulink url="examples/HRTFcompact"><citetitle>HRTFcompact</citetitle></ulink>, and <ulink url="examples/beats.wav"><citetitle>beats.wav</citetitle></ulink>.
 
65
      <example>
 
66
        <title>Example of the hrtfer opcode.</title>
 
67
        <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>
 
68
          <xi:include href="examples-xml/hrtfer.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
69
      </example>
 
70
    </para>
 
71
  </refsect1>
 
72
 
 
73
  <refsect1>
 
74
    <title>See Also</title>
 
75
    <para>
 
76
      <link linkend="hrtfmove"><citetitle>hrtfmove</citetitle></link>,
 
77
      <link linkend="hrtfmove2"><citetitle>hrtfmove2</citetitle></link>,
 
78
      <link linkend="hrtfstat"><citetitle>hrtfstat</citetitle></link>.
 
79
    </para>
 
80
  </refsect1>
 
81
 
 
82
  <refsect1>
 
83
    <title>Credits</title>
 
84
    <para>
 
85
      <simplelist>
 
86
        <member>Authors: Eli Breder and David MacIntyre</member>
 
87
        <member>Montreal</member>
 
88
        <member>1996</member>
 
89
      </simplelist>
 
90
    </para>
 
91
 
 
92
    <para>Fixed the example thanks to a message from &nameistvan;.</para>
 
93
  </refsect1>
 
94
</refentry>