@applemusic-like-lyrics/lyric 0.0.2 → 0.1.0

package/README.md

@@ -1,5 +1,11 @@
 # Lyric parser/writer for AMLL
 
+> 警告：此为个人项目，且尚未完成开发，可能仍有大量问题，所以请勿直接用于生产环境！
+
+![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 模块以提供给其他项目使用。
 
@@ -17,3 +23,36 @@
 - QQ 音乐逐词歌词格式 `.qrc`
 - Lyricify Syllable 逐词歌词格式 `.lys`
 - ASS 字幕格式 `.ass`
+
+## 与 Core 歌词组件一起使用
+
+在和二者合用的时候，需要注意**两者的歌词行结构并不完全相同**，需要进行诸如（以 LyRiC 举例）下面的方式进行转换方可被歌词组件正确解析：
+
+```typescript
+import { parseLrc } from "@applemusic-like-lyrics/lyric";
+const lines = parseLrc("[00:00.00]test");
+const converted = lines.map((line, i, lines) => ({
+    words: [
+        {
+            word: line.words[0]?.word ?? "",
+            startTime: line.words[0]?.startTime ?? 0,
+            endTime: lines[i + 1]?.words?.[0]?.startTime ?? Infinity,
+        },
+    ],
+    startTime: line.words[0]?.startTime ?? 0,
+    endTime: lines[i + 1]?.words?.[0]?.startTime ?? Infinity,
+    translatedLyric: "",
+    romanLyric: "",
+    isBG: false,
+    isDuet: false,
+}));
+// 此时就可以将 converted 传给 LyricPlayer 了
+```
+
+推荐使用 TypeScript，这样可以更方便地查错。
+
+## 构建
+
+```shell
+wasm-pack build --target bundler --release --scope applemusic-like-lyrics
+```

package/package.json

@@ -4,18 +4,26 @@
     "SteveXMH <39523898+Steve-xmh@users.noreply.github.com>"
   ],
   "description": "一个歌词解析/生成模块，着重于歌词内容解析，支持多种格式",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "license": "GPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Steve-xmh/applemusic-like-lyrics"
+  },
+  "scripts": {
+    "build": "wasm-pack build --release",
+    "build:dev": "wasm-pack build --dev",
+    "fmt": "cargo fmt"
+  },
   "files": [
-    "lyric_bg.wasm",
-    "lyric.js",
-    "lyric_bg.js",
-    "lyric.d.ts"
+    "pkg/*.wasm",
+    "pkg/*.js",
+    "pkg/*.d.ts"
   ],
-  "module": "lyric.js",
-  "types": "lyric.d.ts",
+  "module": "pkg/lyric.js",
+  "types": "pkg/lyric.d.ts",
   "sideEffects": [
-    "./lyric.js",
-    "./snippets/*"
+    "./pkg/lyric.js",
+    "./pkg/snippets/*"
   ]
 }

package/{lyric.d.ts → pkg/lyric.d.ts}

@@ -10,7 +10,6 @@
 */
 export function set_panic_hook(): void;
 
-
 /**
  * 解析 LyRiC 格式的歌词字符串
  * @param src 歌词字符串
@@ -67,6 +66,20 @@ export function parseLys(src: string): LyricLine[];
  */
 export function stringifyLys(lines: LyricLine[]): string;
 
+/**
+ * 解析 ESLyric 格式的歌词字符串
+ * @param src 歌词字符串
+ * @returns 成功解析出来的歌词
+ */
+export function parseEslrc(src: string): LyricLine[];
+
+/**
+ * 将歌词数组转换为 ESLyric 格式的字符串
+ * @param lines 歌词数组
+ * @returns ESLyric 格式的字符串
+ */
+export function stringifyEslrc(lines: LyricLine[]): string;
+
 /**
  * 将歌词数组转换为 ASS 字幕格式的字符串
  * 
@@ -90,7 +103,7 @@ export interface LyricWord {
     endTime: number;
     /** 单词 */
     word: string;
-};
+}
 
 /**
  * 一行歌词，存储多个单词
@@ -112,7 +125,14 @@ export interface LyricLine {
      * 此选项只有作为 Lyricify Syllable 文件格式导入导出时才有意义
      */
     isDuet?: boolean;
-};
+}
 
+/**
+ * 解密十六进制字符串格式的 Qrc 歌词数据
+ * 解密后可去头尾 XML 数据后通过调用 `parseQrc` 解析歌词行
+ * @param hexData 十六进制格式的字符串，代表被加密的歌词数据
+ * @returns 被解密出来的歌词字符串，是前后有 XML 混合的 QRC 歌词
+ */
+export function decryptQrcHex(hexData: string): string;
 
 

package/{lyric_bg.js → pkg/lyric_bg.js}

@@ -205,14 +205,58 @@ function debugString(val) {
     // TODO we could test for more things here, like `Set`s and `Map`s.
     return className;
 }
+/**
+* @param {any} lrc
+* @returns {string}
+*/
+export function stringifyAss(lrc) {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.stringifyAss(retptr, addHeapObject(lrc));
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        deferred1_0 = r0;
+        deferred1_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+
+/**
+* @param {string} hex_data
+* @returns {string}
+*/
+export function decryptQrcHex(hex_data) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passStringToWasm0(hex_data, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.decryptQrcHex(retptr, ptr0, len0);
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        deferred2_0 = r0;
+        deferred2_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+
 /**
 * @param {string} src
 * @returns {any}
 */
-export function parseLrc(src) {
+export function parseEslrc(src) {
     const ptr0 = passStringToWasm0(src, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.parseLrc(ptr0, len0);
+    const ret = wasm.parseEslrc(ptr0, len0);
     return takeObject(ret);
 }
 
@@ -220,12 +264,12 @@ export function parseLrc(src) {
 * @param {any} lrc
 * @returns {string}
 */
-export function stringifyLrc(lrc) {
+export function stringifyEslrc(lrc) {
     let deferred1_0;
     let deferred1_1;
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.stringifyLrc(retptr, addHeapObject(lrc));
+        wasm.stringifyEslrc(retptr, addHeapObject(lrc));
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         deferred1_0 = r0;
@@ -241,10 +285,10 @@ export function stringifyLrc(lrc) {
 * @param {string} src
 * @returns {any}
 */
-export function parseQrc(src) {
+export function parseLrc(src) {
     const ptr0 = passStringToWasm0(src, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.parseQrc(ptr0, len0);
+    const ret = wasm.parseLrc(ptr0, len0);
     return takeObject(ret);
 }
 
@@ -252,12 +296,12 @@ export function parseQrc(src) {
 * @param {any} lrc
 * @returns {string}
 */
-export function stringifyQrc(lrc) {
+export function stringifyLrc(lrc) {
     let deferred1_0;
     let deferred1_1;
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.stringifyQrc(retptr, addHeapObject(lrc));
+        wasm.stringifyLrc(retptr, addHeapObject(lrc));
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         deferred1_0 = r0;
@@ -269,26 +313,14 @@ export function stringifyQrc(lrc) {
     }
 }
 
-/**
-* 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 set_panic_hook() {
-    wasm.set_panic_hook();
-}
-
 /**
 * @param {string} src
 * @returns {any}
 */
-export function parseYrc(src) {
+export function parseLys(src) {
     const ptr0 = passStringToWasm0(src, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.parseYrc(ptr0, len0);
+    const ret = wasm.parseLys(ptr0, len0);
     return takeObject(ret);
 }
 
@@ -296,12 +328,12 @@ export function parseYrc(src) {
 * @param {any} lrc
 * @returns {string}
 */
-export function stringifyYrc(lrc) {
+export function stringifyLys(lrc) {
     let deferred1_0;
     let deferred1_1;
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.stringifyYrc(retptr, addHeapObject(lrc));
+        wasm.stringifyLys(retptr, addHeapObject(lrc));
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         deferred1_0 = r0;
@@ -317,10 +349,10 @@ export function stringifyYrc(lrc) {
 * @param {string} src
 * @returns {any}
 */
-export function parseLys(src) {
+export function parseQrc(src) {
     const ptr0 = passStringToWasm0(src, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.parseLys(ptr0, len0);
+    const ret = wasm.parseQrc(ptr0, len0);
     return takeObject(ret);
 }
 
@@ -328,12 +360,12 @@ export function parseLys(src) {
 * @param {any} lrc
 * @returns {string}
 */
-export function stringifyLys(lrc) {
+export function stringifyQrc(lrc) {
     let deferred1_0;
     let deferred1_1;
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.stringifyLys(retptr, addHeapObject(lrc));
+        wasm.stringifyQrc(retptr, addHeapObject(lrc));
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         deferred1_0 = r0;
@@ -345,16 +377,39 @@ export function stringifyLys(lrc) {
     }
 }
 
+/**
+* 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 set_panic_hook() {
+    wasm.set_panic_hook();
+}
+
+/**
+* @param {string} src
+* @returns {any}
+*/
+export function parseYrc(src) {
+    const ptr0 = passStringToWasm0(src, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.parseYrc(ptr0, len0);
+    return takeObject(ret);
+}
+
 /**
 * @param {any} lrc
 * @returns {string}
 */
-export function stringifyAss(lrc) {
+export function stringifyYrc(lrc) {
     let deferred1_0;
     let deferred1_1;
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.stringifyAss(retptr, addHeapObject(lrc));
+        wasm.stringifyYrc(retptr, addHeapObject(lrc));
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         deferred1_0 = r0;
@@ -466,6 +521,11 @@ export function __wbindgen_number_get(arg0, arg1) {
     getInt32Memory0()[arg0 / 4 + 0] = !isLikeNone(ret);
 };
 
+export function __wbindgen_as_number(arg0) {
+    const ret = +getObject(arg0);
+    return ret;
+};
+
 export function __wbindgen_number_new(arg0) {
     const ret = arg0;
     return addHeapObject(ret);
@@ -481,12 +541,12 @@ export function __wbindgen_string_new(arg0, arg1) {
     return addHeapObject(ret);
 };
 
-export function __wbg_getwithrefkey_5e6d9547403deab8(arg0, arg1) {
+export function __wbg_getwithrefkey_4a92a5eca60879b9(arg0, arg1) {
     const ret = getObject(arg0)[getObject(arg1)];
     return addHeapObject(ret);
 };
 
-export function __wbg_set_841ac57cff3d672b(arg0, arg1, arg2) {
+export function __wbg_set_9182712abebf82ef(arg0, arg1, arg2) {
     getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
 };
 

package/pkg/lyric_bg.wasm.d.ts

@@ -0,0 +1,21 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export function stringifyAss(a: number, b: number): void;
+export function decryptQrcHex(a: number, b: number, c: number): void;
+export function parseEslrc(a: number, b: number): number;
+export function stringifyEslrc(a: number, b: number): void;
+export function parseLrc(a: number, b: number): number;
+export function stringifyLrc(a: number, b: number): void;
+export function parseLys(a: number, b: number): number;
+export function stringifyLys(a: number, b: number): void;
+export function parseQrc(a: number, b: number): number;
+export function stringifyQrc(a: number, b: number): void;
+export function set_panic_hook(): void;
+export function parseYrc(a: number, b: number): number;
+export function stringifyYrc(a: number, b: number): void;
+export function __wbindgen_malloc(a: number, b: number): number;
+export function __wbindgen_realloc(a: number, b: number, c: number, d: number): number;
+export function __wbindgen_add_to_stack_pointer(a: number): number;
+export function __wbindgen_free(a: number, b: number, c: number): void;
+export function __wbindgen_exn_store(a: number): void;