blob: 22bff01916d4ee5a1d6f9c337a9e65d2d4656761 [file] [log] [blame]
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +00001# Stuff to parse AIFF-C and AIFF files.
2#
3# Unless explicitly stated otherwise, the description below is true
4# both for AIFF-C files and AIFF files.
5#
6# An 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#
21# An AIFF file has the string "AIFF" instead of "AIFC".
22#
23# A chunk consists of an identifier (4 bytes) followed by a size (4 bytes,
24# big endian order), followed by the data. The size field does not include
25# the size of the 8 byte header.
26#
27# The 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)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +000043# in AIFF-C files only:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +000044# <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#
51# A pstring consists of 1 byte length, a string of characters, and 0 or 1
52# byte pad to make the total length even.
53#
54# Usage.
55#
56# Reading AIFF files:
57# f = aifc.open(file, 'r')
Sjoerd Mullender2a451411993-12-20 09:36:01 +000058# where file is either the name of a file or an open file pointer.
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +000059# The open file pointer must have methods read(), seek(), and close().
60# In some types of audio files, if the setpos() method is not used,
61# the seek() method is not necessary.
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +000062#
63# This 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)
72# getparams() -- returns a tuple consisting of all of the
73# 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
Guido van Rossum17ed1ae1993-06-01 13:21:04 +000082# close() -- close the instance (make it unusable)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +000083# The position returned by tell(), the position given to setpos() and
84# the position of marks are all compatible and have nothing to do with
85# the actual postion in the file.
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +000086# The close() method is called automatically when the class instance
87# is destroyed.
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +000088#
89# Writing AIFF files:
90# f = aifc.open(file, 'w')
Sjoerd Mullender2a451411993-12-20 09:36:01 +000091# where file is either the name of a file or an open file pointer.
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +000092# The open file pointer must have methods write(), tell(), seek(), and
93# close().
94#
95# This 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(nchannels, sampwidth, framerate, nframes, comptype, compname)
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
118# You should set the parameters before the first writeframesraw or
119# writeframes. The total number of frames does not need to be set,
120# but when it is set to the correct value, the header does not have to
121# be patched up.
122# It is best to first set all parameters, perhaps possibly the
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000123# compression type, and then write audio frames using writeframesraw.
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000124# When all frames have been written, either call writeframes('') or
125# close() to patch up the sizes in the header.
126# Marks can be added anytime. If there are any marks, ypu must call
127# close() after all frames have been written.
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000128# The close() method is called automatically when the class instance
129# is destroyed.
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000130#
131# When a file is opened with the extension '.aiff', an AIFF file is
132# written, otherwise an AIFF-C file is written. This default can be
133# changed by calling aiff() or aifc() before the first writeframes or
134# writeframesraw.
135
Guido van Rossum3db6ebc1994-01-28 09:59:35 +0000136import __builtin__
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000137try:
138 import CL
139except ImportError:
140 pass
141
142Error = 'aifc.Error'
143
144_AIFC_version = 0xA2805140 # Version 1 of AIFF-C
145
146_skiplist = 'COMT', 'INST', 'MIDI', 'AESD', \
147 'APPL', 'NAME', 'AUTH', '(c) ', 'ANNO'
148
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000149def _read_long(file):
150 x = 0L
151 for i in range(4):
152 byte = file.read(1)
153 if byte == '':
154 raise EOFError
155 x = x*256 + ord(byte)
156 if x >= 0x80000000L:
157 x = x - 0x100000000L
158 return int(x)
159
160def _read_ulong(file):
161 x = 0L
162 for i in range(4):
163 byte = file.read(1)
164 if byte == '':
165 raise EOFError
166 x = x*256 + ord(byte)
167 return x
168
169def _read_short(file):
170 x = 0
171 for i in range(2):
172 byte = file.read(1)
173 if byte == '':
174 raise EOFError
175 x = x*256 + ord(byte)
176 if x >= 0x8000:
177 x = x - 0x10000
178 return x
179
180def _read_string(file):
181 length = ord(file.read(1))
Guido van Rossumb6775db1994-08-01 11:34:53 +0000182 if length == 0:
183 data = ''
184 else:
185 data = file.read(length)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000186 if length & 1 == 0:
187 dummy = file.read(1)
188 return data
189
190_HUGE_VAL = 1.79769313486231e+308 # See <limits.h>
191
192def _read_float(f): # 10 bytes
193 import math
194 expon = _read_short(f) # 2 bytes
195 sign = 1
196 if expon < 0:
197 sign = -1
198 expon = expon + 0x8000
199 himant = _read_ulong(f) # 4 bytes
200 lomant = _read_ulong(f) # 4 bytes
201 if expon == himant == lomant == 0:
202 f = 0.0
203 elif expon == 0x7FFF:
204 f = _HUGE_VAL
205 else:
206 expon = expon - 16383
207 f = (himant * 0x100000000L + lomant) * pow(2.0, expon - 63)
208 return sign * f
209
210def _write_short(f, x):
211 d, m = divmod(x, 256)
212 f.write(chr(d))
213 f.write(chr(m))
214
215def _write_long(f, x):
216 if x < 0:
217 x = x + 0x100000000L
218 data = []
219 for i in range(4):
220 d, m = divmod(x, 256)
221 data.insert(0, m)
222 x = d
223 for i in range(4):
224 f.write(chr(int(data[i])))
225
226def _write_string(f, s):
227 f.write(chr(len(s)))
228 f.write(s)
229 if len(s) & 1 == 0:
230 f.write(chr(0))
231
232def _write_float(f, x):
233 import math
234 if x < 0:
235 sign = 0x8000
236 x = x * -1
237 else:
238 sign = 0
239 if x == 0:
240 expon = 0
241 himant = 0
242 lomant = 0
243 else:
244 fmant, expon = math.frexp(x)
245 if expon > 16384 or fmant >= 1: # Infinity or NaN
246 expon = sign|0x7FFF
247 himant = 0
248 lomant = 0
249 else: # Finite
250 expon = expon + 16382
251 if expon < 0: # denormalized
252 fmant = math.ldexp(fmant, expon)
253 expon = 0
254 expon = expon | sign
255 fmant = math.ldexp(fmant, 32)
256 fsmant = math.floor(fmant)
257 himant = long(fsmant)
258 fmant = math.ldexp(fmant - fsmant, 32)
259 fsmant = math.floor(fmant)
260 lomant = long(fsmant)
261 _write_short(f, expon)
262 _write_long(f, himant)
263 _write_long(f, lomant)
264
Guido van Rossumd3166071993-05-24 14:16:22 +0000265class Chunk:
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000266 def __init__(self, file):
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000267 self.file = file
268 self.chunkname = self.file.read(4)
269 if len(self.chunkname) < 4:
270 raise EOFError
271 self.chunksize = _read_long(self.file)
272 self.size_read = 0
273 self.offset = self.file.tell()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000274
275 def rewind(self):
276 self.file.seek(self.offset, 0)
277 self.size_read = 0
278
279 def setpos(self, pos):
280 if pos < 0 or pos > self.chunksize:
281 raise RuntimeError
282 self.file.seek(self.offset + pos, 0)
283 self.size_read = pos
284
285 def read(self, length):
286 if self.size_read >= self.chunksize:
287 return ''
288 if length > self.chunksize - self.size_read:
289 length = self.chunksize - self.size_read
290 data = self.file.read(length)
291 self.size_read = self.size_read + len(data)
292 return data
293
294 def skip(self):
295 try:
296 self.file.seek(self.chunksize - self.size_read, 1)
297 except RuntimeError:
298 while self.size_read < self.chunksize:
299 dummy = self.read(8192)
300 if not dummy:
301 raise EOFError
302 if self.chunksize & 1:
303 dummy = self.read(1)
304
Guido van Rossumd3166071993-05-24 14:16:22 +0000305class Aifc_read:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000306 # Variables used in this class:
307 #
308 # These variables are available to the user though appropriate
309 # methods of this class:
310 # _file -- the open file with methods read(), close(), and seek()
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000311 # set through the __init__() method
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000312 # _nchannels -- the number of audio channels
313 # available through the getnchannels() method
314 # _nframes -- the number of audio frames
315 # available through the getnframes() method
316 # _sampwidth -- the number of bytes per audio sample
317 # available through the getsampwidth() method
318 # _framerate -- the sampling frequency
319 # available through the getframerate() method
320 # _comptype -- the AIFF-C compression type ('NONE' if AIFF)
321 # available through the getcomptype() method
322 # _compname -- the human-readable AIFF-C compression type
323 # available through the getcomptype() method
324 # _markers -- the marks in the audio file
325 # available through the getmarkers() and getmark()
326 # methods
327 # _soundpos -- the position in the audio stream
328 # available through the tell() method, set through the
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000329 # setpos() method
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000330 #
331 # These variables are used internally only:
332 # _version -- the AIFF-C version number
333 # _decomp -- the decompressor from builtin module cl
334 # _comm_chunk_read -- 1 iff the COMM chunk has been read
335 # _aifc -- 1 iff reading an AIFF-C file
336 # _ssnd_seek_needed -- 1 iff positioned correctly in audio
337 # file for readframes()
338 # _ssnd_chunk -- instantiation of a chunk class for the SSND chunk
Sjoerd Mullender3a997271993-02-04 16:43:28 +0000339 # _framesize -- size of one frame in the file
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000340
341 access _file, _nchannels, _nframes, _sampwidth, _framerate, \
342 _comptype, _compname, _markers, _soundpos, _version, \
343 _decomp, _comm_chunk_read, __aifc, _ssnd_seek_needed, \
344 _ssnd_chunk, _framesize: private
345
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000346 def initfp(self, file):
347 self._file = file
348 self._version = 0
349 self._decomp = None
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000350 self._convert = None
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000351 self._markers = []
352 self._soundpos = 0
353 form = self._file.read(4)
354 if form != 'FORM':
355 raise Error, 'file does not start with FORM id'
356 formlength = _read_long(self._file)
357 if formlength <= 0:
358 raise Error, 'invalid FORM chunk data size'
359 formdata = self._file.read(4)
360 formlength = formlength - 4
361 if formdata == 'AIFF':
362 self._aifc = 0
363 elif formdata == 'AIFC':
364 self._aifc = 1
365 else:
366 raise Error, 'not an AIFF or AIFF-C file'
367 self._comm_chunk_read = 0
Sjoerd Mullender7564a641993-01-22 14:26:28 +0000368 while formlength > 0:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000369 self._ssnd_seek_needed = 1
Sjoerd Mullender8d733a01993-01-29 12:01:00 +0000370 #DEBUG: SGI's soundfiler has a bug. There should
371 # be no need to check for EOF here.
372 try:
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000373 chunk = Chunk(self._file)
Sjoerd Mullender8d733a01993-01-29 12:01:00 +0000374 except EOFError:
375 if formlength == 8:
376 print 'Warning: FORM chunk size too large'
377 formlength = 0
378 break
379 raise EOFError # different error, raise exception
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000380 if chunk.chunkname == 'COMM':
381 self._read_comm_chunk(chunk)
382 self._comm_chunk_read = 1
383 elif chunk.chunkname == 'SSND':
384 self._ssnd_chunk = chunk
385 dummy = chunk.read(8)
386 self._ssnd_seek_needed = 0
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000387 elif chunk.chunkname == 'FVER':
388 self._version = _read_long(chunk)
389 elif chunk.chunkname == 'MARK':
390 self._readmark(chunk)
391 elif chunk.chunkname in _skiplist:
392 pass
393 else:
394 raise Error, 'unrecognized chunk type '+chunk.chunkname
Sjoerd Mullender4150ede1993-08-26 14:12:07 +0000395 formlength = formlength - 8 - chunk.chunksize
396 if chunk.chunksize & 1:
397 formlength = formlength - 1
Sjoerd Mullender93f07401993-01-26 09:24:37 +0000398 if formlength > 0:
399 chunk.skip()
Sjoerd Mullender7564a641993-01-22 14:26:28 +0000400 if not self._comm_chunk_read or not self._ssnd_chunk:
401 raise Error, 'COMM chunk and/or SSND chunk missing'
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000402 if self._aifc and self._decomp:
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000403 params = [CL.ORIGINAL_FORMAT, 0,
404 CL.BITS_PER_COMPONENT, self._sampwidth * 8,
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000405 CL.FRAME_RATE, self._framerate]
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000406 if self._nchannels == 1:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000407 params[1] = CL.MONO
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000408 elif self._nchannels == 2:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000409 params[1] = CL.STEREO_INTERLEAVED
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000410 else:
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000411 raise Error, 'cannot compress more than 2 channels'
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000412 self._decomp.SetParams(params)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000413
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000414 def __init__(self, f):
415 if type(f) == type(''):
Guido van Rossume174c151994-09-16 10:55:53 +0000416 f = __builtin__.open(f, 'rb')
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000417 # else, assume it is an open file object already
418 self.initfp(f)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000419
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000420 def __del__(self):
421 if self._file:
422 self.close()
423
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000424 #
425 # User visible methods.
426 #
427 def getfp(self):
428 return self._file
429
430 def rewind(self):
431 self._ssnd_seek_needed = 1
432 self._soundpos = 0
433
434 def close(self):
435 if self._decomp:
436 self._decomp.CloseDecompressor()
437 self._decomp = None
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000438 self._file = None
439
440 def tell(self):
441 return self._soundpos
442
443 def getnchannels(self):
444 return self._nchannels
445
446 def getnframes(self):
447 return self._nframes
448
449 def getsampwidth(self):
450 return self._sampwidth
451
452 def getframerate(self):
453 return self._framerate
454
455 def getcomptype(self):
456 return self._comptype
457
458 def getcompname(self):
459 return self._compname
460
461## def getversion(self):
462## return self._version
463
464 def getparams(self):
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000465 return self.getnchannels(), self.getsampwidth(), \
466 self.getframerate(), self.getnframes(), \
467 self.getcomptype(), self.getcompname()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000468
469 def getmarkers(self):
470 if len(self._markers) == 0:
471 return None
472 return self._markers
473
474 def getmark(self, id):
475 for marker in self._markers:
476 if id == marker[0]:
477 return marker
478 raise Error, 'marker ' + `id` + ' does not exist'
479
480 def setpos(self, pos):
481 if pos < 0 or pos > self._nframes:
482 raise Error, 'position not in range'
483 self._soundpos = pos
484 self._ssnd_seek_needed = 1
485
486 def readframes(self, nframes):
487 if self._ssnd_seek_needed:
488 self._ssnd_chunk.rewind()
489 dummy = self._ssnd_chunk.read(8)
Sjoerd Mullender3a997271993-02-04 16:43:28 +0000490 pos = self._soundpos * self._framesize
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000491 if pos:
492 self._ssnd_chunk.setpos(pos + 8)
493 self._ssnd_seek_needed = 0
Sjoerd Mullender8d733a01993-01-29 12:01:00 +0000494 if nframes == 0:
495 return ''
Sjoerd Mullender3a997271993-02-04 16:43:28 +0000496 data = self._ssnd_chunk.read(nframes * self._framesize)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000497 if self._convert and data:
498 data = self._convert(data)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000499 self._soundpos = self._soundpos + len(data) / (self._nchannels * self._sampwidth)
500 return data
501
502 #
503 # Internal methods.
504 #
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000505 access *: private
506
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000507 def _decomp_data(self, data):
508 dummy = self._decomp.SetParam(CL.FRAME_BUFFER_SIZE,
509 len(data) * 2)
510 return self._decomp.Decompress(len(data) / self._nchannels,
511 data)
512
513 def _ulaw2lin(self, data):
514 import audioop
515 return audioop.ulaw2lin(data, 2)
516
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000517 def _adpcm2lin(self, data):
518 import audioop
519 if not hasattr(self, '_adpcmstate'):
520 # first time
521 self._adpcmstate = None
522 data, self._adpcmstate = audioop.adpcm2lin(data, 2,
523 self._adpcmstate)
524 return data
525
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000526 def _read_comm_chunk(self, chunk):
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000527 self._nchannels = _read_short(chunk)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000528 self._nframes = _read_long(chunk)
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000529 self._sampwidth = (_read_short(chunk) + 7) / 8
Sjoerd Mullenderffe94901994-01-28 09:56:05 +0000530 self._framerate = int(_read_float(chunk))
Sjoerd Mullender3a997271993-02-04 16:43:28 +0000531 self._framesize = self._nchannels * self._sampwidth
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000532 if self._aifc:
533 #DEBUG: SGI's soundeditor produces a bad size :-(
534 kludge = 0
535 if chunk.chunksize == 18:
536 kludge = 1
537 print 'Warning: bad COMM chunk size'
538 chunk.chunksize = 23
539 #DEBUG end
540 self._comptype = chunk.read(4)
541 #DEBUG start
542 if kludge:
543 length = ord(chunk.file.read(1))
544 if length & 1 == 0:
545 length = length + 1
546 chunk.chunksize = chunk.chunksize + length
547 chunk.file.seek(-1, 1)
548 #DEBUG end
549 self._compname = _read_string(chunk)
550 if self._comptype != 'NONE':
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000551 if self._comptype == 'G722':
552 try:
553 import audioop
554 except ImportError:
555 pass
556 else:
557 self._convert = self._adpcm2lin
558 self._framesize = self._framesize / 4
559 return
560 # for ULAW and ALAW try Compression Library
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000561 try:
562 import cl, CL
563 except ImportError:
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000564 if self._comptype == 'ULAW':
565 try:
566 import audioop
567 self._convert = self._ulaw2lin
568 self._framesize = self._framesize / 2
569 return
570 except ImportError:
571 pass
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000572 raise Error, 'cannot read compressed AIFF-C files'
573 if self._comptype == 'ULAW':
574 scheme = CL.G711_ULAW
Sjoerd Mullender3a997271993-02-04 16:43:28 +0000575 self._framesize = self._framesize / 2
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000576 elif self._comptype == 'ALAW':
577 scheme = CL.G711_ALAW
Sjoerd Mullender3a997271993-02-04 16:43:28 +0000578 self._framesize = self._framesize / 2
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000579 else:
580 raise Error, 'unsupported compression type'
581 self._decomp = cl.OpenDecompressor(scheme)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000582 self._convert = self._decomp_data
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000583 else:
584 self._comptype = 'NONE'
585 self._compname = 'not compressed'
586
587 def _readmark(self, chunk):
588 nmarkers = _read_short(chunk)
Guido van Rossum9b3bc711993-06-20 21:02:22 +0000589 # Some files appear to contain invalid counts.
590 # Cope with this by testing for EOF.
591 try:
592 for i in range(nmarkers):
593 id = _read_short(chunk)
594 pos = _read_long(chunk)
595 name = _read_string(chunk)
596 self._markers.append((id, pos, name))
597 except EOFError:
598 print 'Warning: MARK chunk contains only',
599 print len(self._markers),
600 if len(self._markers) == 1: print 'marker',
601 else: print 'markers',
602 print 'instead of', nmarkers
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000603
Guido van Rossumd3166071993-05-24 14:16:22 +0000604class Aifc_write:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000605 # Variables used in this class:
606 #
607 # These variables are user settable through appropriate methods
608 # of this class:
609 # _file -- the open file with methods write(), close(), tell(), seek()
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000610 # set through the __init__() method
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000611 # _comptype -- the AIFF-C compression type ('NONE' in AIFF)
612 # set through the setcomptype() or setparams() method
613 # _compname -- the human-readable AIFF-C compression type
614 # set through the setcomptype() or setparams() method
615 # _nchannels -- the number of audio channels
616 # set through the setnchannels() or setparams() method
617 # _sampwidth -- the number of bytes per audio sample
618 # set through the setsampwidth() or setparams() method
619 # _framerate -- the sampling frequency
620 # set through the setframerate() or setparams() method
621 # _nframes -- the number of audio frames written to the header
622 # set through the setnframes() or setparams() method
623 # _aifc -- whether we're writing an AIFF-C file or an AIFF file
624 # set through the aifc() method, reset through the
625 # aiff() method
626 #
627 # These variables are used internally only:
628 # _version -- the AIFF-C version number
629 # _comp -- the compressor from builtin module cl
630 # _nframeswritten -- the number of audio frames actually written
631 # _datalength -- the size of the audio samples written to the header
632 # _datawritten -- the size of the audio samples actually written
633
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000634 access _file, _comptype, _compname, _nchannels, _sampwidth, \
635 _framerate, _nframes, _aifc, _version, _comp, \
636 _nframeswritten, _datalength, _datawritten: private
637
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000638 def __init__(self, f):
639 if type(f) == type(''):
Guido van Rossum6ed9df21993-12-17 16:43:43 +0000640 filename = f
Guido van Rossume174c151994-09-16 10:55:53 +0000641 f = __builtin__.open(f, 'wb')
Guido van Rossum6ed9df21993-12-17 16:43:43 +0000642 else:
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000643 # else, assume it is an open file object already
Guido van Rossum6ed9df21993-12-17 16:43:43 +0000644 filename = '???'
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000645 self.initfp(f)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000646 if filename[-5:] == '.aiff':
647 self._aifc = 0
648 else:
649 self._aifc = 1
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000650
651 def initfp(self, file):
652 self._file = file
653 self._version = _AIFC_version
654 self._comptype = 'NONE'
655 self._compname = 'not compressed'
656 self._comp = None
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000657 self._convert = None
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000658 self._nchannels = 0
659 self._sampwidth = 0
660 self._framerate = 0
661 self._nframes = 0
662 self._nframeswritten = 0
663 self._datawritten = 0
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000664 self._datalength = 0
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000665 self._markers = []
666 self._marklength = 0
667 self._aifc = 1 # AIFF-C is default
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000668
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000669 def __del__(self):
670 if self._file:
671 self.close()
672
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000673 #
674 # User visible methods.
675 #
676 def aiff(self):
677 if self._nframeswritten:
678 raise Error, 'cannot change parameters after starting to write'
679 self._aifc = 0
680
681 def aifc(self):
682 if self._nframeswritten:
683 raise Error, 'cannot change parameters after starting to write'
684 self._aifc = 1
685
686 def setnchannels(self, nchannels):
687 if self._nframeswritten:
688 raise Error, 'cannot change parameters after starting to write'
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000689 if nchannels < 1:
690 raise Error, 'bad # of channels'
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000691 self._nchannels = nchannels
692
693 def getnchannels(self):
694 if not self._nchannels:
695 raise Error, 'number of channels not set'
696 return self._nchannels
697
698 def setsampwidth(self, sampwidth):
699 if self._nframeswritten:
700 raise Error, 'cannot change parameters after starting to write'
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000701 if sampwidth < 1 or sampwidth > 4:
702 raise Error, 'bad sample width'
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000703 self._sampwidth = sampwidth
704
705 def getsampwidth(self):
706 if not self._sampwidth:
707 raise Error, 'sample width not set'
708 return self._sampwidth
709
710 def setframerate(self, framerate):
711 if self._nframeswritten:
712 raise Error, 'cannot change parameters after starting to write'
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000713 if framerate <= 0:
714 raise Error, 'bad frame rate'
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000715 self._framerate = framerate
716
717 def getframerate(self):
718 if not self._framerate:
719 raise Error, 'frame rate not set'
720 return self._framerate
721
722 def setnframes(self, nframes):
723 if self._nframeswritten:
724 raise Error, 'cannot change parameters after starting to write'
725 self._nframes = nframes
726
727 def getnframes(self):
728 return self._nframeswritten
729
730 def setcomptype(self, comptype, compname):
731 if self._nframeswritten:
732 raise Error, 'cannot change parameters after starting to write'
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000733 if comptype not in ('NONE', 'ULAW', 'ALAW', 'G722'):
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000734 raise Error, 'unsupported compression type'
735 self._comptype = comptype
736 self._compname = compname
737
738 def getcomptype(self):
739 return self._comptype
740
741 def getcompname(self):
742 return self._compname
743
744## def setversion(self, version):
745## if self._nframeswritten:
746## raise Error, 'cannot change parameters after starting to write'
747## self._version = version
748
749 def setparams(self, (nchannels, sampwidth, framerate, nframes, comptype, compname)):
750 if self._nframeswritten:
751 raise Error, 'cannot change parameters after starting to write'
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000752 if comptype not in ('NONE', 'ULAW', 'ALAW', 'G722'):
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000753 raise Error, 'unsupported compression type'
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000754 self.setnchannels(nchannels)
755 self.setsampwidth(sampwidth)
756 self.setframerate(framerate)
757 self.setnframes(nframes)
758 self.setcomptype(comptype, compname)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000759
760 def getparams(self):
761 if not self._nchannels or not self._sampwidth or not self._framerate:
762 raise Error, 'not all parameters set'
763 return self._nchannels, self._sampwidth, self._framerate, \
764 self._nframes, self._comptype, self._compname
765
Sjoerd Mullender7564a641993-01-22 14:26:28 +0000766 def setmark(self, id, pos, name):
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000767 if id <= 0:
768 raise Error, 'marker ID must be > 0'
769 if pos < 0:
770 raise Error, 'marker position must be >= 0'
771 if type(name) != type(''):
772 raise Error, 'marker name must be a string'
773 for i in range(len(self._markers)):
774 if id == self._markers[i][0]:
775 self._markers[i] = id, pos, name
776 return
777 self._markers.append((id, pos, name))
778
779 def getmark(self, id):
780 for marker in self._markers:
781 if id == marker[0]:
782 return marker
783 raise Error, 'marker ' + `id` + ' does not exist'
784
785 def getmarkers(self):
786 if len(self._markers) == 0:
787 return None
788 return self._markers
789
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000790 def tell(self):
791 return self._nframeswritten
792
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000793 def writeframesraw(self, data):
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000794 self._ensure_header_written(len(data))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000795 nframes = len(data) / (self._sampwidth * self._nchannels)
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000796 if self._convert:
797 data = self._convert(data)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000798 self._file.write(data)
799 self._nframeswritten = self._nframeswritten + nframes
800 self._datawritten = self._datawritten + len(data)
801
802 def writeframes(self, data):
803 self.writeframesraw(data)
804 if self._nframeswritten != self._nframes or \
805 self._datalength != self._datawritten:
806 self._patchheader()
807
808 def close(self):
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000809 self._ensure_header_written(0)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000810 if self._datawritten & 1:
811 # quick pad to even size
812 self._file.write(chr(0))
813 self._datawritten = self._datawritten + 1
814 self._writemarkers()
815 if self._nframeswritten != self._nframes or \
816 self._datalength != self._datawritten or \
817 self._marklength:
818 self._patchheader()
819 if self._comp:
820 self._comp.CloseCompressor()
821 self._comp = None
Sjoerd Mullenderfeaa7d21993-12-16 13:56:34 +0000822 self._file.flush()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000823 self._file = None
824
825 #
826 # Internal methods.
827 #
Sjoerd Mullender2a451411993-12-20 09:36:01 +0000828 access *: private
829
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000830 def _comp_data(self, data):
831 dum = self._comp.SetParam(CL.FRAME_BUFFER_SIZE, len(data))
832 dum = self._comp.SetParam(CL.COMPRESSED_BUFFER_SIZE, len(data))
833 return self._comp.Compress(nframes, data)
834
835 def _lin2ulaw(self, data):
836 import audioop
837 return audioop.lin2ulaw(data, 2)
838
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000839 def _lin2adpcm(self, data):
840 import audioop
841 if not hasattr(self, '_adpcmstate'):
842 self._adpcmstate = None
843 data, self._adpcmstate = audioop.lin2adpcm(data, 2,
844 self._adpcmstate)
845 return data
846
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000847 def _ensure_header_written(self, datasize):
848 if not self._nframeswritten:
849 if self._comptype in ('ULAW', 'ALAW'):
850 if not self._sampwidth:
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000851 self._sampwidth = 2
852 if self._sampwidth != 2:
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000853 raise Error, 'sample width must be 2 when compressing with ULAW or ALAW'
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000854 if self._comptype == 'G722':
855 if not self._sampwidth:
856 self._sampwidth = 2
857 if self._sampwidth != 2:
858 raise Error, 'sample width must be 2 when compressing with G7.22 (ADPCM)'
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000859 if not self._nchannels:
860 raise Error, '# channels not specified'
861 if not self._sampwidth:
862 raise Error, 'sample width not specified'
863 if not self._framerate:
864 raise Error, 'sampling rate not specified'
865 self._write_header(datasize)
866
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000867 def _init_compression(self):
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000868 if self._comptype == 'G722':
869 import audioop
870 self._convert = self._lin2adpcm
871 return
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000872 try:
873 import cl, CL
874 except ImportError:
875 if self._comptype == 'ULAW':
876 try:
877 import audioop
878 self._convert = self._lin2ulaw
879 return
880 except ImportError:
881 pass
882 raise Error, 'cannot write compressed AIFF-C files'
883 if self._comptype == 'ULAW':
884 scheme = CL.G711_ULAW
885 elif self._comptype == 'ALAW':
886 scheme = CL.G711_ALAW
887 else:
888 raise Error, 'unsupported compression type'
889 self._comp = cl.OpenCompressor(scheme)
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000890 params = [CL.ORIGINAL_FORMAT, 0,
891 CL.BITS_PER_COMPONENT, self._sampwidth * 8,
892 CL.FRAME_RATE, self._framerate,
893 CL.FRAME_BUFFER_SIZE, 100,
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000894 CL.COMPRESSED_BUFFER_SIZE, 100]
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000895 if self._nchannels == 1:
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000896 params[1] = CL.MONO
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000897 elif self._nchannels == 2:
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000898 params[1] = CL.STEREO_INTERLEAVED
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000899 else:
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000900 raise Error, 'cannot compress more than 2 channels'
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000901 self._comp.SetParams(params)
902 # the compressor produces a header which we ignore
903 dummy = self._comp.Compress(0, '')
904 self._convert = self._comp_data
905
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000906 def _write_header(self, initlength):
907 if self._aifc and self._comptype != 'NONE':
Sjoerd Mullender43bf0bc1993-12-13 11:42:39 +0000908 self._init_compression()
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000909 self._file.write('FORM')
910 if not self._nframes:
911 self._nframes = initlength / (self._nchannels * self._sampwidth)
912 self._datalength = self._nframes * self._nchannels * self._sampwidth
913 if self._datalength & 1:
914 self._datalength = self._datalength + 1
Sjoerd Mullender1f057541994-09-06 16:17:51 +0000915 if self._aifc:
916 if self._comptype in ('ULAW', 'ALAW'):
917 self._datalength = self._datalength / 2
918 if self._datalength & 1:
919 self._datalength = self._datalength + 1
920 elif self._comptype == 'G722':
921 self._datalength = (self._datalength + 3) / 4
922 if self._datalength & 1:
923 self._datalength = self._datalength + 1
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000924 self._form_length_pos = self._file.tell()
925 commlength = self._write_form_length(self._datalength)
926 if self._aifc:
927 self._file.write('AIFC')
928 self._file.write('FVER')
929 _write_long(self._file, 4)
930 _write_long(self._file, self._version)
931 else:
932 self._file.write('AIFF')
933 self._file.write('COMM')
934 _write_long(self._file, commlength)
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000935 _write_short(self._file, self._nchannels)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000936 self._nframes_pos = self._file.tell()
937 _write_long(self._file, self._nframes)
Sjoerd Mullender49c2df11994-01-06 16:35:34 +0000938 _write_short(self._file, self._sampwidth * 8)
939 _write_float(self._file, self._framerate)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000940 if self._aifc:
941 self._file.write(self._comptype)
942 _write_string(self._file, self._compname)
943 self._file.write('SSND')
944 self._ssnd_length_pos = self._file.tell()
945 _write_long(self._file, self._datalength + 8)
946 _write_long(self._file, 0)
947 _write_long(self._file, 0)
948
949 def _write_form_length(self, datalength):
950 if self._aifc:
951 commlength = 18 + 5 + len(self._compname)
952 if commlength & 1:
953 commlength = commlength + 1
954 verslength = 12
955 else:
956 commlength = 18
957 verslength = 0
958 _write_long(self._file, 4 + verslength + self._marklength + \
959 8 + commlength + 16 + datalength)
960 return commlength
961
962 def _patchheader(self):
963 curpos = self._file.tell()
964 if self._datawritten & 1:
965 datalength = self._datawritten + 1
966 self._file.write(chr(0))
967 else:
968 datalength = self._datawritten
969 if datalength == self._datalength and \
Sjoerd Mullender7564a641993-01-22 14:26:28 +0000970 self._nframes == self._nframeswritten and \
971 self._marklength == 0:
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000972 self._file.seek(curpos, 0)
973 return
974 self._file.seek(self._form_length_pos, 0)
975 dummy = self._write_form_length(datalength)
976 self._file.seek(self._nframes_pos, 0)
977 _write_long(self._file, self._nframeswritten)
978 self._file.seek(self._ssnd_length_pos, 0)
979 _write_long(self._file, datalength + 8)
980 self._file.seek(curpos, 0)
981 self._nframes = self._nframeswritten
982 self._datalength = datalength
983
984 def _writemarkers(self):
985 if len(self._markers) == 0:
986 return
987 self._file.write('MARK')
988 length = 2
989 for marker in self._markers:
990 id, pos, name = marker
991 length = length + len(name) + 1 + 6
992 if len(name) & 1 == 0:
993 length = length + 1
994 _write_long(self._file, length)
995 self._marklength = length + 8
Sjoerd Mullender7564a641993-01-22 14:26:28 +0000996 _write_short(self._file, len(self._markers))
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +0000997 for marker in self._markers:
998 id, pos, name = marker
999 _write_short(self._file, id)
1000 _write_long(self._file, pos)
1001 _write_string(self._file, name)
1002
Guido van Rossum7bc817d1993-12-17 15:25:27 +00001003def open(f, mode):
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +00001004 if mode == 'r':
Guido van Rossum7bc817d1993-12-17 15:25:27 +00001005 return Aifc_read(f)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +00001006 elif mode == 'w':
Guido van Rossum7bc817d1993-12-17 15:25:27 +00001007 return Aifc_write(f)
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +00001008 else:
Sjoerd Mullender2a451411993-12-20 09:36:01 +00001009 raise Error, "mode must be 'r' or 'w'"
Sjoerd Mullendereeabe7e1993-01-22 12:53:11 +00001010
Guido van Rossum7bc817d1993-12-17 15:25:27 +00001011openfp = open # B/W compatibility