@bililive-tools/manager 1.3.0 → 1.4.1

package/README.md

@@ -28,7 +28,7 @@ import { provider } from "@bililive-tools/bilibili-recorder";
 
 const manager = createRecorderManager({
   providers: [provider],
-  savePathRule: "D:\\录制\\{platforme}}/{owner}/{year}-{month}-{date} {hour}-{min}-{sec} {title}", // 保存路径，占位符见文档
+  savePathRule: "D:\\录制\\{platforme}}/{owner}/{year}-{month}-{date} {hour}-{min}-{sec} {title}", // 保存路径，占位符见文档，支持 [ejs](https://ejs.co/) 模板引擎
   autoCheckInterval: 1000 * 60, // 自动检查间隔，单位秒
   autoRemoveSystemReservedChars: true, // 移除系统非法字符串
   biliBatchQuery: false, // B站检查使用批量接口

package/lib/FFMPEGRecorder.js

@@ -52,7 +52,7 @@ export class FFMPEGRecorder extends EventEmitter {
     }
     createCommand() {
         this.timeoutChecker?.start();
-        const invalidCount = this.isHls ? 35 : 15;
+        const invalidCount = this.isHls ? 35 : 18;
         const isInvalidStream = createInvalidStreamChecker(invalidCount);
         const inputOptions = [
             ...this.inputOptions,
@@ -117,13 +117,18 @@ export class FFMPEGRecorder extends EventEmitter {
     async stop() {
         this.timeoutChecker.stop();
         try {
-            this.command.kill("SIGINT");
-            // @ts-ignore
-            // this.command.ffmpegProc?.stdin?.write("q");
+            // ts文件使用write("q")需要十来秒进行处理，直接中断，其他格式使用sigint会导致缺少数据
+            if (this.streamManager.videoFilePath.endsWith(".ts")) {
+                this.command.kill("SIGINT");
+            }
+            else {
+                // @ts-ignore
+                this.command.ffmpegProc?.stdin?.write("q");
+            }
             await this.streamManager.handleVideoCompleted();
         }
         catch (err) {
-            this.emit("DebugLog", { type: "common", text: String(err) });
+            this.emit("DebugLog", { type: "error", text: String(err) });
         }
     }
     getExtraDataController() {

package/lib/manager.d.ts

@@ -13,6 +13,7 @@ export interface RecorderProvider<E extends AnyObject> {
         title: string;
         owner: string;
         uid?: number;
+        avatar?: string;
     } | null>;
     createRecorder: (this: RecorderProvider<E>, opts: Omit<RecorderCreateOpts<E>, "providerId">) => Recorder<E>;
     fromJSON: <T extends SerializedRecorder<E>>(this: RecorderProvider<E>, json: T) => Recorder<E>;

package/lib/manager.js

@@ -1,9 +1,10 @@
 import path from "node:path";
 import mitt from "mitt";
+import ejs from "ejs";
 import { omit, range } from "lodash-es";
 import { parseArgsStringToArgv } from "string-argv";
 import { getBiliStatusInfoByRoomIds } from "./api.js";
-import { formatDate, removeSystemReservedChars, formatTemplate, replaceExtName, downloadImage, } from "./utils.js";
+import { formatDate, removeSystemReservedChars, formatTemplate, replaceExtName, downloadImage, isBetweenTimeRange, } from "./utils.js";
 import { StreamManager } from "./streamManager.js";
 const configurableProps = [
     "savePathRule",
@@ -38,7 +39,9 @@ export function createRecorderManager(opts) {
         const maxThreadCount = 3;
         // 这里暂时不打算用 state == recording 来过滤，provider 必须内部自己处理录制过程中的 check，
         // 这样可以防止一些意外调用 checkLiveStatusAndRecord 时出现重复录制。
-        let needCheckRecorders = recorders.filter((r) => !r.disableAutoCheck);
+        let needCheckRecorders = recorders
+            .filter((r) => !r.disableAutoCheck)
+            .filter((r) => isBetweenTimeRange(r.handleTime));
         let threads = [];
         if (manager.biliBatchQuery) {
             const biliNeedCheckRecorders = needCheckRecorders
@@ -271,9 +274,16 @@ export function genSavePathFromRule(manager, recorder, extData) {
     };
     if (manager.autoRemoveSystemReservedChars) {
         for (const key in params) {
-            params[key] = removeSystemReservedChars(String(params[key]));
+            params[key] = removeSystemReservedChars(String(params[key])).trim();
         }
     }
-    return formatTemplate(manager.savePathRule, params);
+    let savePathRule = manager.savePathRule;
+    try {
+        savePathRule = ejs.render(savePathRule, params);
+    }
+    catch (error) {
+        console.error("模板解析错误", error);
+    }
+    return formatTemplate(savePathRule, params);
 }
 export { StreamManager };

package/lib/record_extra_data_controller.js

@@ -14,6 +14,7 @@ export function createRecordExtraDataController(savePath) {
         },
         messages: [],
     };
+    let hasCompleted = false;
     const scheduleSave = asyncThrottle(() => save(), 30e3, {
         immediateRunWhenEndOfDefer: true,
     });
@@ -22,10 +23,14 @@ export function createRecordExtraDataController(savePath) {
     };
     // TODO: 将所有数据存放在内存中可能存在问题
     const addMessage = (comment) => {
+        if (hasCompleted)
+            return;
         data.messages.push(comment);
         scheduleSave();
     };
     const setMeta = (meta) => {
+        if (hasCompleted)
+            return;
         data.meta = {
             ...data.meta,
             ...meta,
@@ -33,13 +38,16 @@ export function createRecordExtraDataController(savePath) {
         scheduleSave();
     };
     const flush = async () => {
-        scheduleSave.flush();
+        if (hasCompleted)
+            return;
+        hasCompleted = true;
         scheduleSave.cancel();
         const xmlContent = convert2Xml(data);
         const parsedPath = path.parse(savePath);
         const xmlPath = path.join(parsedPath.dir, parsedPath.name + ".xml");
         await fs.promises.writeFile(xmlPath, xmlContent);
         await fs.promises.rm(savePath);
+        data.messages = [];
     };
     return {
         data,
@@ -76,6 +84,7 @@ export function convert2Xml(data) {
             "@@weight": String(0),
             "@@user": String(ele.sender?.name),
             "@@uid": String(ele?.sender?.uid),
+            "@@timestamp": String(ele.timestamp),
         };
         data["@@p"] = [
             data["@@progress"],
@@ -88,7 +97,7 @@ export function convert2Xml(data) {
             data["@@uid"],
             data["@@weight"],
         ].join(",");
-        return pick(data, ["@@p", "#text", "@@user", "@@uid"]);
+        return pick(data, ["@@p", "#text", "@@user", "@@uid", "@@timestamp"]);
     });
     const gifts = data.messages
         .filter((item) => item.type === "give_gift")
@@ -101,6 +110,7 @@ export function convert2Xml(data) {
             "@@price": String(ele.price * 1000),
             "@@user": String(ele.sender?.name),
             "@@uid": String(ele?.sender?.uid),
+            "@@timestamp": String(ele.timestamp),
             // "@@raw": JSON.stringify(ele),
         };
         return data;
@@ -115,6 +125,7 @@ export function convert2Xml(data) {
             "#text": String(ele.text),
             "@@user": String(ele.sender?.name),
             "@@uid": String(ele?.sender?.uid),
+            "@@timestamp": String(ele.timestamp),
             // "@@raw": JSON.stringify(ele),
         };
         return data;
@@ -131,6 +142,7 @@ export function convert2Xml(data) {
             "@@level": String(ele.level),
             "@@user": String(ele.sender?.name),
             "@@uid": String(ele?.sender?.uid),
+            "@@timestamp": String(ele.timestamp),
             // "@@raw": JSON.stringify(ele),
         };
         return data;

package/lib/recorder.d.ts

@@ -27,6 +27,8 @@ export interface RecorderCreateOpts<E extends AnyObject = UnknownObject> {
     uid?: number;
     /** 画质匹配重试次数 */
     qualityRetry?: number;
+    /** 抖音是否使用双屏直播流，开启后如果是双屏直播，那么就使用拼接的流，默认为true */
+    doubleScreen?: boolean;
     /** B站是否使用m3u8代理 */
     useM3U8Proxy?: boolean;
     /**B站m3u8代理url */
@@ -43,6 +45,12 @@ export interface RecorderCreateOpts<E extends AnyObject = UnknownObject> {
     videoFormat?: "auto" | "ts" | "mkv";
     /** 流格式优先级 */
     formatriorities?: Array<"flv" | "hls">;
+    /** 只录制音频 */
+    onlyAudio?: boolean;
+    /** 监控时间段 */
+    handleTime?: [string | null, string | null];
+    /** 控制弹幕是否使用服务端时间戳 */
+    useServerTimestamp?: boolean;
     extra?: Partial<E>;
 }
 export type SerializedRecorder<E extends AnyObject> = PickRequired<RecorderCreateOpts<E>, "id">;
@@ -62,7 +70,7 @@ export interface RecordHandle {
     cut: (this: RecordHandle) => Promise<void>;
 }
 export interface DebugLog {
-    type: string | "common" | "ffmpeg";
+    type: string | "common" | "ffmpeg" | "error";
     text: string;
 }
 export type GetSavePath = (data: {

package/lib/streamManager.js

@@ -21,21 +21,21 @@ export class Segment extends EventEmitter {
     async handleSegmentEnd() {
         if (!this.outputVideoFilePath) {
             this.emit("DebugLog", {
-                type: "common",
+                type: "error",
                 text: "Should call onSegmentStart first",
             });
             return;
         }
         try {
             await Promise.all([
-                retry(() => fs.rename(this.rawRecordingVideoPath, this.outputFilePath)),
+                retry(() => fs.rename(this.rawRecordingVideoPath, this.outputFilePath), 10, 2000),
                 this.extraDataController?.flush(),
             ]);
             this.emit("videoFileCompleted", { filename: this.outputFilePath });
         }
         catch (err) {
             this.emit("DebugLog", {
-                type: "common",
+                type: "error",
                 text: "videoFileCompleted error " + String(err),
             });
         }
@@ -53,7 +53,7 @@ export class Segment extends EventEmitter {
             }
             catch (err) {
                 this.emit("DebugLog", {
-                    type: "common",
+                    type: "error",
                     text: "onUpdateLiveInfo error " + String(err),
                 });
             }

package/lib/utils.d.ts

@@ -61,6 +61,7 @@ export declare function sortByKeyOrder<T, K extends keyof T>(objects: T[], order
  * @returns Promise
  */
 export declare function retry<T>(fn: () => Promise<T>, retries?: number, delay?: number): Promise<T>;
+export declare const isBetweenTimeRange: (range: undefined | [] | [string | null, string | null]) => boolean;
 declare const _default: {
     replaceExtName: typeof replaceExtName;
     singleton: typeof singleton;
@@ -79,5 +80,6 @@ declare const _default: {
     uuid: () => `${string}-${string}-${string}-${string}-${string}`;
     sortByKeyOrder: typeof sortByKeyOrder;
     retry: typeof retry;
+    isBetweenTimeRange: (range: undefined | [] | [string | null, string | null]) => boolean;
 };
 export default _default;

package/lib/utils.js

@@ -159,6 +159,10 @@ export function createInvalidStreamChecker(count = 15) {
     let prevFrame = 0;
     let frameUnchangedCount = 0;
     return (ffmpegLogLine) => {
+        // B站某些cdn在直播结束后仍会返回一些数据 https://github.com/renmu123/biliLive-tools/issues/123
+        if (ffmpegLogLine.includes("New subtitle stream with index")) {
+            return true;
+        }
         const streamInfo = ffmpegLogLine.match(/frame=\s*(\d+) fps=.*? q=.*? size=.*? time=.*? bitrate=.*? speed=.*?/);
         if (streamInfo != null) {
             const [, frameText] = streamInfo;
@@ -257,6 +261,49 @@ export async function retry(fn, retries = 3, delay = 1000) {
         return retry(fn, retries - 1, delay);
     }
 }
+export const isBetweenTimeRange = (range) => {
+    if (!range)
+        return true;
+    if (range.length !== 2)
+        return true;
+    if (range[0] === null || range[1] === null)
+        return true;
+    try {
+        const status = isBetweenTime(new Date(), range);
+        return status;
+    }
+    catch (error) {
+        return true;
+    }
+};
+/**
+ * 当前时间是否在两个时间'HH:mm:ss'之间，如果是["22:00:00","05:00:00"]，当前时间是凌晨3点，返回true
+ * @param {string} currentTime 当前时间
+ * @param {string[]} timeRange 时间范围
+ */
+function isBetweenTime(currentTime, timeRange) {
+    const [startTime, endTime] = timeRange;
+    if (!startTime || !endTime)
+        return true;
+    const [startHour, startMinute, startSecond] = startTime.split(":").map(Number);
+    const [endHour, endMinute, endSecond] = endTime.split(":").map(Number);
+    const [currentHour, currentMinute, currentSecond] = [
+        currentTime.getHours(),
+        currentTime.getMinutes(),
+        currentTime.getSeconds(),
+    ];
+    const start = startHour * 3600 + startMinute * 60 + startSecond;
+    let end = endHour * 3600 + endMinute * 60 + endSecond;
+    let current = currentHour * 3600 + currentMinute * 60 + currentSecond;
+    // 如果结束时间小于开始时间，说明跨越了午夜
+    if (end < start) {
+        end += 24 * 3600; // 将结束时间加上24小时
+        if (current < start) {
+            current += 24 * 3600; // 如果当前时间小于开始时间，也加上24小时
+        }
+    }
+    return start <= current && current <= end;
+}
 export default {
     replaceExtName,
     singleton,
@@ -275,4 +322,5 @@ export default {
     uuid,
     sortByKeyOrder,
     retry,
+    isBetweenTimeRange,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bililive-tools/manager",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Batch scheduling recorders",
   "main": "./lib/index.js",
   "type": "module",
@@ -39,7 +39,8 @@
     "string-argv": "^0.3.2",
     "lodash-es": "^4.17.21",
     "axios": "^1.7.8",
-    "fs-extra": "^11.2.0"
+    "fs-extra": "^11.2.0",
+    "ejs": "^3.1.10"
   },
   "scripts": {
     "build": "pnpm run test && tsc",