feat: replace scipy.wavfile with soundfile for WAV handling

.gitignore

@@ -11,3 +11,4 @@ ipython_log.py
 dist/
 tests/
 music/singing/ecantorix/
+.vscode/

README.md

@@ -24,29 +24,28 @@ To install music you can either install it directly with `pip`:
 pip3 install music
 ```
 
-or you can clone this repository and install it from there:
+To install the Music package in editable mode from source:
 
 ```console
 git clone https://github.com/ttm/music.git
-pip3 install -e <path_to_repo>
+cd music
+uv sync
 ```
 
-This install method is especially useful when reloading the modified module in subsequent runs of music, and for greater control of customization, hacking and debugging.
-
 ### Dependencies
 
-Every dependency is installed by default by `pip`, but you can take a look at [requirements.txt](https://github.com/ttm/music/blob/master/requirements.txt).
+Dependencies are managed via UV and locked in [uv.lock](uv.lock).
 
 ## Examples
 
-Inside [the examples folder](https://github.com/ttm/music/tree/master/examples) you can find some scripts that use the main features of Music.
+Inside [the examples folder](https://github.com/ttm/music/tree/master/music/examples) you can find some scripts that use the main features of Music.
 
-* [chromatic_scale](https://github.com/ttm/music/tree/master/examples/chromatic_scale.py): writes twelve notes into a WAV file from a sequence of frequencies.
-* [penta_effects](https://github.com/ttm/music/tree/master/examples/chromatic_scale.py): writes a pentatonic scale repeated once clean, once with pitch, one with vibrato, one with Doppler, and one with FM, into a WAV stereo file.
-* [noisy](https://github.com/ttm/music/tree/master/examples/noisy.py): writes into a WAV file a sequence of different noises.
-* [thirty_notes](https://github.com/ttm/music/tree/master/examples/thirty_notes.py) and [thirty_numpy_notes](https://github.com/ttm/music/tree/master/examples/thirty_numpy_notes.py) generate a sequence of sounds by using a synth class (in this case the class [`Being`](https://github.com/ttm/music/tree/master/music/legacy/classes.py)).
-* [campanology](https://github.com/ttm/music/tree/master/examples/campanology.py) and [geometric_music](https://github.com/ttm/music/tree/master/examples/geometric_music.py) both use `Being` as their synth, but this time with permutations.
-* [isynth](https://github.com/ttm/music/tree/master/examples/isynth.py) also uses a synth class, but of a different kind, [`IteratorSynth`](https://github.com/ttm/music/tree/master/music/legacy/classes.py), that iterates through arbitrary lists of variables.
+* [chromatic_scale](https://github.com/ttm/music/tree/master/music/examples/chromatic_scale.py): writes twelve notes into a WAV file from a sequence of frequencies.
+* [penta_effects](https://github.com/ttm/music/tree/master/music/examples/chromatic_scale.py): writes a pentatonic scale repeated once clean, once with pitch, one with vibrato, one with Doppler, and one with FM, into a WAV stereo file.
+* [noisy](https://github.com/ttm/music/tree/master/music/examples/noisy.py): writes into a WAV file a sequence of different noises.
+* [thirty_notes](https://github.com/ttm/music/tree/master/music/examples/thirty_notes.py) and [thirty_numpy_notes](https://github.com/ttm/music/tree/master/music/examples/thirty_numpy_notes.py) generate a sequence of sounds by using a synth class (in this case the class [`Being`](https://github.com/ttm/music/tree/master/music/legacy/classes.py)).
+* [campanology](https://github.com/ttm/music/tree/master/music/examples/campanology.py) and [geometric_music](https://github.com/ttm/music/tree/master/music/examples/geometric_music.py) both use `Being` as their synth, but this time with permutations.
+* [isynth](https://github.com/ttm/music/tree/master/music/examples/isynth.py) also uses a synth class, but of a different kind, [`IteratorSynth`](https://github.com/ttm/music/tree/master/music/legacy/classes.py), that iterates through arbitrary lists of variables.
 
 ## Package structure
 

music/core/io.py

@@ -3,7 +3,7 @@
 """
 
 import numpy as np
-from scipy.io import wavfile
+import soundfile as sf
 from .functions import normalize_mono, normalize_stereo
 from .filters import adsr, adsr_stereo
 
@@ -25,14 +25,17 @@ def read_wav(filename: str):
     NDArray
         Values of the WAV file
     """
-    s = wavfile.read(filename)
-    print(type(s[1] / 2 ** 15))
-    if s[1].dtype != 'int16':
+    # Read integer PCM data (dtype=int16)
+    data, sr = sf.read(filename, dtype='int16')
+    print(type(data / 2 ** 15))
+    if data.dtype != 'int16':
         print('implement non 16bit samples!')
         return np.array(None)
-    if len(s[1].shape) == 2:
-        return np.array(s[1].transpose() / 2 ** 15)
-    return s[1] / 2 ** 15
+    # data: shape (nsamples,) or (nsamples, channels)
+    if data.ndim == 2:
+        # convert to (channels, nsamples)
+        return np.array(data.T / 2 ** 15)
+    return data / 2 ** 15
 
 
 def write_wav_mono(sonic_vector=SONIC_VECTOR_MONO, filename="asound.wav",
@@ -79,7 +82,8 @@ def write_wav_mono(sonic_vector=SONIC_VECTOR_MONO, filename="asound.wav",
         print(f"File {filename} not written")
     nn = eval("np.int" + str(bit_depth))
     result = nn(result)
-    wavfile.write(filename, sample_rate, result)
+    # Write to WAV using SoundFile
+    sf.write(filename, result, sample_rate)
 
 
 def write_wav_stereo(sonic_vector=SONIC_VECTOR_STEREO, filename="asound.wav",
@@ -126,4 +130,5 @@ def write_wav_stereo(sonic_vector=SONIC_VECTOR_STEREO, filename="asound.wav",
         print(f"File {filename} not written")
     nn = eval("np.int" + str(bit_depth))
     result = nn(result)
-    wavfile.write(filename, sample_rate, result.T)
+    # Write to WAV using SoundFile
+    sf.write(filename, result.T, sample_rate)

music/singing/perform.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 import os
 import re
-from scipy.io import wavfile
+import soundfile as sf
 from music.core import normalize_mono
 
 here = os.path.abspath(os.path.dirname(__file__))
@@ -44,9 +44,10 @@ def sing(text="Mar-ry had a litt-le lamb",
     os.system('cp {}/Makefile {}/Makefile'.format(ECANTORIXDIR,
                                                   ECANTORIXCACHE))
     os.system('make -C {}'.format(ECANTORIXCACHE))
-    wread = wavfile.read(ECANTORIXCACHE + '/achant.wav')
-    assert wread[0] == 44100
-    return normalize_mono(wread[1])
+    # Read generated chant as int16 PCM
+    data, sr = sf.read(ECANTORIXCACHE + '/achant.wav', dtype='int16')
+    assert sr == 44100
+    return normalize_mono(data)
     # return wread[1]
 
 

pyproject.toml

@@ -1,25 +1,25 @@
 [project]
 name = 'music'
-version = '1.0.0-b5'
+version = '1.0.0-b6'
 authors = [
     { name = 'Renato Fabbri', email = 'renato.fabbri@gmail.com' },
-    { name = 'Jacopo Donati', email = 'jacopo.donati@gmail.com' }
+    { name = 'Jacopo Donati', email = 'jacopo.donati@gmail.com' },
 ]
 description = 'Extreme-fidelity synthesis of musical elements, based on the MASS framework'
-license = { file = "LICENSE" }
+license = "MIT"
 readme = 'README.md'
-requires-python = '>=3.0'
+requires-python = '>=3.10'
 dependencies = [
     'colorama >= 0.4.6',
     'matplotlib >= 3.7.1',
     'numpy >= 1.26.4',
     'scipy >= 1.12.0',
+    'soundfile >= 0.12.1',
     'sympy >= 1.12',
     'termcolor >= 2.4.0',
 ]
 classifiers = [
     'Programming Language :: Python :: 3',
-    'License :: OSI Approved :: MIT License',
     'Operating System :: OS Independent',
     'Development Status :: 5 - Production/Stable',
     'Intended Audience :: Science/Research',
@@ -62,7 +62,7 @@ keywords = [
     'sound',
     'spatialization',
     'speech',
-    'synth'
+    'synth',
 ]
 
 [project.urls]
@@ -72,3 +72,13 @@ Issues = 'https://github.com/ttm/music/issues'
 [build-system]
 requires = ['setuptools>=61.0']
 build-backend = 'setuptools.build_meta'
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["music*"]
+
+# explicitly ship everything under my_pkg/examples
+[tool.setuptools.package-data]
+"music" = ["examples/*"]