rhythmsync 1.0.0__tar.gz

rhythmsync-1.0.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: rhythmsync
+Version: 1.0.0
+Summary: CLI music player with synchronized lyrics (LRC) support
+Author: KON/NOS R
+License: MIT
+Keywords: music,cli,audio,lrc,player,terminal
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pygame
+Requires-Dist: rich
+Requires-Dist: mutagen
+
+# RhythmSync
+
+CLI audio player that plays music while displaying synchronized lyrics (LRC).
+
+---
+
+## Features
+
+- Play single audio files:
+  - Once
+  - In loop (`-r`)
+- Play all supported audio files in a directory:
+  - Alphabetical order (`-d`)
+  - Alphabetical loop (`-dr`)
+  - Shuffle (`-ds`)
+- Display synchronized lyrics during playback
+- Show song metadata tags
+- Styled terminal music player UI
+
+---
+
+## Supported Audio Formats
+
+- `.mp3`
+- `.flac`
+- `.wav`
+- `.ogg`
+
+### Notes
+- Other audio formats might work, but full functionality is not guaranteed.
+
+---
+
+## Lyrics Sync
+
+RhythmSync reads embedded lyric metadata from audio files.
+
+Supported tags include:
+- `SYLT`, `SYLT::eng`
+- `LYRICS`, `LYRICS:eng`
+- `LYRICS-ENG`, `LYRICS_EN`
+- `LYRICS_SYNCED`, `SYNCEDLYRICS`
+
+### LRC Format
+
+```
+[00:12.34] First line
+[00:15.67] Second line
+[00:18.90] Third line
+```
+
+- Format: `[mm:ss.xx] Line`
+
+### Notes
+- If no lyrics are found, a placeholder message is shown.
+
+---
+
+## Commands
+
+### General
+
+```
+help - Lists all available commands.
+clear - Clears the terminal.
+```
+
+
+### Playback
+
+```
+play {path} - Plays a single audio file once.
+play -r {path} - Plays a single audio file in repeat mode until stopped (Ctrl+C).
+play -d {directory} - Plays all supported audio files in alphabetical order.
+play -dr {directory} - Plays all supported audio files in alphabetical order and loops around until stopped (Ctrl+C).
+play -ds {directory} - Plays all supported audio files in shuffled order.
+```
+
+
+### Metadata
+
+```
+info {path} - Displays all available metadata.
+info {path} [tags] - Displays only given metadata tags.
+```
+
+---
+
+## Notes
+
+- Paths containing spaces must be wrapped in quotes:
+
+```
+play "My Music/song.mp3"
+```
+
+- Use `Ctrl+C` to stop playback or exit the app

rhythmsync-1.0.0/README.md

@@ -0,0 +1,97 @@
+# RhythmSync
+
+CLI audio player that plays music while displaying synchronized lyrics (LRC).
+
+---
+
+## Features
+
+- Play single audio files:
+  - Once
+  - In loop (`-r`)
+- Play all supported audio files in a directory:
+  - Alphabetical order (`-d`)
+  - Alphabetical loop (`-dr`)
+  - Shuffle (`-ds`)
+- Display synchronized lyrics during playback
+- Show song metadata tags
+- Styled terminal music player UI
+
+---
+
+## Supported Audio Formats
+
+- `.mp3`
+- `.flac`
+- `.wav`
+- `.ogg`
+
+### Notes
+- Other audio formats might work, but full functionality is not guaranteed.
+
+---
+
+## Lyrics Sync
+
+RhythmSync reads embedded lyric metadata from audio files.
+
+Supported tags include:
+- `SYLT`, `SYLT::eng`
+- `LYRICS`, `LYRICS:eng`
+- `LYRICS-ENG`, `LYRICS_EN`
+- `LYRICS_SYNCED`, `SYNCEDLYRICS`
+
+### LRC Format
+
+```
+[00:12.34] First line
+[00:15.67] Second line
+[00:18.90] Third line
+```
+
+- Format: `[mm:ss.xx] Line`
+
+### Notes
+- If no lyrics are found, a placeholder message is shown.
+
+---
+
+## Commands
+
+### General
+
+```
+help - Lists all available commands.
+clear - Clears the terminal.
+```
+
+
+### Playback
+
+```
+play {path} - Plays a single audio file once.
+play -r {path} - Plays a single audio file in repeat mode until stopped (Ctrl+C).
+play -d {directory} - Plays all supported audio files in alphabetical order.
+play -dr {directory} - Plays all supported audio files in alphabetical order and loops around until stopped (Ctrl+C).
+play -ds {directory} - Plays all supported audio files in shuffled order.
+```
+
+
+### Metadata
+
+```
+info {path} - Displays all available metadata.
+info {path} [tags] - Displays only given metadata tags.
+```
+
+---
+
+## Notes
+
+- Paths containing spaces must be wrapped in quotes:
+
+```
+play "My Music/song.mp3"
+```
+
+- Use `Ctrl+C` to stop playback or exit the app

rhythmsync-1.0.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rhythmsync"
+version = "1.0.0"
+description = "CLI music player with synchronized lyrics (LRC) support"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+  {name = "KON/NOS R"}
+]
+
+keywords = ["music", "cli", "audio", "lrc", "player", "terminal"]
+
+dependencies = [
+  "pygame",
+  "rich",
+  "mutagen"
+]
+
+[project.scripts]
+rhythmsync = "rhythmsync.main:main"

rhythmsync-1.0.0/rhythmsync/main.py

@@ -0,0 +1,411 @@
+import os
+os.environ["PYGAME_HIDE_SUPPORT_PROMPT"] = "1"
+import pygame
+from rich.console import Console
+console = Console()
+from rich.console import Group
+from rich.panel import Panel
+from rich.align import Align
+from rich.progress import Progress, BarColumn, TextColumn
+from rich.live import Live
+from rich.layout import Layout
+from mutagen import File
+from re import match
+from pathlib import Path
+from random import shuffle
+import shlex
+
+
+#create rich layout
+def make_layout():
+    layout = Layout()
+    layout.split_column(
+        Layout(name="header", size=4),
+        Layout(name="lyrics", ratio=1),
+        Layout(name="player", size=3)
+    )
+    return layout
+
+#header section
+def make_header(title, artist, mode = None):
+        if mode is not None:
+            mode = mode.split()
+            if mode[0] == "repeat":
+                return Panel(
+                    Group(
+                        Align.center(f"[bold]{title}[/bold]"),
+                        Align.center(f"[#5900ab]{artist}[/#5900ab]")
+                        ),
+                title="⭮",
+                title_align="right",
+                style="white",
+                )
+            elif mode[0][:9] == "directory":
+                now, total = mode[1:3]
+                if mode[0] == "directory-shuffle":
+                    return Panel(
+                        Group(
+                            Align.center(f"[bold]{title}[/bold]"),
+                            Align.center(f"[#5900ab]{artist}[/#5900ab]")
+                            ),
+                    title=f"🔀︎Playing {now} of {total}",
+                    title_align="right",
+                    style="white",
+                    )
+                elif mode[0] == "directory-repeat":
+                    return Panel(
+                        Group(
+                            Align.center(f"[bold]{title}[/bold]"),
+                            Align.center(f"[#5900ab]{artist}[/#5900ab]")
+                            ),
+                    title=f"⭮ Playing {now} of {total}",
+                    title_align="right",
+                    style="white",
+                    )
+    
+                return Panel(
+                    Group(
+                        Align.center(f"[bold]{title}[/bold]"),
+                        Align.center(f"[#5900ab]{artist}[/#5900ab]")
+                        ),
+                title=f"Playing {now} of {total}",
+                title_align="right",
+                style="white",
+                )
+            
+        return Panel(
+        Group(Align.center(f"[bold]{title}[/bold]"),
+              Align.center(f"[#5900ab]{artist}[/#5900ab]")),
+              style="white",
+    )
+
+#lyrics section
+def make_lyrics(lyrics):
+    line1, line2, line3, line4, line5 = lyrics
+    return Align.center(Group(
+            Align.center(f"[#1f1f1f]{line1}[#1f1f1f]"),
+            Align.center(f"[#2f2f2f]{line2}[#2f2f2f]"),
+            Align.center(f"[bold #00d0ff]{line3}[/bold #00d0ff]"),
+            Align.center(f"[white]{line4}[white]"),
+            Align.center(f"[#afafaf]{line5}[#afafaf]")
+            ),
+        vertical="middle"
+    )
+
+#player section
+def make_player():
+    return Progress(
+        TextColumn("{task.description}[/]", justify="right"),
+        BarColumn(bar_width=None),
+        TextColumn("{task.fields[suffix]}", justify="right"),
+    )
+
+#clear the terminal
+def clear_screen():
+    os.system('cls' if os.name == 'nt' else 'clear')
+
+#format time in mm:ss.xx format
+def format_time(milliseconds):
+    min = int((milliseconds // 1000) // 60)
+    sec = (milliseconds // 1000) % 60
+    mil = milliseconds % 1000
+    hund = int(mil // 10)
+    return f"{min:02}:{sec:02}.{hund:02}"
+
+#format time to milliseconds
+def unformat_time(time_str):
+    min, sec = time_str.split(":")
+    sec, hund = sec.split(".")
+    milliseconds = (
+        int(min) * 60 * 1000 + int(sec) * 1000 + int(hund) * 10)
+    return milliseconds
+
+#get meatadata
+def get_metadata(file_path, tags = None):
+    try:
+        audio = File(file_path)
+
+        if audio is None:
+            print(f"Error: Could not open file {file_path}")
+            return None
+        
+        lines = []
+
+        if tags is None:
+            for key, value in audio.items():
+                if isinstance(value, list):
+                    value = "; ".join(str(v) for v in value)
+
+                    lines.append(f"[green]{key}[/green]: {value}")
+        else:
+            for key, value in audio.items():
+                if isinstance(value, list):
+
+                    if key in tags:
+                        value = "; ".join(str(v) for v in value)
+
+                        lines.append(f"[green]{key}[/green]: {value}")
+        
+        return "\n".join(lines)
+    
+    except Exception as e:
+        print(f"Error extracting metadata: {e}")
+        return None
+
+#get title and artist info
+def get_ti_ar(file_path):
+    try:
+        audio = File(file_path)
+
+        if audio is None:
+            return "Unknown Title", "Unknown Artist"
+        
+        title = audio.get("title", ["Unknown Title"])[0]
+        artist = audio.get("artist", ["Unknown Artist"])[0]
+
+        return title, artist
+    
+    except Exception as e:
+        print(f"Error extracting metadata: {e}")
+        return "Unknown Title", "Unknown Artist"
+
+#get lrc data from the audio file
+def get_lrc(file_path):
+    try:
+        audio = File(file_path)
+
+        if audio is None:
+            print(f"Error: Could not open file {file_path}")
+            return None
+
+        lrc_tag_names = ['SYLT', 'SYLT::eng', 'LYRICS', 'LYRICS:eng', 'LYRICS-ENG', 'LYRICS_EN', 'LYRICS_SYNCED', 'SYNCEDLYRICS']
+
+        for tag_name in lrc_tag_names:
+            if tag_name in audio:
+                return audio[tag_name][0]
+        return None
+
+    except Exception as e:
+        print(f"Error extracting LRC data: {e}")
+        return None
+
+#get lyric lines without the tags from the lrc data
+def format_lrc(lrc_data):
+    timestamp = r"^\[\d{2}:\d{2}\.\d{2}\]"
+    lrc_lines = lrc_data.split("\n")
+    lyrics = [[line[1:9],line[10:].strip()] for line in lrc_lines if match(timestamp, line)]
+    lyrics.insert(0,['00:00.00', ""])
+    for x in lyrics:
+        if x[1] == "":
+            x[1] = "♫"
+    return lyrics
+
+#music player
+def run_player(file_path, mode = None):
+    global repeat
+    try:
+        layout = make_layout()
+
+        pygame.mixer.init()
+        pygame.mixer.music.load(file_path)
+        pygame.mixer.music.play()
+
+        total_length = int(pygame.mixer.Sound(file_path).get_length()*1000)
+
+        title, artist = get_ti_ar(file_path)
+
+        lyrics_exist = False
+        raw_lrc = get_lrc(file_path)
+        if raw_lrc is not None:
+            lyrics = format_lrc(raw_lrc)
+            lyrics_exist = True
+
+        clear_screen()
+        
+        layout["header"].update(make_header(title, artist, mode))
+
+        layout["lyrics"].update(Align.center("No lyrics to display", vertical="middle"))
+
+        progress = make_player()
+        layout["player"].update(progress)
+
+        with Live(layout, refresh_per_second=100):
+            playback = progress.add_task(
+            f"[red]< [#00d0ff]",
+            total=total_length, 
+            suffix="[#00d0ff] [red]>")
+
+            lyric_index = 0
+
+            while pygame.mixer.music.get_busy(): #music starts
+                current_time = pygame.mixer.music.get_pos()
+
+                if lyrics_exist and lyric_index < len(lyrics):
+                    if unformat_time(lyrics[lyric_index][0]) <= current_time:
+                        layout["lyrics"].update(make_lyrics((
+                            lyrics[lyric_index-2][1] if lyric_index > 1 else "",
+                            lyrics[lyric_index-1][1] if lyric_index > 0 else "",
+                            lyrics[lyric_index][1],
+                            lyrics[lyric_index+1][1] if lyric_index < len(lyrics)-1 else "",
+                            lyrics[lyric_index+2][1] if lyric_index < len(lyrics)-2 else ""
+                            )))
+                        lyric_index += 1
+
+                progress.update(playback, 
+                                completed=current_time,
+                                description=f"[red]< [#00d0ff]{format_time(current_time)}",
+                                suffix=f"[#00d0ff]{format_time(total_length - current_time)} [red]>"
+                                )
+    except KeyboardInterrupt:
+        repeat = False
+        clear_screen()
+        print(f"Exitting...")
+        pygame.mixer.music.stop()
+        
+#main program
+def main():
+    clear_screen()
+    rhythmsync_ascii ='''[#5900ab]
+[#5900ab] _____  _           _   _                [#00d0ff]_____                  
+[#5900ab]|  __ \\| |         | | | |              [#00d0ff]/ ____|                 
+[#5900ab]| |__) | |__  _   _| |_| |__  _ __ ___ [#00d0ff]| (___  _   _ _ __   ___ 
+[#5900ab]|  _  /| '_ \\| | | | __| '_ \\| '_ ` _ \\ [#00d0ff]\\___ \\| | | | '_ \\ / __|
+[#5900ab]| | \\ \\| | | | |_| | |_| | | | | | | | |[#00d0ff]____) | |_| | | | | (__ 
+[#5900ab]|_|  \\_\\_| |_|\\__, |\\__|_| |_|_| |_| |_|[#00d0ff]_____/ \__, |_| |_|\\___|
+[#5900ab]               __/ |                         [#00d0ff]   __/ |           
+[#5900ab]              |___/                           [#00d0ff] |___/            
+'''
+    console.print(Align.center(rhythmsync_ascii))
+    while True:
+        try:
+            global repeat
+
+            raw_command = input(">")
+            
+            if raw_command.strip():
+                command = shlex.split(raw_command)
+                command_parts = len(command)
+            
+                #help command
+                if command[0] == "help" and command_parts == 1:
+                    console.print('''command list:
+        [green]help[/green] - Lists all available commands.
+        [green]clear[/green] - Clears the terminal.
+        [green]play[/green] [cyan]{par} {path}[/cyan] - Plays the audio file located at the specified [cyan]{path}[/cyan].
+            If [cyan]{par}[/cyan] is "-r", the audio file plays in repeat until stopped.
+            If [cyan]{par}[/cyan] is "-d" and [cyan]{path}[/cyan] is a directory, the audio files of given directory play in alphabetical order.
+            If [cyan]{par}[/cyan] is "-dr" and [cyan]{path}[/cyan] is a directory, the audio files of given directory play in alphabetical order and loop around until stopped.
+            If [cyan]{par}[/cyan] is "-ds" and [cyan]{path}[/cyan] is a directory, the audio files of given directory play in shuffled order.
+            If [cyan]{par}[/cyan] is omitted, the audio file plays once.
+        [green]info[/green] [cyan]{path} {tags}[/cyan] - Displays metadata for the file at [cyan]{path}[/cyan].
+            If [cyan]{tags}[/cyan] is provided (separate them with space for multiple tags), shows only those specific tags and their respective values.
+            If [cyan]{tags}[/cyan] is omitted, shows all available tags and their respective values.
+        '''
+                                    )
+                
+                #clear command
+                elif command[0] == "clear" and command_parts == 1:
+                    clear_screen()
+                    console.print(Align.center(rhythmsync_ascii))
+                
+                #play command
+                elif command[0] == "play":
+                    if command_parts == 2:
+                        file_path = str(Path(command[1]).expanduser().resolve())
+                        if os.path.exists(file_path):
+                            run_player(file_path)
+                            clear_screen()
+                            console.print(Align.center(rhythmsync_ascii))
+                        else:
+                            print("Please enter a valid file path.")
+                    elif command_parts == 3:
+                        par = command[1]
+                        file_path = str(Path(command[2]).expanduser().resolve())
+                        if os.path.exists(file_path):
+                            if par == "-r":
+                                repeat = True
+                                while repeat:
+                                    run_player(file_path, "repeat")
+                                clear_screen()
+                                console.print(Align.center(rhythmsync_ascii))
+                            elif par == "-d":
+                                extensions = (".mp3", ".flac", ".wav", ".ogg")
+                                audio_files = [
+                                f for f in Path(file_path).iterdir()
+                                if f.suffix.lower() in extensions
+                                ]
+                                audio_files.sort()
+                                repeat = True
+                                i = 0
+                                for file in audio_files:
+                                    i += 1
+                                    run_player(file, f"directory {i} {len(audio_files)}")
+                                    if repeat == False:
+                                        break
+                                clear_screen()
+                                console.print(Align.center(rhythmsync_ascii))
+                            elif par == "-ds":
+                                extensions = (".mp3", ".flac", ".wav", ".ogg")
+                                audio_files = [
+                                f for f in Path(file_path).iterdir()
+                                if f.suffix.lower() in extensions
+                                ]
+                                shuffle(audio_files)
+                                repeat = True
+                                i = 0
+                                for file in audio_files:
+                                    i += 1
+                                    run_player(file, f"directory-shuffle {i} {len(audio_files)}")
+                                    if repeat == False:
+                                        break
+                                clear_screen()
+                                console.print(Align.center(rhythmsync_ascii))
+                            elif par == "-dr":
+                                extensions = (".mp3", ".flac", ".wav", ".ogg")
+                                audio_files = [
+                                f for f in Path(file_path).iterdir()
+                                if f.suffix.lower() in extensions
+                                ]
+                                audio_files.sort()
+                                repeat = True
+                                while repeat:
+                                    i = 0
+                                    for file in audio_files:
+                                        i += 1
+                                        run_player(file, f"directory-repeat {i} {len(audio_files)}")
+                                        if repeat == False:
+                                            break
+                                clear_screen()
+                                console.print(Align.center(rhythmsync_ascii))
+                        else:
+                            print("Please enter a valid file path.") 
+                    else:
+                        print("Please enter a valid file path and parameters.")
+                
+                #info command
+                elif command[0] == "info":
+                    if command_parts >= 2:
+                       file_path = Path(command[1]).expanduser().resolve()
+                       par = tuple(command[2:]) or None
+                       if os.path.exists(file_path):
+                           console.print(get_metadata(file_path, par), highlight=False)
+                       else:
+                           print("Please enter a valid file path.")
+                    else:
+                        print("Please enter a valid file path and parameters.")
+
+                #invalid command
+                else:
+                    print("Invalid command! Enter 'help' to display command list.")
+    
+        except KeyboardInterrupt:
+            print(f"Exitting...")
+            break
+        except Exception as e:
+            clear_screen()
+            console.print(Align.center(rhythmsync_ascii))
+            print(f"Error: {e}")
+    
+
+if __name__ == "__main__":
+    main()

rhythmsync-1.0.0/rhythmsync.egg-info/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: rhythmsync
+Version: 1.0.0
+Summary: CLI music player with synchronized lyrics (LRC) support
+Author: KON/NOS R
+License: MIT
+Keywords: music,cli,audio,lrc,player,terminal
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pygame
+Requires-Dist: rich
+Requires-Dist: mutagen
+
+# RhythmSync
+
+CLI audio player that plays music while displaying synchronized lyrics (LRC).
+
+---
+
+## Features
+
+- Play single audio files:
+  - Once
+  - In loop (`-r`)
+- Play all supported audio files in a directory:
+  - Alphabetical order (`-d`)
+  - Alphabetical loop (`-dr`)
+  - Shuffle (`-ds`)
+- Display synchronized lyrics during playback
+- Show song metadata tags
+- Styled terminal music player UI
+
+---
+
+## Supported Audio Formats
+
+- `.mp3`
+- `.flac`
+- `.wav`
+- `.ogg`
+
+### Notes
+- Other audio formats might work, but full functionality is not guaranteed.
+
+---
+
+## Lyrics Sync
+
+RhythmSync reads embedded lyric metadata from audio files.
+
+Supported tags include:
+- `SYLT`, `SYLT::eng`
+- `LYRICS`, `LYRICS:eng`
+- `LYRICS-ENG`, `LYRICS_EN`
+- `LYRICS_SYNCED`, `SYNCEDLYRICS`
+
+### LRC Format
+
+```
+[00:12.34] First line
+[00:15.67] Second line
+[00:18.90] Third line
+```
+
+- Format: `[mm:ss.xx] Line`
+
+### Notes
+- If no lyrics are found, a placeholder message is shown.
+
+---
+
+## Commands
+
+### General
+
+```
+help - Lists all available commands.
+clear - Clears the terminal.
+```
+
+
+### Playback
+
+```
+play {path} - Plays a single audio file once.
+play -r {path} - Plays a single audio file in repeat mode until stopped (Ctrl+C).
+play -d {directory} - Plays all supported audio files in alphabetical order.
+play -dr {directory} - Plays all supported audio files in alphabetical order and loops around until stopped (Ctrl+C).
+play -ds {directory} - Plays all supported audio files in shuffled order.
+```
+
+
+### Metadata
+
+```
+info {path} - Displays all available metadata.
+info {path} [tags] - Displays only given metadata tags.
+```
+
+---
+
+## Notes
+
+- Paths containing spaces must be wrapped in quotes:
+
+```
+play "My Music/song.mp3"
+```
+
+- Use `Ctrl+C` to stop playback or exit the app

rhythmsync-1.0.0/rhythmsync.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+rhythmsync/__init__.py
+rhythmsync/main.py
+rhythmsync.egg-info/PKG-INFO
+rhythmsync.egg-info/SOURCES.txt
+rhythmsync.egg-info/dependency_links.txt
+rhythmsync.egg-info/entry_points.txt
+rhythmsync.egg-info/requires.txt
+rhythmsync.egg-info/top_level.txt

rhythmsync-1.0.0/rhythmsync.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

rhythmsync-1.0.0/rhythmsync.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+rhythmsync = rhythmsync.main:main

rhythmsync-1.0.0/rhythmsync.egg-info/requires.txt

@@ -0,0 +1,3 @@
+pygame
+rich
+mutagen

rhythmsync-1.0.0/rhythmsync.egg-info/top_level.txt

@@ -0,0 +1 @@
+rhythmsync

rhythmsync-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+