mediasnacks 0.21.0 → 0.22.2

package/src/seqcheck.js

@@ -4,7 +4,7 @@ import { parseArgs } from 'node:util'
 import { readdirSync } from 'node:fs'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks seqcheck [options] [folder]
 
@@ -29,7 +29,7 @@ function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 

package/src/sqcrop.js

@@ -3,12 +3,12 @@
 import { join } from 'node:path'
 import { rename } from 'node:fs/promises'
 
-import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 import { lstat, uniqueFilenameFor } from './utils/fs-utils.js'
 import { parseOptions } from './utils/parseOptions.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks sqcrop [-y | --overwrite] [--output-dir=<dir>] <images> 
 
@@ -27,7 +27,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 

package/src/ssim.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import { ffmpeg } from './utils/ffmpeg.js'
+import { ffmpeg } from './utils/subprocess.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks ssim <img1> <img2>
 
@@ -15,7 +15,7 @@ DESCRIPTION
 async function main() {
 	const [img1, img2] = process.argv.slice(2)
 	if (!img1 || !img2) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(1)
 	}
 

package/src/utils/parseOptions.js

@@ -13,6 +13,7 @@ export async function parseOptions(options = {}, config = {}) {
 	})
 	return {
 		values,
+		positionals,
 		files: await resolveGlobs(positionals, tokens)
 	}
 }

package/src/vsplit.js

@@ -4,12 +4,12 @@ import { readFileSync } from 'node:fs'
 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'
 
 
 // TODO looks like it's missing a frame (perhaps becaue of -c copy)
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks vsplit <csv> <video>
 
@@ -41,7 +41,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
@@ -55,7 +55,7 @@ async function main() {
 		throw new Error('CSV file contains no clips')
 
 	console.log(`Splitting video into ${clips.length} clip${clips.length === 1 ? '' : 's'}…`)
-	await splitVideo(videoPath, clips)
+	await vsplit(videoPath, clips)
 }
 
 function parseCSV(csvPath) {
@@ -77,7 +77,7 @@ function parseCSV(csvPath) {
 	return clips
 }
 
-async function splitVideo(videoPath, clips) {
+async function vsplit(videoPath, clips) {
 	const { dir, name, ext } = parse(videoPath)
 	const seqLen = Math.log10(clips.length) + 1 | 0
 

package/src/vtrim.js

@@ -2,10 +2,10 @@
 
 import { resolve, parse } from 'node:path'
 import { parseOptions } from './utils/parseOptions.js'
-import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/subprocess.js'
 
 
-const MAN = `
+const HELP = `
 SYNOPSIS
   mediasnacks vtrim [--start <time>] [--end <time>] <video>
 
@@ -29,7 +29,7 @@ async function main() {
 	})
 
 	if (values.help) {
-		console.log(MAN)
+		console.log(HELP)
 		process.exit(0)
 	}
 
@@ -37,10 +37,10 @@ async function main() {
 		throw new Error('No video specified. See mediasnacks vtrim --help')
 
 	for (const file of files)
-		await trim(resolve(file), values.start, values.end)
+		await vtrim(resolve(file), values.start, values.end)
 }
 
-async function trim(video, start, end) {
+async function vtrim(video, start, end) {
 	const { dir, name, ext } = parse(video)
 	await ffmpeg([
 		'-v', 'error',

package/.zsh/completions/_mediasnacks

@@ -1,47 +0,0 @@
-#compdef mediasnacks
-
-_mediasnacks_commands=(
-  'avif:Converts images to AVIF'
-  'sqcrop:Square crops images'
-  
-  'resize:Resizes videos or images'
-  'edgespic:Extracts first and last frames'
-  'ssim:Computes similarity of two images'
-  'gif:Video to GIF'
-  
-  'detectdups:Detects sequentially duplicate frames in a video'
-  'dropdups:Removes sequentially duplicate frames in a video'
-  'framediff:ffplay with a filter for diffing adjacent frames'
-  'hev1tohvc1:Fixes video thumbnails not rendering in macOS Finder'
-  'moov2front:Rearranges metadata for fast-start streaming'
-  'vconcat:Concatenates videos'
-  'vdiff:Plays a video with the difference of two videos'
-  'vsplit:Splits a video into multiple clips from CSV timestamps'
-  'vtrim:Trims video from start to end time'
-  'prores:Converts video to Apple ProRes'
-  
-  'flattendir:Moves unique files to the top dir and deletes empty dirs'
-  'seqcheck:Finds missing sequence number'
-  'qdir:Sequentially runs all *.sh files in a folder'
-  
-  'dlaudio: yt-dlp best audio'
-  'dlvideo: yt-dlp best video'
-  
-  'unemoji:Removes emojis from filenames'
-  'rmcover:Removes cover art'
-)
-
-if (( CURRENT == 2 )); then
-	_describe -t commands 'mediasnacks commands' _mediasnacks_commands
-	return
-fi
-
-local cmd="$words[2]"
-case "$cmd" in
-	avif|resize|sqcrop|moov2front|detectdups|dropdups|edgespic|seqcheck|hev1tohvc1|framediff|vdiff|vconcat|vsplit|vtrim|dlaudio|dlvideo|unemoji|rmcover|curltime|gif|flattendir|prores|ssim)
-		_files
-		;;
-	qdir)
-		_files -/
-		;;
-esac

package/install-zsh-completions.sh

@@ -1,23 +0,0 @@
-#!/bin/sh
-set -eu
-
-# Exit on systems without ZSH
-zsh=$(command -v zsh) || exit 0
-
-src="$(cd "$(dirname "$0")" && pwd)/.zsh/completions/_mediasnacks"
-[ -f "$src" ] || exit 0
-
-exec "$zsh" -s "$src" << 'ZSH_EOF'
-src="$1"
-for dir in "${fpath[@]}"; do
-  if [ -w "$dir" ]; then
-    dst="$dir/_mediasnacks"
-    ln -sf "$src" "$dst"
-    echo "linked zsh completions: $dst -> $src"
-    exit 0
-  fi
-done
-echo "zsh completions: no writable fpath directory found, skipping." >&2
-exit 0
-ZSH_EOF
-

package/src/avif.test.js

@@ -1,16 +0,0 @@
-import { join } from 'node:path'
-import { test } from 'node:test'
-import { ok } from 'node:assert/strict'
-
-import { ssim } from './ssim.js'
-import { mkTempDir, cli } from './utils/test-utils.js'
-
-const rel = f => join(import.meta.dirname, f)
-
-test('PNG to AVIF', async () => {
-	const tmp = mkTempDir('avif')
-	cli('avif', '--output-dir', tmp, rel('fixtures/lenna.png'))
-
-	const similarityScore = await ssim(join(tmp, 'lenna.avif'), rel('fixtures/lenna.avif'))
-	ok(similarityScore > 0.99, `Similarity too low: ${similarityScore}`)
-})

package/src/detectdups.test.js

@@ -1,24 +0,0 @@
-import { test } from 'node:test'
-import { join } from 'node:path'
-import { equal } from 'node:assert/strict'
-import { cli } from './utils/test-utils.js'
-
-const rel = f => join(import.meta.dirname, f)
-
-function detect(video) {
-	const { stdout } = cli('detectdups', rel(video))
-	return JSON.parse(stdout).n
-}
-
-test('no dups', () => equal(detect('fixtures/big-buck-bunny/bbb_24fps_no_dups.mp4'), null))
-
-// These fixtures are badly retimed (non-interpolated, just duplicating a frame)
-
-test('24 to 48 (has dup at n=2)', () => equal(detect('fixtures/big-buck-bunny/bbb_24_to_48fps_dup.mp4'), 2))
-test('25 to 50 (has dup at n=2)', () => equal(detect('fixtures/big-buck-bunny/bbb_25_to_50fps_dup.mp4'), 2))
-
-test('24 to 30 (has dup at n=5)', () => equal(detect('fixtures/big-buck-bunny/bbb_24_to_30fps_dup.mp4'), 5))
-test('25 to 30 (has dup at n=6)', () => equal(detect('fixtures/big-buck-bunny/bbb_25_to_30fps_dup.mp4'), 6))
-
-test('24 to 25 (has dup at n=25)', () => equal(detect('fixtures/big-buck-bunny/bbb_24_to_25fps_dup.mp4'), 25))
-

package/src/edgespic.test.js

@@ -1,36 +0,0 @@
-import { ok } from 'node:assert/strict'
-import { join } from 'node:path'
-import { describe, test } from 'node:test'
-import { cpSync, readdirSync, } from 'node:fs'
-
-import { ssim } from './ssim.js'
-import { cli, mkTempDir } from './utils/test-utils.js'
-
-const rel = f => join(import.meta.dirname, f)
-
-describe('edgespic', () => {
-	const tmp = mkTempDir('edgespic')
-	const inputFile = join(tmp, '60fps.mp4')
-	cpSync(rel('fixtures/60fps.mp4'), inputFile)
-	cli('edgespic', inputFile)
-
-	test('creates output directory', () => {
-		const files = readdirSync(join(tmp, 'edgespic'))
-		ok(files.length === 2, `Expected 2 PNG files, got ${files.length}`)
-	})
-
-	test('extracts first frame', async () => {
-		const out = join(tmp, 'edgespic', '60fps_first.png')
-		const fixture = rel('fixtures/edgespic/60fps_first.png')
-		const similarityScore = await ssim(out, fixture)
-		ok(similarityScore > 0.99, `Similarity too low: ${similarityScore}`)
-	})
-
-	test('extracts last frame', async () => {
-		const out = join(tmp, 'edgespic', '60fps_last.png')
-		const fixture = rel('fixtures/edgespic/60fps_last.png')
-		const similarityScore = await ssim(out, fixture)
-		ok(similarityScore > 0.99, `Similarity too low: ${similarityScore}`)
-	})
-})
-

package/src/fixtures/60fps.csv

@@ -1,7 +0,0 @@
-start,end
-0,5
-5,10
-10,15
-15,20
-20,25
-25,30

package/src/fixtures/big-buck-bunny/generate.md

@@ -1,71 +0,0 @@
-# Generating Fixtures
-
-
-## 1. Download a video (Big Buck Bunny)
-
-```sh
-curl https://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_1080p_h264.mov -o bbb_full_24fps.mov
-```
-
-## 2. Extract a scene
-Using the third scene because it's complex enough to cover many edge cases.
-It has a bird flapping its wings with motion blur. Also, animated text titles, 
-and fairly static frames after the title ends.
-
-The scene is 1080p, 24fps, 7.28sec, h.264.
-```sh
-brew tap ericfortis/fcpscene
-brew install fcpscene
-fcpscene -m files bbb_full_24fps.mov 
-
-cp bbb/bbb_full_24fps_003.mov ./bbb_24fps_no_dups.mov
-rm -rf bbb
-rm bbb_full_24fps.mov  
-```
-
-## 3. Re-encode the scene 24fps
-This way all videos will share the same encoding, and no audio.
-
-```sh
-ffmpeg -i bbb_24fps_no_dups.mov \
-  -c:v libx264 -crf 18 -preset slow \
-  -an \
-  bbb_24fps_no_dups.mp4
-```
-
-## 4. Retime (no dups) speed stretch to 25fps
-For a good (no dups) 25fps, retiming by speeding it up.
-```sh
-ffmpeg -i bbb_24fps_no_dups.mp4 \
-  -vf "setpts=24/25*PTS" \
-  -r 25 \
-  bbb_25fps_no_dups.mp4
-```
-
-
-## 5. Retime by inserting duplicates (no interpolation)
-```sh
-for TARGET_FPS in 48 30 25; do
-  ffmpeg -i bbb_24fps_no_dups.mp4 \
-    -vf fps=$TARGET_FPS \
-    -c:v libx264 -crf 18 -preset slow \
-    -an \
-    "bbb_24_to_${TARGET_FPS}fps_dup.mp4"
-done
-
-for TARGET_FPS in 60 50 30; do
-  ffmpeg -i bbb_25fps_no_dups.mp4 \
-    -vf fps=$TARGET_FPS \
-    -c:v libx264 -crf 18 -preset slow \
-    -an \
-    "bbb_25_to_${TARGET_FPS}fps_dup.mp4"
-done
-```
-Counting the cycle from 1 (not from 0):
-
-- 24 to 48 (inserts dup at n=2) 0101
-- 25 to 50 (inserts dup at n=2) 0101
-- 24 to 30 (inserts dup at n=5) 0000100001
-- 25 to 30 (inserts dup at n=6) 000001000001
-- 24 to 25 (inserts dup at n=25) (0*24)1
-- 25 to 60 (inserts dup at n=2 and n=3) 01011

package/src/fixtures/qdir-jobs/job1_good.sh

@@ -1 +0,0 @@
-exit 0

package/src/fixtures/qdir-jobs/job2_bad.sh

@@ -1 +0,0 @@
-exit 1

package/src/fixtures/qdir-jobs/job3_good.sh

@@ -1,2 +0,0 @@
-sleep 0.5
-exit 0

package/src/fixtures/qdir-jobs/job4_bad.sh

@@ -1 +0,0 @@
-exit 1

package/src/flattendir.test.js

@@ -1,36 +0,0 @@
-import { test } from 'node:test'
-import { deepEqual } from 'node:assert/strict'
-import { readdirSync } from 'node:fs'
-
-import { mkTempDir, cli, dir, touch } from './utils/test-utils.js'
-
-test('flattendir moves files to top level and deletes empty dirs', () => {
-	const tmp = mkTempDir('flattendir')
-	dir(tmp, 'dir1', 'dir1-1')
-	dir(tmp, 'dir2')
-	touch(tmp, 'file1.txt')
-	touch(tmp, 'dir1', 'file2.txt')
-	touch(tmp, 'dir1', 'dir1-1', 'file3.txt')
-	touch(tmp, 'dir1', '.DS_Store')
-
-	cli('flattendir', tmp)
-	deepEqual(readdirSync(tmp).sort(), [
-		'file1.txt',
-		'file2.txt',
-		'file3.txt'
-	])
-})
-
-test('flattendir does not move files if filename collision occurs', () => {
-	const tmp = mkTempDir('flattendir-collision')
-	dir(tmp, 'dir1')
-	touch(tmp, 'file1.txt')
-	touch(tmp, 'dir1', 'file1.txt')
-
-	cli('flattendir', tmp)
-	deepEqual(readdirSync(tmp, { recursive: true }).sort(), [
-		'dir1',
-		'dir1/file1.txt',
-		'file1.txt'
-	])
-})

package/src/qdir.test.js

@@ -1,24 +0,0 @@
-import { test } from 'node:test'
-import { join } from 'node:path'
-import { equal, deepEqual } from 'node:assert/strict'
-import { cpSync, readdirSync } from 'node:fs'
-
-import { qdir } from './qdir.js'
-import { mkTempDir } from './utils/test-utils.js'
-
-const rel = f => join(import.meta.dirname, f)
-
-test('qdir-jobs get renamed and failed have their exit status code', async () => {
-	const tmp = mkTempDir('qdir')
-	cpSync(rel('fixtures/qdir-jobs'), tmp, { recursive: true })
-
-	const err = await qdir(tmp, 0.2)
-	equal(err, null)
-
-	deepEqual(readdirSync(tmp).sort(), [
-		'job1_good.sh.done',
-		'job2_bad.sh.failed.1',
-		'job3_good.sh.done',
-		'job4_bad.sh.failed.1'
-	])
-})

package/src/seqcheck.test.js

@@ -1,27 +0,0 @@
-import { test } from 'node:test'
-import { deepEqual } from 'node:assert/strict'
-import { extractSeqNums, findMissingNumbers } from './seqcheck.js'
-
-
-test('extractSeqNums extracts sequence numbers from filenames', () => {
-	const filenames = [
-		'video-111_001.mov',
-		'video-111_002.mov',
-		'video-111_004.mov',
-		'bad.mov',
-		'bad_too_a39.mov',
-	]
-	deepEqual(extractSeqNums(filenames, '_', '.'), [1, 2, 4])
-})
-
-
-test('findMissingNumbers ', () => {
-	test('finds gaps in a sequence', () =>
-		deepEqual(findMissingNumbers([1, 2, 4, 5, 8]), [3, 6, 7]))
-
-	test('returns empty array for empty input', () =>
-		deepEqual(findMissingNumbers([]), []))
-
-	test('returns empty array when there are no gaps', () =>
-		deepEqual(findMissingNumbers([10, 11, 12]), []))
-})

package/src/utils/fs-utils.test.js

@@ -1,21 +0,0 @@
-import { equal } from 'node:assert/strict'
-import test, { describe } from 'node:test'
-import { replaceExt } from './fs-utils.js'
-
-
-describe('replaceExt', () => {
-	test('replaces a simple extension', () =>
-		equal(replaceExt('file.txt', 'md'), 'file.md'))
-
-	test('replaces a multi-part extension', () =>
-		equal(replaceExt('archive.tar.gz', 'zip'), 'archive.tar.zip'))
-
-	test('adds extension when none exists', () =>
-		equal(replaceExt('README', 'md'), 'README.md'))
-
-	test('handles empty filename', () =>
-		equal(replaceExt('', 'ext'), '.ext'))
-
-	test('handles dot-files', () =>
-		equal(replaceExt('.env', 'txt'), '.env.txt'))
-})

package/src/utils/parseOptions.test.js

@@ -1,59 +0,0 @@
-import { join } from 'node:path'
-import { tmpdir } from 'node:os'
-import { equal, deepEqual } from 'node:assert/strict'
-import { mkdtemp, writeFile, rm } from 'node:fs/promises'
-import { test, describe, before, after } from 'node:test'
-
-import { parseOptions } from './parseOptions.js'
-
-
-describe('parseOptions', () => {
-	let testDir
-	let inTmpDir = f => join(testDir, f)
-	const testFiles = ['file1.png', 'file2.png', 'file3.png']
-
-	before(async () => {
-		testDir = await mkdtemp(join(tmpdir(), 'parse-args-'))
-		for (const file of testFiles)
-			await writeFile(inTmpDir(file), '')
-	})
-
-	after(() => rm(testDir, { recursive: true }))
-
-	test('parses args and globs files', async () => {
-		const { values, files } = await parseOptions({
-			'output-dir': { type: 'string' }
-		}, {
-			args: ['--output-dir', '/tmp', inTmpDir('file[12].png')],
-		})
-		equal(values['output-dir'], '/tmp')
-		deepEqual(files, [
-			inTmpDir('file1.png'),
-			inTmpDir('file2.png')
-		])
-	})
-
-	test('respects verbatim tokens', async () => {
-		const literal0 = 'literal-file[98].png'
-		const literal1 = 'literal-file[99].png'
-		const { files } = await parseOptions({}, {
-			args: [inTmpDir('file[12].png'), '--', literal0, literal1]
-		})
-		deepEqual(files, [
-			inTmpDir('file1.png'),
-			inTmpDir('file2.png'),
-			literal0,
-			literal1,
-		])
-	})
-
-	test('empty files array when no positionals', async () => {
-		const { files, values } = await parseOptions({
-			foo: { type: 'boolean' }
-		}, {
-			args: ['--foo'],
-		})
-		equal(values.foo, true)
-		deepEqual(files, [])
-	})
-})

package/src/vconcat.test.js

@@ -1,23 +0,0 @@
-import { ok } from 'node:assert/strict'
-import { join } from 'node:path'
-import { test } from 'node:test'
-import { cpSync } from 'node:fs'
-
-import { videoAttrs } from './utils/ffmpeg.js'
-import { mkTempDir, cli } from './utils/test-utils.js'
-
-const rel = f => join(import.meta.dirname, f)
-
-test('vconcat concatenates videos with single quotes in filenames', async () => {
-	const tmp = mkTempDir('vconcat')
-
-	const file1 = join(tmp, `video'1.mp4`)
-	const file2 = join(tmp, `video'2.mp4`)
-	cpSync(rel('fixtures/60fps.mp4'), file1)
-	cpSync(rel('fixtures/60fps.mp4'), file2)
-
-	cli('vconcat', file1, file2)
-
-	const { duration } = await videoAttrs(join(tmp, `video'1.concat.mp4`))
-	ok(parseFloat(duration) === 60, `Duration should be 60s, got ${duration}s`)
-})

package/src/vsplit.test.js

@@ -1,32 +0,0 @@
-import { ok } from 'node:assert/strict'
-import { join } from 'node:path'
-import { describe, test } from 'node:test'
-import { cpSync, readdirSync } from 'node:fs'
-
-import { videoAttrs } from './utils/ffmpeg.js'
-import { mkTempDir, cli } from './utils/test-utils.js'
-
-
-const rel = f => join(import.meta.dirname, f)
-
-describe('vsplit splits video into multiple clips from CSV', () => {
-	const tmp = mkTempDir('vsplit')
-
-	const csvFile = join(tmp, '60fps.csv')
-	const inputFile = join(tmp, '60fps.mp4')
-
-	cpSync(rel('fixtures/60fps.csv'), csvFile)
-	cpSync(rel('fixtures/60fps.mp4'), inputFile)
-	cli('vsplit', csvFile, inputFile)
-
-	test('all 6 clips were created', () => {
-		const files = readdirSync(tmp).filter(f => f.startsWith('60fps_'))
-		ok(files.length === 6, `Expected 6 clips, got ${files.length}`)
-	})
-
-	test('first clip has correct duration (5 seconds)', async () => {
-		const { duration } = await videoAttrs(join(tmp, '60fps_1.mp4'))
-		const EPSILON = 0.05
-		ok(Math.abs(parseFloat(duration) - 5) < EPSILON, `Duration should be 5s, got ${duration}s`)
-	})
-})