@napi-rs/webcodecs 0.0.0

package/package.json

@@ -0,0 +1,150 @@
+{
+  "name": "@napi-rs/webcodecs",
+  "version": "0.0.0",
+  "description": "WebCodecs API implementation for Node.js using FFmpeg",
+  "keywords": [
+    "N-API",
+    "NAPI",
+    "Rust",
+    "napi-rs",
+    "node-addon",
+    "node-addon-api"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/Brooooooklyn/webcodecs-node.git"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.js"
+    },
+    "./polyfill": {
+      "types": "./polyfill.d.ts",
+      "import": "./polyfill.js",
+      "require": "./polyfill.js"
+    }
+  },
+  "browser": "browser.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts",
+    "index.js",
+    "polyfill.d.ts",
+    "polyfill.js",
+    "standard.d.ts"
+  ],
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "bench": "node --import @oxc-node/core/register benchmark/bench.ts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "format": "run-p format:rs format:toml format:oxfmt format:prettier",
+    "format:prettier": "prettier . \"!**/*.{js,jsx,ts,tsx}\" -w",
+    "format:oxfmt": "oxfmt",
+    "format:toml": "taplo format",
+    "format:rs": "cargo fmt",
+    "lint": "oxlint --type-aware",
+    "prepublishOnly": "napi prepublish -t npm",
+    "test": "ava",
+    "typecheck": "tsc -b tsconfig.json",
+    "version": "napi version"
+  },
+  "lint-staged": {
+    "*.@(js|ts|tsx)": [
+      "oxlint --fix",
+      "oxfmt"
+    ],
+    "*.@(yml|yaml|md|json)": [
+      "prettier --write"
+    ],
+    "*.toml": [
+      "taplo format"
+    ]
+  },
+  "devDependencies": {
+    "@emnapi/core": "^1.7.1",
+    "@emnapi/runtime": "^1.7.1",
+    "@napi-rs/cli": "^3.5.0",
+    "@napi-rs/wasm-runtime": "^1.1.0",
+    "@oxc-node/core": "^0.0.35",
+    "@taplo/cli": "^0.7.0",
+    "@tybys/wasm-util": "^0.10.1",
+    "@types/node": "^25.0.2",
+    "ava": "^6.4.1",
+    "chalk": "^5.6.2",
+    "emnapi": "^1.7.1",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "mediabunny": "1.26.0",
+    "npm-run-all2": "^8.0.4",
+    "oxfmt": "^0.18.0",
+    "oxlint": "^1.33.0",
+    "oxlint-tsgolint": "^0.9.1",
+    "prettier": "^3.7.4",
+    "tinybench": "^6.0.0",
+    "typescript": "^5.9.3"
+  },
+  "napi": {
+    "binaryName": "webcodecs",
+    "constEnum": false,
+    "dtsHeaderFile": "dts-header.d.ts",
+    "targets": [
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl",
+      "x86_64-pc-windows-msvc",
+      "aarch64-unknown-linux-gnu",
+      "aarch64-unknown-linux-musl",
+      "aarch64-pc-windows-msvc",
+      "armv7-unknown-linux-gnueabihf"
+    ]
+  },
+  "packageManager": "pnpm@10.26.0",
+  "prettier": {
+    "arrowParens": "always",
+    "printWidth": 120,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "all"
+  },
+  "ava": {
+    "environmentVariables": {
+      "TS_NODE_PROJECT": "./tsconfig.json"
+    },
+    "extensions": {
+      "ts": "module"
+    },
+    "files": [
+      "__test__/**/*.spec.ts"
+    ],
+    "nodeArguments": [
+      "--import",
+      "@oxc-node/core/register"
+    ],
+    "timeout": "5m",
+    "workerThreads": false
+  },
+  "engines": {
+    "node": ">= 10"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "optionalDependencies": {
+    "@napi-rs/webcodecs-darwin-x64": "0.0.0",
+    "@napi-rs/webcodecs-darwin-arm64": "0.0.0",
+    "@napi-rs/webcodecs-linux-x64-gnu": "0.0.0",
+    "@napi-rs/webcodecs-linux-x64-musl": "0.0.0",
+    "@napi-rs/webcodecs-win32-x64-msvc": "0.0.0",
+    "@napi-rs/webcodecs-linux-arm64-gnu": "0.0.0",
+    "@napi-rs/webcodecs-linux-arm64-musl": "0.0.0",
+    "@napi-rs/webcodecs-win32-arm64-msvc": "0.0.0",
+    "@napi-rs/webcodecs-linux-arm-gnueabihf": "0.0.0"
+  }
+}

package/polyfill.d.ts

@@ -0,0 +1,33 @@
+import type {
+  AudioData,
+  AudioDecoder,
+  AudioEncoder,
+  DOMRectReadOnly,
+  EncodedAudioChunk,
+  EncodedVideoChunk,
+  ImageDecoder,
+  ImageTrack,
+  ImageTrackList,
+  VideoColorSpace,
+  VideoDecoder,
+  VideoEncoder,
+  VideoFrame,
+} from './index'
+
+declare global {
+  var VideoEncoder: typeof import('./index').VideoEncoder
+  var VideoDecoder: typeof import('./index').VideoDecoder
+  var AudioEncoder: typeof import('./index').AudioEncoder
+  var AudioDecoder: typeof import('./index').AudioDecoder
+  var VideoFrame: typeof import('./index').VideoFrame
+  var AudioData: typeof import('./index').AudioData
+  var EncodedVideoChunk: typeof import('./index').EncodedVideoChunk
+  var EncodedAudioChunk: typeof import('./index').EncodedAudioChunk
+  var ImageDecoder: typeof import('./index').ImageDecoder
+  var VideoColorSpace: typeof import('./index').VideoColorSpace
+  var ImageTrack: typeof import('./index').ImageTrack
+  var ImageTrackList: typeof import('./index').ImageTrackList
+  var DOMRectReadOnly: typeof import('./index').DOMRectReadOnly
+}
+
+export {}

package/polyfill.js

@@ -0,0 +1,20 @@
+const webcodecs = require('./index.js')
+
+// WebCodecs classes (W3C spec)
+globalThis.VideoEncoder ??= webcodecs.VideoEncoder
+globalThis.VideoDecoder ??= webcodecs.VideoDecoder
+globalThis.AudioEncoder ??= webcodecs.AudioEncoder
+globalThis.AudioDecoder ??= webcodecs.AudioDecoder
+globalThis.VideoFrame ??= webcodecs.VideoFrame
+globalThis.AudioData ??= webcodecs.AudioData
+globalThis.EncodedVideoChunk ??= webcodecs.EncodedVideoChunk
+globalThis.EncodedAudioChunk ??= webcodecs.EncodedAudioChunk
+globalThis.ImageDecoder ??= webcodecs.ImageDecoder
+globalThis.VideoColorSpace ??= webcodecs.VideoColorSpace
+
+// Supporting types (W3C spec)
+globalThis.ImageTrack ??= webcodecs.ImageTrack
+globalThis.ImageTrackList ??= webcodecs.ImageTrackList
+
+// DOM types needed by WebCodecs (not available in Node.js)
+globalThis.DOMRectReadOnly ??= webcodecs.DOMRectReadOnly

package/standard.d.ts

@@ -0,0 +1,413 @@
+/**
+ * Standard WebCodecs type definitions
+ * W3C WebCodecs Spec: https://w3c.github.io/webcodecs/
+ *
+ * These types match the W3C WebCodecs specification for interoperability.
+ */
+
+// ============================================================================
+// BufferSource Types
+// ============================================================================
+
+/**
+ * BufferSource per WebIDL spec - union of ArrayBuffer and ArrayBufferView
+ */
+export type BufferSource = ArrayBufferView | ArrayBuffer
+
+/**
+ * AllowSharedBufferSource per WebIDL spec - includes SharedArrayBuffer
+ */
+export type AllowSharedBufferSource = ArrayBuffer | SharedArrayBuffer | ArrayBufferView
+
+// ============================================================================
+// EncodedVideoChunk Types
+// ============================================================================
+
+/**
+ * Type of encoded video chunk
+ * @see https://w3c.github.io/webcodecs/#enumdef-encodedvideochunktype
+ */
+export type EncodedVideoChunkType = 'key' | 'delta'
+
+/**
+ * Init dictionary for EncodedVideoChunk constructor
+ * @see https://w3c.github.io/webcodecs/#dictdef-encodedvideochunkinit
+ */
+export interface EncodedVideoChunkInit {
+  /** Chunk type - 'key' for keyframes, 'delta' for dependent frames */
+  type: EncodedVideoChunkType
+  /** Timestamp in microseconds */
+  timestamp: number
+  /** Duration in microseconds (optional) */
+  duration?: number
+  /** Encoded video data */
+  data: BufferSource
+  /** ArrayBuffers to transfer (optional, for zero-copy) */
+  transfer?: ArrayBuffer[]
+}
+
+// ============================================================================
+// EncodedAudioChunk Types
+// ============================================================================
+
+/**
+ * Type of encoded audio chunk
+ * @see https://w3c.github.io/webcodecs/#enumdef-encodedaudiochunktype
+ */
+export type EncodedAudioChunkType = 'key' | 'delta'
+
+/**
+ * Init dictionary for EncodedAudioChunk constructor
+ * @see https://w3c.github.io/webcodecs/#dictdef-encodedaudiochunkinit
+ */
+export interface EncodedAudioChunkInit {
+  /** Chunk type - 'key' for keyframes, 'delta' for dependent frames */
+  type: EncodedAudioChunkType
+  /** Timestamp in microseconds */
+  timestamp: number
+  /** Duration in microseconds (optional) */
+  duration?: number
+  /** Encoded audio data */
+  data: BufferSource
+  /** ArrayBuffers to transfer (optional, for zero-copy) */
+  transfer?: ArrayBuffer[]
+}
+
+// ============================================================================
+// VideoEncoder Types
+// ============================================================================
+
+/**
+ * Hardware acceleration preference
+ * @see https://w3c.github.io/webcodecs/#enumdef-hardwareacceleration
+ */
+export type HardwareAcceleration = 'no-preference' | 'prefer-hardware' | 'prefer-software'
+
+/**
+ * Latency mode for encoding
+ * @see https://w3c.github.io/webcodecs/#enumdef-latencymode
+ */
+export type LatencyMode = 'quality' | 'realtime'
+
+/**
+ * Bitrate mode for video encoding
+ * @see https://w3c.github.io/webcodecs/#enumdef-videoencoderbitratemode
+ */
+export type VideoEncoderBitrateMode = 'constant' | 'variable' | 'quantizer'
+
+/**
+ * Alpha channel handling
+ * @see https://w3c.github.io/webcodecs/#enumdef-alphaoption
+ */
+export type AlphaOption = 'discard' | 'keep'
+
+/**
+ * VideoEncoder configuration
+ * @see https://w3c.github.io/webcodecs/#dictdef-videoencoderconfig
+ */
+export interface VideoEncoderConfig {
+  /** Codec string (e.g., 'avc1.42001E', 'vp8', 'vp09.00.10.08') */
+  codec: string
+  /** Coded width in pixels */
+  width: number
+  /** Coded height in pixels */
+  height: number
+  /** Display width (optional, defaults to width) */
+  displayWidth?: number
+  /** Display height (optional, defaults to height) */
+  displayHeight?: number
+  /** Target bitrate in bits per second */
+  bitrate?: number
+  /** Target framerate */
+  framerate?: number
+  /** Hardware acceleration preference */
+  hardwareAcceleration?: HardwareAcceleration
+  /** Alpha channel handling */
+  alpha?: AlphaOption
+  /** Scalability mode (e.g., 'L1T1', 'L1T2') */
+  scalabilityMode?: string
+  /** Bitrate mode */
+  bitrateMode?: VideoEncoderBitrateMode
+  /** Latency mode */
+  latencyMode?: LatencyMode
+  /** AVC-specific configuration */
+  avc?: AvcEncoderConfig
+  /** HEVC-specific configuration */
+  hevc?: HevcEncoderConfig
+}
+
+/**
+ * AVC (H.264) encoder configuration
+ * @see https://w3c.github.io/webcodecs/avc_codec_registration.html
+ */
+export interface AvcEncoderConfig {
+  /** Bitstream format */
+  format?: 'avc' | 'annexb'
+}
+
+/**
+ * HEVC (H.265) encoder configuration
+ * @see https://w3c.github.io/webcodecs/hevc_codec_registration.html
+ */
+export interface HevcEncoderConfig {
+  /** Bitstream format */
+  format?: 'hevc' | 'annexb'
+}
+
+// ============================================================================
+// VideoDecoder Types
+// ============================================================================
+
+/**
+ * VideoDecoder configuration
+ * @see https://w3c.github.io/webcodecs/#dictdef-videodecoderconfig
+ */
+export interface VideoDecoderConfig {
+  /** Codec string */
+  codec: string
+  /** Coded width (optional for some codecs) */
+  codedWidth?: number
+  /** Coded height (optional for some codecs) */
+  codedHeight?: number
+  /** Display aspect width */
+  displayAspectWidth?: number
+  /** Display aspect height */
+  displayAspectHeight?: number
+  /** Color space information */
+  colorSpace?: VideoColorSpaceInit
+  /** Hardware acceleration preference */
+  hardwareAcceleration?: HardwareAcceleration
+  /** Optimize for latency */
+  optimizeForLatency?: boolean
+  /** Codec-specific description (e.g., avcC box for H.264) */
+  description?: BufferSource
+  /** Rotation in degrees clockwise (0, 90, 180, 270) - W3C WebCodecs spec */
+  rotation?: number
+  /** Horizontal flip - W3C WebCodecs spec */
+  flip?: boolean
+}
+
+// ============================================================================
+// AudioEncoder Types
+// ============================================================================
+
+/**
+ * Bitrate mode for audio encoding
+ * @see https://w3c.github.io/webcodecs/#enumdef-bitratemode
+ */
+export type BitrateMode = 'constant' | 'variable'
+
+/**
+ * AudioEncoder configuration
+ * @see https://w3c.github.io/webcodecs/#dictdef-audioencoderconfig
+ */
+export interface AudioEncoderConfig {
+  /** Codec string (e.g., 'opus', 'mp4a.40.2') */
+  codec: string
+  /** Sample rate in Hz */
+  sampleRate: number
+  /** Number of audio channels */
+  numberOfChannels: number
+  /** Target bitrate in bits per second */
+  bitrate?: number
+  /** Bitrate mode */
+  bitrateMode?: BitrateMode
+  /** Opus-specific configuration */
+  opus?: OpusEncoderConfig
+  /** AAC-specific configuration */
+  aac?: AacEncoderConfig
+}
+
+/**
+ * Opus encoder configuration
+ * @see https://w3c.github.io/webcodecs/opus_codec_registration.html
+ */
+export interface OpusEncoderConfig {
+  /** Opus application type */
+  application?: 'voip' | 'audio' | 'lowdelay'
+  /** Frame duration in microseconds */
+  frameDuration?: number
+  /** Complexity (0-10) */
+  complexity?: number
+  /** Use DTX (discontinuous transmission) */
+  usedtx?: boolean
+  /** Use in-band FEC */
+  useinbandfec?: boolean
+  /** Packet loss percentage hint */
+  packetlossperc?: number
+}
+
+/**
+ * AAC encoder configuration
+ * @see https://w3c.github.io/webcodecs/aac_codec_registration.html
+ */
+export interface AacEncoderConfig {
+  /** AAC format */
+  format?: 'aac' | 'adts'
+}
+
+// ============================================================================
+// AudioDecoder Types
+// ============================================================================
+
+/**
+ * AudioDecoder configuration
+ * @see https://w3c.github.io/webcodecs/#dictdef-audiodecoderconfig
+ */
+export interface AudioDecoderConfig {
+  /** Codec string */
+  codec: string
+  /** Sample rate in Hz */
+  sampleRate: number
+  /** Number of audio channels */
+  numberOfChannels: number
+  /** Codec-specific description */
+  description?: BufferSource
+}
+
+// ============================================================================
+// VideoFrame Types
+// ============================================================================
+
+/**
+ * Pixel format for video frames
+ * @see https://w3c.github.io/webcodecs/#enumdef-videoframepixelformat
+ */
+export type VideoPixelFormat =
+  | 'I420'
+  | 'I420A'
+  | 'I422'
+  | 'I422A'
+  | 'I444'
+  | 'I444A'
+  | 'I420P10'
+  | 'I420AP10'
+  | 'I422P10'
+  | 'I422AP10'
+  | 'I444P10'
+  | 'I444AP10'
+  | 'I420P12'
+  | 'I422P12'
+  | 'I444P12'
+  | 'NV12'
+  | 'NV21'
+  | 'RGBA'
+  | 'RGBX'
+  | 'BGRA'
+  | 'BGRX'
+
+/**
+ * VideoFrame buffer init
+ * @see https://w3c.github.io/webcodecs/#dictdef-videoframebufferinit
+ */
+export interface VideoFrameBufferInit {
+  /** Pixel format */
+  format: VideoPixelFormat
+  /** Coded width */
+  codedWidth: number
+  /** Coded height */
+  codedHeight: number
+  /** Timestamp in microseconds */
+  timestamp: number
+  /** Duration in microseconds */
+  duration?: number
+  /** Display width */
+  displayWidth?: number
+  /** Display height */
+  displayHeight?: number
+  /** Color space */
+  colorSpace?: VideoColorSpaceInit
+}
+
+// ============================================================================
+// VideoColorSpace Types
+// ============================================================================
+
+/**
+ * Color primaries
+ * @see https://w3c.github.io/webcodecs/#enumdef-videocolorprimaries
+ */
+export type VideoColorPrimaries = 'bt709' | 'bt470bg' | 'smpte170m' | 'bt2020' | 'smpte432'
+
+/**
+ * Transfer characteristics
+ * @see https://w3c.github.io/webcodecs/#enumdef-videotransfercharacteristics
+ */
+export type VideoTransferCharacteristics = 'bt709' | 'smpte170m' | 'iec61966-2-1' | 'srgb' | 'linear' | 'pq' | 'hlg'
+
+/**
+ * Matrix coefficients
+ * @see https://w3c.github.io/webcodecs/#enumdef-videomatrixcoefficients
+ */
+export type VideoMatrixCoefficients = 'rgb' | 'bt709' | 'bt470bg' | 'smpte170m' | 'bt2020-ncl'
+
+/**
+ * VideoColorSpace init dictionary
+ * @see https://w3c.github.io/webcodecs/#dictdef-videocolorspaceinit
+ */
+export interface VideoColorSpaceInit {
+  /** Color primaries */
+  primaries?: VideoColorPrimaries | null
+  /** Transfer characteristics */
+  transfer?: VideoTransferCharacteristics | null
+  /** Matrix coefficients */
+  matrix?: VideoMatrixCoefficients | null
+  /** Full range flag */
+  fullRange?: boolean | null
+}
+
+// ============================================================================
+// AudioData Types
+// ============================================================================
+
+/**
+ * Audio sample format
+ * @see https://w3c.github.io/webcodecs/#enumdef-audiosampleformat
+ */
+export type AudioSampleFormat = 'u8' | 's16' | 's32' | 'f32' | 'u8-planar' | 's16-planar' | 's32-planar' | 'f32-planar'
+
+/**
+ * AudioData init dictionary
+ * @see https://w3c.github.io/webcodecs/#dictdef-audiodatainit
+ */
+export interface AudioDataInit {
+  /** Sample format */
+  format: AudioSampleFormat
+  /** Sample rate in Hz */
+  sampleRate: number
+  /** Number of frames (samples per channel) */
+  numberOfFrames: number
+  /** Number of channels */
+  numberOfChannels: number
+  /** Timestamp in microseconds */
+  timestamp: number
+  /** Audio data */
+  data: BufferSource
+  /** ArrayBuffers to transfer */
+  transfer?: ArrayBuffer[]
+}
+
+// ============================================================================
+// ImageDecoder Types
+// ============================================================================
+
+/**
+ * ImageDecoder init dictionary
+ * @see https://w3c.github.io/webcodecs/#dictdef-imagedecodeinit
+ */
+export interface ImageDecoderInit {
+  /** Image data */
+  data: BufferSource | ReadableStream<Uint8Array>
+  /** MIME type */
+  type: string
+  /** Color space conversion */
+  colorSpaceConversion?: 'none' | 'default'
+  /** Desired width */
+  desiredWidth?: number
+  /** Desired height */
+  desiredHeight?: number
+  /** Prefer animation */
+  preferAnimation?: boolean
+  /** ArrayBuffers to transfer */
+  transfer?: ArrayBuffer[]
+}