@dan-uni/dan-any 0.7.8 → 0.8.5

package/src/index.ts

@@ -2,7 +2,7 @@ import 'reflect-metadata/lite'
 
 import { XMLBuilder, XMLParser } from 'fast-xml-parser'
 import JSONbig from 'json-bigint'
-import type { Options as AssGenOptions } from './ass-gen'
+import type { Options as AssGenOptions, CanvasCtx } from './ass-gen'
 import type { CommandDm as DM_JSON_BiliCommandGrpc } from './proto/gen/bili/dm_pb'
 
 import { create, fromBinary, toBinary } from '@bufbuild/protobuf'
@@ -12,6 +12,7 @@ import {
   timestampNow,
 } from '@bufbuild/protobuf/wkt'
 
+import pkg from '../package.json'
 import { generateASS, parseAssRawField } from './ass-gen'
 import {
   // DanmakuElem as DM_JSON_BiliGrpc,
@@ -31,6 +32,17 @@ const JSON = JSONbig({
   useNativeBigInt: true,
 })
 
+const DanUniConvertTipTemplate: DanUniConvertTip = {
+  meassage: 'Converted by DanUni!',
+  version: `JS/TS ${pkg.name} (v${pkg.version})`,
+}
+
+interface DanUniConvertTip {
+  meassage: string
+  version: string
+  data?: string
+}
+
 export interface DM_XML_Bili {
   i: {
     chatserver: string
@@ -54,12 +66,14 @@ export interface DM_JSON_Dplayer {
   data: [number, number, number, string, string][]
 }
 export interface DM_JSON_Artplayer {
-  text: string // 弹幕文本
-  time?: number // 弹幕时间，默认为当前播放器时间
-  mode?: number // 弹幕模式：0: 滚动 (默认)，1: 顶部，2: 底部
-  color?: string // 弹幕颜色，默认为白色
-  border?: boolean // 弹幕是否有描边，默认为 false
-  style?: {} // 弹幕自定义样式，默认为空对象
+  danmuku: {
+    text: string // 弹幕文本
+    time?: number // 弹幕时间，默认为当前播放器时间
+    mode?: number // 弹幕模式：0: 滚动 (默认)，1: 顶部，2: 底部
+    color?: string // 弹幕颜色，默认为白色
+    border?: boolean // 弹幕是否有描边，默认为 false
+    style?: {} // 弹幕自定义样式，默认为空对象
+  }[]
 }
 export interface DM_JSON_DDPlay {
   count: number | string
@@ -101,6 +115,12 @@ export class UniPool {
   constructor(
     public dans: UniDM[],
     public options: Options = {},
+    private info = {
+      /**
+       * 是否从已被转换过的第三方格式弹幕再次转换而来
+       */
+      fromConverted: false,
+    },
   ) {
     if (options.dedupe !== false) options.dedupe = true
     if (this.options.dedupe) this.dedupe()
@@ -232,11 +252,15 @@ export class UniPool {
    */
   assign(dans: UniPool | UniDM | UniDM[]) {
     if (dans instanceof UniPool) {
-      return new UniPool([...this.dans, ...dans.dans])
+      return new UniPool(
+        [...this.dans, ...dans.dans],
+        { ...this.options, ...dans.options },
+        { ...this.info, ...dans.info },
+      )
     } else if (dans instanceof UniDM) {
-      return new UniPool([...this.dans, dans])
+      return new UniPool([...this.dans, dans], this.options, this.info)
     } else if (Array.isArray(dans) && dans.every((d) => d instanceof UniDM)) {
-      return new UniPool([...this.dans, ...dans])
+      return new UniPool([...this.dans, ...dans], this.options, this.info)
     } else return this
   }
   /**
@@ -248,7 +272,8 @@ export class UniPool {
     return [...set].map((v) => {
       return new UniPool(
         this.dans.filter((d) => d[key] === v),
-        { dedupe: false },
+        { ...this.options, dedupe: false },
+        this.info,
       )
     })
   }
@@ -366,7 +391,7 @@ export class UniPool {
         }
       }
     })
-    return new UniPool(result)
+    return new UniPool(result, this.options, this.info)
   }
   minify() {
     return this.dans.map((d) => d.minify())
@@ -377,8 +402,8 @@ export class UniPool {
         return this.dans
       case 'danuni.bin':
         return this.toPb()
-      // case 'bili.xml':
-      //   return this.toBiliXML()
+      case 'bili.xml':
+        return this.toBiliXML()
       // case 'bili.bin':
       //   return this.toBiliBin()
       // case 'bili.cmd.bin':
@@ -389,8 +414,8 @@ export class UniPool {
         return this.toArtplayer()
       case 'ddplay.json':
         return this.toDDplay()
-      case 'common.ass':
-        return this.toASS()
+      // case 'common.ass':
+      //   return this.toASS()
       default: {
         const message = '(err) Unknown format or unsupported now!'
         if (continue_on_error) return message
@@ -405,6 +430,7 @@ export class UniPool {
         UniDM.create(
           {
             ...d,
+            progress: d.progress / 1000,
             mode: d.mode as number,
             ctime: timestampDate(d.ctime || timestampNow()),
             pool: d.pool as number,
@@ -427,7 +453,7 @@ export class UniPool {
           return {
             SOID: d.SOID,
             DMID: d.DMID,
-            progress: d.progress,
+            progress: d.progress * 1000,
             mode: d.mode as number,
             fontsize: d.fontsize,
             color: d.color,
@@ -446,8 +472,10 @@ export class UniPool {
   }
   static fromBiliXML(xml: string, options?: Options) {
     const parser = new XMLParser({ ignoreAttributes: false }),
-      oriData: DM_XML_Bili = parser.parse(xml),
-      dans = oriData.i.d
+      oriData: DM_XML_Bili & { danuni?: DanUniConvertTip } = parser.parse(xml),
+      dans = oriData.i.d,
+      fromConverted = !!oriData.danuni,
+      cid = BigInt(oriData.i.chatid)
     return new UniPool(
       dans
         .map((d) => {
@@ -466,15 +494,28 @@ export class UniPool {
               id: BigInt(p_arr[7]),
               weight: Number.parseInt(p_arr[8]),
             },
-            BigInt(oriData.i.chatid),
+            cid,
             options,
+            fromConverted ? oriData.danuni?.data : undefined,
           )
         })
         .filter((d) => d !== null),
       options,
+      { fromConverted },
     )
   }
-  toBiliXML(): string {
+  toBiliXML(options?: {
+    /**
+     * 当SOID非来源bili时，若此处指定则使用该值为cid，否则使用SOID
+     */
+    cid?: bigint
+    /**
+     * 当仅含有来自bili的弹幕时，启用将保持发送者标识不含`@`
+     * @description
+     * bili的弹幕含midHash(crc)，不启用该处使用senderID填充，启用则去除`@bili`部分，提高兼容性
+     */
+    avoidSenderIDWithAt?: boolean
+  }): string {
     const genCID = (id: string) => {
       const UniID = ID.fromString(id)
       if (UniID.domain === platform.PlatformVideoSource.Bilibili) {
@@ -485,7 +526,13 @@ export class UniPool {
 
         if (cid) return cid
       }
-      return Number.parseInt(Buffer.from(id).toString('hex'), 16).toString()
+      return !options?.cid || id
+    }
+    if (options?.avoidSenderIDWithAt) {
+      const ok = this.dans.every((d) =>
+        d.senderID.endsWith(`@${platform.PlatformVideoSource.Bilibili}`),
+      )
+      if (!ok) throw new Error('存在其他来源的senderID，请关闭该功能再试！')
     }
     const builder = new XMLBuilder({ ignoreAttributes: false })
     return builder.build({
@@ -493,6 +540,7 @@ export class UniPool {
         '@_version': '1.0',
         '@_encoding': 'UTF-8',
       },
+      danuni: { ...DanUniConvertTipTemplate, data: this.shared.SOID },
       i: {
         chatserver: 'chat.bilibili.com',
         chatid: genCID(this.dans[0].SOID),
@@ -501,7 +549,7 @@ export class UniPool {
         state: 0,
         real_name: 0,
         source: 'k-v',
-        d: this.dans.map((dan) => dan.toBiliXML()),
+        d: this.dans.map((dan) => dan.toBiliXML(options)),
       },
     })
   }
@@ -533,7 +581,7 @@ export class UniPool {
     )
   }
   static fromDplayer(
-    json: DM_JSON_Dplayer,
+    json: DM_JSON_Dplayer & { danuni?: DanUniConvertTip },
     playerID: string,
     domain = 'other',
     options?: Options,
@@ -557,11 +605,13 @@ export class UniPool {
         )
       }),
       options,
+      { fromConverted: !!json.danuni },
     )
   }
-  toDplayer(): DM_JSON_Dplayer {
+  toDplayer(): DM_JSON_Dplayer & { danuni?: DanUniConvertTip } {
     return {
       code: 0,
+      danuni: DanUniConvertTipTemplate,
       data: this.dans.map((dan) => {
         const d = dan.toDplayer()
         return [d.progress, d.mode, d.color, d.midHash, d.content]
@@ -569,13 +619,13 @@ export class UniPool {
     }
   }
   static fromArtplayer(
-    json: DM_JSON_Artplayer[],
+    json: DM_JSON_Artplayer & { danuni?: DanUniConvertTip },
     playerID: string,
     domain = 'other',
     options?: Options,
   ) {
     return new UniPool(
-      json.map((d) => {
+      json.danmuku.map((d) => {
         // let TYPE = 0
         // if (d.mode === 1) TYPE = 5
         // else if (d.mode === 2) TYPE = 4
@@ -593,23 +643,27 @@ export class UniPool {
         )
       }),
       options,
+      { fromConverted: !!json.danuni },
     )
   }
-  toArtplayer(): DM_JSON_Artplayer[] {
-    return this.dans.map((dan) => {
-      const d = dan.toArtplayer()
-      return {
-        text: d.content,
-        time: d.progress,
-        mode: d.mode as 0 | 1 | 2,
-        color: `#${d.color.toString(16).toUpperCase() || 'FFFFFF'}`,
-        border: d.border,
-        style: d.style,
-      }
-    })
+  toArtplayer(): DM_JSON_Artplayer & { danuni?: DanUniConvertTip } {
+    return {
+      danuni: DanUniConvertTipTemplate,
+      danmuku: this.dans.map((dan) => {
+        const d = dan.toArtplayer()
+        return {
+          text: d.content,
+          time: d.progress,
+          mode: d.mode as 0 | 1 | 2,
+          color: `#${d.color.toString(16).toUpperCase() || 'FFFFFF'}`,
+          border: d.border,
+          style: d.style,
+        }
+      }),
+    }
   }
   static fromDDPlay(
-    json: DM_JSON_DDPlay,
+    json: DM_JSON_DDPlay & { danuni?: DanUniConvertTip },
     episodeId: string,
     options?: Options,
   ) {
@@ -631,10 +685,12 @@ export class UniPool {
         )
       }),
       options,
+      { fromConverted: !!json.danuni },
     )
   }
-  toDDplay(): DM_JSON_DDPlay {
+  toDDplay(): DM_JSON_DDPlay & { danuni?: DanUniConvertTip } {
     return {
+      danuni: DanUniConvertTipTemplate,
       count: this.dans.length,
       comments: this.dans.map((dan) => {
         const d = dan.toDDplay()
@@ -649,9 +705,15 @@ export class UniPool {
   static fromASS(ass: string) {
     return parseAssRawField(ass)
   }
-  toASS(options: AssGenOptions = { substyle: {} }): string {
+  /**
+   * 转换为ASS字幕格式的弹幕，需播放器支持多行ASS渲染
+   */
+  toASS(
+    canvasCtx: CanvasCtx,
+    options: AssGenOptions = { substyle: {} },
+  ): string {
     const fn = this.shared.SOID
-    return generateASS(this, { filename: fn, title: fn, ...options })
+    return generateASS(this, { filename: fn, title: fn, ...options }, canvasCtx)
   }
 }
 

package/src/proto/gen/bili/dm_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.6.2 with parameter "target=ts"
+// @generated by protoc-gen-es v2.6.3 with parameter "target=ts"
 // @generated from file bili/dm.proto (package bilibili.community.service.dm.v1, syntax proto3)
 /* eslint-disable */
 

package/src/proto/gen/danuni_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.6.2 with parameter "target=ts"
+// @generated by protoc-gen-es v2.6.3 with parameter "target=ts"
 // @generated from file danuni.proto (package danuni.danmaku.v1, syntax proto3)
 /* eslint-disable */
 

package/src/utils/dm-gen.ts

@@ -2,6 +2,7 @@ import { Expose, plainToInstance } from 'class-transformer'
 import {
   IsDate,
   IsEmail,
+  isEmail,
   IsEnum,
   IsInt,
   IsNotEmpty,
@@ -733,13 +734,22 @@ export class UniDM {
     }
     return mode
   }
-  static fromBili(args: DMBili, cid?: bigint, options?: Options) {
+  static fromBili(
+    args: DMBili,
+    cid?: bigint,
+    options?: Options,
+    recSOID?: string,
+  ) {
     interface TExtra extends Extra {
       bili: ExtraBili
     }
     if (args.oid && !cid) cid = args.oid
-    const SOID = `def_${PlatformVideoSource.Bilibili}+${ID.fromBili({ cid })}`,
-      senderID = ID.fromBili({ midHash: args.midHash })
+    const SOID =
+        recSOID ||
+        `def_${PlatformVideoSource.Bilibili}+${ID.fromBili({ cid })}`,
+      senderID = isEmail(args.midHash, { require_tld: false })
+        ? args.midHash
+        : ID.fromBili({ midHash: args.midHash })
     let mode = Modes.Normal
     const pool = args.pool, //暂时不做处理，兼容bili的pool格式
       extra: TExtra = {
@@ -797,7 +807,13 @@ export class UniDM {
     )
   }
   @Expose()
-  toBiliXML(options?: { skipBiliCommand: boolean }) {
+  toBiliXML(options?: {
+    skipBiliCommand?: boolean
+    /**
+     * 见 ../index.ts UniPool.toBiliXML() 的 options，该option不宜手动调用，判断逻辑未封装
+     */
+    avoidSenderIDWithAt?: boolean
+  }) {
     if (options?.skipBiliCommand && this.extra.bili?.command) {
       return null
     }
@@ -846,7 +862,9 @@ export class UniDM {
         this.color,
         this.ctime.getTime() / 1000,
         this.extra.bili?.pool || this.pool, // 目前pool与bili兼容
-        this.senderID,
+        options?.avoidSenderIDWithAt
+          ? this.senderID.replaceAll(`@${PlatformVideoSource.Bilibili}`, '')
+          : this.senderID,
         this.extra.bili?.dmid || this.DMID || this.toDMID(),
         this.weight,
       ].join(','),
@@ -1001,7 +1019,9 @@ export class UniDM {
       color: this.color,
       uid: this.senderID,
       m: this.content,
-      cid: Number(this.DMID) || 1,
+      cid: this.DMID
+        ? Number.parseInt(Buffer.from(this.DMID).toString('hex'), 16)
+        : 0,
     }
   }
 }