@hanifhan1f/vidstack 1.12.13 → 1.12.14

package/src/core/tracks/text/events.ts

@@ -1,52 +0,0 @@
-import type { DOMEvent } from 'maverick.js/std';
-
-import type { TextTrack } from './text-track';
-
-export interface TextTrackEvents {
-  'load-start': TextTrackLoadStartEvent;
-  load: TextTrackLoadEvent;
-  error: TextTrackErrorEvent;
-  'add-cue': TextTrackAddCueEvent;
-  'remove-cue': TextTrackRemoveCueEvent;
-  'cue-change': TextTrackCueChangeEvent;
-  'mode-change': TextTrackModeChangeEvent;
-}
-
-export interface TextTrackEvent<T> extends DOMEvent<T> {
-  target: TextTrack;
-}
-
-/**
- * Fired when the text track begins the loading/parsing process.
- */
-export interface TextTrackLoadStartEvent extends TextTrackEvent<void> {}
-
-/**
- * Fired when the text track has finished loading/parsing.
- */
-export interface TextTrackLoadEvent extends TextTrackEvent<void> {}
-
-/**
- * Fired when loading or parsing the text track fails.
- */
-export interface TextTrackErrorEvent extends TextTrackEvent<Error> {}
-
-/**
- * Fired when a cue is added to the text track.
- */
-export interface TextTrackAddCueEvent extends TextTrackEvent<VTTCue> {}
-
-/**
- * Fired when a cue is removed from the text track.
- */
-export interface TextTrackRemoveCueEvent extends TextTrackEvent<VTTCue> {}
-
-/**
- * Fired when the active cues for the current text track have changed.
- */
-export interface TextTrackCueChangeEvent extends TextTrackEvent<void> {}
-
-/**
- * Fired when the text track mode (showing/hidden/disabled) has changed.
- */
-export interface TextTrackModeChangeEvent extends TextTrackEvent<TextTrack> {}

package/src/core/tracks/text/render/libass-text-renderer.ts

@@ -1,246 +0,0 @@
-import { DOMEvent, EventsController, EventsTarget, isString } from 'maverick.js/std';
-
-import { TextTrackSymbol } from '../symbols';
-import type { TextTrack } from '../text-track';
-import type { TextRenderer } from './text-renderer';
-
-export class LibASSTextRenderer implements TextRenderer {
-  readonly priority = 1;
-
-  #instance: LibASSInstance | null = null;
-  #track: TextTrack | null = null;
-  #typeRE = /(ssa|ass)$/;
-
-  constructor(
-    public readonly loader: LibASSModuleLoader,
-    public config?: LibASSConfig,
-  ) {}
-
-  canRender(track: TextTrack, video: HTMLVideoElement | null): boolean {
-    return (
-      !!video &&
-      !!track.src &&
-      ((isString(track.type) && this.#typeRE.test(track.type)) || this.#typeRE.test(track.src))
-    );
-  }
-
-  attach(video: HTMLVideoElement | null) {
-    if (!video) return;
-
-    this.loader().then(async (mod) => {
-      this.#instance = new mod.default({
-        ...this.config,
-        video,
-        subUrl: this.#track?.src || '',
-      });
-
-      new EventsController(this.#instance)
-        .add('ready', () => {
-          const canvas = this.#instance?._canvas;
-          if (canvas) canvas.style.pointerEvents = 'none';
-        })
-        .add('error', (event) => {
-          if (!this.#track) return;
-          this.#track[TextTrackSymbol.readyState] = 3;
-          this.#track.dispatchEvent(
-            new DOMEvent('error', {
-              trigger: event,
-              detail: event.error,
-            }),
-          );
-        });
-    });
-  }
-
-  changeTrack(track: TextTrack | null) {
-    if (!track || track.readyState === 3) {
-      this.#freeTrack();
-    } else if (this.#track !== track) {
-      this.#instance?.setTrackByUrl(track.src!);
-      this.#track = track;
-    }
-  }
-
-  detach(): void {
-    this.#freeTrack();
-  }
-
-  #freeTrack() {
-    this.#instance?.freeTrack();
-    this.#track = null;
-  }
-}
-
-export interface LibASSModuleLoader {
-  (): Promise<{
-    default: LibASSConstructor;
-  }>;
-}
-
-export interface LibASSConstructor {
-  new (
-    config?: {
-      video: HTMLVideoElement;
-      canvas?: HTMLCanvasElement;
-      subUrl?: string;
-    } & LibASSConfig,
-  ): LibASSInstance;
-}
-
-export interface LibASSInstance extends EventsTarget<LibASSInstanceEvents> {
-  _video: HTMLVideoElement;
-  _canvas: HTMLVideoElement | null;
-  setTrackByUrl(url: string): void;
-  setCurrentTime(time: number): void;
-  freeTrack(): void;
-  destroy(): void;
-}
-
-export interface LibASSInstanceEvents {
-  ready: LibASSReadyEvent;
-  error: LibASSErrorEvent;
-}
-
-export interface LibASSReadyEvent extends Event {}
-
-export interface LibASSErrorEvent extends ErrorEvent {}
-
-/**
- * @see {@link https://github.com/ThaUnknown/jassub/tree/main#options}
- */
-export interface LibASSConfig {
-  /**
-   * Which image blending mode to use. WASM will perform better on lower end devices, JS will
-   * perform better if the device and browser supports hardware acceleration.
-   *
-   * @defaultValue "js"
-   */
-  blendMode?: 'js' | 'wasm';
-  /**
-   * Whether or not to use async rendering, which offloads the CPU by creating image bitmaps on
-   * the GPU.
-   *
-   * @defaultValue true
-   */
-  asyncRender?: boolean;
-  /**
-   * Whether or not to render things fully on the worker, greatly reduces CPU usage.
-   *
-   * @defaultValue true
-   */
-  offscreenRender?: boolean;
-  /**
-   * Whether or not to render subtitles as the video player renders frames, rather than predicting
-   * which frame the player is on using events.
-   *
-   * @defaultValue true
-   */
-  onDemandRender?: boolean;
-  /**
-   * Target FPS to render subtitles at. Ignored when onDemandRender is enabled.
-   *
-   * @defaultValue 24
-   */
-  targetFps?: number;
-  /**
-   * Subtitle time offset in seconds.
-   *
-   * @defaultValue 0
-   */
-  timeOffset?: number;
-  /**
-   * Whether or not to print debug information.
-   *
-   * @defaultValue false
-   */
-  debug?: boolean;
-  /**
-   * Scale down (< 1.0) the subtitles canvas to improve performance at the expense of quality, or
-   * scale it up (> 1.0).
-   *
-   * @defaultValue 1.0
-   */
-  prescaleFactor?: number;
-  /**
-   * The height in pixels beyond which the subtitles canvas won't be pre-scaled.
-   *
-   * @defaultValue 1080
-   */
-  prescaleHeightLimit?: number;
-  /**
-   * The maximum rendering height in pixels of the subtitles canvas. Beyond this subtitles will
-   * be up-scaled by the browser.
-   *
-   * @defaultValue 0
-   */
-  maxRenderHeight?: number;
-  /**
-   * Attempt to discard all animated tags. Enabling this may severely mangle complex subtitles
-   * and should only be considered as an last ditch effort of uncertain success for hardware
-   * otherwise incapable of displaying anything. Will not reliably work with manually edited or
-   * allocated events.
-   *
-   * @defaultValue false
-   */
-  dropAllAnimations?: boolean;
-  /**
-   * The URL of the worker.
-   *
-   * @defaultValue "jassub-worker.js"
-   */
-  workerUrl?: string;
-  /**
-   * The URL of the legacy worker. Only loaded if the browser doesn't support WASM.
-   *
-   * @defaultValue "jassub-worker-legacy.js"
-   */
-  legacyWorkerUrl?: string;
-  /**
-   * The URL of the subtitle file to play.
-   *
-   */
-  subUrl?: string;
-  /**
-   * The content of the subtitle file to play.
-   *
-   */
-  subContent?: string;
-  /**
-   * An array of links or `Uint8Array` to the fonts used in the subtitle. If `Uint8Array` is used
-   * the array is copied, not referenced. This forces all the fonts in this array to be loaded
-   * by the renderer, regardless of if they are used.
-   *
-   */
-  fonts?: string[] | Uint8Array[];
-  /**
-   * Object with all available fonts. Key is font family in lower case, value is link or
-   * `Uint8Array`. These fonts are selectively loaded if detected as used in the current
-   * subtitle track.
-   *
-   * @defaultValue {'liberation sans': './default.woff2'}}
-   */
-  availableFonts?: Record<string, string>;
-  /**
-   * The font family key of the fallback font in `availableFonts` to use if the other font
-   * for the style is missing special glyphs or unicode.
-   *
-   * @defaultValue "liberation sans"
-   */
-  fallbackFont?: string;
-  /**
-   * If the Local Font Access API is enabled `[chrome://flags/#font-access]`, the library will
-   * query for permissions to use local fonts and use them if any are missing. The permission can
-   * be queried beforehand using `navigator.permissions.request({ name: 'local-fonts' })`.
-   *
-   * @defaultValue true
-   */
-  useLocalFonts?: boolean;
-  /**
-   * libass bitmap cache memory limit in MiB (approximate).
-   */
-  libassMemoryLimit?: number;
-  /**
-   * libass glyph cache memory limit in MiB (approximate).
-   */
-  libassGlyphLimit?: number;
-}

package/src/core/tracks/text/render/native-text-renderer.ts

@@ -1,106 +0,0 @@
-import { isHTMLElement } from '../../../../utils/dom';
-import { TextTrackSymbol } from '../symbols';
-import type { TextTrack as VdsTextTrack } from '../text-track';
-import type { TextRenderer } from './text-renderer';
-
-export class NativeTextRenderer implements TextRenderer {
-  readonly priority = 0;
-
-  #display = true;
-  #video: HTMLVideoElement | null = null;
-  #track: VdsTextTrack | null = null;
-  #tracks = new Set<VdsTextTrack>();
-
-  canRender(_, video: HTMLVideoElement | null) {
-    return !!video;
-  }
-
-  attach(video: HTMLVideoElement | null) {
-    this.#video = video;
-    if (video) video.textTracks.onchange = this.#onChange.bind(this);
-  }
-
-  addTrack(track: VdsTextTrack): void {
-    this.#tracks.add(track);
-    this.#attachTrack(track);
-  }
-
-  removeTrack(track: VdsTextTrack): void {
-    track[TextTrackSymbol.native]?.remove?.();
-    track[TextTrackSymbol.native] = null;
-    this.#tracks.delete(track);
-  }
-
-  changeTrack(track: VdsTextTrack | null): void {
-    const current = track?.[TextTrackSymbol.native];
-
-    if (current && current.track.mode !== 'showing') {
-      current.track.mode = 'showing';
-    }
-
-    this.#track = track;
-  }
-
-  setDisplay(display: boolean) {
-    this.#display = display;
-    this.#onChange();
-  }
-
-  detach() {
-    if (this.#video) this.#video.textTracks.onchange = null;
-    for (const track of this.#tracks) this.removeTrack(track);
-    this.#tracks.clear();
-    this.#video = null;
-    this.#track = null;
-  }
-
-  #attachTrack(track: VdsTextTrack): void {
-    if (!this.#video) return;
-    const el = (track[TextTrackSymbol.native] ??= this.#createTrackElement(track));
-    if (isHTMLElement(el)) {
-      this.#video.append(el);
-      el.track.mode = el.default ? 'showing' : 'disabled';
-    }
-  }
-
-  #createTrackElement(track: VdsTextTrack): HTMLTrackElement {
-    const el = document.createElement('track'),
-      isDefault = track.default || track.mode === 'showing',
-      isSupported = track.src && track.type === 'vtt';
-
-    el.id = track.id;
-    el.src = isSupported ? track.src! : '';
-    el.label = track.label;
-    el.kind = track.kind;
-    el.default = isDefault;
-    track.language && (el.srclang = track.language);
-
-    if (isDefault && !isSupported) {
-      this.#copyCues(track, el.track);
-    }
-
-    return el;
-  }
-
-  #copyCues(track: VdsTextTrack, native: Partial<TextTrack>) {
-    if ((track.src && track.type === 'vtt') || native.cues?.length) return;
-    for (const cue of track.cues) native.addCue!(cue as any);
-  }
-
-  #onChange(event?: Event) {
-    for (const track of this.#tracks) {
-      const native = track[TextTrackSymbol.native];
-
-      if (!native) continue;
-
-      if (!this.#display) {
-        native.track.mode = native.managed ? 'hidden' : 'disabled';
-        continue;
-      }
-
-      const isShowing = native.track.mode === 'showing';
-      if (isShowing) this.#copyCues(track, native.track);
-      track.setMode(isShowing ? 'showing' : 'disabled', event);
-    }
-  }
-}

package/src/core/tracks/text/render/text-renderer.ts

@@ -1,134 +0,0 @@
-import { effect, onDispose, untrack } from 'maverick.js';
-import { EventsController, listenEvent } from 'maverick.js/std';
-
-import type { MediaContext } from '../../../api/media-context';
-import { TextTrackSymbol } from '../symbols';
-import { isTrackCaptionKind, TextTrack } from '../text-track';
-import type { TextTrackAddEvent, TextTrackList, TextTrackRemoveEvent } from '../text-tracks';
-import { NativeTextRenderer } from './native-text-renderer';
-
-export class TextRenderers {
-  #video: HTMLVideoElement | null = null;
-  #textTracks: TextTrackList;
-  #renderers: TextRenderer[] = [];
-  #media: MediaContext;
-
-  #nativeDisplay = false;
-  #nativeRenderer: NativeTextRenderer | null = null;
-  #customRenderer: TextRenderer | null = null;
-
-  constructor(media: MediaContext) {
-    this.#media = media;
-
-    const textTracks = media.textTracks;
-    this.#textTracks = textTracks;
-
-    effect(this.#watchControls.bind(this));
-
-    onDispose(this.#detach.bind(this));
-
-    new EventsController(textTracks)
-      .add('add', this.#onAddTrack.bind(this))
-      .add('remove', this.#onRemoveTrack.bind(this))
-      .add('mode-change', this.#update.bind(this));
-  }
-
-  #watchControls() {
-    const { nativeControls } = this.#media.$state;
-    this.#nativeDisplay = nativeControls();
-    this.#update();
-  }
-
-  add(renderer: TextRenderer) {
-    this.#renderers.push(renderer);
-    untrack(this.#update.bind(this));
-  }
-
-  remove(renderer: TextRenderer) {
-    renderer.detach();
-    this.#renderers.splice(this.#renderers.indexOf(renderer), 1);
-    untrack(this.#update.bind(this));
-  }
-
-  /** @internal */
-  attachVideo(video: HTMLVideoElement | null) {
-    requestAnimationFrame(() => {
-      this.#video = video;
-
-      if (video) {
-        this.#nativeRenderer = new NativeTextRenderer();
-        this.#nativeRenderer.attach(video);
-        for (const track of this.#textTracks) this.#addNativeTrack(track);
-      }
-
-      this.#update();
-    });
-  }
-
-  #addNativeTrack(track: TextTrack) {
-    if (!isTrackCaptionKind(track)) return;
-    this.#nativeRenderer?.addTrack(track);
-  }
-
-  #removeNativeTrack(track: TextTrack) {
-    if (!isTrackCaptionKind(track)) return;
-    this.#nativeRenderer?.removeTrack(track);
-  }
-
-  #onAddTrack(event: TextTrackAddEvent) {
-    this.#addNativeTrack(event.detail);
-  }
-
-  #onRemoveTrack(event: TextTrackRemoveEvent) {
-    this.#removeNativeTrack(event.detail);
-  }
-
-  #update() {
-    const currentTrack = this.#textTracks.selected;
-
-    // We identify text tracks that were embedded in HLS playlists and loaded natively (e.g., iOS
-    // Safari) because we can't toggle mode to hidden and still get cue updates for some reason.
-    // See `native-hls-text-tracks.ts` for discovery.
-    if (this.#video && (this.#nativeDisplay || currentTrack?.[TextTrackSymbol.nativeHLS])) {
-      this.#customRenderer?.changeTrack(null);
-      this.#nativeRenderer?.setDisplay(true);
-      this.#nativeRenderer?.changeTrack(currentTrack);
-      return;
-    }
-
-    this.#nativeRenderer?.setDisplay(false);
-    this.#nativeRenderer?.changeTrack(null);
-
-    if (!currentTrack) {
-      this.#customRenderer?.changeTrack(null);
-      return;
-    }
-
-    const customRenderer = this.#renderers
-      .sort((a, b) => a.priority - b.priority)
-      .find((renderer) => renderer.canRender(currentTrack, this.#video));
-
-    if (this.#customRenderer !== customRenderer) {
-      this.#customRenderer?.detach();
-      customRenderer?.attach(this.#video);
-      this.#customRenderer = customRenderer ?? null;
-    }
-
-    customRenderer?.changeTrack(currentTrack);
-  }
-
-  #detach() {
-    this.#nativeRenderer?.detach();
-    this.#nativeRenderer = null;
-    this.#customRenderer?.detach();
-    this.#customRenderer = null;
-  }
-}
-
-export interface TextRenderer {
-  readonly priority: number;
-  canRender(track: TextTrack, video: HTMLVideoElement | null): boolean;
-  attach(video: HTMLVideoElement | null);
-  detach(): void;
-  changeTrack(track: TextTrack | null): void;
-}

package/src/core/tracks/text/symbols.ts

@@ -1,17 +0,0 @@
-const CROSS_ORIGIN = Symbol(__DEV__ ? 'TEXT_TRACK_CROSS_ORIGIN' : 0),
-  READY_STATE = Symbol(__DEV__ ? 'TEXT_TRACK_READY_STATE' : 0),
-  UPDATE_ACTIVE_CUES = Symbol(__DEV__ ? 'TEXT_TRACK_UPDATE_ACTIVE_CUES' : 0),
-  CAN_LOAD = Symbol(__DEV__ ? 'TEXT_TRACK_CAN_LOAD' : 0),
-  ON_MODE_CHANGE = Symbol(__DEV__ ? 'TEXT_TRACK_ON_MODE_CHANGE' : 0),
-  NATIVE = Symbol(__DEV__ ? 'TEXT_TRACK_NATIVE' : 0),
-  NATIVE_HLS = Symbol(__DEV__ ? 'TEXT_TRACK_NATIVE_HLS' : 0);
-
-export const TextTrackSymbol = {
-  crossOrigin: CROSS_ORIGIN,
-  readyState: READY_STATE,
-  updateActiveCues: UPDATE_ACTIVE_CUES,
-  canLoad: CAN_LOAD,
-  onModeChange: ON_MODE_CHANGE,
-  native: NATIVE,
-  nativeHLS: NATIVE_HLS,
-} as const;