mediasnacks 0.21.0 → 0.22.2

package/README.md

@@ -13,7 +13,7 @@ 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.sh
+$(npm root -g)/mediasnacks/install-zsh-completions.js
 ```
 
 
@@ -50,6 +50,8 @@ 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
+- `play` Plays filtered playlist with mpv
 
 
 - `dlaudio`: yt-dlp best audio
@@ -74,57 +76,6 @@ mediasnacks avif -- file[234].png
 ```
 
 
----
-
-## Commands
-
-### Converting Images to AVIF
-```shell
-mediasnacks avif [-y | --overwrite] [--output-dir=<dir>] <images> 
-```
-
-<br/>
-
-### Resizing Images or Videos
-Resizes videos and images. The aspect ratio is preserved when only one dimension is specified.
-
-`--width` and `--height` are `-2` by default:
-- `-1` auto-compute while preserving the aspect ratio (may result in an odd number)
-- `-2` same as `-1` but rounds to the nearest even number
-
-```shell
-mediasnacks resize [--width=<num>] [--height=<num>] [-y | --overwrite] [--output-dir=<dir>] <files>
-```
-
-Example: Overwrites the input file (-y)
-```shell
-mediasnacks resize -y --width 480 'dir-a/**/*.png' 'dir-b/**/*.mp4'
-```
-
-Example: Output directory (-o)
-```shell
-mediasnacks resize --height 240 --output-dir /tmp/out video.mov
-```
-
-<br/>
-
-### Fast-Start Streaming Video
-Rearranges .mov and .mp4 metadata to the start of the file for fast-start streaming.
-
-**Files are overwritten**
-
-```shell
-mediasnacks moov2front <videos>
-```
-What is Fast Start?
-- https://wiki.avblocks.com/avblocks-for-cpp/muxer-parameters/mp4
-- https://trac.ffmpeg.org/wiki/HowToCheckIfFaststartIsEnabledForPlayback
-
-
-<br/>
-
----
-
 ## Adding a macOS Quick Action
 
 

package/install-zsh-completions.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+import { join } from 'node:path'
+import { execSync } from 'node:child_process'
+import { writeFileSync } from 'node:fs'
+import { commandsSummary } from './src/cli.js'
+
+let zshFuncDefsDirs
+try {
+	zshFuncDefsDirs = execSync('zsh -c "print -l \\$fpath"', { encoding: 'utf-8' })
+}
+catch {
+	process.exit(0) // Exit on systems without ZSH
+}
+
+for (const dir of zshFuncDefsDirs.split('\n'))
+	try {
+		writeFileSync(join(dir, '_mediasnacks'), makeScript(), { mode: 0o755 })
+		break
+	}
+	catch {}
+
+
+function makeScript() {
+	return `#compdef mediasnacks
+
+_mediasnacks_commands=(
+${commandsSummary().map(([cmd, desc]) => `'${cmd}:${desc}'`).join('\n')}
+)
+
+if (( CURRENT == 2 )); then
+	_describe -t commands 'mediasnacks commands' _mediasnacks_commands
+	return
+fi
+
+local cmd="$words[2]"
+case "$cmd" in
+	qdir)
+		_files -/
+		;;
+	*)
+		_files
+		;;
+esac
+`
+}
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediasnacks",
-  "version": "0.21.0",
+  "version": "0.22.2",
   "description": "Utilities for optimizing and preparing videos and images",
   "license": "MIT",
   "author": "Eric Fortis",
@@ -10,12 +10,11 @@
 	},
 	"scripts": {
 		"test": "docker run --rm $(docker build -q .)",
-		"postinstall": "sh install-zsh-completions.sh",
+		"postinstall": "node install-zsh-completions.js",
 		"dev-install": "npm i -g . --ignore-scripts=false"
 	},
 	"files": [
 		"src",
-		".zsh",
-		"install-zsh-completions.sh"
+		"install-zsh-completions.js"
 	]
 }

package/src/avif.js

@@ -4,10 +4,10 @@ import { join, basename, dirname } from 'node:path'
 
 import { parseOptions } from './utils/parseOptions.js'
 import { replaceExt, lstat } from './utils/fs-utils.js'
-import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks avif [-y | --overwrite] [--output-dir=<dir>] <images> 
 
@@ -26,7 +26,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
@@ -35,14 +35,14 @@ async function main() {
 
 	console.log('AVIF…')
 	for (const file of files)
-		await toAvif({
+		await avif({
 			file,
 			outFile: join(values['output-dir'] || dirname(file), replaceExt(basename(file), 'avif')),
 			overwrite: values.overwrite
 		})
 }
 
-async function toAvif({ file, outFile, overwrite }) {
+async function avif({ file, outFile, overwrite }) {
 	const stAvif = lstat(outFile)
 
 	if (!overwrite && stAvif?.isFile()) {

package/src/cli.js

@@ -18,7 +18,7 @@ const COMMANDS = {
 	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 in macOS Finder '],
+	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'],
@@ -28,7 +28,9 @@ const COMMANDS = {
 
 	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\n'],
+	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'],
@@ -37,36 +39,46 @@ const COMMANDS = {
 	rmcover: ['rmcover.sh', 'Removes cover art'],
 }
 
-const MAN = `
+export function commandsSummary() {
+	return Object.entries(COMMANDS)
+		.map(([cmd, [, desc]]) => [cmd, desc])
+}
+
+const HELP = `
 SYNOPSIS
   mediasnacks <command> <args>
 
 COMMANDS
-${Object.entries(COMMANDS).map(([cmd, [, title]]) =>
-	`  ${styleText('bold', cmd.padEnd(12, ' '))}\t${title}`).join('\n')}
+${commandsSummary().map(([cmd, desc]) =>
+	`  ${styleText('bold', cmd.padEnd(12, ' '))}\t${desc}`).join('\n')}
 `.trim()
 
 
-const [, , opt, ...args] = process.argv
+function main() {
+	const [, , opt, ...args] = process.argv
 
-if (opt === '-v' || opt === '--version') {
-	console.log(pkgJSON.version)
-	process.exit(0)
-}
-if (opt === '-h' || opt === '--help') {
-	console.log(MAN)
-	process.exit(0)
-}
+	if (opt === '-v' || opt === '--version') {
+		console.log(pkgJSON.version)
+		process.exit(0)
+	}
+	if (opt === '-h' || opt === '--help') {
+		console.log(HELP)
+		process.exit(0)
+	}
 
-if (!opt) {
-	console.log(MAN)
-	process.exit(1)
-}
-if (!Object.hasOwn(COMMANDS, opt)) {
-	console.error(`'${opt}' is not a command. See mediasnacks --help\n`)
-	process.exit(1)
+	if (!opt) {
+		console.log(HELP)
+		process.exit(1)
+	}
+	if (!Object.hasOwn(COMMANDS, opt)) {
+		console.error(`'${opt}' is not a command. See mediasnacks --help\n`)
+		process.exit(1)
+	}
+
+	const cmd = join(import.meta.dirname, COMMANDS[opt][0])
+	spawn(cmd, args, { stdio: 'inherit' })
+		.on('exit', process.exit)
 }
 
-const cmd = join(import.meta.dirname, COMMANDS[opt][0])
-spawn(cmd, args, { stdio: 'inherit' })
-	.on('exit', process.exit)
+if (import.meta.main)
+	main()

package/src/detectdups.js

@@ -1,14 +1,16 @@
 #!/usr/bin/env node
 
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, assertUserHasFFmpeg, videoAttrs } from './utils/ffmpeg.js'
+import { ffmpeg, assertUserHasFFmpeg, videoAttrs } from './utils/subprocess.js'
 
 const STDEV_THRESHOLD = 0.2
 
-const MAN = `
-Usage: mediasnacks detectdups [options] <video>
+const HELP = `
+SYNOPSIS
+  mediasnacks detectdups [options] <video>
 
-Detects sequentially duplicate frames in a video and prints a histogram of their distance.
+DESCRIPTION
+  Detects sequentially duplicate frames in a video and prints a histogram of their distance.
 
 EXAMPLES
   Peak at N=2, means that every other frame is repeated, such as in a 
@@ -38,7 +40,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
@@ -70,7 +72,7 @@ async function main() {
 		throw new Error(`Invalid analysis range. Exceeds video duration: ${vDur}`)
 
 
-	const dups = await detectDuplicateFramesNums(files[0], seek, duration)
+	const dups = await detectdups(files[0], seek, duration)
 	const h = deltaHistogram(dups)
 	const report = {
 		n: maxFreqKey(h),
@@ -83,7 +85,7 @@ async function main() {
 	console.log(JSON.stringify(report, null, 2))
 }
 
-export async function detectDuplicateFramesNums(video, seek, duration) {
+export async function detectdups(video, seek, duration) {
 	const { stderr } = await ffmpeg([
 		'-v', 'info',
 		'-stats',

package/src/dropdups.js

@@ -3,21 +3,13 @@
 import { resolve, parse, format } from 'node:path'
 
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, assertUserHasFFmpeg, run } from './utils/ffmpeg.js'
+import { ffmpeg, assertUserHasFFmpeg, run } from './utils/subprocess.js'
+import { PRORES_PROFILES } from './prores.js'
 
 
-const PRORES_PROFILES = {
-	'proxy': 0,
-	'lt': 1,
-	'standard': 2,
-	'hq': 3,
-	'4444': 4,
-	'4444xq': 5,
-}
 const PROFILE = PRORES_PROFILES.hq
 
-
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks dropdups [-n <bad-frame-number>] <video>
 
@@ -42,7 +34,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
@@ -55,10 +47,10 @@ async function main() {
 
 	console.log('Dropping Duplicate Frames…')
 	for (const file of files)
-		await drop(resolve(file), nBadFrame)
+		await dropdups(resolve(file), nBadFrame)
 }
 
-async function drop(video, nBadFrame) {
+async function dropdups(video, nBadFrame) {
 	await run('ffmpeg', [
 		'-v', 'error',
 		'-stats',

package/src/edgespic.js

@@ -4,10 +4,10 @@ import { basename, extname, join, parse } from 'node:path'
 
 import { mkDir } from './utils/fs-utils.js'
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, videoAttrs, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { ffmpeg, videoAttrs, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks edgespic [--width=<num>] <files>
 
@@ -30,7 +30,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
@@ -46,11 +46,11 @@ async function main() {
 
 	console.log('Extracting edge frames…')
 	for (const file of files)
-		await extractEdgeFrames(file, width, outDir)
+		await edgespic(file, width, outDir)
 }
 
 
-async function extractEdgeFrames(video, width, outDir) {
+async function edgespic(video, width, outDir) {
 	const { r_frame_rate } = await videoAttrs(video)
 	const name = basename(video, extname(video))
 

package/src/hev1tohvc1.js

@@ -2,10 +2,10 @@
 
 import { parseOptions } from './utils/parseOptions.js'
 import { uniqueFilenameFor, overwrite } from './utils/fs-utils.js'
-import { videoAttrs, ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { videoAttrs, ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks hev1tohvc1 <videos>
 
@@ -22,14 +22,14 @@ async function main() {
 	const { files } = await parseOptions()
 
 	if (!files.length)
-		throw new Error(MAN)
+		throw new Error(HELP)
 
 	console.log('HEV1 to HVC1…')
 	for (const file of files)
-		await toHvc1(file)
+		await hev1tohvc1(file)
 }
 
-async function toHvc1(file) {
+async function hev1tohvc1(file) {
 	const v = await videoAttrs(file)
 	if (v.codec_tag_string !== 'hev1') {
 		console.log('(skipped: non hev1)', file)

package/src/moov2front.js

@@ -1,16 +1,20 @@
 #!/usr/bin/env node
 
-import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 import { uniqueFilenameFor, overwrite } from './utils/fs-utils.js'
 import { parseOptions } from './utils/parseOptions.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks moov2front <videos>
 
 DESCRIPTION
   Rearranges .mov and .mp4 metadata to the start of the file for fast-start streaming.
+  
+  What is Fast Start?
+	  - https://wiki.avblocks.com/avblocks-for-cpp/muxer-parameters/mp4
+	  - https://trac.ffmpeg.org/wiki/HowToCheckIfFaststartIsEnabledForPlayback
  
 NOTES
   Files are overwritten.
@@ -22,7 +26,7 @@ async function main() {
 	const { files } = await parseOptions()
 
 	if (!files.length)
-		throw new Error(MAN)
+		throw new Error(HELP)
 
 	console.log('Optimizing video for progressive download…')
 	for (const file of files)

package/src/play.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+import { join } from 'node:path'
+import { spawn } from 'node:child_process'
+import { readdirSync } from 'node:fs'
+import { parseOptions } from './utils/parseOptions.js'
+
+
+const HELP = `
+SYNOPSIS
+  mediasnacks play [--no-recursive] [-h | --help] [query ...]
+
+DESCRIPTION
+  Plays a filtered playlist with mpv.
+ 
+EXAMPLE
+  cd Music
+  mediasnacks play artistX artistY
+`.trim()
+
+
+async function main() {
+	const { values, positionals } = await parseOptions({
+		recursive: { short: 'r', type: 'boolean', default: true },
+		help: { short: 'h', type: 'boolean' }
+	}, { allowNegative: true })
+
+	if (values.help) {
+		console.log(HELP)
+		process.exit(0)
+	}
+
+	const pattern = positionals.length
+		? positionals.join('|')
+		: ''
+	const files = findFiles('.', new RegExp(pattern, 'i'), values.recursive)
+
+	if (!files.length) {
+		console.error('No matching files found.')
+		process.exit(0)
+	}
+
+	const child = spawn('mpv', ['--playlist=-'], {
+		detached: true,
+		stdio: ['pipe', 'ignore', 'ignore']
+	})
+	child.stdin.end(files.join('\n'))
+	child.unref()
+}
+
+function findFiles(dir, regex, recursive = true) {
+	const IGNORED_DIRS = ['.fcpbundle/']
+	return readdirSync(dir, { withFileTypes: true, recursive })
+		.filter(entry =>
+			entry.isFile()
+			&& !entry.name.startsWith('.')
+			&& !IGNORED_DIRS.some(d => entry.parentPath.includes(d))
+			&& regex.test(entry.name))
+		.map(entry => join(entry.parentPath, entry.name))
+}
+
+main().catch(err => {
+	console.error(err.message)
+	process.exit(1)
+})

package/src/prores.js

@@ -3,9 +3,9 @@
 import { resolve, parse, join } from 'node:path'
 
 import { parseOptions } from './utils/parseOptions.js'
-import { assertUserHasFFmpeg, run } from './utils/ffmpeg.js'
+import { assertUserHasFFmpeg, run } from './utils/subprocess.js'
 
-const PRORES_PROFILES = {
+export const PRORES_PROFILES = {
 	'proxy': 0,
 	'lt': 1,
 	'standard': 2,
@@ -14,7 +14,7 @@ const PRORES_PROFILES = {
 	'4444xq': 5,
 }
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks prores [options] <video>
 
@@ -42,31 +42,35 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
 	if (files.length !== 1)
 		throw new Error('Expected 1 argument: video file. See mediasnacks prores --help')
 
-	const videoPath = resolve(files[0])
-
-	const { name, dir } = parse(videoPath)
-	const outputPath = join(dir, `${name}.prores.mov`)
+	const video = resolve(files[0])
+	const { name, dir } = parse(video)
+	const output = join(dir, `${name}.prores.mov`)
 
 	console.log(`Converting to ProRes…`)
+	await prores(video, values.profile, output)
+}
+
+async function prores(video, profile, output) {
 	await run('ffmpeg', [
 		'-v', 'error',
 		'-stats',
-		'-i', videoPath,
+		'-i', video,
 		'-c:v', 'prores_ks',
-		'-profile:v', values.profile,
+		'-profile:v', profile,
 		'-pix_fmt', 'yuv422p10le',
-		outputPath
+		output
 	])
 }
 
-main().catch(err => {
-	console.error(err.message || err)
-	process.exit(1)
-})
+if (import.meta.main)
+	main().catch(err => {
+		console.error(err.message || err)
+		process.exit(1)
+	})

package/src/qdir.js

@@ -8,7 +8,7 @@ import { readdir, writeFile, unlink, rename } from 'node:fs/promises'
 import { isFile } from './utils/fs-utils.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks qdir [folder]
 
@@ -26,7 +26,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 

package/src/random.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+import { join } from 'node:path'
+import { spawn } from 'node:child_process'
+import { readdirSync } from 'node:fs'
+import { parseOptions } from './utils/parseOptions.js'
+
+
+const HELP = `
+SYNOPSIS
+  mediasnacks random [-r | --recursive] [-h | --help]
+
+DESCRIPTION
+  Opens a random file in the current working directory
+`.trim()
+
+async function main() {
+	if (process.platform !== 'darwin') {
+		console.error('Error: This command is only supported on macOS.')
+		process.exit(1)
+	}
+
+	const { values } = await parseOptions({
+		recursive: { short: 'r', type: 'boolean' },
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
+		console.log(HELP)
+		process.exit(0)
+	}
+
+	spawn('open', [pickRandomFile('.', values.recursive)])
+}
+
+function pickRandomFile(dir, recursive) {
+	const files = readdirSync(dir, { withFileTypes: true, recursive })
+		.filter(entry => !entry.name.startsWith('.') && entry.isFile())
+		.map(entry => join(entry.parentPath, entry.name))
+	return files[Math.floor(Math.random() * files.length)]
+}
+
+main().catch(err => {
+	console.error(err.message)
+	process.exit(1)
+})

package/src/resize.js

@@ -5,10 +5,10 @@ import { rename } from 'node:fs/promises'
 
 import { parseOptions } from './utils/parseOptions.js'
 import { isFile, uniqueFilenameFor } from './utils/fs-utils.js'
-import { ffmpeg, videoAttrs, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { ffmpeg, videoAttrs, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks resize [--width=<num>] [--height=<num>] [-y | --overwrite] [--output-dir=<dir>] <files>
 
@@ -41,7 +41,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}