@dan-uni/dan-any 0.0.7 → 0.2.0

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

@@ -0,0 +1,238 @@
+import { createCanvas } from 'canvas'
+import type { UniPool } from '../..'
+import type { Danmaku, SubtitleStyle } from '../types'
+
+import { DanmakuType, FontSize } from '../types'
+import { DanmakuList2UniPool, UniPool2DanmakuLists } from './danconvert'
+import { arrayOfLength } from './lang'
+
+// 计算一个矩形移进屏幕的时间（头进屏幕到尾巴进屏幕）
+const computeScrollInTime = (
+  rectWidth: number,
+  screenWidth: number,
+  scrollTime: number,
+) => {
+  const speed = (screenWidth + rectWidth) / scrollTime
+  return rectWidth / speed
+}
+
+// 计算一个矩形在屏幕上的时间（头进屏幕到头离开屏幕）
+const computeScrollOverTime = (
+  rectWidth: number,
+  screenWidth: number,
+  scrollTime: number,
+) => {
+  const speed = (screenWidth + rectWidth) / scrollTime
+  return screenWidth / speed
+}
+
+interface ScrollGrid {
+  start: number
+  end: number
+  width: number
+}
+
+type FixGrid = number
+
+interface DanmakuGrids {
+  // [DanmakuType.SCROLL]: ScrollGrid[];
+  // [DanmakuType.TOP]: FixGrid[];
+  // [DanmakuType.BOTTOM]: FixGrid[];
+  1: ScrollGrid[] // DanmakuType.SCROLL
+  3: FixGrid[] // DanmakuType.TOP
+  2: FixGrid[] // DanmakuType.BOTTOM
+}
+
+const splitGrids = ({
+  fontSize,
+  padding,
+  playResY,
+  bottomSpace,
+}: {
+  fontSize: number[]
+  padding: number[]
+  playResY: number
+  bottomSpace: number
+}): DanmakuGrids => {
+  const defaultFontSize = fontSize[FontSize.NORMAL]
+  const paddingTop = padding[0]
+  const paddingBottom = padding[2]
+  const linesCount = Math.floor(
+    (playResY - bottomSpace) / (defaultFontSize + paddingTop + paddingBottom),
+  )
+
+  // 首先以通用的字号把屏幕的高度分成若干行，字幕只允许落在一个行里
+  return {
+    // 每一行里的数字是当前在这一行里的最后一条弹幕区域（算入padding）的右边离开屏幕的时间，
+    // 这个时间和下一条弹幕的左边离开屏幕的时间相比较，能确定在整个弹幕的飞行过程中是否会相撞（不同长度弹幕飞行速度不同）|,
+    // 当每一条弹幕加到一行里时，就会把这个时间算出来，获取新的弹幕时就可以判断哪一行是允许放的就放进去
+    1: arrayOfLength(linesCount, {
+      start: 0,
+      end: 0,
+      width: 0,
+    }),
+    // 对于固定的弹幕，每一行里都存放弹幕的消失时间，只要这行的弹幕没消失就不能放新弹幕进来
+    3: arrayOfLength(linesCount, 0),
+    2: arrayOfLength(linesCount, 0),
+  }
+}
+
+export const measureTextWidth = (() => {
+  const canvasContext = createCanvas(50, 50).getContext('2d')
+  const supportTextMeasure = !!canvasContext.measureText('中')
+
+  if (supportTextMeasure) {
+    return (
+      fontName: string,
+      fontSize: number,
+      bold: boolean,
+      text: string,
+    ) => {
+      canvasContext.font = `${bold ? 'bold' : 'normal'} ${fontSize}px ${fontName}`
+      const textWidth = canvasContext.measureText(text).width
+      return Math.round(textWidth)
+    }
+  }
+
+  console.warn(
+    '[Warn] node-canvas is installed without text measure support, layout may not be correct',
+  )
+  return (_fontName: string, fontSize: number, _bold: boolean, text: string) =>
+    text.length * fontSize
+})()
+
+// 找到能用的行
+const resolveAvailableFixGrid = (grids: FixGrid[], time: number) => {
+  for (const [i, grid] of grids.entries()) {
+    if (grid <= time) {
+      return i
+    }
+  }
+
+  return -1
+}
+
+const resolveAvailableScrollGrid = (
+  grids: ScrollGrid[],
+  rectWidth: number,
+  screenWidth: number,
+  time: number,
+  duration: number,
+) => {
+  for (const [i, previous] of grids.entries()) {
+    // 对于滚动弹幕，要算两个位置：
+    //
+    // 1. 前一条弹幕的尾巴进屏幕之前，后一条弹幕不能开始出现
+    // 2. 前一条弹幕的尾巴离开屏幕之前，后一条弹幕的头不能离开屏幕
+    const previousInTime =
+      previous.start +
+      computeScrollInTime(previous.width, screenWidth, duration)
+    const currentOverTime =
+      time + computeScrollOverTime(rectWidth, screenWidth, duration)
+
+    if (time >= previousInTime && currentOverTime >= previous.end) {
+      return i
+    }
+  }
+
+  return -1
+}
+
+const initializeLayout = (config: SubtitleStyle) => {
+  const {
+    playResX,
+    playResY,
+    fontName,
+    fontSize,
+    bold,
+    padding,
+    scrollTime,
+    fixTime,
+    bottomSpace,
+  } = config
+  const [paddingTop, paddingRight, paddingBottom, paddingLeft] = padding
+
+  const defaultFontSize = fontSize[FontSize.NORMAL]
+  const grids = splitGrids(config)
+  const gridHeight = defaultFontSize + paddingTop + paddingBottom
+
+  return (danmaku: Danmaku) => {
+    const targetGrids = grids[danmaku.type as keyof DanmakuGrids]
+    const danmakuFontSize = fontSize[danmaku.fontSizeType]
+    const rectWidth =
+      measureTextWidth(fontName, danmakuFontSize, bold, danmaku.content) +
+      paddingLeft +
+      paddingRight
+    const verticalOffset =
+      paddingTop + Math.round((defaultFontSize - danmakuFontSize) / 2)
+
+    if (danmaku.type === DanmakuType.SCROLL) {
+      const scrollGrids = targetGrids as ScrollGrid[]
+      const gridNumber = resolveAvailableScrollGrid(
+        scrollGrids,
+        rectWidth,
+        playResX,
+        danmaku.time,
+        scrollTime,
+      )
+      if (gridNumber < 0) {
+        // console.warn(`[Warn] Collision ${danmaku.time}: ${danmaku.content}`)
+        return null
+      }
+      targetGrids[gridNumber] = {
+        width: rectWidth,
+        start: danmaku.time,
+        end: danmaku.time + scrollTime,
+      }
+
+      const top = gridNumber * gridHeight + verticalOffset
+      const start = playResX + paddingLeft
+      const end = -rectWidth
+
+      return { ...danmaku, top, start, end }
+    } else {
+      const gridNumber = resolveAvailableFixGrid(
+        targetGrids as FixGrid[],
+        danmaku.time,
+      )
+      if (gridNumber < 0) {
+        // console.warn(`[Warn] Collision ${danmaku.time}: ${danmaku.content}`)
+        return null
+      }
+      if (danmaku.type === DanmakuType.TOP) {
+        targetGrids[gridNumber] = danmaku.time + fixTime
+
+        const top = gridNumber * gridHeight + verticalOffset
+        // 固定弹幕横向按中心点计算
+        const left = Math.round(playResX / 2)
+
+        return { ...danmaku, top, left }
+      }
+
+      targetGrids[gridNumber] = danmaku.time + fixTime
+
+      // 底部字幕的格子是留出`bottomSpace`的位置后从下往上算的
+      const top =
+        playResY -
+        bottomSpace -
+        gridHeight * gridNumber -
+        gridHeight +
+        verticalOffset
+      const left = Math.round(playResX / 2)
+
+      return { ...danmaku, top, left }
+    }
+  }
+}
+
+export const layoutDanmaku = (
+  inputList: UniPool,
+  config: SubtitleStyle,
+): UniPool => {
+  const list = [...UniPool2DanmakuLists(inputList)].sort(
+    (x, y) => x.time - y.time,
+  )
+  const layout = initializeLayout(config)
+
+  return DanmakuList2UniPool(list.map(layout).filter((danmaku) => !!danmaku))
+}

package/src/index.test.ts

@@ -48,6 +48,12 @@ describe('转化自', () => {
     console.info(json)
     console.info(pool)
   })
+  it('ass(双向)', () => {
+    const pool = UniPool.fromBiliXML(xml)
+    const ass = pool.toASS()
+    console.info(ass)
+    console.info(UniPool.fromASS(ass))
+  })
 })
 
 describe('共通值', () => {
@@ -59,3 +65,13 @@ describe('共通值', () => {
     console.info(pool.split('pool'))
   })
 })
+
+describe('其它', () => {
+  const pool = UniPool.fromBiliXML(xml)
+  it('最小化', () => {
+    console.info(pool.minify())
+  })
+  it('合并范围内重复', () => {
+    console.info(pool.merge(10).minify())
+  })
+})

package/src/index.ts

@@ -1,4 +1,5 @@
 import { XMLParser } from 'fast-xml-parser'
+import type { Options as AssGenOptions } from './ass-gen'
 import type { CommandDm as DM_JSON_BiliCommandGrpc } from './proto/gen/bili/dm_pb'
 // import type * as UniDMType from './utils/dm-gen'
 import type { platfrom } from './utils/id-gen'
@@ -10,6 +11,7 @@ import {
   timestampNow,
 } from '@bufbuild/protobuf/wkt'
 
+import { generateASS, parseAssRawField } from './ass-gen'
 import {
   // DanmakuElem as DM_JSON_BiliGrpc,
   DmSegMobileReplySchema,
@@ -71,6 +73,7 @@ export type DM_format =
   | 'dplayer.json'
   | 'artplayer.json'
   | 'ddplay.json'
+  | 'common.ass'
 
 type shareItems = Partial<
   Pick<
@@ -95,6 +98,9 @@ export class UniPool {
   static create() {
     return new UniPool([])
   }
+  /**
+   * 合并弹幕/弹幕库
+   */
   assign(dans: UniPool | UniDM | UniDM[]) {
     if (dans instanceof UniPool) {
       return new UniPool([...this.dans, ...dans.dans])
@@ -104,6 +110,9 @@ export class UniPool {
       return new UniPool([...this.dans, ...dans])
     } else return this
   }
+  /**
+   * 按共通属性拆分弹幕库
+   */
   split(key: keyof shareItems) {
     if (this.shared[key]) return [this]
     const set = new Set(this.dans.map((d) => d[key]))
@@ -111,6 +120,105 @@ export class UniPool {
       return new UniPool(this.dans.filter((d) => d[key] === v))
     })
   }
+  /**
+   * 合并一定时间段内的重复弹幕，防止同屏出现过多
+   * @param lifetime 查重时间区段，单位秒 (默认为0，表示不查重)
+   */
+  merge(lifetime = 0) {
+    if (!this.shared.FCID) {
+      console.error(
+        "本功能仅支持同弹幕库内使用，可先 .split('FCID') 在分别使用",
+      )
+      return this
+    }
+    if (lifetime <= 0) return this
+    const mergeContext = this.dans.reduce<
+      [
+        UniDM[],
+        Record<string, UniDM>,
+        Record<string, UniDMTools.ExtraDanUniMerge>,
+      ]
+    >(
+      ([result, cache, mergeObj], danmaku) => {
+        const key = ['content', 'mode', 'platform', 'pool', 'SPMO']
+          .map((k) => danmaku[k as keyof UniDM])
+          .join('|')
+        const cached = cache[key]
+        const lastAppearTime = cached?.progress || 0
+        if (
+          cached &&
+          danmaku.progress - lastAppearTime <= lifetime &&
+          danmaku.isSameAs(cached)
+        ) {
+          const senders = mergeObj[key].senders
+          senders.push(danmaku.senderID)
+          const extra = danmaku.extra
+          extra.danuni = extra.danuni || {}
+          extra.danuni.merge = {
+            count: senders.length,
+            duration: danmaku.progress - cached.progress,
+            senders,
+          }
+          danmaku.extraStr = JSON.stringify(extra)
+          cache[key] = danmaku
+          mergeObj[key] = extra.danuni.merge
+          return [result, cache, mergeObj]
+        } else {
+          mergeObj[key] = {
+            count: 1,
+            duration: 0,
+            senders: [danmaku.senderID],
+          }
+          cache[key] = danmaku
+          // 初始化merge信息，包含第一个sender
+          const extra = danmaku.extra
+          extra.danuni = extra.danuni || {}
+          extra.danuni.merge = mergeObj[key]
+          danmaku.extraStr = JSON.stringify(extra)
+          result.push(danmaku)
+          return [result, cache, mergeObj]
+        }
+      },
+      [[], {}, {}],
+    )
+    // 处理结果，删除senders<=1的merge字段
+    const [result, _cache, mergeObj] = mergeContext
+    result.forEach((danmaku, i) => {
+      const key = ['content', 'mode', 'platform', 'pool', 'SPMO']
+        .map((k) => danmaku[k as keyof UniDM])
+        .join('|')
+      const extra = result[i].extra,
+        mergeData = mergeObj[key]
+      result[i].extraStr = JSON.stringify({
+        ...extra,
+        danuni: {
+          ...extra.danuni,
+          merge: mergeData,
+        },
+      } satisfies UniDMTools.Extra)
+      if (mergeData?.count) {
+        if (mergeData.count <= 1) {
+          const updatedExtra = { ...extra }
+          if (updatedExtra.danuni) {
+            delete updatedExtra.danuni.merge
+            if (Object.keys(updatedExtra.danuni).length === 0) {
+              delete updatedExtra.danuni
+            }
+          }
+          result[i].extraStr =
+            Object.keys(updatedExtra).length > 0
+              ? JSON.stringify(updatedExtra)
+              : undefined
+        } else {
+          result[i].senderID = 'merge@bot'
+        }
+      }
+    })
+    return new UniPool(result)
+  }
+  minify() {
+    return this.dans.map((d) => d.minify())
+  }
   convert2(format: DM_format) {
     switch (format) {
       case 'danuni.json':
@@ -339,6 +447,12 @@ export class UniPool {
       }),
     }
   }
+  static fromASS(ass: string) {
+    return parseAssRawField(ass)
+  }
+  toASS(options: AssGenOptions = { substyle: {} }): string {
+    return generateASS(this, options)
+  }
 }
 
 export {

package/src/utils/dm-gen.test.ts

@@ -0,0 +1,66 @@
+//基于以下注释，根据vitest生成测试用例
+import { describe, expect, it } from 'vitest'
+import type { UniDMObj } from './dm-gen'
+
+import { UniDM, UniPool } from '..'
+
+const xml = `<i>
+<chatserver>chat.bilibili.com</chatserver>
+<chatid>1156756312</chatid>
+<mission>0</mission>
+<maxlimit>2947</maxlimit>
+<state>0</state>
+<real_name>0</real_name>
+<source>k-v</source>
+<d p="13.213,1,25,16777215,1686314041,3,ff41173d,1335658005672492032">喜欢</d>
+<d p="13.331,1,25,16777215,1686948453,3,56a3c5d5,1340979831550069760">不喜欢</d>
+<d p="13.374,1,25,16777215,1686300770,3,647fe355,1335546672880933888">不喜欢</d>
+<d p="13.499,1,25,16777215,1686301548,3,2848bf1c,1335553202649003264">不喜欢</d>
+</i>`
+
+describe('其它', () => {
+  const pool = UniPool.fromBiliXML(xml)
+  it('比较(常规)', () => {
+    // 确保测试用例为预期值
+    expect(pool.dans[0].content).toBe('喜欢')
+    expect(pool.dans[1].content).toBe('不喜欢')
+    // 正式测试
+    const a = pool.dans[0].isSameAs(pool.dans[1]),
+      b = pool.dans[1].isSameAs(pool.dans[2]),
+      c = pool.dans[1].isSameAs(pool.dans[3])
+    console.info(a, b, c)
+    expect(a).toBe(false)
+    expect(b).toBe(true)
+    expect(c).toBe(true)
+  })
+  it('比较(extra)', () => {
+    const commonSample = {
+      FCID: 'test@du',
+      content: 'T Sample',
+      extra: {
+        danuni: {
+          merge: {
+            count: 1,
+            duration: 0,
+            senders: ['test@du'],
+          },
+        },
+      },
+    } satisfies Partial<UniDMObj>
+    const pool2 = [
+      UniDM.create({ ...commonSample, extra: undefined }),
+      UniDM.create({ ...commonSample, extra: {} }),
+      UniDM.create({ ...commonSample, extra: { danuni: {} } }),
+      UniDM.create({ ...commonSample }),
+      UniDM.create({ ...commonSample, extra: { artplayer: { border: true } } }),
+    ]
+    for (const pool of pool2) {
+      console.info(pool.extraStr)
+      console.info(pool2[0].isSameAs(pool))
+    }
+    expect(pool2[0].isSameAs(pool2[1])).toBe(true)
+    expect(pool2[0].isSameAs(pool2[2])).toBe(true)
+    expect(pool2[0].isSameAs(pool2[3])).toBe(true)
+    expect(pool2[0].isSameAs(pool2[4])).toBe(false)
+  })
+})