@nxtedition/lib 22.0.12 → 22.0.13

package/ass.js

@@ -1,16 +1,68 @@
+// @ts-check
 import fp from 'lodash/fp.js'
 
 const BASE_WIDTH = 1920
 const BASE_HEIGHT = 1080
 
-export function encodeASS(events, { styles = {}, width = BASE_WIDTH, height = BASE_HEIGHT } = {}) {
+/**
+ * @typedef {object} SubtitleEvent
+ * @property {number} start
+ * @property {number | null} [duration]
+ * @property {number | null} [end]
+ * @property {string | null} [style]
+ * @property {string | null} [text]
+ *
+ * @typedef {object} Styles
+ * @property {string} [name]
+ * @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]
+ * @property {string} [scaleX]
+ * @property {string} [scaleY]
+ * @property {string} [spacing]
+ * @property {string} [angle]
+ * @property {string} [borderStyle]
+ * @property {string} [outline]
+ * @property {string} [shadow]
+ * @property {string} [alignment]
+ * @property {string} [marginL]
+ * @property {string} [marginR]
+ * @property {string} [marginV]
+ * @property {string} [encoding]
+ *
+ * @typedef {object} Options
+ * @property {Styles} [styles]
+ * @property {number} [width]
+ * @property {number} [height]
+ * @property {boolean} [scaledBorderAndShadow] TODO: default to true when all client styles depend on it?
+ */
+
+/**
+ * @param {SubtitleEvent[]} events
+ * @param {Options} [options]
+ * @returns {string}
+ */
+export function encodeASS(
+  events,
+  { styles = {}, width = BASE_WIDTH, height = BASE_HEIGHT, scaledBorderAndShadow = false } = {},
+) {
   return [
-    encASSHeader({ width, height }),
-    encASSStyles({ styles, width, height }),
+    encASSHeader({ width, height, scaledBorderAndShadow }),
+    encASSStyles(styles),
     encASSEvents(events),
   ].join('\n')
 }
 
+/**
+ * @param {SubtitleEvent[]} events
+ */
 function formatDialogues(events) {
   let s = ''
   for (const { start, duration, end = duration != null ? start + duration : null, text, style } of [
@@ -25,12 +77,18 @@ function formatDialogues(events) {
   return s
 }
 
+/**
+ * @param {SubtitleEvent[]} events
+ */
 function encASSEvents(events) {
   return `[Events]
 Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
 ${formatDialogues(events)}`
 }
 
+/**
+ * @param {Styles} styles
+ */
 const formatStyles = fp.pipe(
   fp.entries,
   fp.reduce((s, [id, style]) => {
@@ -87,40 +145,46 @@ const formatStyles = fp.pipe(
   }, ''),
 )
 
-function encASSStyles({ styles, width, height }) {
-  const scaledStyles = {}
-
-  for (const [id, style] of Object.entries(styles)) {
-    scaledStyles[id] = { ...style }
-    for (const key of ['fontsize', 'marginV', 'marginL', 'marginR']) {
-      const scale = key === 'fontsize' ? height / BASE_HEIGHT : width / BASE_WIDTH
-
-      if (typeof style[key] === 'string') {
-        const scaled = Number(style[key]) * scale
-        scaledStyles[id][key] = String(Math.round(scaled * 10) / 10)
-      }
-    }
-  }
-
+/**
+ * @param {Styles} styles
+ * @returns {string}
+ */
+function encASSStyles(styles) {
   return `[V4+ Styles]
 Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
-${formatStyles(scaledStyles)}`
+${formatStyles(styles)}`
 }
 
-function encASSHeader({ width, height }) {
+/**
+ * @param {object} params
+ * @param {number} [params.width]
+ * @param {number} [params.height]
+ * @param {boolean} [params.scaledBorderAndShadow]
+ */
+function encASSHeader({ width, height, scaledBorderAndShadow }) {
+  const scale = typeof width === 'number' ? BASE_WIDTH / width : 1
   // WrapStyle
   // 0: smart wrapping, lines are evenly broken
   // 1: end-of-line word wrapping, only \N breaks
   // 2: no word wrapping, \n \N both breaks
   // 3: same as 0, but lower line gets wider.
-  return `[Script Info]
-ScriptType: v4.00+
-PlayResX: ${width || BASE_WIDTH}
-PlayResY: ${height || BASE_HEIGHT}
-WrapStyle: 1
-`
+  const header = [
+    '[Script Info]',
+    'ScriptType: v4.00+',
+    `PlayResX: ${scale * (width || BASE_WIDTH)}`,
+    `PlayResY: ${scale * (height || BASE_HEIGHT)}`,
+    'WrapStyle: 1',
+  ]
+  if (scaledBorderAndShadow) {
+    header.push('ScaledBorderAndShadow: Yes')
+  }
+  return `${header.join('\n')}\n`
 }
 
+/**
+ * @param {number | null | undefined} seconds
+ * @returns {string}
+ */
 function formatASSTime(seconds) {
   if (seconds == null) {
     return ''

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/lib",
-  "version": "22.0.12",
+  "version": "22.0.13",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "type": "module",