amine@192: import os
amine@221: import math
amine@88: from random import random
amine@192: from tempfile import TemporaryDirectory
amine@221: from unittest import TestCase
amine@86: from genty import genty, genty_dataset
amine@207: from auditok import split, AudioRegion, AudioParameterError
amine@215: from auditok.core import _duration_to_nb_windows
amine@212: from auditok.util import AudioDataSource
amine@210: from auditok.io import (
amine@210:     _normalize_use_channel,
amine@210:     _extract_selected_channel,
amine@210:     get_audio_source,
amine@210: )
amine@86: 
amine@86: 
amine@88: def _make_random_length_regions(
amine@88:     byte_seq, sampling_rate, sample_width, channels
amine@88: ):
amine@88:     regions = []
amine@88:     for b in byte_seq:
amine@88:         duration = round(random() * 10, 6)
amine@95:         data = b * int(duration * sampling_rate) * sample_width * channels
amine@88:         start = round(random() * 13, 3)
amine@88:         region = AudioRegion(
amine@88:             data, start, sampling_rate, sample_width, channels
amine@88:         )
amine@88:         regions.append(region)
amine@88:     return regions
amine@88: 
amine@88: 
amine@86: @genty
amine@215: class TestFunctions(TestCase):
amine@215:     @genty_dataset(
amine@221:         zero_duration=(0, 1, None, 0),
amine@221:         multiple=(0.3, 0.1, round, 3),
amine@221:         not_multiple_ceil=(0.35, 0.1, math.ceil, 4),
amine@221:         not_multiple_floor=(0.35, 0.1, math.floor, 3),
amine@221:         small_duration=(0.05, 0.1, round, 0),
amine@221:         small_duration_ceil=(0.05, 0.1, math.ceil, 1),
amine@221:         negative_duration=(-0.5, 0.1, math.ceil, ValueError),
amine@221:         negative_analysis_window=(0.5, -0.1, math.ceil, ValueError),
amine@215:     )
amine@221:     def test_duration_to_nb_windows(
amine@221:         self, duration, analysis_window, round_fn, expected
amine@221:     ):
amine@221:         if expected == ValueError:
amine@215:             with self.assertRaises(expected):
amine@221:                 _duration_to_nb_windows(duration, analysis_window, round_fn)
amine@215:         else:
amine@221:             result = _duration_to_nb_windows(
amine@221:                 duration, analysis_window, round_fn
amine@221:             )
amine@215:             self.assertEqual(result, expected)
amine@215: 
amine@215: 
amine@215: @genty
amine@207: class TestSplit(TestCase):
amine@207:     @genty_dataset(
amine@207:         simple=(
amine@207:             0.2,
amine@207:             5,
amine@207:             0.2,
amine@207:             False,
amine@207:             False,
amine@207:             {"eth": 50},
amine@207:             [(2, 16), (17, 31), (34, 76)],
amine@207:         ),
amine@214:         short_max_dur=(
amine@214:             0.3,
amine@214:             2,
amine@214:             0.2,
amine@214:             False,
amine@214:             False,
amine@214:             {"eth": 50},
amine@214:             [(2, 16), (17, 31), (34, 54), (54, 74), (74, 76)],
amine@214:         ),
amine@214:         long_min_dur=(3, 5, 0.2, False, False, {"eth": 50}, [(34, 76)]),
amine@214:         long_max_silence=(0.2, 80, 10, False, False, {"eth": 50}, [(2, 76)]),
amine@214:         zero_max_silence=(
amine@214:             0.2,
amine@214:             5,
amine@214:             0.0,
amine@214:             False,
amine@214:             False,
amine@214:             {"eth": 50},
amine@214:             [(2, 14), (17, 24), (26, 29), (34, 76)],
amine@214:         ),
amine@207:         low_energy_threshold=(
amine@207:             0.2,
amine@207:             5,
amine@207:             0.2,
amine@207:             False,
amine@207:             False,
amine@207:             {"energy_threshold": 40},
amine@207:             [(0, 50), (50, 76)],
amine@207:         ),
amine@207:         high_energy_threshold=(
amine@207:             0.2,
amine@207:             5,
amine@207:             0.2,
amine@207:             False,
amine@207:             False,
amine@207:             {"energy_threshold": 60},
amine@207:             [],
amine@207:         ),
amine@207:         trim_leading_and_trailing_silence=(
amine@207:             0.2,
amine@207:             10,  # use long max_dur
amine@207:             0.5,  # and a max_silence longer than any inter-region silence
amine@207:             True,
amine@207:             False,
amine@207:             {"eth": 50},
amine@207:             [(2, 76)],
amine@207:         ),
amine@207:         drop_trailing_silence=(
amine@207:             0.2,
amine@207:             5,
amine@207:             0.2,
amine@207:             True,
amine@207:             False,
amine@207:             {"eth": 50},
amine@207:             [(2, 14), (17, 29), (34, 76)],
amine@207:         ),
amine@207:         drop_trailing_silence_2=(
amine@207:             1.5,
amine@207:             5,
amine@207:             0.2,
amine@207:             True,
amine@207:             False,
amine@207:             {"eth": 50},
amine@207:             [(34, 76)],
amine@207:         ),
amine@207:         strict_min_dur=(
amine@207:             0.3,
amine@207:             2,
amine@207:             0.2,
amine@207:             False,
amine@207:             True,
amine@207:             {"eth": 50},
amine@207:             [(2, 16), (17, 31), (34, 54), (54, 74)],
amine@207:         ),
amine@207:     )
amine@207:     def test_split_params(
amine@207:         self,
amine@207:         min_dur,
amine@207:         max_dur,
amine@207:         max_silence,
amine@207:         drop_trailing_silence,
amine@207:         strict_min_dur,
amine@207:         kwargs,
amine@207:         expected,
amine@207:     ):
amine@207:         with open("tests/data/test_split_10HZ_mono.raw", "rb") as fp:
amine@207:             data = fp.read()
amine@207: 
amine@207:         regions = split(
amine@207:             data,
amine@207:             min_dur,
amine@207:             max_dur,
amine@207:             max_silence,
amine@207:             drop_trailing_silence,
amine@207:             strict_min_dur,
amine@207:             analysis_window=0.1,
amine@207:             sr=10,
amine@207:             sw=2,
amine@207:             ch=1,
amine@207:             **kwargs
amine@207:         )
amine@207:         regions = list(regions)
amine@207:         err_msg = "Wrong number of regions after split, expected: "
amine@210:         err_msg += "{}, found: {}".format(len(expected), len(regions))
amine@207:         self.assertEqual(len(regions), len(expected), err_msg)
amine@207: 
amine@207:         sample_width = 2
amine@207:         for reg, exp in zip(regions, expected):
amine@207:             onset, offset = exp
amine@207:             exp_data = data[onset * sample_width : offset * sample_width]
amine@207:             self.assertEqual(bytes(reg), exp_data)
amine@207: 
amine@211:     @genty_dataset(
amine@211:         stereo_all_default=(2, {}, [(2, 16), (17, 31), (34, 76)]),
amine@213:         mono_max_read=(1, {"max_read": 5}, [(2, 16), (17, 31), (34, 50)]),
amine@213:         mono_max_read_short_name=(1, {"mr": 5}, [(2, 16), (17, 31), (34, 50)]),
amine@211:         mono_use_channel_1=(
amine@211:             1,
amine@211:             {"eth": 50, "use_channel": 1},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         mono_uc_1=(1, {"eth": 50, "uc": 1}, [(2, 16), (17, 31), (34, 76)]),
amine@211:         mono_use_channel_left=(
amine@211:             1,
amine@211:             {"eth": 50, "use_channel": "left"},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         mono_uc_left=(
amine@211:             1,
amine@211:             {"eth": 50, "uc": "left"},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         mono_use_channel_None=(
amine@211:             1,
amine@211:             {"eth": 50, "use_channel": None},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         stereo_use_channel_1=(
amine@211:             2,
amine@211:             {"eth": 50, "use_channel": 1},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         stereo_use_channel_left=(
amine@211:             2,
amine@211:             {"eth": 50, "use_channel": "left"},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         stereo_use_channel_no_use_channel_given=(
amine@211:             2,
amine@211:             {"eth": 50},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         stereo_use_channel_minus_2=(
amine@211:             2,
amine@211:             {"eth": 50, "use_channel": -2},
amine@211:             [(2, 16), (17, 31), (34, 76)],
amine@211:         ),
amine@211:         stereo_uc_2=(2, {"eth": 50, "uc": 2}, [(10, 32), (36, 76)]),
amine@211:         stereo_use_channel_right=(
amine@211:             2,
amine@211:             {"eth": 50, "use_channel": "right"},
amine@211:             [(10, 32), (36, 76)],
amine@211:         ),
amine@211:         stereo_uc_minus_1=(2, {"eth": 50, "uc": -1}, [(10, 32), (36, 76)]),
amine@213:         mono_uc_mix=(
amine@213:             1,
amine@213:             {"eth": 50, "uc": "mix"},
amine@213:             [(2, 16), (17, 31), (34, 76)],
amine@213:         ),
amine@213:         stereo_use_channel_mix=(
amine@213:             2,
amine@213:             {"energy_threshold": 53.5, "use_channel": "mix"},
amine@213:             [(54, 76)],
amine@213:         ),
amine@213:         stereo_uc_mix=(2, {"eth": 52, "uc": "mix"}, [(17, 26), (54, 76)]),
amine@213:         stereo_uc_mix_default_eth=(
amine@213:             2,
amine@213:             {"uc": "mix"},
amine@213:             [(10, 16), (17, 31), (36, 76)],
amine@213:         ),
amine@211:     )
amine@211:     def test_split_kwargs(self, channels, kwargs, expected):
amine@211: 
amine@211:         mono_or_stereo = "mono" if channels == 1 else "stereo"
amine@211:         filename = "tests/data/test_split_10HZ_{}.raw".format(mono_or_stereo)
amine@211:         with open(filename, "rb") as fp:
amine@211:             data = fp.read()
amine@211: 
amine@211:         regions = split(
amine@211:             data,
amine@211:             min_dur=0.2,
amine@211:             max_dur=5,
amine@211:             max_silence=0.2,
amine@211:             drop_trailing_silence=False,
amine@211:             strict_min_dur=False,
amine@211:             analysis_window=0.1,
amine@211:             sr=10,
amine@211:             sw=2,
amine@211:             ch=channels,
amine@211:             **kwargs
amine@211:         )
amine@212:         regions = list(regions)
amine@211:         sample_width = 2
amine@211:         import numpy as np
amine@211: 
amine@211:         use_channel = kwargs.get("use_channel", kwargs.get("uc"))
amine@211:         # extrat channel of interest
amine@211:         if channels != 1:
amine@211:             use_channel = kwargs.get("use_channel", kwargs.get("uc"))
amine@211:             use_channel = _normalize_use_channel(use_channel)
amine@211:             data = _extract_selected_channel(
amine@211:                 data, channels, sample_width, use_channel=use_channel
amine@211:             )
amine@211:         err_msg = "Wrong number of regions after split, expected: "
amine@211:         err_msg += "{}, found: {}".format(expected, regions)
amine@211:         self.assertEqual(len(regions), len(expected), err_msg)
amine@212:         for reg, exp in zip(regions, expected):
amine@212:             onset, offset = exp
amine@212:             exp_data = data[onset * sample_width : offset * sample_width]
amine@212:             self.assertEqual(bytes(reg), exp_data)
amine@211: 
amine@212:     @genty_dataset(
amine@220:         mono_aw_0_2_max_silence_0_2=(
amine@220:             0.2,
amine@220:             5,
amine@220:             0.2,
amine@220:             1,
amine@220:             {"uc": 1, "aw": 0.2},
amine@220:             [(2, 30), (34, 76)],
amine@220:         ),
amine@220:         mono_aw_0_2_max_silence_0_3=(
amine@220:             0.2,
amine@220:             5,
amine@220:             0.3,
amine@220:             1,
amine@220:             {"uc": 1, "aw": 0.2},
amine@227:             [(2, 30), (34, 76)],
amine@220:         ),
amine@220:         mono_aw_0_2_max_silence_0_4=(
amine@220:             0.2,
amine@220:             5,
amine@227:             0.4,
amine@220:             1,
amine@220:             {"uc": 1, "aw": 0.2},
amine@220:             [(2, 32), (34, 76)],
amine@220:         ),
amine@220:         mono_aw_0_2=(
amine@220:             0.2,
amine@220:             5,
amine@220:             0.2,
amine@220:             1,
amine@220:             {"uc": 1, "aw": 0.2},
amine@220:             [(2, 30), (34, 76)],
amine@220:         ),
amine@220:         stereo_uc_1_analysis_window_0_2=(
amine@220:             0.2,
amine@220:             5,
amine@220:             0.2,
amine@220:             2,
amine@220:             {"uc": 1, "analysis_window": 0.2},
amine@220:             [(2, 30), (34, 76)],
amine@220:         ),
amine@220:     )
amine@220:     def test_split_analysis_window(
amine@220:         self, min_dur, max_dur, max_silence, channels, kwargs, expected
amine@220:     ):
amine@220: 
amine@220:         mono_or_stereo = "mono" if channels == 1 else "stereo"
amine@220:         filename = "tests/data/test_split_10HZ_{}.raw".format(mono_or_stereo)
amine@220:         with open(filename, "rb") as fp:
amine@220:             data = fp.read()
amine@220: 
amine@220:         regions = split(
amine@220:             data,
amine@220:             min_dur=min_dur,
amine@220:             max_dur=max_dur,
amine@220:             max_silence=max_silence,
amine@220:             drop_trailing_silence=False,
amine@220:             strict_min_dur=False,
amine@220:             sr=10,
amine@220:             sw=2,
amine@220:             ch=channels,
amine@220:             **kwargs
amine@220:         )
amine@220:         regions = list(regions)
amine@220:         sample_width = 2
amine@220:         import numpy as np
amine@220: 
amine@220:         use_channel = kwargs.get("use_channel", kwargs.get("uc"))
amine@220:         # extrat channel of interest
amine@220:         if channels != 1:
amine@220:             use_channel = kwargs.get("use_channel", kwargs.get("uc"))
amine@220:             use_channel = _normalize_use_channel(use_channel)
amine@220:             data = _extract_selected_channel(
amine@220:                 data, channels, sample_width, use_channel=use_channel
amine@220:             )
amine@220:         err_msg = "Wrong number of regions after split, expected: "
amine@220:         err_msg += "{}, found: {}".format(expected, regions)
amine@220:         self.assertEqual(len(regions), len(expected), err_msg)
amine@220:         for reg, exp in zip(regions, expected):
amine@220:             onset, offset = exp
amine@220:             exp_data = data[onset * sample_width : offset * sample_width]
amine@220:             self.assertEqual(bytes(reg), exp_data)
amine@220: 
amine@220:     @genty_dataset(
amine@212:         filename_audio_format=(
amine@212:             "tests/data/test_split_10HZ_stereo.raw",
amine@212:             {"audio_format": "raw", "sr": 10, "sw": 2, "ch": 2},
amine@212:         ),
amine@212:         filename_audio_format_short_name=(
amine@212:             "tests/data/test_split_10HZ_stereo.raw",
amine@212:             {"fmt": "raw", "sr": 10, "sw": 2, "ch": 2},
amine@212:         ),
amine@212:         filename_no_audio_format=(
amine@212:             "tests/data/test_split_10HZ_stereo.raw",
amine@212:             {"sr": 10, "sw": 2, "ch": 2},
amine@212:         ),
amine@212:         filename_no_long_audio_params=(
amine@212:             "tests/data/test_split_10HZ_stereo.raw",
amine@212:             {"sampling_rate": 10, "sample_width": 2, "channels": 2},
amine@212:         ),
amine@212:         bytes_=(
amine@212:             open("tests/data/test_split_10HZ_stereo.raw", "rb").read(),
amine@212:             {"sr": 10, "sw": 2, "ch": 2},
amine@212:         ),
amine@212:         audio_reader=(
amine@212:             AudioDataSource(
amine@212:                 "tests/data/test_split_10HZ_stereo.raw",
amine@212:                 sr=10,
amine@212:                 sw=2,
amine@212:                 ch=2,
amine@212:                 block_dur=0.1,
amine@212:             ),
amine@212:             {},
amine@212:         ),
amine@212:         audio_region=(
amine@212:             AudioRegion(
amine@212:                 open("tests/data/test_split_10HZ_stereo.raw", "rb").read(),
amine@212:                 0,
amine@212:                 10,
amine@212:                 2,
amine@212:                 2,
amine@212:             ),
amine@212:             {},
amine@212:         ),
amine@212:         audio_source=(
amine@212:             get_audio_source(
amine@212:                 "tests/data/test_split_10HZ_stereo.raw", sr=10, sw=2, ch=2
amine@212:             ),
amine@212:             {},
amine@212:         ),
amine@212:     )
amine@212:     def test_split_input_type(self, input, kwargs):
amine@212: 
amine@212:         with open("tests/data/test_split_10HZ_mono.raw", "rb") as fp:
amine@212:             data = fp.read()
amine@212: 
amine@212:         regions = split(
amine@212:             input,
amine@212:             min_dur=0.2,
amine@212:             max_dur=5,
amine@212:             max_silence=0.2,
amine@212:             drop_trailing_silence=False,
amine@212:             strict_min_dur=False,
amine@212:             analysis_window=0.1,
amine@212:             **kwargs
amine@212:         )
amine@212:         regions = list(regions)
amine@212:         expected = [(2, 16), (17, 31), (34, 76)]
amine@212:         sample_width = 2
amine@212:         err_msg = "Wrong number of regions after split, expected: "
amine@212:         err_msg += "{}, found: {}".format(expected, regions)
amine@212:         self.assertEqual(len(regions), len(expected), err_msg)
amine@211:         for reg, exp in zip(regions, expected):
amine@211:             onset, offset = exp
amine@211:             exp_data = data[onset * sample_width : offset * sample_width]
amine@211:             self.assertEqual(bytes(reg), exp_data)
amine@211: 
amine@223:     @genty_dataset(
amine@223:         min_dur_greater_than_max_dur=(0.5, 0.4, 0.1),
amine@223:         durations_OK_but_wrong_number_of_analysis_windows=(0.44, 0.49, 0.1),
amine@223:     )
amine@223:     def test_split_wrong_min_max_dur(self, min_dur, max_dur, analysis_window):
amine@223: 
amine@223:         with self.assertRaises(ValueError) as val_err:
amine@223:             split(
amine@223:                 b"0" * 16,
amine@223:                 min_dur=min_dur,
amine@223:                 max_dur=max_dur,
amine@223:                 max_silence=0.2,
amine@223:                 sr=16000,
amine@223:                 sw=1,
amine@223:                 ch=1,
amine@223:                 analysis_window=analysis_window,
amine@223:             )
amine@223: 
amine@223:         err_msg = "'min_dur' ({0} sec.) results in {1} analysis "
amine@223:         err_msg += "window(s) ({1} == ceil({0} / {2})) which is "
amine@223:         err_msg += "higher than the number of analysis window(s) for "
amine@223:         err_msg += "'max_dur' ({3} == floor({4} / {2}))"
amine@223: 
amine@223:         err_msg = err_msg.format(
amine@223:             min_dur,
amine@223:             math.ceil(min_dur / analysis_window),
amine@223:             analysis_window,
amine@223:             math.floor(max_dur / analysis_window),
amine@223:             max_dur,
amine@223:         )
amine@223:         self.assertEqual(err_msg, str(val_err.exception))
amine@223: 
amine@224:     @genty_dataset(
amine@224:         max_silence_equals_max_dur=(0.5, 0.5, 0.1),
amine@224:         max_silence_greater_than_max_dur=(0.5, 0.4, 0.1),
amine@224:         durations_OK_but_wrong_number_of_analysis_windows=(0.44, 0.49, 0.1),
amine@224:     )
amine@224:     def test_split_wrong_max_silence_max_dur(
amine@224:         self, max_silence, max_dur, analysis_window
amine@224:     ):
amine@224: 
amine@224:         with self.assertRaises(ValueError) as val_err:
amine@224:             split(
amine@224:                 b"0" * 16,
amine@224:                 min_dur=0.2,
amine@224:                 max_dur=max_dur,
amine@224:                 max_silence=max_silence,
amine@224:                 sr=16000,
amine@224:                 sw=1,
amine@224:                 ch=1,
amine@224:                 analysis_window=analysis_window,
amine@224:             )
amine@224: 
amine@224:         err_msg = "'max_silence' ({0} sec.) results in {1} analysis "
amine@224:         err_msg += "window(s) ({1} == floor({0} / {2})) which is "
amine@224:         err_msg += "higher or equal to the number of analysis window(s) for "
amine@224:         err_msg += "'max_dur' ({3} == floor({4} / {2}))"
amine@224: 
amine@224:         err_msg = err_msg.format(
amine@224:             max_silence,
amine@224:             math.floor(max_silence / analysis_window),
amine@224:             analysis_window,
amine@224:             math.floor(max_dur / analysis_window),
amine@224:             max_dur,
amine@224:         )
amine@224:         self.assertEqual(err_msg, str(val_err.exception))
amine@224: 
amine@226:     @genty_dataset(
amine@226:         negative_min_dur=({"min_dur": -1},),
amine@226:         zero_min_dur=({"min_dur": 0},),
amine@226:         negative_max_dur=({"max_dur": -1},),
amine@226:         zero_max_dur=({"max_dur": 0},),
amine@226:         negative_max_silence=({"max_silence": -1},),
amine@226:     )
amine@226:     def test_split_negative_temporal_params(self, wrong_param):
amine@226: 
amine@226:         params = {"min_dur": 0.2, "max_dur": 0.5, "max_silence": 0.1}
amine@226:         params.update(wrong_param)
amine@226:         with self.assertRaises(ValueError) as val_err:
amine@226:             split(None, **params)
amine@226: 
amine@226:         name = set(wrong_param).pop()
amine@226:         value = wrong_param[name]
amine@226:         err_msg = "'{}' ({}) must be >{} 0".format(
amine@226:             name, value, "=" if name == "max_silence" else ""
amine@226:         )
amine@226:         self.assertEqual(err_msg, str(val_err.exception))
amine@226: 
amine@207: 
amine@207: @genty
amine@207: class TestAudioRegion(TestCase):
amine@86:     @genty_dataset(
amine@86:         simple=(b"\0" * 8000, 0, 8000, 1, 1, 1, 1, 1000),
amine@86:         one_ms_less_than_1_sec=(
amine@86:             b"\0" * 7992,
amine@86:             0,
amine@86:             8000,
amine@86:             1,
amine@86:             1,
amine@86:             0.999,
amine@86:             0.999,
amine@86:             999,
amine@86:         ),
amine@86:         tree_quarter_ms_less_than_1_sec=(
amine@86:             b"\0" * 7994,
amine@86:             0,
amine@86:             8000,
amine@86:             1,
amine@86:             1,
amine@86:             0.99925,
amine@86:             0.99925,
amine@86:             999,
amine@86:         ),
amine@86:         half_ms_less_than_1_sec=(
amine@86:             b"\0" * 7996,
amine@86:             0,
amine@86:             8000,
amine@86:             1,
amine@86:             1,
amine@86:             0.9995,
amine@86:             0.9995,
amine@86:             1000,
amine@86:         ),
amine@86:         quarter_ms_less_than_1_sec=(
amine@86:             b"\0" * 7998,
amine@86:             0,
amine@86:             8000,
amine@86:             1,
amine@86:             1,
amine@86:             0.99975,
amine@86:             0.99975,
amine@86:             1000,
amine@86:         ),
amine@86:         simple_sample_width_2=(b"\0" * 8000 * 2, 0, 8000, 2, 1, 1, 1, 1000),
amine@86:         simple_stereo=(b"\0" * 8000 * 2, 0, 8000, 1, 2, 1, 1, 1000),
amine@86:         simple_multichannel=(b"\0" * 8000 * 5, 0, 8000, 1, 5, 1, 1, 1000),
amine@86:         simple_sample_width_2_multichannel=(
amine@86:             b"\0" * 8000 * 2 * 5,
amine@86:             0,
amine@86:             8000,
amine@86:             2,
amine@86:             5,
amine@86:             1,
amine@86:             1,
amine@86:             1000,
amine@86:         ),
amine@86:         one_ms_less_than_1s_sw_2_multichannel=(
amine@86:             b"\0" * 7992 * 2 * 5,
amine@86:             0,
amine@86:             8000,
amine@86:             2,
amine@86:             5,
amine@86:             0.999,
amine@86:             0.999,
amine@86:             999,
amine@86:         ),
amine@86:         tree_qrt_ms_lt_1_s_sw_2_multichannel=(
amine@86:             b"\0" * 7994 * 2 * 5,
amine@86:             0,
amine@86:             8000,
amine@86:             2,
amine@86:             5,
amine@86:             0.99925,
amine@86:             0.99925,
amine@86:             999,
amine@86:         ),
amine@86:         half_ms_lt_1s_sw_2_multichannel=(
amine@86:             b"\0" * 7996 * 2 * 5,
amine@86:             0,
amine@86:             8000,
amine@86:             2,
amine@86:             5,
amine@86:             0.9995,
amine@86:             0.9995,
amine@86:             1000,
amine@86:         ),
amine@86:         quarter_ms_lt_1s_sw_2_multichannel=(
amine@86:             b"\0" * 7998 * 2 * 5,
amine@86:             0,
amine@86:             8000,
amine@86:             2,
amine@86:             5,
amine@86:             0.99975,
amine@86:             0.99975,
amine@86:             1000,
amine@86:         ),
amine@86:         arbitrary_length_1=(
amine@86:             b"\0" * int(8000 * 1.33),
amine@86:             2.7,
amine@86:             8000,
amine@86:             1,
amine@86:             1,
amine@86:             4.03,
amine@86:             1.33,
amine@86:             1330,
amine@86:         ),
amine@86:         arbitrary_length_2=(
amine@86:             b"\0" * int(8000 * 0.476),
amine@86:             11.568,
amine@86:             8000,
amine@86:             1,
amine@86:             1,
amine@86:             12.044,
amine@86:             0.476,
amine@86:             476,
amine@86:         ),
amine@86:         arbitrary_length_sw_2_multichannel=(
amine@86:             b"\0" * int(8000 * 1.711) * 2 * 3,
amine@86:             9.415,
amine@86:             8000,
amine@86:             2,
amine@86:             3,
amine@86:             11.126,
amine@86:             1.711,
amine@86:             1711,
amine@86:         ),
amine@86:         arbitrary_samplig_rate=(
amine@86:             b"\0" * int(3172 * 1.318),
amine@86:             17.236,
amine@86:             3172,
amine@86:             1,
amine@86:             1,
amine@86:             17.236 + int(3172 * 1.318) / 3172,
amine@86:             int(3172 * 1.318) / 3172,
amine@86:             1318,
amine@86:         ),
amine@86:         arbitrary_sr_sw_2_multichannel=(
amine@86:             b"\0" * int(11317 * 0.716) * 2 * 3,
amine@86:             18.811,
amine@86:             11317,
amine@86:             2,
amine@86:             3,
amine@86:             18.811 + int(11317 * 0.716) / 11317,
amine@86:             int(11317 * 0.716) / 11317,
amine@86:             716,
amine@86:         ),
amine@86:     )
amine@86:     def test_creation(
amine@86:         self,
amine@86:         data,
amine@86:         start,
amine@86:         sampling_rate,
amine@86:         sample_width,
amine@86:         channels,
amine@86:         expected_end,
amine@86:         expected_duration_s,
amine@86:         expected_duration_ms,
amine@86:     ):
amine@86:         region = AudioRegion(
amine@86:             data, start, sampling_rate, sample_width, channels
amine@86:         )
amine@86:         self.assertEqual(region.sampling_rate, sampling_rate)
amine@86:         self.assertEqual(region.sr, sampling_rate)
amine@86:         self.assertEqual(region.sample_width, sample_width)
amine@86:         self.assertEqual(region.sw, sample_width)
amine@86:         self.assertEqual(region.channels, channels)
amine@86:         self.assertEqual(region.ch, channels)
amine@86:         self.assertEqual(region.start, start)
amine@86:         self.assertEqual(region.end, expected_end)
amine@86:         self.assertEqual(region.duration, expected_duration_s)
amine@86:         self.assertEqual(len(region), expected_duration_ms)
amine@86:         self.assertEqual(bytes(region), data)
amine@88: 
amine@97:     def test_creation_invalid_data_exception(self):
amine@97:         with self.assertRaises(AudioParameterError) as audio_param_err:
amine@97:             _ = AudioRegion(
amine@97:                 data=b"ABCDEFGHI",
amine@97:                 start=0,
amine@97:                 sampling_rate=8,
amine@97:                 sample_width=2,
amine@97:                 channels=1,
amine@97:             )
amine@97:         self.assertEqual(
amine@97:             "The length of audio data must be an integer "
amine@97:             "multiple of `sample_width * channels`",
amine@97:             str(audio_param_err.exception),
amine@97:         )
amine@97: 
amine@88:     @genty_dataset(
amine@192:         simple=("output.wav", 1.230, "output.wav"),
amine@192:         start=("output_{start}.wav", 1.230, "output_1.23.wav"),
amine@192:         start_2=("output_{start}.wav", 1.233712, "output_1.233712.wav"),
amine@192:         start_3=("output_{start}.wav", 1.2300001, "output_1.23.wav"),
amine@192:         start_4=("output_{start:.3f}.wav", 1.233712, "output_1.234.wav"),
amine@192:         start_5=(
amine@192:             "output_{start:.8f}.wav",
amine@192:             1.233712345,
amine@192:             "output_1.23371200.wav",
amine@192:         ),
amine@192:         start_end_duration=(
amine@192:             "output_{start}_{end}_{duration}.wav",
amine@192:             1.455,
amine@192:             "output_1.455_2.455_1.0.wav",
amine@192:         ),
amine@192:         start_end_duration_2=(
amine@192:             "output_{start}_{end}_{duration}.wav",
amine@192:             1.455321,
amine@192:             "output_1.455321_2.455321_1.0.wav",
amine@192:         ),
amine@192:     )
amine@192:     def test_save(self, format, start, expected):
amine@192:         with TemporaryDirectory() as tmpdir:
amine@192:             region = AudioRegion(b"0" * 160, start, 160, 1, 1)
amine@192:             format = os.path.join(tmpdir, format)
amine@192:             filename = region.save(format)[len(tmpdir) + 1 :]
amine@192:             self.assertEqual(filename, expected)
amine@192: 
amine@193:     def test_save_file_exists_exception(self):
amine@193:         with TemporaryDirectory() as tmpdir:
amine@193:             filename = os.path.join(tmpdir, "output.wav")
amine@193:             open(filename, "w").close()
amine@193:             region = AudioRegion(b"0" * 160, 0, 160, 1, 1)
amine@193:             with self.assertRaises(FileExistsError):
amine@193:                 region.save(filename, exists_ok=False)
amine@193: 
amine@192:     @genty_dataset(
amine@194:         first_half=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(0, 500),
amine@194:             0,
amine@194:             b"a" * 80,
amine@194:         ),
amine@194:         second_half=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(500, None),
amine@194:             0.5,
amine@194:             b"b" * 80,
amine@194:         ),
amine@194:         second_half_negative=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(-500, None),
amine@194:             0.5,
amine@194:             b"b" * 80,
amine@194:         ),
amine@194:         middle=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(200, 750),
amine@194:             0.2,
amine@194:             b"a" * 48 + b"b" * 40,
amine@194:         ),
amine@194:         middle_negative=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(-800, -250),
amine@194:             0.2,
amine@194:             b"a" * 48 + b"b" * 40,
amine@194:         ),
amine@194:         middle_sw2=(
amine@194:             AudioRegion(b"a" * 160 + b"b" * 160, 0, 160, 2, 1),
amine@194:             slice(200, 750),
amine@194:             0.2,
amine@194:             b"a" * 96 + b"b" * 80,
amine@194:         ),
amine@194:         middle_ch2=(
amine@194:             AudioRegion(b"a" * 160 + b"b" * 160, 0, 160, 1, 2),
amine@194:             slice(200, 750),
amine@194:             0.2,
amine@194:             b"a" * 96 + b"b" * 80,
amine@194:         ),
amine@194:         middle_sw2_ch2=(
amine@194:             AudioRegion(b"a" * 320 + b"b" * 320, 0, 160, 2, 2),
amine@194:             slice(200, 750),
amine@194:             0.2,
amine@194:             b"a" * 192 + b"b" * 160,
amine@194:         ),
amine@194:         but_first_sample=(
amine@194:             AudioRegion(b"a" * 4000 + b"b" * 4000, 0, 8000, 1, 1),
amine@194:             slice(1, None),
amine@194:             0.001,
amine@194:             b"a" * (4000 - 8) + b"b" * 4000,
amine@194:         ),
amine@194:         but_first_sample_negative=(
amine@194:             AudioRegion(b"a" * 4000 + b"b" * 4000, 0, 8000, 1, 1),
amine@194:             slice(-999, None),
amine@194:             0.001,
amine@194:             b"a" * (4000 - 8) + b"b" * 4000,
amine@194:         ),
amine@194:         but_last_sample=(
amine@194:             AudioRegion(b"a" * 4000 + b"b" * 4000, 0, 8000, 1, 1),
amine@194:             slice(0, 999),
amine@194:             0,
amine@194:             b"a" * 4000 + b"b" * (4000 - 8),
amine@194:         ),
amine@194:         but_last_sample_negative=(
amine@194:             AudioRegion(b"a" * 4000 + b"b" * 4000, 0, 8000, 1, 1),
amine@194:             slice(0, -1),
amine@194:             0,
amine@194:             b"a" * 4000 + b"b" * (4000 - 8),
amine@194:         ),
amine@194:         big_negative_start=(
amine@194:             AudioRegion(b"a" * 160, 0, 160, 1, 1),
amine@194:             slice(-5000, None),
amine@194:             0,
amine@194:             b"a" * 160,
amine@194:         ),
amine@194:         big_negative_stop=(
amine@194:             AudioRegion(b"a" * 160, 0, 160, 1, 1),
amine@194:             slice(None, -1500),
amine@194:             0,
amine@194:             b"",
amine@194:         ),
amine@194:         empty=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(0, 0),
amine@194:             0,
amine@194:             b"",
amine@194:         ),
amine@194:         empty_start_stop_reversed=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(200, 100),
amine@194:             0.2,
amine@194:             b"",
amine@194:         ),
amine@194:         empty_big_positive_start=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(2000, 3000),
amine@194:             2,
amine@194:             b"",
amine@194:         ),
amine@194:         empty_negative_reversed=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(-100, -200),
amine@194:             0.9,
amine@194:             b"",
amine@194:         ),
amine@194:         empty_big_negative_stop=(
amine@194:             AudioRegion(b"a" * 80 + b"b" * 80, 0, 160, 1, 1),
amine@194:             slice(0, -2000),
amine@194:             0,
amine@194:             b"",
amine@194:         ),
amine@194:     )
amine@194:     def test_region_slicing(
amine@194:         self, region, slice_, expected_start, expected_data
amine@194:     ):
amine@194:         sub_region = region[slice_]
amine@194:         self.assertEqual(sub_region.start, expected_start)
amine@194:         self.assertEqual(bytes(sub_region), expected_data)
amine@194: 
amine@194:     @genty_dataset(
amine@88:         simple=(8000, 1, 1),
amine@88:         stereo_sw_2=(8000, 2, 2),
amine@88:         arbitray_sr_multichannel=(5413, 2, 3),
amine@88:     )
amine@88:     def test_concatenation(self, sampling_rate, sample_width, channels):
amine@88: 
amine@88:         region_1, region_2 = _make_random_length_regions(
amine@88:             [b"a", b"b"], sampling_rate, sample_width, channels
amine@88:         )
amine@88: 
amine@88:         expected_start = region_1.start
amine@88:         expected_duration = region_1.duration + region_2.duration
amine@88:         expected_end = expected_start + expected_duration
amine@88:         expected_data = bytes(region_1) + bytes(region_2)
amine@88:         concat_region = region_1 + region_2
amine@88: 
amine@88:         self.assertEqual(concat_region.start, expected_start)
amine@88:         self.assertAlmostEqual(concat_region.end, expected_end, places=6)
amine@88:         self.assertAlmostEqual(
amine@88:             concat_region.duration, expected_duration, places=6
amine@88:         )
amine@88:         self.assertEqual(bytes(concat_region), expected_data)
amine@88: 
amine@88:     @genty_dataset(
amine@88:         simple=(8000, 1, 1),
amine@88:         stereo_sw_2=(8000, 2, 2),
amine@88:         arbitray_sr_multichannel=(5413, 2, 3),
amine@88:     )
amine@88:     def test_concatenation_many(self, sampling_rate, sample_width, channels):
amine@88: 
amine@88:         regions = _make_random_length_regions(
amine@88:             [b"a", b"b", b"c"], sampling_rate, sample_width, channels
amine@88:         )
amine@88:         expected_start = regions[0].start
amine@88:         expected_duration = sum(r.duration for r in regions)
amine@88:         expected_end = expected_start + expected_duration
amine@88:         expected_data = b"".join(bytes(r) for r in regions)
amine@88:         concat_region = sum(regions)
amine@88: 
amine@88:         self.assertEqual(concat_region.start, expected_start)
amine@88:         self.assertAlmostEqual(concat_region.end, expected_end, places=6)
amine@88:         self.assertAlmostEqual(
amine@88:             concat_region.duration, expected_duration, places=6
amine@88:         )
amine@88:         self.assertEqual(bytes(concat_region), expected_data)
amine@88: 
amine@88:     def test_concatenation_different_sampling_rate_error(self):
amine@88: 
amine@88:         region_1 = AudioRegion(b"a" * 100, 0, 8000, 1, 1)
amine@88:         region_2 = AudioRegion(b"b" * 100, 0, 3000, 1, 1)
amine@88: 
amine@88:         with self.assertRaises(ValueError) as val_err:
amine@88:             region_1 + region_2
amine@88:         self.assertEqual(
amine@88:             "Can only concatenate AudioRegions of the same "
amine@88:             "sampling rate (8000 != 3000)",
amine@88:             str(val_err.exception),
amine@88:         )
amine@88: 
amine@88:     def test_concatenation_different_sample_width_error(self):
amine@88: 
amine@88:         region_1 = AudioRegion(b"a" * 100, 0, 8000, 2, 1)
amine@88:         region_2 = AudioRegion(b"b" * 100, 0, 8000, 4, 1)
amine@88: 
amine@88:         with self.assertRaises(ValueError) as val_err:
amine@88:             region_1 + region_2
amine@88:         self.assertEqual(
amine@88:             "Can only concatenate AudioRegions of the same "
amine@88:             "sample width (2 != 4)",
amine@88:             str(val_err.exception),
amine@88:         )
amine@88: 
amine@88:     def test_concatenation_different_number_of_channels_error(self):
amine@88: 
amine@88:         region_1 = AudioRegion(b"a" * 100, 0, 8000, 1, 1)
amine@88:         region_2 = AudioRegion(b"b" * 100, 0, 8000, 1, 2)
amine@88: 
amine@88:         with self.assertRaises(ValueError) as val_err:
amine@88:             region_1 + region_2
amine@88:         self.assertEqual(
amine@88:             "Can only concatenate AudioRegions of the same "
amine@88:             "number of channels (1 != 2)",
amine@88:             str(val_err.exception),
amine@88:         )
amine@196: 
amine@196:     @genty_dataset(
amine@196:         simple=(0.01, 0.03, 30),
amine@196:         rounded_len_floor=(0.00575, 0.01725, 17),
amine@196:         rounded_len_ceil=(0.00625, 0.01875, 19),
amine@196:     )
amine@196:     def test_multiplication(
amine@196:         self, duration, expected_duration, expected_length
amine@196:     ):
amine@196:         sw = 2
amine@196:         data = b"0" * int(duration * 8000 * sw)
amine@196:         region = AudioRegion(data, 0, 8000, sw, 1)
amine@196:         m_region = 1 * region * 3
amine@196:         self.assertEqual(bytes(m_region), data * 3)
amine@196:         self.assertEqual(m_region.sr, 8000)
amine@196:         self.assertEqual(m_region.sw, 2)
amine@196:         self.assertEqual(m_region.ch, 1)
amine@196:         self.assertEqual(m_region.duration, expected_duration)
amine@196:         self.assertEqual(len(m_region), expected_length)
amine@197: 
amine@198:     @genty_dataset(_str=("x", "str"), _float=(1.4, "float"))
amine@197:     def test_multiplication_non_int(self, factor, _type):
amine@197:         with self.assertRaises(TypeError) as type_err:
amine@198:             AudioRegion(b"0" * 80, 0, 8000, 1, 1) * factor
amine@197:             err_msg = "Can't multiply AudioRegion by a non-int of type '{}'"
amine@197:             self.assertEqual(err_msg.format(_type), str(type_err.exception))