mediasnacks 0.30.3 → 0.32.0

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.0",
 	"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'],

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,63 @@
+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] <file>
+
+DESCRIPTION
+  Prints all available attributes for the primary video stream from ffprobe.
+
+OPTIONS
+  -a, --all    Prints all attributes as JSON
+`
+
+export default async function main() {
+	const { values, files, usage } = await parseOptions(HELP, {
+		all: { short: 'a', type: 'boolean' }
+	})
+
+	const video = files[0]
+	if (!video) throw usage('No video file specified')
+
+	if (values.all)
+		console.log(JSON.stringify(await videoAttrs(video), '', 2))
+	else
+		console.log(await infoSummary(video))
+}
+
+
+export async function infoSummary(video) {
+	const v = await videoAttrs(video)
+	return [
+		`${v.width}x${v.height}`,
+		`${fps(v.r_frame_rate)}fps`,
+		formatSeconds(v.duration),
+		prettyCodecName(v.codec_name)
+	].join('  ')
+}
+
+function fps(rFrameRate) {
+	const [num, den] = rFrameRate.split('/').map(Number)
+	return cleanDecimals((num / den).toFixed(2))
+}
+
+function prettyCodecName(codec) {
+	// ffmpeg -codecs | grep '^...V'
+	return {
+		'dnxhd': 'DNxHD',
+		'dvvideo': 'DV (Digital Video)',
+		'h264': 'H.264',
+		'hevc': 'H.265',
+		'jpeg2000': 'JPEG 2000',
+		'mpeg4': 'MPEG-4 Part 2',
+		'prores': 'ProRes',
+		'qtrle': 'QuickTime RLE',
+		'rawvideo': 'Uncompressed',
+	}[codec] || codec
+}
+
+
+

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,53 @@
+import { spawn } from 'node:child_process'
+import { printProgress } 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'] })
+
+	p.stderr.pipe(process.stderr)
+	p.stdout.on('data', chunk => {
+		const text = chunk.toString()
+		if (text.includes('progress=end'))
+			onProgress(1)
+		else {
+			const m = text.match(/out_time_us=(\d+)/)
+			onProgress(Number(m[1]) / µsVideoDuration)
+		}
+	})
+
+	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,33 @@
+/**
+ * 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) {
+	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
+}
+
+
+/**
+ * Removes trailing zeros and a trailing decimal point.
+ *
+ * Examples:
+ *   cleanDecimals(3.1400) -> "3.14"
+ *   cleanDecimals(5.0) -> "5"
+ */
+export function cleanDecimals(number) {
+	return String(number).replace(/\.?0+$/, '') || '0'
+}

package/src/utils/printProgress.js

@@ -0,0 +1,14 @@
+export function printProgress(progress) {
+	process.stdout.write(`\r${progressBar(progress)} ${(progress * 100).toFixed(1)}%`)
+	if (progress === 1)
+		process.stdout.write('\n')
+}
+
+function progressBar(progress, width = 42) {
+	const nFull = (width * progress) | 0
+	const fPartial = (width * progress) - nFull
+	const nRemaining = width - nFull
+	const partials = ' ▏▎▍▌▋▊▉'
+	const partial = partials[Math.min(partials.length * fPartial | 0, partials.length - 1)]
+	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/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 = `