libpag/src/interfaces.ts

Portable Animated Graphics

import type { ctor, Point, Rect, Vector } from './types';

export interface TimeRange {
  start: number;
  end: number;
}

export interface VideoReader {
  isSought: boolean;
  isPlaying: boolean;
  prepare: (targetFrame: number, playbackRate: number) => Promise<void>;
  getError: () => Promise<any>;
  onDestroy: () => void;
  play: () => Promise<void>;
  pause: () => void;
  stop: () => void;
}

export interface VideoReaderManager{
  getVideoReaderByID: (id: number) => VideoReader | undefined;
  destroy: () => void;
}

export interface VideoDecoderConstructor {
  create: (
      mp4Data: Uint8Array,
      width: number,
      height: number,
      frameRate: number,
      staticTimeRanges: TimeRange[],
  ) => Promise<VideoReader>;
}

export interface FontMetrics {
  ascent: number;
  descent: number;
  xHeight: number;
  capHeight: number;
}

export interface Stroke {
  width: number;
  cap: ctor;
  join: ctor;
  miterLimit: number;
}

export interface ScalerContext {
  fontString: (fauxBold: boolean, fauxItalic: boolean) => string;
  getAdvance: (text: string) => number;
  getBounds: (text: string, fauxBold: boolean, fauxItalic: boolean) => Rect;
  getFontMetrics: () => FontMetrics;
  readPixels: (text: string, bounds: Rect, fauxBold: boolean, stroke?: Stroke) => Uint8Array | null;
}

export interface ScalerContextConstructor {
  isEmoji: (text: string) => boolean;
  new (fontName: string, fontStyle: string, size: number, fauxBold: boolean, fauxItalic: boolean): ScalerContext;
}