libbitsub 1.4.1 → 1.5.0

package/pkg/libbitsub.d.ts

@@ -1,243 +1,264 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/**
+ * PGS subtitle parser and renderer exposed to JavaScript.
+ */
 export class PgsParser {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Clear the internal cache.
-   */
-  clearCache(): void;
-  /**
-   * Get all timestamps in milliseconds as a Float64Array.
-   */
-  getTimestamps(): Float64Array;
-  /**
-   * Render subtitle at the given index and return RGBA data.
-   * Returns null if index is invalid or no subtitle data.
-   */
-  renderAtIndex(index: number): SubtitleFrame | undefined;
-  /**
-   * Find the display set index for a given timestamp in milliseconds.
-   */
-  findIndexAtTimestamp(time_ms: number): number;
-  /**
-   * Create a new PGS parser.
-   */
-  constructor();
-  /**
-   * Parse a PGS file from binary data.
-   * Returns the number of display sets parsed.
-   */
-  parse(data: Uint8Array): number;
-  /**
-   * Get the number of display sets.
-   */
-  readonly count: number;
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Clear the internal cache.
+     */
+    clearCache(): void;
+    /**
+     * Find the display set index for a given timestamp in milliseconds.
+     */
+    findIndexAtTimestamp(time_ms: number): number;
+    /**
+     * Get all timestamps in milliseconds as a Float64Array.
+     */
+    getTimestamps(): Float64Array;
+    /**
+     * Create a new PGS parser.
+     */
+    constructor();
+    /**
+     * Parse a PGS file from binary data.
+     * Returns the number of display sets parsed.
+     */
+    parse(data: Uint8Array): number;
+    /**
+     * Render subtitle at the given index and return RGBA data.
+     * Returns null if index is invalid or no subtitle data.
+     */
+    renderAtIndex(index: number): SubtitleFrame | undefined;
+    /**
+     * Get the number of display sets.
+     */
+    readonly count: number;
 }
 
+/**
+ * Unified render result for both formats.
+ */
 export class RenderResult {
-  private constructor();
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Get composition X position at index.
-   */
-  getCompositionX(index: number): number;
-  /**
-   * Get composition Y position at index.
-   */
-  getCompositionY(index: number): number;
-  /**
-   * Get composition RGBA data at index.
-   */
-  getCompositionRgba(index: number): Uint8Array;
-  /**
-   * Get composition width at index.
-   */
-  getCompositionWidth(index: number): number;
-  /**
-   * Get composition height at index.
-   */
-  getCompositionHeight(index: number): number;
-  readonly screenWidth: number;
-  readonly screenHeight: number;
-  /**
-   * Get the number of composition elements.
-   */
-  readonly compositionCount: number;
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get composition height at index.
+     */
+    getCompositionHeight(index: number): number;
+    /**
+     * Get composition RGBA data at index.
+     */
+    getCompositionRgba(index: number): Uint8Array;
+    /**
+     * Get composition width at index.
+     */
+    getCompositionWidth(index: number): number;
+    /**
+     * Get composition X position at index.
+     */
+    getCompositionX(index: number): number;
+    /**
+     * Get composition Y position at index.
+     */
+    getCompositionY(index: number): number;
+    /**
+     * Get the number of composition elements.
+     */
+    readonly compositionCount: number;
+    readonly screenHeight: number;
+    readonly screenWidth: number;
 }
 
+/**
+ * A single subtitle composition element.
+ */
 export class SubtitleComposition {
-  private constructor();
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Get RGBA pixel data as Uint8Array.
-   */
-  getRgba(): Uint8Array;
-  readonly x: number;
-  readonly y: number;
-  readonly width: number;
-  readonly height: number;
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get RGBA pixel data as Uint8Array.
+     */
+    getRgba(): Uint8Array;
+    readonly height: number;
+    readonly width: number;
+    readonly x: number;
+    readonly y: number;
 }
 
 /**
  * Subtitle format type.
  */
 export enum SubtitleFormat {
-  /**
-   * PGS (Blu-ray) subtitle format
-   */
-  Pgs = 0,
-  /**
-   * VobSub (DVD) subtitle format
-   */
-  VobSub = 1,
+    /**
+     * PGS (Blu-ray) subtitle format
+     */
+    Pgs = 0,
+    /**
+     * VobSub (DVD) subtitle format
+     */
+    VobSub = 1,
 }
 
+/**
+ * A complete subtitle frame with all compositions.
+ */
 export class SubtitleFrame {
-  private constructor();
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Get a composition by index.
-   */
-  getComposition(index: number): SubtitleComposition | undefined;
-  /**
-   * Get the number of compositions.
-   */
-  readonly compositionCount: number;
-  readonly width: number;
-  readonly height: number;
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get a composition by index.
+     */
+    getComposition(index: number): SubtitleComposition | undefined;
+    /**
+     * Get the number of compositions.
+     */
+    readonly compositionCount: number;
+    readonly height: number;
+    readonly width: number;
 }
 
+/**
+ * Unified subtitle renderer for both PGS and VobSub formats.
+ */
 export class SubtitleRenderer {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Clear internal caches.
-   */
-  clearCache(): void;
-  /**
-   * Load VobSub subtitle data from IDX and SUB.
-   */
-  loadVobSub(idx_content: string, sub_data: Uint8Array): void;
-  /**
-   * Get all timestamps in milliseconds.
-   */
-  getTimestamps(): Float64Array;
-  /**
-   * Render subtitle at the given index.
-   * Returns a unified RenderResult or null.
-   */
-  renderAtIndex(index: number): RenderResult | undefined;
-  /**
-   * Load VobSub from SUB file only.
-   */
-  loadVobSubOnly(sub_data: Uint8Array): void;
-  /**
-   * Render subtitle at the given timestamp in seconds.
-   */
-  renderAtTimestamp(time_seconds: number): RenderResult | undefined;
-  /**
-   * Find the subtitle index for a given timestamp in milliseconds.
-   */
-  findIndexAtTimestamp(time_ms: number): number;
-  /**
-   * Create a new subtitle renderer.
-   */
-  constructor();
-  /**
-   * Dispose of all resources.
-   */
-  dispose(): void;
-  /**
-   * Load PGS subtitle data.
-   */
-  loadPgs(data: Uint8Array): number;
-  /**
-   * Get the number of subtitle entries.
-   */
-  readonly count: number;
-  /**
-   * Get the current subtitle format.
-   */
-  readonly format: SubtitleFormat | undefined;
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Clear internal caches.
+     */
+    clearCache(): void;
+    /**
+     * Dispose of all resources.
+     */
+    dispose(): void;
+    /**
+     * Find the subtitle index for a given timestamp in milliseconds.
+     */
+    findIndexAtTimestamp(time_ms: number): number;
+    /**
+     * Get all timestamps in milliseconds.
+     */
+    getTimestamps(): Float64Array;
+    /**
+     * Load PGS subtitle data.
+     */
+    loadPgs(data: Uint8Array): number;
+    /**
+     * Load VobSub subtitle data from IDX and SUB.
+     */
+    loadVobSub(idx_content: string, sub_data: Uint8Array): void;
+    /**
+     * Load VobSub from SUB file only.
+     */
+    loadVobSubOnly(sub_data: Uint8Array): void;
+    /**
+     * Create a new subtitle renderer.
+     */
+    constructor();
+    /**
+     * Render subtitle at the given index.
+     * Returns a unified RenderResult or null.
+     */
+    renderAtIndex(index: number): RenderResult | undefined;
+    /**
+     * Render subtitle at the given timestamp in seconds.
+     */
+    renderAtTimestamp(time_seconds: number): RenderResult | undefined;
+    /**
+     * Get the number of subtitle entries.
+     */
+    readonly count: number;
+    /**
+     * Get the current subtitle format.
+     */
+    readonly format: SubtitleFormat | undefined;
 }
 
+/**
+ * A VobSub subtitle frame.
+ */
 export class VobSubFrame {
-  private constructor();
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Get RGBA pixel data as Uint8Array.
-   */
-  getRgba(): Uint8Array;
-  readonly screenWidth: number;
-  readonly screenHeight: number;
-  readonly x: number;
-  readonly y: number;
-  readonly width: number;
-  readonly height: number;
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get RGBA pixel data as Uint8Array.
+     */
+    getRgba(): Uint8Array;
+    readonly height: number;
+    readonly screenHeight: number;
+    readonly screenWidth: number;
+    readonly width: number;
+    readonly x: number;
+    readonly y: number;
 }
 
+/**
+ * VobSub subtitle parser and renderer exposed to JavaScript.
+ */
 export class VobSubParser {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Clear the internal cache.
-   */
-  clearCache(): void;
-  /**
-   * Get all timestamps in milliseconds as a Float64Array.
-   */
-  getTimestamps(): Float64Array;
-  /**
-   * Load VobSub from IDX content and SUB data.
-   */
-  loadFromData(idx_content: string, sub_data: Uint8Array): void;
-  /**
-   * Render subtitle at the given index and return RGBA data.
-   */
-  renderAtIndex(index: number): VobSubFrame | undefined;
-  /**
-   * Set the deband sample range in pixels (default: 15).
-   */
-  setDebandRange(range: number): void;
-  /**
-   * Load VobSub from SUB file only (scans for timestamps).
-   */
-  loadFromSubOnly(sub_data: Uint8Array): void;
-  /**
-   * Enable or disable debanding.
-   */
-  setDebandEnabled(enabled: boolean): void;
-  /**
-   * Set the deband threshold (0.0-255.0, default: 64.0).
-   */
-  setDebandThreshold(threshold: number): void;
-  /**
-   * Find the subtitle index for a given timestamp in milliseconds.
-   * Returns -1 if no subtitle should be displayed at this time.
-   */
-  findIndexAtTimestamp(time_ms: number): number;
-  /**
-   * Create a new VobSub parser.
-   */
-  constructor();
-  /**
-   * Dispose of all resources.
-   */
-  dispose(): void;
-  /**
-   * Check if debanding is enabled.
-   */
-  readonly debandEnabled: boolean;
-  /**
-   * Get the number of subtitle entries.
-   */
-  readonly count: number;
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Clear the internal cache.
+     */
+    clearCache(): void;
+    /**
+     * Dispose of all resources.
+     */
+    dispose(): void;
+    /**
+     * Find the subtitle index for a given timestamp in milliseconds.
+     * Returns -1 if no subtitle should be displayed at this time.
+     */
+    findIndexAtTimestamp(time_ms: number): number;
+    /**
+     * Get all timestamps in milliseconds as a Float64Array.
+     */
+    getTimestamps(): Float64Array;
+    /**
+     * Load VobSub from IDX content and SUB data.
+     */
+    loadFromData(idx_content: string, sub_data: Uint8Array): void;
+    /**
+     * Load VobSub from SUB file only (scans for timestamps).
+     */
+    loadFromSubOnly(sub_data: Uint8Array): void;
+    /**
+     * Create a new VobSub parser.
+     */
+    constructor();
+    /**
+     * Render subtitle at the given index and return RGBA data.
+     */
+    renderAtIndex(index: number): VobSubFrame | undefined;
+    /**
+     * Enable or disable debanding.
+     */
+    setDebandEnabled(enabled: boolean): void;
+    /**
+     * Set the deband sample range in pixels (default: 15).
+     */
+    setDebandRange(range: number): void;
+    /**
+     * Set the deband threshold (0.0-255.0, default: 64.0).
+     */
+    setDebandThreshold(threshold: number): void;
+    /**
+     * Get the number of subtitle entries.
+     */
+    readonly count: number;
+    /**
+     * Check if debanding is enabled.
+     */
+    readonly debandEnabled: boolean;
 }
 
 /**
@@ -248,96 +269,96 @@ export function init(): void;
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly __wbg_pgsparser_free: (a: number, b: number) => void;
-  readonly __wbg_renderresult_free: (a: number, b: number) => void;
-  readonly __wbg_subtitlecomposition_free: (a: number, b: number) => void;
-  readonly __wbg_subtitlerenderer_free: (a: number, b: number) => void;
-  readonly __wbg_vobsubframe_free: (a: number, b: number) => void;
-  readonly __wbg_vobsubparser_free: (a: number, b: number) => void;
-  readonly init: () => void;
-  readonly pgsparser_clearCache: (a: number) => void;
-  readonly pgsparser_count: (a: number) => number;
-  readonly pgsparser_findIndexAtTimestamp: (a: number, b: number) => number;
-  readonly pgsparser_getTimestamps: (a: number) => any;
-  readonly pgsparser_new: () => number;
-  readonly pgsparser_parse: (a: number, b: number, c: number) => number;
-  readonly pgsparser_renderAtIndex: (a: number, b: number) => number;
-  readonly renderresult_compositionCount: (a: number) => number;
-  readonly renderresult_getCompositionHeight: (a: number, b: number) => number;
-  readonly renderresult_getCompositionRgba: (a: number, b: number) => any;
-  readonly renderresult_getCompositionWidth: (a: number, b: number) => number;
-  readonly renderresult_getCompositionX: (a: number, b: number) => number;
-  readonly renderresult_getCompositionY: (a: number, b: number) => number;
-  readonly renderresult_screenHeight: (a: number) => number;
-  readonly renderresult_screenWidth: (a: number) => number;
-  readonly subtitlecomposition_getRgba: (a: number) => any;
-  readonly subtitlecomposition_height: (a: number) => number;
-  readonly subtitlecomposition_width: (a: number) => number;
-  readonly subtitlecomposition_x: (a: number) => number;
-  readonly subtitlecomposition_y: (a: number) => number;
-  readonly subtitleframe_getComposition: (a: number, b: number) => number;
-  readonly subtitlerenderer_clearCache: (a: number) => void;
-  readonly subtitlerenderer_count: (a: number) => number;
-  readonly subtitlerenderer_dispose: (a: number) => void;
-  readonly subtitlerenderer_findIndexAtTimestamp: (a: number, b: number) => number;
-  readonly subtitlerenderer_format: (a: number) => number;
-  readonly subtitlerenderer_getTimestamps: (a: number) => any;
-  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_loadVobSubOnly: (a: number, b: number, c: number) => void;
-  readonly subtitlerenderer_new: () => number;
-  readonly subtitlerenderer_renderAtIndex: (a: number, b: number) => number;
-  readonly subtitlerenderer_renderAtTimestamp: (a: number, b: number) => number;
-  readonly vobsubframe_getRgba: (a: number) => any;
-  readonly vobsubframe_height: (a: number) => number;
-  readonly vobsubframe_screenHeight: (a: number) => number;
-  readonly vobsubframe_screenWidth: (a: number) => number;
-  readonly vobsubframe_width: (a: number) => number;
-  readonly vobsubframe_x: (a: number) => number;
-  readonly vobsubframe_y: (a: number) => number;
-  readonly vobsubparser_clearCache: (a: number) => void;
-  readonly vobsubparser_count: (a: number) => number;
-  readonly vobsubparser_debandEnabled: (a: number) => number;
-  readonly vobsubparser_dispose: (a: number) => void;
-  readonly vobsubparser_findIndexAtTimestamp: (a: number, b: number) => number;
-  readonly vobsubparser_getTimestamps: (a: number) => any;
-  readonly vobsubparser_loadFromData: (a: number, b: number, c: number, d: number, e: number) => void;
-  readonly vobsubparser_loadFromSubOnly: (a: number, b: number, c: number) => void;
-  readonly vobsubparser_new: () => number;
-  readonly vobsubparser_renderAtIndex: (a: number, b: number) => number;
-  readonly vobsubparser_setDebandEnabled: (a: number, b: number) => void;
-  readonly vobsubparser_setDebandRange: (a: number, b: number) => void;
-  readonly vobsubparser_setDebandThreshold: (a: number, b: number) => void;
-  readonly __wbg_subtitleframe_free: (a: number, b: number) => void;
-  readonly subtitleframe_width: (a: number) => number;
-  readonly subtitleframe_height: (a: number) => number;
-  readonly subtitleframe_compositionCount: (a: number) => number;
-  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
-  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 __wbindgen_start: () => void;
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_pgsparser_free: (a: number, b: number) => void;
+    readonly __wbg_renderresult_free: (a: number, b: number) => void;
+    readonly __wbg_subtitlecomposition_free: (a: number, b: number) => void;
+    readonly __wbg_subtitlerenderer_free: (a: number, b: number) => void;
+    readonly __wbg_vobsubframe_free: (a: number, b: number) => void;
+    readonly __wbg_vobsubparser_free: (a: number, b: number) => void;
+    readonly init: () => void;
+    readonly pgsparser_clearCache: (a: number) => void;
+    readonly pgsparser_count: (a: number) => number;
+    readonly pgsparser_findIndexAtTimestamp: (a: number, b: number) => number;
+    readonly pgsparser_getTimestamps: (a: number) => any;
+    readonly pgsparser_new: () => number;
+    readonly pgsparser_parse: (a: number, b: number, c: number) => number;
+    readonly pgsparser_renderAtIndex: (a: number, b: number) => number;
+    readonly renderresult_compositionCount: (a: number) => number;
+    readonly renderresult_getCompositionHeight: (a: number, b: number) => number;
+    readonly renderresult_getCompositionRgba: (a: number, b: number) => any;
+    readonly renderresult_getCompositionWidth: (a: number, b: number) => number;
+    readonly renderresult_getCompositionX: (a: number, b: number) => number;
+    readonly renderresult_getCompositionY: (a: number, b: number) => number;
+    readonly renderresult_screenHeight: (a: number) => number;
+    readonly renderresult_screenWidth: (a: number) => number;
+    readonly subtitlecomposition_getRgba: (a: number) => any;
+    readonly subtitlecomposition_height: (a: number) => number;
+    readonly subtitlecomposition_width: (a: number) => number;
+    readonly subtitlecomposition_x: (a: number) => number;
+    readonly subtitlecomposition_y: (a: number) => number;
+    readonly subtitleframe_getComposition: (a: number, b: number) => number;
+    readonly subtitlerenderer_clearCache: (a: number) => void;
+    readonly subtitlerenderer_count: (a: number) => number;
+    readonly subtitlerenderer_dispose: (a: number) => void;
+    readonly subtitlerenderer_findIndexAtTimestamp: (a: number, b: number) => number;
+    readonly subtitlerenderer_format: (a: number) => number;
+    readonly subtitlerenderer_getTimestamps: (a: number) => any;
+    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_loadVobSubOnly: (a: number, b: number, c: number) => void;
+    readonly subtitlerenderer_new: () => number;
+    readonly subtitlerenderer_renderAtIndex: (a: number, b: number) => number;
+    readonly subtitlerenderer_renderAtTimestamp: (a: number, b: number) => number;
+    readonly vobsubframe_getRgba: (a: number) => any;
+    readonly vobsubframe_height: (a: number) => number;
+    readonly vobsubframe_screenHeight: (a: number) => number;
+    readonly vobsubframe_screenWidth: (a: number) => number;
+    readonly vobsubframe_width: (a: number) => number;
+    readonly vobsubframe_x: (a: number) => number;
+    readonly vobsubframe_y: (a: number) => number;
+    readonly vobsubparser_clearCache: (a: number) => void;
+    readonly vobsubparser_count: (a: number) => number;
+    readonly vobsubparser_debandEnabled: (a: number) => number;
+    readonly vobsubparser_dispose: (a: number) => void;
+    readonly vobsubparser_findIndexAtTimestamp: (a: number, b: number) => number;
+    readonly vobsubparser_getTimestamps: (a: number) => any;
+    readonly vobsubparser_loadFromData: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly vobsubparser_loadFromSubOnly: (a: number, b: number, c: number) => void;
+    readonly vobsubparser_new: () => number;
+    readonly vobsubparser_renderAtIndex: (a: number, b: number) => number;
+    readonly vobsubparser_setDebandEnabled: (a: number, b: number) => void;
+    readonly vobsubparser_setDebandRange: (a: number, b: number) => void;
+    readonly vobsubparser_setDebandThreshold: (a: number, b: number) => void;
+    readonly __wbg_subtitleframe_free: (a: number, b: number) => void;
+    readonly subtitleframe_width: (a: number) => number;
+    readonly subtitleframe_height: (a: number) => number;
+    readonly subtitleframe_compositionCount: (a: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    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 __wbindgen_start: () => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
 
 /**
-* Instantiates the given `module`, which can either be bytes or
-* a precompiled `WebAssembly.Module`.
-*
-* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
-*
-* @returns {InitOutput}
-*/
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
 export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
 
 /**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
-*
-* @returns {Promise<InitOutput>}
-*/
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
 export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;