feat: Lyrics

This commit is contained in:
yhlhoh committed 2026-10-24 10:54:52 +08:00
1 parent 6ed3e169e4
commit 82b1fa0d47
17 files changed
+3863 -283

No files matched your search

+226
View File
@@ -0,0 +1,226 @@
'use strict';
const test = require('node:test');
const assert = require('node:assert/strict');
const {
parseLrc,
parseTimestamp,
buildTimeline,
isCreditLine,
normalizeLrcPreset,
DEFAULT_CREDIT_KEYWORDS,
} = require('../lib/lrc');
const SAMPLE = `[ti:测试曲目]
[ar:测试歌手]
[al:测试专辑]
[by:editor]
[offset:0]
[00:00.00]作词:甲
[00:00.50]作曲:乙
[00:01.00]第一句
[00:03.50]第二句
[00:06.00][00:09.00]重复副歌
[00:12.000]最后一句
`;
test('parseTimestamp 支持 mm:ss / mm:ss.xx / mm:ss.xxx', () => {
assert.equal(parseTimestamp('00:12'), 12);
assert.equal(parseTimestamp('01:02.5'), 62.5);
assert.equal(parseTimestamp('01:02.50'), 62.5);
assert.equal(parseTimestamp('01:02.500'), 62.5);
assert.equal(parseTimestamp('1:02:50'), 62.5);
assert.equal(parseTimestamp('abc'), null);
assert.equal(parseTimestamp('00:61'), null);
});
test('parseLrc 提取元数据与时间戳歌词', () => {
const parsed = parseLrc(SAMPLE);
assert.equal(parsed.meta.ti, '测试曲目');
assert.equal(parsed.meta.ar, '测试歌手');
assert.equal(parsed.metaOffsetMs, 0);
assert.equal(parsed.lyricEntries.length, 7);
assert.deepEqual(parsed.lyricEntries.map((e) => e.time), [0, 0.5, 1, 3.5, 6, 9, 12]);
assert.equal(parsed.warnings.length, 0);
});
test('parseLrc 清理增强型逐字时间戳', () => {
const parsed = parseLrc('[00:01.00]<00:01.00>你<00:01.50>好');
assert.equal(parsed.lyricEntries[0].text, '你好');
});
test('parseLrc 保留增强型逐字片段', () => {
const parsed = parseLrc('[00:01.00]<00:01.00>Hello <00:01.50>world');
const entry = parsed.lyricEntries[0];
assert.equal(entry.text, 'Hello world');
assert.equal(entry.segments.length, 2);
assert.equal(entry.segments[0].text, 'Hello ');
assert.equal(entry.segments[0].time, 1);
assert.equal(entry.segments[1].text, 'world');
assert.equal(entry.segments[1].time, 1.5);
});
test('buildTimeline 输出相对 cue 的逐字时间轴', () => {
const parsed = parseLrc('[00:10.00]<00:10.00>逐<00:10.50>字<00:11.00>测试');
const timeline = buildTimeline(parsed, { offsetMs: 0, range: { startIndex: 0, endIndex: null } });
assert.equal(timeline.cues[0].text, '逐字测试');
assert.deepEqual(timeline.cues[0].segments.map((s) => s.at), [0, 500, 1000]);
assert.equal(timeline.stats.karaokeCues, 1);
const shifted = buildTimeline(parsed, { offsetMs: 200, range: { startIndex: 0, endIndex: null } });
assert.deepEqual(shifted.cues[0].segments.map((s) => s.at), [200, 700, 1200]);
});
test('一行多时间戳时退回整句,避免逐字时间错位', () => {
const parsed = parseLrc('[00:01.00][00:20.00]<00:01.00>AB<00:01.50>CD');
assert.equal(parsed.lyricEntries[0].segments, null);
assert.equal(parsed.lyricEntries[1].segments, null);
assert.equal(parsed.lyricEntries[0].text, 'ABCD');
});
test('同一时间点多行合并时退回整句点亮', () => {
const parsed = parseLrc('[00:01.00]<00:01.00>A<00:01.50>B\n[00:01.00]C');
const timeline = buildTimeline(parsed, {});
assert.equal(timeline.cues.length, 1);
assert.equal(timeline.cues[0].text, 'AB\nC');
assert.equal(timeline.cues[0].segments, null);
assert.equal(timeline.stats.karaokeCues, 0);
});
test('逐字片段可独立关闭,且自定义 CSS 会被保留', () => {
const preset = normalizeLrcPreset({
id: 'css-test',
source: '[00:01.00]<00:01.00>A<00:01.50>B',
style: {
animation: 'custom',
karaoke: false,
customCss: '.lrc-box { border: 1px solid red; }',
},
});
assert.equal(preset.style.animation, 'custom');
assert.equal(preset.style.karaoke, false);
assert.match(preset.style.customCss, /border: 1px solid red/);
const longCss = normalizeLrcPreset({
id: 'css-long',
source: '',
style: { customCss: 'x'.repeat(60000), animation: 'not-a-real-animation' },
});
assert.equal(longCss.style.customCss.length, 50000);
assert.equal(longCss.style.animation, 'fade');
});
test('parseLrc 处理 offset 元数据与无时间戳行', () => {
const parsed = parseLrc('[offset:+250]\n没有时间戳的标题\n[00:01.00]歌词');
assert.equal(parsed.metaOffsetMs, 250);
assert.equal(parsed.lines.some((l) => l.kind === 'untimed'), true);
assert.equal(parsed.lyricEntries.length, 1);
});
test('isCreditLine 识别版权 / 制作信息但保留正常歌词', () => {
assert.equal(isCreditLine('作词:某人', DEFAULT_CREDIT_KEYWORDS), true);
assert.equal(isCreditLine(' [制作人] 某某', DEFAULT_CREDIT_KEYWORDS), true);
assert.equal(isCreditLine('© 2024 Example Studio', DEFAULT_CREDIT_KEYWORDS), true);
assert.equal(isCreditLine('This Song (Produced by X)', DEFAULT_CREDIT_KEYWORDS), true);
assert.equal(isCreditLine('第一句歌词', DEFAULT_CREDIT_KEYWORDS), false);
assert.equal(isCreditLine('我写了这首歌的作词部分作为纪念,但这句是很长的歌词不应该被过滤', DEFAULT_CREDIT_KEYWORDS), false);
});
test('buildTimeline 过滤版权行并把第一句归零(自动偏移)', () => {
const parsed = parseLrc(SAMPLE);
const timeline = buildTimeline(parsed, {
filters: { dropCreditLines: true, creditKeywords: DEFAULT_CREDIT_KEYWORDS },
range: { startIndex: 0, endIndex: null },
offsetMs: 0,
tailMs: 4000,
});
assert.equal(timeline.stats.excludedCredit, 2);
assert.equal(timeline.cues.length, 5);
assert.equal(timeline.cues[0].text, '第一句');
assert.equal(timeline.cues[0].t, 0);
assert.equal(timeline.cues[1].t, 2500);
assert.equal(timeline.cues[2].t, 5000);
assert.equal(timeline.cues[3].t, 8000);
assert.equal(timeline.cues[4].t, 11000);
assert.equal(timeline.endMs, 15000);
});
test('buildTimeline 支持范围选择与手动偏移', () => {
const parsed = parseLrc(SAMPLE);
const timeline = buildTimeline(parsed, {
filters: { dropCreditLines: true, creditKeywords: DEFAULT_CREDIT_KEYWORDS },
range: { startIndex: 1, endIndex: 2 },
offsetMs: 300,
tailMs: 2000,
});
assert.equal(timeline.cues.length, 2);
assert.equal(timeline.cues[0].text, '第二句');
assert.equal(timeline.cues[0].t, 300); // 首句也应用手动偏移
assert.equal(timeline.cues[1].text, '重复副歌');
assert.equal(timeline.cues[1].t, 2800);
assert.equal(timeline.endMs, 4800);
assert.deepEqual(timeline.range, { startIndex: 1, endIndex: 2 });
});
test('buildTimeline 合并同一时间点的多行(双语歌词)', () => {
const parsed = parseLrc('[00:01.00]Hello\n[00:01.00]你好\n[00:03.00]World');
const timeline = buildTimeline(parsed, {});
assert.equal(timeline.cues.length, 2);
assert.equal(timeline.cues[0].text, 'Hello\n你好');
assert.equal(timeline.cues[1].t, 2000);
});
test('buildTimeline 应用 LRC offset 元数据(正值提前)', () => {
const parsed = parseLrc('[offset:+500]\n[00:02.00]A\n[00:04.00]B');
const timeline = buildTimeline(parsed, { offsetMs: 0 });
assert.equal(timeline.metaOffsetMs, 500);
assert.equal(timeline.cues[0].t, 0);
assert.equal(timeline.cues[1].t, 1500);
});
test('normalizeLrcPreset 约束字段范围并保留数据', () => {
const preset = normalizeLrcPreset({
id: 'x1',
name: ' 测试字幕 ',
source: '[00:01.00]A',
filters: { creditKeywords: ['作词', '作词', ' 作曲 '] },
range: { startIndex: 5, endIndex: 2 },
offsetMs: 999999,
tailMs: -5,
style: { fontSize: 999, position: 'somewhere', align: 'center' },
});
assert.equal(preset.id, 'x1');
assert.equal(preset.name, '测试字幕');
assert.deepEqual(preset.filters.creditKeywords, ['作词', '作曲']);
assert.deepEqual(preset.range, { startIndex: 0, endIndex: 0 });
assert.equal(preset.offsetMs, 60000);
assert.equal(preset.tailMs, 0);
assert.equal(preset.style.fontSize, 200);
assert.equal(preset.style.position, 'bottom');
assert.equal(preset.style.align, 'center');
});
test('normalizeStyle 支持禁用背景 / 阴影 / 逐字', () => {
const preset = normalizeLrcPreset({
id: 'toggles',
source: '[00:01.00]A',
style: {
backgroundEnabled: false,
textShadowEnabled: false,
karaoke: false,
karaokePendingColor: 'rgba(255, 0, 0, 0.3)',
},
});
assert.equal(preset.style.backgroundEnabled, false);
assert.equal(preset.style.textShadowEnabled, false);
assert.equal(preset.style.karaoke, false);
assert.equal(preset.style.karaokePendingColor, 'rgba(255, 0, 0, 0.3)');
// 未提供时默认开启
const defaults = normalizeLrcPreset({ id: 'defaults', source: '[00:01.00]A' });
assert.equal(defaults.style.backgroundEnabled, true);
assert.equal(defaults.style.textShadowEnabled, true);
assert.equal(defaults.style.karaoke, true);
});
+141
View File
@@ -0,0 +1,141 @@
'use strict';
const test = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const os = require('os');
const path = require('path');
const { createStores } = require('../lib/store');
const models = require('../lib/models');
const { normalizeLrcPreset, DEFAULT_CREDIT_KEYWORDS } = require('../lib/lrc');
function makeTempDir() {
return fs.mkdtempSync(path.join(os.tmpdir(), 'obs-lt-store-'));
}
function makeStores(dir) {
return createStores(dir, {
appearancePresets: [{
id: 'ap-1',
name: 'seed appearance',
kind: 'iframe',
align: 'right',
html: '<div>{{title}}</div>',
fieldDefs: [{ key: 'title', label: '标题', defaultValue: 'hello' }],
}],
contentPresets: [{
id: 'cp-1',
name: 'seed content',
appearancePresetId: 'ap-1',
fields: { title: 'world' },
}],
lrcPresets: [{
id: 'lrc-1',
name: 'seed lrc',
source: '[00:01.00]A\n[00:03.00]B',
filters: { dropCreditLines: true, dropUntimed: true, creditKeywords: DEFAULT_CREDIT_KEYWORDS },
range: { startIndex: 0, endIndex: null },
offsetMs: 0,
tailMs: 4000,
style: {},
}],
settings: { autoHideDuration: 0 },
normalizeAppearancePreset: models.normalizeAppearancePreset,
normalizeContentPreset: models.normalizeContentPreset,
normalizeLrcPreset,
});
}
test('首次启动写入种子数据,重启后数据保持不变', () => {
const dir = makeTempDir();
try {
const stores = makeStores(dir);
assert.equal(stores.appearancePresets.list().length, 1);
assert.equal(stores.contentPresets.list().length, 1);
assert.equal(stores.lrcPresets.list().length, 1);
assert.equal(stores.settings.value.autoHideDuration, 0);
for (const name of ['appearance-presets.json', 'content-presets.json', 'lrc-presets.json', 'settings.json']) {
assert.equal(fs.existsSync(path.join(dir, name)), true, name + ' should exist');
}
const inserted = stores.lrcPresets.insert({
name: '新增 LRC',
source: '[00:02.00]第一句\n[00:05.00]第二句',
filters: { dropCreditLines: true, dropUntimed: true },
range: { startIndex: 0, endIndex: 0 },
offsetMs: 120,
tailMs: 2000,
style: { fontSize: 50 },
});
assert.ok(inserted.id);
stores.settings.update({ autoHideDuration: 4500 });
// 重新从磁盘加载,验证持久化
const reloaded = makeStores(dir);
const found = reloaded.lrcPresets.find(inserted.id);
assert.ok(found);
assert.equal(found.name, '新增 LRC');
assert.deepEqual(found.range, { startIndex: 0, endIndex: 0 });
assert.equal(found.offsetMs, 120);
assert.equal(found.tailMs, 2000);
assert.equal(found.style.fontSize, 50);
assert.equal(reloaded.settings.value.autoHideDuration, 4500);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
test('数据损坏时备份为 .bak 并用种子重建', () => {
const dir = makeTempDir();
try {
makeStores(dir);
const file = path.join(dir, 'lrc-presets.json');
fs.writeFileSync(file, '{ this is not json', 'utf8');
const stores = makeStores(dir);
assert.equal(stores.lrcPresets.list().length, 1);
assert.equal(stores.lrcPresets.list()[0].id, 'lrc-1');
const backups = fs.readdirSync(dir).filter((name) => name.includes('.corrupt-') && name.endsWith('.bak'));
assert.equal(backups.length, 1);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
test('更新与删除会立即落盘且不留下临时文件', () => {
const dir = makeTempDir();
try {
const stores = makeStores(dir);
const updated = stores.contentPresets.update('cp-1', { name: '改过的内容', fields: { title: 'changed' } });
assert.equal(updated.name, '改过的内容');
const afterUpdate = makeStores(dir);
assert.equal(afterUpdate.contentPresets.find('cp-1').name, '改过的内容');
assert.equal(stores.appearancePresets.remove('ap-1'), true);
const afterDelete = makeStores(dir);
assert.equal(afterDelete.appearancePresets.find('ap-1'), null);
const leftovers = fs.readdirSync(dir).filter((name) => name.endsWith('.tmp'));
assert.deepEqual(leftovers, []);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
test('写入时会规整非法字段(不会原样落盘)', () => {
const dir = makeTempDir();
try {
const stores = makeStores(dir);
const inserted = stores.lrcPresets.insert({ name: '', source: 123, offsetMs: 'abc', style: { fontSize: 999 } });
assert.equal(inserted.source, '');
assert.equal(inserted.name, '未命名 LRC 字幕');
assert.equal(inserted.offsetMs, 0);
assert.equal(inserted.style.fontSize, 200);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});