summaryrefslogtreecommitdiff
path: root/opcodes/fouti.xml
blob: eac44c1745ce514f71927dcf426d1cebfa976837 (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
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
<refentry id="fouti">
<indexterm id="IndexFouti"><primary>fouti</primary></indexterm>
  <refentryinfo><title>Signal I/O:File I/O</title></refentryinfo>
  <refmeta>
    <refentrytitle>fouti</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>fouti</refname>
    <refpurpose>
      Outputs i-rate signals of an arbitrary number of channels to a specified file.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>fouti</emphasis> output <emphasis>N</emphasis> i-rate signals to a specified file of <emphasis>N</emphasis> channels.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>fouti</command> ihandle, iformat, iflag, iout1 [, iout2, iout3,....,ioutN]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ihandle</emphasis> -- a number which specifies this file.
    </para>

    <para>
      <emphasis>iformat</emphasis> -- a flag to choose output file format:
      <itemizedlist>
        <listitem>
          <para>0 - floating point in text format</para>
        </listitem>

        <listitem>
          <para>1 - 32-bit floating point in binary format</para>
        </listitem>
      </itemizedlist>
    </para>

    <para>
      <emphasis>iflag</emphasis> -- choose the mode of writing to the ASCII file (valid only in ASCII mode; in binary mode <emphasis>iflag</emphasis> has no meaning, but it must be present anyway). <emphasis>iflag</emphasis> can be a value chosen among the following:
      <itemizedlist>
        <listitem>
          <para>0 - line of text without instrument prefix</para>
        </listitem>

        <listitem>
          <para>1 - line of text with instrument prefix (see below)</para>
        </listitem>

        <listitem>
          <para>2 - reset the time of instrument prefixes to zero (to be used only in some particular cases. See below)</para>
        </listitem>
      </itemizedlist>
    </para>

    <para>
      <emphasis>iout,..., ioutN</emphasis> -- values to be written to the file
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>fouti</emphasis> and <link linkend="foutir"><citetitle>foutir</citetitle></link> write i-rate values to a file. The main use of these opcodes is to generate a score file during a realtime session. For this purpose, the user should set <emphasis>iformat</emphasis> to 0 (text file output) and <emphasis>iflag</emphasis> to 1, which enable the output of a prefix consisting of the strings <emphasis>inum</emphasis>, <emphasis>actiontime</emphasis>, and <emphasis>duration</emphasis>, before the values of <emphasis>iout1...ioutN</emphasis> arguments. The arguments in the prefix refer to instrument number, action time and duration of current note.
    </para>

    <para>
      Notice that <link linkend="fout"><citetitle>fout</citetitle></link> and <link linkend="foutk"><citetitle>foutk</citetitle></link> can use either a string containing a file pathname, or a handle-number generated by <link linkend="fiopen"><citetitle>fiopen</citetitle></link>. Whereas, with <emphasis>fouti</emphasis> and <link linkend="foutir"><citetitle>foutir</citetitle></link>, the target file can be only specified by means of a handle-number.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="fiopen"><citetitle>fiopen</citetitle></link>,
      <link linkend="fout"><citetitle>fout</citetitle></link>,
      <link linkend="foutir"><citetitle>foutir</citetitle></link>,
      <link linkend="foutk"><citetitle>foutk</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namegabriel;</member>
        <member>Italy</member>
        <member>1999</member>
      </simplelist>
    </para>

    <para>New in Csound version 3.56</para>
  </refsect1>
</refentry>