sonusai 0.20.2__py3-none-any.whl → 0.20.3__py3-none-any.whl

sonusai/metrics/calc_audio_stats.py

@@ -1,3 +1,8 @@
+from pathlib import Path
+
+import numpy as np
+from sox import Transformer as SoxTransformer
+
 from sonusai.mixture.datatypes import AudioStatsMetrics
 from sonusai.mixture.datatypes import AudioT
 
@@ -12,7 +17,6 @@ def _convert_str_with_factors_to_int(x: str) -> int:
 
 def calc_audio_stats(audio: AudioT, win_len: float | None = None) -> AudioStatsMetrics:
     from sonusai.mixture import SAMPLE_RATE
-    from sonusai.mixture import Transformer
 
     args = ["stats"]
     if win_len is not None:
@@ -53,3 +57,275 @@ def calc_audio_stats(audio: AudioT, win_len: float | None = None) -> AudioStatsM
         fl=float(stats["Flat factor"]),
         pkc=_convert_str_with_factors_to_int(stats["Pk count"]),
     )
+
+
+class Transformer(SoxTransformer):
+    """Override certain sox.Transformer methods"""
+
+    def build(  # pyright: ignore [reportIncompatibleMethodOverride]
+        self,
+        input_filepath: str | Path | None = None,
+        output_filepath: str | Path | None = None,
+        input_array: np.ndarray | None = None,
+        sample_rate_in: float | None = None,
+        extra_args: list[str] | None = None,
+        return_output: bool = False,
+    ) -> tuple[bool, str | None, str | None]:
+        """Given an input file or array, creates an output_file on disk by
+        executing the current set of commands. This function returns True on
+        success. If return_output is True, this function returns a triple of
+        (status, out, err), giving the success state, along with stdout and
+        stderr returned by sox.
+
+        Parameters
+        ----------
+        input_filepath : str or None
+            Either path to input audio file or None for array input.
+        output_filepath : str
+            Path to desired output file. If a file already exists at
+            the given path, the file will be overwritten.
+            If '-n', no file is created.
+        input_array : np.ndarray or None
+            An np.ndarray of an waveform with shape (n_samples, n_channels).
+            sample_rate_in must also be provided.
+            If None, input_filepath must be specified.
+        sample_rate_in : int
+            Sample rate of input_array.
+            This argument is ignored if input_array is None.
+        extra_args : list or None, default=None
+            If a list is given, these additional arguments are passed to SoX
+            at the end of the list of effects.
+            Don't use this argument unless you know exactly what you're doing!
+        return_output : bool, default=False
+            If True, returns the status and information sent to stderr and
+            stdout as a tuple (status, stdout, stderr).
+            If output_filepath is None, return_output=True by default.
+            If False, returns True on success.
+
+        Returns
+        -------
+        status : bool
+            True on success.
+        out : str (optional)
+            This is not returned unless return_output is True.
+            When returned, captures the stdout produced by sox.
+        err : str (optional)
+            This is not returned unless return_output is True.
+            When returned, captures the stderr produced by sox.
+
+        Examples
+        --------
+        > import numpy as np
+        > import sox
+        > tfm = sox.Transformer()
+        > sample_rate = 44100
+        > y = np.sin(2 * np.pi * 440.0 * np.arange(sample_rate * 1.0) / sample_rate)
+
+        file in, file out - basic usage
+
+        > status = tfm.build('path/to/input.wav', 'path/to/output.mp3')
+
+        file in, file out - equivalent usage
+
+        > status = tfm.build(
+                input_filepath='path/to/input.wav',
+                output_filepath='path/to/output.mp3'
+            )
+
+        array in, file out
+
+        > status = tfm.build(
+                input_array=y, sample_rate_in=sample_rate,
+                output_filepath='path/to/output.mp3'
+            )
+
+        """
+        from sox import file_info
+        from sox.core import SoxError
+        from sox.core import sox
+        from sox.log import logger
+
+        input_format, input_filepath = self._parse_inputs(input_filepath, input_array, sample_rate_in)
+
+        if output_filepath is None:
+            raise ValueError("output_filepath is not specified!")
+
+        # set output parameters
+        if input_filepath == output_filepath:
+            raise ValueError("input_filepath must be different from output_filepath.")
+        file_info.validate_output_file(output_filepath)
+
+        args = []
+        args.extend(self.globals)
+        args.extend(self._input_format_args(input_format))
+        args.append(input_filepath)
+        args.extend(self._output_format_args(self.output_format))
+        args.append(output_filepath)
+        args.extend(self.effects)
+
+        if extra_args is not None:
+            if not isinstance(extra_args, list):
+                raise ValueError("extra_args must be a list.")
+            args.extend(extra_args)
+
+        status, out, err = sox(args, input_array, True)
+        if status != 0:
+            raise SoxError(f"Stdout: {out}\nStderr: {err}")
+
+        logger.info("Created %s with effects: %s", output_filepath, " ".join(self.effects_log))
+
+        if return_output:
+            return status, out, err  # pyright: ignore [reportReturnType]
+
+        return True, None, None
+
+    def build_array(  # pyright: ignore [reportIncompatibleMethodOverride]
+        self,
+        input_filepath: str | Path | None = None,
+        input_array: np.ndarray | None = None,
+        sample_rate_in: int | None = None,
+        extra_args: list[str] | None = None,
+    ) -> np.ndarray:
+        """Given an input file or array, returns the output as a numpy array
+        by executing the current set of commands. By default, the array will
+        have the same sample rate as the input file unless otherwise specified
+        using set_output_format. Functions such as channels and convert
+        will be ignored!
+
+        The SonusAI override does not generate a warning for rate transforms.
+
+        Parameters
+        ----------
+        input_filepath : str, Path or None
+            Either path to input audio file or None.
+        input_array : np.ndarray or None
+            A np.ndarray of a waveform with shape (n_samples, n_channels).
+            If this argument is passed, sample_rate_in must also be provided.
+            If None, input_filepath must be specified.
+        sample_rate_in : int
+            Sample rate of input_array.
+            This argument is ignored if input_array is None.
+        extra_args : list or None, default=None
+            If a list is given, these additional arguments are passed to SoX
+            at the end of the list of effects.
+            Don't use this argument unless you know exactly what you're doing!
+
+        Returns
+        -------
+        output_array : np.ndarray
+            Output audio as a numpy array
+
+        Examples
+        --------
+
+        > import numpy as np
+        > import sox
+        > tfm = sox.Transformer()
+        > sample_rate = 44100
+        > y = np.sin(2 * np.pi * 440.0 * np.arange(sample_rate * 1.0) / sample_rate)
+
+        file in, array out
+
+        > output_array = tfm.build(input_filepath='path/to/input.wav')
+
+        array in, array out
+
+        > output_array = tfm.build(input_array=y, sample_rate_in=sample_rate)
+
+        specifying the output sample rate
+
+        > tfm.set_output_format(rate=8000)
+        > output_array = tfm.build(input_array=y, sample_rate_in=sample_rate)
+
+        if an effect changes the number of channels, you must explicitly
+        specify the number of output channels
+
+        > tfm.remix(remix_dictionary={1: [1], 2: [1], 3: [1]})
+        > tfm.set_output_format(channels=3)
+        > output_array = tfm.build(input_array=y, sample_rate_in=sample_rate)
+
+
+        """
+        from sox.core import SoxError
+        from sox.core import sox
+        from sox.log import logger
+        from sox.transform import ENCODINGS_MAPPING
+
+        input_format, input_filepath = self._parse_inputs(input_filepath, input_array, sample_rate_in)
+
+        # check if any of the below commands are part of the effects chain
+        ignored_commands = ["channels", "convert"]
+        if set(ignored_commands) & set(self.effects_log):
+            logger.warning(
+                "When outputting to an array, channels and convert "
+                + "effects may be ignored. Use set_output_format() to "
+                + "specify output formats."
+            )
+
+        output_filepath = "-"
+
+        if input_format.get("file_type") is None:
+            encoding_out = np.int16
+        else:
+            encoding_out = next(k for k, v in ENCODINGS_MAPPING.items() if input_format["file_type"] == v)
+
+        n_bits = np.dtype(encoding_out).itemsize * 8
+
+        output_format = {
+            "file_type": "raw",
+            "rate": sample_rate_in,
+            "bits": n_bits,
+            "channels": input_format["channels"],
+            "encoding": None,
+            "comments": None,
+            "append_comments": True,
+        }
+
+        if self.output_format.get("rate") is not None:
+            output_format["rate"] = self.output_format["rate"]
+
+        if self.output_format.get("channels") is not None:
+            output_format["channels"] = self.output_format["channels"]
+
+        if self.output_format.get("bits") is not None:
+            n_bits = self.output_format["bits"]
+            output_format["bits"] = n_bits
+
+        match n_bits:
+            case 8:
+                encoding_out = np.int8  # type: ignore[assignment]
+            case 16:
+                encoding_out = np.int16
+            case 32:
+                encoding_out = np.float32  # type: ignore[assignment]
+            case 64:
+                encoding_out = np.float64  # type: ignore[assignment]
+            case _:
+                raise ValueError(f"invalid n_bits {n_bits}")
+
+        args = []
+        args.extend(self.globals)
+        args.extend(self._input_format_args(input_format))
+        args.append(input_filepath)
+        args.extend(self._output_format_args(output_format))
+        args.append(output_filepath)
+        args.extend(self.effects)
+
+        if extra_args is not None:
+            if not isinstance(extra_args, list):
+                raise ValueError("extra_args must be a list.")
+            args.extend(extra_args)
+
+        status, out, err = sox(args, input_array, False)
+        if status != 0:
+            raise SoxError(f"Stdout: {out}\nStderr: {err}")
+
+        out = np.frombuffer(out, dtype=encoding_out)  # pyright: ignore [reportArgumentType, reportCallIssue]
+        if output_format["channels"] > 1:
+            out = out.reshape(
+                (output_format["channels"], int(len(out) / output_format["channels"])),
+                order="F",
+            ).T
+        logger.info("Created array with effects: %s", " ".join(self.effects_log))
+
+        return out

{sonusai-0.20.2.dist-info → sonusai-0.20.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sonusai
-Version: 0.20.2
+Version: 0.20.3
 Summary: Framework for building deep neural network models for sound, speech, and voice AI
 Home-page: https://aaware.com
 License: GPL-3.0-only

{sonusai-0.20.2.dist-info → sonusai-0.20.3.dist-info}/RECORD

@@ -22,7 +22,7 @@ sonusai/ir_metric.py,sha256=n35_RssAk2jjqm1iXJ6euMtK00LV4qohdBfDAZZpNlU,19581
 sonusai/lsdb.py,sha256=0HOGDDndB3LT9cz9AaxKIpt9vslAoSP4F239gply4Xg,5149
 sonusai/main.py,sha256=HbnEia1B1-Z-mlHkLfojH8aj9GIpL1Btw3oH60T_CCQ,2590
 sonusai/metrics/__init__.py,sha256=ssV6JEK_oklRSocsp6HMcG-GtJvV8IkRQtdKhHHmwU8,878
-sonusai/metrics/calc_audio_stats.py,sha256=IHgYEPaob_Nw35SaH3tyHp7Wwju4f-2-BJZ99JyeLmc,1572
+sonusai/metrics/calc_audio_stats.py,sha256=x3poP4_EzBLS8f1bnP2VzqI2nTjqEKbU1661Hngcuak,11846
 sonusai/metrics/calc_class_weights.py,sha256=SUOCdM4w03rFpyxAriPnPwCtEEFsAH3WxpK9N_fupwo,3637
 sonusai/metrics/calc_optimal_thresholds.py,sha256=0JOqU__doeOpNtgEZgeO1Kg7pttJRpITTVmqLU6TadY,3513
 sonusai/metrics/calc_pcm.py,sha256=yBQV9UJ1GK5f4c_8TNABMtZR-xyStKJCsSTT0FQGa50,1886
@@ -122,7 +122,7 @@ sonusai/utils/temp_seed.py,sha256=Ava5TCGpvDBtaRx2l-40CuGIjhgLevu1KFfZsgr38qM,21
 sonusai/utils/write_audio.py,sha256=0lKdaX57N6H-UWdioqmXCJMjwT1eBz5B-bSGqDvloAc,838
 sonusai/utils/yes_or_no.py,sha256=0h1okjXmDNbJp7rZJFR2V-HFU1GJDm3YFTUVmYExkOU,263
 sonusai/vars.py,sha256=kBBzuvC8szmdIZEEDA7XXmD765addZKdM2aFipeGO1w,933
-sonusai-0.20.2.dist-info/METADATA,sha256=CT_z1tJfku142nH0PL22DT7EEc8bFfJj9qyWcR7v6FU,2535
-sonusai-0.20.2.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-sonusai-0.20.2.dist-info/entry_points.txt,sha256=zMNjEphEPO6B3cD1GNpit7z-yA9tUU5-j3W2v-UWstU,92
-sonusai-0.20.2.dist-info/RECORD,,
+sonusai-0.20.3.dist-info/METADATA,sha256=b1BfQSo-D0xBiozUy426X-iRkK0uY9_LlZkg1ZXaSl8,2535
+sonusai-0.20.3.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+sonusai-0.20.3.dist-info/entry_points.txt,sha256=zMNjEphEPO6B3cD1GNpit7z-yA9tUU5-j3W2v-UWstU,92
+sonusai-0.20.3.dist-info/RECORD,,