torchrir 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

torchrir-0.1.2.dist-info/METADATA

@@ -1,271 +0,0 @@
-Metadata-Version: 2.4
-Name: torchrir
-Version: 0.1.2
-Summary: PyTorch-based room impulse response (RIR) simulation toolkit for static and dynamic scenes.
-Project-URL: Repository, https://github.com/taishi-n/torchrir
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: NOTICE
-Requires-Dist: numpy>=2.2.6
-Requires-Dist: torch>=2.10.0
-Dynamic: license-file
-
-# TorchRIR
-
-PyTorch-based room impulse response (RIR) simulation toolkit focused on a clean, modern API with GPU support.
-This project has been substantially assisted by AI using Codex.
-
-## License
-Apache-2.0. See `LICENSE` and `NOTICE`.
-
-## Installation
-```bash
-pip install torchrir
-```
-
-## Current Capabilities
-- ISM-based static and dynamic RIR simulation (2D/3D shoebox rooms).
-- Directivity patterns: `omni`, `cardioid`, `hypercardioid`, `subcardioid`, `bidir` with orientation handling.
-- Acoustic parameters: `beta` or `t60` (Sabine), optional diffuse tail via `tdiff`.
-- Dynamic convolution via `DynamicConvolver` (`trajectory` or `hop` modes).
-- GPU acceleration for ISM accumulation (CUDA/MPS; MPS disables LUT).
-- Dataset utilities with CMU ARCTIC support and example pipelines.
-- Plotting utilities for static and dynamic scenes.
-- Metadata export helpers for time axis, DOA, and array attributes (JSON-ready).
-- Unified CLI with JSON/YAML config and deterministic flag support.
-
-## Example Usage
-```bash
-# CMU ARCTIC + static RIR (fixed sources/mics)
-uv run python examples/static.py --plot
-
-# Dynamic RIR demos
-uv run python examples/dynamic_mic.py --plot
-uv run python examples/dynamic_src.py --plot
-uv run python examples/dynamic_mic.py --gif
-uv run python examples/dynamic_src.py --gif
-
-# Unified CLI
-uv run python examples/cli.py --mode static --plot
-uv run python examples/cli.py --mode dynamic_mic --plot
-uv run python examples/cli.py --mode dynamic_src --plot
-uv run python examples/cli.py --mode dynamic_mic --gif
-uv run python examples/dynamic_mic.py --gif --gif-fps 12
-
-# Config + deterministic
-uv run python examples/cli.py --mode static --deterministic --seed 123 --config-out outputs/cli.json
-uv run python examples/cli.py --config-in outputs/cli.json
-```
-GIF FPS is auto-derived from signal duration and RIR steps unless overridden with `--gif-fps`.
-For 3D rooms, an additional `*_3d.gif` is saved.
-YAML configs are supported when `PyYAML` is installed.
-```bash
-# YAML config
-uv run python examples/cli.py --mode static --config-out outputs/cli.yaml
-uv run python examples/cli.py --config-in outputs/cli.yaml
-```
-`examples/cli_example.yaml` provides a ready-to-use template.
-Examples also save `*_metadata.json` alongside audio outputs.
-
-```python
-from torchrir import DynamicConvolver, MicrophoneArray, Room, Source, simulate_rir
-
-room = Room.shoebox(size=[6.0, 4.0, 3.0], fs=16000, beta=[0.9] * 6)
-sources = Source.positions([[1.0, 2.0, 1.5]])
-mics = MicrophoneArray.positions([[2.0, 2.0, 1.5]])
-
-rir = simulate_rir(
-    room=room,
-    sources=sources,
-    mics=mics,
-    max_order=6,
-    tmax=0.3,
-    device="auto",
-)
-```
-
-```python
-from torchrir import DynamicConvolver
-
-# Trajectory-mode dynamic convolution
-y = DynamicConvolver(mode="trajectory").convolve(signal, rirs)
-
-# Hop-mode dynamic convolution
-y = DynamicConvolver(mode="hop", hop=1024).convolve(signal, rirs)
-```
-Dynamic convolution is exposed via `DynamicConvolver` only (no legacy function wrappers).
-
-## Limitations and Potential Errors
-- Ray tracing and FDTD simulators are placeholders and raise `NotImplementedError`.
-- `TemplateDataset` methods are not implemented and will raise `NotImplementedError`.
-- `simulate_rir`/`simulate_dynamic_rir` require `max_order` (or `SimulationConfig.max_order`) and either `nsample` or `tmax`.
-- Non-`omni` directivity requires orientation; mismatched shapes raise `ValueError`.
-- `beta` must have 4 (2D) or 6 (3D) elements; invalid sizes raise `ValueError`.
-- `simulate_dynamic_rir` requires `src_traj` and `mic_traj` to have matching time steps.
-- Dynamic simulation currently loops per time step; very long trajectories can be slow.
-- MPS disables the sinc LUT path (falls back to direct sinc), which can be slower and slightly different numerically.
-- Deterministic mode is best-effort; some backends may still be non-deterministic.
-- YAML configs require `PyYAML`; otherwise a `ModuleNotFoundError` is raised.
-- CMU ARCTIC downloads require network access.
-- GIF animation output requires Pillow (via matplotlib animation writer).
-
-### Dataset-agnostic utilities
-```python
-from torchrir import (
-    CmuArcticDataset,
-    binaural_mic_positions,
-    clamp_positions,
-    load_dataset_sources,
-    sample_positions,
-)
-
-def dataset_factory(speaker: str | None):
-    spk = speaker or "bdl"
-    return CmuArcticDataset("datasets/cmu_arctic", speaker=spk, download=True)
-
-signals, fs, info = load_dataset_sources(
-    dataset_factory=dataset_factory,
-    num_sources=2,
-    duration_s=10.0,
-    rng=random.Random(0),
-)
-```
-
-### Dataset template (for future extension)
-`TemplateDataset` provides a minimal stub to implement new datasets later.
-
-### Logging
-```python
-from torchrir import LoggingConfig, get_logger, setup_logging
-
-setup_logging(LoggingConfig(level="INFO"))
-logger = get_logger("examples")
-logger.info("running torchrir example")
-```
-
-### Scene container
-```python
-from torchrir import Scene
-
-scene = Scene(room=room, sources=sources, mics=mics, src_traj=src_traj, mic_traj=mic_traj)
-scene.validate()
-```
-
-### Immutable geometry helpers
-`Room`, `Source`, and `MicrophoneArray` are immutable; use `.replace()` to update fields.
-
-### Result container
-```python
-from torchrir import RIRResult
-
-result = RIRResult(rirs=rirs, scene=scene, config=config)
-```
-
-### Simulation strategies
-```python
-from torchrir import ISMSimulator
-
-sim = ISMSimulator()
-result = sim.simulate(scene, config)
-```
-
-## Device Selection
-- `device="cpu"`: CPU execution
-- `device="cuda"`: NVIDIA GPU (CUDA) if available, otherwise fallback to CPU
-- `device="mps"`: Apple Silicon GPU via Metal (MPS) if available, otherwise fallback to CPU
-- `device="auto"`: prefer CUDA → MPS → CPU
-
-```python
-from torchrir import DeviceSpec
-
-device, dtype = DeviceSpec(device="auto").resolve()
-```
-
-## References
-- [gpuRIR](https://github.com/DavidDiazGuerra/gpuRIR)
-- [Cross3D](https://github.com/DavidDiazGuerra/Cross3D)
-- [pyroomacoustics](https://github.com/LCAV/pyroomacoustics)
-- [das-generator](https://github.com/ehabets/das-generator)
-- [rir-generator](https://github.com/audiolabs/rir-generator)
-
-## Specification (Current)
-### Purpose
-- Provide room impulse response (RIR) simulation on PyTorch with CPU/CUDA/MPS support.
-- Support static and dynamic scenes with a maintainable, modern API.
-
-### Room Model
-- Shoebox (rectangular) room model.
-- 2D or 3D.
-- Image Source Method (ISM) implementation.
-
-### Inputs
-#### Scene Geometry
-- Room size: `[Lx, Ly, Lz]` (2D uses `[Lx, Ly]`).
-- Source positions: `(n_src, dim)`.
-- Microphone positions: `(n_mic, dim)`.
-- Reflection order: `max_order`.
-
-#### Acoustic Parameters
-- Sample rate: `fs`.
-- Speed of sound: `c` (default 343.0 m/s).
-- Wall reflection coefficients: `beta` (4 faces for 2D, 6 for 3D) or `t60` (Sabine).
-
-#### Output Length
-- Specify `nsample` (samples) or `tmax` (seconds).
-
-#### Directivity
-- Patterns: `omni`, `cardioid`, `hypercardioid`, `subcardioid`, `bidir`.
-- Orientation specified by vector or angles.
-
-#### Configuration
-- `SimulationConfig` controls algorithm settings (e.g., max_order, tmax, directivity, device, seed, fractional delay length, LUT, chunk sizes, compile path).
-- Passed explicitly via `simulate_rir(..., config=...)` or `simulate_dynamic_rir(..., config=...)`.
-
-### Outputs
-- Static RIR shape: `(n_src, n_mic, nsample)`.
-- Dynamic RIR shape: `(T, n_src, n_mic, nsample)`.
-- Preserves dtype/device.
-
-### Core APIs
-#### Static RIR
-```python
-room = Room.shoebox(size=[6.0, 4.0, 3.0], fs=16000, beta=[0.9] * 6)
-sources = Source.positions([[1.0, 2.0, 1.5], [4.5, 1.0, 1.2]])
-mics = MicrophoneArray.positions([[2.0, 2.0, 1.5], [3.0, 2.0, 1.5]])
-
-rir = simulate_rir(
-    room=room,
-    sources=sources,
-    mics=mics,
-    max_order=8,
-    tmax=0.4,
-    directivity="omni",
-    device="auto",
-)
-```
-
-#### Dynamic RIRs + Convolution
-```python
-rirs = simulate_dynamic_rir(
-    room=room,
-    src_traj=src_traj,   # (T, n_src, dim)
-    mic_traj=mic_traj,   # (T, n_mic, dim)
-    max_order=8,
-    tmax=0.4,
-    device="auto",
-)
-
-y = DynamicConvolver(mode="trajectory").convolve(signal, rirs)
-```
-
-### Device Control
-- `device="cpu"`, `"cuda"`, `"mps"`, or `"auto"`; resolves with fallback to CPU.
-
-## Future Work
-- Ray tracing backend: implement `RayTracingSimulator` with frequency-dependent absorption/scattering.
-- FDTD backend: implement `FDTDSimulator` with configurable grid resolution and boundary conditions.
-- Dataset expansion: add additional dataset integrations beyond CMU ARCTIC (see `TemplateDataset`).
-- Enhanced acoustics: frequency-dependent absorption and more advanced diffuse tail models.
-- Add microphone and source directivity models similar to gpuRIR/pyroomacoustics.
-- Add regression tests comparing generated RIRs against gpuRIR outputs.

torchrir-0.1.2.dist-info/RECORD

@@ -1,28 +0,0 @@
-torchrir/__init__.py,sha256=gUaLrXkWTqDSHCvU7JEB39Ynh-mWAWQGmnbV7Zghi2w,2362
-torchrir/animation.py,sha256=bQ-yWRV7oCzaFU5I1J-VdsiQAWqU1--R6vH6asxQhRw,6280
-torchrir/config.py,sha256=PsZdDIS3p4jepeNSHyd69aSD9QlOEdpG9v1SAXlZ_Fg,2295
-torchrir/core.py,sha256=1Ups0_os9ArbSA3RIPeS8ftGSygEfwCsoc28u6xy6tg,26587
-torchrir/directivity.py,sha256=v_t37YgeXF_IYzbnrk0TCs1npb_0yKR7zHiG8XV3V4w,1259
-torchrir/dynamic.py,sha256=j8W-2Xwak_v4GQ-RetzlWXyHVUmbTFs1H7dEIwYYXlA,2131
-torchrir/logging_utils.py,sha256=s4jDSSDoHT0HKeplDUpGMsdeBij4eibLSpaaAPzkB68,2146
-torchrir/metadata.py,sha256=cwoXrr_yE2bQRUPnJe6p7POMPCWa9_oabCtp--WqBE8,6958
-torchrir/plotting.py,sha256=ynimJC10QRTMVIC5vH3w1bMEN3e-0CyPHICtZzWu3XE,8145
-torchrir/plotting_utils.py,sha256=uGceTrwWmJhZ_V1FnJNp30vE13hHbXDkY3X0aAxDhvc,5169
-torchrir/results.py,sha256=-HczEfr2u91BNb1xbrIGKCj0G3yzy7l_fmUMUeKbGRw,614
-torchrir/room.py,sha256=BnqA4FY_k_RQV9PvUAX8fr15yIP-PBIrzkmAiwLPZHU,5449
-torchrir/scene.py,sha256=GuHuCspakAUOT81_ArTqaZbmBX0ApoJuCKTaZ21wGis,2435
-torchrir/scene_utils.py,sha256=Kkj1XL1Xtpf_2bk7np_AmQqUHHYC9dxwXRRYgt30EwA,2128
-torchrir/signal.py,sha256=QETI2dv5CPU4H9Jpi4CSEow4qlYVn0kbsun02h9MnP8,8253
-torchrir/simulators.py,sha256=4hBswrBc8erp4ac5O20YbcVN8V_OnjP5ANaVnOtJQ9E,3075
-torchrir/utils.py,sha256=HNQDksskfk6xLZ7XFWA7mh9GHhdfW4SthnJ5w_k58_Y,10652
-torchrir/datasets/__init__.py,sha256=3T55F3fjjRR3j618ubRkMlZnQTxvXaxioFMhygxm7oQ,601
-torchrir/datasets/base.py,sha256=mCHLtGOOaD1II1alJpP6ipzkz87l-rh19NgfeLnJbDU,720
-torchrir/datasets/cmu_arctic.py,sha256=NpF5fATptkBPjf-6fDUYrOqfl-Jvi3j9bj5wfvwmcLI,7034
-torchrir/datasets/template.py,sha256=KByYkCRm3cdTj4_jDvcZQ0Z4igilojJBH-6_W0-JIyc,2076
-torchrir/datasets/utils.py,sha256=UtG8fcBaHiJiZ8Pba9IBY5_ClA_K_ilqUpGzvnwGNpQ,3135
-torchrir-0.1.2.dist-info/licenses/LICENSE,sha256=5vS_7WTsMEw_QQHEPQ_WCwovJXEgmxoEwcwOI-9VbXI,10766
-torchrir-0.1.2.dist-info/licenses/NOTICE,sha256=SRs_q-ZqoVF9_YuuedZOvVBk01jV7YQAeF8rRvlRg0s,118
-torchrir-0.1.2.dist-info/METADATA,sha256=EWDdQ4sWDAcOgCDlg7b4QHFLu_Wm-6CXVc3sY-gx1E0,9161
-torchrir-0.1.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-torchrir-0.1.2.dist-info/top_level.txt,sha256=aIFwntowJjvm7rZk480HymC3ipDo1g-9hEbNY1wF-Oo,9
-torchrir-0.1.2.dist-info/RECORD,,