akarisub 0.2.2 → 1.0.1

package/src/ts/types.ts

@@ -1,397 +0,0 @@
-/**
- * Type definitions for AkariSub TypeScript implementation.
- */
-
-// =============================================================================
-// ASS/SSA Subtitle Types
-// =============================================================================
-
-/** ASS Event (dialogue/subtitle entry) */
-export interface ASSEvent {
-  /** Start Time of the Event (in milliseconds) */
-  Start: number
-  /** Duration of the Event (in milliseconds) */
-  Duration: number
-  /** Style name */
-  Style: string
-  /** Character name (for information only) */
-  Name: string
-  /** Left Margin override in pixels */
-  MarginL: number
-  /** Right Margin override in pixels */
-  MarginR: number
-  /** Bottom Margin override in pixels */
-  MarginV: number
-  /** Transition Effect */
-  Effect: string
-  /** Subtitle Text */
-  Text: string
-  /** Read order number */
-  ReadOrder: number
-  /** Z-index layer */
-  Layer: number
-  /** Internal index */
-  _index?: number
-}
-
-/** ASS Style definition */
-export interface ASSStyle {
-  /** Style name (case sensitive) */
-  Name: string
-  /** Font family name */
-  FontName: string
-  /** Font size */
-  FontSize: number
-  /** Primary color (RGBA as uint32) */
-  PrimaryColour: number
-  /** Secondary color (RGBA as uint32) */
-  SecondaryColour: number
-  /** Outline color (RGBA as uint32) */
-  OutlineColour: number
-  /** Background/shadow color (RGBA as uint32) */
-  BackColour: number
-  /** Bold (-1 = true, 0 = false) */
-  Bold: number
-  /** Italic (-1 = true, 0 = false) */
-  Italic: number
-  /** Underline (-1 = true, 0 = false) */
-  Underline: number
-  /** StrikeOut (-1 = true, 0 = false) */
-  StrikeOut: number
-  /** Width scale (percent) */
-  ScaleX: number
-  /** Height scale (percent) */
-  ScaleY: number
-  /** Extra spacing between characters (pixels) */
-  Spacing: number
-  /** Rotation angle (degrees) */
-  Angle: number
-  /** Border style (1 = outline + shadow, 3 = opaque box) */
-  BorderStyle: number
-  /** Outline width (0-4 pixels) */
-  Outline: number
-  /** Shadow depth (0-4 pixels) */
-  Shadow: number
-  /** Alignment (1-9, numpad style) */
-  Alignment: number
-  /** Left margin (pixels) */
-  MarginL: number
-  /** Right margin (pixels) */
-  MarginR: number
-  /** Vertical margin (pixels) */
-  MarginV: number
-  /** Font encoding */
-  Encoding: number
-  /** Treat font name as pattern */
-  treat_fontname_as_pattern: number
-  /** Blur amount */
-  Blur: number
-  /** Text justification */
-  Justify: number
-}
-
-// =============================================================================
-// Performance Stats Types
-// =============================================================================
-
-/** Performance statistics for the renderer */
-export interface PerformanceStats {
-  /** Total frames rendered since reset */
-  framesRendered: number
-  /** Number of frames dropped */
-  framesDropped: number
-  /** Average render time in milliseconds */
-  avgRenderTime: number
-  /** Maximum render time in milliseconds */
-  maxRenderTime: number
-  /** Minimum render time in milliseconds */
-  minRenderTime: number
-  /** Last render time in milliseconds */
-  lastRenderTime: number
-  /** Estimated render FPS based on timing */
-  renderFps: number
-  /** Whether using Web Worker */
-  usingWorker: boolean
-  /** Whether offscreen rendering is enabled */
-  offscreenRender: boolean
-  /** Whether on-demand rendering is enabled */
-  onDemandRender: boolean
-  /** Number of pending render operations */
-  pendingRenders: number
-  /** Total subtitle events in current track */
-  totalEvents: number
-  /** Number of cache hits (unchanged frames) */
-  cacheHits: number
-  /** Number of cache misses (rendered frames) */
-  cacheMisses: number
-}
-
-// =============================================================================
-// AkariSub Options Types
-// =============================================================================
-
-/** Configuration options for AkariSub */
-export interface AkariSubOptions {
-  /** Video element to sync with and overlay */
-  video?: HTMLVideoElement
-  /** Custom canvas element (optional if video is provided) */
-  canvas?: HTMLCanvasElement
-  /** Image blending mode: 'js' for hardware acceleration, 'wasm' for software */
-  blendMode?: 'js' | 'wasm'
-  /** Use async rendering with ImageBitmap (default: true) */
-  asyncRender?: boolean
-  /** Use offscreen canvas rendering (default: true) */
-  offscreenRender?: boolean
-  /** Use requestVideoFrameCallback for precise sync (default: true) */
-  onDemandRender?: boolean
-  /** Target FPS when not using onDemandRender (default: 24) */
-  targetFps?: number
-  /** Time offset in seconds (default: 0) */
-  timeOffset?: number
-  /** Enable debug logging (default: false) */
-  debug?: boolean
-  /** Scale factor for subtitles (default: 1.0) */
-  prescaleFactor?: number
-  /** Height limit for prescaling (default: 1080) */
-  prescaleHeightLimit?: number
-  /** Maximum render height, 0 = no limit (default: 0) */
-  maxRenderHeight?: number
-  /** Attempt to drop all animations (default: false) */
-  dropAllAnimations?: boolean
-  /** Drop all blur effects for performance (default: false) */
-  dropAllBlur?: boolean
-  /** Clamp \\pos values to script resolution (default: false) */
-  clampPos?: boolean
-  /** URL to the worker script */
-  workerUrl?: string
-  /** URL to the WASM binary */
-  wasmUrl?: string
-  /** URL to subtitle file */
-  subUrl?: string
-  /** Subtitle content as string or UTF-8 bytes */
-  subContent?: string | Uint8Array | ArrayBuffer
-  /** Encrypted subtitle content decrypted inside the worker before loading into libass */
-  encryptedSubContent?: EncryptedSubtitleContent
-  /** Array of font URLs or Uint8Arrays */
-  fonts?: (string | Uint8Array)[]
-  /** Available fonts map (lowercase name -> URL/data) */
-  availableFonts?: Record<string, string | Uint8Array>
-  /** Fallback font families in order (default: ['liberation sans']). Fontconfig uses these for cascade. */
-  fallbackFonts?: string[]
-  /** Use Local Font Access API (default: true if available) */
-  useLocalFonts?: boolean
-  /** libass bitmap cache memory limit in MiB */
-  libassMemoryLimit?: number
-  /** libass glyph cache limit */
-  libassGlyphLimit?: number
-  /** Callback invoked when all GPU renderers (WebGPU, WebGL2) are unavailable and the renderer falls back to Canvas2D */
-  onCanvasFallback?: () => void
-  /** Additional time in seconds to render subtitles ahead for pipeline latency compensation (default: 0.008) */
-  renderAhead?: number
-  /** Pre-render early track windows after load to warm libass caches (default: false) */
-  fullTrackWarmup?: boolean
-}
-
-export interface EncryptedSubtitleContent {
-  /** Non-extractable AES-GCM content key from akari-crypto's v2 transport flow */
-  contentKey: CryptoKey
-  /** Single encrypted subtitle payload */
-  encrypted?: ArrayBuffer
-  /** Chunked encrypted subtitle payloads, in display file order */
-  encryptedChunks?: ArrayBuffer[]
-}
-
-// =============================================================================
-// Callback Types (deprecated - use Promise-based API instead)
-// =============================================================================
-
-/** @deprecated Use Promise-based getEvents() instead */
-export type ASSEventCallback = (error: Error | null, events: ASSEvent[]) => void
-/** @deprecated Use Promise-based getStyles() instead */
-export type ASSStyleCallback = (error: Error | null, styles: ASSStyle[]) => void
-/** @deprecated Use Promise-based getStats() instead */
-export type PerformanceStatsCallback = (error: Error | null, stats: PerformanceStats | null) => void
-/** @deprecated Use Promise-based resetStats() instead */
-export type ResetStatsCallback = (error: Error | null) => void
-
-// =============================================================================
-// Worker Message Types
-// =============================================================================
-
-/** Image data for rendering */
-export interface RenderImage {
-  x: number
-  y: number
-  w: number
-  h: number
-  image: ImageBitmap | ArrayBuffer | Uint8Array | Uint8ClampedArray | number
-}
-
-/** Render timing debug info */
-export interface RenderTimes {
-  WASMRenderTime?: number
-  WASMBitmapDecodeTime?: number
-  JSRenderTime?: number
-  JSBitmapGenerationTime?: number
-  IPCTime?: number
-  bitmaps?: number
-}
-
-/** Worker -> Main thread message for rendering */
-export interface RenderMessage {
-  target: 'render'
-  asyncRender: boolean
-  images: RenderImage[]
-  times: RenderTimes
-  width: number
-  height: number
-  colorSpace: string | null
-}
-
-/** Worker -> Main thread messages */
-export type WorkerOutboundMessage =
-  | { target: 'ready' }
-  | { target: 'trackReady' }
-  | { target: 'unbusy' }
-  | { target: 'console'; command: string; content: string }
-  | { target: 'getLocalFont'; font: string }
-  | { target: 'verifyColorSpace'; subtitleColorSpace: string | null }
-  | { target: 'getEvents'; events: ASSEvent[] }
-  | { target: 'getStyles'; styles: ASSStyle[]; time: number }
-  | { target: 'getStats'; stats: Partial<PerformanceStats> }
-  | { target: 'resetStats'; success: boolean }
-  | { target: 'getEventCount'; count: number }
-  | { target: 'getStyleCount'; count: number }
-  | RenderMessage
-
-/** Main thread -> Worker init message */
-export interface WorkerInitMessage {
-  target: 'init'
-  wasmUrl: string
-  asyncRender: boolean
-  fullTrackWarmup: boolean
-  onDemandRender: boolean
-  initialTime: number
-  width: number
-  height: number
-  blendMode: 'js' | 'wasm'
-  subUrl?: string
-  subContent?: string | Uint8Array | ArrayBuffer | null
-  encryptedSubContent?: EncryptedSubtitleContent | null
-  fonts: (string | Uint8Array)[]
-  availableFonts: Record<string, string | Uint8Array>
-  fallbackFonts: string[]
-  debug: boolean
-  targetFps: number
-  dropAllAnimations?: boolean
-  dropAllBlur?: boolean
-  clampPos?: boolean
-  libassMemoryLimit?: number
-  libassGlyphLimit?: number
-  useLocalFonts: boolean
-  hasBitmapBug: boolean
-}
-
-/** Main thread -> Worker messages */
-export type WorkerInboundMessage =
-  | WorkerInitMessage
-  | { target: 'offscreenCanvas'; transferable: [OffscreenCanvas] }
-  | { target: 'detachOffscreen' }
-  | { target: 'canvas'; width: number; height: number; videoWidth: number; videoHeight: number; force?: boolean }
-  | { target: 'video'; currentTime?: number; isPaused?: boolean; rate?: number; colorSpace?: string | null }
-  | { target: 'setTrack'; content: string | Uint8Array | ArrayBuffer }
-  | { target: 'setEncryptedTrack'; content: EncryptedSubtitleContent }
-  | { target: 'setTrackByUrl'; url: string }
-  | { target: 'freeTrack' }
-  | { target: 'demand'; time: number }
-  | { target: 'destroy' }
-  | { target: 'addFont'; font: string | Uint8Array }
-  | { target: 'defaultFont'; font: string }
-  | { target: 'createEvent'; event: Partial<ASSEvent> }
-  | { target: 'setEvent'; event: Partial<ASSEvent>; index: number }
-  | { target: 'removeEvent'; index: number }
-  | { target: 'getEvents' }
-  | { target: 'createStyle'; style: Partial<ASSStyle> }
-  | { target: 'setStyle'; style: Partial<ASSStyle>; index: number }
-  | { target: 'removeStyle'; index: number }
-  | { target: 'getStyles' }
-  | { target: 'styleOverride'; style: Partial<ASSStyle> }
-  | { target: 'disableStyleOverride' }
-  | { target: 'getStats' }
-  | { target: 'resetStats' }
-  | { target: 'getEventCount' }
-  | { target: 'getStyleCount' }
-  | { target: 'getColorSpace' }
-
-// =============================================================================
-// RVFC Types
-// =============================================================================
-
-/** requestVideoFrameCallback metadata */
-export interface VideoFrameCallbackMetadata {
-  /** The current media time of the frame being displayed (seconds) */
-  mediaTime: number
-  /** Video intrinsic width */
-  width: number
-  /** Video intrinsic height */
-  height: number
-  /** Number of frames presented so far */
-  presentedFrames?: number
-  /** Time spent processing the frame (milliseconds) */
-  processingDuration?: number
-  /** Expected time when this frame will be displayed (DOMHighResTimeStamp) */
-  expectedDisplayTime?: number
-  /** Time at which the frame was presented (DOMHighResTimeStamp) */
-  presentationTime?: number
-}
-
-// =============================================================================
-// Color Space Types
-// =============================================================================
-
-export type WebYCbCrColorSpace = 'BT709' | 'BT601'
-export type SubtitleColorSpace = 'BT601' | 'BT709' | 'SMPTE240M' | 'FCC' | null
-
-// =============================================================================
-// AkariSub WASM Module Types
-// =============================================================================
-
-/** Emscripten AkariSub Module (C ABI exports) */
-export interface AkariSubModule extends EmscriptenModule {
-  _malloc: (size: number) => number
-  _free: (ptr: number) => void
-  _akarisub_create: (width: number, height: number, fallbackFontPtr: number, debug: number) => number
-  _akarisub_destroy: (handle: number) => void
-  _akarisub_set_drop_animations: (handle: number, value: number) => void
-  _akarisub_create_track_mem: (handle: number, contentPtr: number) => void
-  _akarisub_remove_track: (handle: number) => void
-  _akarisub_resize_canvas: (handle: number, width: number, height: number, videoWidth: number, videoHeight: number) => void
-  _akarisub_add_font: (handle: number, namePtr: number, dataPtr: number, size: number) => void
-  _akarisub_reload_fonts: (handle: number) => void
-  _akarisub_set_default_font: (handle: number, fontPtr: number) => void
-  _akarisub_set_fallback_fonts: (handle: number, fontsPtr: number) => void
-  _akarisub_set_memory_limits: (handle: number, glyphLimit: number, memoryLimit: number) => void
-  _akarisub_get_event_count: (handle: number) => number
-  _akarisub_alloc_event: (handle: number) => number
-  _akarisub_remove_event: (handle: number, index: number) => void
-  _akarisub_get_style_count: (handle: number) => number
-  _akarisub_alloc_style: (handle: number) => number
-  _akarisub_remove_style: (handle: number, index: number) => void
-  _akarisub_style_override_index: (handle: number, index: number) => void
-  _akarisub_disable_style_override: (handle: number) => void
-  _akarisub_get_track_color_space: (handle: number) => number
-  _akarisub_event_get_int: (handle: number, index: number, field: number) => number
-  _akarisub_event_set_int: (handle: number, index: number, field: number, value: number) => void
-  _akarisub_event_get_str: (handle: number, index: number, field: number) => number
-  _akarisub_event_set_str: (handle: number, index: number, field: number, valuePtr: number) => void
-  _akarisub_style_get_num: (handle: number, index: number, field: number) => number
-  _akarisub_style_set_num: (handle: number, index: number, field: number, value: number) => void
-  _akarisub_style_get_str: (handle: number, index: number, field: number) => number
-  _akarisub_style_set_str: (handle: number, index: number, field: number, valuePtr: number) => void
-  _akarisub_get_event_time_range: (handle: number, outPtr: number) => number
-  _akarisub_get_empty_window: (handle: number, tm: number, outPtr: number) => number
-  _akarisub_render_blend_collect: (handle: number, time: number, force: number, outPtr: number, maxItems: number) => number
-  _akarisub_render_image_collect: (handle: number, time: number, force: number, outPtr: number, maxItems: number) => number
-  FS_createPath: (parent: string, path: string, canRead: boolean, canWrite: boolean) => void
-  FS_createDataFile: (parent: string, name: string | null, data: Uint8Array, canRead: boolean, canWrite: boolean, canOwn?: boolean) => void
-}