libbitsub 1.11.0 → 1.12.1

package/src/integrations/hlsjs.ts

@@ -4,6 +4,8 @@
  * hls.js handles HLS media and WebVTT/IMSC text tracks; use this helper for
  * external PGS/VobSub/MKS bitmap overlays on the same media element.
  *
+ * @module
+ *
  * @example
  * ```ts
  * import Hls from 'hls.js'
@@ -33,8 +35,10 @@ export interface HlsLike {
   }
 }
 
+/** Options for attachBitSubToHls(). */
 export type BitSubHlsOptions = AttachBitSubOptions
 
+/** Handle returned by attachBitSubToHls(). */
 export interface BitSubHlsHandle extends BitSubController {
   /** Underlying hls.js instance. */
   readonly hls: HlsLike
@@ -150,5 +154,7 @@ export function attachBitSubToHls(hls: HlsLike, options: BitSubHlsOptions = {}):
   }
 }
 
+/** Shared attach options and controller types. */
 export type { AttachBitSubOptions, BitSubController, BitSubSourceOptions, BitSubRenderer } from './shared'
+/** Attach or construct a libbitsub controller. */
 export { attachBitSub, createBitSubRenderer } from './shared'

package/src/integrations/index.ts

@@ -1,9 +1,13 @@
 /**
  * Optional player integrations for libbitsub.
- * Prefer deep imports (`libbitsub/videojs`, `libbitsub/shaka`, `libbitsub/hlsjs`, `libbitsub/react`)
- * so unused peer dependencies stay out of your bundle.
+ *
+ * Prefer deep imports (`libbitsub/videojs`, `libbitsub/shaka`, `libbitsub/hlsjs`,
+ * `libbitsub/react`) so unused peer dependencies stay out of your bundle.
+ *
+ * @module
  */
 
+/** Shared attach/create helpers used by every player adapter. */
 export {
   attachBitSub,
   createBitSubRenderer,
@@ -13,6 +17,7 @@ export {
   type BitSubSourceOptions
 } from './shared'
 
+/** Video.js plugin and player typings. */
 export {
   registerBitSubPlugin,
   type BitSubVideoJsApi,
@@ -22,10 +27,13 @@ export {
   type VideoJsPlayerLike
 } from './videojs'
 
+/** Shaka Player adapter. */
 export { attachBitSubToShaka, type BitSubShakaHandle, type BitSubShakaOptions, type ShakaPlayerLike } from './shaka'
 
+/** hls.js adapter. */
 export { attachBitSubToHls, type BitSubHlsHandle, type BitSubHlsOptions, type HlsLike } from './hlsjs'
 
+/** React hook and overlay component. */
 export {
   BitSubOverlay,
   useBitSub,

package/src/integrations/react.tsx

@@ -1,7 +1,9 @@
 /**
  * Optional React bindings for libbitsub bitmap subtitles.
  *
- * Peer dependency: react >= 18
+ * Peer dependency: react >= 18.
+ *
+ * @module
  *
  * @example
  * ```tsx
@@ -26,13 +28,16 @@ import { useEffect, useRef, useState, type CSSProperties, type ReactElement, typ
 import { attachBitSub, type AttachBitSubOptions, type BitSubController, type BitSubSourceOptions } from './shared'
 import type { SubtitleDisplaySettings, SubtitleDiagnosticWarning, SubtitleRendererEvent } from '../wrapper'
 
+/** Subtitle source fields accepted by the React bindings. */
 export type BitSubReactSource = BitSubSourceOptions
 
+/** Options for useBitSub(). */
 export interface UseBitSubOptions extends BitSubReactSource {
   /** When false, do not load even if source fields are set. Default true. */
   enabled?: boolean
 }
 
+/** Return value of useBitSub(). */
 export interface UseBitSubResult {
   controller: BitSubController | null
   error: Error | null
@@ -48,6 +53,10 @@ function sourceKey(source: BitSubReactSource | null | undefined): string {
     hasIdxContent: Boolean(source.idxContent),
     cacheLimit: source.cacheLimit ?? null,
     timeOffset: source.timeOffset ?? null,
+    frameAwareSync: source.frameAwareSync ?? null,
+    backend: source.backend ?? null,
+    devicePixelRatioCap: source.devicePixelRatioCap ?? null,
+    offscreenRender: source.offscreenRender ?? null,
     streamingLoad: source.streamingLoad ?? null,
     rangeRequests: source.rangeRequests ?? null,
     debug: source.debug ?? null,
@@ -83,6 +92,8 @@ export function useBitSub(
   const enabled = options?.enabled !== false
   const key = sourceKey(options)
   const displaySettings = options?.displaySettings
+  const container = options?.container
+  const canvas = options?.canvas
 
   useEffect(() => {
     setError(null)
@@ -135,7 +146,7 @@ export function useBitSub(
       setController(null)
     }
     // key captures source identity; callback props stay fresh via refs
-  }, [videoRef, key, enabled])
+  }, [videoRef, key, enabled, container, canvas])
 
   useEffect(() => {
     if (displaySettings) {
@@ -146,6 +157,7 @@ export function useBitSub(
   return { controller, error }
 }
 
+/** Props for BitSubOverlay. */
 export interface BitSubOverlayProps extends UseBitSubOptions {
   videoRef: RefObject<HTMLVideoElement | null>
   /** Optional class name applied to a zero-size host span for debugging. */
@@ -165,6 +177,9 @@ export function BitSubOverlay(props: BitSubOverlayProps): ReactElement | null {
   return <span className={className} style={{ display: 'none', ...style }} aria-hidden='true' />
 }
 
+/** Shared attach options and controller types. */
 export type { AttachBitSubOptions, BitSubController, BitSubSourceOptions, BitSubRenderer } from './shared'
+/** Attach or construct a libbitsub controller. */
 export { attachBitSub, createBitSubRenderer } from './shared'
+/** Runtime overlay display settings. */
 export type { SubtitleDisplaySettings }

package/src/integrations/shaka.ts

@@ -4,6 +4,8 @@
  * Bitmap PGS/VobSub tracks are not native Shaka text tracks — this helper
  * overlays libbitsub on the player media element.
  *
+ * @module
+ *
  * @example
  * ```ts
  * import shaka from 'shaka-player'
@@ -26,8 +28,10 @@ export interface ShakaPlayerLike {
   removeEventListener?(type: string, listener: (...args: unknown[]) => void): void
 }
 
+/** Options for attachBitSubToShaka(). */
 export type BitSubShakaOptions = AttachBitSubOptions
 
+/** Handle returned by attachBitSubToShaka(). */
 export interface BitSubShakaHandle extends BitSubController {
   /** Underlying Shaka player reference. */
   readonly player: ShakaPlayerLike
@@ -88,5 +92,7 @@ export function attachBitSubToShaka(player: ShakaPlayerLike, options: BitSubShak
   }
 }
 
+/** Shared attach options and controller types. */
 export type { AttachBitSubOptions, BitSubController, BitSubSourceOptions, BitSubRenderer } from './shared'
+/** Attach or construct a libbitsub controller. */
 export { attachBitSub, createBitSubRenderer } from './shared'

package/src/integrations/shared.ts

@@ -6,6 +6,7 @@
 import {
   createAutoSubtitleRenderer,
   type AutoVideoSubtitleOptions,
+  type DvbRenderer,
   type PgsRenderer,
   type SubtitleDisplaySettings,
   type SubtitleRendererStats,
@@ -13,11 +14,12 @@ import {
 } from '../wrapper'
 
 /** High-level renderer produced by integrations. */
-export type BitSubRenderer = PgsRenderer | VobSubRenderer
+export type BitSubRenderer = PgsRenderer | VobSubRenderer | DvbRenderer
 
 /** Subtitle source + renderer options without a bound video element. */
 export type BitSubSourceOptions = Omit<AutoVideoSubtitleOptions, 'video'>
 
+/** Handle returned by player adapters. */
 export interface BitSubController {
   /** Active renderer, or null when no track is loaded. */
   readonly renderer: BitSubRenderer | null
@@ -39,6 +41,7 @@ export interface BitSubController {
   setVideo(video: HTMLVideoElement | null): void
 }
 
+/** Options for attachBitSub(). */
 export interface AttachBitSubOptions extends BitSubSourceOptions {
   /** When false, skip the initial load even if source fields are present. Default true. */
   autoLoad?: boolean

package/src/integrations/videojs.ts

@@ -1,6 +1,8 @@
 /**
  * Optional Video.js plugin for libbitsub bitmap subtitles.
  *
+ * @module
+ *
  * @example
  * ```ts
  * import videojs from 'video.js'
@@ -26,24 +28,29 @@ export interface VideoJsPlayerLike {
   trigger?(event: string, data?: unknown): void
 }
 
+/** Minimal Video.js plugin instance surface. */
 export interface VideoJsPluginBase {
   player: VideoJsPlayerLike
   options_: unknown
   dispose(): void
 }
 
+/** Minimal Video.js plugin constructor surface. */
 export interface VideoJsPluginConstructor {
   new (player: VideoJsPlayerLike, options?: unknown): VideoJsPluginBase
   prototype: VideoJsPluginBase
 }
 
+/** Minimal video.js factory used by the plugin. */
 export interface VideoJsLike {
   getPlugin(name: string): VideoJsPluginConstructor
   registerPlugin(name: string, plugin: unknown): void
 }
 
+/** Options for player.bitsub(). */
 export type BitSubVideoJsOptions = AttachBitSubOptions
 
+/** Video.js player.bitsub() API. */
 export interface BitSubVideoJsApi {
   /** Active controller, if any. */
   controller(): BitSubController | null
@@ -196,5 +203,7 @@ export type VideoJsBitSubPlayer = VideoJsPlayerLike & {
   bitsub(options?: BitSubVideoJsOptions): BitSubVideoJsApi
 }
 
+/** Shared attach options and controller types. */
 export type { AttachBitSubOptions, BitSubController, BitSubSourceOptions, BitSubRenderer } from './shared'
+/** Attach or construct a libbitsub controller. */
 export { attachBitSub, createBitSubRenderer } from './shared'

package/src/wrapper.ts

@@ -8,6 +8,7 @@ export type {
   AssetFetchStrategy,
   AutoSubtitleSource,
   AutoVideoSubtitleOptions,
+  LiveSubtitleRenderer,
   OpenedSubtitles,
   SubtitleAspectMode,
   SubtitleCacheStats,
@@ -34,6 +35,10 @@ export type {
   SubtitleRendererBackend,
   SubtitleRendererEvent,
   SubtitleRendererStatsSnapshot,
+  SubtitleSynchronizationMode,
+  SubtitleStreamChunk,
+  RuntimeCapabilities,
+  SubtitlePresentPath,
   VideoSubtitleOptions,
   VideoVobSubOptions,
   RenderResult,
@@ -51,14 +56,29 @@ export { warmup, ready, isWorkerAvailable, isWorkerReady } from './ts/worker'
 // Re-export WebGPU utilities
 export { isWebGPUSupported } from './ts/webgpu-renderer'
 
+export {
+  getRuntimeCapabilities,
+  canUseWorkerOffscreenRender,
+  isOffscreenCanvasSupported,
+  isOffscreenCanvas2DSupported,
+  isTransferControlToOffscreenSupported,
+  isCanvas2DSupported
+} from './ts/capabilities'
+
 // Re-export parsers
-export { PgsParser, VobSubParserLowLevel, UnifiedSubtitleParser, openSubtitles } from './ts/parsers'
+export { PgsParser, DvbParser, VobSubParserLowLevel, UnifiedSubtitleParser, openSubtitles } from './ts/parsers'
 
 // Re-export frame export helpers
 export { renderFrameData, toBlob, toCanvas, toImageBitmap } from './ts/frame-export'
 
 // Re-export renderers
-export { PgsRenderer, VobSubRenderer, createAutoSubtitleRenderer, type SubtitleRendererStats } from './ts/renderers'
+export {
+  PgsRenderer,
+  DvbRenderer,
+  VobSubRenderer,
+  createAutoSubtitleRenderer,
+  type SubtitleRendererStats
+} from './ts/renderers'
 
 // Re-export format detection utilities
 export { detectSubtitleFormat } from './ts/utils'