File: Audio-File-Utilities.html

package info (click to toggle)
octave 4.0.3-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 94,200 kB
  • ctags: 52,925
  • sloc: cpp: 316,850; ansic: 43,469; fortran: 23,670; sh: 13,805; yacc: 8,204; objc: 7,939; lex: 3,631; java: 2,127; makefile: 1,746; perl: 1,022; awk: 988
file content (138 lines) | stat: -rw-r--r-- 6,322 bytes parent folder | download | duplicates (2)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Audio File Utilities</title>

<meta name="description" content="GNU Octave: Audio File Utilities">
<meta name="keywords" content="GNU Octave: Audio File Utilities">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Audio-Processing.html#Audio-Processing" rel="up" title="Audio Processing">
<link href="Audio-Device-Information.html#Audio-Device-Information" rel="next" title="Audio Device Information">
<link href="Audio-Processing.html#Audio-Processing" rel="prev" title="Audio Processing">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Audio-File-Utilities"></a>
<div class="header">
<p>
Next: <a href="Audio-Device-Information.html#Audio-Device-Information" accesskey="n" rel="next">Audio Device Information</a>, Up: <a href="Audio-Processing.html#Audio-Processing" accesskey="u" rel="up">Audio Processing</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Audio-File-Utilities-1"></a>
<h3 class="section">33.1 Audio File Utilities</h3>

<p>The following functions allow you to read, write and retrieve
information about audio files.  Various formats are supported including
wav, flac and ogg vorbis.
</p>
<a name="XREFaudioinfo"></a><dl>
<dt><a name="index-audioinfo"></a>Loadable Function: <em><var>info</var> =</em> <strong>audioinfo</strong> <em>(<var>filename</var>)</em></dt>
<dd><p>Return information about an audio file specified by <var>filename</var>.
</p></dd></dl>


<a name="XREFaudioread"></a><dl>
<dt><a name="index-audioread"></a>Loadable Function: <em>[<var>y</var>, <var>fs</var>] =</em> <strong>audioread</strong> <em>(<var>filename</var>)</em></dt>
<dt><a name="index-audioread-1"></a>Loadable Function: <em>[<var>y</var>, <var>fs</var>] =</em> <strong>audioread</strong> <em>(<var>filename</var>, <var>samples</var>)</em></dt>
<dt><a name="index-audioread-2"></a>Loadable Function: <em>[<var>y</var>, <var>fs</var>] =</em> <strong>audioread</strong> <em>(<var>filename</var>, <var>datatype</var>)</em></dt>
<dt><a name="index-audioread-3"></a>Loadable Function: <em>[<var>y</var>, <var>fs</var>] =</em> <strong>audioread</strong> <em>(<var>filename</var>, <var>samples</var>, <var>datatype</var>)</em></dt>
<dd><p>Read the audio file <var>filename</var> and return the audio data <var>y</var> and
sampling rate <var>fs</var>.
</p>
<p>The audio data is stored as matrix with rows corresponding to audio frames
and columns corresponding to channels.
</p>
<p>The optional two-element vector argument <var>samples</var> specifies starting
and ending frames.
</p>
<p>The optional argument <var>datatype</var> specifies the datatype to return.
If it is <code>&quot;native&quot;</code>, then the type of data depends on how the data
is stored in the audio file.
</p></dd></dl>


<a name="XREFaudiowrite"></a><dl>
<dt><a name="index-audiowrite"></a>Loadable Function: <em></em> <strong>audiowrite</strong> <em>(<var>filename</var>, <var>y</var>, <var>fs</var>)</em></dt>
<dt><a name="index-audiowrite-1"></a>Loadable Function: <em></em> <strong>audiowrite</strong> <em>(<var>filename</var>, <var>y</var>, <var>fs</var>, <var>name</var>, <var>value</var>, &hellip;)</em></dt>
<dd>
<p>Write audio data from the matrix <var>y</var> to <var>filename</var> at sampling rate
<var>fs</var> with the file format determined by the file extension.
</p>
<p>Additional name/value argument pairs may be used to specify the
following options:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>BitsPerSample</samp>&rsquo;</dt>
<dd><p>Number of bits per sample, valid values are 8, 16, 24 and 32.  Default is 16.
</p>
</dd>
<dt>&lsquo;<samp>BitRate</samp>&rsquo;</dt>
<dd><p>Valid argument name, but ignored.  Left for compatibility with <small>MATLAB</small>.
</p>
</dd>
<dt>&lsquo;<samp>Quality</samp>&rsquo;</dt>
<dd><p>Quality setting for the Ogg Vorbis compressor.  Values can range between 0
and 100 with 100 being the highest quality setting.  Default is 75.
</p>
</dd>
<dt>&lsquo;<samp>Title</samp>&rsquo;</dt>
<dd><p>Title for the audio file.
</p>
</dd>
<dt>&lsquo;<samp>Artist</samp>&rsquo;</dt>
<dd><p>Artist name.
</p>
</dd>
<dt>&lsquo;<samp>Comment</samp>&rsquo;</dt>
<dd><p>Comment.
</p></dd>
</dl>
</dd></dl>


<hr>
<div class="header">
<p>
Next: <a href="Audio-Device-Information.html#Audio-Device-Information" accesskey="n" rel="next">Audio Device Information</a>, Up: <a href="Audio-Processing.html#Audio-Processing" accesskey="u" rel="up">Audio Processing</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>