0.1.0

.gitattributes

@@ -0,0 +1 @@
+*.mp3 filter=lfs diff=lfs merge=lfs -text

.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "releases/**"
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  python:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "pipenv"
+
+      - name: Install pipenv
+        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
+        shell: bash
+
+      - name: Install Pipfile packages
+        run: pipenv sync --python 3.10 --dev
+        shell: bash
+
+      - name: Reinstall CPU version of PyTorch
+        run: |
+          pipenv run pip uninstall --yes torch torchaudio
+          pipenv run pip install torch~=2.0 torchaudio~=2.0 --index-url https://download.pytorch.org/whl/cpu
+
+      - name: Formatting
+        run: pipenv run black --diff .
+
+      - name: Sort imports
+        run: pipenv run isort --check --diff .
+
+      - name: Lint
+        run: pipenv run flake8
+
+      - name: Type check
+        run: pipenv run mypy --strict --junit-xml=mypy-results.xml music_interpolation/
+
+      - name: Test
+        run: pipenv run pytest --junit-xml=pytest-results.xml

.gitignore

@@ -158,3 +158,9 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# JUnit
+*-results.xml
+
+# OS files
+.DS_Store

.vscode/extensions.json

@@ -0,0 +1,14 @@
+// -*- jsonc -*-
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "ms-python.black-formatter",
+    "ms-python.flake8",
+    "ms-python.isort",
+    "ms-python.mypy-type-checker",
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "ms-toolsai.jupyter",
+    "ms-toolsai.jupyter-renderers"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,27 @@
+// -*- jsonc -*-
+{
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": true
+  },
+
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.tabSize": 4
+  },
+  "python.analysis.diagnosticSeverityOverrides": {
+    "reportMissingTypeStubs": "none",
+    "reportUnknownMemberType": "none"
+  },
+  "python.analysis.typeCheckingMode": "strict",
+
+  "search.exclude": {
+    "**/build": true,
+    "**/*.lock": true
+  }
+}

Pipfile

@@ -0,0 +1,26 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+audiocraft = "*"
+librosa = "*"
+music_interpolation = { editable = true, path = "." }
+numpy = "*"
+soundfile = "*"
+torch = "~=2.0"
+torchaudio = "~=2.0"
+transformers = "~=4.0"
+
+[dev-packages]
+argparse = "==1.4.0"
+black = "==23.7.0"
+flake8 = "==6.1.0"
+isort = "==5.12.0"
+mypy = "==1.5.0"
+pytest = "==7.4.0"
+ipykernel = "*"
+
+[requires]
+python_version = "3.10"

README.md

@@ -1,2 +1,45 @@
 # music-interpolation
-Mix between music tracks using machine learning
+
+> Mix between music tracks using machine learning
+
+## Introduction
+
+This repository is a sandbox to experiment with machine learning techniques for smoothly transitioning between music tracks.
+
+## Development
+
+1. `git clone https://github.com/jhurliman/music-interpolation.git`
+2. `cd music-interpolation`
+3. Install pipenv if you have not already: `pip install pipenv`
+4. Install dependencies: `pipenv sync --python 3.10 --dev`
+5. Run tests: `pipenv run pytest`
+
+## Usage
+
+```python
+import librosa
+from IPython.display import Audio
+from music_interpolation import EncodecInterpolation
+
+# Instantiate the interpolation class, fetching and loading the pre-trained
+# Encodec model
+interp = EncodecInterpolation()
+
+# Load two audio tracks, resampling to the sampling rate of the Encodec model
+# (defaults to 48kHz)
+audio_a, _ = librosa.load('audio_a.mp3', sr=interp.sampling_rate, mono=False)
+audio_b, _ = librosa.load('audio_b.mp3', sr=interp.sampling_rate, mono=False)
+
+# Transition between two audio tracks using linear interpolation between
+# embedding vectors generated by a pre-trained Encodec model
+audio_c = interp.interpolate(audio_a, audio_b)
+Audio(data=audio_c, rate=interp.sampling_rate)
+```
+
+## Contributing
+
+Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

music_interpolation/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"