@applemusic-like-lyrics/lyric 0.2.4 → 0.4.0

package/README.md

@@ -1,35 +1,36 @@
 # Lyric parser/writer for AMLL
 
-> 警告：此为个人项目，且尚未完成开发，可能仍有大量问题，所以请勿直接用于生产环境！
+English / [简体中文](./README-CN.md)
+
+> Warning: This is a personal project and is still under development. There may still be many issues, so please do not use it directly in production environments!
 
 ![AMLL-Lyric](https://img.shields.io/badge/Lyric-%23FB8C84?label=Apple%20Music-like%20Lyrics&labelColor=%23FB5C74)
 [![npm](https://img.shields.io/npm/dt/%40applemusic-like-lyrics/lyric)](https://www.npmjs.com/package/@applemusic-like-lyrics/lyric)
 [![npm](https://img.shields.io/npm/v/%40applemusic-like-lyrics%2Flyric)](https://www.npmjs.com/package/@applemusic-like-lyrics/lyric)
 
-一个 AMLL 的歌词解析/生成模块，使用 Rust 编写，并通过 `wasm-pack`
-构建成 WASM 模块以提供给其他项目使用。
+A lyric parsing/generation module for AMLL, written in Rust and built into a WASM module using `wasm-pack` for use in other projects.
 
-本模块由于只着重于歌词内容，所以会丢弃一切和歌词无关的信息，如需获取一个歌词文件中的详细信息（例如歌手）请考虑使用其他框架。
+Since this module focuses only on lyric content, it discards all information unrelated to lyrics. If you need to get detailed information from a lyric file (such as artist), please consider using other frameworks.
 
-歌词格式支持表：
+Lyric format support table:
 
-| 源格式＼目标格式                      | 解析自身格式 | LyRiC 格式 `.lrc` | ESLyric 逐词歌词格式 `.lrc` | 网易云音乐逐词歌词格式 `.yrc` | QQ 音乐逐词歌词格式 `.qrc` | Lyricify Syllable 逐词歌词格式 `.lys` | TTML 歌词格式 `.ttml` | ASS 字幕格式 `.ass` |
-| ------------------------------------- | ------------ | ----------------- | --------------------------- | ----------------------------- | -------------------------- | ------------------------------------- | --------------------- | ------------------- |
-| LyRiC 格式 `.lrc`                     | ✅           | ／                | ✅                          | ✅                            | ✅                         | ✅                                    | ✅                    | ✅                  |
-| ESLyric 逐词歌词格式 `.lrc`           | ✅           | ✅                | ／                          | ✅                            | ✅                         | ✅                                    | ✅                    | ✅                  |
-| 网易云音乐逐词歌词格式 `.yrc`         | ✅           | ✅ [^1]           | ✅ [^1]                     | ／                            | ✅                         | ✅                                    | ✅                    | ✅                  |
-| QQ 音乐逐词歌词格式 `.qrc`            | ✅           | ✅ [^1]           | ✅ [^1]                     | ✅                            | ／                         | ✅                                    | ✅                    | ✅                  |
-| Lyricify Syllable 逐词歌词格式 `.lys` | ✅           | ✅ [^1]           | ✅ [^1]                     | ✅ [^2]                       | ✅ [^2]                    | ／                                    | ✅                    | ✅                  |
-| TTML 歌词格式 `.ttml`                 | ✅           | ✅ [^1]           | ✅ [^1]                     | ✅ [^2]                       | ✅ [^2]                    | ✅ [^3]                               | ／                    | ✅                  |
-| ASS 字幕格式 `.ass`                   | ❌           | ❌                | ❌                          | ❌                            | ❌                         | ❌                                    | ❌                    | ／                  |
+| Source Format＼Target Format          | Parse Own Format | LyRiC Format `.lrc` | ESLyric Word-by-word Format `.lrc` | NetEase Cloud Music Word-by-word Format `.yrc` | QQ Music Word-by-word Format `.qrc` | Lyricify Syllable Word-by-word Format `.lys` | TTML Lyric Format `.ttml` | ASS Subtitle Format `.ass` |
+| ------------------------------------- | --------------- | ------------------- | ---------------------------------- | --------------------------------------------- | ---------------------------------- | -------------------------------------------- | ------------------------ | -------------------------- |
+| LyRiC Format `.lrc`                     | ✅              | ／                  | ✅                                 | ✅                                            | ✅                                 | ✅                                           | ✅                       | ✅                         |
+| ESLyric Word-by-word Format `.lrc`      | ✅              | ✅                  | ／                                 | ✅                                            | ✅                                 | ✅                                           | ✅                       | ✅                         |
+| NetEase Cloud Music Word-by-word Format `.yrc` | ✅       | ✅ [^1]             | ✅ [^1]                            | ／                                            | ✅                                 | ✅                                           | ✅                       | ✅                         |
+| QQ Music Word-by-word Format `.qrc`     | ✅              | ✅ [^1]             | ✅ [^1]                            | ✅                                            | ／                                 | ✅                                           | ✅                       | ✅                         |
+| Lyricify Syllable Word-by-word Format `.lys` | ✅         | ✅ [^1]             | ✅ [^1]                            | ✅ [^2]                                       | ✅ [^2]                            | ／                                           | ✅                       | ✅                         |
+| TTML Lyric Format `.ttml`               | ✅              | ✅ [^1]             | ✅ [^1]                            | ✅ [^2]                                       | ✅ [^2]                            | ✅ [^3]                                      | ／                       | ✅                         |
+| ASS Subtitle Format `.ass`              | ❌              | ❌                  | ❌                                 | ❌                                            | ❌                                 | ❌                                           | ❌                       | ／                         |
 
-[^1]: 会丢失逐词时间数据、演唱属性（背景人声，对唱人声）和 AMLL 元数据
-[^2]: 会丢失演唱属性（背景人声，对唱人声）和 AMLL 元数据
-[^3]: 会丢失 AMLL 元数据
+[^1]: Will lose word-by-word timing data, vocal attributes (background vocals, duet vocals) and AMLL metadata
+[^2]: Will lose vocal attributes (background vocals, duet vocals) and AMLL metadata
+[^3]: Will lose AMLL metadata
 
-## 与 Core 歌词组件一起使用
+## Using with Core Lyric Component
 
-在和二者合用的时候，需要注意**两者的歌词行结构并不完全相同**，需要进行诸如（以 LyRiC 举例）下面的方式进行转换方可被歌词组件正确解析：
+When using them together, note that **the lyric line structures of the two are not exactly the same**. You need to convert them in a way like the following example (using LyRiC as an example) for the lyric component to parse correctly:
 
 ```typescript
 import { parseLrc } from "@applemusic-like-lyrics/lyric";
@@ -49,12 +50,12 @@ const converted = lines.map((line, i, lines) => ({
     isBG: false,
     isDuet: false,
 }));
-// 此时就可以将 converted 传给 LyricPlayer 了
+// Now you can pass converted to LyricPlayer
 ```
 
-推荐使用 TypeScript，这样可以更方便地查错。
+Using TypeScript is recommended as it makes it easier to detect errors.
 
-## 构建
+## Building
 
 ```shell
 wasm-pack build --target bundler --release --scope applemusic-like-lyrics

package/package.json

@@ -4,11 +4,16 @@
     "SteveXMH <39523898+Steve-xmh@users.noreply.github.com>"
   ],
   "description": "一个歌词解析/生成模块，着重于歌词内容解析，支持多种格式",
-  "version": "0.2.4",
+  "version": "0.4.0",
   "license": "GPL-3.0",
+  "nx": {
+    "tags": [
+      "library"
+    ]
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Steve-xmh/applemusic-like-lyrics"
+    "url": "https://github.com/amll-dev/applemusic-like-lyrics"
   },
   "files": [
     "pkg/*.wasm",

package/pkg/amll_lyric.d.ts

@@ -1,14 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
-* When the `console_error_panic_hook` feature is enabled, we can call the
-* `set_panic_hook` function at least once during initialization, and then
-* we will get better error messages if our code ever panics.
-*
-* For more details see
-* https://github.com/rustwasm/console_error_panic_hook#readme
-*/
-export function wasm_start(): void;
 /**
  * 解析 LyRiC 格式的歌词字符串
  * @param src 歌词字符串
@@ -96,12 +87,14 @@ export function stringifyAss(lines: LyricLine[]): string;
  * 一个歌词单词
  */
 export interface LyricWord {
-	/** 单词的起始时间 */
-	startTime: number;
-	/** 单词的结束时间 */
-	endTime: number;
-	/** 单词 */
-	word: string;
+    /** 单词的起始时间 */
+    startTime: number;
+    /** 单词的结束时间 */
+    endTime: number;
+    /** 单词 */
+    word: string;
+    /** 单词的音译 */
+    romanWord: string;
 }
 
 /**
@@ -109,41 +102,41 @@ export interface LyricWord {
  * 如果是 LyRiC 等只能表达一行歌词的格式，则会将整行当做一个单词存储起来
  */
 export interface LyricLine {
-	/**
-	 * 该行的所有单词
-	 * 如果是 LyRiC 等只能表达一行歌词的格式，这里就只会有一个单词
-	 */
-	words: LyricWord[];
-	/**
-	 * 该行的翻译
-	 */
-	translatedLyric: string;
-	/**
-	 * 该行的音译
-	 */
-	romanLyric: string;
-	/**
-	 * 该行是否为背景歌词行
-	 * 此选项只有作为 Lyricify Syllable 文件格式导入导出时才有意义
-	 */
-	isBG: boolean;
-	/**
-	 * 该行是否为对唱歌词行（即歌词行靠右对齐）
-	 * 此选项只有作为 Lyricify Syllable 文件格式导入导出时才有意义
-	 */
-	isDuet: boolean;
-	/**
-	 * 该行的开始时间
-	 *
-	 * **并不总是等于第一个单词的开始时间**
-	 */
-	startTime: number;
-	/**
-	 * 该行的结束时间
-	 *
-	 * **并不总是等于最后一个单词的开始时间**
-	 */
-	endTime: number;
+    /**
+     * 该行的所有单词
+     * 如果是 LyRiC 等只能表达一行歌词的格式，这里就只会有一个单词
+     */
+    words: LyricWord[];
+    /**
+     * 该行的翻译
+     */
+    translatedLyric: string;
+    /**
+     * 该行的音译
+     */
+    romanLyric: string;
+    /**
+     * 该行是否为背景歌词行
+     * 此选项只有作为 Lyricify Syllable 文件格式导入导出时才有意义
+     */
+    isBG: boolean;
+    /**
+     * 该行是否为对唱歌词行（即歌词行靠右对齐）
+     * 此选项只有作为 Lyricify Syllable 文件格式导入导出时才有意义
+     */
+    isDuet: boolean;
+    /**
+     * 该行的开始时间
+     *
+     * **并不总是等于第一个单词的开始时间**
+     */
+    startTime: number;
+    /**
+     * 该行的结束时间
+     *
+     * **并不总是等于最后一个单词的开始时间**
+     */
+    endTime: number;
 }
 
 /**
@@ -158,14 +151,14 @@ export function decryptQrcHex(hexData: string): string;
  * 一个 TTML 歌词行对象，存储了歌词行信息和 AMLL 元数据信息
  */
 export interface TTMLLyric {
-	/**
-	 * TTML 中存储的歌词行信息
-	 */
-	lines: LyricLine[];
-	/**
-	 * 一个元数据表，以 `[键, 值数组]` 的形式存储
-	 */
-	metadata: [string, string[]][];
+    /**
+     * TTML 中存储的歌词行信息
+     */
+    lines: LyricLine[];
+    /**
+     * 一个元数据表，以 `[键, 值数组]` 的形式存储
+     */
+    metadata: [string, string[]][];
 }
 
 /**
@@ -182,3 +175,13 @@ export function parseTTML(src: string): TTMLLyric;
 export function stringifyTTML(lyric: TTMLLyric): string;
 
 
+
+/**
+ * When the `console_error_panic_hook` feature is enabled, we can call the
+ * `set_panic_hook` function at least once during initialization, and then
+ * we will get better error messages if our code ever panics.
+ *
+ * For more details see
+ * https://github.com/rustwasm/console_error_panic_hook#readme
+ */
+export function wasm_start(): void;

package/pkg/amll_lyric.js

@@ -1,7 +1,9 @@
+/* @ts-self-types="./amll_lyric.d.ts" */
 
 import * as wasm from "./amll_lyric_bg.wasm";
 import { __wbg_set_wasm } from "./amll_lyric_bg.js";
 __wbg_set_wasm(wasm);
-export * from "./amll_lyric_bg.js";
-
 wasm.__wbindgen_start();
+export {
+    decryptQrcHex, parseEslrc, parseLrc, parseLys, parseQrc, parseTTML, parseYrc, stringifyAss, stringifyEslrc, stringifyLrc, stringifyLys, stringifyQrc, stringifyTTML, stringifyYrc, wasm_start
+} from "./amll_lyric_bg.js";