blob: 6fe4b0a469f01c56407de27ff993285fbfc87fb7 (
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
|
<?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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="loadwave" xml:lang="en">
<refnamediv>
<refname>loadwave</refname>
<refpurpose>load a sound wav file into scilab</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>x=loadwave(filename);
[x,y]=loadwave(filename);
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>filename</term>
<listitem>
<para>a string. The path of the wav file to be loaded</para>
</listitem>
</varlistentry>
<varlistentry>
<term>x</term>
<listitem>
<para>a matrix one line for each channel</para>
</listitem>
</varlistentry>
<varlistentry>
<term>y</term>
<listitem>
<para>vector as [data format, number of channels, samples per second
per channel, estimate of bytes per second needed, byte alignment of
a basic sample block, bits per sample, length of sound data in
bytes, bytes per sample (per channel)].
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
Reads a <literal>.wav</literal> sound file into Scilab as a matrix.
If y is given, it is filled with information about the samples (See the
message sent by <literal>loadwave</literal>).
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// At first we create 0.5 seconds of sound parameters.
t=soundsec(0.5);
// Then we generate the sound: a two channels sound.
s=[sin(2*%pi*440*t);sin(2*%pi*350*t)];
savewave(TMPDIR+'/foo.wav',s);
s1=loadwave(TMPDIR+'/foo.wav');
max(abs(s1-s))
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="savewave">savewave</link>
</member>
<member>
<link linkend="analyze">analyze</link>
</member>
<member>
<link linkend="mapsound">mapsound</link>
</member>
</simplelist>
</refsection>
</refentry>
|
