rosabeats 0.1.3__tar.gz

rosabeats-0.1.3/LICENSE.md

@@ -0,0 +1,7 @@
+# ISC License
+
+Copyright © 2025 [John Fleming](https://github.com/jbff)
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

rosabeats-0.1.3/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: rosabeats
+Version: 0.1.3
+Summary: Audio beat detection, segmentation, and remixing library using librosa
+Author: John Fleming
+License-Expression: ISC
+Project-URL: Homepage, https://github.com/jbff/rosabeats
+Project-URL: Repository, https://github.com/jbff/rosabeats
+Keywords: audio,beat,detection,segmentation,remixing,librosa,music
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: librosa<1.0,>=0.11.0
+Requires-Dist: soundfile<1.0,>=0.13.0
+Requires-Dist: sounddevice<1.0,>=0.5.0
+Requires-Dist: numpy<3.0,>=2.0
+Requires-Dist: scipy<2.0,>=1.15
+Requires-Dist: scikit-learn<2.0,>=1.5
+Provides-Extra: ffms2
+Requires-Dist: ffms2; extra == "ffms2"
+Provides-Extra: vamp
+Requires-Dist: vamp; extra == "vamp"
+Provides-Extra: all
+Requires-Dist: ffms2; extra == "all"
+Requires-Dist: vamp; extra == "all"
+Dynamic: license-file
+
+# rosabeats
+
+This repository contains the rosabeats Python library that allows for audio beat detection, segmentation, and remixing. It leverages the power of librosa and other audio processing libraries to enable precise beat tracking, song segmentation, and creative audio manipulation. This repository contains the core library code and various tools including scripts to segment songs, create and play/save beat "recipes", and a command line interpreter for interactive beat manipulation.
+
+I wrote this because for some reason I was too dense to figure out how to use [Amen](https://github.com/algorithmic-music-exploration/amen) to replicate in Python something like the Infinite Jukebox. That was the initial impetus, anyway. This code is not elegant. If I was too dense to figure out how to use amen, even with the code and examples in front of me, you can bet that I did not write elegant code. But it does work and I have enjoyed playing with it.
+
+A short mp3 that is in the public domain is included and an example beat recipe that references it. The track used for this example was obtained from [Free Music Archive](https://freemusicarchive.org/music/play-house/single/random-drop/) - "Random Drop" by Play House - and is distributed under the Creative Commons Public Domain License (CC0), which allows for unrestricted use, modification, and distribution without any copyright restrictions. Many thanks to the creator.
+
+I wrote most of this code in 2018-2019 and made some additions through 2021. I created this public repo to hold the most useful bits on April 12, 2025. I intend to improve the code. It almost certainly contains bugs that I don't ever hit. It was cobbled together a feature at a time and thus, looks and probably acts that way.
+
+## Features
+
+- **Beat Detection**: Automatically detect beats and tempo in audio files
+- **Bar Analysis**: Group beats into bars with configurable beats-per-bar
+- **Audio Segmentation**: Segment songs into structural parts using:
+  - Laplacian segmentation (powered by librosa)
+  - Segmentino (using Vamp plugins) 
+- **Audio Remixing**: Create remixes by manipulating beats and bars:
+  - Play individual beats or ranges of beats
+  - Play entire bars or ranges of bars
+  - Shuffle beats or bars randomly
+  - Reverse the order of beats within bars
+  - Create precise rests with beat-accurate timing
+- **Beat Recipe Files**: Save and load beat patterns as reusable recipes
+- **Interactive Shell**: Command-line interface for experimenting with beat patterns
+- **Segment Analysis**: Identify structurally similar sections in songs
+- **Output Options**: Play remixes in real-time, save to files, or generate beat recipes
+
+## Installation
+
+### Prerequisites
+
+- Python 3.9+ (Tested most recently with Python 3.11.12 and 3.13.2)
+- ffms2 libraries (On Fedora: `dnf install ffms2`; tested most recently with ffms-5.0)
+
+### Installing from PyPI
+
+```bash
+# Basic install
+pip install rosabeats
+
+# With optional dependencies
+pip install rosabeats[all]
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+```bash
+uv pip install rosabeats
+uv pip install rosabeats[all]
+```
+
+### Installing from Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/jbff/rosabeats.git
+cd rosabeats
+```
+
+2. Install the package:
+```bash
+pip install .
+```
+
+Or for development (editable install):
+```bash
+pip install -e .
+```
+
+3. Installing optional dependencies:
+
+rosabeats has optional dependencies that can be installed based on your needs:
+
+```bash
+# Install with Vamp plugin support
+pip install .[vamp]
+
+# Install with ffms2 support for additional audio formats
+pip install .[ffms2]
+
+# Install with all optional dependencies
+pip install .[all]
+```
+
+This will install the package and its dependencies, and make the following command-line tools available:
+- `beatrecipe-processor`: Process beat recipes
+- `segment-song`: Segment songs using librosa's Laplacian segmentation
+- `beatswitch`: Generate beat recipes with alternating patterns
+- `rosabeats-shell`: Interactive shell for beat manipulation
+
+### Optional: Vamp Plugins for Segmentino
+
+If you want to use the Segmentino-based segmentation:
+
+1. Download and install the Vamp plugin SDK
+2. Install the Segmentino plugin
+
+### Using rosabeats
+
+The package can be imported in Python as:
+```python
+import rosabeats
+```
+
+Documentation for beat recipes can be found in the `docs/` directory of the package. The main tools (`beatrecipe_processor.py` and `segment_song.py`) have been tested and are functional. Additional scripts in the `scripts/` directory may be of interest but have not been recently tested.
+
+## License
+
+## ISC License
+
+Copyright © 2025 [John Fleming](https://github.com/jbff)
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+## Acknowledgments
+
+- [librosa](https://librosa.org/) for audio analysis
+- [Vamp plugins](https://www.vamp-plugins.org/) for audio segmentation
+- [Amen](https://github.com/algorithmic-music-exploration/amen) was the original inspiration
+

rosabeats-0.1.3/README.md

@@ -0,0 +1,122 @@
+# rosabeats
+
+This repository contains the rosabeats Python library that allows for audio beat detection, segmentation, and remixing. It leverages the power of librosa and other audio processing libraries to enable precise beat tracking, song segmentation, and creative audio manipulation. This repository contains the core library code and various tools including scripts to segment songs, create and play/save beat "recipes", and a command line interpreter for interactive beat manipulation.
+
+I wrote this because for some reason I was too dense to figure out how to use [Amen](https://github.com/algorithmic-music-exploration/amen) to replicate in Python something like the Infinite Jukebox. That was the initial impetus, anyway. This code is not elegant. If I was too dense to figure out how to use amen, even with the code and examples in front of me, you can bet that I did not write elegant code. But it does work and I have enjoyed playing with it.
+
+A short mp3 that is in the public domain is included and an example beat recipe that references it. The track used for this example was obtained from [Free Music Archive](https://freemusicarchive.org/music/play-house/single/random-drop/) - "Random Drop" by Play House - and is distributed under the Creative Commons Public Domain License (CC0), which allows for unrestricted use, modification, and distribution without any copyright restrictions. Many thanks to the creator.
+
+I wrote most of this code in 2018-2019 and made some additions through 2021. I created this public repo to hold the most useful bits on April 12, 2025. I intend to improve the code. It almost certainly contains bugs that I don't ever hit. It was cobbled together a feature at a time and thus, looks and probably acts that way.
+
+## Features
+
+- **Beat Detection**: Automatically detect beats and tempo in audio files
+- **Bar Analysis**: Group beats into bars with configurable beats-per-bar
+- **Audio Segmentation**: Segment songs into structural parts using:
+  - Laplacian segmentation (powered by librosa)
+  - Segmentino (using Vamp plugins) 
+- **Audio Remixing**: Create remixes by manipulating beats and bars:
+  - Play individual beats or ranges of beats
+  - Play entire bars or ranges of bars
+  - Shuffle beats or bars randomly
+  - Reverse the order of beats within bars
+  - Create precise rests with beat-accurate timing
+- **Beat Recipe Files**: Save and load beat patterns as reusable recipes
+- **Interactive Shell**: Command-line interface for experimenting with beat patterns
+- **Segment Analysis**: Identify structurally similar sections in songs
+- **Output Options**: Play remixes in real-time, save to files, or generate beat recipes
+
+## Installation
+
+### Prerequisites
+
+- Python 3.9+ (Tested most recently with Python 3.11.12 and 3.13.2)
+- ffms2 libraries (On Fedora: `dnf install ffms2`; tested most recently with ffms-5.0)
+
+### Installing from PyPI
+
+```bash
+# Basic install
+pip install rosabeats
+
+# With optional dependencies
+pip install rosabeats[all]
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+```bash
+uv pip install rosabeats
+uv pip install rosabeats[all]
+```
+
+### Installing from Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/jbff/rosabeats.git
+cd rosabeats
+```
+
+2. Install the package:
+```bash
+pip install .
+```
+
+Or for development (editable install):
+```bash
+pip install -e .
+```
+
+3. Installing optional dependencies:
+
+rosabeats has optional dependencies that can be installed based on your needs:
+
+```bash
+# Install with Vamp plugin support
+pip install .[vamp]
+
+# Install with ffms2 support for additional audio formats
+pip install .[ffms2]
+
+# Install with all optional dependencies
+pip install .[all]
+```
+
+This will install the package and its dependencies, and make the following command-line tools available:
+- `beatrecipe-processor`: Process beat recipes
+- `segment-song`: Segment songs using librosa's Laplacian segmentation
+- `beatswitch`: Generate beat recipes with alternating patterns
+- `rosabeats-shell`: Interactive shell for beat manipulation
+
+### Optional: Vamp Plugins for Segmentino
+
+If you want to use the Segmentino-based segmentation:
+
+1. Download and install the Vamp plugin SDK
+2. Install the Segmentino plugin
+
+### Using rosabeats
+
+The package can be imported in Python as:
+```python
+import rosabeats
+```
+
+Documentation for beat recipes can be found in the `docs/` directory of the package. The main tools (`beatrecipe_processor.py` and `segment_song.py`) have been tested and are functional. Additional scripts in the `scripts/` directory may be of interest but have not been recently tested.
+
+## License
+
+## ISC License
+
+Copyright © 2025 [John Fleming](https://github.com/jbff)
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+## Acknowledgments
+
+- [librosa](https://librosa.org/) for audio analysis
+- [Vamp plugins](https://www.vamp-plugins.org/) for audio segmentation
+- [Amen](https://github.com/algorithmic-music-exploration/amen) was the original inspiration
+

rosabeats-0.1.3/docs/beatrecipe_docs.txt

@@ -0,0 +1,80 @@
+every beat recipe must contain these two lines, at the top:
+            file <filename.wav>
+            beats_bar # #
+
+the two arguments to beats_bar specify the number of beats pe bar, and the absolute beat
+number in the file that starts the first bar (this is often 0, first beat = first bar,
+but is also often not, depending on track and file characteristics; using control_beats.py
+to experiment is best way to discover if this should be non-zero for a given track)
+
+These two lines are necessary to specify source and in order to calculate where bars are
+in the file. After them, everything else is optional and can occur as many or few times as
+you like, in any order
+
+            beats #
+            bars #
+            beats #-#
+            bars #-#
+
+These are the simplest. You can play one or more beats, or one or more bars, by specifying
+the beats or bars you wish to play. All of these are valid syntax:
+
+            beats 3
+            beats 3-3
+            beats 3-8
+            beats 8-3
+            bars 4
+            bars 4-4
+            bars 4-12
+            bars 12-4
+
+If the first and last  # specified are the same, it will be like specifying a single
+beat/bar. If the first # specified is greater than the last, the beats/bars will be
+played in reverse order, i.e. bars 4-1 will play bar 4, bar 3, bar 2, then bar 1.
+
+            rest #
+
+Will insert silence. The argument specifies number of beats of silence. "rest 1" will
+insert 1 beat of silence. Argument is floating point, so you can add fractional beats
+of silence, e.g. "rest 0.5" will add half a beat of silence.
+
+            beats_shuf #
+            beats_shuf #-#
+            bars_shuf #
+            bars_shuf #-#
+
+These two act much like beats and bars covered previously, except instead of playing
+the specified beats or bars in the sequence specified, they will be randomly shuffled
+before being played. If only a single beat or bar is given after these specifiers,
+it will be the same as using "beats" or "bars" as shuffling a single item will always
+result in the output of that one item (i.e. "bars_shuf 8" is same as "bars 8").
+
+
+            bars_rev #
+            bars_rev #-#
+
+This is like bars, except it will play the beats in the bar in reverse order. That is,
+if "bars 0" played beats 0, 1, 2, 3, 4, 5, 6, and 7, "bars_rev 0" would play beats
+7, 6, 5, 4, 3, 2, 1, and 0.
+
+            beat_div # # #
+This will divide a beat into equal segments and play a certain number of them. The
+first argument is the beat #. The second argument is how many pieces to divide the beat
+into. THe third argument is how many times to play that subdivided beat. For example,
+"beat_div 540 2 2" will play the first half of beat 540 twice; "beat_div 300 3 12"
+will play the first third of beat 300 12 times (this will sound like 4 beats of triplets).
+
+            def name bars #
+            def name bars #-#
+            def name beats #
+            def name beats #-#
+
+This defines a segment that can later be played with the play command (below). Right now
+it can only handle beats and bars specifications (per above) but the plan is to expand it
+to represent any valid command.
+
+            play name
+
+This will play any defined segment defined with "def" (above). If previously you had said
+"def seg1 bars 0-7" later when you say "play seg1" it will actually play bars 0-7.
+1

rosabeats-0.1.3/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rosabeats"
+dynamic = ["version"]
+description = "Audio beat detection, segmentation, and remixing library using librosa"
+readme = "README.md"
+license = "ISC"
+requires-python = ">=3.9"
+authors = [
+    { name = "John Fleming" }
+]
+keywords = ["audio", "beat", "detection", "segmentation", "remixing", "librosa", "music"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Sound/Audio :: Analysis",
+    "Topic :: Multimedia :: Sound/Audio :: Conversion",
+]
+dependencies = [
+    "librosa>=0.11.0,<1.0",
+    "soundfile>=0.13.0,<1.0",
+    "sounddevice>=0.5.0,<1.0",
+    "numpy>=2.0,<3.0",
+    "scipy>=1.15,<2.0",
+    "scikit-learn>=1.5,<2.0",
+]
+
+[project.optional-dependencies]
+ffms2 = ["ffms2"]
+vamp = ["vamp"]
+all = ["ffms2", "vamp"]
+
+[project.scripts]
+beatrecipe-processor = "rosabeats.beatrecipe_processor:main"
+segment-song = "rosabeats.segment_song:main"
+beatswitch = "rosabeats.beatswitch:main"
+rosabeats-shell = "rosabeats.rosabeats_shell:main"
+
+[project.urls]
+Homepage = "https://github.com/jbff/rosabeats"
+Repository = "https://github.com/jbff/rosabeats"
+
+[tool.setuptools.dynamic]
+version = {attr = "rosabeats.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["."]
+
+[tool.setuptools.package-data]
+rosabeats = ["docs/*"]

rosabeats-0.1.3/rosabeats/__init__.py

@@ -0,0 +1,23 @@
+"""
+rosabeats: Audio beat detection, segmentation, and remixing library
+
+This package provides tools for audio beat detection, segmentation, and remixing.
+It leverages the power of librosa and other audio processing libraries to enable
+precise beat tracking, song segmentation, and creative audio manipulation.
+
+Main features:
+- Beat Detection: Automatically detect beats and tempo in audio files
+- Bar Analysis: Group beats into bars with configurable beats-per-bar
+- Audio Segmentation: Segment songs into structural parts
+- Audio Remixing: Create remixes by manipulating beats and bars
+- Beat Recipe Files: Save and load beat patterns as reusable recipes
+"""
+
+__version__ = "0.1.3"
+
+# Import main classes and functions from the module
+from .rosabeats import rosabeats
+
+# Expose key functionality at package level
+__all__ = ['rosabeats']
+