node-av 5.1.0 → 5.1.1

package/benchmarks/cases/transcode.ts

@@ -1,271 +0,0 @@
-/**
- * Transcode Speed Benchmark Tests
- *
- * Compares transcoding performance between FFmpeg CLI and node-av
- * for various codec configurations.
- */
-
-import { dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { Decoder, Demuxer, Encoder, HardwareContext, Muxer, pipeline } from '../../src/api/index.js';
-import { FF_ENCODER_LIBX264, FF_ENCODER_LIBX265 } from '../../src/constants/encoders.js';
-import { runner } from '../runner.js';
-import { FFmpegArgs } from '../utils/ffmpeg-cli.js';
-
-import type { BenchmarkConfig } from '../runner.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// Default paths
-const testDataDir = resolve(__dirname, '../../testdata');
-const resultsDir = resolve(__dirname, '../results');
-
-/**
- * Default benchmark configuration
- */
-const defaultConfig = {
-  iterations: 5,
-  warmupIterations: 1,
-};
-
-/**
- * Software H.264 Transcode Benchmark
- */
-export async function benchmarkSWH264(inputFile?: string, outputFile?: string): Promise<void> {
-  const input = inputFile ?? join(testDataDir, 'video.mp4');
-  const output = outputFile ?? join(resultsDir, 'sw-h264-output.mp4');
-
-  const config: BenchmarkConfig = {
-    name: 'SW H.264 Transcode',
-    description: 'Software H.264 encoding with libx264 (CPU)',
-    category: 'transcode',
-    inputFile: input,
-    outputFile: output,
-    ...defaultConfig,
-  };
-
-  const ffmpegOptions = {
-    input,
-    output,
-    args: FFmpegArgs.swH264(23),
-  };
-
-  const nodeAVFn = async () => {
-    await using demuxer = await Demuxer.open(input);
-    const videoStream = demuxer.video();
-    if (!videoStream) throw new Error('No video stream found');
-
-    const decoder = await Decoder.create(videoStream);
-    const encoder = await Encoder.create(FF_ENCODER_LIBX264, {
-      decoder,
-      options: { preset: 'medium', crf: 23 },
-    });
-
-    await using muxer = await Muxer.open(output);
-
-    const control = pipeline(demuxer, decoder, encoder, muxer);
-    await control.completion;
-
-    // Get frame count from codec context
-    const ctx = encoder.getCodecContext();
-    return { framesProcessed: ctx?.frameNumber };
-  };
-
-  await runner.runBenchmark(config, ffmpegOptions, nodeAVFn);
-}
-
-/**
- * Software H.265/HEVC Transcode Benchmark
- */
-export async function benchmarkSWH265(inputFile?: string, outputFile?: string): Promise<void> {
-  const input = inputFile ?? join(testDataDir, 'video.mp4');
-  const output = outputFile ?? join(resultsDir, 'sw-h265-output.mp4');
-
-  const config: BenchmarkConfig = {
-    name: 'SW H.265 Transcode',
-    description: 'Software H.265/HEVC encoding with libx265 (CPU)',
-    category: 'transcode',
-    inputFile: input,
-    outputFile: output,
-    ...defaultConfig,
-  };
-
-  const ffmpegOptions = {
-    input,
-    output,
-    args: FFmpegArgs.swH265(28),
-  };
-
-  const nodeAVFn = async () => {
-    await using demuxer = await Demuxer.open(input);
-    const videoStream = demuxer.video();
-    if (!videoStream) throw new Error('No video stream found');
-
-    const decoder = await Decoder.create(videoStream);
-    const encoder = await Encoder.create(FF_ENCODER_LIBX265, {
-      decoder,
-      options: { preset: 'medium', crf: 28 },
-    });
-
-    await using muxer = await Muxer.open(output);
-
-    const control = pipeline(demuxer, decoder, encoder, muxer);
-    await control.completion;
-
-    // Get frame count from codec context
-    const ctx = encoder.getCodecContext();
-    return { framesProcessed: ctx?.frameNumber };
-  };
-
-  await runner.runBenchmark(config, ffmpegOptions, nodeAVFn);
-}
-
-/**
- * Hardware H.264 Transcode Benchmark (platform-dependent)
- */
-export async function benchmarkHWH264(inputFile?: string, outputFile?: string): Promise<void> {
-  const input = inputFile ?? join(testDataDir, 'video.mp4');
-  const output = outputFile ?? join(resultsDir, 'hw-h264-output.mp4');
-
-  // Check hardware availability
-  const hw = HardwareContext.auto();
-  if (!hw) {
-    console.log('⚠️  Skipping HW H.264 benchmark: No hardware acceleration available');
-    return;
-  }
-
-  const hwEncoderCodec = hw.getEncoderCodec('h264');
-  if (!hwEncoderCodec) {
-    console.log('⚠️  Skipping HW H.264 benchmark: No hardware H.264 encoder available');
-    hw.dispose();
-    return;
-  }
-
-  // Determine FFmpeg hardware encoder based on platform
-  let ffmpegArgs: string[];
-  const platform = process.platform;
-
-  if (platform === 'darwin') {
-    ffmpegArgs = FFmpegArgs.hwH264VideoToolbox();
-  } else if (platform === 'linux') {
-    // Try VAAPI first, then NVENC
-    ffmpegArgs = FFmpegArgs.hwH264Vaapi();
-  } else if (platform === 'win32') {
-    ffmpegArgs = FFmpegArgs.hwH264Nvenc();
-  } else {
-    console.log('⚠️  Skipping HW H.264 benchmark: Unknown platform');
-    hw.dispose();
-    return;
-  }
-
-  const config: BenchmarkConfig = {
-    name: 'HW H.264 Transcode',
-    description: `Hardware H.264 encoding (${hw.deviceTypeName})`,
-    category: 'transcode',
-    inputFile: input,
-    outputFile: output,
-    ...defaultConfig,
-  };
-
-  const ffmpegOptions = {
-    input,
-    output,
-    args: ffmpegArgs,
-  };
-
-  const nodeAVFn = async () => {
-    await using demuxer = await Demuxer.open(input);
-    const videoStream = demuxer.video();
-    if (!videoStream) throw new Error('No video stream found');
-
-    const decoder = await Decoder.create(videoStream, { hardware: hw });
-    const encoder = await Encoder.create(hwEncoderCodec, {
-      decoder,
-      bitrate: '2M',
-    });
-
-    await using muxer = await Muxer.open(output);
-
-    const control = pipeline(demuxer, decoder, encoder, muxer);
-    await control.completion;
-
-    // Get frame count from codec context
-    const ctx = encoder.getCodecContext();
-    return { framesProcessed: ctx?.frameNumber };
-  };
-
-  try {
-    await runner.runBenchmark(config, ffmpegOptions, nodeAVFn);
-  } finally {
-    hw.dispose();
-  }
-}
-
-/**
- * Stream Copy (Remux) Benchmark
- */
-export async function benchmarkStreamCopy(inputFile?: string, outputFile?: string): Promise<void> {
-  const input = inputFile ?? join(testDataDir, 'video.mp4');
-  const output = outputFile ?? join(resultsDir, 'stream-copy-output.mp4');
-
-  const config: BenchmarkConfig = {
-    name: 'Stream Copy (Remux)',
-    description: 'Copy streams without re-encoding',
-    category: 'transcode',
-    inputFile: input,
-    outputFile: output,
-    ...defaultConfig,
-  };
-
-  const ffmpegOptions = {
-    input,
-    output,
-    args: FFmpegArgs.streamCopy(),
-  };
-
-  const nodeAVFn = async () => {
-    await using demuxer = await Demuxer.open(input);
-    await using muxer = await Muxer.open(output);
-
-    // Add streams from demuxer to muxer (required for stream copy)
-    const streamMap = new Map<number, number>();
-    for (const stream of demuxer.streams) {
-      const outIndex = muxer.addStream(stream);
-      streamMap.set(stream.index, outIndex);
-    }
-
-    // Manual packet copy to count packets
-    let packetCount = 0;
-    for await (const packet of demuxer.packets()) {
-      if (!packet) break;
-      const outIndex = streamMap.get(packet.streamIndex);
-      if (outIndex !== undefined) {
-        await muxer.writePacket(packet, outIndex);
-        packetCount++;
-      }
-      packet.free();
-    }
-
-    return { framesProcessed: packetCount };
-  };
-
-  await runner.runBenchmark(config, ffmpegOptions, nodeAVFn);
-}
-
-/**
- * Run all transcode benchmarks
- */
-export async function runAllTranscodeBenchmarks(inputFile?: string): Promise<void> {
-  console.log('\n🎬 Running Transcode Speed Benchmarks\n');
-  console.log('='.repeat(60));
-
-  await benchmarkSWH264(inputFile);
-  await benchmarkSWH265(inputFile);
-  await benchmarkHWH264(inputFile);
-  await benchmarkStreamCopy(inputFile);
-
-  console.log('\n' + '='.repeat(60));
-  console.log('Transcode benchmarks completed\n');
-}

package/benchmarks/index.ts

@@ -1,264 +0,0 @@
-#!/usr/bin/env tsx
-/**
- * node-av Benchmark CLI
- *
- * Comprehensive benchmark suite comparing node-av with FFmpeg CLI.
- *
- * Usage:
- *   npm run benchmark              # Run all benchmarks
- *   npm run benchmark -- --help    # Show help
- *   npm run benchmark -- transcode # Run only transcode benchmarks
- *   npm run benchmark -- memory    # Run only memory benchmarks
- *   npm run benchmark -- latency   # Run only latency benchmarks
- *   npm run benchmark -- -i file1.mp4 -i file2.mp4  # Multiple inputs
- */
-
-import { existsSync, readdirSync } from 'node:fs';
-import { mkdir } from 'node:fs/promises';
-import { basename, dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { measureAllLatencies } from './cases/latency.js';
-import { runAllMemoryBenchmarks } from './cases/memory.js';
-import { runAllTranscodeBenchmarks } from './cases/transcode.js';
-import { runner } from './runner.js';
-import { createInputFileInfo, getSystemInfo, saveResultsJSON, writeReport } from './utils/report.js';
-
-import type { BenchmarkReport, InputFileInfo } from './utils/report.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// Default paths
-const testDataDir = resolve(__dirname, '../testdata');
-const resultsDir = resolve(__dirname, 'results');
-const defaultInputFile = join(testDataDir, 'video.mp4');
-
-/**
- * Parse command line arguments
- */
-function parseArgs(): { category?: string; inputFiles: string[]; help: boolean; noReport: boolean; iterations?: number; pattern?: string } {
-  const args = process.argv.slice(2);
-  let category: string | undefined;
-  const inputFiles: string[] = [];
-  let help = false;
-  let noReport = false;
-  let iterations: number | undefined;
-  let pattern: string | undefined;
-
-  for (let i = 0; i < args.length; i++) {
-    const arg = args[i];
-
-    if (arg === '--help' || arg === '-h') {
-      help = true;
-    } else if (arg === '--no-report') {
-      noReport = true;
-    } else if (arg === '--input' || arg === '-i') {
-      inputFiles.push(args[++i]);
-    } else if (arg === '--pattern' || arg === '-p') {
-      pattern = args[++i];
-    } else if (arg === '--iterations' || arg === '-n') {
-      iterations = parseInt(args[++i], 10);
-    } else if (!arg.startsWith('-')) {
-      category = arg;
-    }
-  }
-
-  return { category, inputFiles, help, noReport, iterations, pattern };
-}
-
-/**
- * Expand glob pattern to file list
- */
-function expandPattern(pattern: string): string[] {
-  const dir = dirname(pattern);
-  const filePattern = basename(pattern).replace('*', '.*');
-  const regex = new RegExp(`^${filePattern}$`);
-
-  if (!existsSync(dir)) return [];
-
-  return readdirSync(dir)
-    .filter((file) => regex.test(file))
-    .map((file) => join(dir, file))
-    .sort();
-}
-
-/**
- * Print help message
- */
-function printHelp(): void {
-  console.log(`
-node-av Benchmark Suite
-========================
-
-Usage:
-  npm run benchmark [options] [category]
-
-Categories:
-  transcode    Run transcode speed benchmarks
-  memory       Run memory usage benchmarks
-  latency      Run latency benchmarks
-  all          Run all benchmarks (default)
-
-Options:
-  -h, --help          Show this help message
-  -i, --input FILE    Use custom input file (can be repeated for multiple files)
-  -p, --pattern PAT   Use glob pattern to match input files
-  -n, --iterations N  Number of iterations per benchmark (default: 5)
-  --no-report         Skip generating BENCHMARK.md report
-
-Examples:
-  npm run benchmark                              # Run all benchmarks with default input
-  npm run benchmark transcode                    # Run only transcode benchmarks
-  npm run benchmark -- -i input.mp4              # Use custom input file
-  npm run benchmark -- -i h264.mp4 -i hevc.mp4   # Multiple input files
-  npm run benchmark -- -p "testdata/bbb-4k-*"    # Match pattern
-  npm run benchmark -- -n 10                     # Run 10 iterations
-  npm run benchmark -- --no-report               # Skip report generation
-`);
-}
-
-/**
- * Main benchmark runner
- */
-async function main(): Promise<void> {
-  const { category, inputFiles, help, noReport, pattern } = parseArgs();
-
-  if (help) {
-    printHelp();
-    process.exit(0);
-  }
-
-  // Resolve input files
-  let inputs: string[] = [];
-
-  if (pattern) {
-    inputs = expandPattern(pattern);
-    if (inputs.length === 0) {
-      console.error(`Error: No files matched pattern: ${pattern}`);
-      process.exit(1);
-    }
-  } else if (inputFiles.length > 0) {
-    inputs = inputFiles;
-  } else {
-    inputs = [defaultInputFile];
-  }
-
-  // Validate all input files exist
-  for (const input of inputs) {
-    if (!existsSync(input)) {
-      console.error(`Error: Input file not found: ${input}`);
-      console.error('Please provide a valid input file with --input or ensure testdata/video.mp4 exists.');
-      process.exit(1);
-    }
-  }
-
-  // Ensure results directory exists
-  if (!existsSync(resultsDir)) {
-    await mkdir(resultsDir, { recursive: true });
-  }
-
-  console.log(`
-╔═══════════════════════════════════════════════════════════════╗
-║              node-av Benchmark Suite                          ║
-╚═══════════════════════════════════════════════════════════════╝
-`);
-
-  // Print system info
-  console.log('Gathering system information...\n');
-  const systemInfo = await getSystemInfo();
-
-  console.log(`System: ${systemInfo.os} ${systemInfo.osVersion} (${systemInfo.arch})`);
-  console.log(`CPU: ${systemInfo.cpu} (${systemInfo.cpuCores} cores)`);
-  console.log(`RAM: ${systemInfo.ram}`);
-  if (systemInfo.gpu) {
-    console.log(`GPU: ${systemInfo.gpu}`);
-  }
-  console.log(`Node.js: ${systemInfo.nodeVersion}`);
-  console.log(`FFmpeg: ${systemInfo.ffmpegVersion}`);
-  console.log(`node-av: ${systemInfo.nodeAVVersion}`);
-  console.log(`Input files: ${inputs.length}`);
-  for (const input of inputs) {
-    console.log(`  - ${basename(input)}`);
-  }
-
-  // Get input file info for all files
-  const inputFileInfos: InputFileInfo[] = [];
-  for (const input of inputs) {
-    const info = await createInputFileInfo(input);
-    inputFileInfos.push(info);
-    console.log(`\n${basename(input)}:`);
-    if (info.duration > 0) {
-      console.log(`  Duration: ${info.duration.toFixed(1)}s`);
-      if (info.resolution) {
-        console.log(`  Resolution: ${info.resolution}`);
-      }
-      if (info.codec) {
-        console.log(`  Codec: ${info.codec}`);
-      }
-      if (info.fps) {
-        console.log(`  FPS: ${info.fps.toFixed(1)}`);
-      }
-    }
-  }
-
-  // Run benchmarks based on category for each input file
-  const categoryLower = category?.toLowerCase() ?? 'all';
-  let latencyMetrics;
-
-  for (const input of inputs) {
-    console.log(`\n${'='.repeat(60)}`);
-    console.log(`📁 Benchmarking: ${basename(input)}`);
-    console.log('='.repeat(60));
-
-    switch (categoryLower) {
-      case 'transcode':
-        await runAllTranscodeBenchmarks(input);
-        break;
-      case 'memory':
-        await runAllMemoryBenchmarks(input);
-        break;
-      case 'latency':
-        latencyMetrics = await measureAllLatencies(input, 10);
-        break;
-      case 'all':
-      default:
-        await runAllTranscodeBenchmarks(input);
-        await runAllMemoryBenchmarks(input);
-        // Only measure latency for first file (it's input-independent)
-        if (input === inputs[0]) {
-          latencyMetrics = await measureAllLatencies(input, 10);
-        }
-        break;
-    }
-  }
-
-  // Generate report if not disabled
-  if (!noReport) {
-    const results = runner.getResults();
-
-    const report: BenchmarkReport = {
-      systemInfo,
-      inputFileInfos,
-      transcodeResults: results.filter((r) => r.config.category === 'transcode'),
-      memoryResults: results.filter((r) => r.config.category === 'memory'),
-      latencyMetrics,
-      timestamp: new Date().toISOString(),
-    };
-
-    await writeReport(report);
-    saveResultsJSON(report);
-  }
-
-  console.log(`
-╔═══════════════════════════════════════════════════════════════╗
-║                    Benchmarks Complete                        ║
-╚═══════════════════════════════════════════════════════════════╝
-`);
-}
-
-// Run main
-main().catch((error) => {
-  console.error('Benchmark failed:', error);
-  process.exit(1);
-});

package/benchmarks/regen-report.ts

@@ -1,22 +0,0 @@
-/**
- * Regenerate BENCHMARK.md from existing results JSON
- */
-import { readFileSync, writeFileSync } from 'node:fs';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { generateReport } from './utils/report.js';
-
-import type { BenchmarkReport } from './utils/report.js';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const resultsPath = resolve(__dirname, 'results/benchmark-results.json');
-const outputPath = resolve(__dirname, '../BENCHMARK.md');
-
-const report: BenchmarkReport = JSON.parse(readFileSync(resultsPath, 'utf-8'));
-report.timestamp = new Date().toISOString();
-
-const markdown = await generateReport(report);
-writeFileSync(outputPath, markdown, 'utf-8');
-
-console.log('✓ BENCHMARK.md regenerated');

package/benchmarks/results/.gitkeep

@@ -1,2 +0,0 @@
-# This directory stores benchmark results (JSON)
-# These files are gitignored to keep the repository clean