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

« back to all changes in this revision

Viewing changes to man/sound/wavread.cat

  • 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
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

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