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