test_sox_effects.py 11.3 KB
Newer Older
moto's avatar
moto committed
1
import math
David Pollack's avatar
David Pollack committed
2
import unittest
moto's avatar
moto committed
3

David Pollack's avatar
David Pollack committed
4
5
6
import torch
import torchaudio

7
from . import common_utils
David Pollack's avatar
David Pollack committed
8

9

moto's avatar
moto committed
10
11
12
13
@common_utils.skipIfNoSoxBackend
class Test_SoxEffectsChain(common_utils.TorchaudioTestCase):
    backend = 'sox'

14
    test_filepath = common_utils.get_asset_path("steam-train-whistle-daniel_simon.mp3")
David Pollack's avatar
David Pollack committed
15

David Pollack's avatar
David Pollack committed
16
    def test_single_channel(self):
17
        fn_sine = common_utils.get_asset_path("sinewave.wav")
David Pollack's avatar
David Pollack committed
18
19
20
21
22
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(fn_sine)
        E.append_effect_to_chain("echos", [0.8, 0.7, 40, 0.25, 63, 0.3])
        x, sr = E.sox_build_flow_effects()
        # check if effects worked
23
        # print(x.size())
David Pollack's avatar
David Pollack committed
24

David Pollack's avatar
David Pollack committed
25
26
27
    def test_rate_channels(self):
        target_rate = 16000
        target_channels = 1
David Pollack's avatar
David Pollack committed
28
        E = torchaudio.sox_effects.SoxEffectsChain()
David Pollack's avatar
David Pollack committed
29
        E.set_input_file(self.test_filepath)
David Pollack's avatar
David Pollack committed
30
31
        E.append_effect_to_chain("rate", [target_rate])
        E.append_effect_to_chain("channels", [target_channels])
David Pollack's avatar
David Pollack committed
32
33
34
35
36
        x, sr = E.sox_build_flow_effects()
        # check if effects worked
        self.assertEqual(sr, target_rate)
        self.assertEqual(x.size(0), target_channels)

David Pollack's avatar
David Pollack committed
37
    def test_lowpass_speed(self):
David Pollack's avatar
David Pollack committed
38
39
        speed = .8
        si, _ = torchaudio.info(self.test_filepath)
David Pollack's avatar
David Pollack committed
40
        E = torchaudio.sox_effects.SoxEffectsChain()
David Pollack's avatar
David Pollack committed
41
        E.set_input_file(self.test_filepath)
David Pollack's avatar
David Pollack committed
42
43
44
        E.append_effect_to_chain("lowpass", 100)
        E.append_effect_to_chain("speed", speed)
        E.append_effect_to_chain("rate", si.rate)
David Pollack's avatar
David Pollack committed
45
46
47
48
49
50
51
52
53
54
55
        x, sr = E.sox_build_flow_effects()
        # check if effects worked
        self.assertEqual(x.size(1), int((si.length / si.channels) / speed))

    def test_ulaw_and_siginfo(self):
        si_out = torchaudio.sox_signalinfo_t()
        ei_out = torchaudio.sox_encodinginfo_t()
        si_out.precision = 8
        ei_out.encoding = torchaudio.get_sox_encoding_t(9)
        ei_out.bits_per_sample = 8
        si_in, ei_in = torchaudio.info(self.test_filepath)
56
57
        si_out.rate = 44100
        si_out.channels = 2
David Pollack's avatar
David Pollack committed
58
        E = torchaudio.sox_effects.SoxEffectsChain(out_siginfo=si_out, out_encinfo=ei_out)
David Pollack's avatar
David Pollack committed
59
60
        E.set_input_file(self.test_filepath)
        x, sr = E.sox_build_flow_effects()
61
        # Note: the output was encoded into ulaw because the
David Pollack's avatar
David Pollack committed
62
        #       number of unique values in the output is less than 256.
63
        self.assertLess(x.unique().size(0), 2**8 + 1)
David Pollack's avatar
David Pollack committed
64
65
        self.assertEqual(x.numel(), si_in.length)

David Pollack's avatar
David Pollack committed
66
67
    def test_band_chorus(self):
        si_in, ei_in = torchaudio.info(self.test_filepath)
68
        ei_in.encoding = torchaudio.get_sox_encoding_t(1)
David Pollack's avatar
David Pollack committed
69
70
71
72
        E = torchaudio.sox_effects.SoxEffectsChain(out_encinfo=ei_in, out_siginfo=si_in)
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("band", ["-n", "10k", "3.5k"])
        E.append_effect_to_chain("chorus", [.5, .7, 55, 0.4, .25, 2, '-s'])
73
74
        E.append_effect_to_chain("rate", [si_in.rate])
        E.append_effect_to_chain("channels", [si_in.channels])
David Pollack's avatar
David Pollack committed
75
        x, sr = E.sox_build_flow_effects()
76
        # The chorus effect will make the output file longer than the input
David Pollack's avatar
David Pollack committed
77
78
        self.assertEqual(x.size(0), si_in.channels)
        self.assertGreaterEqual(x.size(1) * x.size(0), si_in.length)
David Pollack's avatar
David Pollack committed
79
80
81

    def test_synth(self):
        si_in, ei_in = torchaudio.info(self.test_filepath)
82
        len_in_seconds = si_in.length / si_in.channels / si_in.rate
83
        ei_in.encoding = torchaudio.get_sox_encoding_t(1)
David Pollack's avatar
David Pollack committed
84
85
        E = torchaudio.sox_effects.SoxEffectsChain(out_encinfo=ei_in, out_siginfo=si_in)
        E.set_input_file(self.test_filepath)
86
        E.append_effect_to_chain("synth", [str(len_in_seconds), "pinknoise", "mix"])
David Pollack's avatar
David Pollack committed
87
88
89
        E.append_effect_to_chain("rate", [44100])
        E.append_effect_to_chain("channels", [2])
        x, sr = E.sox_build_flow_effects()
David Pollack's avatar
David Pollack committed
90
        self.assertEqual(x.size(0), si_in.channels)
91
        self.assertEqual(si_in.length, x.size(0) * x.size(1))
David Pollack's avatar
David Pollack committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

    def test_gain(self):
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("gain", ["5"])
        x, sr = E.sox_build_flow_effects()
        E.clear_chain()
        self.assertTrue(x.abs().max().item(), 1.)
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("gain", ["-e", "-5"])
        x, sr = E.sox_build_flow_effects()
        E.clear_chain()
        self.assertLess(x.abs().max().item(), 1.)
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("gain", ["-b", "8"])
        x, sr = E.sox_build_flow_effects()
        E.clear_chain()
        self.assertTrue(x.abs().max().item(), 1.)
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("gain", ["-n", "-10"])
        x, sr = E.sox_build_flow_effects()
        E.clear_chain()
        self.assertLess(x.abs().max().item(), 1.)

116
    def test_tempo_or_speed(self):
David Pollack's avatar
David Pollack committed
117
118
119
120
121
122
123
        tempo = .8
        si, _ = torchaudio.info(self.test_filepath)
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("tempo", ["-s", tempo])
        x, sr = E.sox_build_flow_effects()
        # check if effect worked
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
        self.assertAlmostEqual(x.size(1), math.ceil((si.length / si.channels) / tempo), delta=1)
        # tempo > 1
        E.clear_chain()
        tempo = 1.2
        E.append_effect_to_chain("tempo", ["-s", tempo])
        x, sr = E.sox_build_flow_effects()
        # check if effect worked
        self.assertAlmostEqual(x.size(1), math.ceil((si.length / si.channels) / tempo), delta=1)
        # tempo > 1
        E.clear_chain()
        speed = 1.2
        E.append_effect_to_chain("speed", [speed])
        E.append_effect_to_chain("rate", [si.rate])
        x, sr = E.sox_build_flow_effects()
        # check if effect worked
        self.assertAlmostEqual(x.size(1), math.ceil((si.length / si.channels) / speed), delta=1)
        # speed < 1
        E.clear_chain()
        speed = 0.8
        E.append_effect_to_chain("speed", [speed])
        E.append_effect_to_chain("rate", [si.rate])
        x, sr = E.sox_build_flow_effects()
        # check if effect worked
        self.assertAlmostEqual(x.size(1), math.ceil((si.length / si.channels) / speed), delta=1)
David Pollack's avatar
David Pollack committed
148
149
150
151
152

    def test_trim(self):
        x_orig, _ = torchaudio.load(self.test_filepath)
        offset = "10000s"
        offset_int = int(offset[:-1])
153
        num_frames = "20000s"
David Pollack's avatar
David Pollack committed
154
155
156
157
158
159
        num_frames_int = int(num_frames[:-1])
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("trim", [offset, num_frames])
        x, sr = E.sox_build_flow_effects()
        # check if effect worked
160
        self.assertTrue(x.allclose(x_orig[:, offset_int:(offset_int + num_frames_int)], rtol=1e-4, atol=1e-4))
David Pollack's avatar
David Pollack committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

    def test_silence_contrast(self):
        si, _ = torchaudio.info(self.test_filepath)
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("silence", [1, 100, 1])
        E.append_effect_to_chain("contrast", [])
        x, sr = E.sox_build_flow_effects()
        # check if effect worked
        self.assertLess(x.numel(), si.length)

    def test_reverse(self):
        x_orig, _ = torchaudio.load(self.test_filepath)
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("reverse", "")
        x_rev, _ = E.sox_build_flow_effects()
        # check if effect worked
        rev_idx = torch.LongTensor(range(x_orig.size(1))[::-1])
        self.assertTrue(x_orig.allclose(x_rev[:, rev_idx], rtol=1e-5, atol=2e-5))

    def test_compand_fade(self):
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        E.append_effect_to_chain("compand", ["0.3,1", "6:-70,-60,-20", "-5", "-90", "0.2"])
        E.append_effect_to_chain("fade", ["q", "0.25", "0", "0.33"])
        x, _ = E.sox_build_flow_effects()
        # check if effect worked
189
        # print(x.size())
David Pollack's avatar
David Pollack committed
190
191
192
193
194

    def test_biquad_delay(self):
        si, _ = torchaudio.info(self.test_filepath)
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
195
196
        E.append_effect_to_chain("biquad", ["0.25136437", "0.50272873", "0.25136437",
                                            "1.0", "-0.17123075", "0.17668821"])
David Pollack's avatar
David Pollack committed
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
        E.append_effect_to_chain("delay", ["15000s"])
        x, _ = E.sox_build_flow_effects()
        # check if effect worked
        self.assertTrue(x.size(1) == (si.length / si.channels) + 15000)

    def test_invalid_effect_name(self):
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        # there is no effect named "special"
        with self.assertRaises(LookupError):
            E.append_effect_to_chain("special", [""])

    def test_unimplemented_effect(self):
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        # the sox spectrogram function is not implemented in torchaudio
        with self.assertRaises(NotImplementedError):
            E.append_effect_to_chain("spectrogram", [""])

    def test_invalid_effect_options(self):
        E = torchaudio.sox_effects.SoxEffectsChain()
        E.set_input_file(self.test_filepath)
        # first two options should be combined to "0.3,1"
        E.append_effect_to_chain("compand", ["0.3", "1", "6:-70,-60,-20", "-5", "-90", "0.2"])
        with self.assertRaises(RuntimeError):
            E.sox_build_flow_effects()

Tomás Osório's avatar
Tomás Osório committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
    def test_fade(self):
        x_orig, _ = torchaudio.load(self.test_filepath)
        fade_in_len = 44100
        fade_out_len = 44100

        for fade_shape_sox, fade_shape_torchaudio in (("q", "quarter_sine"), ("h", "half_sine"), ("t", "linear")):
            E = torchaudio.sox_effects.SoxEffectsChain()
            E.set_input_file(self.test_filepath)
            E.append_effect_to_chain("fade", [fade_shape_sox, 1, "0", 1])
            x, sr = E.sox_build_flow_effects()

            fade = torchaudio.transforms.Fade(fade_in_len, fade_out_len, fade_shape_torchaudio)

            # check if effect worked
            self.assertTrue(x.allclose(fade(x_orig), rtol=1e-4, atol=1e-4))

Tomás Osório's avatar
Tomás Osório committed
240
241
242
243
244
245
246
247
248
249
250
251
    def test_vol(self):
        x_orig, _ = torchaudio.load(self.test_filepath)

        for gain, gain_type in ((1.1, "amplitude"), (2, "db"), (2, "power")):
            E = torchaudio.sox_effects.SoxEffectsChain()
            E.set_input_file(self.test_filepath)
            E.append_effect_to_chain("vol", [gain, gain_type])
            x, sr = E.sox_build_flow_effects()

            vol = torchaudio.transforms.Vol(gain, gain_type)
            z = vol(x_orig)
            # check if effect worked
moto's avatar
moto committed
252
            self.assertTrue(x.allclose(z, rtol=1e-4, atol=1e-4))
Tomás Osório's avatar
Tomás Osório committed
253

Artyom Astafurov's avatar
Artyom Astafurov committed
254
255
    def test_vad(self):
        sample_files = [
256
257
            common_utils.get_asset_path("vad-go-stereo-44100.wav"),
            common_utils.get_asset_path("vad-go-mono-32000.wav")
Artyom Astafurov's avatar
Artyom Astafurov committed
258
259
260
261
262
263
264
265
266
267
268
269
270
271
        ]

        for sample_file in sample_files:
            E = torchaudio.sox_effects.SoxEffectsChain()
            E.set_input_file(sample_file)
            E.append_effect_to_chain("vad")
            x, _ = E.sox_build_flow_effects()

            x_orig, sample_rate = torchaudio.load(sample_file)
            vad = torchaudio.transforms.Vad(sample_rate)

            y = vad(x_orig)
            self.assertTrue(x.allclose(y, rtol=1e-4, atol=1e-4))

David Pollack's avatar
David Pollack committed
272

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