@nxtedition/lib 23.11.2 → 23.12.1

package/ass.js

@@ -1,5 +1,4 @@
 // @ts-check
-import fp from 'lodash/fp.js'
 import { wordwrap } from './wordwrap.js'
 
 const BASE_WIDTH = 1920
@@ -12,6 +11,29 @@ const BASE_HEIGHT = 1080
  * @property {number | null} [end]
  * @property {string | null} [style]
  * @property {string | null} [text]
+ * @property {SubtitleEventStyleOverrides} [styleOverrides]
+ *
+ * @typedef {object} SubtitleEventStyleOverrides
+ * @property {string} [marginL]
+ * @property {string} [marginR]
+ * @property {string} [marginV]
+ * @property {string} [alignment]
+ * @property {string} [fontname]
+ * @property {string} [fontsize]
+ * @property {string} [primaryColour]
+ * @property {string} [secondaryColour]
+ * @property {string} [outlineColour]
+ * @property {string} [backColour]
+ * @property {string} [bold]
+ * @property {string} [italic]
+ * @property {string} [underline]
+ * @property {string} [strikeOut]
+ *
+ * @typedef {object} EmbeddableSubtitleFontFace
+ * @property {string} family
+ * @property {'normal'|'bold'} weight
+ * @property {'normal'|'italic'} style
+ * @property {Uint8Array} data
  *
  * @typedef {object} Styles
  * @property {string} [name]
@@ -44,6 +66,7 @@ const BASE_HEIGHT = 1080
  * @property {number} [height]
  * @property {boolean} [scaledBorderAndShadow] TODO: default to true when all client styles depend on it?
  * @property {boolean} [futureWordWrapping]
+ * @property {EmbeddableSubtitleFontFace[]} [fonts]
  */
 
 /**
@@ -59,6 +82,7 @@ export function encodeASS(
     height = BASE_HEIGHT,
     scaledBorderAndShadow = false,
     futureWordWrapping = false,
+    fonts = [],
   } = {},
 ) {
   const scale = typeof width === 'number' ? BASE_HEIGHT / height : 1
@@ -66,9 +90,13 @@ export function encodeASS(
   const playResY = scale * (height || BASE_HEIGHT)
   return [
     encASSHeader({ playResX, playResY, scaledBorderAndShadow, futureWordWrapping }),
+    encFontFaces(fonts),
     encASSStyles(styles),
+    '',
     encASSEvents(events, styles, playResX, futureWordWrapping),
-  ].join('\n')
+  ]
+    .filter((x) => typeof x === 'string')
+    .join('\n')
 }
 
 /**
@@ -78,34 +106,111 @@ export function encodeASS(
  * @param {boolean} futureWordWrapping
  */
 function formatDialogues(events, styles, scriptResX, futureWordWrapping) {
-  let s = ''
-  for (const { start, duration, end = duration != null ? start + duration : null, text, style } of [
-    ...events,
-  ].sort((a, b) => a.start - b.start)) {
-    const styleName = style || 'nxt-default'
-    const eventStyle = styles[styleName]
-    const fontSize = parseFloat(eventStyle.fontsize || '32')
-    const fontFamily = eventStyle.fontname ?? 'Arial'
-    const maxWidth = Math.max(
-      0,
-      scriptResX - parseFloat(eventStyle.marginL || '0') - parseFloat(eventStyle.marginR || '0'),
+  return [...events]
+    .sort((a, b) => a.start - b.start)
+    .map((event) => {
+      const {
+        start,
+        duration,
+        end = duration != null ? start + duration : null,
+        text,
+        style,
+        styleOverrides,
+      } = event
+
+      if (typeof text !== 'string' || text.length === 0 || typeof start !== 'number') {
+        return null
+      }
+
+      const styleName = style || 'nxt-default'
+      const eventStyle = styles[styleName] ?? {}
+      const textOptions = {
+        fontSize: parseFloat(eventStyle.fontsize || '32'),
+        fontFamily: eventStyle.fontname ?? 'Arial',
+        maxWidth: Math.max(
+          0,
+          scriptResX -
+            parseFloat(eventStyle.marginL || '0') -
+            parseFloat(eventStyle.marginR || '0'),
+        ),
+        styleOverrides,
+        futureWordWrapping,
+      }
+
+      return `Dialogue: ${[
+        /* Layer   */ '0',
+        /* Start   */ formatASSTime(start) || '0:00:00.00',
+        /* End     */ formatASSTime(end) || '9:59:59.00',
+        /* Style   */ styleName,
+        /* Name    */ '',
+        /* MarginL */ (styleOverrides?.marginL ?? '0').padStart(4, '0'),
+        /* MarginR */ (styleOverrides?.marginR ?? '0').padStart(4, '0'),
+        /* MarginV */ (styleOverrides?.marginV ?? '0').padStart(4, '0'),
+        /* Effect  */ '',
+        /* Text    */ encodeText(text, textOptions),
+      ]
+        .filter((s) => typeof s === 'string')
+        .join(',')}`
+    })
+    .join('\n')
+}
+
+/**
+ * @param {string} text
+ * @param {object} options
+ * @param {number} options.fontSize
+ * @param {string} options.fontFamily
+ * @param {number} options.maxWidth
+ * @param {SubtitleEventStyleOverrides} [options.styleOverrides]
+ * @param {boolean} options.futureWordWrapping
+ */
+function encodeText(text, { styleOverrides, futureWordWrapping, ...options }) {
+  return `${getOverrideTags(styleOverrides)}${text
+    .split(/\\n|\n|\\N/)
+    .map((line) => line.trim())
+    .flatMap((line) =>
+      futureWordWrapping ? wordwrap(line, { ...options, breakWord: false }) : [line],
     )
-    if (typeof text === 'string' && text.length > 0 && Number.isFinite(start)) {
-      s += `Dialogue: 0,${formatASSTime(start) || '0:00:00.00'},${
-        formatASSTime(end) || '9:59:59.00'
-      },${styleName},,0000,0000,0000,,${text
-        .split(/\\n|\n|\\N/)
-        .map((line) => line.trim())
-        .flatMap((line) =>
-          futureWordWrapping
-            ? wordwrap(line, { fontSize, fontFamily, maxWidth, breakWord: false })
-            : [line],
-        )
-        .map((line) => line.trim())
-        .join('\\N')}\n`
-    }
-  }
-  return s
+    .map((line) => line.trim())
+    .join('\\N')}`
+}
+
+/**
+ * @param {SubtitleEventStyleOverrides} [styleOverrides]
+ */
+function getOverrideTags(styleOverrides) {
+  return Object.entries(styleOverrides ?? {})
+    .map(([key, value]) => {
+      switch (key) {
+        case 'alignment':
+          return `an${value}`
+        case 'primaryColour':
+          return `c${value}`
+        case 'secondaryColour':
+          return `2c${value}`
+        case 'outlineColour':
+          return `3c${value}`
+        case 'backColour':
+          return `4c${value}`
+        case 'bold':
+          return `b${value === '0' ? '0' : '1'}`
+        case 'italic':
+          return `i${value === '0' ? '0' : '1'}`
+        case 'underline':
+          return `u${value === '0' ? '0' : '1'}`
+        case 'strikeOut':
+          return `s${value === '0' ? '0' : '1'}`
+        case 'fontname':
+          return `fn${value}`
+        case 'fontsize':
+          return `fs${value}`
+        default:
+          return null
+      }
+    })
+    .filter((tag) => typeof tag === 'string')
+    .map((tag) => `{\\${tag}}`)
+    .join('')
 }
 
 /**
@@ -117,70 +222,48 @@ function formatDialogues(events, styles, scriptResX, futureWordWrapping) {
 function encASSEvents(events, styles, scriptResX, futureWordWrapping) {
   return `[Events]
 Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
-${formatDialogues(events, styles, scriptResX, futureWordWrapping)}`
+${formatDialogues(events, styles, scriptResX, futureWordWrapping)}\n`
 }
 
 /**
  * @param {{ [styleName: string]: Styles }} styles
+ * @returns {string}
  */
-const formatStyles = fp.pipe(
-  fp.entries,
-  fp.reduce((s, [id, style]) => {
-    return (
-      s +
-      'Style: ' +
-      id +
-      ',' +
-      style.fontname +
-      ',' +
-      style.fontsize +
-      ',' +
-      style.primaryColour +
-      ',' +
-      style.secondaryColour +
-      ',' +
-      style.outlineColour +
-      ',' +
-      style.backColour +
-      ',' +
-      style.bold +
-      ',' +
-      style.italic +
-      ',' +
-      style.underline +
-      ',' +
-      style.strikeOut +
-      ',' +
-      style.scaleX +
-      ',' +
-      style.scaleY +
-      ',' +
-      style.spacing +
-      ',' +
-      style.angle +
-      ',' +
-      style.borderStyle +
-      ',' +
-      style.outline +
-      ',' +
-      style.shadow +
-      ',' +
-      style.alignment +
-      ',' +
-      style.marginL +
-      ',' +
-      style.marginR +
-      ',' +
-      style.marginV +
-      ',' +
-      style.encoding +
-      '\n'
+const formatStyles = (styles) =>
+  Object.entries(styles)
+    .map(([id, style]) =>
+      [
+        `Style: ${id}`,
+        style.fontname,
+        style.fontsize,
+        style.primaryColour,
+        style.secondaryColour,
+        style.outlineColour,
+        style.backColour,
+        style.bold,
+        style.italic,
+        style.underline,
+        style.strikeOut,
+        style.scaleX,
+        style.scaleY,
+        style.spacing,
+        style.angle,
+        style.borderStyle,
+        style.outline,
+        style.shadow,
+        style.alignment,
+        style.marginL,
+        style.marginR,
+        style.marginV,
+        style.encoding,
+      ]
+        .map((s) => s ?? '')
+        .join(','),
     )
-  }, ''),
-)
+    .join('\n')
 
 /**
- * @param {Styles} styles
+ * @param {{ [styleName: string]: Styles }} styles
  * @returns {string}
  */
 function encASSStyles(styles) {
@@ -195,6 +278,7 @@ ${formatStyles(styles)}`
  * @param {number} params.playResY
  * @param {boolean} [params.scaledBorderAndShadow]
  * @param {boolean} params.futureWordWrapping
+ * @returns {string}
  */
 function encASSHeader({ playResX, playResY, scaledBorderAndShadow, futureWordWrapping }) {
   // WrapStyle
@@ -243,3 +327,82 @@ function formatASSTime(seconds) {
     (cs === 0 ? '00' : cs < 10 ? '0' + cs : cs)
   )
 }
+
+/**
+ * @param {EmbeddableSubtitleFontFace[]} fontFaces
+ * @returns {string | undefined}
+ */
+function encFontFaces(fontFaces) {
+  if (fontFaces.length === 0) {
+    return
+  }
+  return [
+    '[Fonts]',
+    ...fontFaces.map((fontFace) => {
+      return [`fontname: ${getFontName(fontFace)}`, ...uuencodeForSSA(fontFace.data)]
+    }),
+  ]
+    .filter((x) => x !== undefined)
+    .flat()
+    .join('\n')
+}
+
+/**
+ * @param {EmbeddableSubtitleFontFace} fontFace
+ */
+function getFontName(fontFace) {
+  const { family, weight, style } = fontFace
+  return `${family}_${weight === 'bold' ? 'B' : ''}${style === 'italic' ? 'I' : ''}0`
+}
+
+/**
+ * UUEncode a binary file (e.g. font file) for SSA/ASS embedding.
+ * @param {Uint8Array} data - Binary content of the file.
+ * @returns {string[]} - Encoded lines, each max 80 characters.
+ */
+function uuencodeForSSA(data) {
+  const result = []
+  const outputLineLength = 80
+
+  let i = 0
+  const fullChunks = Math.floor(data.length / 3)
+
+  // Encode 3-byte chunks
+  while (i < fullChunks * 3) {
+    const b1 = data[i++]
+    const b2 = data[i++]
+    const b3 = data[i++]
+    const n = (b1 << 16) | (b2 << 8) | b3
+
+    const c1 = ((n >> 18) & 0x3f) + 33
+    const c2 = ((n >> 12) & 0x3f) + 33
+    const c3 = ((n >> 6) & 0x3f) + 33
+    const c4 = (n & 0x3f) + 33
+
+    result.push(String.fromCharCode(c1, c2, c3, c4))
+  }
+
+  // Handle remainder
+  const remaining = data.length % 3
+  if (remaining === 1) {
+    const last = data[i] * 0x100
+    const c1 = ((last >> 10) & 0x3f) + 33
+    const c2 = ((last >> 4) & 0x3f) + 33
+    result.push(String.fromCharCode(c1, c2))
+  } else if (remaining === 2) {
+    const last = ((data[i] << 8) | data[i + 1]) * 0x10000
+    const c1 = ((last >> 16) & 0x3f) + 33
+    const c2 = ((last >> 10) & 0x3f) + 33
+    const c3 = ((last >> 4) & 0x3f) + 33
+    result.push(String.fromCharCode(c1, c2, c3))
+  }
+
+  // Break into 80-char lines
+  const finalLines = []
+  const allChars = result.join('')
+  for (let j = 0; j < allChars.length; j += outputLineLength) {
+    finalLines.push(allChars.slice(j, j + outputLineLength))
+  }
+
+  return finalLines
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/lib",
-  "version": "23.11.2",
+  "version": "23.12.1",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "type": "module",
@@ -99,6 +99,7 @@
     "@nxtedition/deepstream.io-client-js": ">=28.1.15",
     "@types/lodash": "^4.17.16",
     "@types/node": "^22.15.1",
+    "canvas": "^3.1.0",
     "eslint": "^9.25.1",
     "eslint-config-prettier": "^10.1.2",
     "eslint-config-standard": "^17.0.0",