summaryrefslogtreecommitdiff
path: root/opcodes/filelen.xml
blob: 897d980dbdec5054e69f0e89d8fca7893e2c7124 (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
<refentry id="filelen">
<indexterm id="IndexFilelen"><primary>filelen</primary></indexterm>
  <refentryinfo><title>Signal I/O:Soundfile Queries</title></refentryinfo>
  <refmeta>
    <refentrytitle>filelen</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>filelen</refname>
    <refpurpose>
      Returns the length of a sound file.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Returns the length of a sound file.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ir <command>filelen</command> ifilcod, [iallowraw]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifilcod</emphasis> -- sound file to be queried
    </para>
    <para>
      <emphasis>iallowraw</emphasis> -- Allow raw sound files (default=1)
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>filelen</emphasis> returns the length of the sound file <emphasis>ifilcod</emphasis> in seconds. <emphasis>filelen</emphasis> can return the length of convolve and PVOC files if the "allow raw sound file" flag is not zero (it is non-zero by default).
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the filelen opcode. It uses the file <ulink url="examples/filelen.csd"><citetitle>filelen.csd</citetitle></ulink>, and <ulink url="examples/mary.wav"><citetitle>mary.wav</citetitle></ulink>.

      <example>
        <title>Example of the filelen opcode.</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/filelen.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>

      The audio file <quote>mary.wav</quote> is 3.5 seconds long. So <emphasis>filelen</emphasis>'s output should include a line like this:
      <screen>
instr 1:  ilen = 3.501
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="filenchnls"><citetitle>filenchnls</citetitle></link>,
      <link linkend="filepeak"><citetitle>filepeak</citetitle></link>,
      <link linkend="filesr"><citetitle>filesr</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namematt;</member>
        <member>July 1999</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>

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