Move utils code into brick

Author: rjtokenring

src/arduino/app_bricks/sound_generator/__init__.py

@@ -2,13 +2,14 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-from arduino.app_utils import WaveGenerator, brick
+from arduino.app_utils import brick
 from arduino.app_peripherals.speaker import Speaker
 import threading
 from typing import Iterable
 import numpy as np
 import time
 
+from .generator import WaveSamplesBuilder
 from .effects import *
 from .loaders import ABCNotationLoader
 
@@ -95,7 +96,7 @@ def stop(self):
 
     def _init_wave_generator(self, wave_form: str):
         with self._cfg_lock:
-            self._wave_gen = WaveGenerator(sample_rate=self.SAMPLE_RATE, wave_form=wave_form)
+            self._wave_gen = WaveSamplesBuilder(sample_rate=self.SAMPLE_RATE, wave_form=wave_form)
 
     def set_wave_form(self, wave_form: str):
         """
@@ -315,7 +316,7 @@ def play_polyphonic(self, notes: list[list[tuple[str, float]]], as_tone: bool =
         blk = mixed.astype(np.float32)
         blk = self._apply_sound_effects(blk, base_frequency)
         return (self._to_bytes(blk), max_duration)
-    
+
     def play_chord(self, notes: list[str], note_duration: float | str = 1 / 4, volume: float = None) -> bytes:
         """
         Play a chord consisting of multiple musical notes simultaneously for a specified duration and volume.

src/arduino/app_bricks/sound_generator/examples/4_effects.py

@@ -43,7 +43,7 @@
 
 # Play as a retro-game sound
 player.set_wave_form("square")
-player.set_effects([SoundEffect.adsr()]) # For a more synththetic sound, add SoundEffect.bitcrusher() effect
+player.set_effects([SoundEffect.adsr()])  # For a more synththetic sound, add SoundEffect.bitcrusher() effect
 for note, duration in tune_sequence:
     player.play_tone(note, duration)
 

src/arduino/app_bricks/sound_generator/generator.py

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: Copyright (C) 2025 ARDUINO SA <http://www.arduino.cc>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+import numpy as np
+
+
+class WaveSamplesBuilder:
+    """Generate wave audio blocks.
+
+    This class produces wave blocks as NumPy buffers.
+
+    Attributes:
+        sample_rate (int): Audio sample rate in Hz.
+    """
+
+    def __init__(self, wave_form: str = "sine", sample_rate: int = 16000):
+        """Create a new WaveGenerator.
+
+        Args:
+            wave_form (str): The type of wave form to generate. Supported values
+                are "sine", "square", "triangle", "white_noise" and "sawtooth".
+            sample_rate (int): The playback sample rate (Hz) used to compute
+                phase increments and buffer sizes.
+        """
+        self.wave_form = wave_form.lower()
+        self.sample_rate = int(sample_rate)
+
+    def generate_block(self, freq: float, block_dur: float, master_volume: float = 1.0):
+        """Generate a block of float32 audio samples.
+
+        Returned buffer is a NumPy view (float32) into an internal preallocated array and is valid
+        until the next call to this method.
+
+        Args:
+            freq (float): Target frequency in Hz for this block.
+            block_dur (float): Duration of the requested block in seconds.
+            master_volume (float, optional): Global gain multiplier. Defaults
+                to 1.0.
+
+        Returns:
+            numpy.ndarray: A 1-D float32 NumPy array containing the generated
+            audio samples for the requested block.
+        """
+        N = max(1, int(self.sample_rate * block_dur))
+
+        # compute wave form based on selected type
+        t = np.arange(N, dtype=np.float32) / self.sample_rate
+
+        match self.wave_form:
+            case "square":
+                samples = 0.5 * (1 + np.sign(np.sin(2.0 * np.pi * freq * t)))
+            case "triangle":
+                samples = 2.0 * np.abs(2.0 * (freq * t % 1) - 1.0) - 1.0
+            case "sawtooth":
+                samples = 2.0 * (freq * t % 1.0) - 1.0
+            case "white_noise":
+                samples = np.random.uniform(-1.0, 1.0, size=N).astype(np.float32)
+            case _:  # "sine" e default
+                samples = np.sin(2.0 * np.pi * freq * t)
+
+        samples = samples.astype(np.float32)
+
+        # apply gain
+        mg = float(master_volume)
+        if mg != 1.0:
+            np.multiply(samples, mg, out=samples)
+
+        return samples

src/arduino/app_utils/audio.py

@@ -6,70 +6,6 @@
 import numpy as np
 
 
-class WaveGenerator:
-    """Generate wave audio blocks.
-
-    This class produces wave blocks as NumPy buffers.
-
-    Attributes:
-        sample_rate (int): Audio sample rate in Hz.
-    """
-
-    def __init__(self, wave_form: str = "sine", sample_rate: int = 16000):
-        """Create a new WaveGenerator.
-
-        Args:
-            wave_form (str): The type of wave form to generate. Supported values
-                are "sine", "square", "triangle", "white_noise" and "sawtooth".
-            sample_rate (int): The playback sample rate (Hz) used to compute
-                phase increments and buffer sizes.
-        """
-        self.wave_form = wave_form.lower()
-        self.sample_rate = int(sample_rate)
-
-    def generate_block(self, freq: float, block_dur: float, master_volume: float = 1.0):
-        """Generate a block of float32 audio samples.
-
-        Returned buffer is a NumPy view (float32) into an internal preallocated array and is valid
-        until the next call to this method.
-
-        Args:
-            freq (float): Target frequency in Hz for this block.
-            block_dur (float): Duration of the requested block in seconds.
-            master_volume (float, optional): Global gain multiplier. Defaults
-                to 1.0.
-
-        Returns:
-            numpy.ndarray: A 1-D float32 NumPy array containing the generated
-            audio samples for the requested block.
-        """
-        N = max(1, int(self.sample_rate * block_dur))
-
-        # compute wave form based on selected type
-        t = np.arange(N, dtype=np.float32) / self.sample_rate
-
-        match self.wave_form:
-            case "square":
-                samples = 0.5 * (1 + np.sign(np.sin(2.0 * np.pi * freq * t)))
-            case "triangle":
-                samples = 2.0 * np.abs(2.0 * (freq * t % 1) - 1.0) - 1.0
-            case "sawtooth":
-                samples = 2.0 * (freq * t % 1.0) - 1.0
-            case "white_noise":
-                samples = np.random.uniform(-1.0, 1.0, size=N).astype(np.float32)
-            case _:  # "sine" e default
-                samples = np.sin(2.0 * np.pi * freq * t)
-
-        samples = samples.astype(np.float32)
-
-        # apply gain
-        mg = float(master_volume)
-        if mg != 1.0:
-            np.multiply(samples, mg, out=samples)
-
-        return samples
-
-
 class SineGenerator:
     """Generate sine-wave audio blocks with amplitude envelope smoothing.