blob: ed5da7d8936fdd94301accd4ac725ab0e5fe8877 [file] [log] [blame]
Guido van Rossum4acc25b2000-02-02 15:10:15 +00001"""Stuff to parse AIFF-C and AIFF files.
2
3Unless explicitly stated otherwise, the description below is true
4both for AIFF-C files and AIFF files.
5
6An AIFF-C file has the following structure.
7
8 +-----------------+
9 | FORM |
10 +-----------------+
11 | <size> |
12 +----+------------+
13 | | AIFC |
14 | +------------+
15 | | <chunks> |
16 | | . |
17 | | . |
18 | | . |
19 +----+------------+
20
21An AIFF file has the string "AIFF" instead of "AIFC".
22
23A chunk consists of an identifier (4 bytes) followed by a size (4 bytes,
24big endian order), followed by the data. The size field does not include
25the size of the 8 byte header.
26
27The following chunk types are recognized.
28
29 FVER
30 <version number of AIFF-C defining document> (AIFF-C only).
31 MARK
32 <# of markers> (2 bytes)
33 list of markers:
34 <marker ID> (2 bytes, must be > 0)
35 <position> (4 bytes)
36 <marker name> ("pstring")
37 COMM
38 <# of channels> (2 bytes)
39 <# of sound frames> (4 bytes)
40 <size of the samples> (2 bytes)
41 <sampling frequency> (10 bytes, IEEE 80-bit extended
42 floating point)
43 in AIFF-C files only:
44 <compression type> (4 bytes)
45 <human-readable version of compression type> ("pstring")
46 SSND
47 <offset> (4 bytes, not used by this program)
48 <blocksize> (4 bytes, not used by this program)
49 <sound data>
50
51A pstring consists of 1 byte length, a string of characters, and 0 or 1
52byte pad to make the total length even.
53
54Usage.
55
56Reading AIFF files:
57 f = aifc.open(file, 'r')
58where file is either the name of a file or an open file pointer.
59The open file pointer must have methods read(), seek(), and close().
60In some types of audio files, if the setpos() method is not used,
61the seek() method is not necessary.
62
63This returns an instance of a class with the following public methods:
64 getnchannels() -- returns number of audio channels (1 for
65 mono, 2 for stereo)
66 getsampwidth() -- returns sample width in bytes
67 getframerate() -- returns sampling frequency
68 getnframes() -- returns number of audio frames
69 getcomptype() -- returns compression type ('NONE' for AIFF files)
70 getcompname() -- returns human-readable version of
71 compression type ('not compressed' for AIFF files)
R David Murray4d35e752013-07-25 16:12:01 -040072 getparams() -- returns a namedtuple consisting of all of the
Guido van Rossum4acc25b2000-02-02 15:10:15 +000073 above in the above order
74 getmarkers() -- get the list of marks in the audio file or None
75 if there are no marks
76 getmark(id) -- get mark with the specified id (raises an error
77 if the mark does not exist)
78 readframes(n) -- returns at most n frames of audio
79 rewind() -- rewind to the beginning of the audio stream
80 setpos(pos) -- seek to the specified position
81 tell() -- return the current position
82 close() -- close the instance (make it unusable)
83The position returned by tell(), the position given to setpos() and
84the position of marks are all compatible and have nothing to do with
Thomas Wouters7e474022000-07-16 12:04:32 +000085the actual position in the file.
Guido van Rossum4acc25b2000-02-02 15:10:15 +000086The close() method is called automatically when the class instance
87is destroyed.
88
89Writing AIFF files:
90 f = aifc.open(file, 'w')
91where file is either the name of a file or an open file pointer.
92The open file pointer must have methods write(), tell(), seek(), and
93close().
94
95This returns an instance of a class with the following public methods:
96 aiff() -- create an AIFF file (AIFF-C default)
97 aifc() -- create an AIFF-C file
98 setnchannels(n) -- set the number of channels
99 setsampwidth(n) -- set the sample width
100 setframerate(n) -- set the frame rate
101 setnframes(n) -- set the number of frames
102 setcomptype(type, name)
103 -- set the compression type and the
104 human-readable compression type
105 setparams(tuple)
106 -- set all parameters at once
107 setmark(id, pos, name)
108 -- add specified mark to the list of marks
109 tell() -- return current position in output file (useful
110 in combination with setmark())
111 writeframesraw(data)
112 -- write audio frames without pathing up the
113 file header
114 writeframes(data)
115 -- write audio frames and patch up the file header
116 close() -- patch up the file header and close the
117 output file
118You should set the parameters before the first writeframesraw or
119writeframes. The total number of frames does not need to be set,
120but when it is set to the correct value, the header does not have to
121be patched up.
122It is best to first set all parameters, perhaps possibly the
123compression type, and then write audio frames using writeframesraw.
Serhiy Storchakae0fd7ef2015-07-10 22:13:40 +0300124When all frames have been written, either call writeframes(b'') or
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000125close() to patch up the sizes in the header.
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300126Marks can be added anytime. If there are any marks, you must call
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000127close() after all frames have been written.
128The close() method is called automatically when the class instance
129is destroyed.
130
131When a file is opened with the extension '.aiff', an AIFF file is
132written, otherwise an AIFF-C file is written. This default can be
133changed by calling aiff() or aifc() before the first writeframes or
134writeframesraw.
135"""
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000136
Guido van Rossum36bb1811996-12-31 05:57:34 +0000137import struct
Georg Brandl1a3284e2007-12-02 09:40:06 +0000138import builtins
Ezio Melotti48d578c2012-03-12 23:57:18 +0200139import warnings
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000140
Victor Stinnerac7b1a32019-06-18 00:00:24 +0200141__all__ = ["Error", "open"]
Skip Montanaroe99d5ea2001-01-20 19:54:20 +0000142
Fred Drake227b1202000-08-17 05:06:49 +0000143class Error(Exception):
144 pass
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000145
Guido van Rossume2a383d2007-01-15 16:59:06 +0000146_AIFC_version = 0xA2805140 # Version 1 of AIFF-C
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000147
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000148def _read_long(file):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000149 try:
150 return struct.unpack('>l', file.read(4))[0]
151 except struct.error:
Serhiy Storchaka5affd232017-04-05 09:37:24 +0300152 raise EOFError from None
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000153
154def _read_ulong(file):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000155 try:
156 return struct.unpack('>L', file.read(4))[0]
157 except struct.error:
Serhiy Storchaka5affd232017-04-05 09:37:24 +0300158 raise EOFError from None
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000159
160def _read_short(file):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000161 try:
162 return struct.unpack('>h', file.read(2))[0]
163 except struct.error:
Serhiy Storchaka5affd232017-04-05 09:37:24 +0300164 raise EOFError from None
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000165
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100166def _read_ushort(file):
167 try:
168 return struct.unpack('>H', file.read(2))[0]
169 except struct.error:
Serhiy Storchaka5affd232017-04-05 09:37:24 +0300170 raise EOFError from None
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100171
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000172def _read_string(file):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000173 length = ord(file.read(1))
174 if length == 0:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000175 data = b''
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000176 else:
177 data = file.read(length)
178 if length & 1 == 0:
179 dummy = file.read(1)
180 return data
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000181
182_HUGE_VAL = 1.79769313486231e+308 # See <limits.h>
183
184def _read_float(f): # 10 bytes
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000185 expon = _read_short(f) # 2 bytes
186 sign = 1
187 if expon < 0:
188 sign = -1
189 expon = expon + 0x8000
190 himant = _read_ulong(f) # 4 bytes
191 lomant = _read_ulong(f) # 4 bytes
192 if expon == himant == lomant == 0:
193 f = 0.0
194 elif expon == 0x7FFF:
195 f = _HUGE_VAL
196 else:
197 expon = expon - 16383
Guido van Rossume2a383d2007-01-15 16:59:06 +0000198 f = (himant * 0x100000000 + lomant) * pow(2.0, expon - 63)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000199 return sign * f
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000200
201def _write_short(f, x):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000202 f.write(struct.pack('>h', x))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000203
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100204def _write_ushort(f, x):
205 f.write(struct.pack('>H', x))
206
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000207def _write_long(f, x):
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100208 f.write(struct.pack('>l', x))
209
210def _write_ulong(f, x):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000211 f.write(struct.pack('>L', x))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000212
213def _write_string(f, s):
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000214 if len(s) > 255:
215 raise ValueError("string exceeds maximum pstring length")
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100216 f.write(struct.pack('B', len(s)))
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000217 f.write(s)
218 if len(s) & 1 == 0:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000219 f.write(b'\x00')
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000220
221def _write_float(f, x):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000222 import math
223 if x < 0:
224 sign = 0x8000
225 x = x * -1
226 else:
227 sign = 0
228 if x == 0:
229 expon = 0
230 himant = 0
231 lomant = 0
232 else:
233 fmant, expon = math.frexp(x)
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100234 if expon > 16384 or fmant >= 1 or fmant != fmant: # Infinity or NaN
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000235 expon = sign|0x7FFF
236 himant = 0
237 lomant = 0
238 else: # Finite
239 expon = expon + 16382
240 if expon < 0: # denormalized
241 fmant = math.ldexp(fmant, expon)
242 expon = 0
243 expon = expon | sign
244 fmant = math.ldexp(fmant, 32)
245 fsmant = math.floor(fmant)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000246 himant = int(fsmant)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000247 fmant = math.ldexp(fmant - fsmant, 32)
248 fsmant = math.floor(fmant)
Guido van Rossume2a383d2007-01-15 16:59:06 +0000249 lomant = int(fsmant)
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100250 _write_ushort(f, expon)
251 _write_ulong(f, himant)
252 _write_ulong(f, lomant)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000253
Guido van Rossum8ea7bb81999-06-09 13:32:28 +0000254from chunk import Chunk
R David Murray4d35e752013-07-25 16:12:01 -0400255from collections import namedtuple
256
257_aifc_params = namedtuple('_aifc_params',
258 'nchannels sampwidth framerate nframes comptype compname')
259
Raymond Hettinger5b798ab2015-08-17 22:04:45 -0700260_aifc_params.nchannels.__doc__ = 'Number of audio channels (1 for mono, 2 for stereo)'
Raymond Hettinger4e707722015-08-23 11:28:01 -0700261_aifc_params.sampwidth.__doc__ = 'Sample width in bytes'
Raymond Hettinger5b798ab2015-08-17 22:04:45 -0700262_aifc_params.framerate.__doc__ = 'Sampling frequency'
263_aifc_params.nframes.__doc__ = 'Number of audio frames'
264_aifc_params.comptype.__doc__ = 'Compression type ("NONE" for AIFF files)'
Raymond Hettinger4e707722015-08-23 11:28:01 -0700265_aifc_params.compname.__doc__ = ("""\
266A human-readable version of the compression type
267('not compressed' for AIFF files)""")
Raymond Hettinger5b798ab2015-08-17 22:04:45 -0700268
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000269
Guido van Rossumd3166071993-05-24 14:16:22 +0000270class Aifc_read:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000271 # Variables used in this class:
272 #
273 # These variables are available to the user though appropriate
274 # methods of this class:
275 # _file -- the open file with methods read(), close(), and seek()
276 # set through the __init__() method
277 # _nchannels -- the number of audio channels
278 # available through the getnchannels() method
279 # _nframes -- the number of audio frames
280 # available through the getnframes() method
281 # _sampwidth -- the number of bytes per audio sample
282 # available through the getsampwidth() method
283 # _framerate -- the sampling frequency
284 # available through the getframerate() method
285 # _comptype -- the AIFF-C compression type ('NONE' if AIFF)
286 # available through the getcomptype() method
287 # _compname -- the human-readable AIFF-C compression type
288 # available through the getcomptype() method
289 # _markers -- the marks in the audio file
290 # available through the getmarkers() and getmark()
291 # methods
292 # _soundpos -- the position in the audio stream
293 # available through the tell() method, set through the
294 # setpos() method
295 #
296 # These variables are used internally only:
297 # _version -- the AIFF-C version number
298 # _decomp -- the decompressor from builtin module cl
299 # _comm_chunk_read -- 1 iff the COMM chunk has been read
300 # _aifc -- 1 iff reading an AIFF-C file
301 # _ssnd_seek_needed -- 1 iff positioned correctly in audio
302 # file for readframes()
303 # _ssnd_chunk -- instantiation of a chunk class for the SSND chunk
304 # _framesize -- size of one frame in the file
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000305
INADA Naoki5dc33ee2017-02-26 21:11:58 +0900306 _file = None # Set here since __del__ checks it
307
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000308 def initfp(self, file):
309 self._version = 0
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000310 self._convert = None
311 self._markers = []
312 self._soundpos = 0
R. David Murray99352742009-05-07 18:24:38 +0000313 self._file = file
314 chunk = Chunk(file)
315 if chunk.getname() != b'FORM':
Collin Winterce36ad82007-08-30 01:19:48 +0000316 raise Error('file does not start with FORM id')
R. David Murray99352742009-05-07 18:24:38 +0000317 formdata = chunk.read(4)
Georg Brandl2095cfe2008-06-07 19:01:03 +0000318 if formdata == b'AIFF':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000319 self._aifc = 0
Georg Brandl2095cfe2008-06-07 19:01:03 +0000320 elif formdata == b'AIFC':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000321 self._aifc = 1
322 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000323 raise Error('not an AIFF or AIFF-C file')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000324 self._comm_chunk_read = 0
Zackery Spytz80d20b92018-02-20 14:06:11 -0700325 self._ssnd_chunk = None
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000326 while 1:
327 self._ssnd_seek_needed = 1
328 try:
329 chunk = Chunk(self._file)
330 except EOFError:
331 break
332 chunkname = chunk.getname()
Georg Brandl2095cfe2008-06-07 19:01:03 +0000333 if chunkname == b'COMM':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000334 self._read_comm_chunk(chunk)
335 self._comm_chunk_read = 1
Georg Brandl2095cfe2008-06-07 19:01:03 +0000336 elif chunkname == b'SSND':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000337 self._ssnd_chunk = chunk
338 dummy = chunk.read(8)
339 self._ssnd_seek_needed = 0
Georg Brandl2095cfe2008-06-07 19:01:03 +0000340 elif chunkname == b'FVER':
Guido van Rossum820819c2002-08-12 22:11:28 +0000341 self._version = _read_ulong(chunk)
Georg Brandl2095cfe2008-06-07 19:01:03 +0000342 elif chunkname == b'MARK':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000343 self._readmark(chunk)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000344 chunk.skip()
345 if not self._comm_chunk_read or not self._ssnd_chunk:
Collin Winterce36ad82007-08-30 01:19:48 +0000346 raise Error('COMM chunk and/or SSND chunk missing')
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000347
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000348 def __init__(self, f):
Georg Brandl2095cfe2008-06-07 19:01:03 +0000349 if isinstance(f, str):
Anthony Zhang03f68b62017-02-22 02:23:30 -0500350 file_object = builtins.open(f, 'rb')
351 try:
352 self.initfp(file_object)
353 except:
354 file_object.close()
355 raise
356 else:
357 # assume it is an open file object already
358 self.initfp(f)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000359
Serhiy Storchaka44c66c72012-12-29 22:54:49 +0200360 def __enter__(self):
361 return self
362
363 def __exit__(self, *args):
364 self.close()
365
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000366 #
367 # User visible methods.
368 #
369 def getfp(self):
370 return self._file
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000371
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000372 def rewind(self):
373 self._ssnd_seek_needed = 1
374 self._soundpos = 0
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000375
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000376 def close(self):
Serhiy Storchaka7e7a3db2015-04-10 13:24:41 +0300377 file = self._file
378 if file is not None:
379 self._file = None
380 file.close()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000381
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000382 def tell(self):
383 return self._soundpos
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000384
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000385 def getnchannels(self):
386 return self._nchannels
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000387
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000388 def getnframes(self):
389 return self._nframes
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000390
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000391 def getsampwidth(self):
392 return self._sampwidth
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000393
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000394 def getframerate(self):
395 return self._framerate
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000396
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000397 def getcomptype(self):
398 return self._comptype
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000399
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000400 def getcompname(self):
401 return self._compname
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000402
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000403## def getversion(self):
404## return self._version
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000405
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000406 def getparams(self):
R David Murray4d35e752013-07-25 16:12:01 -0400407 return _aifc_params(self.getnchannels(), self.getsampwidth(),
408 self.getframerate(), self.getnframes(),
409 self.getcomptype(), self.getcompname())
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000410
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000411 def getmarkers(self):
412 if len(self._markers) == 0:
413 return None
414 return self._markers
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000415
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000416 def getmark(self, id):
417 for marker in self._markers:
418 if id == marker[0]:
419 return marker
Georg Brandl2095cfe2008-06-07 19:01:03 +0000420 raise Error('marker {0!r} does not exist'.format(id))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000421
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000422 def setpos(self, pos):
423 if pos < 0 or pos > self._nframes:
Collin Winterce36ad82007-08-30 01:19:48 +0000424 raise Error('position not in range')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000425 self._soundpos = pos
426 self._ssnd_seek_needed = 1
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000427
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000428 def readframes(self, nframes):
429 if self._ssnd_seek_needed:
430 self._ssnd_chunk.seek(0)
431 dummy = self._ssnd_chunk.read(8)
432 pos = self._soundpos * self._framesize
433 if pos:
Guido van Rossum2663c132000-03-07 15:19:31 +0000434 self._ssnd_chunk.seek(pos + 8)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000435 self._ssnd_seek_needed = 0
436 if nframes == 0:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000437 return b''
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000438 data = self._ssnd_chunk.read(nframes * self._framesize)
439 if self._convert and data:
440 data = self._convert(data)
Georg Brandl2095cfe2008-06-07 19:01:03 +0000441 self._soundpos = self._soundpos + len(data) // (self._nchannels
442 * self._sampwidth)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000443 return data
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000444
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000445 #
446 # Internal methods.
447 #
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000448
Georg Brandl2095cfe2008-06-07 19:01:03 +0000449 def _alaw2lin(self, data):
450 import audioop
451 return audioop.alaw2lin(data, 2)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000452
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000453 def _ulaw2lin(self, data):
454 import audioop
455 return audioop.ulaw2lin(data, 2)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000456
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000457 def _adpcm2lin(self, data):
458 import audioop
459 if not hasattr(self, '_adpcmstate'):
460 # first time
461 self._adpcmstate = None
Georg Brandl2095cfe2008-06-07 19:01:03 +0000462 data, self._adpcmstate = audioop.adpcm2lin(data, 2, self._adpcmstate)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000463 return data
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000464
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000465 def _read_comm_chunk(self, chunk):
466 self._nchannels = _read_short(chunk)
467 self._nframes = _read_long(chunk)
Georg Brandl2095cfe2008-06-07 19:01:03 +0000468 self._sampwidth = (_read_short(chunk) + 7) // 8
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000469 self._framerate = int(_read_float(chunk))
Serhiy Storchaka134cb012018-03-18 09:55:53 +0200470 if self._sampwidth <= 0:
471 raise Error('bad sample width')
472 if self._nchannels <= 0:
473 raise Error('bad # of channels')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000474 self._framesize = self._nchannels * self._sampwidth
475 if self._aifc:
476 #DEBUG: SGI's soundeditor produces a bad size :-(
477 kludge = 0
478 if chunk.chunksize == 18:
479 kludge = 1
Ezio Melotti48d578c2012-03-12 23:57:18 +0200480 warnings.warn('Warning: bad COMM chunk size')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000481 chunk.chunksize = 23
482 #DEBUG end
483 self._comptype = chunk.read(4)
484 #DEBUG start
485 if kludge:
486 length = ord(chunk.file.read(1))
487 if length & 1 == 0:
488 length = length + 1
489 chunk.chunksize = chunk.chunksize + length
490 chunk.file.seek(-1, 1)
491 #DEBUG end
492 self._compname = _read_string(chunk)
Georg Brandl2095cfe2008-06-07 19:01:03 +0000493 if self._comptype != b'NONE':
494 if self._comptype == b'G722':
495 self._convert = self._adpcm2lin
Georg Brandl2095cfe2008-06-07 19:01:03 +0000496 elif self._comptype in (b'ulaw', b'ULAW'):
497 self._convert = self._ulaw2lin
Georg Brandl2095cfe2008-06-07 19:01:03 +0000498 elif self._comptype in (b'alaw', b'ALAW'):
499 self._convert = self._alaw2lin
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000500 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000501 raise Error('unsupported compression type')
Serhiy Storchaka4b532592013-10-12 18:21:33 +0300502 self._sampwidth = 2
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000503 else:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000504 self._comptype = b'NONE'
505 self._compname = b'not compressed'
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000506
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000507 def _readmark(self, chunk):
508 nmarkers = _read_short(chunk)
509 # Some files appear to contain invalid counts.
510 # Cope with this by testing for EOF.
511 try:
512 for i in range(nmarkers):
513 id = _read_short(chunk)
514 pos = _read_long(chunk)
515 name = _read_string(chunk)
516 if pos or name:
517 # some files appear to have
518 # dummy markers consisting of
519 # a position 0 and name ''
520 self._markers.append((id, pos, name))
521 except EOFError:
Ezio Melotti48d578c2012-03-12 23:57:18 +0200522 w = ('Warning: MARK chunk contains only %s marker%s instead of %s' %
523 (len(self._markers), '' if len(self._markers) == 1 else 's',
524 nmarkers))
525 warnings.warn(w)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000526
Guido van Rossumd3166071993-05-24 14:16:22 +0000527class Aifc_write:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000528 # Variables used in this class:
529 #
530 # These variables are user settable through appropriate methods
531 # of this class:
532 # _file -- the open file with methods write(), close(), tell(), seek()
533 # set through the __init__() method
534 # _comptype -- the AIFF-C compression type ('NONE' in AIFF)
535 # set through the setcomptype() or setparams() method
536 # _compname -- the human-readable AIFF-C compression type
537 # set through the setcomptype() or setparams() method
538 # _nchannels -- the number of audio channels
539 # set through the setnchannels() or setparams() method
540 # _sampwidth -- the number of bytes per audio sample
541 # set through the setsampwidth() or setparams() method
542 # _framerate -- the sampling frequency
543 # set through the setframerate() or setparams() method
544 # _nframes -- the number of audio frames written to the header
545 # set through the setnframes() or setparams() method
546 # _aifc -- whether we're writing an AIFF-C file or an AIFF file
547 # set through the aifc() method, reset through the
548 # aiff() method
549 #
550 # These variables are used internally only:
551 # _version -- the AIFF-C version number
552 # _comp -- the compressor from builtin module cl
553 # _nframeswritten -- the number of audio frames actually written
554 # _datalength -- the size of the audio samples written to the header
555 # _datawritten -- the size of the audio samples actually written
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000556
INADA Naoki5dc33ee2017-02-26 21:11:58 +0900557 _file = None # Set here since __del__ checks it
558
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000559 def __init__(self, f):
Georg Brandl2095cfe2008-06-07 19:01:03 +0000560 if isinstance(f, str):
Anthony Zhang03f68b62017-02-22 02:23:30 -0500561 file_object = builtins.open(f, 'wb')
562 try:
563 self.initfp(file_object)
564 except:
565 file_object.close()
566 raise
567
568 # treat .aiff file extensions as non-compressed audio
569 if f.endswith('.aiff'):
570 self._aifc = 0
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000571 else:
Anthony Zhang03f68b62017-02-22 02:23:30 -0500572 # assume it is an open file object already
573 self.initfp(f)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000574
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000575 def initfp(self, file):
576 self._file = file
577 self._version = _AIFC_version
Georg Brandl2095cfe2008-06-07 19:01:03 +0000578 self._comptype = b'NONE'
579 self._compname = b'not compressed'
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000580 self._convert = None
581 self._nchannels = 0
582 self._sampwidth = 0
583 self._framerate = 0
584 self._nframes = 0
585 self._nframeswritten = 0
586 self._datawritten = 0
587 self._datalength = 0
588 self._markers = []
589 self._marklength = 0
590 self._aifc = 1 # AIFF-C is default
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000591
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000592 def __del__(self):
Sandro Tosi70efbef2012-01-01 22:53:08 +0100593 self.close()
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000594
Serhiy Storchaka44c66c72012-12-29 22:54:49 +0200595 def __enter__(self):
596 return self
597
598 def __exit__(self, *args):
599 self.close()
600
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000601 #
602 # User visible methods.
603 #
604 def aiff(self):
605 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000606 raise Error('cannot change parameters after starting to write')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000607 self._aifc = 0
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000608
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000609 def aifc(self):
610 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000611 raise Error('cannot change parameters after starting to write')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000612 self._aifc = 1
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000613
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000614 def setnchannels(self, nchannels):
615 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000616 raise Error('cannot change parameters after starting to write')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000617 if nchannels < 1:
Collin Winterce36ad82007-08-30 01:19:48 +0000618 raise Error('bad # of channels')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000619 self._nchannels = nchannels
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000620
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000621 def getnchannels(self):
622 if not self._nchannels:
Collin Winterce36ad82007-08-30 01:19:48 +0000623 raise Error('number of channels not set')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000624 return self._nchannels
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000625
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000626 def setsampwidth(self, sampwidth):
627 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000628 raise Error('cannot change parameters after starting to write')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000629 if sampwidth < 1 or sampwidth > 4:
Collin Winterce36ad82007-08-30 01:19:48 +0000630 raise Error('bad sample width')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000631 self._sampwidth = sampwidth
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000632
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000633 def getsampwidth(self):
634 if not self._sampwidth:
Collin Winterce36ad82007-08-30 01:19:48 +0000635 raise Error('sample width not set')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000636 return self._sampwidth
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000637
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000638 def setframerate(self, framerate):
639 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000640 raise Error('cannot change parameters after starting to write')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000641 if framerate <= 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000642 raise Error('bad frame rate')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000643 self._framerate = framerate
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000644
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000645 def getframerate(self):
646 if not self._framerate:
Collin Winterce36ad82007-08-30 01:19:48 +0000647 raise Error('frame rate not set')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000648 return self._framerate
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000649
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000650 def setnframes(self, nframes):
651 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000652 raise Error('cannot change parameters after starting to write')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000653 self._nframes = nframes
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000654
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000655 def getnframes(self):
656 return self._nframeswritten
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000657
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000658 def setcomptype(self, comptype, compname):
659 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000660 raise Error('cannot change parameters after starting to write')
Georg Brandl2095cfe2008-06-07 19:01:03 +0000661 if comptype not in (b'NONE', b'ulaw', b'ULAW',
662 b'alaw', b'ALAW', b'G722'):
Collin Winterce36ad82007-08-30 01:19:48 +0000663 raise Error('unsupported compression type')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000664 self._comptype = comptype
665 self._compname = compname
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000666
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000667 def getcomptype(self):
668 return self._comptype
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000669
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000670 def getcompname(self):
671 return self._compname
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000672
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000673## def setversion(self, version):
674## if self._nframeswritten:
675## raise Error, 'cannot change parameters after starting to write'
676## self._version = version
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000677
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000678 def setparams(self, params):
679 nchannels, sampwidth, framerate, nframes, comptype, compname = params
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000680 if self._nframeswritten:
Collin Winterce36ad82007-08-30 01:19:48 +0000681 raise Error('cannot change parameters after starting to write')
Georg Brandl2095cfe2008-06-07 19:01:03 +0000682 if comptype not in (b'NONE', b'ulaw', b'ULAW',
683 b'alaw', b'ALAW', b'G722'):
Collin Winterce36ad82007-08-30 01:19:48 +0000684 raise Error('unsupported compression type')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000685 self.setnchannels(nchannels)
686 self.setsampwidth(sampwidth)
687 self.setframerate(framerate)
688 self.setnframes(nframes)
689 self.setcomptype(comptype, compname)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000690
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000691 def getparams(self):
692 if not self._nchannels or not self._sampwidth or not self._framerate:
Collin Winterce36ad82007-08-30 01:19:48 +0000693 raise Error('not all parameters set')
R David Murray4d35e752013-07-25 16:12:01 -0400694 return _aifc_params(self._nchannels, self._sampwidth, self._framerate,
695 self._nframes, self._comptype, self._compname)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000696
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000697 def setmark(self, id, pos, name):
698 if id <= 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000699 raise Error('marker ID must be > 0')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000700 if pos < 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000701 raise Error('marker position must be >= 0')
Sandro Tosi70efbef2012-01-01 22:53:08 +0100702 if not isinstance(name, bytes):
703 raise Error('marker name must be bytes')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000704 for i in range(len(self._markers)):
705 if id == self._markers[i][0]:
706 self._markers[i] = id, pos, name
707 return
708 self._markers.append((id, pos, name))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000709
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000710 def getmark(self, id):
711 for marker in self._markers:
712 if id == marker[0]:
713 return marker
Georg Brandl2095cfe2008-06-07 19:01:03 +0000714 raise Error('marker {0!r} does not exist'.format(id))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000715
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000716 def getmarkers(self):
717 if len(self._markers) == 0:
718 return None
719 return self._markers
Tim Peters146965a2001-01-14 18:09:23 +0000720
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000721 def tell(self):
722 return self._nframeswritten
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000723
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000724 def writeframesraw(self, data):
Serhiy Storchaka452bab42013-11-16 14:01:31 +0200725 if not isinstance(data, (bytes, bytearray)):
726 data = memoryview(data).cast('B')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000727 self._ensure_header_written(len(data))
Georg Brandl2095cfe2008-06-07 19:01:03 +0000728 nframes = len(data) // (self._sampwidth * self._nchannels)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000729 if self._convert:
730 data = self._convert(data)
731 self._file.write(data)
732 self._nframeswritten = self._nframeswritten + nframes
733 self._datawritten = self._datawritten + len(data)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000734
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000735 def writeframes(self, data):
736 self.writeframesraw(data)
737 if self._nframeswritten != self._nframes or \
738 self._datalength != self._datawritten:
739 self._patchheader()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000740
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000741 def close(self):
Serhiy Storchaka051722d2012-12-29 22:30:56 +0200742 if self._file is None:
743 return
744 try:
Sandro Tosi70efbef2012-01-01 22:53:08 +0100745 self._ensure_header_written(0)
746 if self._datawritten & 1:
747 # quick pad to even size
748 self._file.write(b'\x00')
749 self._datawritten = self._datawritten + 1
750 self._writemarkers()
751 if self._nframeswritten != self._nframes or \
752 self._datalength != self._datawritten or \
753 self._marklength:
754 self._patchheader()
Serhiy Storchaka051722d2012-12-29 22:30:56 +0200755 finally:
Sandro Tosi70efbef2012-01-01 22:53:08 +0100756 # Prevent ref cycles
757 self._convert = None
Serhiy Storchaka051722d2012-12-29 22:30:56 +0200758 f = self._file
Sandro Tosi70efbef2012-01-01 22:53:08 +0100759 self._file = None
Serhiy Storchaka051722d2012-12-29 22:30:56 +0200760 f.close()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000761
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000762 #
763 # Internal methods.
764 #
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000765
Georg Brandl2095cfe2008-06-07 19:01:03 +0000766 def _lin2alaw(self, data):
767 import audioop
768 return audioop.lin2alaw(data, 2)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000769
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000770 def _lin2ulaw(self, data):
771 import audioop
772 return audioop.lin2ulaw(data, 2)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000773
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000774 def _lin2adpcm(self, data):
775 import audioop
776 if not hasattr(self, '_adpcmstate'):
777 self._adpcmstate = None
Georg Brandl2095cfe2008-06-07 19:01:03 +0000778 data, self._adpcmstate = audioop.lin2adpcm(data, 2, self._adpcmstate)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000779 return data
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000780
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000781 def _ensure_header_written(self, datasize):
782 if not self._nframeswritten:
Sandro Tosibdd53542012-01-01 18:04:37 +0100783 if self._comptype in (b'ULAW', b'ulaw', b'ALAW', b'alaw', b'G722'):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000784 if not self._sampwidth:
785 self._sampwidth = 2
786 if self._sampwidth != 2:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000787 raise Error('sample width must be 2 when compressing '
Sandro Tosibdd53542012-01-01 18:04:37 +0100788 'with ulaw/ULAW, alaw/ALAW or G7.22 (ADPCM)')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000789 if not self._nchannels:
Collin Winterce36ad82007-08-30 01:19:48 +0000790 raise Error('# channels not specified')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000791 if not self._sampwidth:
Collin Winterce36ad82007-08-30 01:19:48 +0000792 raise Error('sample width not specified')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000793 if not self._framerate:
Collin Winterce36ad82007-08-30 01:19:48 +0000794 raise Error('sampling rate not specified')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000795 self._write_header(datasize)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000796
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000797 def _init_compression(self):
Georg Brandl2095cfe2008-06-07 19:01:03 +0000798 if self._comptype == b'G722':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000799 self._convert = self._lin2adpcm
Georg Brandl2095cfe2008-06-07 19:01:03 +0000800 elif self._comptype in (b'ulaw', b'ULAW'):
801 self._convert = self._lin2ulaw
802 elif self._comptype in (b'alaw', b'ALAW'):
803 self._convert = self._lin2alaw
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000804
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000805 def _write_header(self, initlength):
Georg Brandl2095cfe2008-06-07 19:01:03 +0000806 if self._aifc and self._comptype != b'NONE':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000807 self._init_compression()
Georg Brandl2095cfe2008-06-07 19:01:03 +0000808 self._file.write(b'FORM')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000809 if not self._nframes:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000810 self._nframes = initlength // (self._nchannels * self._sampwidth)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000811 self._datalength = self._nframes * self._nchannels * self._sampwidth
812 if self._datalength & 1:
813 self._datalength = self._datalength + 1
814 if self._aifc:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000815 if self._comptype in (b'ulaw', b'ULAW', b'alaw', b'ALAW'):
816 self._datalength = self._datalength // 2
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000817 if self._datalength & 1:
818 self._datalength = self._datalength + 1
Georg Brandl2095cfe2008-06-07 19:01:03 +0000819 elif self._comptype == b'G722':
820 self._datalength = (self._datalength + 3) // 4
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000821 if self._datalength & 1:
822 self._datalength = self._datalength + 1
Serhiy Storchaka84d28b42013-12-14 20:35:04 +0200823 try:
824 self._form_length_pos = self._file.tell()
825 except (AttributeError, OSError):
826 self._form_length_pos = None
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000827 commlength = self._write_form_length(self._datalength)
828 if self._aifc:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000829 self._file.write(b'AIFC')
830 self._file.write(b'FVER')
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100831 _write_ulong(self._file, 4)
832 _write_ulong(self._file, self._version)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000833 else:
Georg Brandl2095cfe2008-06-07 19:01:03 +0000834 self._file.write(b'AIFF')
835 self._file.write(b'COMM')
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100836 _write_ulong(self._file, commlength)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000837 _write_short(self._file, self._nchannels)
Serhiy Storchaka84d28b42013-12-14 20:35:04 +0200838 if self._form_length_pos is not None:
839 self._nframes_pos = self._file.tell()
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100840 _write_ulong(self._file, self._nframes)
Serhiy Storchaka4b532592013-10-12 18:21:33 +0300841 if self._comptype in (b'ULAW', b'ulaw', b'ALAW', b'alaw', b'G722'):
842 _write_short(self._file, 8)
843 else:
844 _write_short(self._file, self._sampwidth * 8)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000845 _write_float(self._file, self._framerate)
846 if self._aifc:
847 self._file.write(self._comptype)
848 _write_string(self._file, self._compname)
Georg Brandl2095cfe2008-06-07 19:01:03 +0000849 self._file.write(b'SSND')
Serhiy Storchaka84d28b42013-12-14 20:35:04 +0200850 if self._form_length_pos is not None:
851 self._ssnd_length_pos = self._file.tell()
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100852 _write_ulong(self._file, self._datalength + 8)
853 _write_ulong(self._file, 0)
854 _write_ulong(self._file, 0)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000855
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000856 def _write_form_length(self, datalength):
857 if self._aifc:
858 commlength = 18 + 5 + len(self._compname)
859 if commlength & 1:
860 commlength = commlength + 1
861 verslength = 12
862 else:
863 commlength = 18
864 verslength = 0
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100865 _write_ulong(self._file, 4 + verslength + self._marklength + \
866 8 + commlength + 16 + datalength)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000867 return commlength
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000868
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000869 def _patchheader(self):
870 curpos = self._file.tell()
871 if self._datawritten & 1:
872 datalength = self._datawritten + 1
Georg Brandl2095cfe2008-06-07 19:01:03 +0000873 self._file.write(b'\x00')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000874 else:
875 datalength = self._datawritten
876 if datalength == self._datalength and \
877 self._nframes == self._nframeswritten and \
878 self._marklength == 0:
879 self._file.seek(curpos, 0)
880 return
881 self._file.seek(self._form_length_pos, 0)
882 dummy = self._write_form_length(datalength)
883 self._file.seek(self._nframes_pos, 0)
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100884 _write_ulong(self._file, self._nframeswritten)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000885 self._file.seek(self._ssnd_length_pos, 0)
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100886 _write_ulong(self._file, datalength + 8)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000887 self._file.seek(curpos, 0)
888 self._nframes = self._nframeswritten
889 self._datalength = datalength
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000890
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000891 def _writemarkers(self):
892 if len(self._markers) == 0:
893 return
Georg Brandl2095cfe2008-06-07 19:01:03 +0000894 self._file.write(b'MARK')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000895 length = 2
896 for marker in self._markers:
897 id, pos, name = marker
898 length = length + len(name) + 1 + 6
899 if len(name) & 1 == 0:
900 length = length + 1
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100901 _write_ulong(self._file, length)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000902 self._marklength = length + 8
903 _write_short(self._file, len(self._markers))
904 for marker in self._markers:
905 id, pos, name = marker
906 _write_short(self._file, id)
Antoine Pitrou03757ec2012-01-17 17:13:04 +0100907 _write_ulong(self._file, pos)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000908 _write_string(self._file, name)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000909
Fred Drake43161351999-06-22 21:23:23 +0000910def open(f, mode=None):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000911 if mode is None:
912 if hasattr(f, 'mode'):
913 mode = f.mode
914 else:
915 mode = 'rb'
916 if mode in ('r', 'rb'):
917 return Aifc_read(f)
918 elif mode in ('w', 'wb'):
919 return Aifc_write(f)
920 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000921 raise Error("mode must be 'r', 'rb', 'w', or 'wb'")
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000922
Guido van Rossum36bb1811996-12-31 05:57:34 +0000923
924if __name__ == '__main__':
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000925 import sys
926 if not sys.argv[1:]:
927 sys.argv.append('/usr/demos/data/audio/bach.aiff')
928 fn = sys.argv[1]
Serhiy Storchaka58b3ebf2013-08-25 19:16:01 +0300929 with open(fn, 'r') as f:
Serhiy Storchakab33baf12013-08-25 19:12:56 +0300930 print("Reading", fn)
931 print("nchannels =", f.getnchannels())
932 print("nframes =", f.getnframes())
933 print("sampwidth =", f.getsampwidth())
934 print("framerate =", f.getframerate())
935 print("comptype =", f.getcomptype())
936 print("compname =", f.getcompname())
937 if sys.argv[2:]:
938 gn = sys.argv[2]
939 print("Writing", gn)
Serhiy Storchaka58b3ebf2013-08-25 19:16:01 +0300940 with open(gn, 'w') as g:
Serhiy Storchakab33baf12013-08-25 19:12:56 +0300941 g.setparams(f.getparams())
942 while 1:
943 data = f.readframes(1024)
944 if not data:
945 break
946 g.writeframes(data)
Serhiy Storchakab33baf12013-08-25 19:12:56 +0300947 print("Done.")