:mod:`!wave` --- Read and write WAV files
Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License
:mod:!wave --- Read and write WAV files
:synopsis: Provide an interface to the WAV sound format.
Source code: Lib/wave.py
--------------
The !wave module provides a convenient interface to the Waveform Audio "WAVE" (or "WAV") file format. Only uncompressed PCM encoded wave files are supported.
Support for `WAVE_FORMAT_EXTENSIBLE headers was added, provided that the extended format is KSDATAFORMAT_SUBTYPE_PCM`.
The !wave module defines the following function and exception:
If *file* is a string, open the file by that name, otherwise treat it as a file-like object. *mode* can be:
`'rb'` Read only mode.
`'wb'` Write only mode.
Note that it does not allow read/write WAV files.
A *mode* of `'rb' returns a Wave_read object, while a *mode* of 'wb' returns a Wave_write object. If *mode* is omitted and a file-like object is passed as *file*, file.mode` is used as the default value for *mode*.
If you pass in a file-like object, the wave object will not close it when its `close()` method is called; it is the caller's responsibility to close the file object.
The .open function may be used in a with statement. When the !with block completes, the Wave_read.close or Wave_write.close method is called.
Added support for unseekable files.
An error raised when something is impossible because it violates the WAV specification or hits an implementation deficiency.
Wave_read Objects
Read a WAV file.
Wave_read objects, as returned by .open, have the following methods:
Close the stream if it was opened by !wave, and make the instance unusable. This is called automatically on object collection.
Returns number of audio channels (`1 for mono, 2` for stereo).
Returns sample width in bytes.
Returns sampling frequency.
Returns number of audio frames.
Returns compression type (`'NONE'` is the only supported type).
Human-readable version of getcomptype. Usually `'not compressed' parallels 'NONE'`.
Returns a ~collections.namedtuple `(nchannels, sampwidth, framerate, nframes, comptype, compname), equivalent to output of the get*()` methods.
Reads and returns at most *n* frames of audio, as a bytes object.
Rewind the file pointer to the beginning of the audio stream.
The following two methods are defined for compatibility with the old !aifc module, and don't do anything interesting.
Returns `None`.
The method only existed for compatibility with the !aifc module which has been removed in Python 3.13.
Raise an error.
The method only existed for compatibility with the !aifc module which has been removed in Python 3.13.
The following two methods define a term "position" which is compatible between them, and is otherwise implementation dependent.
Set the file pointer to the specified position.
Return current file pointer position.
Wave_write Objects
Write a WAV file.
Wave_write objects, as returned by .open.
For seekable output streams, the `wave header will automatically be updated to reflect the number of frames actually written. For unseekable streams, the *nframes* value must be accurate when the first frame data is written. An accurate *nframes* value can be achieved either by calling setnframes or setparams with the number of frames that will be written before close is called and then using writeframesraw to write the frame data, or by calling writeframes with all of the frame data to be written. In the latter case writeframes` will calculate the number of frames in the data and set *nframes* accordingly before writing the frame data.
Added support for unseekable files.
Wave_write objects have the following methods:
Make sure *nframes* is correct, and close the file if it was opened by !wave. This method is called upon object collection. It will raise an exception if the output stream is not seekable and *nframes* does not match the number of frames actually written.
Set the number of channels.
Return the number of channels.
Set the sample width to *n* bytes.
Return the sample width in bytes.
Set the frame rate to *n*.
A non-integral input to this method is rounded to the nearest integer.
Return the frame rate.
Set the number of frames to *n*. This will be changed later if the number of frames actually written is different (this update attempt will raise an error if the output stream is not seekable).
Return the number of audio frames written so far.
Set the compression type and description. At the moment, only compression type `NONE` is supported, meaning no compression.
Return the compression type (`'NONE'`).
Return the human-readable compression type name.
The *tuple* should be `(nchannels, sampwidth, framerate, nframes, comptype, compname), with values valid for the set*()` methods. Sets all parameters.
Return a ~collections.namedtuple `(nchannels, sampwidth, framerate, nframes, comptype, compname)` containing the current output parameters.
Return current position in the file, with the same disclaimer for the Wave_read.tell and Wave_read.setpos methods.
Write audio frames, without correcting *nframes*.
Any bytes-like object is now accepted.
Write audio frames and make sure *nframes* is correct. It will raise an error if the output stream is not seekable and the total number of frames that have been written after *data* has been written does not match the previously set value for *nframes*.
Any bytes-like object is now accepted.
Note that it is invalid to set any parameters after calling writeframes or writeframesraw, and any attempt to do so will raise wave.Error.