Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1 | """Stuff to parse WAVE files. |
| 2 | |
| 3 | Usage. |
| 4 | |
| 5 | Reading WAVE files: |
| 6 | f = wave.open(file, 'r') |
| 7 | where file is either the name of a file or an open file pointer. |
| 8 | The open file pointer must have methods read(), seek(), and close(). |
| 9 | When the setpos() and rewind() methods are not used, the seek() |
| 10 | method is not necessary. |
| 11 | |
| 12 | This returns an instance of a class with the following public methods: |
| 13 | getnchannels() -- returns number of audio channels (1 for |
| 14 | mono, 2 for stereo) |
| 15 | getsampwidth() -- returns sample width in bytes |
| 16 | getframerate() -- returns sampling frequency |
| 17 | getnframes() -- returns number of audio frames |
| 18 | getcomptype() -- returns compression type ('NONE' for linear samples) |
| 19 | getcompname() -- returns human-readable version of |
| 20 | compression type ('not compressed' linear samples) |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 21 | getparams() -- returns a namedtuple consisting of all of the |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 22 | above in the above order |
| 23 | getmarkers() -- returns None (for compatibility with the |
| 24 | aifc module) |
| 25 | getmark(id) -- raises an error since the mark does not |
| 26 | exist (for compatibility with the aifc module) |
| 27 | readframes(n) -- returns at most n frames of audio |
| 28 | rewind() -- rewind to the beginning of the audio stream |
| 29 | setpos(pos) -- seek to the specified position |
| 30 | tell() -- return the current position |
| 31 | close() -- close the instance (make it unusable) |
| 32 | The position returned by tell() and the position given to setpos() |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 33 | are compatible and have nothing to do with the actual position in the |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 34 | file. |
| 35 | The close() method is called automatically when the class instance |
| 36 | is destroyed. |
| 37 | |
| 38 | Writing WAVE files: |
| 39 | f = wave.open(file, 'w') |
| 40 | where file is either the name of a file or an open file pointer. |
| 41 | The open file pointer must have methods write(), tell(), seek(), and |
| 42 | close(). |
| 43 | |
| 44 | This returns an instance of a class with the following public methods: |
| 45 | setnchannels(n) -- set the number of channels |
| 46 | setsampwidth(n) -- set the sample width |
| 47 | setframerate(n) -- set the frame rate |
| 48 | setnframes(n) -- set the number of frames |
| 49 | setcomptype(type, name) |
| 50 | -- set the compression type and the |
| 51 | human-readable compression type |
| 52 | setparams(tuple) |
| 53 | -- set all parameters at once |
| 54 | tell() -- return current position in output file |
| 55 | writeframesraw(data) |
| 56 | -- write audio frames without pathing up the |
| 57 | file header |
| 58 | writeframes(data) |
| 59 | -- write audio frames and patch up the file header |
| 60 | close() -- patch up the file header and close the |
| 61 | output file |
| 62 | You should set the parameters before the first writeframesraw or |
| 63 | writeframes. The total number of frames does not need to be set, |
| 64 | but when it is set to the correct value, the header does not have to |
| 65 | be patched up. |
| 66 | It is best to first set all parameters, perhaps possibly the |
| 67 | compression type, and then write audio frames using writeframesraw. |
Serhiy Storchaka | e0fd7ef | 2015-07-10 22:13:40 +0300 | [diff] [blame] | 68 | When all frames have been written, either call writeframes(b'') or |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 69 | close() to patch up the sizes in the header. |
| 70 | The close() method is called automatically when the class instance |
| 71 | is destroyed. |
| 72 | """ |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 73 | |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 74 | import builtins |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 75 | |
Martin Panter | 19e69c5 | 2015-11-14 12:46:42 +0000 | [diff] [blame] | 76 | __all__ = ["open", "openfp", "Error", "Wave_read", "Wave_write"] |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 77 | |
Fred Drake | 9b8d801 | 2000-08-17 04:45:13 +0000 | [diff] [blame] | 78 | class Error(Exception): |
| 79 | pass |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 80 | |
| 81 | WAVE_FORMAT_PCM = 0x0001 |
| 82 | |
Serhiy Storchaka | d3b7505 | 2013-10-17 23:04:04 +0300 | [diff] [blame] | 83 | _array_fmts = None, 'b', 'h', None, 'i' |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 84 | |
Serhiy Storchaka | 3062c9a | 2013-11-23 22:26:01 +0200 | [diff] [blame] | 85 | import audioop |
Guido van Rossum | ebb9c92 | 1999-02-05 22:28:17 +0000 | [diff] [blame] | 86 | import struct |
Serhiy Storchaka | d739bda | 2013-05-29 23:38:00 +0300 | [diff] [blame] | 87 | import sys |
Guido van Rossum | 3601e88 | 1999-08-26 15:50:43 +0000 | [diff] [blame] | 88 | from chunk import Chunk |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 89 | from collections import namedtuple |
Brian Curtin | 9f914a0 | 2017-11-10 11:38:25 -0500 | [diff] [blame] | 90 | import warnings |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 91 | |
Serhiy Storchaka | 4c6a020 | 2013-09-04 00:28:43 +0300 | [diff] [blame] | 92 | _wave_params = namedtuple('_wave_params', |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 93 | 'nchannels sampwidth framerate nframes comptype compname') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 94 | |
| 95 | class Wave_read: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 96 | """Variables used in this class: |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 97 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 98 | These variables are available to the user though appropriate |
| 99 | methods of this class: |
| 100 | _file -- the open file with methods read(), close(), and seek() |
| 101 | set through the __init__() method |
| 102 | _nchannels -- the number of audio channels |
| 103 | available through the getnchannels() method |
| 104 | _nframes -- the number of audio frames |
| 105 | available through the getnframes() method |
| 106 | _sampwidth -- the number of bytes per audio sample |
| 107 | available through the getsampwidth() method |
| 108 | _framerate -- the sampling frequency |
| 109 | available through the getframerate() method |
| 110 | _comptype -- the AIFF-C compression type ('NONE' if AIFF) |
| 111 | available through the getcomptype() method |
| 112 | _compname -- the human-readable AIFF-C compression type |
| 113 | available through the getcomptype() method |
| 114 | _soundpos -- the position in the audio stream |
| 115 | available through the tell() method, set through the |
| 116 | setpos() method |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 117 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 118 | These variables are used internally only: |
| 119 | _fmt_chunk_read -- 1 iff the FMT chunk has been read |
| 120 | _data_seek_needed -- 1 iff positioned correctly in audio |
| 121 | file for readframes() |
| 122 | _data_chunk -- instantiation of a chunk class for the DATA chunk |
| 123 | _framesize -- size of one frame in the file |
| 124 | """ |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 125 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 126 | def initfp(self, file): |
| 127 | self._convert = None |
| 128 | self._soundpos = 0 |
| 129 | self._file = Chunk(file, bigendian = 0) |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 130 | if self._file.getname() != b'RIFF': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 131 | raise Error('file does not start with RIFF id') |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 132 | if self._file.read(4) != b'WAVE': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 133 | raise Error('not a WAVE file') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 134 | self._fmt_chunk_read = 0 |
| 135 | self._data_chunk = None |
| 136 | while 1: |
| 137 | self._data_seek_needed = 1 |
| 138 | try: |
| 139 | chunk = Chunk(self._file, bigendian = 0) |
| 140 | except EOFError: |
| 141 | break |
| 142 | chunkname = chunk.getname() |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 143 | if chunkname == b'fmt ': |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 144 | self._read_fmt_chunk(chunk) |
| 145 | self._fmt_chunk_read = 1 |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 146 | elif chunkname == b'data': |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 147 | if not self._fmt_chunk_read: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 148 | raise Error('data chunk before fmt chunk') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 149 | self._data_chunk = chunk |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 150 | self._nframes = chunk.chunksize // self._framesize |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 151 | self._data_seek_needed = 0 |
| 152 | break |
| 153 | chunk.skip() |
| 154 | if not self._fmt_chunk_read or not self._data_chunk: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 155 | raise Error('fmt chunk and/or data chunk missing') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 156 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 157 | def __init__(self, f): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 158 | self._i_opened_the_file = None |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 159 | if isinstance(f, str): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 160 | f = builtins.open(f, 'rb') |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 161 | self._i_opened_the_file = f |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 162 | # else, assume it is an open file object already |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 163 | try: |
| 164 | self.initfp(f) |
| 165 | except: |
| 166 | if self._i_opened_the_file: |
| 167 | f.close() |
| 168 | raise |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 169 | |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 170 | def __del__(self): |
| 171 | self.close() |
R David Murray | c91d5ee | 2013-07-31 13:46:08 -0400 | [diff] [blame] | 172 | |
| 173 | def __enter__(self): |
| 174 | return self |
| 175 | |
| 176 | def __exit__(self, *args): |
| 177 | self.close() |
| 178 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 179 | # |
| 180 | # User visible methods. |
| 181 | # |
| 182 | def getfp(self): |
| 183 | return self._file |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 184 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 185 | def rewind(self): |
| 186 | self._data_seek_needed = 1 |
| 187 | self._soundpos = 0 |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 188 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 189 | def close(self): |
| 190 | self._file = None |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 191 | file = self._i_opened_the_file |
| 192 | if file: |
| 193 | self._i_opened_the_file = None |
| 194 | file.close() |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 195 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 196 | def tell(self): |
| 197 | return self._soundpos |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 198 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 199 | def getnchannels(self): |
| 200 | return self._nchannels |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 201 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 202 | def getnframes(self): |
| 203 | return self._nframes |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 204 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 205 | def getsampwidth(self): |
| 206 | return self._sampwidth |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 207 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 208 | def getframerate(self): |
| 209 | return self._framerate |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 210 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 211 | def getcomptype(self): |
| 212 | return self._comptype |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 213 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 214 | def getcompname(self): |
| 215 | return self._compname |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 216 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 217 | def getparams(self): |
Serhiy Storchaka | 4c6a020 | 2013-09-04 00:28:43 +0300 | [diff] [blame] | 218 | return _wave_params(self.getnchannels(), self.getsampwidth(), |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 219 | self.getframerate(), self.getnframes(), |
| 220 | self.getcomptype(), self.getcompname()) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 221 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 222 | def getmarkers(self): |
| 223 | return None |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 224 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 225 | def getmark(self, id): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 226 | raise Error('no marks') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 227 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 228 | def setpos(self, pos): |
| 229 | if pos < 0 or pos > self._nframes: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 230 | raise Error('position not in range') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 231 | self._soundpos = pos |
| 232 | self._data_seek_needed = 1 |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 233 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 234 | def readframes(self, nframes): |
| 235 | if self._data_seek_needed: |
| 236 | self._data_chunk.seek(0, 0) |
| 237 | pos = self._soundpos * self._framesize |
| 238 | if pos: |
| 239 | self._data_chunk.seek(pos, 0) |
| 240 | self._data_seek_needed = 0 |
| 241 | if nframes == 0: |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 242 | return b'' |
Serhiy Storchaka | 3062c9a | 2013-11-23 22:26:01 +0200 | [diff] [blame] | 243 | data = self._data_chunk.read(nframes * self._framesize) |
| 244 | if self._sampwidth != 1 and sys.byteorder == 'big': |
| 245 | data = audioop.byteswap(data, self._sampwidth) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 246 | if self._convert and data: |
| 247 | data = self._convert(data) |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 248 | self._soundpos = self._soundpos + len(data) // (self._nchannels * self._sampwidth) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 249 | return data |
| 250 | |
| 251 | # |
| 252 | # Internal methods. |
| 253 | # |
| 254 | |
| 255 | def _read_fmt_chunk(self, chunk): |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 256 | wFormatTag, self._nchannels, self._framerate, dwAvgBytesPerSec, wBlockAlign = struct.unpack_from('<HHLLH', chunk.read(14)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 257 | if wFormatTag == WAVE_FORMAT_PCM: |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 258 | sampwidth = struct.unpack_from('<H', chunk.read(2))[0] |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 259 | self._sampwidth = (sampwidth + 7) // 8 |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 260 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 261 | raise Error('unknown format: %r' % (wFormatTag,)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 262 | self._framesize = self._nchannels * self._sampwidth |
| 263 | self._comptype = 'NONE' |
| 264 | self._compname = 'not compressed' |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 265 | |
| 266 | class Wave_write: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 267 | """Variables used in this class: |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 268 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 269 | These variables are user settable through appropriate methods |
| 270 | of this class: |
| 271 | _file -- the open file with methods write(), close(), tell(), seek() |
| 272 | set through the __init__() method |
| 273 | _comptype -- the AIFF-C compression type ('NONE' in AIFF) |
| 274 | set through the setcomptype() or setparams() method |
| 275 | _compname -- the human-readable AIFF-C compression type |
| 276 | set through the setcomptype() or setparams() method |
| 277 | _nchannels -- the number of audio channels |
| 278 | set through the setnchannels() or setparams() method |
| 279 | _sampwidth -- the number of bytes per audio sample |
| 280 | set through the setsampwidth() or setparams() method |
| 281 | _framerate -- the sampling frequency |
| 282 | set through the setframerate() or setparams() method |
| 283 | _nframes -- the number of audio frames written to the header |
| 284 | set through the setnframes() or setparams() method |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 285 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 286 | These variables are used internally only: |
| 287 | _datalength -- the size of the audio samples written to the header |
| 288 | _nframeswritten -- the number of frames actually written |
| 289 | _datawritten -- the size of the audio samples actually written |
| 290 | """ |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 291 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 292 | def __init__(self, f): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 293 | self._i_opened_the_file = None |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 294 | if isinstance(f, str): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 295 | f = builtins.open(f, 'wb') |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 296 | self._i_opened_the_file = f |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 297 | try: |
| 298 | self.initfp(f) |
| 299 | except: |
| 300 | if self._i_opened_the_file: |
| 301 | f.close() |
| 302 | raise |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 303 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 304 | def initfp(self, file): |
| 305 | self._file = file |
| 306 | self._convert = None |
| 307 | self._nchannels = 0 |
| 308 | self._sampwidth = 0 |
| 309 | self._framerate = 0 |
| 310 | self._nframes = 0 |
| 311 | self._nframeswritten = 0 |
| 312 | self._datawritten = 0 |
| 313 | self._datalength = 0 |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 314 | self._headerwritten = False |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 315 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 316 | def __del__(self): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 317 | self.close() |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 318 | |
R David Murray | c91d5ee | 2013-07-31 13:46:08 -0400 | [diff] [blame] | 319 | def __enter__(self): |
| 320 | return self |
| 321 | |
| 322 | def __exit__(self, *args): |
| 323 | self.close() |
| 324 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 325 | # |
| 326 | # User visible methods. |
| 327 | # |
| 328 | def setnchannels(self, nchannels): |
| 329 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 330 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 331 | if nchannels < 1: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 332 | raise Error('bad # of channels') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 333 | self._nchannels = nchannels |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 334 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 335 | def getnchannels(self): |
| 336 | if not self._nchannels: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 337 | raise Error('number of channels not set') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 338 | return self._nchannels |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 339 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 340 | def setsampwidth(self, sampwidth): |
| 341 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 342 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 343 | if sampwidth < 1 or sampwidth > 4: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 344 | raise Error('bad sample width') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 345 | self._sampwidth = sampwidth |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 346 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 347 | def getsampwidth(self): |
| 348 | if not self._sampwidth: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 349 | raise Error('sample width not set') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 350 | return self._sampwidth |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 351 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 352 | def setframerate(self, framerate): |
| 353 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 354 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 355 | if framerate <= 0: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 356 | raise Error('bad frame rate') |
Mark Dickinson | 64a38c0 | 2010-08-28 17:22:16 +0000 | [diff] [blame] | 357 | self._framerate = int(round(framerate)) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 358 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 359 | def getframerate(self): |
| 360 | if not self._framerate: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 361 | raise Error('frame rate not set') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 362 | return self._framerate |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 363 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 364 | def setnframes(self, nframes): |
| 365 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 366 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 367 | self._nframes = nframes |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 368 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 369 | def getnframes(self): |
| 370 | return self._nframeswritten |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 371 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 372 | def setcomptype(self, comptype, compname): |
| 373 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 374 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 375 | if comptype not in ('NONE',): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 376 | raise Error('unsupported compression type') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 377 | self._comptype = comptype |
| 378 | self._compname = compname |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 379 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 380 | def getcomptype(self): |
| 381 | return self._comptype |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 382 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 383 | def getcompname(self): |
| 384 | return self._compname |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 385 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 386 | def setparams(self, params): |
| 387 | nchannels, sampwidth, framerate, nframes, comptype, compname = params |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 388 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 389 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 390 | self.setnchannels(nchannels) |
| 391 | self.setsampwidth(sampwidth) |
| 392 | self.setframerate(framerate) |
| 393 | self.setnframes(nframes) |
| 394 | self.setcomptype(comptype, compname) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 395 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 396 | def getparams(self): |
| 397 | if not self._nchannels or not self._sampwidth or not self._framerate: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 398 | raise Error('not all parameters set') |
Serhiy Storchaka | 4c6a020 | 2013-09-04 00:28:43 +0300 | [diff] [blame] | 399 | return _wave_params(self._nchannels, self._sampwidth, self._framerate, |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 400 | self._nframes, self._comptype, self._compname) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 401 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 402 | def setmark(self, id, pos, name): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 403 | raise Error('setmark() not supported') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 404 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 405 | def getmark(self, id): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 406 | raise Error('no marks') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 407 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 408 | def getmarkers(self): |
| 409 | return None |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 410 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 411 | def tell(self): |
| 412 | return self._nframeswritten |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 413 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 414 | def writeframesraw(self, data): |
Serhiy Storchaka | 452bab4 | 2013-11-16 14:01:31 +0200 | [diff] [blame] | 415 | if not isinstance(data, (bytes, bytearray)): |
| 416 | data = memoryview(data).cast('B') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 417 | self._ensure_header_written(len(data)) |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 418 | nframes = len(data) // (self._sampwidth * self._nchannels) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 419 | if self._convert: |
| 420 | data = self._convert(data) |
Serhiy Storchaka | 3062c9a | 2013-11-23 22:26:01 +0200 | [diff] [blame] | 421 | if self._sampwidth != 1 and sys.byteorder == 'big': |
| 422 | data = audioop.byteswap(data, self._sampwidth) |
| 423 | self._file.write(data) |
| 424 | self._datawritten += len(data) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 425 | self._nframeswritten = self._nframeswritten + nframes |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 426 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 427 | def writeframes(self, data): |
| 428 | self.writeframesraw(data) |
| 429 | if self._datalength != self._datawritten: |
| 430 | self._patchheader() |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 431 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 432 | def close(self): |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 433 | try: |
| 434 | if self._file: |
R David Murray | 536ffe1 | 2013-07-31 20:48:26 -0400 | [diff] [blame] | 435 | self._ensure_header_written(0) |
| 436 | if self._datalength != self._datawritten: |
| 437 | self._patchheader() |
| 438 | self._file.flush() |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 439 | finally: |
| 440 | self._file = None |
| 441 | file = self._i_opened_the_file |
| 442 | if file: |
| 443 | self._i_opened_the_file = None |
| 444 | file.close() |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 445 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 446 | # |
| 447 | # Internal methods. |
| 448 | # |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 449 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 450 | def _ensure_header_written(self, datasize): |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 451 | if not self._headerwritten: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 452 | if not self._nchannels: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 453 | raise Error('# channels not specified') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 454 | if not self._sampwidth: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 455 | raise Error('sample width not specified') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 456 | if not self._framerate: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 457 | raise Error('sampling rate not specified') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 458 | self._write_header(datasize) |
| 459 | |
| 460 | def _write_header(self, initlength): |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 461 | assert not self._headerwritten |
Guido van Rossum | 09549f4 | 2007-08-27 20:40:10 +0000 | [diff] [blame] | 462 | self._file.write(b'RIFF') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 463 | if not self._nframes: |
Benjamin Peterson | 5efea04 | 2010-01-13 03:49:50 +0000 | [diff] [blame] | 464 | self._nframes = initlength // (self._nchannels * self._sampwidth) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 465 | self._datalength = self._nframes * self._nchannels * self._sampwidth |
Serhiy Storchaka | 7714ebb | 2013-11-16 13:04:00 +0200 | [diff] [blame] | 466 | try: |
| 467 | self._form_length_pos = self._file.tell() |
| 468 | except (AttributeError, OSError): |
| 469 | self._form_length_pos = None |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 470 | self._file.write(struct.pack('<L4s4sLHHLLHH4s', |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 471 | 36 + self._datalength, b'WAVE', b'fmt ', 16, |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 472 | WAVE_FORMAT_PCM, self._nchannels, self._framerate, |
| 473 | self._nchannels * self._framerate * self._sampwidth, |
| 474 | self._nchannels * self._sampwidth, |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 475 | self._sampwidth * 8, b'data')) |
Serhiy Storchaka | 7714ebb | 2013-11-16 13:04:00 +0200 | [diff] [blame] | 476 | if self._form_length_pos is not None: |
| 477 | self._data_length_pos = self._file.tell() |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 478 | self._file.write(struct.pack('<L', self._datalength)) |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 479 | self._headerwritten = True |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 480 | |
| 481 | def _patchheader(self): |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 482 | assert self._headerwritten |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 483 | if self._datawritten == self._datalength: |
| 484 | return |
| 485 | curpos = self._file.tell() |
| 486 | self._file.seek(self._form_length_pos, 0) |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 487 | self._file.write(struct.pack('<L', 36 + self._datawritten)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 488 | self._file.seek(self._data_length_pos, 0) |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 489 | self._file.write(struct.pack('<L', self._datawritten)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 490 | self._file.seek(curpos, 0) |
| 491 | self._datalength = self._datawritten |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 492 | |
Fred Drake | f960782 | 1999-06-17 15:18:47 +0000 | [diff] [blame] | 493 | def open(f, mode=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 494 | if mode is None: |
| 495 | if hasattr(f, 'mode'): |
| 496 | mode = f.mode |
| 497 | else: |
| 498 | mode = 'rb' |
| 499 | if mode in ('r', 'rb'): |
| 500 | return Wave_read(f) |
| 501 | elif mode in ('w', 'wb'): |
| 502 | return Wave_write(f) |
| 503 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 504 | raise Error("mode must be 'r', 'rb', 'w', or 'wb'") |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 505 | |
Brian Curtin | 9f914a0 | 2017-11-10 11:38:25 -0500 | [diff] [blame] | 506 | def openfp(f, mode=None): |
| 507 | warnings.warn("wave.openfp is deprecated since Python 3.7. " |
| 508 | "Use wave.open instead.", DeprecationWarning, stacklevel=2) |
| 509 | return open(f, mode=mode) |