libbitsub 1.7.3 → 1.8.0

package/pkg/README.md

@@ -1,6 +1,6 @@
 # libbit(map)sub
 
-High-performance WASM renderer for graphical subtitles (PGS and VobSub), written in Rust.
+High-performance WASM renderer for graphical subtitles (PGS, VobSub, and MKS-embedded VobSub), written in Rust.
 
 Started as a fork of Arcus92's [libpgs-js](https://github.com/Arcus92/libpgs-js), this project was reworked for higher performance and broader format support. It keeps the familiar high-level PGS-oriented API while adding a lower-level parser surface, VobSub support, GPU backends, and worker-backed rendering.
 
@@ -8,6 +8,7 @@ Started as a fork of Arcus92's [libpgs-js](https://github.com/Arcus92/libpgs-js)
 
 - PGS (Blu-ray) subtitle parsing and rendering
 - VobSub (DVD) subtitle parsing and rendering
+- Matroska `.mks` extraction for embedded `S_VOBSUB` tracks
 - WebGPU, WebGL2, and Canvas2D rendering with automatic fallback
 - Worker-backed parsing/rendering for large subtitle files
 - Rich layout controls: scale, horizontal/vertical offsets, alignment, bottom padding, safe area, opacity
@@ -46,15 +47,16 @@ deno add jsr:@altq/libbitsub
 
 ## Worker setup
 
-For best performance, make the generated WASM assets reachable by the browser so the shared worker can load them:
+In most bundler-based projects, no manual worker setup is required. `libbitsub` now resolves the WASM asset relative to the package module URL, so bundlers such as Vite, webpack, and Rollup can emit the asset automatically.
+
+If your app serves package files in a way that does not expose that emitted WASM asset to the browser, you can still provide the legacy public fallback by copying the WASM file to `/libbitsub/libbitsub_bg.wasm`:
 
 ```bash
 mkdir -p public/libbitsub
 cp node_modules/libbitsub/pkg/libbitsub_bg.wasm public/libbitsub/
-cp node_modules/libbitsub/pkg/libbitsub.js public/libbitsub/
 ```
 
-`workerUrl` still exists in the option type for compatibility, but the current implementation creates an inline shared worker and resolves the WASM asset from the package loader. Supplying `workerUrl` does not change runtime behavior.
+The worker is still created inline. `workerUrl` remains in the option type only for compatibility and does not change runtime behavior.
 
 ## Building from source
 
@@ -130,6 +132,12 @@ const renderer = new VobSubRenderer({
   idxUrl: '/subtitles/movie.idx'
 })
 
+const mksRenderer = new VobSubRenderer({
+  video: videoElement,
+  subUrl: '/subtitles/movie.mks',
+  fileName: 'movie.mks'
+})
+
 renderer.setDebandThreshold(64)
 renderer.setDebandRange(15)
 ```
@@ -146,7 +154,7 @@ const renderer = createAutoSubtitleRenderer({
 })
 ```
 
-Automatic detection uses file hints when available and otherwise inspects the binary payload. If the format cannot be identified confidently, it throws instead of silently forcing a parser.
+Automatic detection uses file hints when available and otherwise inspects the binary payload. `.mks` sources are treated as VobSub only when they contain an embedded `S_VOBSUB` track. If the format cannot be identified confidently, it throws instead of silently forcing a parser.
 
 ## Layout controls
 
@@ -194,8 +202,11 @@ Low-level parsers expose the same model:
 ```ts
 import { PgsParser, UnifiedSubtitleParser, VobSubParserLowLevel } from 'libbitsub'
 
+const vob = new VobSubParserLowLevel()
+vob.loadFromMks(new Uint8Array(mksBuffer))
+
 const parser = new UnifiedSubtitleParser()
-const detected = parser.loadAuto({ data: subtitleBytes, fileName: 'track.sup' })
+const detected = parser.loadAuto({ data: subtitleBytes, fileName: 'track.mks' })
 
 console.log(detected)
 console.log(parser.getMetadata())
@@ -210,6 +221,10 @@ Metadata includes:
 - PGS composition count, palette ID, composition state
 - VobSub language, track ID, IDX metadata presence, file position where available
 
+## MKS security and corruption checks
+
+The `.mks` path validates Matroska structure before handing payloads to the VobSub decoder. Embedded subtitle blocks are size-checked, compressed blocks use bounded zlib inflation, and extracted SPU packets are rejected if their declared payload lengths or control offsets are inconsistent. Malformed or oversized `.mks` payloads fail fast instead of being partially decoded.
+
 ## Cache control and prefetching
 
 High-level renderers expose cache helpers:

package/pkg/libbitsub.d.ts

@@ -194,6 +194,10 @@ export class SubtitleRenderer {
      * Load VobSub subtitle data from IDX and SUB.
      */
     loadVobSub(idx_content: string, sub_data: Uint8Array): void;
+    /**
+     * Load VobSub subtitle data from a Matroska subtitle container.
+     */
+    loadVobSubMks(mks_data: Uint8Array): void;
     /**
      * Load VobSub from SUB file only.
      */
@@ -303,6 +307,10 @@ export class VobSubParser {
      * Load VobSub from IDX content and SUB data.
      */
     loadFromData(idx_content: string, sub_data: Uint8Array): void;
+    /**
+     * Load VobSub from a Matroska subtitle container with embedded S_VOBSUB tracks.
+     */
+    loadFromMks(mks_data: Uint8Array): void;
     /**
      * Load VobSub from SUB file only (scans for timestamps).
      */
@@ -414,6 +422,7 @@ export interface InitOutput {
     readonly subtitlerenderer_language: (a: number) => [number, number];
     readonly subtitlerenderer_loadPgs: (a: number, b: number, c: number) => number;
     readonly subtitlerenderer_loadVobSub: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly subtitlerenderer_loadVobSubMks: (a: number, b: number, c: number) => [number, number];
     readonly subtitlerenderer_loadVobSubOnly: (a: number, b: number, c: number) => void;
     readonly subtitlerenderer_new: () => number;
     readonly subtitlerenderer_renderAtIndex: (a: number, b: number) => number;
@@ -441,6 +450,7 @@ export interface InitOutput {
     readonly vobsubparser_hasIdxMetadata: (a: number) => number;
     readonly vobsubparser_language: (a: number) => [number, number];
     readonly vobsubparser_loadFromData: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly vobsubparser_loadFromMks: (a: number, b: number, c: number) => [number, number];
     readonly vobsubparser_loadFromSubOnly: (a: number, b: number, c: number) => void;
     readonly vobsubparser_new: () => number;
     readonly vobsubparser_renderAtIndex: (a: number, b: number) => number;
@@ -458,6 +468,7 @@ export interface InitOutput {
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
     readonly __wbindgen_start: () => void;
 }
 

package/pkg/libbitsub.js

@@ -494,6 +494,18 @@ export class SubtitleRenderer {
         const len1 = WASM_VECTOR_LEN;
         wasm.subtitlerenderer_loadVobSub(this.__wbg_ptr, ptr0, len0, ptr1, len1);
     }
+    /**
+     * Load VobSub subtitle data from a Matroska subtitle container.
+     * @param {Uint8Array} mks_data
+     */
+    loadVobSubMks(mks_data) {
+        const ptr0 = passArray8ToWasm0(mks_data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.subtitlerenderer_loadVobSubMks(this.__wbg_ptr, ptr0, len0);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
     /**
      * Load VobSub from SUB file only.
      * @param {Uint8Array} sub_data
@@ -772,6 +784,18 @@ export class VobSubParser {
         const len1 = WASM_VECTOR_LEN;
         wasm.vobsubparser_loadFromData(this.__wbg_ptr, ptr0, len0, ptr1, len1);
     }
+    /**
+     * Load VobSub from a Matroska subtitle container with embedded S_VOBSUB tracks.
+     * @param {Uint8Array} mks_data
+     */
+    loadFromMks(mks_data) {
+        const ptr0 = passArray8ToWasm0(mks_data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.vobsubparser_loadFromMks(this.__wbg_ptr, ptr0, len0);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
     /**
      * Load VobSub from SUB file only (scans for timestamps).
      * @param {Uint8Array} sub_data
@@ -865,7 +889,7 @@ export function init() {
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,
-        __wbg___wbindgen_throw_5549492daedad139: function(arg0, arg1) {
+        __wbg___wbindgen_throw_81fc77679af83bc6: function(arg0, arg1) {
             throw new Error(getStringFromWasm0(arg0, arg1));
         },
         __wbg_error_a6fa202b58aa1cd3: function(arg0, arg1) {
@@ -879,7 +903,7 @@ function __wbg_get_imports() {
                 wasm.__wbindgen_free(deferred0_0, deferred0_1, 1);
             }
         },
-        __wbg_length_e6e1633fbea6cfa9: function(arg0) {
+        __wbg_length_0c32cb8543c8e4c8: function(arg0) {
             const ret = arg0.length;
             return ret;
         },
@@ -887,22 +911,22 @@ function __wbg_get_imports() {
             const ret = new Error();
             return ret;
         },
-        __wbg_new_from_slice_0bc58e36f82a1b50: function(arg0, arg1) {
+        __wbg_new_from_slice_2580ff33d0d10520: function(arg0, arg1) {
             const ret = new Uint8Array(getArrayU8FromWasm0(arg0, arg1));
             return ret;
         },
-        __wbg_new_with_length_0f3108b57e05ed7c: function(arg0) {
-            const ret = new Uint8Array(arg0 >>> 0);
+        __wbg_new_with_length_6402c1de5dfd4085: function(arg0) {
+            const ret = new Float64Array(arg0 >>> 0);
             return ret;
         },
-        __wbg_new_with_length_4295fc6d4f8fdbb6: function(arg0) {
-            const ret = new Float64Array(arg0 >>> 0);
+        __wbg_new_with_length_9cedd08484b73942: function(arg0) {
+            const ret = new Uint8Array(arg0 >>> 0);
             return ret;
         },
-        __wbg_prototypesetcall_3875d54d12ef2eec: function(arg0, arg1, arg2) {
+        __wbg_prototypesetcall_3e05eb9545565046: function(arg0, arg1, arg2) {
             Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), arg2);
         },
-        __wbg_set_index_aba8326dc4ba779d: function(arg0, arg1, arg2) {
+        __wbg_set_index_e93e681c9c5b6486: function(arg0, arg1, arg2) {
             arg0[arg1 >>> 0] = arg2;
         },
         __wbg_stack_3b0d974bbf31e44f: function(arg0, arg1) {
@@ -912,6 +936,11 @@ function __wbg_get_imports() {
             getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
             getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
         },
+        __wbindgen_cast_0000000000000001: function(arg0, arg1) {
+            // Cast intrinsic for `Ref(String) -> Externref`.
+            const ret = getStringFromWasm0(arg0, arg1);
+            return ret;
+        },
         __wbindgen_init_externref_table: function() {
             const table = wasm.__wbindgen_externrefs;
             const offset = table.grow(4);
@@ -1020,6 +1049,12 @@ function passStringToWasm0(arg, malloc, realloc) {
     return ptr;
 }
 
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
 let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
 cachedTextDecoder.decode();
 const MAX_SAFARI_DECODE_BYTES = 2146435072;

package/pkg/libbitsub_bg.wasm.d.ts

@@ -49,6 +49,7 @@ export const subtitlerenderer_hasIdxMetadata: (a: number) => number;
 export const subtitlerenderer_language: (a: number) => [number, number];
 export const subtitlerenderer_loadPgs: (a: number, b: number, c: number) => number;
 export const subtitlerenderer_loadVobSub: (a: number, b: number, c: number, d: number, e: number) => void;
+export const subtitlerenderer_loadVobSubMks: (a: number, b: number, c: number) => [number, number];
 export const subtitlerenderer_loadVobSubOnly: (a: number, b: number, c: number) => void;
 export const subtitlerenderer_new: () => number;
 export const subtitlerenderer_renderAtIndex: (a: number, b: number) => number;
@@ -76,6 +77,7 @@ export const vobsubparser_getTimestamps: (a: number) => any;
 export const vobsubparser_hasIdxMetadata: (a: number) => number;
 export const vobsubparser_language: (a: number) => [number, number];
 export const vobsubparser_loadFromData: (a: number, b: number, c: number, d: number, e: number) => void;
+export const vobsubparser_loadFromMks: (a: number, b: number, c: number) => [number, number];
 export const vobsubparser_loadFromSubOnly: (a: number, b: number, c: number) => void;
 export const vobsubparser_new: () => number;
 export const vobsubparser_renderAtIndex: (a: number, b: number) => number;
@@ -93,4 +95,5 @@ export const __wbindgen_free: (a: number, b: number, c: number) => void;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_externrefs: WebAssembly.Table;
+export const __externref_table_dealloc: (a: number) => void;
 export const __wbindgen_start: () => void;

package/pkg/package.json

@@ -5,7 +5,7 @@
     "altqx"
   ],
   "description": "High-performance WASM renderer for graphical subtitles (PGS and VobSub)",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "license": "MIT",
   "repository": {
     "type": "git",