@dan-uni/dan-any 0.7.8 → 0.8.5

package/dist/src/ass-gen/index.d.ts

@@ -1,6 +1,7 @@
 import type { RawConfig } from './ass/raw';
-import type { SubtitleStyle } from './types';
+import type { CanvasCtx, SubtitleStyle } from './types';
 import { UniPool } from '..';
+export { CanvasCtx };
 export type Options = {
     filename?: string;
     title?: string;
@@ -24,5 +25,5 @@ const assText = generateASS(xmlText, { filename, title: 'Quick Example' })
 fs.writeFileSync(`${filename}.ass`, assText, 'utf-8')
 ```
  */
-export declare function generateASS(danmaku: UniPool, options: Options): string;
+export declare function generateASS(danmaku: UniPool, options: Options, canvasCtx: CanvasCtx): string;
 export declare function parseAssRawField(ass: string): UniPool;

package/dist/src/ass-gen/types.d.ts

@@ -1,4 +1,28 @@
+import type { CanvasRenderingContext2D as NodeCRCtx2D } from 'canvas';
 import type { UniDM } from '../utils/dm-gen';
+/**
+ * 请根据您的使用环境提供一个 50x50 的 2D Canvas 上下文
+ * @example
+ * // Node.js + canvas
+ * import { createCanvas } from 'canvas'
+ * const canvas = createCanvas(50, 50)
+ * const ctx = canvas.getContext('2d')
+ * @example
+ * // Node.js + Fabric.js
+ * import { StaticCanvas } from 'fabric/node'
+ * const ctx = new StaticCanvas(null, { width: 50, height: 50 }).getContext()
+ * @example
+ * // Browser + Native Canvas
+ * const canvas = document.createElement('canvas')
+ * canvas.width = 50
+ * canvas.height = 50
+ * const ctx = canvas.getContext('2d')
+ * @example
+ * // Browser + Fabric.js
+ * import { Canvas } from 'fabric'
+ * const ctx = new Canvas('canvas', { width: 50, height: 50 }).getContext()
+ */
+export type CanvasCtx = NodeCRCtx2D | CanvasRenderingContext2D;
 export interface Context {
     filename: string;
     title: string;

package/dist/src/ass-gen/util/layout.d.ts

@@ -1,4 +1,4 @@
 import type { UniPool } from '../..';
-import type { SubtitleStyle } from '../types';
-export declare const measureTextWidth: (fontName: string, fontSize: number, bold: boolean, text: string) => number;
-export declare const layoutDanmaku: (inputList: UniPool, config: SubtitleStyle) => UniPool;
+import type { CanvasCtx, SubtitleStyle } from '../types';
+export declare const measureTextWidthConstructor: (canvasContext: CanvasCtx) => (fontName: string, fontSize: number, bold: boolean, text: string) => number;
+export declare const layoutDanmaku: (inputList: UniPool, config: SubtitleStyle, canvasCtx: CanvasCtx) => UniPool;

package/dist/src/index.d.ts

@@ -1,10 +1,15 @@
 import 'reflect-metadata/lite';
-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 { UniDM } from './utils/dm-gen';
 import * as UniDMTools from './utils/dm-gen';
 import * as UniIDTools from './utils/id-gen';
 import * as platform from './utils/platform';
+interface DanUniConvertTip {
+    meassage: string;
+    version: string;
+    data?: string;
+}
 export interface DM_XML_Bili {
     i: {
         chatserver: string;
@@ -28,12 +33,14 @@ export interface DM_JSON_Dplayer {
     data: [number, number, number, string, string][];
 }
 export interface DM_JSON_Artplayer {
-    text: string;
-    time?: number;
-    mode?: number;
-    color?: string;
-    border?: boolean;
-    style?: {};
+    danmuku: {
+        text: string;
+        time?: number;
+        mode?: number;
+        color?: string;
+        border?: boolean;
+        style?: {};
+    }[];
 }
 export interface DM_JSON_DDPlay {
     count: number | string;
@@ -54,7 +61,13 @@ interface Options {
 export declare class UniPool {
     dans: UniDM[];
     options: Options;
-    constructor(dans: UniDM[], options?: Options);
+    private info;
+    constructor(dans: UniDM[], options?: Options, info?: {
+        /**
+         * 是否从已被转换过的第三方格式弹幕再次转换而来
+         */
+        fromConverted: boolean;
+    });
     pipe(fn: UniPoolPipe): Promise<UniPool>;
     pipeSync(fn: UniPoolPipeSync): UniPool;
     get shared(): shareItems;
@@ -125,26 +138,58 @@ export declare class UniPool {
      */
     merge(lifetime?: number): UniPool;
     minify(): (Partial<UniDMTools.UniDMObj> & Pick<UniDMTools.UniDMObj, "SOID">)[];
-    convert2(format: DM_format, continue_on_error?: boolean): string | Uint8Array<ArrayBufferLike> | UniDM[] | DM_JSON_Dplayer | DM_JSON_DDPlay | DM_JSON_Artplayer[];
+    convert2(format: DM_format, continue_on_error?: boolean): string | Uint8Array<ArrayBufferLike> | UniDM[] | (DM_JSON_Dplayer & {
+        danuni?: DanUniConvertTip;
+    }) | (DM_JSON_Artplayer & {
+        danuni?: DanUniConvertTip;
+    }) | (DM_JSON_DDPlay & {
+        danuni?: DanUniConvertTip;
+    });
     static fromPb(bin: Uint8Array | ArrayBuffer, options?: Options): UniPool;
     /**
      * 转为 protobuf 二进制
      */
     toPb(): Uint8Array<ArrayBufferLike>;
     static fromBiliXML(xml: string, options?: Options): UniPool;
-    toBiliXML(): string;
+    toBiliXML(options?: {
+        /**
+         * 当SOID非来源bili时，若此处指定则使用该值为cid，否则使用SOID
+         */
+        cid?: bigint;
+        /**
+         * 当仅含有来自bili的弹幕时，启用将保持发送者标识不含`@`
+         * @description
+         * bili的弹幕含midHash(crc)，不启用该处使用senderID填充，启用则去除`@bili`部分，提高兼容性
+         */
+        avoidSenderIDWithAt?: boolean;
+    }): string;
     static fromBiliGrpc(bin: Uint8Array | ArrayBuffer, options?: Options): UniPool;
     /**
      * @param bin 符合`DmWebViewReplySchema`(bili视频meta)的protobuf二进制
      */
     static fromBiliCommandGrpc(bin: Uint8Array | ArrayBuffer, options?: Options): UniPool;
-    static fromDplayer(json: DM_JSON_Dplayer, playerID: string, domain?: string, options?: Options): UniPool;
-    toDplayer(): DM_JSON_Dplayer;
-    static fromArtplayer(json: DM_JSON_Artplayer[], playerID: string, domain?: string, options?: Options): UniPool;
-    toArtplayer(): DM_JSON_Artplayer[];
-    static fromDDPlay(json: DM_JSON_DDPlay, episodeId: string, options?: Options): UniPool;
-    toDDplay(): DM_JSON_DDPlay;
+    static fromDplayer(json: DM_JSON_Dplayer & {
+        danuni?: DanUniConvertTip;
+    }, playerID: string, domain?: string, options?: Options): UniPool;
+    toDplayer(): DM_JSON_Dplayer & {
+        danuni?: DanUniConvertTip;
+    };
+    static fromArtplayer(json: DM_JSON_Artplayer & {
+        danuni?: DanUniConvertTip;
+    }, playerID: string, domain?: string, options?: Options): UniPool;
+    toArtplayer(): DM_JSON_Artplayer & {
+        danuni?: DanUniConvertTip;
+    };
+    static fromDDPlay(json: DM_JSON_DDPlay & {
+        danuni?: DanUniConvertTip;
+    }, episodeId: string, options?: Options): UniPool;
+    toDDplay(): DM_JSON_DDPlay & {
+        danuni?: DanUniConvertTip;
+    };
     static fromASS(ass: string): UniPool;
-    toASS(options?: AssGenOptions): string;
+    /**
+     * 转换为ASS字幕格式的弹幕，需播放器支持多行ASS渲染
+     */
+    toASS(canvasCtx: CanvasCtx, options?: AssGenOptions): string;
 }
 export { platform, UniDM, UniDMTools, UniIDTools, type DM_JSON_BiliCommandGrpc, };

package/dist/src/utils/dm-gen.d.ts

@@ -272,9 +272,13 @@ export declare class UniDM {
      */
     static transCtime(oriCtime: ctime, tsUnit?: 'ms' | 's'): Date;
     static transMode(oriMode: number, fmt: 'bili' | 'dplayer' | 'artplayer' | 'ddplay'): Modes;
-    static fromBili(args: DMBili, cid?: bigint, options?: Options): UniDM;
+    static fromBili(args: DMBili, cid?: bigint, options?: Options, recSOID?: string): UniDM;
     toBiliXML(options?: {
-        skipBiliCommand: boolean;
+        skipBiliCommand?: boolean;
+        /**
+         * 见 ../index.ts UniPool.toBiliXML() 的 options，该option不宜手动调用，判断逻辑未封装
+         */
+        avoidSenderIDWithAt?: boolean;
     }): {
         '#text': string;
         '@_p': string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dan-uni/dan-any",
-  "version": "0.7.8",
+  "version": "0.8.5",
   "description": "A danmaku transformer lib, supporting danmaku from different platforms.",
   "keywords": [
     "bangumi",
@@ -31,12 +31,10 @@
     "buf": "buf generate"
   },
   "dependencies": {
-    "@bufbuild/protobuf": "^2.6.2",
+    "@bufbuild/protobuf": "^2.6.3",
     "base16384": "^1.0.0",
-    "canvas": "^3.1.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.2",
-    "fabric": "^6.7.1",
     "fast-xml-parser": "^5.2.5",
     "fs-extra": "^11.3.0",
     "hh-mm-ss": "^1.2.0",
@@ -46,10 +44,11 @@
   },
   "devDependencies": {
     "@bufbuild/buf": "^1.56.0",
-    "@bufbuild/protoc-gen-es": "^2.6.2",
+    "@bufbuild/protoc-gen-es": "^2.6.3",
     "@types/fs-extra": "^11.0.4",
     "@types/hh-mm-ss": "^1.2.3",
     "@types/json-bigint": "^1.0.4",
+    "canvas": "^3.1.2",
     "protobufjs": "^7.5.3"
   }
 }

package/rslib.config.ts

@@ -18,7 +18,6 @@ export default defineConfig({
       output: {
         filename: { js: 'index.umd.min.js' },
         target: 'web',
-        externals: ['fabric/node'],
       },
       dts: true,
       umdName: pkg.name,

package/src/ass-gen/__tests__/canvas.test.ts

@@ -1,11 +1,15 @@
-import { assert, assertType, it } from 'vitest'
+import { createCanvas } from 'canvas'
+import { assertType, it } from 'vitest'
 
-import { measureTextWidth } from '../util/layout'
+import { measureTextWidthConstructor } from '../util/layout'
 
 it('canvas measureTextWidth', () => {
   const text = '一段测试文字'
-  const width = measureTextWidth('SimHei', 25, false, text)
+  const canvas = createCanvas(50, 50)
+  const width = measureTextWidthConstructor(
+    canvas.getContext('2d') as unknown as CanvasRenderingContext2D,
+  )('SimHei', 25, false, text)
   assertType<number>(width)
   console.info(width, text.length)
-  assert(width >= 25 * text.length)
+  // assert(width >= 25 * text.length)
 })

package/src/ass-gen/__tests__/generate.test.ts

@@ -1,6 +1,7 @@
 import fs from 'node:fs'
 import path, { dirname } from 'node:path'
 import { fileURLToPath } from 'node:url'
+import { createCanvas } from 'canvas'
 import { it } from 'vitest'
 
 import { generateASS } from '../'
@@ -12,9 +13,14 @@ it('generate ass from xml', () => {
   const filename = '898651903.xml'
   const xmlPath = path.join(__dirname, filename)
   const xmlText = fs.readFileSync(xmlPath, 'utf-8')
-  const assText = generateASS(UniPool.fromBiliXML(xmlText), {
-    // filename,
-    // title: '我的忏悔',
-  })
+  const canvas = createCanvas(50, 50)
+  const assText = generateASS(
+    UniPool.fromBiliXML(xmlText),
+    {
+      // filename,
+      // title: '我的忏悔',
+    },
+    canvas.getContext('2d') as unknown as CanvasRenderingContext2D,
+  )
   fs.writeFileSync(path.join(__dirname, `${filename}.ass`), assText, 'utf-8')
 })

package/src/ass-gen/index.ts

@@ -1,6 +1,6 @@
 // import parse from './parse/bilibili'
 import type { RawConfig } from './ass/raw'
-import type { SubtitleStyle } from './types'
+import type { CanvasCtx, SubtitleStyle } from './types'
 
 import { UniPool } from '..'
 import ass from './ass/create'
@@ -8,6 +8,8 @@ import { deRaw } from './ass/raw'
 import getConfig from './config'
 import { DanmakuList2UniPool, layoutDanmaku } from './util'
 
+export { CanvasCtx }
+
 export type Options = {
   filename?: string
   title?: string
@@ -32,13 +34,17 @@ const assText = generateASS(xmlText, { filename, title: 'Quick Example' })
 fs.writeFileSync(`${filename}.ass`, assText, 'utf-8')
 ```
  */
-export function generateASS(danmaku: UniPool, options: Options): string {
+export function generateASS(
+  danmaku: UniPool,
+  options: Options,
+  canvasCtx: CanvasCtx,
+): string {
   //   const result = parse(text)
   const config = getConfig(options.substyle)
   // const filteredList = filterDanmaku(result.list, config.block)
   // const mergedList = mergeDanmaku(result.list, config.mergeIn)
   const mergedList = danmaku.merge(config.mergeIn)
-  const layoutList = layoutDanmaku(mergedList, config)
+  const layoutList = layoutDanmaku(mergedList, config, canvasCtx)
   const content = ass(
     layoutList,
     danmaku,

package/src/ass-gen/types.ts

@@ -1,7 +1,31 @@
 // export type BlockRule = string | RegExp
-
+import type { CanvasRenderingContext2D as NodeCRCtx2D } from 'canvas'
 import type { UniDM } from '../utils/dm-gen'
 
+/**
+ * 请根据您的使用环境提供一个 50x50 的 2D Canvas 上下文
+ * @example
+ * // Node.js + canvas
+ * import { createCanvas } from 'canvas'
+ * const canvas = createCanvas(50, 50)
+ * const ctx = canvas.getContext('2d')
+ * @example
+ * // Node.js + Fabric.js
+ * import { StaticCanvas } from 'fabric/node'
+ * const ctx = new StaticCanvas(null, { width: 50, height: 50 }).getContext()
+ * @example
+ * // Browser + Native Canvas
+ * const canvas = document.createElement('canvas')
+ * canvas.width = 50
+ * canvas.height = 50
+ * const ctx = canvas.getContext('2d')
+ * @example
+ * // Browser + Fabric.js
+ * import { Canvas } from 'fabric'
+ * const ctx = new Canvas('canvas', { width: 50, height: 50 }).getContext()
+ */
+export type CanvasCtx = NodeCRCtx2D | CanvasRenderingContext2D
+
 export interface Context {
   filename: string
   title: string

package/src/ass-gen/util/layout.ts

@@ -1,7 +1,5 @@
-import { Canvas as WebCanvas } from 'fabric'
-import { StaticCanvas as NodeCanvas } from 'fabric/node'
 import type { UniPool } from '../..'
-import type { Danmaku, SubtitleStyle } from '../types'
+import type { CanvasCtx, Danmaku, SubtitleStyle } from '../types'
 
 import { DanmakuType, FontSize } from '../types'
 import { DanmakuList2UniPool, UniPool2DanmakuLists } from './danconvert'
@@ -78,18 +76,7 @@ const splitGrids = ({
   }
 }
 
-export const measureTextWidth = (() => {
-  let isWeb
-  try {
-    isWeb = !!window
-  } catch {
-    isWeb = false
-  }
-  const Canvas = isWeb ? WebCanvas : NodeCanvas
-  const canvasContext = new Canvas(undefined, {
-    width: 50,
-    height: 50,
-  }).getContext()
+export const measureTextWidthConstructor = (canvasContext: CanvasCtx) => {
   const supportTextMeasure = !!canvasContext.measureText('中')
 
   if (supportTextMeasure) {
@@ -110,7 +97,7 @@ export const measureTextWidth = (() => {
   )
   return (_fontName: string, fontSize: number, _bold: boolean, text: string) =>
     text.length * fontSize
-})()
+}
 
 // 找到能用的行
 const resolveAvailableFixGrid = (grids: FixGrid[], time: number) => {
@@ -149,7 +136,7 @@ const resolveAvailableScrollGrid = (
   return -1
 }
 
-const initializeLayout = (config: SubtitleStyle) => {
+const initializeLayout = (config: SubtitleStyle, canvasCtx: CanvasCtx) => {
   const {
     playResX,
     playResY,
@@ -171,7 +158,12 @@ const initializeLayout = (config: SubtitleStyle) => {
     const targetGrids = grids[danmaku.type as keyof DanmakuGrids]
     const danmakuFontSize = fontSize[danmaku.fontSizeType]
     const rectWidth =
-      measureTextWidth(fontName, danmakuFontSize, bold, danmaku.content) +
+      measureTextWidthConstructor(canvasCtx)(
+        fontName,
+        danmakuFontSize,
+        bold,
+        danmaku.content,
+      ) +
       paddingLeft +
       paddingRight
     const verticalOffset =
@@ -239,11 +231,12 @@ const initializeLayout = (config: SubtitleStyle) => {
 export const layoutDanmaku = (
   inputList: UniPool,
   config: SubtitleStyle,
+  canvasCtx: CanvasCtx,
 ): UniPool => {
   const list = [...UniPool2DanmakuLists(inputList)].sort(
     (x, y) => x.time - y.time,
   )
-  const layout = initializeLayout(config)
+  const layout = initializeLayout(config, canvasCtx)
 
   return DanmakuList2UniPool(list.map(layout).filter((danmaku) => !!danmaku))
 }

package/src/index.test.ts

@@ -1,4 +1,5 @@
 //基于以下注释，根据vitest生成测试用例
+import { createCanvas } from 'canvas'
 import { describe, it } from 'vitest'
 
 import { UniPool } from './index'
@@ -33,28 +34,42 @@ describe('转化自', () => {
     console.info(xml)
     console.info(pool)
     console.info(pool.toBiliXML())
+    console.info(pool.toBiliXML({ avoidSenderIDWithAt: true }))
   })
   it('artplayer(json)', () => {
-    const json = [
-        {
-          text: 'artplayer测试弹幕', // 弹幕文本
-          time: 10, // 弹幕时间, 默认为当前播放器时间
-          mode: 0, // 弹幕模式: 0: 滚动(默认)，1: 顶部，2: 底部
-          color: '#FFFFFF', // 弹幕颜色，默认为白色
-          border: false, // 弹幕是否有描边, 默认为 false
-          style: { border: '10rem' }, // 弹幕自定义样式, 默认为空对象
-        },
-      ],
+    const json = {
+        danmuku: [
+          {
+            text: 'artplayer测试弹幕', // 弹幕文本
+            time: 10, // 弹幕时间, 默认为当前播放器时间
+            mode: 0, // 弹幕模式: 0: 滚动(默认)，1: 顶部，2: 底部
+            color: '#FFFFFF', // 弹幕颜色，默认为白色
+            border: false, // 弹幕是否有描边, 默认为 false
+            style: { border: '10rem' }, // 弹幕自定义样式, 默认为空对象
+          },
+        ],
+      },
       pool = UniPool.fromArtplayer(json, 'playerid-test', 'acfun')
     console.info(json)
     console.info(pool)
   })
   it('ass[双向]', () => {
+    const canvas = createCanvas(50, 50)
     const pool = UniPool.fromBiliXML(xml)
-    const ass = pool.toASS()
+    const ass = pool.toASS(canvas.getContext('2d'))
     console.info(ass)
     console.info(UniPool.fromASS(ass))
   })
+  it('pb[双向]', () => {
+    const pool = UniPool.fromBiliXML(xml)
+    const pb = pool.toPb()
+    console.info(UniPool.fromPb(pb))
+  })
+  it('DDplay[双向]', () => {
+    const pool = UniPool.fromBiliXML(xml)
+    const ddplay = pool.toDDplay()
+    console.info(UniPool.fromDDPlay(ddplay, '1'))
+  })
 })
 
 describe('共通值', () => {