rosabeats 0.1.3__tar.gz → 0.2.0__tar.gz

{rosabeats-0.1.3/rosabeats.egg-info → rosabeats-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rosabeats
-Version: 0.1.3
+Version: 0.2.0
 Summary: Audio beat detection, segmentation, and remixing library using librosa
 Author: John Fleming
 License-Expression: ISC
@@ -8,15 +8,13 @@ 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
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: librosa<1.0,>=0.11.0
@@ -27,11 +25,9 @@ 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"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
 Dynamic: license-file
 
 # rosabeats
@@ -48,9 +44,7 @@ I wrote most of this code in 2018-2019 and made some additions through 2021. I c
 
 - **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 Segmentation**: Segment songs into structural parts using Laplacian spectral clustering 
 - **Audio Remixing**: Create remixes by manipulating beats and bars:
   - Play individual beats or ranges of beats
   - Play entire bars or ranges of bars
@@ -66,7 +60,7 @@ I wrote most of this code in 2018-2019 and made some additions through 2021. I c
 
 ### Prerequisites
 
-- Python 3.9+ (Tested most recently with Python 3.11.12 and 3.13.2)
+- Python 3.11+ (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
@@ -105,32 +99,17 @@ 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
+- `segment-song`: Segment songs and track beats
 - `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:
@@ -153,6 +132,5 @@ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH RE
 ## 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 → rosabeats-0.2.0}/README.md

@@ -12,9 +12,7 @@ I wrote most of this code in 2018-2019 and made some additions through 2021. I c
 
 - **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 Segmentation**: Segment songs into structural parts using Laplacian spectral clustering 
 - **Audio Remixing**: Create remixes by manipulating beats and bars:
   - Play individual beats or ranges of beats
   - Play entire bars or ranges of bars
@@ -30,7 +28,7 @@ I wrote most of this code in 2018-2019 and made some additions through 2021. I c
 
 ### Prerequisites
 
-- Python 3.9+ (Tested most recently with Python 3.11.12 and 3.13.2)
+- Python 3.11+ (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
@@ -69,32 +67,17 @@ 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
+- `segment-song`: Segment songs and track beats
 - `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:
@@ -117,6 +100,5 @@ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH RE
 ## 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 → rosabeats-0.2.0}/pyproject.toml

@@ -8,15 +8,13 @@ dynamic = ["version"]
 description = "Audio beat detection, segmentation, and remixing library using librosa"
 readme = "README.md"
 license = "ISC"
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 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",
@@ -35,8 +33,7 @@ dependencies = [
 
 [project.optional-dependencies]
 ffms2 = ["ffms2"]
-vamp = ["vamp"]
-all = ["ffms2", "vamp"]
+dev = ["pytest>=8.0", "pytest-cov>=4.0"]
 
 [project.scripts]
 beatrecipe-processor = "rosabeats.beatrecipe_processor:main"
@@ -56,3 +53,9 @@ where = ["."]
 
 [tool.setuptools.package-data]
 rosabeats = ["docs/*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"

{rosabeats-0.1.3 → rosabeats-0.2.0}/rosabeats/__init__.py

@@ -13,7 +13,7 @@ Main features:
 - Beat Recipe Files: Save and load beat patterns as reusable recipes
 """
 
-__version__ = "0.1.3"
+__version__ = "0.2.0"
 
 # Import main classes and functions from the module
 from .rosabeats import rosabeats

rosabeats-0.2.0/rosabeats/__main__.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+"""
+Entry point for running rosabeats as a module.
+
+Usage:
+    python -m rosabeats [command]
+
+Commands:
+    shell       Launch interactive shell (default)
+    segment     Segment audio file and track beats
+    beatswitch  Generate beat recipe with alternating patterns
+    recipe      Process beat recipe files
+
+Examples:
+    python -m rosabeats                     # Launch interactive shell
+    python -m rosabeats shell               # Same as above
+    python -m rosabeats segment song.wav    # Segment audio file
+    python -m rosabeats beatswitch song.wav # Generate beat recipe
+    python -m rosabeats recipe file.br      # Process beat recipe
+"""
+
+import sys
+
+
+def main():
+    """Main entry point for python -m rosabeats."""
+    if len(sys.argv) < 2:
+        # Default to shell
+        from rosabeats.rosabeats_shell import main as shell_main
+        sys.exit(shell_main())
+
+    command = sys.argv[1]
+
+    # Remove the command from argv so subcommands see correct args
+    sys.argv = [f"rosabeats {command}"] + sys.argv[2:]
+
+    if command in ("shell", "sh"):
+        from rosabeats.rosabeats_shell import main as shell_main
+        sys.exit(shell_main())
+    elif command in ("segment", "seg"):
+        from rosabeats.segment_song import main as segment_main
+        sys.exit(segment_main() or 0)
+    elif command in ("beatswitch", "bs"):
+        from rosabeats.beatswitch import main as beatswitch_main
+        sys.exit(beatswitch_main() or 0)
+    elif command in ("recipe", "br"):
+        from rosabeats.beatrecipe_processor import main as recipe_main
+        sys.exit(recipe_main() or 0)
+    elif command in ("-h", "--help", "help"):
+        print(__doc__)
+        sys.exit(0)
+    else:
+        print(f"Unknown command: {command}")
+        print("Use 'python -m rosabeats --help' for usage information.")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

{rosabeats-0.1.3 → rosabeats-0.2.0}/rosabeats/beatrecipe_processor.py

@@ -4,6 +4,7 @@ import re, sys, os.path, random, logging
 
 from rosabeats import rosabeats
 
+
 class beatrecipe_processor(rosabeats):
     @staticmethod
     def ilist(indices):
@@ -65,6 +66,13 @@ class beatrecipe_processor(rosabeats):
     def parse_error(self, error_info):
         self.log.error("%s" % error_info)
 
+    def parse_command(self, cmd):
+        """Split a command line into (verb, args). args is a list of remaining tokens."""
+        parts = cmd.split()
+        if not parts:
+            return None, []
+        return parts[0], parts[1:]
+
     def read_beatrecipe(self):
         self.recipe_lines = list()
         with open(self.recipe, "r") as f:
@@ -75,11 +83,18 @@ class beatrecipe_processor(rosabeats):
 
                 for cmd in lines:
                     self.recipe_lines.append(cmd)
+                    # Load macro definitions at read time so macros are available after init
+                    if cmd.strip().startswith("def "):
+                        try:
+                            _, rest = cmd.split(maxsplit=1)
+                            name, value = rest.split(maxsplit=1)
+                            self.define_macro(name, value)
+                        except Exception:
+                            pass
 
     def define_macro(self, name, value):
         if self.macros.get(name) is not None:
-            self.parse_error("macro %s already defined" % name)
-            return False
+            self.log.debug("macro %s redefined" % name)
         self.macros[name] = value
         return True
 
@@ -114,7 +129,7 @@ class beatrecipe_processor(rosabeats):
             return None
 
         # skip lines that start with hash
-        if line.startswith('#'):
+        if line.startswith("#"):
             return None
 
         # remove same line comments but process rest of line
@@ -127,7 +142,7 @@ class beatrecipe_processor(rosabeats):
 
         # split multiple commands separated by semicolons
         lines = []
-        for l in line.split(';'):
+        for l in line.split(";"):
             lines.append(l.strip())
 
         return lines
@@ -339,9 +354,7 @@ class beatrecipe_processor(rosabeats):
                     return True
                 else:
                     raise e
-            print(
-                "[*] (def seg: %s = %s)" % (name, value)
-            )
+            print("[*] (def seg: %s = %s)" % (name, value))
 
             self.define_macro(name, value)
             print("defined %s => %s" % (name, value))
@@ -357,7 +370,6 @@ class beatrecipe_processor(rosabeats):
                 print("%15s %15s" % (name, value))
 
         elif self.interactive and verb == "ls":
-
             print(", ".join(list(self.macros.keys())))
 
         elif self.interactive and verb == "quit":
@@ -392,12 +404,11 @@ class beatrecipe_processor(rosabeats):
     def process_interactive(self):
         KeepProcessing = True
         while KeepProcessing:
-
             print("")
             print("enter beatrecipe command => ", end="", flush=True)
 
             lines = self.preprocess(input())
-            
+
             for cmd in lines:
                 print(cmd)
                 KeepProcessing = self.execute_command(cmd)
@@ -413,8 +424,8 @@ class beatrecipe_processor(rosabeats):
             except Exception:
                 verb = line
                 args = ""
-#               self.parse_error("could not split line into verb and args")
-#               sys.exit(1)
+            #               self.parse_error("could not split line into verb and args")
+            #               sys.exit(1)
 
             if verb == "file":
                 filename = str(args)
@@ -433,10 +444,12 @@ class beatrecipe_processor(rosabeats):
                 # if we know our audio source, load it, analyze it, and init outputs
                 if self.sourcefile:
                     print("One moment as we track your beats for you, madame...")
-                    self.track_beats(beatsper=per, firstfull=first)
+                    self.track_beats(beatsper=per, downbeat=first)
                     self.init_outputs()
                 else:
-                    self.parse_error("a file directive must come before a beats_bar directive")
+                    self.parse_error(
+                        "a file directive must come before a beats_bar directive"
+                    )
                     sys.exit(1)
 
             elif verb == "def":
@@ -457,46 +470,49 @@ class beatrecipe_processor(rosabeats):
 
 
 def main(args=None):
-    output_play = False
-    output_save = False
-    output_beats = False
-    loglevel = logging.INFO
-    recipes = []
-    
-    # If no args provided, use sys.argv (skipping the script name at index 0)
-    if args is None:
-        args = sys.argv[1:]
-        
-    for arg in args:
-        if arg == "-p" or arg == "--play":
-            output_play = True
-
-        elif arg == "-s" or arg == "--save":
-            output_save = True
-
-        elif arg == "-b" or arg == "--beats":
-            output_beats = True
-
-        elif arg == "-d" or arg == "--debug":
-            loglevel = logging.DEBUG
-
-        else:
-            recipes.append(arg)
-
-    if len(recipes) < 1:
-        print("no recipes to process were found on command line")
-        sys.exit(1)
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        description='Process beat recipe files (.br) to create audio remixes',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog='''
+Examples:
+  beatrecipe-processor -p recipe.br           Play the recipe
+  beatrecipe-processor -s recipe.br           Save output to WAV
+  beatrecipe-processor -p -s recipe.br        Play and save
+  beatrecipe-processor -b recipe.br           Write beats output file
+'''
+    )
+    parser.add_argument('recipes', nargs='+', metavar='RECIPE',
+                        help='Beat recipe files (.br) to process')
+    parser.add_argument('-p', '--play', action='store_true',
+                        help='Enable audio playback')
+    parser.add_argument('-s', '--save', action='store_true',
+                        help='Save output to WAV file')
+    parser.add_argument('-b', '--beats', action='store_true',
+                        help='Write beats output file')
+    parser.add_argument('-d', '--debug', action='store_true',
+                        help='Enable debug mode')
+
+    parsed = parser.parse_args(args)
+
+    output_play = parsed.play
+    output_save = parsed.save
+    output_beats = parsed.beats
+    loglevel = logging.DEBUG if parsed.debug else logging.INFO
+    recipes = parsed.recipes
 
     if not (output_play or output_save or output_beats):
-        print("must specify one or more of --play, --save, or --beats for output")
-        sys.exit(1)
+        parser.error("must specify one or more of --play, --save, or --beats for output")
 
     for recipe in recipes:
         print("processing %s..." % recipe, flush=True)
 
         stub, ext = os.path.splitext(os.path.basename(recipe))
 
-        p = beatrecipe_processor(recipe, interactive=False, loglevel=loglevel, debug=True)
+        p = beatrecipe_processor(
+            recipe, interactive=False, loglevel=loglevel, debug=True
+        )
 
         if output_play:
             p.enable_output_play()
@@ -519,5 +535,6 @@ def main(args=None):
             print("error processing %s: %s" % (recipe, e), flush=True)
             raise e
 
+
 if __name__ == "__main__":
     main()

{rosabeats-0.1.3 → rosabeats-0.2.0}/rosabeats/beatswitch.py

@@ -21,16 +21,16 @@ class BeatSwitcher(rosabeats.rosabeats):
     Attributes:
         infile (str): Path to input audio file
         outfile (str): Path to output beat recipe file (.br)
-        firstfull (int): Index of first full bar
+        downbeat (int): Beat index of first downbeat
         fmin (int): Minimum number of forward beats
         fmax (int): Maximum number of forward beats
         bmin (int): Minimum number of backward beats
         bmax (int): Maximum number of backward beats
     """
-    
+
     def __init__(self, infile, debug=False):
         """Initialize the BeatSwitcher.
-        
+
         Args:
             infile (str): Path to input audio file
             debug (bool, optional): Enable debug mode
@@ -43,26 +43,26 @@ class BeatSwitcher(rosabeats.rosabeats):
 
         # Initialize instance variables
         self.outfile = None
-        self.firstfull = None
+        self._downbeat_arg = None
         self.fmin = None
         self.fmax = None
         self.bmin = None
         self.bmax = None
 
-    def setup(self, outfile, firstfull):
+    def setup(self, outfile, downbeat=None):
         """Set up the beat recipe configuration.
-        
+
         Args:
             outfile (str): Path to output beat recipe file (.br)
-            firstfull (int): Index of first full bar
+            downbeat (int, optional): Beat index of first downbeat (auto-detected if None)
         """
         # Configure output file
         self.outfile = outfile
         self.enable_output_beats(self.outfile)
 
         # Configure beat tracking
-        self.firstfull = firstfull
-        self.track_beats(firstfull=firstfull)
+        self._downbeat_arg = downbeat
+        self.track_beats(downbeat=downbeat)
 
         # Disable WAV output and playback
         self.disable_output_save()
@@ -90,7 +90,7 @@ class BeatSwitcher(rosabeats.rosabeats):
             self.gen_beat_samples()
 
         # Start from first full bar
-        curr_beat = self.firstfullbar
+        curr_beat = self.downbeat
         song_over = False
         direction = "r"  # Start with reverse direction
 
@@ -215,8 +215,12 @@ def parse_args():
         help="Maximum number of backward beats"
     )
     parser.add_argument(
-        "--firstfull", type=int, default=0,
-        help="First full bar index"
+        "--downbeat", type=int, default=None,
+        help="Beat index of first downbeat (default: 0)"
+    )
+    parser.add_argument(
+        "--auto-downbeat", action="store_true",
+        help="Auto-detect downbeat using DBN"
     )
     parser.add_argument(
         "--debug", action="store_true",
@@ -247,7 +251,19 @@ def main():
     
     # Create and run beat switcher
     bs = BeatSwitcher(args.input_file, debug=args.debug)
-    bs.setup(output_file, args.firstfull)
+
+    # Determine downbeat value
+    if args.downbeat is not None:
+        downbeat = args.downbeat
+    elif args.auto_downbeat:
+        # Auto-detect using DBN approach
+        bs.track_beats(downbeat=0)
+        print("Auto-detecting downbeat using DBN...")
+        downbeat = bs.detect_downbeat_dbn(bs.beatsperbar)
+    else:
+        downbeat = 0
+
+    bs.setup(output_file, downbeat)
     bs.set_parameters(args.fmin, args.fmax, args.bmin, args.bmax)
     bs.run()