• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1from test.support import check_no_resource_warning, findfile, TESTFN, unlink
2import unittest
3from unittest import mock
4from test import audiotests
5from audioop import byteswap
6import io
7import sys
8import struct
9import aifc
10
11class AifcTest(audiotests.AudioWriteTests,
12               audiotests.AudioTestsWithSourceFile):
13    module = aifc
14    close_fd = True
15    test_unseekable_read = None
16
17
18class AifcPCM8Test(AifcTest, unittest.TestCase):
19    sndfilename = 'pluck-pcm8.aiff'
20    sndfilenframes = 3307
21    nchannels = 2
22    sampwidth = 1
23    framerate = 11025
24    nframes = 48
25    comptype = b'NONE'
26    compname = b'not compressed'
27    frames = bytes.fromhex("""\
28      02FF 4B00 3104 8008 CB06 4803 BF01 03FE B8FA B4F3 29EB 1AE6 \
29      EDE4 C6E2 0EE0 EFE0 57E2 FBE8 13EF D8F7 97FB F5FC 08FB DFFB \
30      11FA 3EFB BCFC 66FF CF04 4309 C10E 5112 EE17 8216 7F14 8012 \
31      490E 520D EF0F CE0F E40C 630A 080A 2B0B 510E 8B11 B60E 440A \
32      """)
33
34
35class AifcPCM16Test(AifcTest, unittest.TestCase):
36    sndfilename = 'pluck-pcm16.aiff'
37    sndfilenframes = 3307
38    nchannels = 2
39    sampwidth = 2
40    framerate = 11025
41    nframes = 48
42    comptype = b'NONE'
43    compname = b'not compressed'
44    frames = bytes.fromhex("""\
45      022EFFEA 4B5D00F6 311804EA 80E10840 CBE106B1 48A903F5 BFE601B2 036CFE7B \
46      B858FA3E B4B1F34F 299AEBCA 1A5DE6DA EDFAE491 C628E275 0E09E0B5 EF2AE029 \
47      5758E271 FB35E83F 1376EF86 D82BF727 9790FB76 F5FAFC0F 0867FB9C DF30FB43 \
48      117EFA36 3EE5FB5B BC79FCB1 66D9FF5D CF150412 431D097C C1BA0EC8 512112A1 \
49      EEE21753 82071665 7FFF1443 8004128F 49A20EAF 52BB0DBA EFB40F60 CE3C0FBF \
50      E4B30CEC 63430A5C 08C80A20 2BBB0B08 514A0E43 8BCF1139 B6F60EEB 44120A5E \
51      """)
52
53
54class AifcPCM24Test(AifcTest, unittest.TestCase):
55    sndfilename = 'pluck-pcm24.aiff'
56    sndfilenframes = 3307
57    nchannels = 2
58    sampwidth = 3
59    framerate = 11025
60    nframes = 48
61    comptype = b'NONE'
62    compname = b'not compressed'
63    frames = bytes.fromhex("""\
64      022D65FFEB9D 4B5A0F00FA54 3113C304EE2B 80DCD6084303 \
65      CBDEC006B261 48A99803F2F8 BFE82401B07D 036BFBFE7B5D \
66      B85756FA3EC9 B4B055F3502B 299830EBCB62 1A5CA7E6D99A \
67      EDFA3EE491BD C625EBE27884 0E05A9E0B6CF EF2929E02922 \
68      5758D8E27067 FB3557E83E16 1377BFEF8402 D82C5BF7272A \
69      978F16FB7745 F5F865FC1013 086635FB9C4E DF30FCFB40EE \
70      117FE0FA3438 3EE6B8FB5AC3 BC77A3FCB2F4 66D6DAFF5F32 \
71      CF13B9041275 431D69097A8C C1BB600EC74E 5120B912A2BA \
72      EEDF641754C0 8207001664B7 7FFFFF14453F 8000001294E6 \
73      499C1B0EB3B2 52B73E0DBCA0 EFB2B20F5FD8 CE3CDB0FBE12 \
74      E4B49C0CEA2D 6344A80A5A7C 08C8FE0A1FFE 2BB9860B0A0E \
75      51486F0E44E1 8BCC64113B05 B6F4EC0EEB36 4413170A5B48 \
76      """)
77
78
79class AifcPCM32Test(AifcTest, unittest.TestCase):
80    sndfilename = 'pluck-pcm32.aiff'
81    sndfilenframes = 3307
82    nchannels = 2
83    sampwidth = 4
84    framerate = 11025
85    nframes = 48
86    comptype = b'NONE'
87    compname = b'not compressed'
88    frames = bytes.fromhex("""\
89      022D65BCFFEB9D92 4B5A0F8000FA549C 3113C34004EE2BC0 80DCD680084303E0 \
90      CBDEC0C006B26140 48A9980003F2F8FC BFE8248001B07D92 036BFB60FE7B5D34 \
91      B8575600FA3EC920 B4B05500F3502BC0 29983000EBCB6240 1A5CA7A0E6D99A60 \
92      EDFA3E80E491BD40 C625EB80E27884A0 0E05A9A0E0B6CFE0 EF292940E0292280 \
93      5758D800E2706700 FB3557D8E83E1640 1377BF00EF840280 D82C5B80F7272A80 \
94      978F1600FB774560 F5F86510FC101364 086635A0FB9C4E20 DF30FC40FB40EE28 \
95      117FE0A0FA3438B0 3EE6B840FB5AC3F0 BC77A380FCB2F454 66D6DA80FF5F32B4 \
96      CF13B980041275B0 431D6980097A8C00 C1BB60000EC74E00 5120B98012A2BAA0 \
97      EEDF64C01754C060 820700001664B780 7FFFFFFF14453F40 800000001294E6E0 \
98      499C1B000EB3B270 52B73E000DBCA020 EFB2B2E00F5FD880 CE3CDB400FBE1270 \
99      E4B49CC00CEA2D90 6344A8800A5A7CA0 08C8FE800A1FFEE0 2BB986C00B0A0E00 \
100      51486F800E44E190 8BCC6480113B0580 B6F4EC000EEB3630 441317800A5B48A0 \
101      """)
102
103
104class AifcULAWTest(AifcTest, unittest.TestCase):
105    sndfilename = 'pluck-ulaw.aifc'
106    sndfilenframes = 3307
107    nchannels = 2
108    sampwidth = 2
109    framerate = 11025
110    nframes = 48
111    comptype = b'ulaw'
112    compname = b''
113    frames = bytes.fromhex("""\
114      022CFFE8 497C0104 307C04DC 8284083C CB84069C 497C03DC BE8401AC 036CFE74 \
115      B684FA24 B684F344 2A7CEC04 19FCE704 EE04E504 C584E204 0E3CE104 EF04DF84 \
116      557CE204 FB24E804 12FCEF04 D784F744 9684FB64 F5C4FC24 083CFBA4 DF84FB24 \
117      11FCFA24 3E7CFB64 BA84FCB4 657CFF5C CF84041C 417C093C C1840EBC 517C12FC \
118      EF0416FC 828415FC 7D7C13FC 828412FC 497C0EBC 517C0DBC F0040F3C CD840FFC \
119      E5040CBC 617C0A3C 08BC0A3C 2C7C0B3C 517C0E3C 8A8410FC B6840EBC 457C0A3C \
120      """)
121    if sys.byteorder != 'big':
122        frames = byteswap(frames, 2)
123
124
125class AifcALAWTest(AifcTest, unittest.TestCase):
126    sndfilename = 'pluck-alaw.aifc'
127    sndfilenframes = 3307
128    nchannels = 2
129    sampwidth = 2
130    framerate = 11025
131    nframes = 48
132    comptype = b'alaw'
133    compname = b''
134    frames = bytes.fromhex("""\
135      0230FFE8 4A0000F8 310004E0 82000840 CB0006A0 4A0003F0 BE0001A8 0370FE78 \
136      BA00FA20 B600F340 2900EB80 1A80E680 ED80E480 C700E280 0E40E080 EF80E080 \
137      5600E280 FB20E880 1380EF80 D900F740 9600FB60 F5C0FC10 0840FBA0 DF00FB20 \
138      1180FA20 3F00FB60 BE00FCB0 6600FF58 CF000420 42000940 C1000EC0 52001280 \
139      EE801780 82001680 7E001480 82001280 4A000EC0 52000DC0 EF800F40 CF000FC0 \
140      E4800CC0 62000A40 08C00A40 2B000B40 52000E40 8A001180 B6000EC0 46000A40 \
141      """)
142    if sys.byteorder != 'big':
143        frames = byteswap(frames, 2)
144
145
146class AifcMiscTest(audiotests.AudioMiscTests, unittest.TestCase):
147    module = aifc
148
149    def test_skipunknown(self):
150        #Issue 2245
151        #This file contains chunk types aifc doesn't recognize.
152        self.f = aifc.open(findfile('Sine-1000Hz-300ms.aif'))
153
154    def test_close_opened_files_on_error(self):
155        non_aifc_file = findfile('pluck-pcm8.wav', subdir='audiodata')
156        with check_no_resource_warning(self):
157            with self.assertRaises(aifc.Error):
158                # Try opening a non-AIFC file, with the expectation that
159                # `aifc.open` will fail (without raising a ResourceWarning)
160                self.f = aifc.open(non_aifc_file, 'rb')
161
162            # Aifc_write.initfp() won't raise in normal case.  But some errors
163            # (e.g. MemoryError, KeyboardInterrupt, etc..) can happen.
164            with mock.patch.object(aifc.Aifc_write, 'initfp',
165                                   side_effect=RuntimeError):
166                with self.assertRaises(RuntimeError):
167                    self.fout = aifc.open(TESTFN, 'wb')
168
169    def test_params_added(self):
170        f = self.f = aifc.open(TESTFN, 'wb')
171        f.aiff()
172        f.setparams((1, 1, 1, 1, b'NONE', b''))
173        f.close()
174
175        f = self.f = aifc.open(TESTFN, 'rb')
176        params = f.getparams()
177        self.assertEqual(params.nchannels, f.getnchannels())
178        self.assertEqual(params.sampwidth, f.getsampwidth())
179        self.assertEqual(params.framerate, f.getframerate())
180        self.assertEqual(params.nframes, f.getnframes())
181        self.assertEqual(params.comptype, f.getcomptype())
182        self.assertEqual(params.compname, f.getcompname())
183
184    def test_write_header_comptype_sampwidth(self):
185        for comptype in (b'ULAW', b'ulaw', b'ALAW', b'alaw', b'G722'):
186            fout = aifc.open(io.BytesIO(), 'wb')
187            fout.setnchannels(1)
188            fout.setframerate(1)
189            fout.setcomptype(comptype, b'')
190            fout.close()
191            self.assertEqual(fout.getsampwidth(), 2)
192            fout.initfp(None)
193
194    def test_write_markers_values(self):
195        fout = aifc.open(io.BytesIO(), 'wb')
196        self.assertEqual(fout.getmarkers(), None)
197        fout.setmark(1, 0, b'foo1')
198        fout.setmark(1, 1, b'foo2')
199        self.assertEqual(fout.getmark(1), (1, 1, b'foo2'))
200        self.assertEqual(fout.getmarkers(), [(1, 1, b'foo2')])
201        fout.initfp(None)
202
203    def test_read_markers(self):
204        fout = self.fout = aifc.open(TESTFN, 'wb')
205        fout.aiff()
206        fout.setparams((1, 1, 1, 1, b'NONE', b''))
207        fout.setmark(1, 0, b'odd')
208        fout.setmark(2, 0, b'even')
209        fout.writeframes(b'\x00')
210        fout.close()
211        f = self.f = aifc.open(TESTFN, 'rb')
212        self.assertEqual(f.getmarkers(), [(1, 0, b'odd'), (2, 0, b'even')])
213        self.assertEqual(f.getmark(1), (1, 0, b'odd'))
214        self.assertEqual(f.getmark(2), (2, 0, b'even'))
215        self.assertRaises(aifc.Error, f.getmark, 3)
216
217
218class AIFCLowLevelTest(unittest.TestCase):
219
220    def test_read_written(self):
221        def read_written(self, what):
222            f = io.BytesIO()
223            getattr(aifc, '_write_' + what)(f, x)
224            f.seek(0)
225            return getattr(aifc, '_read_' + what)(f)
226        for x in (-1, 0, 0.1, 1):
227            self.assertEqual(read_written(x, 'float'), x)
228        for x in (float('NaN'), float('Inf')):
229            self.assertEqual(read_written(x, 'float'), aifc._HUGE_VAL)
230        for x in (b'', b'foo', b'a' * 255):
231            self.assertEqual(read_written(x, 'string'), x)
232        for x in (-0x7FFFFFFF, -1, 0, 1, 0x7FFFFFFF):
233            self.assertEqual(read_written(x, 'long'), x)
234        for x in (0, 1, 0xFFFFFFFF):
235            self.assertEqual(read_written(x, 'ulong'), x)
236        for x in (-0x7FFF, -1, 0, 1, 0x7FFF):
237            self.assertEqual(read_written(x, 'short'), x)
238        for x in (0, 1, 0xFFFF):
239            self.assertEqual(read_written(x, 'ushort'), x)
240
241    def test_read_raises(self):
242        f = io.BytesIO(b'\x00')
243        self.assertRaises(EOFError, aifc._read_ulong, f)
244        self.assertRaises(EOFError, aifc._read_long, f)
245        self.assertRaises(EOFError, aifc._read_ushort, f)
246        self.assertRaises(EOFError, aifc._read_short, f)
247
248    def test_write_long_string_raises(self):
249        f = io.BytesIO()
250        with self.assertRaises(ValueError):
251            aifc._write_string(f, b'too long' * 255)
252
253    def test_wrong_open_mode(self):
254        with self.assertRaises(aifc.Error):
255            aifc.open(TESTFN, 'wrong_mode')
256
257    def test_read_wrong_form(self):
258        b1 = io.BytesIO(b'WRNG' + struct.pack('>L', 0))
259        b2 = io.BytesIO(b'FORM' + struct.pack('>L', 4) + b'WRNG')
260        self.assertRaises(aifc.Error, aifc.open, b1)
261        self.assertRaises(aifc.Error, aifc.open, b2)
262
263    def test_read_no_comm_chunk(self):
264        b = io.BytesIO(b'FORM' + struct.pack('>L', 4) + b'AIFF')
265        self.assertRaises(aifc.Error, aifc.open, b)
266
267    def test_read_no_ssnd_chunk(self):
268        b = b'FORM' + struct.pack('>L', 4) + b'AIFC'
269        b += b'COMM' + struct.pack('>LhlhhLL', 38, 1, 0, 8,
270                                   0x4000 | 12, 11025<<18, 0)
271        b += b'NONE' + struct.pack('B', 14) + b'not compressed' + b'\x00'
272        with self.assertRaisesRegex(aifc.Error, 'COMM chunk and/or SSND chunk'
273                                                ' missing'):
274            aifc.open(io.BytesIO(b))
275
276    def test_read_wrong_compression_type(self):
277        b = b'FORM' + struct.pack('>L', 4) + b'AIFC'
278        b += b'COMM' + struct.pack('>LhlhhLL', 23, 1, 0, 8,
279                                   0x4000 | 12, 11025<<18, 0)
280        b += b'WRNG' + struct.pack('B', 0)
281        self.assertRaises(aifc.Error, aifc.open, io.BytesIO(b))
282
283    def test_read_wrong_number_of_channels(self):
284        for nchannels in 0, -1:
285            b = b'FORM' + struct.pack('>L', 4) + b'AIFC'
286            b += b'COMM' + struct.pack('>LhlhhLL', 38, nchannels, 0, 8,
287                                       0x4000 | 12, 11025<<18, 0)
288            b += b'NONE' + struct.pack('B', 14) + b'not compressed' + b'\x00'
289            b += b'SSND' + struct.pack('>L', 8) + b'\x00' * 8
290            with self.assertRaisesRegex(aifc.Error, 'bad # of channels'):
291                aifc.open(io.BytesIO(b))
292
293    def test_read_wrong_sample_width(self):
294        for sampwidth in 0, -1:
295            b = b'FORM' + struct.pack('>L', 4) + b'AIFC'
296            b += b'COMM' + struct.pack('>LhlhhLL', 38, 1, 0, sampwidth,
297                                       0x4000 | 12, 11025<<18, 0)
298            b += b'NONE' + struct.pack('B', 14) + b'not compressed' + b'\x00'
299            b += b'SSND' + struct.pack('>L', 8) + b'\x00' * 8
300            with self.assertRaisesRegex(aifc.Error, 'bad sample width'):
301                aifc.open(io.BytesIO(b))
302
303    def test_read_wrong_marks(self):
304        b = b'FORM' + struct.pack('>L', 4) + b'AIFF'
305        b += b'COMM' + struct.pack('>LhlhhLL', 18, 1, 0, 8,
306                                   0x4000 | 12, 11025<<18, 0)
307        b += b'SSND' + struct.pack('>L', 8) + b'\x00' * 8
308        b += b'MARK' + struct.pack('>LhB', 3, 1, 1)
309        with self.assertWarns(UserWarning) as cm:
310            f = aifc.open(io.BytesIO(b))
311        self.assertEqual(str(cm.warning), 'Warning: MARK chunk contains '
312                                          'only 0 markers instead of 1')
313        self.assertEqual(f.getmarkers(), None)
314
315    def test_read_comm_kludge_compname_even(self):
316        b = b'FORM' + struct.pack('>L', 4) + b'AIFC'
317        b += b'COMM' + struct.pack('>LhlhhLL', 18, 1, 0, 8,
318                                   0x4000 | 12, 11025<<18, 0)
319        b += b'NONE' + struct.pack('B', 4) + b'even' + b'\x00'
320        b += b'SSND' + struct.pack('>L', 8) + b'\x00' * 8
321        with self.assertWarns(UserWarning) as cm:
322            f = aifc.open(io.BytesIO(b))
323        self.assertEqual(str(cm.warning), 'Warning: bad COMM chunk size')
324        self.assertEqual(f.getcompname(), b'even')
325
326    def test_read_comm_kludge_compname_odd(self):
327        b = b'FORM' + struct.pack('>L', 4) + b'AIFC'
328        b += b'COMM' + struct.pack('>LhlhhLL', 18, 1, 0, 8,
329                                   0x4000 | 12, 11025<<18, 0)
330        b += b'NONE' + struct.pack('B', 3) + b'odd'
331        b += b'SSND' + struct.pack('>L', 8) + b'\x00' * 8
332        with self.assertWarns(UserWarning) as cm:
333            f = aifc.open(io.BytesIO(b))
334        self.assertEqual(str(cm.warning), 'Warning: bad COMM chunk size')
335        self.assertEqual(f.getcompname(), b'odd')
336
337    def test_write_params_raises(self):
338        fout = aifc.open(io.BytesIO(), 'wb')
339        wrong_params = (0, 0, 0, 0, b'WRNG', '')
340        self.assertRaises(aifc.Error, fout.setparams, wrong_params)
341        self.assertRaises(aifc.Error, fout.getparams)
342        self.assertRaises(aifc.Error, fout.setnchannels, 0)
343        self.assertRaises(aifc.Error, fout.getnchannels)
344        self.assertRaises(aifc.Error, fout.setsampwidth, 0)
345        self.assertRaises(aifc.Error, fout.getsampwidth)
346        self.assertRaises(aifc.Error, fout.setframerate, 0)
347        self.assertRaises(aifc.Error, fout.getframerate)
348        self.assertRaises(aifc.Error, fout.setcomptype, b'WRNG', '')
349        fout.aiff()
350        fout.setnchannels(1)
351        fout.setsampwidth(1)
352        fout.setframerate(1)
353        fout.setnframes(1)
354        fout.writeframes(b'\x00')
355        self.assertRaises(aifc.Error, fout.setparams, (1, 1, 1, 1, 1, 1))
356        self.assertRaises(aifc.Error, fout.setnchannels, 1)
357        self.assertRaises(aifc.Error, fout.setsampwidth, 1)
358        self.assertRaises(aifc.Error, fout.setframerate, 1)
359        self.assertRaises(aifc.Error, fout.setnframes, 1)
360        self.assertRaises(aifc.Error, fout.setcomptype, b'NONE', '')
361        self.assertRaises(aifc.Error, fout.aiff)
362        self.assertRaises(aifc.Error, fout.aifc)
363
364    def test_write_params_singles(self):
365        fout = aifc.open(io.BytesIO(), 'wb')
366        fout.aifc()
367        fout.setnchannels(1)
368        fout.setsampwidth(2)
369        fout.setframerate(3)
370        fout.setnframes(4)
371        fout.setcomptype(b'NONE', b'name')
372        self.assertEqual(fout.getnchannels(), 1)
373        self.assertEqual(fout.getsampwidth(), 2)
374        self.assertEqual(fout.getframerate(), 3)
375        self.assertEqual(fout.getnframes(), 0)
376        self.assertEqual(fout.tell(), 0)
377        self.assertEqual(fout.getcomptype(), b'NONE')
378        self.assertEqual(fout.getcompname(), b'name')
379        fout.writeframes(b'\x00' * 4 * fout.getsampwidth() * fout.getnchannels())
380        self.assertEqual(fout.getnframes(), 4)
381        self.assertEqual(fout.tell(), 4)
382
383    def test_write_params_bunch(self):
384        fout = aifc.open(io.BytesIO(), 'wb')
385        fout.aifc()
386        p = (1, 2, 3, 4, b'NONE', b'name')
387        fout.setparams(p)
388        self.assertEqual(fout.getparams(), p)
389        fout.initfp(None)
390
391    def test_write_header_raises(self):
392        fout = aifc.open(io.BytesIO(), 'wb')
393        self.assertRaises(aifc.Error, fout.close)
394        fout = aifc.open(io.BytesIO(), 'wb')
395        fout.setnchannels(1)
396        self.assertRaises(aifc.Error, fout.close)
397        fout = aifc.open(io.BytesIO(), 'wb')
398        fout.setnchannels(1)
399        fout.setsampwidth(1)
400        self.assertRaises(aifc.Error, fout.close)
401
402    def test_write_header_comptype_raises(self):
403        for comptype in (b'ULAW', b'ulaw', b'ALAW', b'alaw', b'G722'):
404            fout = aifc.open(io.BytesIO(), 'wb')
405            fout.setsampwidth(1)
406            fout.setcomptype(comptype, b'')
407            self.assertRaises(aifc.Error, fout.close)
408            fout.initfp(None)
409
410    def test_write_markers_raises(self):
411        fout = aifc.open(io.BytesIO(), 'wb')
412        self.assertRaises(aifc.Error, fout.setmark, 0, 0, b'')
413        self.assertRaises(aifc.Error, fout.setmark, 1, -1, b'')
414        self.assertRaises(aifc.Error, fout.setmark, 1, 0, None)
415        self.assertRaises(aifc.Error, fout.getmark, 1)
416        fout.initfp(None)
417
418    def test_write_aiff_by_extension(self):
419        sampwidth = 2
420        filename = TESTFN + '.aiff'
421        fout = self.fout = aifc.open(filename, 'wb')
422        self.addCleanup(unlink, filename)
423        fout.setparams((1, sampwidth, 1, 1, b'ULAW', b''))
424        frames = b'\x00' * fout.getnchannels() * sampwidth
425        fout.writeframes(frames)
426        fout.close()
427        f = self.f = aifc.open(filename, 'rb')
428        self.assertEqual(f.getcomptype(), b'NONE')
429        f.close()
430
431
432if __name__ == "__main__":
433    unittest.main()
434