wave
index
/usr/lib/python1.6/wave.py

Stuff to parse WAVE files.
 
Usage.
 
Reading WAVE files:
      f = wave.open(file, 'r')
where file is either the name of a file or an open file pointer.
The open file pointer must have methods read(), seek(), and close().
When the setpos() and rewind() methods are not used, the seek()
method is not  necessary.
 
This returns an instance of a class with the following public methods:
      getnchannels()  -- returns number of audio channels (1 for
                         mono, 2 for stereo)
      getsampwidth()  -- returns sample width in bytes
      getframerate()  -- returns sampling frequency
      getnframes()    -- returns number of audio frames
      getcomptype()   -- returns compression type ('NONE' for linear samples)
      getcompname()   -- returns human-readable version of
                         compression type ('not compressed' linear samples)
      getparams()     -- returns a tuple consisting of all of the
                         above in the above order
      getmarkers()    -- returns None (for compatibility with the
                         aifc module)
      getmark(id)     -- raises an error since the mark does not
                         exist (for compatibility with the aifc module)
      readframes(n)   -- returns at most n frames of audio
      rewind()        -- rewind to the beginning of the audio stream
      setpos(pos)     -- seek to the specified position
      tell()          -- return the current position
      close()         -- close the instance (make it unusable)
The position returned by tell() and the position given to setpos()
are compatible and have nothing to do with the actual postion in the
file.
The close() method is called automatically when the class instance
is destroyed.
 
Writing WAVE files:
      f = wave.open(file, 'w')
where file is either the name of a file or an open file pointer.
The open file pointer must have methods write(), tell(), seek(), and
close().
 
This returns an instance of a class with the following public methods:
      setnchannels(n) -- set the number of channels
      setsampwidth(n) -- set the sample width
      setframerate(n) -- set the frame rate
      setnframes(n)   -- set the number of frames
      setcomptype(type, name)
                      -- set the compression type and the
                         human-readable compression type
      setparams(tuple)
                      -- set all parameters at once
      tell()          -- return current position in output file
      writeframesraw(data)
                      -- write audio frames without pathing up the
                         file header
      writeframes(data)
                      -- write audio frames and patch up the file header
      close()         -- patch up the file header and close the
                         output file
You should set the parameters before the first writeframesraw or
writeframes.  The total number of frames does not need to be set,
but when it is set to the correct value, the header does not have to
be patched up.
It is best to first set all parameters, perhaps possibly the
compression type, and then write audio frames using writeframesraw.
When all frames have been written, either call writeframes('') or
close() to patch up the sizes in the header.
The close() method is called automatically when the class instance
is destroyed.

 
Modules
            
__builtin__
struct

 
Classes
            
Wave_read
Wave_write

 
class Wave_read
      Variables used in this class:
 
These variables are available to the user though appropriate
methods of this class:
_file -- the open file with methods read(), close(), and seek()
          set through the __init__() method
_nchannels -- the number of audio channels
          available through the getnchannels() method
_nframes -- the number of audio frames
          available through the getnframes() method
_sampwidth -- the number of bytes per audio sample
          available through the getsampwidth() method
_framerate -- the sampling frequency
          available through the getframerate() method
_comptype -- the AIFF-C compression type ('NONE' if AIFF)
          available through the getcomptype() method
_compname -- the human-readable AIFF-C compression type
          available through the getcomptype() method
_soundpos -- the position in the audio stream
          available through the tell() method, set through the
          setpos() method
 
These variables are used internally only:
_fmt_chunk_read -- 1 iff the FMT chunk has been read
_data_seek_needed -- 1 iff positioned correctly in audio
          file for readframes()
_data_chunk -- instantiation of a chunk class for the DATA chunk
_framesize -- size of one frame in the file
 
  
__init__(self, f)
_read_fmt_chunk(self, chunk)
close(self)
getcompname(self)
getcomptype(self)
getfp(self)
# User visible methods.
getframerate(self)
getmark(self, id)
getmarkers(self)
getnchannels(self)
getnframes(self)
getparams(self)
getsampwidth(self)
initfp(self, file)
readframes(self, nframes)
rewind(self)
setpos(self, pos)
tell(self)

 
class Wave_write
      Variables used in this class:
 
These variables are user settable through appropriate methods
of this class:
_file -- the open file with methods write(), close(), tell(), seek()
          set through the __init__() method
_comptype -- the AIFF-C compression type ('NONE' in AIFF)
          set through the setcomptype() or setparams() method
_compname -- the human-readable AIFF-C compression type
          set through the setcomptype() or setparams() method
_nchannels -- the number of audio channels
          set through the setnchannels() or setparams() method
_sampwidth -- the number of bytes per audio sample
          set through the setsampwidth() or setparams() method
_framerate -- the sampling frequency
          set through the setframerate() or setparams() method
_nframes -- the number of audio frames written to the header
          set through the setnframes() or setparams() method
 
These variables are used internally only:
_datalength -- the size of the audio samples written to the header
_nframeswritten -- the number of frames actually written
_datawritten -- the size of the audio samples actually written
 
  
__del__(self)
__init__(self, f)
_ensure_header_written(self, datasize)
_patchheader(self)
_write_header(self, initlength)
close(self)
getcompname(self)
getcomptype(self)
getframerate(self)
getmark(self, id)
getmarkers(self)
getnchannels(self)
getnframes(self)
getparams(self)
getsampwidth(self)
initfp(self, file)
setcomptype(self, comptype, compname)
setframerate(self, framerate)
setmark(self, id, pos, name)
setnchannels(self, nchannels)
# User visible methods.
setnframes(self, nframes)
setparams(self, (nchannels, sampwidth, framerate, nframes, comptype, compname))
setsampwidth(self, sampwidth)
tell(self)
writeframes(self, data)
writeframesraw(self, data)

 
Functions
            
open(f, mode=None)
openfp = open(f, mode=None)

 
Data
             Error = 'wave.Error'
WAVE_FORMAT_PCM = 1
__file__ = '/usr/lib/python1.6/wave.pyc'
__name__ = 'wave'
_array_fmts = (None, 'b', 'h', None, 'l')
big_endian = 0