read music lyrics from container metadata

Open
#1,985 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
data

Research direction

No file, class or test is named in the payload, so the first step is to ask the maintainer where audio metadata is currently assembled for the training pipeline and which collector interface a new one must implement. The goal is a collector that reads USLT (unsynchronised lyrics) frames out of MP3 containers via mutagen or music-tag and exposes them as lyrics/metadata for training, without loading whole files into memory. Done means that collector is wired into the existing metadata path and covered by a test using a tagged MP3 fixture. Note the issue has sat unaddressed for about ten months with no comments, so confirm the design is still wanted before starting.

Written by the indexing model from the issue text.

Description

enhancement

mutagen and music-tag are great python libraries for reading audio container metadata.

we can read the USLT (unsynchronised lyrics) from MP3 files, so if a user has an extensively tagged library, they can just use the files as-is and their lyrics will be found.

i don't think it'll even be that slow - we'll be I/O bound for the most part, but it will probably need a specialised collector class.

Dominant language
Python
Stars
2.9k
Forks
295
Avg merge
3h 28m
Merged PRs (30d)
42

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bghira/SimpleTuner

All issues in bghira/SimpleTuner

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.