mediasnacks 0.30.3 → 0.32.4

package/README.md

@@ -31,6 +31,7 @@ mediasnacks <command> <args>
 - `countframes` Counts frames in a video
 - `ssim` Computes similarity of two images
 - `gif`: Video to GIF
+- `info`: Prints video attributes
 
 
 - `detectdups` Detects sequentially duplicate frames in a video

package/index.js

@@ -21,3 +21,4 @@ export { unemoji } from './src/unemoji.js'
 export { vsplit } from './src/vsplit.js'
 export { vtrim } from './src/vtrim.js'
 export { base64 } from './src/base64.js'
+export { infoSummary } from './src/info.js'

package/package.json

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

package/src/avif.js

@@ -1,7 +1,7 @@
 import { join, basename, dirname } from 'node:path'
 import { parseOptions } from './utils/parseOptions.js'
 import { replaceExt, lstat } from './utils/fs-utils.js'
-import { ffmpeg } from './utils/subprocess.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `

package/src/cli.js

@@ -17,7 +17,8 @@ const COMMANDS = {
 	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.js', 'Video to GIF\n'],
+	gif: ['./gif.js', 'Video to GIF'],
+	info: ['./info.js', 'Prints video stream attributes\n'],
 
 	detectdups: ['./detectdups.js', 'Detects duplicate frames in a video'],
 	dropdups: ['./dropdups.js', 'Removes duplicate frames in a video'],
@@ -54,7 +55,7 @@ SYNOPSIS
 
 COMMANDS
 ${commandsSummary().map(([cmd, desc]) =>
-	`  ${styleText('bold', cmd.padEnd(12, ' '))}\t${desc}`).join('\n')}
+	`  ${styleText('bold', cmd.padEnd(12))}\t${desc}`).join('\n')}
 `.trim()
 
 
@@ -76,11 +77,11 @@ async function main() {
 	if (!opt) throw HELP
 	if (!Object.hasOwn(COMMANDS, opt)) throw `'${opt}' is not a command. See mediasnacks --help\n`
 
-	const cmd = COMMANDS[opt][0]
-	if (cmd.endsWith('.js'))
-		await (await import(cmd)).default()
+	const prog = COMMANDS[opt][0]
+	if (prog.endsWith('.js'))
+		await (await import(prog)).default()
 	else
-		spawn(join(import.meta.dirname, cmd), args, { stdio: 'inherit' })
+		spawn(join(import.meta.dirname, prog), args, { stdio: 'inherit' })
 			.on('exit', process.exit)
 }
 

package/src/detectdups.js

@@ -1,6 +1,6 @@
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg } from './utils/subprocess.js'
 import { videoAttrs } from './utils/videoAttrs.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 const STDEV_THRESHOLD = 0.2
 

package/src/dropdups.js

@@ -1,7 +1,8 @@
 import { resolve, parse, format } from 'node:path'
-import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, run } from './utils/subprocess.js'
 import { ProresProfiles } from './prores.js'
+import { parseOptions } from './utils/parseOptions.js'
+import { ffmpegWithProgress } from './utils/ffmpeg.js'
+import { infoSummary } from './info.js'
 
 
 const PROFILE = ProresProfiles.default
@@ -15,7 +16,7 @@ DESCRIPTION
 
 OPTIONS
   -n, --dup-frame-num <n>  Known frame interval to drop.
-		                       Default: n=0, which auto-detects repeated frames (slower)
+ 		                       Default: n=0, which auto-detects repeated frames (slower)
 
 EXAMPLES
   Use n=2 when every other frame is repeated:
@@ -38,14 +39,14 @@ export default async function main() {
 	if (dupFrameNum && !Number.isInteger(+dupFrameNum))
 		throw usage('Invalid -n. It must be a positive integer.')
 
-	for (const file of files)
+	for (const file of files) {
+		console.log(await infoSummary(file))
 		await dropdups(resolve(file), dupFrameNum)
+	}
 }
 
 export async function dropdups(video, dupFrameNum) {
-	await run('ffmpeg', [
-		'-v', 'error',
-		'-stats',
+	await ffmpegWithProgress(video, [
 		'-an',
 		'-i', video,
 		'-vf', dupFrameNum

package/src/edgespic.js

@@ -3,7 +3,7 @@ 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 } from './utils/subprocess.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const WIDTH = 640

package/src/frameseq.js

@@ -2,7 +2,7 @@ import { basename, extname, join, parse } from 'node:path'
 
 import { mkDir } from './utils/fs-utils.js'
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg } from './utils/subprocess.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 import { countframes } from './countframes.js'
 
 

package/src/hev1tohvc1.js

@@ -1,7 +1,7 @@
 import { parseOptions } from './utils/parseOptions.js'
 import { uniqueFilenameFor, overwrite } from './utils/fs-utils.js'
-import { ffmpeg } from './utils/subprocess.js'
 import { videoAttrs } from './utils/videoAttrs.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `

package/src/info.js

@@ -0,0 +1,65 @@
+import { parseOptions } from './utils/parseOptions.js'
+import { videoAttrs } from './utils/videoAttrs.js'
+import { formatSeconds, cleanDecimals } from './utils/formatSeconds.js'
+
+
+const HELP = `
+SYNOPSIS
+  mediasnacks info [-a | --all] <files>
+
+DESCRIPTION
+  Prints video or image attributes using ffprobe. By default, it’s similar to 
+  \`ls\` but prints the: width, height, fps, duration, codec, and filename.
+
+OPTIONS
+  -a, --all    Prints everything as JSON
+
+EXAMPLES
+  Short summary of each match:	
+    mediasnacks info *.mp4
+  
+  Sort by fps:
+    mediasnacks info *.* | sort -k3,3n
+
+  Move 60fps videos into 60fps/ subdir: 
+    FPS=60
+    DIR=\${FPS}fps
+    mkdir -p \$DIR
+    mediasnacks info *.* |
+      grep \${FPS}fps |
+      awk -F\\t '{print $NF}' |
+      while read -r f; do
+        mv -- "$f" \$DIR/
+      done  
+`
+
+export default async function main() {
+	const { values, files, usage } = await parseOptions(HELP, {
+		all: { short: 'a', type: 'boolean' }
+	})
+
+	if (!files[0]) throw usage('No video file specified')
+
+	for (const video of files)
+		if (values.all)
+			console.log(JSON.stringify(await videoAttrs(video), '', 2))
+		else
+			console.log(`${await infoSummary(video)}\t${video}`)
+}
+
+
+export async function infoSummary(video) {
+	const v = await videoAttrs(video)
+	return [
+		String(v.width).padStart(4),
+		String(v.height).padStart(4),
+		`${fps(v.r_frame_rate)}fps`.padStart(7),
+		formatSeconds(v.duration, 0).padStart(8),
+		v.codec_name
+	].join('\t')
+}
+
+function fps(rFrameRate) {
+	const [num, den] = rFrameRate.split('/').map(Number)
+	return cleanDecimals((num / den).toFixed(2))
+}

package/src/moov2front.js

@@ -1,6 +1,6 @@
-import { ffmpeg } from './utils/subprocess.js'
 import { uniqueFilenameFor, overwrite } from './utils/fs-utils.js'
 import { parseOptions } from './utils/parseOptions.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `

package/src/prores.js

@@ -1,6 +1,7 @@
 import { resolve, parse, join } from 'node:path'
 import { parseOptions } from './utils/parseOptions.js'
-import { run } from './utils/subprocess.js'
+import { ffmpegWithProgress } from './utils/ffmpeg.js'
+import { infoSummary } from './info.js'
 
 
 // https://github.com/oyvindln/vhs-decode/wiki/ProRes-The-Definitive-FFmpeg-Guide#profiles-can-be-the-following
@@ -68,13 +69,12 @@ export default async function main() {
 	const output = join(dir, `${name}.prores.mov`)
 
 	const { profile, start, end } = values
+	console.log(await infoSummary(video))
 	await prores({ video, profile, start, end, output })
 }
 
 export async function prores({ video, profile, start, end, output }) {
-	await run('ffmpeg', [
-		'-v', 'error',
-		'-stats',
+	await ffmpegWithProgress(video, [
 		start ? ['-ss', start] : [],
 		end ? ['-to', end] : [],
 		'-i', video,

package/src/resize.js

@@ -3,8 +3,8 @@ import { rename } from 'node:fs/promises'
 
 import { parseOptions } from './utils/parseOptions.js'
 import { isFile, uniqueFilenameFor } from './utils/fs-utils.js'
-import { ffmpeg } from './utils/subprocess.js'
 import { videoAttrs } from './utils/videoAttrs.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `

package/src/sqcrop.js

@@ -1,10 +1,10 @@
 import { join } from 'node:path'
 import { rename } from 'node:fs/promises'
 
-import { ffmpeg } from './utils/subprocess.js'
 import { lstat, uniqueFilenameFor } from './utils/fs-utils.js'
 import { parseOptions } from './utils/parseOptions.js'
 import { videoAttrs } from './utils/videoAttrs.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `

package/src/ssim.js

@@ -1,5 +1,5 @@
-import { ffmpeg } from './utils/subprocess.js'
 import { parseOptions } from './utils/parseOptions.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `

package/src/utils/ffmpeg.js

@@ -0,0 +1,64 @@
+import os from 'node:os'
+import { spawn } from 'node:child_process'
+import { printProgress, showCursor } from './printProgress.js'
+import { videoAttrs } from './videoAttrs.js'
+import { runSilently } from './subprocess.js'
+
+
+async function assertUserHasFFmpeg() {
+	try {
+		await runSilently('ffmpeg', ['-version'])
+		await runSilently('ffprobe', ['-version'])
+	}
+	catch {
+		throw new Error('ffmpeg not found. Please install ffmpeg.')
+	}
+}
+
+
+export async function ffmpeg(args) {
+	await assertUserHasFFmpeg()
+	return runSilently('ffmpeg', args)
+}
+
+
+export async function ffmpegWithProgress(input, args, onProgress = printProgress) {
+	await assertUserHasFFmpeg()
+	const µsVideoDuration = 1e6 * (await videoAttrs(input)).duration
+
+	const p = spawn('ffmpeg', [
+		'-v', 'error',
+		'-nostats',
+		'-progress', 'pipe:1',
+		...args
+	], { stdio: ['inherit', 'pipe', 'pipe'] })
+
+	const startTime = performance.now()
+	p.stdout.on('data', chunk => {
+		const text = chunk.toString()
+		const msElapsed = performance.now() - startTime
+		if (text.includes('progress=continue')) {
+			const m = text.match(/out_time_us=(\d+)/)
+			const progress = Number(m[1]) / µsVideoDuration
+			const msETA = msElapsed * (1 - progress) / progress
+			onProgress(progress, msElapsed, msETA)
+		}
+		else
+			onProgress(1, msElapsed, 0)
+	})
+	process.on('SIGINT', () => {
+		p?.kill('SIGINT')
+		showCursor()
+		console.log('\nAborted')
+		process.exit(128 + os.constants.signals.SIGINT)
+	})
+	p.stderr.pipe(process.stderr)
+
+	await new Promise((resolve, reject) => {
+		p.on('error', reject)
+		p.on('close', code => {
+			if (code === 0) resolve()
+			else reject(Error(`ffmpeg failed with code ${code}`))
+		})
+	})
+}

package/src/utils/formatSeconds.js

@@ -0,0 +1,32 @@
+/**
+ * Removes trailing zeros and a trailing decimal point.
+ *
+ * Examples:
+ *   cleanDecimals(3.1400) -> "3.14"
+ *   cleanDecimals(5.0) -> "5"
+ */
+export const cleanDecimals = Number
+
+/**
+ * Converts seconds to a string like "9h9m9s".
+ *
+ * Examples:
+ *   formatSeconds(1.1) -> "1.1s"
+ *   formatSeconds(3661, 2) -> "1h1m1s"
+ *   formatSeconds(3661.0, 2) -> "1h1m1s"
+ *   formatSeconds(3661.25, 2) -> "1h1m1.25s"
+ */
+export function formatSeconds(seconds, maxDecimals = 2) {
+	if (!Number.isFinite(+seconds))
+		return ''
+	const intSeconds = seconds | 0
+	const partialSeconds = seconds % 60
+	const minutes = (intSeconds % 3600) / 60 | 0
+	const hours = intSeconds / 3600 | 0
+
+	let result = ''
+	if (hours) result += hours + 'h'
+	if (minutes) result += minutes + 'm'
+	if (partialSeconds || !result) result += cleanDecimals(partialSeconds.toFixed(maxDecimals)) + 's'
+	return result
+}

package/src/utils/parseOptions.js

@@ -10,48 +10,41 @@ const glob = promisify(_glob)
  * @param {Partial<import('node:util').ParseArgsConfig>} [config]
  */
 export async function parseOptions(helpText, options = {}, config = {}) {
+	helpText = helpText.trim()
 	options.help = { short: 'h', type: 'boolean' }
 
-	const { values, positionals, tokens } = parseArgs({
+	const { values, positionals } = parseArgs({
 		args: process.argv.slice(3),
 		allowPositionals: true,
 		options,
-		...config,
-		tokens: true
+		...config
 	})
 
 	if (values.help) {
-		console.log(helpText.trim())
+		console.log(helpText)
 		process.exit(0)
 	}
 
 	return {
 		values,
 		positionals,
-		files: await resolveGlobs(positionals, tokens),
+		files: await resolveGlobs(positionals),
 		usage: err => err
-			? styleText('redBright', '' + err + '\n') + helpText
+			? styleText('redBright', err + '\n') + helpText
 			: helpText
 	}
 }
 
-async function resolveGlobs(arr, tokens = []) {
-	const terminatorIndex = tokens.find(t => t.kind === 'option-terminator')?.index ?? -1
+async function resolveGlobs(arr) {
 	const set = new Set()
-
-	const globable = terminatorIndex === -1
-		? arr
-		: arr.slice(0, terminatorIndex)
-
-	for (const g of globable)
-		for (const file of await glob(g))
-			set.add(file)
-
-
-	if (terminatorIndex !== -1)
-		for (const literal of arr.slice(terminatorIndex))
-			set.add(literal)
-
+	for (const arg of arr) {
+		const matches = await glob(arg)
+		if (matches.length)
+			for (const file of matches)
+				set.add(file)
+		else
+			set.add(arg)
+	}
 	return Array.from(set)
 }
 

package/src/utils/parseTimecode.js

@@ -6,11 +6,11 @@ export function parseTimecode(time) {
 	if (parts.some(isNaN) || parts.length > 3)
 		throw new Error(`Invalid time: ${time}`)
 
-	// HH:MM:SS or HH:MM:SS.mmm
-	if (parts.length === 3) return parts[0] * 3600 + parts[1] * 60 + parts[2]
+	if (parts.length === 3) // HH:MM:SS or HH:MM:SS.mmm
+		return (3600 * parts[0]) + (60 * parts[1]) + parts[2]
 
-	// MM:SS or MM:SS.mmm
-	if (parts.length === 2) return parts[0] * 60 + parts[1]
+	if (parts.length === 2) // MM:SS or MM:SS.mmm
+		return (60 * parts[0]) + parts[1]
 
 	return parts[0]
 }

package/src/utils/printProgress.js

@@ -0,0 +1,34 @@
+import { formatSeconds } from './formatSeconds.js'
+
+const HIDE_CURSOR = '\x1b[?25l'
+const SHOW_CURSOR = '\x1b[?25h'
+const ERASE_TO_END = '\x1b[K'
+
+export const showCursor = () => process.stdout.write(SHOW_CURSOR)
+
+export function printProgress(progress, msElapsed, msETA) {
+	const elapsed = msElapsed
+		? ` • ${formatSeconds(msElapsed / 1000, 0)}`
+		: ''
+	const eta = msETA
+		? ` • ETA ${formatSeconds(msETA / 1000, 0)}`
+		: ''
+	const percent = progress === 1
+		? '100%'
+		: `${(progress * 100).toFixed(1)}%`
+	process.stdout.write(HIDE_CURSOR)
+	process.stdout.write(`\r${progressBar(progress)} ${percent}${eta}${elapsed}${ERASE_TO_END}`)
+	if (progress === 1)
+		process.stdout.write('\n' + SHOW_CURSOR)
+}
+
+function progressBar(progress, width = 44) {
+	width-- // for partial char
+	const nFull = (width * progress) | 0
+	const fPartial = (width * progress) - nFull
+	const nRemaining = width - nFull
+
+	const partials = ' ▏▎▍▌▋▊▉'
+	const partial = partials.at(partials.length * fPartial)
+	return '█'.repeat(nFull) + partial + '•'.repeat(nRemaining)
+}

package/src/utils/subprocess.js

@@ -1,21 +1,6 @@
 import { spawn } from 'node:child_process'
 
 
-async function assertUserHasFFmpeg() {
-	try {
-		await runSilently('ffmpeg', ['-version'])
-		await runSilently('ffprobe', ['-version'])
-	}
-	catch {
-		throw new Error('ffmpeg not found. Please install ffmpeg.')
-	}
-}
-
-export async function ffmpeg(args) {
-	await assertUserHasFFmpeg()
-	return runSilently('ffmpeg', args)
-}
-
 export async function runSilently(program, args) {
 	return new Promise((resolve, reject) => {
 		const stdout = []
@@ -38,6 +23,7 @@ export async function runSilently(program, args) {
 	})
 }
 
+
 export async function run(program, args) {
 	return new Promise((resolve, reject) => {
 		const p = spawn(program, args, { stdio: ['inherit', 'pipe', 'pipe'] })

package/src/utils/test-utils.js

@@ -5,19 +5,10 @@ import { mkdtempSync, mkdirSync, writeFileSync } from 'node:fs'
 
 const rel = f => join(import.meta.dirname, f)
 
-export function mkTempDir(prefix = 'test-') {
-	return mkdtempSync(join(tmpdir(), prefix))
-}
+export const cli = (...args) => spawnSync(rel('../cli.js'), args)
 
-export function cli(...args) {
-	return spawnSync(rel('../cli.js'), args)
-}
+export const dir = (...args) => mkdirSync(join(...args), { recursive: true })
+export const touch = (...args) => writeFileSync(join(...args), '')
 
-export function dir(...args) {
-	return mkdirSync(join(...args), { recursive: true })
-}
-
-export function touch(...args) {
-	return writeFileSync(join(...args), '')
-}
+export const mkTempDir = (prefix = 'test-') => mkdtempSync(join(tmpdir(), prefix))
 

package/src/vtrim.js

@@ -1,6 +1,6 @@
 import { resolve, parse } from 'node:path'
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg } from './utils/subprocess.js'
+import { ffmpeg } from './utils/ffmpeg.js'
 
 
 const HELP = `