Skip to main content

A simple LRC parser for Python.

Project description

Lemony LRC Parser

Python License: MIT PyPI

柠檬味的 Python LRC 歌词解析器.

Lemon-flavored LRC Parser for Python.

Features

  • 解析标准 LRC 歌词文件
  • 支持 EnhancedLRC / SPL 的逐字歌词标签
  • 支持 metadata 标签
  • 支持折叠时间标签
  • 支持参照行
  • 支持歌词合并
  • 完整的类型注解

Installation

推荐使用 uv.

It's recommend to use uv.

uv add lemony-lrc-parser

用 pip 也行.

It's okay to use pip.

pip install lemony-lrc-parser

Usage

Quick Start

import lemony_lrc_parser as llp

lrc_text = """[ti: Never Gonna Give You Up]
[ar: Rick Astley]

[00:18.684]We're no strangers to love
[00:18.684]我们都是情场老手

[00:22.657]You know the rules and so do I
[00:22.657]你和我都知道爱情的规则

[00:27.070]A full commitment's what I'm thinking of
[00:27.070]我在想的正是一份实打实的承诺

[00:31.459]You wouldn't get this from any other guy
[00:31.459]你从其他人那里得不到的
"""

# 解析
lyrics = llp.loads(lrc_text)

# 访问 metadata
print(lyrics.metadata["ti"])  # "Never Gonna Give You Up"
print(lyrics.metadata["ar"])  # "Rick Astley"

# 遍历歌词行
for line in lyrics:
    print(f"{line.start}ms: {line.text}")

# 序列化回 LRC 文本
output = llp.dumps(lyrics)

OOP Interface

Lyrics 类提供面向对象的解析和序列化入口:

from lemony_lrc_parser import Lyrics

lyrics = Lyrics.loads(lrc_text)

# Lyrics 同时是序列容器
print(len(lyrics))    # 行数
print(lyrics[0].text) # 第一行文本
print(lyrics[-1].text)

# 切片访问
first_three = lyrics[0:3]

# 序列化
lrc_output = lyrics.dumps()

# __str__ 等价于 dumps()
print(lyrics)

Word-level Lyrics

解析逐字 (Enhanced LRC / SPL) 歌词:

lrc_text = "[00:01.00]<00:01.00>Never <00:01.50>gonna <00:02.00>give <00:02.50>you <00:03.00>up[00:03.50]"

lyrics = llp.loads(lrc_text)
line = lyrics[0]

for word in line.content:
    print(f"  [{word.start} -> {word.end}] {word.content!r}")
    # [1000 -> 1500] 'Never '
    # [1500 -> 2000] 'gonna '
    # [2000 -> 2500] 'give '
    # [2500 -> 3000] 'you '
    # [3000 -> None] 'up'

# 行级时间: line.start=1000, line.end=3500

Reference Lines (Translation / Transliteration)

LRC 文件中, 紧跟在带时间标签行后面的无标签行, 或与主行的时间戳相同的行, 会被解析为参考行, 常用于存放翻译或音译:

lrc_text = """[00:01.00]Hello
    你好
[00:02.00]World
[00:02.00]世界
"""

lyrics = llp.loads(lrc_text)

line = lyrics[0]
print(line.text)                              # "Hello"
print(line.reference_lines[0][0].content)     # "你好"

Combining Lyrics

将两份歌词 (如原文和翻译) 按时间标签合并:

main = llp.loads("[00:01.00]Hello\n[00:02.00]World\n")
translation = llp.loads("[00:01.00]你好\n[00:02.00]世界\n")

# combine 方法: 翻译行挂到同时间点的 reference_lines 中
combined = main.combine(translation)

# 也可以用 + 运算符
combined = main + translation

for line in combined:
    print(line.text)  # 主歌词
    for ref in line.reference_lines:
        ref_text = "".join(w.content for w in ref)
        print(f"  -> {ref_text}")  # 参考行

# other_as_refline_only=False 时, 翻译中找不到对应时间点的行会作为新行保留
combined = main.combine(translation, other_as_refline_only=False)

Implicit Line End

当歌词行没有显式结束时间时, 可以自动用下一行的开始时间填充:

from lemony_lrc_parser import Lyrics
from lemony_lrc_parser.models import ParseOptions

lyrics = Lyrics.loads(lrc_text, options=ParseOptions(fill_implicit_line_end=True))

# lyrics[0].end == lyrics[1].start

Parsing Options

from lemony_lrc_parser import Lyrics
from lemony_lrc_parser.models import ParseOptions

lyrics = Lyrics.loads(
    lrc_text,
    options=ParseOptions(
        fill_implicit_line_end=False,       # 是否填充隐式行尾时间
    ),
)

Serialization Options

通过 SerializationOptions 控制序列化行为:

from lemony_lrc_parser import Lyrics
from lemony_lrc_parser.models import SerializationOptions

output = lyrics.dumps(
    options=SerializationOptions(
        with_metadata=True,                     # 是否输出 metadata 段
        use_bracket_for_byword_tag=False,       # 逐字标签使用 [...] 还是 <...> (默认)
        skip_empty_metadata=True,               # 跳过空值的 metadata 键
        line_tag_decimal_length=2,              # 行标签毫秒位数 (默认 2)
        word_tag_decimal_length=2,              # 逐字标签毫秒位数 (默认 2)
    ),
)

Offset 语义

使用 Lyrics.apply_offset(ms) 应用时间偏移:

  • ms > 0 → 歌词延后出现 (display_time = tag_time + ms)
  • ms < 0 → 歌词提前出现 (display_time = tag_time - |ms|)

如果应用 offset 会导致时间戳变为负数, 将抛出 ValueError, 由调用方自行处理.

小数位数

默认 line_tag_decimal_length=2word_tag_decimal_length=2, 输出格式如 [00:01.00]<00:01.05>. 此时小数部分表示百分秒, 不足 2 位时自动补齐. 若需保留完整的毫秒精度, 请设置为 3.

Applying Offset

通过 Lyrics.apply_offset(ms) 对时间戳应用偏移, 返回一个新对象:

from lemony_lrc_parser import Lyrics

lyrics = Lyrics.loads(lrc_text)

# 正数 → 歌词延后出现 (等价于 lyrics >> 500)
shifted = lyrics.apply_offset(500)

# 负数 → 歌词提前出现 (等价于 lyrics << 500)
shifted = lyrics.apply_offset(-500)

# 使用 << / >> 运算符
shifted = lyrics >> 500   # 延后 500ms
shifted = lyrics << 500   # 提前 500ms

# shifted 的时间戳已被整体偏移, 原始 lyrics 不受影响

如果偏移会导致时间戳变为负数, 将抛出 ValueError.

序列化时不会再自动应用 offset;如需在序列化前偏移时间戳, 请先调用 apply_offset() 再序列化返回的副本.

Skip Empty Metadata

默认跳过空值的 metadata 键:

from lemony_lrc_parser import Lyrics
from lemony_lrc_parser.models import SerializationOptions

lyrics = Lyrics.loads('[ti: Test]\n[empty: ]\n[00:01.00]Hello\n')

# 默认跳过空值
print(lyrics.dumps())  # 不含 [empty: ]

# 保留空值
print(lyrics.dumps(options=SerializationOptions(skip_empty_metadata=False)))

References

LRC Wikipedia

SPL Specification

UwU?

UwU!

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lemony_lrc_parser-0.3.0a0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file lemony_lrc_parser-0.3.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for lemony_lrc_parser-0.3.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 56448879968269dfd7c871a84de05413b8d150caa17fafee11dc3d7f50155f52
MD5 9f56ade3dfb7d9adc7e2300b760a7959
BLAKE2b-256 0f961eb5106b18ef83ed0f9fe048ae29320aafce42976dd8f51d5863878c5781

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page