mediasnacks 0.19.1 → 0.20.0

package/.zsh/completions/_mediasnacks

@@ -6,6 +6,7 @@ _mediasnacks_commands=(
   
   'resize:Resizes videos or images'
   'edgespic:Extracts first and last frames'
+  'ssim:Computes similarity of two images'
   'gif:Video to GIF'
   
   'detectdups:Detects sequentially duplicate frames in a video'
@@ -39,7 +40,7 @@ fi
 
 local cmd="$words[2]"
 case "$cmd" in
-	avif|resize|sqcrop|moov2front|detectdups|dropdups|edgespic|seqcheck|hev1tohvc1|framediff|vdiff|vconcat|vsplit|vtrim|dlaudio|dlvideo|unemoji|rmcover|curltime|gif|flattendir|prores)
+	avif|resize|sqcrop|moov2front|detectdups|dropdups|edgespic|seqcheck|hev1tohvc1|framediff|vdiff|vconcat|vsplit|vtrim|dlaudio|dlvideo|unemoji|rmcover|curltime|gif|flattendir|prores|ssim)
 		_files
 		;;
 	qdir)

package/README.md

@@ -31,6 +31,7 @@ mediasnacks <command> <args>
 
 - `resize` Resizes videos or images
 - `edgespic` Extracts first and last frames
+- `ssim` Computes similarity of two images
 - `gif`: Video to GIF
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediasnacks",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "Utilities for optimizing and preparing videos and images",
   "license": "MIT",
   "author": "Eric Fortis",

package/src/avif.test.js

@@ -1,8 +1,8 @@
 import { join } from 'node:path'
 import { test } from 'node:test'
-import { deepEqual } from 'node:assert/strict'
+import { ok } from 'node:assert/strict'
 
-import { videoAttrs } from './utils/ffmpeg.js'
+import { ssim } from './ssim.js'
 import { mkTempDir, cli } from './utils/test-utils.js'
 
 const rel = f => join(import.meta.dirname, f)
@@ -11,9 +11,6 @@ test('PNG to AVIF', async () => {
 	const tmp = mkTempDir('avif')
 	cli('avif', '--output-dir', tmp, rel('fixtures/lenna.png'))
 
-	deepEqual(
-		await videoAttrs(join(tmp, 'lenna.avif')),
-		await videoAttrs(rel('fixtures/lenna.avif')))
-	// That's because we use non-deterministic avif.
-	// Claude says: avif is deterministic only when it's single-threaded: '-threads 1'
+	const similarityScore = await ssim(join(tmp, 'lenna.avif'), rel('fixtures/lenna.avif'))
+	ok(similarityScore > 0.99, `Similarity too low: ${similarityScore}`)
 })

package/src/cli.js

@@ -12,6 +12,7 @@ const COMMANDS = {
 
 	resize: ['resize.js', 'Resizes videos or images'],
 	edgespic: ['edgespic.js', 'Extracts first and last frames'],
+	ssim: ['ssim.js', 'Computes SSIM between two images'],
 	gif: ['gif.sh', 'Video to GIF\n'],
 
 	detectdups: ['detectdups.js', 'Detects duplicate frames in a video'],

package/src/edgespic.test.js

@@ -1,9 +1,10 @@
+import { ok } from 'node:assert/strict'
 import { join } from 'node:path'
-import { ok, equal } from 'node:assert/strict'
 import { describe, test } from 'node:test'
 import { cpSync, readdirSync, } from 'node:fs'
 
-import { cli, mkTempDir, sha1 } from './utils/test-utils.js'
+import { ssim } from './ssim.js'
+import { cli, mkTempDir } from './utils/test-utils.js'
 
 const rel = f => join(import.meta.dirname, f)
 
@@ -18,15 +19,18 @@ describe('edgespic', () => {
 		ok(files.length === 2, `Expected 2 PNG files, got ${files.length}`)
 	})
 
-	test('extracts first frame', () => {
+	test('extracts first frame', async () => {
+		const out = join(tmp, 'edgespic', '60fps_first.png')
 		const fixture = rel('fixtures/edgespic/60fps_first.png')
-		const generated = join(tmp, 'edgespic', '60fps_first.png')
-		equal(sha1(generated), sha1(fixture))
+		const similarityScore = await ssim(out, fixture)
+		ok(similarityScore > 0.99, `Similarity too low: ${similarityScore}`)
 	})
 
-	test('extracts last frame', () => {
+	test('extracts last frame', async () => {
+		const out = join(tmp, 'edgespic', '60fps_last.png')
 		const fixture = rel('fixtures/edgespic/60fps_last.png')
-		const generated = join(tmp, 'edgespic', '60fps_last.png')
-		equal(sha1(generated), sha1(fixture))
+		const similarityScore = await ssim(out, fixture)
+		ok(similarityScore > 0.99, `Similarity too low: ${similarityScore}`)
 	})
 })
+

package/src/ssim.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+import { ffmpeg } from './utils/ffmpeg.js'
+
+
+const MAN = `
+SYNOPSIS
+  mediasnacks ssim <img1> <img2>
+
+DESCRIPTION
+  Computes the Structural Similarity Index (SSIM) between two images using ffmpeg.
+`.trim()
+
+
+async function main() {
+	const [img1, img2] = process.argv.slice(2)
+	if (!img1 || !img2) {
+		console.log(MAN)
+		process.exit(1)
+	}
+
+	const score = await ssim(img1, img2)
+	console.log(score)
+}
+
+export async function ssim(img1, img2) {
+	const result = await ffmpeg([
+		'-i', img1,
+		'-i', img2,
+		'-filter_complex', 'ssim',
+		'-f', 'null', '-'
+	])
+	const match = result.stderr.match(/All:([\d.]+)/)
+	if (!match)
+		throw new Error(`Could not parse SSIM output:\n${result.stderr}`)
+	return parseFloat(match[1])
+}
+
+
+if (import.meta.main)
+	main().catch(err => {
+		console.error(err.message)
+		process.exit(1)
+	})

package/src/utils/ffmpeg.js

@@ -1,10 +1,6 @@
 import { spawn } from 'node:child_process'
 
 
-export async function ffmpeg(args) {
-	return runSilently('ffmpeg', args)
-}
-
 export async function assertUserHasFFmpeg() {
 	try {
 		await runSilently('ffmpeg', ['-version'])
@@ -15,6 +11,9 @@ export async function assertUserHasFFmpeg() {
 	}
 }
 
+export async function ffmpeg(args) {
+	return runSilently('ffmpeg', args)
+}
 
 async function runSilently(program, args) {
 	return new Promise((resolve, reject) => {

package/src/utils/test-utils.js

@@ -1,7 +1,7 @@
-import { join }                               from 'node:path'
-import { tmpdir }                              from 'node:os'
-import { spawnSync }                           from 'node:child_process'
-import { createHash }                           from 'node:crypto'
+import { join } from 'node:path'
+import { tmpdir } from 'node:os'
+import { spawnSync } from 'node:child_process'
+import { createHash } from 'node:crypto'
 import { mkdtempSync, readFileSync, mkdirSync, writeFileSync } from 'node:fs'
 
 const rel = f => join(import.meta.dirname, f)