@bililive-tools/douyu-recorder 1.0.1 → 1.1.0

package/README.md

@@ -6,6 +6,8 @@
 
 # 安装
 
+**建议所有录制器和manager包都升级到最新版，我不会对兼容性做过多考虑**
+
 `npm i @bililive-tools/douyu-recorder @bililive-tools/manager`
 
 # 使用
@@ -33,11 +35,12 @@ manager.startCheckLoop();
 interface Options {
   channelId: string; // 直播间ID，具体解析见文档，也可自行解析
   quality: number; // 见画质参数
-  qualityRetry?: number; // 画质匹配重试次数
+  qualityRetry?: number; // 画质匹配重试次数, -1为强制匹配画质，0为自动配置，正整数为最大匹配次数
   streamPriorities: []; // 废弃
   sourcePriorities: []; // 废弃
   disableAutoCheck?: boolean; // 为 true 时 manager 将跳过自动检查
-  segment?: number; // 分段参数
+  segment?: number; // 分段参数，单位分钟
+  titleKeywords?: string; // 禁止录制的标题关键字，英文逗号分开多个
   disableProvideCommentsWhenRecording?: boolean; // 禁用弹幕录制
   saveGiftDanma?: boolean; // 保存礼物弹幕
   saveSCDanma?: boolean; // 保存高能弹幕
@@ -64,7 +67,7 @@ interface Options {
 ```ts
 import { provider } from "@bililive-tools/douyu-recorder";
 
-const url = "https://live.bilibili.com/5055636";
+const url = "https://www.douyu.com/2140934";
 const { id } = await provider.resolveChannelInfoFromURL(url);
 ```
 

package/lib/dy_api.js

@@ -1,6 +1,6 @@
 import crypto from "node:crypto";
-import { v4 as uuid4 } from "uuid";
 import safeEval from "safe-eval";
+import { uuid } from "./utils.js";
 import queryString from "query-string";
 import { requester } from "./requester.js";
 /**
@@ -8,7 +8,7 @@ import { requester } from "./requester.js";
  */
 export async function getLiveInfo(opts) {
     const sign = await getSignFn(opts.channelId, opts.rejectSignFnCache);
-    const did = uuid4().replace(/-/g, "");
+    const did = uuid().replace(/-/g, "");
     const time = Math.ceil(Date.now() / 1000);
     const signedStr = String(sign(opts.channelId, did, time));
     // TODO: 这里类型处理的有点问题，先用 as 顶着

package/lib/dy_client/index.d.ts

@@ -43,6 +43,20 @@ interface Message$Gift {
     bnn: string;
     gfn: string;
 }
+interface Message$ODFBC {
+    type: "odfbc";
+    uid: string;
+    rid: string;
+    nick: string;
+    price: string;
+}
+interface Message$RNDFBC {
+    type: "rndfbc";
+    uid: string;
+    rid: string;
+    nick: string;
+    price: string;
+}
 interface Message$CommChatPandora {
     type: "comm_chatmsg";
     rid: string;
@@ -97,7 +111,7 @@ interface Message$CommChatVoiceDanmu {
     };
 }
 type Message$CommChat = Message$CommChatPandora | Message$CommChatVoiceDanmu;
-export type Message = Message$Chat | Message$Gift | Message$CommChat;
+export type Message = Message$Chat | Message$Gift | Message$CommChat | Message$ODFBC | Message$RNDFBC;
 export interface DYClient extends Emitter<{
     message: Message;
     error: unknown;

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-import { RecorderProvider } from "@bililive-tools/manager";
+import type { RecorderProvider } from "@bililive-tools/manager";
 export declare const provider: RecorderProvider<Record<string, unknown>>;

package/lib/index.js

@@ -1,8 +1,8 @@
 import mitt from "mitt";
-import { createFFMPEGBuilder, defaultFromJSON, defaultToJSON, genRecorderUUID, genRecordUUID, StreamManager, utils, } from "@bililive-tools/manager";
+import { defaultFromJSON, defaultToJSON, genRecorderUUID, genRecordUUID, utils, FFMPEGRecorder, } from "@bililive-tools/manager";
 import { getInfo, getStream } from "./stream.js";
 import { getRoomInfo } from "./dy_api.js";
-import { assert, ensureFolderExist } from "./utils.js";
+import { ensureFolderExist } from "./utils.js";
 import { createDYClient } from "./dy_client/index.js";
 import { giftMap, colorTab } from "./danma.js";
 import { requester } from "./requester.js";
@@ -62,12 +62,53 @@ const ffmpegOutputOptions = [
     "-min_frag_duration",
     "60000000",
 ];
-const checkLiveStatusAndRecord = async function ({ getSavePath, qualityRetry, banLiveId, }) {
-    if (this.recordHandle != null)
+const checkLiveStatusAndRecord = async function ({ getSavePath, banLiveId, isManualStart, }) {
+    // 如果已经在录制中，只在需要检查标题关键词时才获取最新信息
+    if (this.recordHandle != null) {
+        // 只有当设置了标题关键词时，并且不是手动启动的录制，才获取最新的直播间信息
+        if (!isManualStart &&
+            this.titleKeywords &&
+            typeof this.titleKeywords === "string" &&
+            this.titleKeywords.trim()) {
+            const now = Date.now();
+            // 每5分钟检查一次标题变化
+            const titleCheckInterval = 5 * 60 * 1000; // 5分钟
+            // 获取上次检查时间
+            const lastCheckTime = typeof this.extra.lastTitleCheckTime === "number" ? this.extra.lastTitleCheckTime : 0;
+            // 如果距离上次检查时间不足指定间隔，则跳过检查
+            if (now - lastCheckTime < titleCheckInterval) {
+                return this.recordHandle;
+            }
+            // 更新检查时间
+            this.extra.lastTitleCheckTime = now;
+            // 获取直播间信息
+            const liveInfo = await getInfo(this.channelId);
+            const { title } = liveInfo;
+            // 检查标题是否包含关键词
+            const keywords = this.titleKeywords
+                .split(",")
+                .map((k) => k.trim())
+                .filter((k) => k);
+            const hasTitleKeyword = keywords.some((keyword) => title.toLowerCase().includes(keyword.toLowerCase()));
+            if (hasTitleKeyword) {
+                this.emit("DebugLog", {
+                    type: "common",
+                    text: `检测到标题包含关键词，停止录制：直播间标题 "${title}" 包含关键词 "${this.titleKeywords}"`,
+                });
+                // 停止录制
+                await this.recordHandle.stop("直播间标题包含关键词");
+                // 返回 null，停止录制
+                return null;
+            }
+        }
+        // 已经在录制中，直接返回
         return this.recordHandle;
+    }
+    // 获取直播间信息
     const liveInfo = await getInfo(this.channelId);
+    const { living, owner, title, liveId } = liveInfo;
     this.liveInfo = liveInfo;
-    const { living, owner, title, cover } = liveInfo;
+    this.emit("LiveStart", { liveId });
     if (liveInfo.liveId === banLiveId) {
         this.tempStopIntervalCheck = true;
     }
@@ -78,13 +119,37 @@ const checkLiveStatusAndRecord = async function ({ getSavePath, qualityRetry, ba
         return null;
     if (!living)
         return null;
-    this.state = "recording";
+    // 检查标题是否包含关键词，如果包含则不自动录制
+    // 手动开始录制时不检查标题关键词
+    if (!isManualStart &&
+        this.titleKeywords &&
+        typeof this.titleKeywords === "string" &&
+        this.titleKeywords.trim()) {
+        const keywords = this.titleKeywords
+            .split(",")
+            .map((k) => k.trim())
+            .filter((k) => k);
+        const hasTitleKeyword = keywords.some((keyword) => title.toLowerCase().includes(keyword.toLowerCase()));
+        if (hasTitleKeyword) {
+            this.emit("DebugLog", {
+                type: "common",
+                text: `跳过录制：直播间标题 "${title}" 包含关键词 "${this.titleKeywords}"`,
+            });
+            return null;
+        }
+    }
     let res;
     // TODO: 先不做什么错误处理，就简单包一下预期上会有错误的地方
     try {
-        let strictQuality = !!this.qualityRetry;
-        if (qualityRetry !== undefined) {
-            strictQuality = !!qualityRetry;
+        let strictQuality = false;
+        if (this.qualityRetry > 0) {
+            strictQuality = true;
+        }
+        if (this.qualityMaxRetry < 0) {
+            strictQuality = true;
+        }
+        if (isManualStart) {
+            strictQuality = false;
         }
         res = await getStream({
             channelId: this.channelId,
@@ -97,14 +162,35 @@ const checkLiveStatusAndRecord = async function ({ getSavePath, qualityRetry, ba
         this.qualityRetry -= 1;
         throw err;
     }
+    this.state = "recording";
     const { currentStream: stream, sources: availableSources, streams: availableStreams } = res;
     this.availableStreams = availableStreams.map((s) => s.name);
     this.availableSources = availableSources.map((s) => s.name);
     this.usedStream = stream.name;
     this.usedSource = stream.source;
-    // TODO: emit update event
-    const savePath = getSavePath({ owner, title });
-    const hasSegment = !!this.segment;
+    const onEnd = (...args) => {
+        if (isEnded)
+            return;
+        isEnded = true;
+        this.emit("DebugLog", {
+            type: "common",
+            text: `ffmpeg end, reason: ${JSON.stringify(args, (_, v) => (v instanceof Error ? v.stack : v))}`,
+        });
+        const reason = args[0] instanceof Error ? args[0].message : String(args[0]);
+        this.recordHandle?.stop(reason);
+    };
+    let isEnded = false;
+    const recorder = new FFMPEGRecorder({
+        url: stream.url,
+        outputOptions: ffmpegOutputOptions,
+        segment: this.segment ?? 0,
+        getSavePath: (opts) => getSavePath({ owner, title, startTime: opts.startTime }),
+        disableDanma: this.disableProvideCommentsWhenRecording,
+    }, onEnd);
+    const savePath = getSavePath({
+        owner,
+        title,
+    });
     try {
         ensureFolderExist(savePath);
     }
@@ -112,25 +198,36 @@ const checkLiveStatusAndRecord = async function ({ getSavePath, qualityRetry, ba
         this.state = "idle";
         throw err;
     }
-    const streamManager = new StreamManager(this, getSavePath, owner, title, savePath, hasSegment);
     const handleVideoCreated = async ({ filename }) => {
-        const extraDataController = streamManager?.getExtraDataController();
+        this.emit("videoFileCreated", { filename });
+        const extraDataController = recorder.getExtraDataController();
         extraDataController?.setMeta({
             room_id: this.channelId,
             platform: provider?.id,
             liveStartTimestamp: liveInfo.startTime?.getTime(),
+            recordStopTimestamp: Date.now(),
+            title: title,
+            user_name: owner,
         });
-        if (this.saveCover) {
-            const coverPath = utils.replaceExtName(filename, ".jpg");
-            utils.downloadImage(cover, coverPath);
-        }
     };
-    this.on("videoFileCreated", handleVideoCreated);
+    recorder.on("videoFileCreated", handleVideoCreated);
+    recorder.on("videoFileCompleted", ({ filename }) => {
+        this.emit("videoFileCompleted", { filename });
+    });
+    recorder.on("DebugLog", (data) => {
+        this.emit("DebugLog", data);
+    });
+    recorder.on("progress", (progress) => {
+        if (this.recordHandle) {
+            this.recordHandle.progress = progress;
+        }
+        this.emit("progress", progress);
+    });
     const client = createDYClient(Number(this.channelId), {
         notAutoStart: true,
     });
     client.on("message", (msg) => {
-        const extraDataController = streamManager.getExtraDataController();
+        const extraDataController = recorder.getExtraDataController();
         if (!extraDataController)
             return;
         switch (msg.type) {
@@ -178,7 +275,60 @@ const checkLiveStatusAndRecord = async function ({ getSavePath, qualityRetry, ba
                 this.emit("Message", gift);
                 extraDataController.addMessage(gift);
                 break;
-                // TODO: 还有一些其他礼物相关的 msg 要处理，目前先简单点只处理 dgb
+            }
+            // 开通钻粉
+            case "odfbc": {
+                if (this.saveGiftDanma === false)
+                    return;
+                const gift = {
+                    type: "give_gift",
+                    timestamp: Date.now(),
+                    name: "钻粉",
+                    price: Number(msg.price) / 100,
+                    count: 1,
+                    color: "#ffffff",
+                    sender: {
+                        uid: msg.uid,
+                        name: msg.nick,
+                        // avatar: msg.ic,
+                        // extra: {
+                        //   level: msg.level,
+                        // },
+                    },
+                    // extra: {
+                    //   hits: Number(msg.hits),
+                    // },
+                };
+                this.emit("Message", gift);
+                extraDataController.addMessage(gift);
+                break;
+            }
+            // 续费钻粉
+            case "rndfbc": {
+                if (this.saveGiftDanma === false)
+                    return;
+                const gift = {
+                    type: "give_gift",
+                    timestamp: Date.now(),
+                    name: "钻粉",
+                    price: Number(msg.price) / 100,
+                    count: 1,
+                    color: "#ffffff",
+                    sender: {
+                        uid: msg.uid,
+                        name: msg.nick,
+                        // avatar: msg.ic,
+                        // extra: {
+                        //   level: msg.level,
+                        // },
+                    },
+                    // extra: {
+                    //   hits: Number(msg.hits),
+                    // },
+                };
+                this.emit("Message", gift);
+                extraDataController.addMessage(gift);
+                break;
             }
             case "comm_chatmsg": {
                 if (this.saveSCDanma === false)
@@ -215,70 +365,26 @@ const checkLiveStatusAndRecord = async function ({ getSavePath, qualityRetry, ba
     if (!this.disableProvideCommentsWhenRecording) {
         client.start();
     }
-    let isEnded = false;
-    const onEnd = async (...args) => {
-        if (isEnded)
-            return;
-        isEnded = true;
-        this.emit("DebugLog", {
-            type: "common",
-            text: `ffmpeg end, reason: ${JSON.stringify(args, (_, v) => (v instanceof Error ? v.stack : v))}`,
-        });
-        const reason = args[0] instanceof Error ? args[0].message : String(args[0]);
-        this.recordHandle?.stop(reason);
-    };
-    const isInvalidStream = utils.createInvalidStreamChecker();
-    const timeoutChecker = utils.createTimeoutChecker(() => onEnd("ffmpeg timeout"), 10e3);
-    const command = createFFMPEGBuilder(stream.url)
-        .inputOptions("-user_agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36")
-        .outputOptions(ffmpegOutputOptions)
-        .output(streamManager.videoFilePath)
-        .on("start", () => {
-        streamManager.handleVideoStarted();
-    })
-        .on("error", onEnd)
-        .on("end", () => onEnd("finished"))
-        .on("stderr", async (stderrLine) => {
-        assert(typeof stderrLine === "string");
-        if (utils.isFfmpegStartSegment(stderrLine)) {
-            await streamManager.handleVideoStarted(stderrLine);
-        }
-        // TODO:解析时间
-        this.emit("DebugLog", { type: "ffmpeg", text: stderrLine });
-        if (isInvalidStream(stderrLine)) {
-            onEnd("invalid stream");
-        }
-    })
-        .on("stderr", timeoutChecker.update);
-    if (hasSegment) {
-        command.outputOptions("-f", "segment", "-segment_time", String(this.segment * 60), "-reset_timestamps", "1");
-    }
-    const ffmpegArgs = command._getArguments();
-    command.run();
+    const ffmpegArgs = recorder.getArguments();
+    recorder.run();
     // TODO: 需要一个机制防止空录制，比如检查文件的大小变化、ffmpeg 的输出、直播状态等
     const stop = utils.singleton(async (reason) => {
         if (!this.recordHandle)
             return;
         this.state = "stopping-record";
-        // TODO: emit update event
-        timeoutChecker.stop();
+        client.stop();
         try {
-            // @ts-ignore
-            command.ffmpegProc?.stdin?.write("q");
-            // TODO: 这里可能会有内存泄露，因为事件还没清，之后再检查下看看。
-            client.stop();
+            await recorder.stop();
         }
         catch (err) {
-            // TODO: 这个 stop 经常报错，这里先把错误吞掉，以后再处理。
-            this.emit("DebugLog", { type: "common", text: String(err) });
+            this.emit("DebugLog", {
+                type: "common",
+                text: `stop ffmpeg error: ${String(err)}`,
+            });
         }
         this.usedStream = undefined;
         this.usedSource = undefined;
-        // TODO: other codes
-        // TODO: emit update event
-        await streamManager.handleVideoCompleted();
         this.emit("RecordStop", { recordHandle: this.recordHandle, reason });
-        this.off("videoFileCreated", handleVideoCreated);
         this.recordHandle = undefined;
         this.liveInfo = undefined;
         this.state = "idle";

package/lib/utils.d.ts

@@ -17,3 +17,5 @@
 export declare function getValuesFromArrayLikeFlexSpaceBetween<T>(array: T[], columnCount: number): T[];
 export declare function ensureFolderExist(fileOrFolderPath: string): void;
 export declare function assert(assertion: unknown, msg?: string): asserts assertion;
+export declare const uuid: () => `${string}-${string}-${string}-${string}-${string}`;
+export declare function createInvalidStreamChecker(): (ffmpegLogLine: string) => boolean;

package/lib/utils.js

@@ -1,5 +1,6 @@
 import fs from "node:fs";
 import path from "node:path";
+import crypto from "node:crypto";
 import { range } from "lodash-es";
 /**
  * 从数组中按照特定算法提取一些值（允许同个索引重复提取）。
@@ -50,3 +51,31 @@ export function assert(assertion, msg) {
         throw new Error(msg);
     }
 }
+export const uuid = () => {
+    return crypto.randomUUID();
+};
+export function createInvalidStreamChecker() {
+    let prevFrame = 0;
+    let frameUnchangedCount = 0;
+    return (ffmpegLogLine) => {
+        const streamInfo = ffmpegLogLine.match(/frame=\s*(\d+) fps=.*? q=.*? size=.*? time=.*? bitrate=.*? speed=.*?/);
+        if (streamInfo != null) {
+            const [, frameText] = streamInfo;
+            const frame = Number(frameText);
+            if (frame === prevFrame) {
+                if (++frameUnchangedCount >= 15) {
+                    return true;
+                }
+            }
+            else {
+                prevFrame = frame;
+                frameUnchangedCount = 0;
+            }
+            return false;
+        }
+        if (ffmpegLogLine.includes("HTTP error 404 Not Found")) {
+            return true;
+        }
+        return false;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bililive-tools/douyu-recorder",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "bililive-tools douyu recorder implemention",
   "main": "./lib/index.js",
   "type": "module",
@@ -41,14 +41,11 @@
     "lodash-es": "^4.17.21",
     "axios": "^1.7.8",
     "douyu-api": "^0.1.0",
-    "@bililive-tools/manager": "1.0.1"
+    "@bililive-tools/manager": "^1.1.0"
   },
   "devDependencies": {
     "@types/ws": "^8.5.13"
   },
-  "peerDependencies": {
-    "@bililive-tools/manager": "*"
-  },
   "optionalDependencies": {
     "bufferutil": "^4.0.8",
     "utf-8-validate": "^6.0.5"