summaryrefslogtreecommitdiff
path: root/modules/sound/help/en_US/auwrite.xml
blob: 9997f910f83c85a2a6ea43a620c2913bac283503 (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
105
106
107
108
109
110
111
112
113
114
115
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) ????-2006 - INRIA - Scilab
    *
    * This file must be used under the terms of the CeCILL.
    * This source file is licensed as described in the file COPYING, which
    * you should have received as part of this distribution.  The terms
    * are also available at
    * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
    *
    -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="auwrite">
    <refnamediv>
        <refname>auwrite</refname>
        <refpurpose>writes .au sound file</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>auwrite(y,aufile)
            auwrite(y,Fs,aufile)
            auwrite(y,Fs,bits,aufile)
            auwrite(y,Fs,bits,method,aufile)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>real vector or matrix with entries in [-1,1].</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>aufile</term>
                <listitem>
                    <para>string (The .au extension is appended if no extension is given)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>Fs</term>
                <listitem>
                    <para>integer, frequency sampling in Hz.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>bits</term>
                <listitem>
                    <para>integer, number of bits in the encoding.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>method</term>
                <listitem>
                    <para>
                        string , <literal>'mu'</literal> (default) or <literal>'linear'</literal>, encoding method.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Utility function to save <literal>.au</literal> sound file.
            <literal>auwrite(y,aufile)</literal> writes a sound file specified by the
            string aufile.  The data should be arranged with one channel
            per column.  Amplitude values outside the range [-1,+1] are
            ignored.
            Supports multi-channel data for 8-bit mu-law, and 8, 16, 32, 64 bits linear formats.
        </para>
        <para>
            <literal>auwrite(y,Fs,aufile)</literal> specifies in <literal>Fs</literal> the sample rate of the data
            in Hertz.
        </para>
        <para>
            <literal>auwrite(y,Fs,bits,aufile)</literal> selects the number of bits in
            the encoder. Allowable settings are bits in [8,16,32,64].
            
            <literal>auwrite(y,Fs,bits,method,aufile)</literal> allows selection of the
            encoding method, which can be either 'mu' or 'linear'.
            Note that bits must be 8 for 'mu' choice. The default method is 8-bits mu-law encoding.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
A=matrix(1:6,2,3);
auwrite(A/6,22050,64,'linear',TMPDIR+'/foo.au');
B=auread(TMPDIR+'/foo.au');
max(abs(A- round(B*6)))
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="auread">auread</link>
            </member>
            <member>
                <link linkend="wavread">wavread</link>
            </member>
            <member>
                <link linkend="savewave">savewave</link>
            </member>
            <member>
                <link linkend="analyze">analyze</link>
            </member>
            <member>
                <link linkend="mapsound">mapsound</link>
            </member>
        </simplelist>
    </refsection>
</refentry>