← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/sound/auread.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/sound/auread.man
1
 
.TH auread 1 "April 1993" "Scilab Group" "Scilab Function"
2
 
.so ../sci.an
3
 
.SH NAME
4
 
auread - load .au sound file
5
 
.SH CALLING SEQUENCE
6
 
.nf
7
 
y=auread(aufile)
8
 
y=auread(aufile,ext)
9
 
[y,Fs,bits]=auread(aufile)
10
 
[y,Fs,bits]=auread(aufile,ext)
11
 
.fi
12
 
.SH PARAMETERS
13
 
.TP
14
 
aufile
15
 
: string (The .au extension is appended if no extension is given)
16
 
.TP
17
 
Fs
18
 
.TP
19
 
: integer, frequency sampling in Hz.
20
 
.TP
21
 
ext
22
 
: string (\fV'size'\fR or \fV'snd'\fR) or integer (to read n samples) or 1 x 2 integer vector [n1,n2] (to read from n1 to n2).
23
 
.SH DESCRIPTION
24
 
Utility function to read \fV.au\fR sound file.
25
 
\fVauread(aufile)\fR loads a sound file specified by the string aufile,
26
 
returning the sampled data in y. Amplitude values are in the range
27
 
[-1,+1].
28
 
.LP
29
 
Supports multi-channel data in the following formats:
30
 
8-bit mu-law, 8-, 16-, and 32-bit linear, and floating point.
31
 
.LP
32
 
\fV[y,Fs,bits]=auread(aufile)\fR returns the sample rate (Fs) in Hertz
33
 
and the number of bits per sample used to encode the data in the file.
34
 
.LP
35
 
\fVauread(aufile,n)\fR returns the first n samples from each channel.
36
 
.LP
37
 
\fVauread(aufile,[n1,n2])\fR returns samples n1 to n2.
38
 
.LP
39
 
\fVauread(aufile,'size')\fR returns the size of the audio data contained
40
 
in the file in place of the actual audio data, returning the
41
 
vector as [samples channels].
42
 
.LP
43
 
\fVauread(aufile,'snd')\fR returns information about the sample and data
44
 
as a tlist.
45
 
.SH SEE ALSO
46
 
savewave,  analyze, mapsound