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

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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<refentry id="soundout">
<indexterm id="IndexSoundout"><primary>soundout</primary></indexterm>
  <refentryinfo><title>Signal I/O:Signal Output</title></refentryinfo>
  <refmeta>
    <refentrytitle>soundout</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>soundout</refname>
    <refpurpose>
      Deprecated. Writes audio output to a disk file.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <note>
      <para>The usage of <emphasis>soundout</emphasis> is discouraged. Please use  <link linkend="fout"><citetitle>fout</citetitle></link> instead.</para>
    </note>
    <para>
      Writes audio output to a disk file.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>soundout</command>  asig1, ifilcod [, iformat]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifilcod</emphasis> -- integer or character-string denoting the destination soundfile name. An integer denotes the file soundin.filcod; a character-string (in double quotes, spaces permitted) gives the filename itself, optionally a full pathname. If not a full path, the named file is sought first in the current directory, then in that given by the environment variable <link linkend="CommandEnvironment"><citetitle>SSDIR</citetitle></link> (if defined) then by <link linkend="CommandEnvironment"><citetitle>SFDIR</citetitle></link>. See also <link linkend="GEN01"><citetitle>GEN01</citetitle></link>.
    </para>

    <para>
      <emphasis>iformat</emphasis> (optional, default=0) -- specifies the audio data file format:
      <itemizedlist>
        <listitem>
          <para>1 = 8-bit signed char (high-order 8 bits of a 16-bit integer)</para>
        </listitem>

        <listitem>
          <para>2 = 8-bit A-law bytes</para>
        </listitem>

        <listitem>
          <para>3 = 8-bit U-law bytes</para>
        </listitem>

        <listitem>
          <para>4 = 16-bit short integers</para>
        </listitem>

        <listitem>
          <para>5 = 32-bit long integers</para>
        </listitem>

        <listitem>
          <para>6 = 32-bit floats</para>
        </listitem>
      </itemizedlist>
    </para>

    <para>
      If <emphasis>iformat</emphasis> = 0 it is taken from the soundfile header, and if no header from the Csound <link linkend="FlagsMinusLowerO"><citetitle>-o</citetitle></link> command-line flag. The default value is 0.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>soundout</emphasis> writes audio output to a disk file.
    </para>
    <note>
      <para>Use of <link linkend="fout"><citetitle>fout</citetitle></link> is recommended instead of <emphasis>soundout</emphasis></para>
    </note>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="fout"><citetitle>fout</citetitle></link>,
      <link linkend="out"><citetitle>out</citetitle></link>,
      <link linkend="outh"><citetitle>outh</citetitle></link>,
      <link linkend="outo"><citetitle>outo</citetitle></link>,
      <link linkend="outq"><citetitle>outq</citetitle></link>,
      <link linkend="outq1"><citetitle>outq1</citetitle></link>,
      <link linkend="outq2"><citetitle>outq2</citetitle></link>,
      <link linkend="outq3"><citetitle>outq3</citetitle></link>,
      <link linkend="outq4"><citetitle>outq4</citetitle></link>,
      <link linkend="outs"><citetitle>outs</citetitle></link>,
      <link linkend="outs1"><citetitle>outs1</citetitle></link>,
      <link linkend="outs2"><citetitle>outs2</citetitle></link>
      <link linkend="soundouts"><citetitle>soundouts</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namebarry;, &namematt;/&namemike;</member>
        <member>MIT, Mills College</member>
        <member>1993-1997</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>