image-to-pixel 3.0.1 → 3.2.0

package/package.json

@@ -1,92 +1,92 @@
-{
-  "name": "image-to-pixel",
-  "version": "3.0.1",
-  "description": "Turn images and video into pixel art: dithering, palettes, batch and video. A WebGL engine (via ShaderMate) with a CPU fallback, plus a full editor.",
-  "type": "module",
-  "license": "MIT",
-  "author": "Tezumie",
-  "homepage": "https://tezumie.github.io/Image-to-Pixel/",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Tezumie/Image-to-Pixel.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Tezumie/Image-to-Pixel/issues"
-  },
-  "keywords": [
-    "pixel-art",
-    "dithering",
-    "palette",
-    "quantization",
-    "floyd-steinberg",
-    "bayer",
-    "webgl",
-    "glsl",
-    "shader",
-    "gif",
-    "sprite-sheet",
-    "lospec"
-  ],
-  "main": "./dist/image-to-pixel.cjs",
-  "module": "./dist/image-to-pixel.esm.js",
-  "types": "./types/index.d.ts",
-  "unpkg": "./dist/image-to-pixel.min.js",
-  "jsdelivr": "./dist/image-to-pixel.min.js",
-  "exports": {
-    ".": {
-      "types": "./types/index.d.ts",
-      "import": "./dist/image-to-pixel.esm.js",
-      "require": "./dist/image-to-pixel.cjs",
-      "default": "./dist/image-to-pixel.esm.js"
-    },
-    "./video": {
-      "types": "./types/video.d.ts",
-      "import": "./dist/video.esm.js",
-      "default": "./dist/video.esm.js"
-    },
-    "./editor": {
-      "types": "./types/editor.d.ts",
-      "import": "./dist/editor.esm.js",
-      "default": "./dist/editor.esm.js"
-    },
-    "./editor.css": "./dist/editor.css",
-    "./dist/*": "./dist/*",
-    "./package.json": "./package.json"
-  },
-  "sideEffects": [
-    "./dist/editor.css",
-    "./dist/image-to-pixel.js",
-    "./dist/image-to-pixel.min.js"
-  ],
-  "files": [
-    "dist",
-    "lib",
-    "types",
-    "LICENSE",
-    "README.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "scripts": {
-    "build": "node esbuild.config.mjs",
-    "build:site": "npm run build && node scripts/build-site.mjs",
-    "watch": "node esbuild.config.mjs --watch",
-    "dev": "node scripts/serve.mjs --dev",
-    "preview": "node scripts/serve.mjs",
-    "bluenoise": "node scripts/gen-bluenoise.mjs",
-    "screenshots": "node scripts/screenshots.mjs",
-    "clean": "node scripts/clean.mjs",
-    "test": "npm run build:site && node --test",
-    "prepublishOnly": "npm test",
-    "check:runtime": "node scripts/nodepod-check.mjs"
-  },
-  "dependencies": {
-    "shadermate": "^2.0.0"
-  },
-  "devDependencies": {
-    "esbuild": "^0.25.12",
-    "highlight.js": "^11.12.0",
-    "marked": "^15.0.12"
-  }
-}
+{
+  "name": "image-to-pixel",
+  "version": "3.2.0",
+  "description": "Turn images and video into pixel art: dithering, palettes, batch and video. A WebGL engine (via ShaderMate) with a CPU fallback, plus a full editor.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Tezumie",
+  "homepage": "https://tezumie.github.io/Image-to-Pixel/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Tezumie/Image-to-Pixel.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Tezumie/Image-to-Pixel/issues"
+  },
+  "keywords": [
+    "pixel-art",
+    "dithering",
+    "palette",
+    "quantization",
+    "floyd-steinberg",
+    "bayer",
+    "webgl",
+    "glsl",
+    "shader",
+    "gif",
+    "sprite-sheet",
+    "lospec"
+  ],
+  "main": "./dist/image-to-pixel.cjs",
+  "module": "./dist/image-to-pixel.esm.js",
+  "types": "./types/index.d.ts",
+  "unpkg": "./dist/image-to-pixel.min.js",
+  "jsdelivr": "./dist/image-to-pixel.min.js",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/image-to-pixel.esm.js",
+      "require": "./dist/image-to-pixel.cjs",
+      "default": "./dist/image-to-pixel.esm.js"
+    },
+    "./video": {
+      "types": "./types/video.d.ts",
+      "import": "./dist/video.esm.js",
+      "default": "./dist/video.esm.js"
+    },
+    "./editor": {
+      "types": "./types/editor.d.ts",
+      "import": "./dist/editor.esm.js",
+      "default": "./dist/editor.esm.js"
+    },
+    "./editor.css": "./dist/editor.css",
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": [
+    "./dist/editor.css",
+    "./dist/image-to-pixel.js",
+    "./dist/image-to-pixel.min.js"
+  ],
+  "files": [
+    "dist",
+    "lib",
+    "types",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "node esbuild.config.mjs",
+    "build:site": "npm run build && node scripts/build-site.mjs",
+    "watch": "node esbuild.config.mjs --watch",
+    "dev": "node scripts/serve.mjs --dev",
+    "preview": "node scripts/serve.mjs",
+    "bluenoise": "node scripts/gen-bluenoise.mjs",
+    "screenshots": "node scripts/screenshots.mjs",
+    "clean": "node scripts/clean.mjs",
+    "test": "npm run build:site && node --test",
+    "prepublishOnly": "npm test",
+    "check:runtime": "node scripts/nodepod-check.mjs"
+  },
+  "dependencies": {
+    "shadermate": "^2.0.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.12",
+    "highlight.js": "^11.12.0",
+    "marked": "^15.0.12"
+  }
+}

package/types/index.d.ts

@@ -192,5 +192,7 @@ export function estimateFps(video: HTMLVideoElement, fallback?: number): Promise
 export function frameTimes(opts: { duration: number; fps: number; start?: number; end?: number; maxFrames?: number }): number[];
 export function forEachFrame(video: HTMLVideoElement, opts: {
   fps: number; start?: number; end?: number; maxFrames?: number; signal?: AbortSignal;
+  /** Explicit frame timestamps (seconds), in selection order. */
+  times?: number[];
   onFrame: (info: { index: number; time: number; total: number }) => unknown;
 }): Promise<number>;

package/types/video.d.ts

@@ -1,43 +1,99 @@
-// image-to-pixel/video
-import type { RGBAImage } from './index';
-export { forEachFrame, estimateFps, seekTo, frameTimes, videoReady } from './index';
-
-export interface VideoEncoderOptions {
-  format: 'mp4' | 'webm';
-  fps: number;
-  /** Size of the frames you will add. */
-  width: number;
-  height: number;
-  /** Whole-number upscale applied to every frame. */
-  scale?: number;
-  bitrate?: number;
-}
-export interface PixelVideoEncoder {
-  readonly width: number;
-  readonly height: number;
-  readonly codec: string;
-  add(frame: RGBAImage): Promise<void>;
-  finish(): Promise<Blob>;
-}
-export function createVideoEncoder(opts: VideoEncoderOptions): Promise<PixelVideoEncoder>;
-export function encodeVideo(frames: RGBAImage[], opts: Omit<VideoEncoderOptions, 'width' | 'height'>): Promise<Blob>;
-export function videoSupport(width?: number, height?: number): Promise<{ mp4: boolean; webm: boolean; webcodecs: boolean }>;
-
-/** Minimal MP4 muxer (one H.264 track, fast start). Feed it VideoEncoder output, or AVCC samples. */
-export interface Mp4Muxer {
-  addChunk(chunk: EncodedVideoChunk, meta?: EncodedVideoChunkMetadata): void;
-  /** timestamp/duration in microseconds; data is length-prefixed NAL units. */
-  addSample(data: Uint8Array, info: { key: boolean; timestamp: number; duration?: number }): void;
-  /** AVCDecoderConfigurationRecord ('avcC'). */
-  setDescription(avcC: Uint8Array): void;
-  finish(): Uint8Array;
-}
-export function createMp4Muxer(opts: { width: number; height: number; timescale?: number }): Mp4Muxer;
-/** Minimal WebM muxer (one VP8/VP9/AV1 track, with SeekHead and Cues). */
-export interface WebmMuxer {
-  addChunk(chunk: EncodedVideoChunk, meta?: EncodedVideoChunkMetadata): void;
-  /** timestamp in microseconds */
-  addFrame(data: Uint8Array, info: { key: boolean; timestamp: number }): void;
-  finish(): Uint8Array;
-}
-export function createWebmMuxer(opts: { width: number; height: number; codec?: 'vp8' | 'vp9' | 'av1'; fps?: number }): WebmMuxer;
+// image-to-pixel/video
+import type { RGBAImage } from './index';
+export { forEachFrame, estimateFps, seekTo, frameTimes, videoReady } from './index';
+
+export interface VideoEncoderOptions {
+  format: 'mp4' | 'webm';
+  fps: number;
+  /** Size of the frames you will add. */
+  width: number;
+  height: number;
+  /** Whole-number upscale applied to every frame. */
+  scale?: number;
+  bitrate?: number;
+  /**
+   * Soundtrack to include, e.g. from decodeAudio(file, { start, end }). Cut to the video's length.
+   * MP4 gets AAC (or Opus where AAC can't be encoded), WebM gets Opus. If the browser can't encode
+   * either, the video is made without it: check `audioCodec` on the encoder.
+   */
+  audio?: PCMAudio | null;
+  /** Bits per second for the audio. Default 128000. */
+  audioBitrate?: number;
+}
+/** Planar 32-bit float PCM, one array per channel. */
+export interface PCMAudio {
+  sampleRate: number;
+  numberOfChannels: number;
+  channels: Float32Array[];
+  /** Seconds (informational). */
+  duration?: number;
+}
+export type AudioCodec = 'aac' | 'opus';
+export interface PixelVideoEncoder {
+  readonly width: number;
+  readonly height: number;
+  readonly codec: string;
+  /** The audio codec used, or null when there is no soundtrack (none given, or none this browser can encode). */
+  readonly audioCodec: AudioCodec | null;
+  add(frame: RGBAImage): Promise<void>;
+  finish(): Promise<Blob>;
+}
+export function createVideoEncoder(opts: VideoEncoderOptions): Promise<PixelVideoEncoder>;
+export function encodeVideo(frames: RGBAImage[], opts: Omit<VideoEncoderOptions, 'width' | 'height'>): Promise<Blob>;
+export function videoSupport(width?: number, height?: number): Promise<{ mp4: boolean; webm: boolean; webcodecs: boolean; aac: boolean; opus: boolean }>;
+
+/**
+ * Decode a file's audio track to PCM (resampled, default 48 kHz; mixed down to at most 2 channels; trimmed to
+ * start/end in seconds). Resolves with null when there is no audio track, it can't be decoded, or there is no
+ * Web Audio (Node).
+ */
+export function decodeAudio(
+  source: Blob | ArrayBuffer | ArrayBufferView | string | HTMLMediaElement,
+  opts?: { start?: number; end?: number; sampleRate?: number; channels?: 1 | 2 },
+): Promise<PCMAudio | null>;
+/** Encode PCM with WebCodecs' AudioEncoder; chunks go to onChunk (e.g. a muxer's addAudioChunk). */
+export function encodeAudio(
+  pcm: PCMAudio,
+  opts: { codec?: AudioCodec; config?: AudioEncoderConfig; bitrate?: number; maxDuration?: number; onChunk: (chunk: EncodedAudioChunk, meta?: EncodedAudioChunkMetadata) => void },
+): Promise<void>;
+export function audioCodecSupported(codec: AudioCodec, sampleRate?: number, numberOfChannels?: number): Promise<boolean>;
+/** An AudioEncoder configuration this browser accepts for `codec` (common rates and bitrates are tried), or null. */
+export function findAudioConfig(codec: AudioCodec, sampleRate?: number, numberOfChannels?: number, bitrate?: number): Promise<AudioEncoderConfig | null>;
+
+/** The audio track a muxer should add. */
+export interface MuxerAudioTrack {
+  codec: AudioCodec;
+  sampleRate: number;
+  numberOfChannels: number;
+  /** MP4 only: bitrate written into the AAC decoder config. */
+  bitrate?: number;
+}
+
+/** Minimal MP4 muxer (one H.264 track and an optional AAC or Opus track, fast start). Feed it encoder output, or raw samples. */
+export interface Mp4Muxer {
+  addChunk(chunk: EncodedVideoChunk, meta?: EncodedVideoChunkMetadata): void;
+  /** timestamp/duration in microseconds; data is length-prefixed NAL units. */
+  addSample(data: Uint8Array, info: { key: boolean; timestamp: number; duration?: number }): void;
+  /** AVCDecoderConfigurationRecord ('avcC'). */
+  setDescription(avcC: Uint8Array): void;
+  /** AudioEncoder output (needs the `audio` option). */
+  addAudioChunk(chunk: EncodedAudioChunk, meta?: EncodedAudioChunkMetadata): void;
+  /** One encoded audio frame, in order. timestamp/duration in microseconds. */
+  addAudioSample(data: Uint8Array, info: { timestamp: number; duration?: number }): void;
+  /** AAC AudioSpecificConfig (for Opus, an optional OpusHead to read the pre-skip from). */
+  setAudioDescription(config: Uint8Array): void;
+  finish(): Uint8Array;
+}
+export function createMp4Muxer(opts: { width: number; height: number; timescale?: number; audio?: MuxerAudioTrack | null }): Mp4Muxer;
+/** Minimal WebM muxer (one VP8/VP9/AV1 track and an optional Opus track, with SeekHead and Cues). */
+export interface WebmMuxer {
+  addChunk(chunk: EncodedVideoChunk, meta?: EncodedVideoChunkMetadata): void;
+  /** timestamp in microseconds */
+  addFrame(data: Uint8Array, info: { key: boolean; timestamp: number }): void;
+  /** AudioEncoder output (needs the `audio` option). */
+  addAudioChunk(chunk: EncodedAudioChunk, meta?: EncodedAudioChunkMetadata): void;
+  /** One Opus packet, in order. timestamp/duration in microseconds. */
+  addAudioFrame(data: Uint8Array, info: { timestamp: number; duration?: number }): void;
+  finish(): Uint8Array;
+}
+export function createWebmMuxer(opts: { width: number; height: number; codec?: 'vp8' | 'vp9' | 'av1'; fps?: number; audio?: (MuxerAudioTrack & { codec: 'opus' }) | null }): WebmMuxer;