floating-live 0.8.0

package/README.md

@@ -0,0 +1,62 @@
+# Floating Live
+一个用于处理和保存直播弹幕的Node.js小工具，开箱即用。
+
+目前支持bilibili和AcFun的直播弹幕，不同平台的弹幕会转换为同一种格式便于保存。
+
+项目仍在开发中，功能尚未完善，目前除了记录保存直播弹幕外暂时没有别的用处啦，敬请期待。
+
+注意：当前项目未进入正式版本阶段，程序结构及导出数据结构可能随时改动，**非常不建议用于正式项目中**。
+
+## 使用方法
+### npm安装
+```
+npm install floating-live
+```
+``` javascript
+// 导入FloatingLive
+const FloatingLive = require("floating-live")
+// 导入bilibili房间生成插件
+const bilibili = require("floating-live/plugin/bilibili")   
+
+// 创建一个FloatingLive实例
+const live = new FloatingLive()
+// 注册插件
+live.registerPlugin("bilibili", bilibili)
+// 添加房间
+live.controller.addRoom({platform: "bilibili", id: 6})
+// 打开
+live.controller.start()
+```
+
+### 拆包即用模式
+* 下载并安装 `Node.js` ，建议下载最新LTS版本（如果已经安装可跳过这一步）。
+* 下载该项目的zip压缩包，解压，并在项目根目录下新建一个名为 `save` 的文件夹。
+* 在项目根目录的控制台输入下列命令，安装所有依赖包。
+  ```
+  npm install
+  ```
+#### 运行Demo文件
+* 打开demo/demo.ts
+  ``` typescript
+  // ...
+  const config = {
+    rooms: [
+      {
+        platform: "bilibili", // 直播平台
+        id: 2064239,          // 直播间号
+      },
+    ],
+  };
+  // ...
+  ```
+* 根据需要修改直播平台和直播间号，目前支持的 `platform` 值有：`acfun`、`bilibili`(注意是小写)，也可以通过自定义插件添加直播平台
+* 在项目根目录的控制台输入下列命令：
+  ```
+  npm run test
+  ```
+  即可接收来自平台的直播弹幕。
+
+## 感谢
+### 开源库
+* [simon300000/bilibili-live-ws](https://github.com/simon300000/bilibili-live-ws/)：与bilibili直播建立Websocket连接并解码数据包
+* [ACFUN-FOSS/ac-danmu](https://github.com/ACFUN-FOSS/ac-danmu.js)：与AcFun直播建立Websocket连接并解码数据包

package/index.d.ts

@@ -0,0 +1,2 @@
+import FloatingLiving from "./src";
+export = FloatingLiving;

package/index.js

@@ -0,0 +1,6 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const src_1 = __importDefault(require("./src"));
+module.exports = src_1.default;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "floating-live",
+  "version": "0.8.0",
+  "type": "commonjs",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "author": "Minteea",
+  "license": "GPLv3",
+  "scripts": {
+    "tsc": "tsc -b",
+    "clear": "rimraf index.js index.d.ts src/**/*.js src/**/*.d.ts plugin/**/*.js plugin/**/*.d.ts",
+    "test": "npm run clear && ts-node demo/demo.ts",
+    "build-test": "npm run build && node demo/demo.js",
+    "build": "npm run clear && npm run tsc",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "acfun-live-danmaku": "^0.6.1",
+    "axios": "^0.26.0",
+    "bilibili-live-ws": "^6.0.3"
+  },
+  "devDependencies": {
+    "@types/websocket": "^1.0.5",
+    "@types/ws": "^8.5.3",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
+  }
+}

package/plugin/acfun/acfunLive.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="node" />
+import { MedalInfo, UserInfo } from "../../src/types/message/AttributeInfo";
+import LiveRoom from "../../src/types/room/LiveRoom";
+import AcClient from "acfun-live-danmaku/client";
+import { EventEmitter } from "events";
+import { LiveInfo } from "../../src/types/room/LiveInfo";
+declare class acfunLive extends EventEmitter implements LiveRoom {
+    /** 平台id */
+    readonly platform: string;
+    /** 房间id */
+    readonly id: number;
+    /** 直播信息 */
+    live: LiveInfo;
+    /** 主播信息 */
+    anchor: UserInfo;
+    /** 直播间弹幕api模块 */
+    client: AcClient | null;
+    /** 是否为打开状态 */
+    opening: boolean;
+    private wsInit;
+    /** 直播间是否可用 */
+    get available(): boolean;
+    constructor(id: number, open?: boolean);
+    getInfo(): Promise<void>;
+    /** 开启直播间监听 */
+    open(): Promise<void>;
+    /** 初始化直播服务端监听 */
+    private initWS;
+    close(): void;
+    destory(): void;
+    /** 根据守护徽章字符串获取粉丝牌信息 */
+    getMedal(badge: string): MedalInfo | null;
+    /** 文本信息(Comment) */
+    msg_Comment(data: {
+        sendTimeMs: string;
+        userInfo: {
+            userIdentity: any;
+            badge: string;
+            nickname: any;
+            userId: string;
+        };
+        content: any;
+    }): void;
+    /** 礼物信息(Gift) */
+    msg_Gift(data: {
+        sendTimeMs: string;
+        user: {
+            userIdentity: any;
+            badge: string;
+            nickname: any;
+            userId: string;
+        };
+        giftName: any;
+        giftId: string;
+        count: any;
+        value: string;
+    }): void;
+    /** 互动信息 */
+    msg_Interact(data: {
+        sendTimeMs: string;
+        userInfo: {
+            userIdentity: any;
+            badge: string;
+            nickname: any;
+            userId: string;
+        };
+    }, type: "entry" | "like" | "follow" | "share" | "join"): void;
+    msg_LiveClosed(): void;
+    msg_LiveBanned(): void;
+    msg_DisplayInfo(data: any): void;
+    emitMsg(data: any): void;
+    emitOrigin(data: any): void;
+}
+export default acfunLive;

package/plugin/acfun/acfunLive.js

@@ -0,0 +1,236 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const acfun_live_danmaku_1 = __importDefault(require("acfun-live-danmaku"));
+const events_1 = require("events");
+const axios_1 = __importDefault(require("axios"));
+class acfunLive extends events_1.EventEmitter {
+    constructor(id, open = false) {
+        super();
+        /** 平台id */
+        this.platform = "acfun";
+        /** 直播信息 */
+        this.live = {
+            /** 直播标题 */
+            title: "",
+            /** 分区 */
+            area: [],
+            /** 封面 */
+            cover: "",
+            /** 直播状态 */
+            status: "off",
+            /** 开始直播时间 */
+            start_time: 0
+        };
+        /** 主播信息 */
+        this.anchor = { name: "", id: 0 };
+        /** 直播间弹幕api模块 */
+        this.client = null;
+        /** 是否为打开状态 */
+        this.opening = false;
+        this.wsInit = false;
+        this.platform = "acfun";
+        this.id = id; // 直播间号
+        this.anchor.id = id; // 主播uid
+        this.getInfo().then(() => {
+            if (open)
+                this.open();
+        });
+        console.log("连接直播间");
+    }
+    /** 直播间是否可用 */
+    get available() {
+        return Boolean(this.client);
+    }
+    ;
+    async getInfo() {
+        if (!this.client) {
+            this.client = await (0, acfun_live_danmaku_1.default)(this.id) || null;
+            if (this.client) {
+                this.live.status = "live";
+                this.live.start_time = this.client.liveStartTime;
+                this.live.title = this.client.caption; // bug
+                this.live.cover = `https://tx2.a.kwimgs.com/bs2/ztlc/cover_${this.client.liveId}_raw.jpg`;
+            }
+            await axios_1.default
+                .get(`https://live.acfun.cn/rest/pc-direct/user/userInfo?userId=${this.id}`)
+                .then((res) => {
+                let profile = res.data.profile;
+                this.anchor.avatar = profile.headUrl;
+                this.anchor.name = profile.name;
+            })
+                .catch((error) => {
+                console.error(error);
+            });
+            this.emit("info");
+        }
+        // 暂不能在连接房间后更新信息
+    }
+    /** 开启直播间监听 */
+    async open() {
+        if (this.opening || !this.available)
+            return;
+        if (!this.wsInit) {
+            this.initWS();
+        }
+        //启动websocket连接
+        this.opening = true;
+        this.client.wsStart();
+        this.emit("open");
+    }
+    /** 初始化直播服务端监听 */
+    async initWS() {
+        if (!this.client)
+            return;
+        let client = this.client;
+        client.on("EnterRoomAck", () => {
+            console.log("[acfun-live-danmaku] 已连接AcFun直播间");
+            this.live.status = "live";
+        });
+        client.on("RecentComment", (comments) => {
+            //当前弹幕列表
+        });
+        client.on("Comment", (danmaku) => {
+            //收到的弹幕
+            this.msg_Comment(danmaku);
+        });
+        client.on("Gift", (gift) => { this.msg_Gift(gift); });
+        client.on("UserEnterRoom", (entry) => { this.msg_Interact(entry, "entry"); });
+        client.on("Like", (like) => { this.msg_Interact(like, "like"); });
+        client.on("JoinClub", (join) => { this.msg_Interact(join, "join"); });
+        client.on("DisplayInfo", (info) => { this.msg_DisplayInfo(info); });
+        client.on("LiveClosed", (end) => { this.msg_LiveClosed(); });
+        client.on("LiveBanned", (end) => { this.msg_LiveBanned(); });
+        this.wsInit = true;
+    }
+    close() {
+        if (!this.opening)
+            return;
+        this.opening = false;
+        this.client?.wsClose();
+        this.emit("close");
+    }
+    destory() {
+        this.close();
+        this.removeAllListeners();
+    }
+    ;
+    /** 根据守护徽章字符串获取粉丝牌信息 */
+    getMedal(badge) {
+        if (badge) {
+            let medalInfo = JSON.parse(badge).medalInfo;
+            return {
+                name: medalInfo.clubName,
+                id: medalInfo.uperId,
+                level: medalInfo.level,
+            };
+        }
+        else {
+            return null;
+        }
+    }
+    /** 文本信息(Comment) */
+    msg_Comment(data) {
+        let danmaku = {
+            platform: "acfun",
+            room: this.id,
+            local_timestamp: new Date().valueOf(),
+            type: "text",
+            info: {
+                text: data.content,
+                user: {
+                    name: data.userInfo.nickname,
+                    id: parseInt(data.userInfo.userId),
+                    medal: this.getMedal(data.userInfo.badge),
+                },
+                timestamp: parseInt(data.sendTimeMs),
+            },
+        };
+        this.emitMsg(danmaku);
+    }
+    /** 礼物信息(Gift) */
+    msg_Gift(data) {
+        let gift = {
+            platform: "acfun",
+            room: this.id,
+            type: "gift",
+            local_timestamp: new Date().valueOf(),
+            info: {
+                user: {
+                    name: data.user.nickname,
+                    id: parseInt(data.user.userId),
+                    medal: this.getMedal(data.user.badge),
+                },
+                gift: {
+                    name: data.giftName,
+                    id: parseInt(data.giftId),
+                    num: data.count,
+                    currency: "coin",
+                    value: parseInt(data.value), // 总价值
+                },
+                timestamp: parseInt(data.sendTimeMs),
+            },
+        };
+        this.emitMsg(gift);
+    }
+    /** 互动信息 */
+    msg_Interact(data, type) {
+        let like = {
+            platform: "acfun",
+            room: this.id,
+            type: type,
+            local_timestamp: new Date().valueOf(),
+            info: {
+                user: {
+                    name: data.userInfo.nickname,
+                    id: parseInt(data.userInfo.userId),
+                    medal: this.getMedal(data.userInfo.badge),
+                },
+                timestamp: parseInt(data.sendTimeMs),
+            },
+        };
+        this.emitMsg(like);
+    }
+    msg_LiveClosed() {
+        let off = {
+            platform: "acfun",
+            room: this.id,
+            type: "live_end",
+            local_timestamp: new Date().valueOf(),
+            info: {
+                status: "off"
+            }
+        };
+        this.live.status = "off";
+        this.client = null;
+        this.emitMsg(off);
+    }
+    msg_LiveBanned() {
+        let cut = {
+            platform: "acfun",
+            room: this.id,
+            type: "live_cut",
+            local_timestamp: new Date().valueOf(),
+            info: {
+                message: ""
+            }
+        };
+        this.live.status = "off";
+        this.client = null;
+        this.emitMsg(cut);
+    }
+    msg_DisplayInfo(data) {
+        // this.toData(msg)
+    }
+    emitMsg(data) {
+        // 一般消息
+        this.emit("msg", data);
+    }
+    emitOrigin(data) {
+        // 源消息
+        this.emit("origin", data);
+    }
+}
+exports.default = acfunLive;

package/plugin/acfun/index.d.ts

@@ -0,0 +1,3 @@
+import FloatingLive from "../../src/index";
+declare const _default: (ctx: FloatingLive) => void;
+export = _default;

package/plugin/acfun/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const acfunLive_1 = __importDefault(require("./acfunLive"));
+module.exports = (ctx) => {
+    ctx.helper.roomGenerator.register("acfun", (id, open) => {
+        let key = `acfun:${Number(id)}`;
+        let room = new acfunLive_1.default(Number(id), open);
+        return { key, room };
+    });
+};

package/plugin/bilibili/bilibiliLive.d.ts

@@ -0,0 +1,58 @@
+/// <reference types="node" />
+import { UserInfo } from "../../src/types/message/AttributeInfo";
+import { KeepLiveWS } from "bilibili-live-ws";
+import { EventEmitter } from "events";
+import LiveRoom from "../../src/types/room/LiveRoom";
+import { LiveInfo } from "../../src/types/room/LiveInfo";
+declare class bilibiliLive extends EventEmitter implements LiveRoom {
+    /** 平台id */
+    readonly platform: string;
+    /** 直播间号 */
+    readonly id: number;
+    /** 直播间room_id */
+    roomid: number;
+    /** 直播信息 */
+    live: LiveInfo;
+    cover: string;
+    /** 主播信息 */
+    anchor: UserInfo;
+    /** 直播间是否可用 */
+    available: boolean;
+    /** 直播间弹幕api模块 */
+    client: KeepLiveWS | null;
+    /** 是否为持续监听状态 */
+    opening: boolean;
+    /** 断线重连间隔 */
+    connectInterval: number;
+    constructor(id: number, // 房间id
+    open?: boolean, // 生成房间后是否打开
+    config?: {
+        connectInterval: number;
+    });
+    /** 获取房间信息 */
+    getInfo(): Promise<void>;
+    /** 开启直播间监听 */
+    open(): Promise<void>;
+    /** 连接直播服务端 */
+    createWS(): Promise<void>;
+    close(): void;
+    destory(): void;
+    emitMsg(data: any): void;
+    emitOrigin(data: any): void;
+    getDanmakuMode(n: number): string;
+    /** 获取弹幕消息 */
+    msg_DANMU_MSG(msg: any): void;
+    /** 获取互动消息 */
+    msg_INTERACT_WORD(msg: any): void;
+    /** 获取礼物消息 */
+    msg_SEND_GIFT(msg: any): void;
+    /** 获取舰长开通消息 */
+    msg_GUARD_BUY(msg: any): void;
+    /** 获取醒目留言消息 */
+    msg_SUPER_CHAT_MESSAGE(msg: any): void;
+    msg_ROOM_BLOCK_MSG(msg: any): void;
+    msg_LIVE(msg: any): void;
+    msg_CUT_OFF(msg: any): void;
+    msg_PREPARING(msg: any): void;
+}
+export default bilibiliLive;