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. |
| 68 | When all frames have been written, either call writeframes('') or |
| 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 | |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 76 | __all__ = ["open", "openfp", "Error"] |
| 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 | |
| 83 | _array_fmts = None, 'b', 'h', None, 'l' |
| 84 | |
Guido van Rossum | ebb9c92 | 1999-02-05 22:28:17 +0000 | [diff] [blame] | 85 | import struct |
Serhiy Storchaka | d739bda | 2013-05-29 23:38:00 +0300 | [diff] [blame] | 86 | import sys |
Guido van Rossum | 3601e88 | 1999-08-26 15:50:43 +0000 | [diff] [blame] | 87 | from chunk import Chunk |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 88 | from collections import namedtuple |
| 89 | |
| 90 | _result = namedtuple('params', |
| 91 | 'nchannels sampwidth framerate nframes comptype compname') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 92 | |
| 93 | class Wave_read: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 94 | """Variables used in this class: |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 95 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 96 | These variables are available to the user though appropriate |
| 97 | methods of this class: |
| 98 | _file -- the open file with methods read(), close(), and seek() |
| 99 | set through the __init__() method |
| 100 | _nchannels -- the number of audio channels |
| 101 | available through the getnchannels() method |
| 102 | _nframes -- the number of audio frames |
| 103 | available through the getnframes() method |
| 104 | _sampwidth -- the number of bytes per audio sample |
| 105 | available through the getsampwidth() method |
| 106 | _framerate -- the sampling frequency |
| 107 | available through the getframerate() method |
| 108 | _comptype -- the AIFF-C compression type ('NONE' if AIFF) |
| 109 | available through the getcomptype() method |
| 110 | _compname -- the human-readable AIFF-C compression type |
| 111 | available through the getcomptype() method |
| 112 | _soundpos -- the position in the audio stream |
| 113 | available through the tell() method, set through the |
| 114 | setpos() method |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 115 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 116 | These variables are used internally only: |
| 117 | _fmt_chunk_read -- 1 iff the FMT chunk has been read |
| 118 | _data_seek_needed -- 1 iff positioned correctly in audio |
| 119 | file for readframes() |
| 120 | _data_chunk -- instantiation of a chunk class for the DATA chunk |
| 121 | _framesize -- size of one frame in the file |
| 122 | """ |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 123 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 124 | def initfp(self, file): |
| 125 | self._convert = None |
| 126 | self._soundpos = 0 |
| 127 | self._file = Chunk(file, bigendian = 0) |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 128 | if self._file.getname() != b'RIFF': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 129 | raise Error('file does not start with RIFF id') |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 130 | if self._file.read(4) != b'WAVE': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 131 | raise Error('not a WAVE file') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 132 | self._fmt_chunk_read = 0 |
| 133 | self._data_chunk = None |
| 134 | while 1: |
| 135 | self._data_seek_needed = 1 |
| 136 | try: |
| 137 | chunk = Chunk(self._file, bigendian = 0) |
| 138 | except EOFError: |
| 139 | break |
| 140 | chunkname = chunk.getname() |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 141 | if chunkname == b'fmt ': |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 142 | self._read_fmt_chunk(chunk) |
| 143 | self._fmt_chunk_read = 1 |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 144 | elif chunkname == b'data': |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 145 | if not self._fmt_chunk_read: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 146 | raise Error('data chunk before fmt chunk') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 147 | self._data_chunk = chunk |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 148 | self._nframes = chunk.chunksize // self._framesize |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 149 | self._data_seek_needed = 0 |
| 150 | break |
| 151 | chunk.skip() |
| 152 | if not self._fmt_chunk_read or not self._data_chunk: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 153 | raise Error('fmt chunk and/or data chunk missing') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 154 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 155 | def __init__(self, f): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 156 | self._i_opened_the_file = None |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 157 | if isinstance(f, str): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 158 | f = builtins.open(f, 'rb') |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 159 | self._i_opened_the_file = f |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 160 | # else, assume it is an open file object already |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 161 | try: |
| 162 | self.initfp(f) |
| 163 | except: |
| 164 | if self._i_opened_the_file: |
| 165 | f.close() |
| 166 | raise |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 167 | |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 168 | def __del__(self): |
| 169 | self.close() |
R David Murray | c91d5ee | 2013-07-31 13:46:08 -0400 | [diff] [blame] | 170 | |
| 171 | def __enter__(self): |
| 172 | return self |
| 173 | |
| 174 | def __exit__(self, *args): |
| 175 | self.close() |
| 176 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 177 | # |
| 178 | # User visible methods. |
| 179 | # |
| 180 | def getfp(self): |
| 181 | return self._file |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 182 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 183 | def rewind(self): |
| 184 | self._data_seek_needed = 1 |
| 185 | self._soundpos = 0 |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 186 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 187 | def close(self): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 188 | if self._i_opened_the_file: |
| 189 | self._i_opened_the_file.close() |
| 190 | self._i_opened_the_file = None |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 191 | self._file = None |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 192 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 193 | def tell(self): |
| 194 | return self._soundpos |
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 getnchannels(self): |
| 197 | return self._nchannels |
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 getnframes(self): |
| 200 | return self._nframes |
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 getsampwidth(self): |
| 203 | return self._sampwidth |
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 getframerate(self): |
| 206 | return self._framerate |
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 getcomptype(self): |
| 209 | return self._comptype |
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 getcompname(self): |
| 212 | return self._compname |
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 getparams(self): |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 215 | return _result(self.getnchannels(), self.getsampwidth(), |
| 216 | self.getframerate(), self.getnframes(), |
| 217 | self.getcomptype(), self.getcompname()) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 218 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 219 | def getmarkers(self): |
| 220 | return None |
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 getmark(self, id): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 223 | raise Error('no marks') |
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 setpos(self, pos): |
| 226 | if pos < 0 or pos > self._nframes: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 227 | raise Error('position not in range') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 228 | self._soundpos = pos |
| 229 | self._data_seek_needed = 1 |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 230 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 231 | def readframes(self, nframes): |
| 232 | if self._data_seek_needed: |
| 233 | self._data_chunk.seek(0, 0) |
| 234 | pos = self._soundpos * self._framesize |
| 235 | if pos: |
| 236 | self._data_chunk.seek(pos, 0) |
| 237 | self._data_seek_needed = 0 |
| 238 | if nframes == 0: |
Guido van Rossum | 51a883b | 2007-07-23 21:28:30 +0000 | [diff] [blame] | 239 | return b'' |
Serhiy Storchaka | d739bda | 2013-05-29 23:38:00 +0300 | [diff] [blame] | 240 | if self._sampwidth > 1 and sys.byteorder == 'big': |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 241 | # unfortunately the fromfile() method does not take |
| 242 | # something that only looks like a file object, so |
| 243 | # we have to reach into the innards of the chunk object |
| 244 | import array |
| 245 | chunk = self._data_chunk |
| 246 | data = array.array(_array_fmts[self._sampwidth]) |
| 247 | nitems = nframes * self._nchannels |
| 248 | if nitems * self._sampwidth > chunk.chunksize - chunk.size_read: |
Benjamin Peterson | 5efea04 | 2010-01-13 03:49:50 +0000 | [diff] [blame] | 249 | nitems = (chunk.chunksize - chunk.size_read) // self._sampwidth |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 250 | data.fromfile(chunk.file.file, nitems) |
| 251 | # "tell" data chunk how much was read |
| 252 | chunk.size_read = chunk.size_read + nitems * self._sampwidth |
| 253 | # do the same for the outermost chunk |
| 254 | chunk = chunk.file |
| 255 | chunk.size_read = chunk.size_read + nitems * self._sampwidth |
| 256 | data.byteswap() |
Antoine Pitrou | 1ce3eb5 | 2010-09-01 20:29:34 +0000 | [diff] [blame] | 257 | data = data.tobytes() |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 258 | else: |
| 259 | data = self._data_chunk.read(nframes * self._framesize) |
| 260 | if self._convert and data: |
| 261 | data = self._convert(data) |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 262 | self._soundpos = self._soundpos + len(data) // (self._nchannels * self._sampwidth) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 263 | return data |
| 264 | |
| 265 | # |
| 266 | # Internal methods. |
| 267 | # |
| 268 | |
| 269 | def _read_fmt_chunk(self, chunk): |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 270 | 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] | 271 | if wFormatTag == WAVE_FORMAT_PCM: |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 272 | sampwidth = struct.unpack_from('<H', chunk.read(2))[0] |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 273 | self._sampwidth = (sampwidth + 7) // 8 |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 274 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 275 | raise Error('unknown format: %r' % (wFormatTag,)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 276 | self._framesize = self._nchannels * self._sampwidth |
| 277 | self._comptype = 'NONE' |
| 278 | self._compname = 'not compressed' |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 279 | |
| 280 | class Wave_write: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 281 | """Variables used in this class: |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 282 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 283 | These variables are user settable through appropriate methods |
| 284 | of this class: |
| 285 | _file -- the open file with methods write(), close(), tell(), seek() |
| 286 | set through the __init__() method |
| 287 | _comptype -- the AIFF-C compression type ('NONE' in AIFF) |
| 288 | set through the setcomptype() or setparams() method |
| 289 | _compname -- the human-readable AIFF-C compression type |
| 290 | set through the setcomptype() or setparams() method |
| 291 | _nchannels -- the number of audio channels |
| 292 | set through the setnchannels() or setparams() method |
| 293 | _sampwidth -- the number of bytes per audio sample |
| 294 | set through the setsampwidth() or setparams() method |
| 295 | _framerate -- the sampling frequency |
| 296 | set through the setframerate() or setparams() method |
| 297 | _nframes -- the number of audio frames written to the header |
| 298 | set through the setnframes() or setparams() method |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 299 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 300 | These variables are used internally only: |
| 301 | _datalength -- the size of the audio samples written to the header |
| 302 | _nframeswritten -- the number of frames actually written |
| 303 | _datawritten -- the size of the audio samples actually written |
| 304 | """ |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 305 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 306 | def __init__(self, f): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 307 | self._i_opened_the_file = None |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 308 | if isinstance(f, str): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 309 | f = builtins.open(f, 'wb') |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 310 | self._i_opened_the_file = f |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 311 | try: |
| 312 | self.initfp(f) |
| 313 | except: |
| 314 | if self._i_opened_the_file: |
| 315 | f.close() |
| 316 | raise |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 317 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 318 | def initfp(self, file): |
| 319 | self._file = file |
| 320 | self._convert = None |
| 321 | self._nchannels = 0 |
| 322 | self._sampwidth = 0 |
| 323 | self._framerate = 0 |
| 324 | self._nframes = 0 |
| 325 | self._nframeswritten = 0 |
| 326 | self._datawritten = 0 |
| 327 | self._datalength = 0 |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 328 | self._headerwritten = False |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 329 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 330 | def __del__(self): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 331 | self.close() |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 332 | |
R David Murray | c91d5ee | 2013-07-31 13:46:08 -0400 | [diff] [blame] | 333 | def __enter__(self): |
| 334 | return self |
| 335 | |
| 336 | def __exit__(self, *args): |
| 337 | self.close() |
| 338 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 339 | # |
| 340 | # User visible methods. |
| 341 | # |
| 342 | def setnchannels(self, nchannels): |
| 343 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 344 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 345 | if nchannels < 1: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 346 | raise Error('bad # of channels') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 347 | self._nchannels = nchannels |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 348 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 349 | def getnchannels(self): |
| 350 | if not self._nchannels: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 351 | raise Error('number of channels not set') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 352 | return self._nchannels |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 353 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 354 | def setsampwidth(self, sampwidth): |
| 355 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 356 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 357 | if sampwidth < 1 or sampwidth > 4: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 358 | raise Error('bad sample width') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 359 | self._sampwidth = sampwidth |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 360 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 361 | def getsampwidth(self): |
| 362 | if not self._sampwidth: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 363 | raise Error('sample width not set') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 364 | return self._sampwidth |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 365 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 366 | def setframerate(self, framerate): |
| 367 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 368 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 369 | if framerate <= 0: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 370 | raise Error('bad frame rate') |
Mark Dickinson | 64a38c0 | 2010-08-28 17:22:16 +0000 | [diff] [blame] | 371 | self._framerate = int(round(framerate)) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 372 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 373 | def getframerate(self): |
| 374 | if not self._framerate: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 375 | raise Error('frame rate not set') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 376 | return self._framerate |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 377 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 378 | def setnframes(self, nframes): |
| 379 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 380 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 381 | self._nframes = nframes |
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 getnframes(self): |
| 384 | return self._nframeswritten |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 385 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 386 | def setcomptype(self, comptype, compname): |
| 387 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 388 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 389 | if comptype not in ('NONE',): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 390 | raise Error('unsupported compression type') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 391 | self._comptype = comptype |
| 392 | self._compname = compname |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 393 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 394 | def getcomptype(self): |
| 395 | return self._comptype |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 396 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 397 | def getcompname(self): |
| 398 | return self._compname |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 399 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 400 | def setparams(self, params): |
| 401 | nchannels, sampwidth, framerate, nframes, comptype, compname = params |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 402 | if self._datawritten: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 403 | raise Error('cannot change parameters after starting to write') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 404 | self.setnchannels(nchannels) |
| 405 | self.setsampwidth(sampwidth) |
| 406 | self.setframerate(framerate) |
| 407 | self.setnframes(nframes) |
| 408 | self.setcomptype(comptype, compname) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 409 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 410 | def getparams(self): |
| 411 | if not self._nchannels or not self._sampwidth or not self._framerate: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 412 | raise Error('not all parameters set') |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 413 | return _result(self._nchannels, self._sampwidth, self._framerate, |
| 414 | self._nframes, self._comptype, self._compname) |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 415 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 416 | def setmark(self, id, pos, name): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 417 | raise Error('setmark() not supported') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 418 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 419 | def getmark(self, id): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 420 | raise Error('no marks') |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 421 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 422 | def getmarkers(self): |
| 423 | return None |
Tim Peters | e119006 | 2001-01-15 03:34:38 +0000 | [diff] [blame] | 424 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 425 | def tell(self): |
| 426 | return self._nframeswritten |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 427 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 428 | def writeframesraw(self, data): |
| 429 | self._ensure_header_written(len(data)) |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 430 | nframes = len(data) // (self._sampwidth * self._nchannels) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 431 | if self._convert: |
| 432 | data = self._convert(data) |
Serhiy Storchaka | d739bda | 2013-05-29 23:38:00 +0300 | [diff] [blame] | 433 | if self._sampwidth > 1 and sys.byteorder == 'big': |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 434 | import array |
| 435 | data = array.array(_array_fmts[self._sampwidth], data) |
| 436 | data.byteswap() |
| 437 | data.tofile(self._file) |
| 438 | self._datawritten = self._datawritten + len(data) * self._sampwidth |
| 439 | else: |
| 440 | self._file.write(data) |
| 441 | self._datawritten = self._datawritten + len(data) |
| 442 | self._nframeswritten = self._nframeswritten + nframes |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 443 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 444 | def writeframes(self, data): |
| 445 | self.writeframesraw(data) |
| 446 | if self._datalength != self._datawritten: |
| 447 | self._patchheader() |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 448 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 449 | def close(self): |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 450 | if self._file: |
R David Murray | 536ffe1 | 2013-07-31 20:48:26 -0400 | [diff] [blame^] | 451 | try: |
| 452 | self._ensure_header_written(0) |
| 453 | if self._datalength != self._datawritten: |
| 454 | self._patchheader() |
| 455 | self._file.flush() |
| 456 | finally: |
| 457 | self._file = None |
Tim Peters | cfc4178 | 2000-10-09 23:43:55 +0000 | [diff] [blame] | 458 | if self._i_opened_the_file: |
| 459 | self._i_opened_the_file.close() |
| 460 | self._i_opened_the_file = None |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 461 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 462 | # |
| 463 | # Internal methods. |
| 464 | # |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 465 | |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 466 | def _ensure_header_written(self, datasize): |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 467 | if not self._headerwritten: |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 468 | if not self._nchannels: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 469 | raise Error('# channels not specified') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 470 | if not self._sampwidth: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 471 | raise Error('sample width not specified') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 472 | if not self._framerate: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 473 | raise Error('sampling rate not specified') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 474 | self._write_header(datasize) |
| 475 | |
| 476 | def _write_header(self, initlength): |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 477 | assert not self._headerwritten |
Guido van Rossum | 09549f4 | 2007-08-27 20:40:10 +0000 | [diff] [blame] | 478 | self._file.write(b'RIFF') |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 479 | if not self._nframes: |
Benjamin Peterson | 5efea04 | 2010-01-13 03:49:50 +0000 | [diff] [blame] | 480 | self._nframes = initlength // (self._nchannels * self._sampwidth) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 481 | self._datalength = self._nframes * self._nchannels * self._sampwidth |
| 482 | self._form_length_pos = self._file.tell() |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 483 | self._file.write(struct.pack('<L4s4sLHHLLHH4s', |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 484 | 36 + self._datalength, b'WAVE', b'fmt ', 16, |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 485 | WAVE_FORMAT_PCM, self._nchannels, self._framerate, |
| 486 | self._nchannels * self._framerate * self._sampwidth, |
| 487 | self._nchannels * self._sampwidth, |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 488 | self._sampwidth * 8, b'data')) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 489 | self._data_length_pos = self._file.tell() |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 490 | self._file.write(struct.pack('<L', self._datalength)) |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 491 | self._headerwritten = True |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 492 | |
| 493 | def _patchheader(self): |
Georg Brandl | cc2adbc | 2010-10-30 08:29:28 +0000 | [diff] [blame] | 494 | assert self._headerwritten |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 495 | if self._datawritten == self._datalength: |
| 496 | return |
| 497 | curpos = self._file.tell() |
| 498 | self._file.seek(self._form_length_pos, 0) |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 499 | self._file.write(struct.pack('<L', 36 + self._datawritten)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 500 | self._file.seek(self._data_length_pos, 0) |
Jesus Cea | e4b86398 | 2012-11-17 03:41:54 +0100 | [diff] [blame] | 501 | self._file.write(struct.pack('<L', self._datawritten)) |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 502 | self._file.seek(curpos, 0) |
| 503 | self._datalength = self._datawritten |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 504 | |
Fred Drake | f960782 | 1999-06-17 15:18:47 +0000 | [diff] [blame] | 505 | def open(f, mode=None): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 506 | if mode is None: |
| 507 | if hasattr(f, 'mode'): |
| 508 | mode = f.mode |
| 509 | else: |
| 510 | mode = 'rb' |
| 511 | if mode in ('r', 'rb'): |
| 512 | return Wave_read(f) |
| 513 | elif mode in ('w', 'wb'): |
| 514 | return Wave_write(f) |
| 515 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 516 | raise Error("mode must be 'r', 'rb', 'w', or 'wb'") |
Guido van Rossum | 3ed23cc | 1994-02-15 15:57:15 +0000 | [diff] [blame] | 517 | |
| 518 | openfp = open # B/W compatibility |