mediasnacks 0.22.5 → 0.24.0

package/README.md

@@ -26,6 +26,7 @@ mediasnacks <command> <args>
 
 ### Commands
 - `avif` Converts images to AVIF
+- `png` Optimizes PNG images with oxipng
 - `sqcrop` Square crops images
 
 

package/package.json

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

package/src/avif.js

@@ -29,7 +29,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (!files.length)

package/src/cli.js

@@ -8,6 +8,7 @@ import pkgJSON from '../package.json' with { type: 'json' }
 
 const COMMANDS = {
 	avif: ['avif.js', 'Converts images to AVIF'],
+	png: ['png.sh', 'Optimizes PNG images with oxipng'],
 	sqcrop: ['sqcrop.js', 'Square crops images\n'],
 
 	resize: ['resize.js', 'Resizes videos or images'],
@@ -59,11 +60,11 @@ function main() {
 
 	if (opt === '-v' || opt === '--version') {
 		console.log(pkgJSON.version)
-		process.exit(0)
+		return
 	}
 	if (opt === '-h' || opt === '--help') {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (!opt) {

package/src/detectdups.js

@@ -41,7 +41,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (files.length !== 1)
@@ -62,15 +62,9 @@ async function main() {
 		? Number(values.duration)
 		: vDur > 60 ? 20 : vDur
 
-	if (isNaN(seek) || seek < 0)
-		throw new Error(`Invalid --seek value: ${values.seek}`)
-
-	if (isNaN(duration) || duration < 1)
-		throw new Error(`Invalid --duration value: ${values.duration}`)
-
-	if ((seek + duration) > vDur)
-		throw new Error(`Invalid analysis range. Exceeds video duration: ${vDur}`)
-
+	if (isNaN(seek) || seek < 0) throw new Error(`Invalid --seek value: ${values.seek}`)
+	if (isNaN(duration) || duration < 1) throw new Error(`Invalid --duration value: ${values.duration}`)
+	if ((seek + duration) > vDur) throw new Error(`Invalid analysis range. Exceeds video duration: ${vDur}`)
 
 	const dups = await detectdups(files[0], seek, duration)
 	const h = deltaHistogram(dups)

package/src/dropdups.js

@@ -4,10 +4,10 @@ import { resolve, parse, format } from 'node:path'
 
 import { parseOptions } from './utils/parseOptions.js'
 import { ffmpeg, assertUserHasFFmpeg, run } from './utils/subprocess.js'
-import { PRORES_PROFILES } from './prores.js'
+import { ProresProfiles } from './prores.js'
 
 
-const PROFILE = PRORES_PROFILES.hq
+const PROFILE = ProresProfiles.default
 
 const HELP = `
 SYNOPSIS
@@ -40,7 +40,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (!files.length)
@@ -65,9 +65,7 @@ async function dropdups(video, dupFrameNum) {
 			? `decimate=cycle=${dupFrameNum}`
 			: 'mpdecimate,setpts=N/FRAME_RATE/TB',
 		'-fps_mode', 'cfr',
-		'-c:v', 'prores_ks',
-		'-profile:v', PROFILE,
-		'-pix_fmt', 'yuv422p10le',
+		'-c:v', 'prores_ks', '-profile:v', PROFILE,
 		makeOutputPath(video)
 	])
 }

package/src/edgespic.js

@@ -33,7 +33,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	const width = Number(values['width'])

package/src/flattendir.sh

@@ -9,17 +9,11 @@ DESCRIPTION
   Moves unique files from subdirectories into the top-level folder, then
   deletes empty directories. Defaults to the current working directory.
 EOF
+  exit "${1:-0}"
 }
 
-if [ "$1" = "-h" ]; then
-  help
-  exit 0
-fi
-
-if [ $# -gt 0 ] && [ ! -d "$1" ]; then
-  help
-  exit 1
-fi
+[ "$1" = "-h" ] && help
+[ $# -gt 0 ] && [ ! -d "$1" ] && help 1
 
 DIR="${1:-$(pwd)}"
 

package/src/framediff.sh

@@ -16,17 +16,11 @@ TIPS
 SEE ALSO
   mediasnacks detectdups, ffplay(1)
 EOF
+  exit "${1:-0}"
 }
 
-if [ "$1" = "-h" ]; then
-  help
-  exit 0
-fi
-
-if [ ! -f "$1" ]; then
-  help
-  exit 1
-fi
+[ "$1" = "-h" ] && help
+[ ! -f "$1" ] && help 1
 
 ffplay -v error "$1" -vf "
     tblend=all_mode=difference,

package/src/gif.sh

@@ -1,13 +1,21 @@
 #!/bin/sh
 
-# Converts to GIF
-
 FPS=10
 WIDTH=600
 
-usage() {
-  echo "Usage: mediasnacks gif [--fps <number>] [--width <pixels>] <file>"
-  exit 1
+help() {
+  /bin/cat << EOF
+SYNOPSIS
+  mediasnacks gif [--fps <number>] [-w | --width <pixels>] <file>
+
+DESCRIPTION
+  Converts video to GIF
+
+OPTIONS
+  --fps       Default: $FPS
+  -w,--width  Default: $WIDTH
+EOF
+  exit "${1:-0}"
 }
 
 while [ $# -gt 0 ]; do
@@ -15,18 +23,21 @@ while [ $# -gt 0 ]; do
     --fps)
       FPS="$2";
       shift 2 ;;
-    --width)
+
+    --width|-w)
       WIDTH="$2"
       shift 2 ;;
+
     --help|-h)
-      usage ;;
+      help ;;
+
     *)
       file="$1"
       shift ;;
   esac
 done
 
-[ -z "$file" ] && usage
+[ -z "$file" ] && help 1
 
 ffmpeg -v error -i "$file" \
   -vf "fps=${FPS},scale=${WIDTH}:-1" \

package/src/hev1tohvc1.js

@@ -19,12 +19,18 @@ DESCRIPTION
 async function main() {
 	await assertUserHasFFmpeg()
 
-	const { files } = await parseOptions()
+	const { values, files } = await parseOptions({
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
+		console.log(HELP)
+		return
+	}
 
 	if (!files.length)
 		throw new Error(HELP)
 
-	console.log('HEV1 to HVC1…')
 	for (const file of files)
 		await hev1tohvc1(file)
 }

package/src/moov2front.js

@@ -23,7 +23,14 @@ NOTES
 async function main() {
 	await assertUserHasFFmpeg()
 
-	const { files } = await parseOptions()
+	const { values, files } = await parseOptions({
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
+		console.log(HELP)
+		return
+	}
 
 	if (!files.length)
 		throw new Error(HELP)

package/src/play.js

@@ -25,7 +25,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	const files = findFiles({
@@ -54,6 +54,7 @@ function play(files) {
 			console.error('Error: MPV is not installed')
 		else
 			console.log(err)
+		process.exit(1)
 	})
 }
 

package/src/png.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+help() {
+  /bin/cat << EOF
+SYNOPSIS
+  mediasnacks png <img1> [img2 ...]
+
+DESCRIPTION
+  Losslessly optimizes PNG images with oxipng at max level.
+
+EXAMPLE
+	mediasnacks png *.png
+EOF
+  exit "${1:-0}"
+}
+
+[ "$1" = "-h" ] && help
+[ $# -eq 0 ] && help 1
+
+oxipng --opt max "$@"

package/src/prores.js

@@ -3,13 +3,24 @@ import { resolve, parse, join } from 'node:path'
 import { parseOptions } from './utils/parseOptions.js'
 import { assertUserHasFFmpeg, run } from './utils/subprocess.js'
 
-export const PRORES_PROFILES = {
-	'proxy': 0,
-	'lt': 1,
-	'standard': 2,
-	'hq': 3,
-	'4444': 4,
-	'4444xq': 5,
+export const ProresProfiles = new class {
+  // https://github.com/oyvindln/vhs-decode/wiki/ProRes-The-Definitive-FFmpeg-Guide#profiles-can-be-the-following
+	profiles = {
+		// 10-bit
+		0: 'proxy',
+		1: 'lt',
+		2: 'standard',
+		3: 'hq',
+
+		// 12-bit
+		4: '4444',
+		5: '4444xq'
+	}
+	default = 3
+
+	list = () => Object.keys(this.profiles)
+	isValid = n => Object.hasOwn(this.profiles, n)
+	table = () => Object.entries(this.profiles)
 }
 
 const HELP = `
@@ -17,15 +28,21 @@ SYNOPSIS
   mediasnacks prores [options] <video>
 
 DESCRIPTION
-  Converts a video to ProRes format.
+  Converts a video to ProRes
 
 OPTIONS
-  -p, --profile <n>  ProRes profile (default: 3 (422 HQ))
+  -p, --profile <n>    Default: 3 (422 HQ 10-bit)
+  -s, --start <time>   Start time (e.g. 5.0). Default: beginning.
+  -e, --end <time>     End time (e.g. 0:10.0). Default: end of video.
   -h, --help
 
+PROFILES
+${ProresProfiles.table().map(([num, name]) =>
+	`  ${num}: ${name}`).join('\n')}
+
 EXAMPLES
   mediasnacks prores video.mov
-  mediasnacks prores --profile 2 video.mov
+  mediasnacks prores -p2 *.mov
 
   Both output a file named: video.prores.mov
 `.trim()
@@ -35,15 +52,20 @@ async function main() {
 	await assertUserHasFFmpeg()
 
 	const { values, files } = await parseOptions({
-		profile: { short: 'p', type: 'string', default: String(PRORES_PROFILES.hq) },
+		profile: { short: 'p', type: 'string', default: String(ProresProfiles.default) },
+		start: { short: 's', type: 'string', default: '' },
+		end: { short: 'e', type: 'string', default: '' },
 		help: { short: 'h', type: 'boolean' },
 	})
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
+	if (!ProresProfiles.isValid(Number(values.profile)))
+		throw new Error('Invalid profile. Must be one of: ' + ProresProfiles.list().join(','))
+
 	if (files.length !== 1)
 		throw new Error('Expected 1 argument: video file. See mediasnacks prores --help')
 
@@ -51,20 +73,19 @@ async function main() {
 	const { name, dir } = parse(video)
 	const output = join(dir, `${name}.prores.mov`)
 
-	console.log(`Converting to ProRes…`)
-	await prores(video, values.profile, output)
+	await prores(video, values.start, values.end, values.profile, output)
 }
 
-async function prores(video, profile, output) {
+async function prores(video, start, end, profile, output) {
 	await run('ffmpeg', [
 		'-v', 'error',
 		'-stats',
+		start ? ['-ss', start] : [],
+		end ? ['-to', end] : [],
 		'-i', video,
-		'-c:v', 'prores_ks',
-		'-profile:v', profile,
-		'-pix_fmt', 'yuv422p10le',
+		'-c:v', 'prores_ks', '-profile:v', profile,
 		output
-	])
+	].flat())
 }
 
 if (import.meta.main)

package/src/qdir.js

@@ -2,10 +2,10 @@
 
 import { join } from 'node:path'
 import { spawn } from 'node:child_process'
-import { parseArgs } from 'node:util'
 import { readdir, writeFile, unlink, rename } from 'node:fs/promises'
 
 import { isFile } from './utils/fs-utils.js'
+import { parseOptions } from './utils/parseOptions.js'
 
 
 const HELP = `
@@ -14,20 +14,30 @@ SYNOPSIS
 
 DESCRIPTION
   Sequentially runs all *.sh files in a folder (cwd by default). 
+  Completed scripts get renamed with a ".done" extension,
+  or to ".failed.$exitCode"
 `.trim()
 
 
+function filter(f) {
+	return f.endsWith('.sh')
+}
+
+function newExt(exitCode) {
+	return exitCode === 0
+		? '.done'
+		: `.failed.${exitCode}`
+}
+
+
 async function main() {
-	const { values, positionals } = parseArgs({
-		options: {
-			help: { short: 'h', type: 'boolean' },
-		},
-		allowPositionals: true,
+	const { values, positionals } = await parseOptions({
+		help: { short: 'h', type: 'boolean' }
 	})
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	const dir = positionals[0] || process.cwd()
@@ -55,12 +65,9 @@ export async function qdir(dir, pollIntervalMs = 10_000) {
 
 		const jobName = job.split('/').pop()
 		await writeFile(lock, jobName, 'utf8')
-
 		try {
 			const exitCode = await runShell(job)
-			await rename(job, job + (exitCode === 0
-				? '.done'
-				: `.failed.${exitCode}`))
+			await rename(job, job + newExt(exitCode))
 		}
 		finally {
 			await unlink(lock).catch(() => {})
@@ -71,8 +78,8 @@ export async function qdir(dir, pollIntervalMs = 10_000) {
 async function getNextJob(dir) {
 	const entries = await readdir(dir, { withFileTypes: true })
 	const scripts = entries
-		.filter(d => d.isFile() && d.name.endsWith('.sh'))
-		.map(d => d.name)
+		.filter(entry => entry.isFile() && filter(entry.name))
+		.map(entry => entry.name)
 		.sort()
 	return scripts.length
 		? join(dir, scripts[0])

package/src/random.js

@@ -14,10 +14,8 @@ DESCRIPTION
 `.trim()
 
 async function main() {
-	if (process.platform !== 'darwin') {
-		console.error('Error: This command is only supported on macOS.')
-		process.exit(1)
-	}
+	if (process.platform !== 'darwin')
+		throw new Error('Error: This command is only supported on macOS.')
 
 	const { values } = await parseOptions({
 		recursive: { short: 'r', type: 'boolean' },
@@ -26,7 +24,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	spawn('open', [pickRandomFile('.', values.recursive)])

package/src/resize.js

@@ -41,7 +41,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	const width = Number(values.width)

package/src/seqcheck.js

@@ -29,7 +29,7 @@ function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	const seq = extractSeqNums(

package/src/sqcrop.js

@@ -28,7 +28,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (!files.length)

package/src/ssim.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import { ffmpeg } from './utils/subprocess.js'
+import { parseOptions } from './utils/parseOptions.js'
 
 
 const HELP = `
@@ -7,19 +8,25 @@ SYNOPSIS
   mediasnacks ssim <img1> <img2>
 
 DESCRIPTION
-  Computes the Structural Similarity Index (SSIM) between two images using ffmpeg.
+  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) {
+	const { values, positionals } = await parseOptions({
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
 		console.log(HELP)
-		process.exit(1)
+		return
 	}
 
-	const score = await ssim(img1, img2)
-	console.log(score)
+	if (positionals.length !== 2)
+		throw new Error('Expected two images')
+
+	const score = await ssim(...positionals)
+	console.log(score.toString())
 }
 
 export async function ssim(img1, img2) {

package/src/utils/subprocess.js

@@ -39,10 +39,9 @@ async function runSilently(program, args) {
 
 export async function run(program, args) {
 	return new Promise((resolve, reject) => {
-		const p = spawn(program, args)
-		p.stdout.on('data', data => process.stdout.write(data))
-		p.stderr.on('data', chunk => process.stderr.write(chunk))
-
+		const p = spawn(program, args, { stdio: ['inherit', 'pipe', 'pipe'] })
+		p.stdout.pipe(process.stdout)
+		p.stderr.pipe(process.stderr)
 		p.on('error', reject)
 		p.on('close', code => {
 			if (code === 0)

package/src/vconcat.sh

@@ -7,30 +7,21 @@ SYNOPSIS
   mediasnacks vconcat <video1> <video2> …
 
 DESCRIPTION
-  Concatenates video files using FFmpeg's without re-encoding.
+  Concatenates video files using FFmpeg without re-encoding.
   All videos must have compatible codecs and resolutions.
 
 EXAMPLES
   mediasnacks vconcat vid1.mov vid2.mov
   mediasnacks vconcat *.mp4
 EOF
+  exit "${1:-0}"
 }
 
-if [ "$1" = "-h" ]; then
-  help
-  exit 0
-fi
-
-if [ "$#" -lt 2 ]; then
-  help
-  exit 1
-fi
+[ "$1" = "-h" ] && help
+[ "$#" -lt 2 ] && help 1
 
 for arg in "$@"; do
-  if [ ! -f "$arg" ]; then
-    help
-    exit 1
-  fi
+  [ ! -f "$arg" ] && help 1
 done
 
 list_file=$(mktemp -p .)

package/src/vdiff.sh

@@ -10,17 +10,11 @@ DESCRIPTION
   Diffs two video files using FFplay with a blend filter.
   Videos must have the same resolution.
 EOF
+  exit "${1:-0}"
 }
 
-if [ "$1" = "-h" ]; then
-  help
-  exit 0
-fi
-
-if [ $# -lt 2 ] || [ ! -f "$1" ] || [ ! -f "$2" ]; then
-  help
-  exit 1
-fi
+[ "$1" = "-h" ] && help
+[ $# -lt 2 ] || [ ! -f "$1" ] || [ ! -f "$2" ] && help 1
 
 video1="$1"
 video2="$2"

package/src/vsplit.js

@@ -44,7 +44,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (files.length !== 2)

package/src/vtrim.js

@@ -32,7 +32,7 @@ async function main() {
 
 	if (values.help) {
 		console.log(HELP)
-		process.exit(0)
+		return
 	}
 
 	if (!files.length)