torchrir 0.1.0__py3-none-any.whl

torchrir/__init__.py

@@ -0,0 +1,85 @@
+"""TorchRIR public API."""
+
+from .config import SimulationConfig, default_config
+from .core import simulate_dynamic_rir, simulate_rir
+from .dynamic import DynamicConvolver
+from .logging_utils import LoggingConfig, get_logger, setup_logging
+from .plotting import plot_scene_dynamic, plot_scene_static
+from .plotting_utils import plot_scene_and_save
+from .room import MicrophoneArray, Room, Source
+from .scene import Scene
+from .results import RIRResult
+from .simulators import FDTDSimulator, ISMSimulator, RIRSimulator, RayTracingSimulator
+from .signal import convolve_rir, fft_convolve
+from .datasets import (
+    BaseDataset,
+    CmuArcticDataset,
+    CmuArcticSentence,
+    choose_speakers,
+    list_cmu_arctic_speakers,
+    SentenceLike,
+    load_dataset_sources,
+    TemplateDataset,
+    TemplateSentence,
+    load_wav_mono,
+    save_wav,
+)
+from .scene_utils import binaural_mic_positions, clamp_positions, linear_trajectory, sample_positions
+from .utils import (
+    att2t_SabineEstimation,
+    att2t_sabine_estimation,
+    beta_SabineEstimation,
+    DeviceSpec,
+    estimate_beta_from_t60,
+    estimate_t60_from_beta,
+    resolve_device,
+    t2n,
+)
+
+__all__ = [
+    "MicrophoneArray",
+    "Room",
+    "Source",
+    "RIRResult",
+    "RIRSimulator",
+    "ISMSimulator",
+    "RayTracingSimulator",
+    "FDTDSimulator",
+    "convolve_rir",
+    "att2t_SabineEstimation",
+    "att2t_sabine_estimation",
+    "beta_SabineEstimation",
+    "DeviceSpec",
+    "BaseDataset",
+    "CmuArcticDataset",
+    "CmuArcticSentence",
+    "choose_speakers",
+    "DynamicConvolver",
+    "estimate_beta_from_t60",
+    "estimate_t60_from_beta",
+    "fft_convolve",
+    "get_logger",
+    "list_cmu_arctic_speakers",
+    "LoggingConfig",
+    "resolve_device",
+    "SentenceLike",
+    "load_dataset_sources",
+    "load_wav_mono",
+    "TemplateDataset",
+    "TemplateSentence",
+    "binaural_mic_positions",
+    "clamp_positions",
+    "linear_trajectory",
+    "sample_positions",
+    "plot_scene_dynamic",
+    "plot_scene_and_save",
+    "plot_scene_static",
+    "save_wav",
+    "Scene",
+    "setup_logging",
+    "SimulationConfig",
+    "default_config",
+    "simulate_dynamic_rir",
+    "simulate_rir",
+    "t2n",
+]

torchrir/config.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+"""Simulation configuration for torchrir."""
+
+from dataclasses import dataclass, replace
+from typing import Optional
+
+import torch
+
+
+@dataclass(frozen=True)
+class SimulationConfig:
+    """Configuration values for RIR simulation and convolution."""
+
+    fs: Optional[float] = None
+    max_order: Optional[int] = None
+    tmax: Optional[float] = None
+    directivity: Optional[str | tuple[str, str]] = None
+    device: Optional[torch.device | str] = None
+    seed: Optional[int] = None
+    use_lut: bool = True
+    mixed_precision: bool = False
+    frac_delay_length: int = 81
+    sinc_lut_granularity: int = 20
+    image_chunk_size: int = 2048
+    accumulate_chunk_size: int = 4096
+    use_compile: bool = False
+
+    def validate(self) -> None:
+        """Validate configuration values."""
+        if self.fs is not None and self.fs <= 0:
+            raise ValueError("fs must be positive")
+        if self.max_order is not None and self.max_order < 0:
+            raise ValueError("max_order must be non-negative")
+        if self.tmax is not None and self.tmax <= 0:
+            raise ValueError("tmax must be positive")
+        if self.seed is not None and self.seed < 0:
+            raise ValueError("seed must be non-negative")
+        if self.frac_delay_length <= 0 or self.frac_delay_length % 2 == 0:
+            raise ValueError("frac_delay_length must be a positive odd integer")
+        if self.sinc_lut_granularity <= 0:
+            raise ValueError("sinc_lut_granularity must be positive")
+        if self.image_chunk_size <= 0:
+            raise ValueError("image_chunk_size must be positive")
+        if self.accumulate_chunk_size <= 0:
+            raise ValueError("accumulate_chunk_size must be positive")
+
+    def replace(self, **kwargs) -> "SimulationConfig":
+        """Return a new config with updated fields."""
+        new_cfg = replace(self, **kwargs)
+        new_cfg.validate()
+        return new_cfg
+
+
+def default_config() -> SimulationConfig:
+    """Return the default simulation configuration."""
+    cfg = SimulationConfig()
+    cfg.validate()
+    return cfg