test.py 10.4 KB
Newer Older
David Pollack's avatar
David Pollack committed
1
import unittest
2
import common_utils
3
import torch
Soumith Chintala's avatar
Soumith Chintala committed
4
import torchaudio
David Pollack's avatar
David Pollack committed
5
import math
David Pollack's avatar
David Pollack committed
6
7
import os

Soumith Chintala's avatar
Soumith Chintala committed
8

Vincent QB's avatar
Vincent QB committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
class AudioBackendScope:
    def __init__(self, backend):
        self.new_backend = backend
        self.previous_backend = torchaudio.get_audio_backend()

    def __enter__(self):
        torchaudio.set_audio_backend(self.new_backend)
        return self.new_backend

    def __exit__(self, type, value, traceback):
        backend = self.previous_backend
        torchaudio.set_audio_backend(backend)


David Pollack's avatar
David Pollack committed
23
class Test_LoadSave(unittest.TestCase):
24
    test_dirpath, test_dir = common_utils.create_temp_assets_dir()
25
26
    test_filepath = os.path.join(test_dirpath, "assets",
                                 "steam-train-whistle-daniel_simon.mp3")
Vincent QB's avatar
Vincent QB committed
27
28
    test_filepath_wav = os.path.join(test_dirpath, "assets",
                                     "steam-train-whistle-daniel_simon.wav")
Soumith Chintala's avatar
Soumith Chintala committed
29

David Pollack's avatar
David Pollack committed
30
    def test_1_save(self):
Vincent QB's avatar
Vincent QB committed
31
32
33
34
35
36
37
38
39
40
41
        for backend in ["sox"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_1_save(self.test_filepath, False)

        for backend in ["sox", "soundfile"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_1_save(self.test_filepath_wav, True)

    def _test_1_save(self, test_filepath, normalization):
David Pollack's avatar
David Pollack committed
42
        # load signal
Vincent QB's avatar
Vincent QB committed
43
        x, sr = torchaudio.load(test_filepath, normalization=normalization)
David Pollack's avatar
David Pollack committed
44
45
46
47
48
49
50
51
52
53
54
55
56
57

        # check save
        new_filepath = os.path.join(self.test_dirpath, "test.wav")
        torchaudio.save(new_filepath, x, sr)
        self.assertTrue(os.path.isfile(new_filepath))
        os.unlink(new_filepath)

        # check automatic normalization
        x /= 1 << 31
        torchaudio.save(new_filepath, x, sr)
        self.assertTrue(os.path.isfile(new_filepath))
        os.unlink(new_filepath)

        # test save 1d tensor
David Pollack's avatar
David Pollack committed
58
        x = x[0, :]  # get mono signal
Soumith Chintala's avatar
Soumith Chintala committed
59
        x.squeeze_()  # remove channel dim
David Pollack's avatar
David Pollack committed
60
61
62
63
64
65
        torchaudio.save(new_filepath, x, sr)
        self.assertTrue(os.path.isfile(new_filepath))
        os.unlink(new_filepath)

        # don't allow invalid sizes as inputs
        with self.assertRaises(ValueError):
David Pollack's avatar
David Pollack committed
66
            x.unsqueeze_(1)  # L x C not C x L
David Pollack's avatar
David Pollack committed
67
68
69
70
71
            torchaudio.save(new_filepath, x, sr)

        with self.assertRaises(ValueError):
            x.squeeze_()
            x.unsqueeze_(1)
Soumith Chintala's avatar
Soumith Chintala committed
72
            x.unsqueeze_(0)  # 1 x L x 1
David Pollack's avatar
David Pollack committed
73
74
75
76
            torchaudio.save(new_filepath, x, sr)

        # don't save to folders that don't exist
        with self.assertRaises(OSError):
77
78
            new_filepath = os.path.join(self.test_dirpath, "no-path",
                                        "test.wav")
David Pollack's avatar
David Pollack committed
79
            torchaudio.save(new_filepath, x, sr)
Soumith Chintala's avatar
Soumith Chintala committed
80

Vincent QB's avatar
Vincent QB committed
81
82
83
84
85
86
87
88
    def test_1_save_sine(self):
        for backend in ["sox", "soundfile"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_1_save_sine()

    def _test_1_save_sine(self):

89
        # save created file
90
91
        sinewave_filepath = os.path.join(self.test_dirpath, "assets",
                                         "sinewave.wav")
92
93
94
95
        sr = 16000
        freq = 440
        volume = 0.3

96
        y = (torch.cos(
97
            2 * math.pi * torch.arange(0, 4 * sr).float() * freq / sr))
David Pollack's avatar
David Pollack committed
98
        y.unsqueeze_(0)
99
        # y is between -1 and 1, so must scale
David Pollack's avatar
David Pollack committed
100
        y = (y * volume * (2**31)).long()
101
102
        torchaudio.save(sinewave_filepath, y, sr)
        self.assertTrue(os.path.isfile(sinewave_filepath))
103

104
        # test precision
David Pollack's avatar
David Pollack committed
105
        new_precision = 32
106
        new_filepath = os.path.join(self.test_dirpath, "test.wav")
David Pollack's avatar
David Pollack committed
107
108
109
110
111
        si, ei = torchaudio.info(sinewave_filepath)
        torchaudio.save(new_filepath, y, sr, new_precision)
        si32, ei32 = torchaudio.info(new_filepath)
        self.assertEqual(si.precision, 16)
        self.assertEqual(si32.precision, new_precision)
112
113
        os.unlink(new_filepath)

David Pollack's avatar
David Pollack committed
114
    def test_2_load(self):
Vincent QB's avatar
Vincent QB committed
115
116
117
118
119
120
121
122
123
124
125
        for backend in ["sox"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_2_load(self.test_filepath, 278756)

        for backend in ["sox", "soundfile"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_2_load(self.test_filepath_wav, 276858)

    def _test_2_load(self, test_filepath, length):
David Pollack's avatar
David Pollack committed
126
        # check normal loading
Vincent QB's avatar
Vincent QB committed
127
        x, sr = torchaudio.load(test_filepath)
David Pollack's avatar
David Pollack committed
128
        self.assertEqual(sr, 44100)
Vincent QB's avatar
Vincent QB committed
129
        self.assertEqual(x.size(), (2, length))
David Pollack's avatar
David Pollack committed
130
131
132

        # check offset
        offset = 15
Vincent QB's avatar
Vincent QB committed
133
134
        x, _ = torchaudio.load(test_filepath)
        x_offset, _ = torchaudio.load(test_filepath, offset=offset)
135
        self.assertTrue(x[:, offset:].allclose(x_offset))
David Pollack's avatar
David Pollack committed
136
137
138

        # check number of frames
        n = 201
Vincent QB's avatar
Vincent QB committed
139
        x, _ = torchaudio.load(test_filepath, num_frames=n)
David Pollack's avatar
David Pollack committed
140
141
142
        self.assertTrue(x.size(), (2, n))

        # check channels first
Vincent QB's avatar
Vincent QB committed
143
144
        x, _ = torchaudio.load(test_filepath, channels_first=False)
        self.assertEqual(x.size(), (length, 2))
David Pollack's avatar
David Pollack committed
145
146
147
148
149
150
151
152
153
154

        # check raising errors
        with self.assertRaises(OSError):
            torchaudio.load("file-does-not-exist.mp3")

        with self.assertRaises(OSError):
            tdir = os.path.join(
                os.path.dirname(self.test_dirpath), "torchaudio")
            torchaudio.load(tdir)

Vincent QB's avatar
Vincent QB committed
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
    def test_2_load_nonormalization(self):
        for backend in ["sox"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_2_load_nonormalization(self.test_filepath, 278756)

    def _test_2_load_nonormalization(self, test_filepath, length):

        # check no normalizing
        x, _ = torchaudio.load(test_filepath, normalization=False)
        self.assertTrue(x.min() <= -1.0)
        self.assertTrue(x.max() >= 1.0)

        # check different input tensor type
        x, _ = torchaudio.load(test_filepath, torch.LongTensor(), normalization=False)
        self.assertTrue(isinstance(x, torch.LongTensor))

David Pollack's avatar
David Pollack committed
172
    def test_3_load_and_save_is_identity(self):
Vincent QB's avatar
Vincent QB committed
173
174
175
176
177
178
        for backend in ["sox", "soundfile"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_3_load_and_save_is_identity()

    def _test_3_load_and_save_is_identity(self):
179
180
181
182
183
184
185
186
187
        input_path = os.path.join(self.test_dirpath, 'assets', 'sinewave.wav')
        tensor, sample_rate = torchaudio.load(input_path)
        output_path = os.path.join(self.test_dirpath, 'test.wav')
        torchaudio.save(output_path, tensor, sample_rate)
        tensor2, sample_rate2 = torchaudio.load(output_path)
        self.assertTrue(tensor.allclose(tensor2))
        self.assertEqual(sample_rate, sample_rate2)
        os.unlink(output_path)

Vincent QB's avatar
Vincent QB committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
    def test_3_load_and_save_is_identity_across_backend(self):
        with self.subTest():
            self._test_3_load_and_save_is_identity_across_backend("sox", "soundfile")
        with self.subTest():
            self._test_3_load_and_save_is_identity_across_backend("soundfile", "sox")

    def _test_3_load_and_save_is_identity_across_backend(self, backend1, backend2):
        with AudioBackendScope(backend1):

            input_path = os.path.join(self.test_dirpath, 'assets', 'sinewave.wav')
            tensor1, sample_rate1 = torchaudio.load(input_path)

            output_path = os.path.join(self.test_dirpath, 'test.wav')
            torchaudio.save(output_path, tensor1, sample_rate1)

        with AudioBackendScope(backend2):
            tensor2, sample_rate2 = torchaudio.load(output_path)

        self.assertTrue(tensor1.allclose(tensor2))
        self.assertEqual(sample_rate1, sample_rate2)
        os.unlink(output_path)

David Pollack's avatar
David Pollack committed
210
    def test_4_load_partial(self):
Vincent QB's avatar
Vincent QB committed
211
212
213
214
215
216
        for backend in ["sox"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_4_load_partial()

    def _test_4_load_partial(self):
David Pollack's avatar
David Pollack committed
217
218
        num_frames = 101
        offset = 201
219
220
221
222
        # load entire mono sinewave wav file, load a partial copy and then compare
        input_sine_path = os.path.join(self.test_dirpath, 'assets', 'sinewave.wav')
        x_sine_full, sr_sine = torchaudio.load(input_sine_path)
        x_sine_part, _ = torchaudio.load(input_sine_path, num_frames=num_frames, offset=offset)
223
        l1_error = x_sine_full[:, offset:(num_frames + offset)].sub(x_sine_part).abs().sum().item()
224
        # test for the correct number of samples and that the correct portion was loaded
David Pollack's avatar
David Pollack committed
225
        self.assertEqual(x_sine_part.size(1), num_frames)
226
227
228
229
230
231
232
        self.assertEqual(l1_error, 0.)
        # create a two channel version of this wavefile
        x_2ch_sine = x_sine_full.repeat(1, 2)
        out_2ch_sine_path = os.path.join(self.test_dirpath, 'assets', '2ch_sinewave.wav')
        torchaudio.save(out_2ch_sine_path, x_2ch_sine, sr_sine)
        x_2ch_sine_load, _ = torchaudio.load(out_2ch_sine_path, num_frames=num_frames, offset=offset)
        os.unlink(out_2ch_sine_path)
David Pollack's avatar
David Pollack committed
233
        l1_error = x_2ch_sine_load.sub(x_2ch_sine[:, offset:(offset + num_frames)]).abs().sum().item()
234
235
236
237
238
        self.assertEqual(l1_error, 0.)

        # test with two channel mp3
        x_2ch_full, sr_2ch = torchaudio.load(self.test_filepath, normalization=True)
        x_2ch_part, _ = torchaudio.load(self.test_filepath, normalization=True, num_frames=num_frames, offset=offset)
239
        l1_error = x_2ch_full[:, offset:(offset + num_frames)].sub(x_2ch_part).abs().sum().item()
David Pollack's avatar
David Pollack committed
240
        self.assertEqual(x_2ch_part.size(1), num_frames)
241
242
243
244
245
        self.assertEqual(l1_error, 0.)

        # check behavior if number of samples would exceed file length
        offset_ns = 300
        x_ns, _ = torchaudio.load(input_sine_path, num_frames=100000, offset=offset_ns)
David Pollack's avatar
David Pollack committed
246
        self.assertEqual(x_ns.size(1), x_sine_full.size(1) - offset_ns)
247
248
249
250
251

        # check when offset is beyond the end of the file
        with self.assertRaises(RuntimeError):
            torchaudio.load(input_sine_path, offset=100000)

David Pollack's avatar
David Pollack committed
252
    def test_5_get_info(self):
Vincent QB's avatar
Vincent QB committed
253
254
255
256
257
258
        for backend in ["sox", "soundfile"]:
            with self.subTest():
                with AudioBackendScope(backend):
                    self._test_5_get_info()

    def _test_5_get_info(self):
259
        input_path = os.path.join(self.test_dirpath, 'assets', 'sinewave.wav')
David Pollack's avatar
David Pollack committed
260
261
262
263
264
265
        channels, samples, rate, precision = (1, 64000, 16000, 16)
        si, ei = torchaudio.info(input_path)
        self.assertEqual(si.channels, channels)
        self.assertEqual(si.length, samples)
        self.assertEqual(si.rate, rate)
        self.assertEqual(ei.bits_per_sample, precision)
Soumith Chintala's avatar
Soumith Chintala committed
266

David Pollack's avatar
David Pollack committed
267
268
if __name__ == '__main__':
    unittest.main()