mediasnacks 0.24.0 → 0.26.0

package/README.md

@@ -10,12 +10,6 @@ Utilities video and images.
 npm install -g mediasnacks
 ```
 
-Optionally, if you have `ignore-scripts=true` in your `.npmprc`, 
-you can install zsh auto-completions with:
-```sh
-$(npm root -g)/mediasnacks/install-zsh-completions.js
-```
-
 
 
 ## Overview
@@ -32,6 +26,8 @@ mediasnacks <command> <args>
 
 - `resize` Resizes videos or images
 - `edgespic` Extracts first and last frames
+- `frameseq` Converts video to sequence of PNGs
+- `countframes` Counts frames in a video
 - `ssim` Computes similarity of two images
 - `gif`: Video to GIF
 
@@ -51,7 +47,7 @@ mediasnacks <command> <args>
 - `flattendir`: Moves unique files to the top dir and deletes empty dirs
 - `qdir` Sequentially runs all *.sh files in a folder
 - `seqcheck` Finds missing sequence number
-- `random` Opens a random file
+- `openrand` Opens a random file
 - `play` Plays filtered playlist with mpv
 
 

package/index.js

@@ -0,0 +1,18 @@
+export { avif } from './src/avif.js'
+export { countframes } from './src/countframes.js'
+export { detectdups } from './src/detectdups.js'
+export { dropdups } from './src/dropdups.js'
+export { edgespic } from './src/edgespic.js'
+export { frameseq } from './src/frameseq.js'
+export { hev1tohvc1 } from './src/hev1tohvc1.js'
+export { moov2front } from './src/moov2front.js'
+export { play } from './src/play.js'
+export { prores } from './src/prores.js'
+export { qdir } from './src/qdir.js'
+export { openrand, pickRandomFile } from './src/openrand.js'
+export { resize } from './src/resize.js'
+export { seqcheck } from './src/seqcheck.js'
+export { sqcrop } from './src/sqcrop.js'
+export { ssim } from './src/ssim.js'
+export { vsplit } from './src/vsplit.js'
+export { vtrim } from './src/vtrim.js'

package/package.json

@@ -1,20 +1,29 @@
 {
-  "name": "mediasnacks",
-  "version": "0.24.0",
-  "description": "Utilities for optimizing and preparing videos and images",
-  "license": "MIT",
-  "author": "Eric Fortis",
-  "type": "module",
+	"name": "mediasnacks",
+	"version": "0.26.0",
+	"description": "Utilities for optimizing and preparing videos and images",
+	"license": "MIT",
+	"author": "Eric Fortis",
+	"type": "module",
 	"bin": {
 		"mediasnacks": "src/cli.js"
 	},
 	"scripts": {
-		"test": "docker run --rm $(docker build -q .)",
+		"test": "FORCE_COLOR=1 node --test",
+		"test-docker": "docker run --rm $(docker build -q .)",
 		"postinstall": "node install-zsh-completions.js",
 		"dev-install": "npm i -g . --ignore-scripts=false"
 	},
+	"exports": {
+		".": {
+			"import": "./index.js",
+			"types": "./index.d.ts"
+		}
+	},
 	"files": [
 		"src",
+		"index.js",
+		"index.d.js",
 		"install-zsh-completions.js"
 	]
 }

package/src/avif.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 import { join, basename, dirname } from 'node:path'
 import { parseOptions } from './utils/parseOptions.js'
 import { replaceExt, lstat } from './utils/fs-utils.js'
@@ -7,22 +6,22 @@ import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 const HELP = `
 SYNOPSIS
-  mediasnacks avif [-y | --overwrite] [--output-dir=<dir>] <images> 
+  mediasnacks avif [-y | --overwrite] [--outdir=<dir>] <images> 
 
 DESCRIPTION
  Converts images to AVIF.
 
 EXAMPLES
   mediasnacks avif -y '*.png'
-  mediasnacks avif --output-dir=foo/ 'a/**/*.png'
+  mediasnacks avif --outdir=foo/ 'a/**/*.png'
 `.trim()
 
 
-async function main() {
+export default async function main() {
 	await assertUserHasFFmpeg()
 
 	const { values, files } = await parseOptions({
-		'output-dir': { type: 'string', default: '' },
+		outdir: { type: 'string', default: '' },
 		overwrite: { short: 'y', type: 'boolean' },
 		help: { short: 'h', type: 'boolean' },
 	})
@@ -37,27 +36,24 @@ async function main() {
 
 	console.log('AVIF…')
 	for (const file of files)
-		await avif({
-			file,
-			outFile: join(values['output-dir'] || dirname(file), replaceExt(basename(file), 'avif')),
-			overwrite: values.overwrite
-		})
+		try {
+			await avif({
+				file,
+				outFile: join(values.outdir || dirname(file), replaceExt(basename(file), 'avif')),
+				overwrite: values.overwrite
+			})
+			console.log(file)
+		}
+		catch (err) {
+			console.error(err?.message || err)
+		}
 }
 
-async function avif({ file, outFile, overwrite }) {
+export async function avif({ file, outFile, overwrite = false }) {
 	const stAvif = lstat(outFile)
+	if (!overwrite && stAvif?.isFile()) throw new Error(`output file exists but --overwrite=false. ${file}`)
+	if (stAvif?.mtimeMs > lstat(file)?.mtimeMs) throw new Error(`avif is newer. ${file}`)
 
-	if (!overwrite && stAvif?.isFile()) {
-		console.log('(skipped: output file exists but --overwrite=false)', file)
-		return
-	}
-	if (stAvif?.mtimeMs > lstat(file)?.mtimeMs) {
-		console.log('(skipped: avif is newer)', file)
-		return
-	}
-
-	// TODO fix transparent PNGs
-	console.log(file)
 	await ffmpeg([
 		'-y',
 		'-i', file,
@@ -66,8 +62,3 @@ async function avif({ file, outFile, overwrite }) {
 		outFile
 	])
 }
-
-main().catch(err => {
-	console.error(err.message)
-	process.exit(1)
-})

package/src/cli.js

@@ -1,43 +1,45 @@
 #!/usr/bin/env node
 
 import { join } from 'node:path'
-import { styleText } from 'node:util'
 import { spawn } from 'node:child_process'
+import { styleText } from 'node:util'
 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'],
-	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'],
-	dropdups: ['dropdups.js', 'Removes duplicate frames in a video'],
-	framediff: ['framediff.sh', 'Plays a video of adjacent frames diff'],
-	hev1tohvc1: ['hev1tohvc1.js', 'Fixes video thumbnails not rendering on macOS Finder'],
-	moov2front: ['moov2front.js', 'Rearranges .mov and .mp4 metadata for fast-start streaming'],
-	vconcat: ['vconcat.sh', 'Concatenates videos'],
-	vdiff: ['vdiff.sh', 'Plays a video with the difference of two videos'],
-	vsplit: ['vsplit.js', 'Splits a video into multiple clips from CSV timestamps'],
-	vtrim: ['vtrim.js', 'Trims video from start to end time'],
-	prores: ['prores.js', 'Converts video to ProRes\n'],
-
-	flattendir: ['flattendir.sh', 'Moves all files to top dir and deletes dirs'],
-	qdir: ['qdir.js', 'Sequentially runs all *.sh files in a folder'],
-	seqcheck: ['seqcheck.js', 'Finds missing sequence number'],
-	random: ['random.js', 'Opens a random file (macOS only)'],
-	play: ['play.js', 'Plays filtered playlist with mpv\n'],
-
-	dlaudio: ['dlaudio.sh', 'yt-dlp best audio'],
-	dlvideo: ['dlvideo.sh', 'yt-dlp best video\n'],
-
-	unemoji: ['unemoji.sh', 'Removes emojis from filenames'],
-	rmcover: ['rmcover.sh', 'Removes cover art'],
+	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'],
+	edgespic: ['./edgespic.js', 'Extracts first and last frames'],
+	frameseq: ['./frameseq.js', 'Converts video to sequence of PNGs'],
+	countframes: ['./countframes.js', 'Counts frames in a video'],
+	ssim: ['./ssim.js', 'Computes SSIM between two images'],
+	gif: ['./gif.sh', 'Video to GIF\n'],
+
+	detectdups: ['./detectdups.js', 'Detects duplicate frames in a video'],
+	dropdups: ['./dropdups.js', 'Removes duplicate frames in a video'],
+	framediff: ['./framediff.sh', 'Plays a video of adjacent frames diff'],
+	hev1tohvc1: ['./hev1tohvc1.js', 'Fixes video thumbnails not rendering on macOS Finder'],
+	moov2front: ['./moov2front.js', 'Rearranges .mov and .mp4 metadata for fast-start streaming'],
+	vconcat: ['./vconcat.sh', 'Concatenates videos'],
+	vdiff: ['./vdiff.sh', 'Plays a video with the difference of two videos'],
+	vsplit: ['./vsplit.js', 'Splits a video into multiple clips from CSV timestamps'],
+	vtrim: ['./vtrim.js', 'Trims video from start to end time'],
+	prores: ['./prores.js', 'Converts video to ProRes\n'],
+
+	flattendir: ['./flattendir.sh', 'Moves all files to top dir and deletes dirs'],
+	qdir: ['./qdir.js', 'Sequentially runs all *.sh files in a folder'],
+	seqcheck: ['./seqcheck.js', 'Finds missing sequence number'],
+	openrand: ['./openrand.js', 'Opens a random file (macOS only)'],
+	play: ['./play.js', 'Plays filtered playlist with mpv\n'],
+
+	dlaudio: ['./dlaudio.sh', 'yt-dlp best audio'],
+	dlvideo: ['./dlvideo.sh', 'yt-dlp best video\n'],
+
+	unemoji: ['./unemoji.sh', 'Removes emojis from filenames'],
+	rmcover: ['./rmcover.sh', 'Removes cover art'],
 }
 
 export function commandsSummary() {
@@ -55,7 +57,7 @@ ${commandsSummary().map(([cmd, desc]) =>
 `.trim()
 
 
-function main() {
+async function main() {
 	const [, , opt, ...args] = process.argv
 
 	if (opt === '-v' || opt === '--version') {
@@ -76,10 +78,16 @@ function main() {
 		process.exit(1)
 	}
 
-	const cmd = join(import.meta.dirname, COMMANDS[opt][0])
-	spawn(cmd, args, { stdio: 'inherit' })
-		.on('exit', process.exit)
+	const cmd = COMMANDS[opt][0]
+	if (cmd.endsWith('.js'))
+		(await import(cmd)).default()
+	else
+		spawn(join(import.meta.dirname, cmd), args, { stdio: 'inherit' })
+			.on('exit', process.exit)
 }
 
 if (import.meta.main)
-	main()
+	main().catch(err => {
+		console.error(err?.message || err)
+		process.exit(1)
+	})

package/src/countframes.js

@@ -0,0 +1,57 @@
+import { parseOptions } from './utils/parseOptions.js'
+import { assertUserHasFFmpeg } from './utils/subprocess.js'
+import { videoAttrs } from './utils/videoAttrs.js'
+import { parseTimecode } from './utils/parseTimecode.js'
+
+
+const HELP = `
+SYNOPSIS
+  mediasnacks countframes [options] <file>
+
+DESCRIPTION
+  Counts the number of frames in a video between optional start and end bounds.
+
+OPTIONS
+  -f, --fps <num>          Frames per second (default: same as video)
+  -s, --start <timecode>   Start time in seconds (default: 0)
+  -e, --end <timecode>     End time in seconds (default: end of video)
+
+EXAMPLES
+  mediasnacks countframes --start=1:30.16 --end=60 video.mov
+  mediasnacks countframes --fps=12 video.mov
+`.trim()
+
+
+export default async function main() {
+	await assertUserHasFFmpeg()
+
+	const { values, files } = await parseOptions({
+		fps: { type: 'string', default: '' },
+		start: { short: 's', type: 'string', default: '' },
+		end: { short: 'e', type: 'string', default: '' },
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
+		console.log(HELP)
+		return
+	}
+
+	const { fps, start, end } = values
+	const video = files[0]
+	if (!video) throw new Error('No video file specified')
+
+	const n = await countframes({ video, fps, start, end })
+	console.log(String(n))
+}
+
+
+export async function countframes({ video, fps, start, end }) {
+	const v = await videoAttrs(video)
+	const videoDuration = parseFloat(v.duration || 0)
+	const startSecs = start ? parseTimecode(start) : 0
+	const endSecs = end ? parseTimecode(end) : videoDuration
+	const durationLimit = Math.max(0, endSecs - startSecs)
+	const actualFps = fps ? Number(fps) : eval(v.r_frame_rate)
+	return Math.ceil(durationLimit * actualFps)
+}

package/src/detectdups.js

@@ -1,7 +1,6 @@
-#!/usr/bin/env node
-
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, assertUserHasFFmpeg, videoAttrs } from './utils/subprocess.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
+import { videoAttrs } from './utils/videoAttrs.js'
 
 const STDEV_THRESHOLD = 0.2
 
@@ -30,7 +29,7 @@ SEE ALSO
 `.trim()
 
 
-async function main() {
+export default async function main() {
 	await assertUserHasFFmpeg()
 
 	const { values, files } = await parseOptions({
@@ -44,13 +43,11 @@ async function main() {
 		return
 	}
 
-	if (files.length !== 1)
-		throw new Error('Invalid input file. One video file must be specified. See mediasnacks detectdups --help')
-
-	const v = await videoAttrs(files[0])
+	if (files.length !== 1) throw new Error('Invalid input file. One video file must be specified. See mediasnacks detectdups --help')
 
-	if (v.codec_type !== 'video')
-		throw new Error('Invalid input file. Must be a video.')
+	const video = files[0]
+	const v = await videoAttrs(video)
+	if (v.codec_type !== 'video') throw new Error('Invalid input file. Must be a video.')
 
 	const vDur = Number(v.duration)
 
@@ -66,7 +63,7 @@ async function main() {
 	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 dups = await detectdups({ video: files[0], seek, duration })
 	const h = deltaHistogram(dups)
 	const report = {
 		n: maxFreqKey(h),
@@ -79,12 +76,12 @@ async function main() {
 	console.log(JSON.stringify(report, null, 2))
 }
 
-export async function detectdups(video, seek, duration) {
+export async function detectdups({ video, seek, duration }) {
 	const { stderr } = await ffmpeg([
 		'-v', 'info',
 		'-stats',
-		'-ss', seek,
-		'-t', duration,
+		seek ? ['-ss', seek] : [],
+		duration ? ['-t', duration] : [],
 		'-i', video,
 		'-vf', [
 			'tblend=all_mode=difference',
@@ -92,7 +89,7 @@ export async function detectdups(video, seek, duration) {
 			'showinfo',
 		].join(','),
 		'-f', 'null', '-',
-	])
+	].flat())
 
 	const reNearBlackFrames = /n:\s*(\d+).*?mean:\[0].*?stdev:\[([0-9.]+)]/
 	const dupFrames = []
@@ -132,10 +129,3 @@ function maxFreqKey(histogram) {
 		? Number(maxKey)
 		: null
 }
-
-
-if (import.meta.main)
-	main().catch(err => {
-		console.error(err.message || err)
-		process.exit(1)
-	})

package/src/dropdups.js

@@ -1,7 +1,4 @@
-#!/usr/bin/env node
-
 import { resolve, parse, format } from 'node:path'
-
 import { parseOptions } from './utils/parseOptions.js'
 import { ffmpeg, assertUserHasFFmpeg, run } from './utils/subprocess.js'
 import { ProresProfiles } from './prores.js'
@@ -30,7 +27,7 @@ EXAMPLES
 `.trim()
 
 
-async function main() {
+export default async function main() {
 	await assertUserHasFFmpeg()
 
 	const { values, files } = await parseOptions({
@@ -55,7 +52,7 @@ async function main() {
 		await dropdups(resolve(file), dupFrameNum)
 }
 
-async function dropdups(video, dupFrameNum) {
+export async function dropdups(video, dupFrameNum) {
 	await run('ffmpeg', [
 		'-v', 'error',
 		'-stats',
@@ -77,8 +74,3 @@ function makeOutputPath(video) {
 		? format({ dir, name: `${name}.dedup`, ext: '.mov' })
 		: format({ dir, name, ext: '.mov' })
 }
-
-main().catch(err => {
-	console.error(err.message || err)
-	process.exit(1)
-})

package/src/edgespic.js

@@ -1,10 +1,9 @@
-#!/usr/bin/env node
-
 import { basename, extname, join, parse } from 'node:path'
 
 import { mkDir } from './utils/fs-utils.js'
+import { videoAttrs } from './utils/videoAttrs.js'
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, videoAttrs, assertUserHasFFmpeg } from './utils/subprocess.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 
 const HELP = `
@@ -23,7 +22,7 @@ EXAMPLES
 `.trim()
 
 
-async function main() {
+export default async function main() {
 	await assertUserHasFFmpeg()
 
 	const { values, files } = await parseOptions({
@@ -37,14 +36,11 @@ async function main() {
 	}
 
 	const width = Number(values['width'])
-	if (width <= 0 || !Number.isInteger(width))
-		throw new Error('--width must be a positive number')
-
-	if (!files.length)
-		throw new Error('No video files specified')
+	if (width <= 0 || !Number.isInteger(width)) throw new Error('--width must be a positive number')
+	if (!files.length) throw new Error('No video files specified')
 
 	const outDir = join(parse(files[0]).dir, 'edgespic')
-	await mkDir(outDir) 
+	await mkDir(outDir)
 
 	console.log('Extracting edge frames…')
 	for (const file of files)
@@ -52,7 +48,7 @@ async function main() {
 }
 
 
-async function edgespic(video, width, outDir) {
+export async function edgespic(video, width, outDir) {
 	const { r_frame_rate } = await videoAttrs(video)
 	const name = basename(video, extname(video))
 
@@ -73,9 +69,3 @@ async function edgespic(video, width, outDir) {
 		join(outDir, `${name}_last.png`)
 	])
 }
-
-
-main().catch(err => {
-	console.error(err.message)
-	process.exit(1)
-})

package/src/frameseq.js

@@ -0,0 +1,69 @@
+import { basename, extname, join, parse } from 'node:path'
+
+import { mkDir } from './utils/fs-utils.js'
+import { parseOptions } from './utils/parseOptions.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
+import { countframes } from './countframes.js'
+
+
+const HELP = `
+SYNOPSIS
+  mediasnacks frameseq [options] <files>
+
+DESCRIPTION
+  Converts a video into a sequence of PNGs.
+
+OPTIONS
+  -f, --fps <num>          Frames per second (default: same as video)
+  -s, --start <timecode>   Start time in seconds (default: 0)
+  -e, --end <timecode>     End time in seconds (default: end of video)
+
+EXAMPLES
+  Start and End
+  mediasnacks frameseq --start=1:30.16 --end=60 video.mov
+  
+  Custom framerate, all video duration
+  mediasnacks frameseq --fps=12 video.mov
+`.trim()
+
+
+export default async function main() {
+	await assertUserHasFFmpeg()
+
+	const { values, files } = await parseOptions({
+		fps: { short: 'f', type: 'string', default: '' },
+		start: { short: 's', type: 'string', default: '' },
+		end: { short: 'e', type: 'string', default: '' },
+		outdir: { type: 'string', default: '' },
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
+		console.log(HELP)
+		return
+	}
+
+	const { fps, start, end, outdir } = values
+	const video = files[0]
+	if (!video) throw new Error('No video files specified')
+	if (fps && isNaN(parseFloat(fps))) throw new Error('Invalid --fps')
+	if (start && isNaN(parseFloat(start))) throw new Error('Invalid --start')
+	if (end && isNaN(parseFloat(end))) throw new Error('Invalid --end')
+
+	const nFrames = await countframes({ video, fps, start, end })
+	const pad = String(nFrames).length
+	await frameseq({ video, fps, start, end, pad, outdir })
+}
+
+export async function frameseq({ video, fps, start, end, pad, outdir }) {
+	const name = basename(video, extname(video))
+	const outDir = outdir || join(parse(video).dir, name)
+	await mkDir(outDir)
+	await ffmpeg([
+		start ? ['-ss', start] : [],
+		end ? ['-to', end] : [],
+		'-i', video,
+		fps ? ['-vf', `fps=${fps}`] : [],
+		join(outDir, `${name}_%0${pad}d.png`)
+	].flat())
+}

package/src/hev1tohvc1.js

@@ -1,8 +1,7 @@
-#!/usr/bin/env node
-
 import { parseOptions } from './utils/parseOptions.js'
 import { uniqueFilenameFor, overwrite } from './utils/fs-utils.js'
-import { videoAttrs, ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
+import { videoAttrs } from './utils/videoAttrs.js'
 
 
 const HELP = `
@@ -16,7 +15,7 @@ DESCRIPTION
 `.trim()
 
 
-async function main() {
+export default async function main() {
 	await assertUserHasFFmpeg()
 
 	const { values, files } = await parseOptions({
@@ -28,21 +27,22 @@ async function main() {
 		return
 	}
 
-	if (!files.length)
-		throw new Error(HELP)
+	if (!files.length) throw new Error('Missing input file(s)')
 
 	for (const file of files)
-		await hev1tohvc1(file)
+		try {
+			await hev1tohvc1(file)
+			console.log(file)
+		}
+		catch (err) {
+			console.error(err?.message || err)
+		}
 }
 
-async function hev1tohvc1(file) {
+export async function hev1tohvc1(file) {
 	const v = await videoAttrs(file)
-	if (v.codec_tag_string !== 'hev1') {
-		console.log('(skipped: non hev1)', file)
-		return
-	}
+	if (v.codec_tag_string !== 'hev1') throw new Error(`non hev1 ${file}`)
 
-	console.log(file)
 	const tmp = uniqueFilenameFor(file)
 	await ffmpeg([
 		'-i', file,
@@ -52,9 +52,3 @@ async function hev1tohvc1(file) {
 	])
 	await overwrite(tmp, file)
 }
-
-
-main().catch(err => {
-	console.error(err.message)
-	process.exit(1)
-})