Merge pull request #5 from danielfcollier/style-rename-folders

danielfcollier · web-flow · commit d908cf37525e · 2025-12-31T17:21:11.000-03:00
style: rename folders, generic structured approach
diff --git a/docs/posts/09 - Audio Engineering.md b/docs/posts/09 - Audio Engineering.md
@@ -19,7 +19,7 @@ If the code relies solely on RMS, the system will trigger alerts for thunder but
 
 ## 🧠 The Shift to Psychoacoustics (LUFS)
 
-To solve this, I shifted the project's primary metric from RMS to **LUFS (Loudness Units Full Scale)** within the `src/umik_base_app/processing/audio_metrics.py` module.
+To solve this, I shifted the project's primary metric from RMS to **LUFS (Loudness Units Full Scale)** within the `src/umik_base_app/sinks/audio_metrics.py` module.
 
 Unlike RMS, LUFS is an audio engineering standard (ITU-R BS.1770-4) designed to model the non-linear way humans hear. It achieves this by applying **K-Weighting** - a specific filter curve applied to the signal *before* measurement.
 
@@ -51,7 +51,7 @@ By using gating, the meter indicates how loud the *events* actually were, withou
 | **Measures** | Physical Signal Power | Perceived Human Loudness |
 | **Frequency Bias** | **None** (Flat response) | **K-Weighted** (Boosts speech frequencies) |
 | **Use Case** | Protecting hardware/circuits | Normalizing audio for human listeners |
-| **Project Integration** | Legacy / Raw Data | **Active** (`src/umik_base_app/processing/audio_metrics.py`) |
+| **Project Integration** | Legacy / Raw Data | **Active** (`src/umik_base_app/sinks/audio_metrics.py`) |
 
 By switching to LUFS, this project doesn't just report how much energy is on the wire - it reports how loud the world actually sounds. It is a small detail that marks the difference between a code experiment and a piece of audio engineering.
 
diff --git a/src/scripts/audio_batch_analysis.py b/src/scripts/audio_batch_analysis.py
@@ -21,8 +21,8 @@
 import numpy as np
 from scipy.io import wavfile
 
-from src.umik_base_app.hardware.calibrator import HardwareCalibrator
-from src.umik_base_app.processing.audio_metrics import AudioMetrics
+from src.umik_base_app.hardwares.calibrator import HardwareCalibrator
+from src.umik_base_app.sinks.audio_metrics import AudioMetrics
 
 logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s", datefmt="%H:%M:%S")
 logger = logging.getLogger(__name__)
diff --git a/src/tests/hardwares/conftest.py b/src/tests/hardwares/conftest.py
diff --git a/src/tests/hardwares/test_cache_strategy.py b/src/tests/hardwares/test_cache_strategy.py
@@ -10,7 +10,7 @@
 
 import numpy as np
 
-from umik_base_app.hardware.cache_strategy import FileFilterCache, NoOpFilterCache
+from umik_base_app.hardwares.cache_strategy import FileFilterCache, NoOpFilterCache
 
 
 def test_file_cache_load_success():
diff --git a/src/tests/hardwares/test_calibrator.py b/src/tests/hardwares/test_calibrator.py
@@ -12,8 +12,8 @@
 import numpy as np
 import pytest
 
-from umik_base_app.hardware.cache_strategy import NoOpFilterCache
-from umik_base_app.hardware.calibrator import HardwareCalibrator
+from umik_base_app.hardwares.cache_strategy import NoOpFilterCache
+from umik_base_app.hardwares.calibrator import HardwareCalibrator
 from umik_base_app.settings import get_settings
 
 settings = get_settings()
@@ -46,7 +46,7 @@ def mock_firwin2():
     Mocks scipy.signal.firwin2 to avoid complex DSP calculations during tests.
     Returns a simple impulse response (identity filter).
     """
-    with patch("umik_base_app.hardware.calibrator.firwin2") as mock:
+    with patch("umik_base_app.hardwares.calibrator.firwin2") as mock:
         # Create a mock filter array.
         # HardwareCalibrator designs a filter of length `num_taps`.
         # firwin2 returns `numtaps` coefficients.
diff --git a/src/tests/hardwares/test_hardware_config.py b/src/tests/hardwares/test_hardware_config.py
@@ -8,7 +8,7 @@
 
 from unittest.mock import MagicMock
 
-from umik_base_app.hardware.config import HardwareConfig
+from umik_base_app.hardwares.config import HardwareConfig
 
 
 def test_audio_device_config_initialization():
diff --git a/src/tests/hardwares/test_selector.py b/src/tests/hardwares/test_selector.py
@@ -12,7 +12,7 @@
 import pytest
 
 # Ensure both the class and the exception are imported
-from umik_base_app.hardware.selector import HardwareNotFound, HardwareSelector
+from umik_base_app.hardwares.selector import HardwareNotFound, HardwareSelector
 
 # Mock device list returned by sd.query_devices()
 MOCK_DEVICES = [
@@ -40,7 +40,7 @@
 @pytest.fixture
 def mock_sounddevice():
     """Mock sounddevice query_devices and default attribute."""
-    with patch("umik_base_app.hardware.selector.sd") as mock_sd:
+    with patch("umik_base_app.hardwares.selector.sd") as mock_sd:
         mock_sd.query_devices.return_value = MOCK_DEVICES
         # Mock sd.default.device = [input_id, output_id]
         mock_sd.default.device = [0, 2]
@@ -78,7 +78,7 @@ def test_device_not_found_raises_exception(mock_sounddevice):
 
 def test_show_audio_devices(mock_sounddevice):
     """Test the utility method that logs available devices."""
-    with patch("umik_base_app.hardware.selector.logger") as mock_logger:
+    with patch("umik_base_app.hardwares.selector.logger") as mock_logger:
         HardwareSelector.show_audio_devices(selected_id=1)
 
         # Verify it logged the devices
diff --git a/src/tests/integration/test_zmq_topology.py b/src/tests/integration/test_zmq_topology.py
@@ -14,7 +14,7 @@
 import numpy as np
 import pytest
 
-from umik_base_app.transport.zmq_transport import ZmqConsumerTransport, ZmqProducerTransport
+from umik_base_app.transports.zmq_transport import ZmqConsumerTransport, ZmqProducerTransport
 
 
 def get_free_port():
diff --git a/src/tests/processing/conftest.py b/src/tests/processing/conftest.py
diff --git a/src/tests/sinks/conftest.py b/src/tests/sinks/conftest.py
diff --git a/src/tests/sinks/test_audio_metrics.py b/src/tests/sinks/test_audio_metrics.py
@@ -11,8 +11,8 @@
 import numpy as np
 import pytest
 
-from umik_base_app.processing.audio_metrics import AudioMetrics
 from umik_base_app.settings import get_settings
+from umik_base_app.sinks.audio_metrics import AudioMetrics
 
 settings = get_settings()
 
@@ -37,7 +37,7 @@ def metrics():
 def test_flux(metrics):
     """Test that flux calls librosa and returns the max value."""
     # Mock librosa to avoid actual DSP calculation
-    with patch("umik_base_app.processing.audio_metrics.librosa.onset.onset_strength") as mock_onset:
+    with patch("umik_base_app.sinks.audio_metrics.librosa.onset.onset_strength") as mock_onset:
         # Return a dummy envelope with a known max
         mock_onset.return_value = np.array([0.1, 0.5, 0.2])
 
@@ -72,7 +72,7 @@ def test_lufs_aggregation(metrics):
 
 def test_show_metrics(metrics):
     """Test that show_metrics logs the correct formatted string."""
-    with patch("umik_base_app.processing.audio_metrics.logger") as mock_logger:
+    with patch("umik_base_app.sinks.audio_metrics.logger") as mock_logger:
         # Pass arbitrary metrics
         metrics.show_metrics(measured_at="12:00:00", rms=0.123456, dbfs=-20.5)
 
diff --git a/src/tests/test_datetime_stamp.py b/src/tests/test_datetime_stamp.py
diff --git a/src/tests/test_pipeline.py b/src/tests/test_pipeline.py
@@ -11,8 +11,9 @@
 
 import numpy as np
 
-from umik_base_app.core.interfaces import AudioSink, AudioTransformer
-from umik_base_app.core.pipeline import AudioPipeline
+from umik_base_app.core.consumer_pipeline import AudioPipeline
+from umik_base_app.sinks.sinks_interface import AudioSink
+from umik_base_app.transformers.transformers_interface import AudioTransformer
 
 
 def test_pipeline_execution():
diff --git a/src/tests/transports/test_queue_transport.py b/src/tests/transports/test_queue_transport.py
@@ -9,7 +9,7 @@
 import numpy as np
 import pytest
 
-from umik_base_app.transport.queue_transport import QueueInMemoryTransport
+from umik_base_app.transports.queue_transport import QueueInMemoryTransport
 
 
 # --- InMemory Tests ---
diff --git a/src/tests/transports/test_zmq_transport.py b/src/tests/transports/test_zmq_transport.py
@@ -17,8 +17,8 @@
 import zmq
 
 from umik_base_app.settings import get_settings
-from umik_base_app.transport.queue_transport import QueueInMemoryTransport
-from umik_base_app.transport.zmq_transport import (
+from umik_base_app.transports.queue_transport import QueueInMemoryTransport
+from umik_base_app.transports.zmq_transport import (
     ZmqConsumerTransport,
     ZmqProducerTransport,
 )
diff --git a/src/umik_base_app/__init__.py b/src/umik_base_app/__init__.py
@@ -13,10 +13,10 @@
 
 from .core.consumer_thread import ConsumerThread
 from .core.listener_thread import ListenerThread
-from .hardware.calibrator import HardwareCalibrator
-from .hardware.config import HardwareConfig
-from .hardware.selector import HardwareSelector
-from .processing.audio_metrics import AudioMetrics
+from .hardwares.calibrator import HardwareCalibrator
+from .hardwares.config import HardwareConfig
+from .hardwares.selector import HardwareSelector
+from .sinks.audio_metrics import AudioMetrics
 
 __all__ = [
     "HardwareCalibrator",
diff --git a/src/umik_base_app/_version.py b/src/umik_base_app/_version.py
@@ -28,7 +28,7 @@
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.1a1.dev7'
-__version_tuple__ = version_tuple = (0, 2, 1, 'a1', 'dev7')
+__version__ = version = '0.2.1a1.dev10'
+__version_tuple__ = version_tuple = (0, 2, 1, 'a1', 'dev10')
 
-__commit_id__ = commit_id = 'g7a15301fc'
+__commit_id__ = commit_id = 'gb9bd0283e'
diff --git a/src/umik_base_app/apps/basic_recorder.py b/src/umik_base_app/apps/basic_recorder.py
@@ -16,10 +16,10 @@
 
 from umik_base_app.config import AppArgs, AppConfig
 from umik_base_app.core.base_app import BaseApp
-from umik_base_app.core.pipeline import AudioPipeline
-from umik_base_app.hardware.calibrator_adapter import HardwareCalibratorAdapter
-from umik_base_app.io.recorder import IORecorder
-from umik_base_app.io.recorder_adapter import IORecorderAdapter
+from umik_base_app.core.consumer_pipeline import AudioPipeline
+from umik_base_app.hardwares.calibrator_adapter import HardwareCalibratorAdapter
+from umik_base_app.sinks.recorder import IORecorder
+from umik_base_app.sinks.recorder_adapter import IORecorderAdapter
 
 logging.basicConfig(level=logging.INFO, format="%(message)s", stream=sys.stdout)
 logger = logging.getLogger(__name__)
diff --git a/src/umik_base_app/apps/metrics_analyzer.py b/src/umik_base_app/apps/metrics_analyzer.py
@@ -25,8 +25,8 @@
 import numpy as np
 from scipy.io import wavfile
 
-from umik_base_app.hardware.calibrator import HardwareCalibrator
-from umik_base_app.processing.audio_metrics import AudioMetrics
+from umik_base_app.hardwares.calibrator import HardwareCalibrator
+from umik_base_app.sinks.audio_metrics import AudioMetrics
 
 logging.basicConfig(level=logging.INFO, format="%(message)s", stream=sys.stdout)
 logger = logging.getLogger(__name__)
diff --git a/src/umik_base_app/apps/real_time_meter.py b/src/umik_base_app/apps/real_time_meter.py
@@ -19,11 +19,11 @@
 
 from umik_base_app.config import AppArgs, AppConfig
 from umik_base_app.core.base_app import BaseApp
-from umik_base_app.core.interfaces import AudioSink
-from umik_base_app.core.pipeline import AudioPipeline
-from umik_base_app.hardware.calibrator_adapter import HardwareCalibratorAdapter
-from umik_base_app.processing.audio_metrics import AudioMetrics
+from umik_base_app.core.consumer_pipeline import AudioPipeline
+from umik_base_app.hardwares.calibrator_adapter import HardwareCalibratorAdapter
 from umik_base_app.settings import get_settings
+from umik_base_app.sinks.audio_metrics import AudioMetrics
+from umik_base_app.sinks.sinks_interface import AudioSink
 
 logging.basicConfig(level=logging.INFO, format="%(levelname)s %(threadName)s %(message)s")
 logger = logging.getLogger(__name__)
diff --git a/src/umik_base_app/apps/umik1_calibrator.py b/src/umik_base_app/apps/umik1_calibrator.py
@@ -15,7 +15,7 @@
 import os
 import sys
 
-from umik_base_app.hardware.calibrator import HardwareCalibrator
+from umik_base_app.hardwares.calibrator import HardwareCalibrator
 from umik_base_app.settings import get_settings
 
 settings = get_settings()
diff --git a/src/umik_base_app/config.py b/src/umik_base_app/config.py
@@ -17,8 +17,8 @@
 import os
 import sys
 
-from .hardware.calibrator import HardwareCalibrator
-from .hardware.selector import HardwareNotFound, HardwareSelector
+from .hardwares.calibrator import HardwareCalibrator
+from .hardwares.selector import HardwareNotFound, HardwareSelector
 from .settings import get_settings
 
 settings = get_settings()
diff --git a/src/umik_base_app/core/__init__.py b/src/umik_base_app/core/__init__.py
@@ -6,12 +6,14 @@
 Year: 2025
 """
 
+from umik_base_app.sinks.sinks_interface import AudioSink
+from umik_base_app.transformers.transformers_interface import AudioTransformer
+
 from ..config import AppArgs, AppConfig
 from .base_app import BaseApp
+from .consumer_pipeline import AudioPipeline
 from .consumer_thread import ConsumerThread
-from .interfaces import AudioSink, AudioTransformer
 from .listener_thread import ListenerThread
-from .pipeline import AudioPipeline
 from .thread_app import ThreadApp
 
 __all__ = [
diff --git a/src/umik_base_app/core/base_app.py b/src/umik_base_app/core/base_app.py
@@ -10,12 +10,12 @@
 import threading
 
 from ..config import AppConfig
-from ..hardware.config import HardwareConfig
+from ..hardwares.config import HardwareConfig
 from ..settings import get_settings
-from ..transport.transport import create_transport
+from ..transports.create_transport import create_transport
+from .consumer_pipeline import AudioPipeline
 from .consumer_thread import ConsumerThread
 from .listener_thread import ListenerThread
-from .pipeline import AudioPipeline
 from .thread_app import ThreadApp
 
 logger = logging.getLogger(__name__)
diff --git a/src/umik_base_app/core/consumer_pipeline.py b/src/umik_base_app/core/consumer_pipeline.py
@@ -1,5 +1,5 @@
 """
-Implements the audio processing pipeline manager.
+Implements the audio sinks pipeline manager.
 
 This module defines the AudioPipeline class, responsible for orchestrating the flow
 of audio data through a sequence of processors (transformers) and delivering the
@@ -14,7 +14,8 @@
 
 import numpy as np
 
-from .interfaces import AudioSink, AudioTransformer
+from umik_base_app.sinks.sinks_interface import AudioSink
+from umik_base_app.transformers.transformers_interface import AudioTransformer
 
 
 class AudioPipeline:
diff --git a/src/umik_base_app/core/consumer_thread.py b/src/umik_base_app/core/consumer_thread.py
@@ -13,8 +13,8 @@
 import queue
 import threading
 
-from ..transport.base_transport import AudioTransport
-from .pipeline import AudioPipeline
+from ..transports.base_transport import AudioTransport
+from .consumer_pipeline import AudioPipeline
 
 logger = logging.getLogger(__name__)
 
diff --git a/src/umik_base_app/core/listener_thread.py b/src/umik_base_app/core/listener_thread.py
@@ -19,9 +19,9 @@
 import sounddevice as sd
 
 from ..datetime_stamp import DatetimeStamp
-from ..hardware.config import HardwareConfig
+from ..hardwares.config import HardwareConfig
 from ..settings import get_settings
-from ..transport.base_transport import AudioTransport
+from ..transports.base_transport import AudioTransport
 
 logger = logging.getLogger(__name__)
 
diff --git a/src/umik_base_app/hardwares/cache_strategy.py b/src/umik_base_app/hardwares/cache_strategy.py
diff --git a/src/umik_base_app/hardwares/calibrator.py b/src/umik_base_app/hardwares/calibrator.py
diff --git a/src/umik_base_app/hardwares/calibrator_adapter.py b/src/umik_base_app/hardwares/calibrator_adapter.py
@@ -11,7 +11,7 @@
 
 import numpy as np
 
-from ..core.interfaces import AudioTransformer
+from ..transformers.transformers_interface import AudioTransformer
 from .calibrator import HardwareCalibrator
 
 
diff --git a/src/umik_base_app/hardwares/config.py b/src/umik_base_app/hardwares/config.py
@@ -11,7 +11,7 @@
 
 import logging
 
-from ..hardware.selector import HardwareSelector
+from ..hardwares.selector import HardwareSelector
 from ..settings import get_settings
 
 settings = get_settings()
diff --git a/src/umik_base_app/hardwares/selector.py b/src/umik_base_app/hardwares/selector.py
diff --git a/src/umik_base_app/sinks/audio_metrics.py b/src/umik_base_app/sinks/audio_metrics.py
diff --git a/src/umik_base_app/sinks/recorder.py b/src/umik_base_app/sinks/recorder.py
diff --git a/src/umik_base_app/sinks/recorder_adapter.py b/src/umik_base_app/sinks/recorder_adapter.py
@@ -15,8 +15,8 @@
 
 import numpy as np
 
-from ..core.interfaces import AudioSink
 from .recorder import IORecorder
+from .sinks_interface import AudioSink
 
 logger = logging.getLogger(__name__)
 
diff --git a/src/umik_base_app/sinks/sinks_interface.py b/src/umik_base_app/sinks/sinks_interface.py
@@ -15,16 +15,6 @@
 import numpy as np
 
 
-@runtime_checkable
-class AudioTransformer(Protocol):
-    """
-    Protocol for components that transform audio data (e.g., HardwareCalibrator, Filter).
-    Input: Raw Audio -> Output: Processed Audio
-    """
-
-    def process_audio(self, audio_chunk: np.ndarray) -> np.ndarray: ...
-
-
 @runtime_checkable
 class AudioSink(Protocol):
     """
diff --git a/src/umik_base_app/transformers/transformers_interface.py b/src/umik_base_app/transformers/transformers_interface.py
@@ -0,0 +1,24 @@
+"""
+Defines the protocols for audio processing components and data sinks.
+
+This module establishes the contracts for AudioTransformer (transformers) and
+AudioSink (consumers) to ensure modularity and type safety in the audio pipeline.
+
+Author: Daniel Collier
+GitHub: https://github.com/danielfcollier
+Year: 2025
+"""
+
+from typing import Protocol, runtime_checkable
+
+import numpy as np
+
+
+@runtime_checkable
+class AudioTransformer(Protocol):
+    """
+    Protocol for components that transform audio data (e.g., HardwareCalibrator, Filter).
+    Input: Raw Audio -> Output: Processed Audio
+    """
+
+    def process_audio(self, audio_chunk: np.ndarray) -> np.ndarray: ...
diff --git a/src/umik_base_app/transports/base_transport.py b/src/umik_base_app/transports/base_transport.py
diff --git a/src/umik_base_app/transports/create_transport.py b/src/umik_base_app/transports/create_transport.py
diff --git a/src/umik_base_app/transports/queue_transport.py b/src/umik_base_app/transports/queue_transport.py
diff --git a/src/umik_base_app/transports/zmq_transport.py b/src/umik_base_app/transports/zmq_transport.py
diff --git a/uv.lock b/uv.lock
