mediasnacks 0.7.0 → 0.8.0

package/.zsh/completions/_mediasnacks

@@ -17,7 +17,7 @@ _mediasnacks_commands=(
   'rmcover:Removes cover art'
   'curltime:Measures request response timings',
   'gif:Video to GIF',
-  'flattendir:Moves all files to top dir and deletes dirs'
+  'flattendir:Moves unique files to the top dir and deletes empty dirs'
 )
 
 _mediasnacks() {

package/README.md

@@ -32,7 +32,7 @@ Commands:
 - `curltime`: Measures request response timings
 - `gif`: Video to GIF
  
-- `flattendir`: Moves all files to top dir and deletes dirs
+- `flattendir`: Moves unique files to the top dir and deletes empty dirs
 <br/>
 
 ### Converting Images to AVIF

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediasnacks",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Utilities for preparing videos, images, and audio for the web",
   "license": "MIT",
   "author": "Eric Fortis",

package/src/avif.js

@@ -3,7 +3,7 @@
 import { join } from 'node:path'
 import { parseArgs } from 'node:util'
 
-import { glob, replaceExt, lstat } from './utils/fs-utils.js'
+import { replaceExt, lstat, globAll } from './utils/fs-utils.js'
 import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
 
 
@@ -15,6 +15,8 @@ Converts images to AVIF.
 
 
 async function main() {
+	await assertUserHasFFmpeg()
+
 	const { values, positionals } = parseArgs({
 		options: {
 			'output-dir': { type: 'string', default: '' },
@@ -32,22 +34,19 @@ async function main() {
 	if (!positionals.length)
 		throw new Error('No images specified. See npx mediasnacks avif --help')
 
-	await assertUserHasFFmpeg()
-	
 	console.log('AVIF…')
-	for (const g of positionals)
-		for (const file of await glob(g))
-			await toAvif({
-				file,
-				outFile: join(values['output-dir'], replaceExt(file, 'avif')),
-				overwrite: values.overwrite
-			})
+	for (const file of await globAll(positionals))
+		await toAvif({
+			file,
+			outFile: join(values['output-dir'], replaceExt(file, 'avif')),
+			overwrite: values.overwrite
+		})
 }
 
 async function toAvif({ file, outFile, overwrite }) {
 	const stImg = lstat(file)
 	const stAvif = lstat(outFile)
-	
+
 	if (!overwrite && stAvif?.isFile()) {
 		console.log('(skipped: output file exists but --overwrite=false)', file)
 		return

package/src/cli.js

@@ -28,7 +28,7 @@ const COMMANDS = {
 	
 	curltime: ['curltime.sh', 'Measures request response timings'],
 	gif: ['gif.sh', 'Video to GIF'],
-	flattendir: ['flattendir.py', 'Moves all files to top dir and deletes dirs']
+	flattendir: ['flattendir.sh', 'Moves all files to top dir and deletes dirs']
 }
 
 const USAGE = `

package/src/dropdups.js

@@ -1,10 +1,9 @@
 #!/usr/bin/env node
 
-import { spawn } from 'node:child_process'
 import { parseArgs } from 'node:util'
 import { resolve, parse, format } from 'node:path'
 
-import { glob } from './utils/fs-utils.js'
+import { globAll } from './utils/fs-utils.js'
 import { ffmpeg, assertUserHasFFmpeg, run } from './utils/ffmpeg.js'
 
 
@@ -34,6 +33,8 @@ Options:
 
 
 async function main() {
+	await assertUserHasFFmpeg()
+	
 	const { values, positionals } = parseArgs({
 		options: {
 			'bad-frame-number': { short: 'n', type: 'string', default: '' },
@@ -54,12 +55,9 @@ async function main() {
 	if (nBadFrame && /^\d+$/.test(nBadFrame))
 		throw new Error('Invalid --bad-frame-number. It must be a positive integer.')
 
-	await assertUserHasFFmpeg()
-
 	console.log('Dropping Duplicate Frames…')
-	for (const g of positionals)
-		for (const file of await glob(g))
-			await drop(resolve(file), nBadFrame)
+	for (const file of await globAll(positionals))
+		await drop(resolve(file), nBadFrame)
 }
 
 async function drop(video, nBadFrame) {

package/src/flattendir.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# Moves unique files to the top dir and deletes empty dirs
+# Usage: mediasnacks flattendir [folder]
+# Default: current working directory
+
+DIR="${1:-$(pwd)}"
+
+find "$DIR" -mindepth 2 -type f | while IFS= read -r file; do
+  dest="$DIR/$(basename "$file")"
+  if [ ! -e "$dest" ]; then
+    mv "$file" "$dest"
+  fi
+done
+
+find "$DIR" -type f -name '.DS_Store' -delete
+find "$DIR" -depth -type d -empty ! -path "$DIR" -delete

package/src/hev1tohvc1.js

@@ -1,9 +1,8 @@
 #!/usr/bin/env node
 
 import { parseArgs } from 'node:util'
-import { unlink, rename } from 'node:fs/promises'
 
-import { glob, uniqueFilenameFor } from './utils/fs-utils.js'
+import { uniqueFilenameFor, overwrite, globAll } from './utils/fs-utils.js'
 import { videoAttrs, ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
 
 
@@ -17,21 +16,19 @@ by changing the container’s sample entry code from HEV1 to HVC1.
 
 
 async function main() {
-	const { positionals } = parseArgs({ allowPositionals: true })
+	await assertUserHasFFmpeg()
 
+	const { positionals } = parseArgs({ allowPositionals: true })
 	if (!positionals.length)
 		throw new Error(USAGE)
 
-	await assertUserHasFFmpeg()
-
 	console.log('HEV1 to HVC1…')
-	for (const g of positionals)
-		for (const file of await glob(g))
-			await toHvc1(file)
+	for (const file of await globAll(positionals))
+		await toHvc1(file)
 }
 
 async function toHvc1(file) {
-	const v = await videoAttrs(file, 'codec_tag_string')
+	const v = await videoAttrs(file)
 	if (v.codec_tag_string !== 'hev1') {
 		console.log('(skipped: non hev1)', file)
 		return
@@ -45,8 +42,7 @@ async function toHvc1(file) {
 		'-tag:v', 'hvc1',
 		tmp
 	])
-	await unlink(file)
-	await rename(tmp, file)
+	await overwrite(tmp, file)
 }
 
 

package/src/moov2front.js

@@ -1,10 +1,9 @@
 #!/usr/bin/env node
 
 import { parseArgs } from 'node:util'
-import { unlink, rename } from 'node:fs/promises'
 
-import { glob, uniqueFilenameFor } from './utils/fs-utils.js'
 import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+import { uniqueFilenameFor, overwrite, globAll } from './utils/fs-utils.js'
 
 
 const USAGE = `
@@ -16,20 +15,17 @@ Files are overwritten.
 `.trim()
 
 async function main() {
-	const { positionals } = parseArgs({ allowPositionals: true })
+	await assertUserHasFFmpeg()
 
+	const { positionals } = parseArgs({ allowPositionals: true })
 	if (!positionals.length)
 		throw new Error(USAGE)
 
-	await assertUserHasFFmpeg()
 	console.log('Optimizing video for progressive download…')
-
-	for (const g of positionals)
-		for (const file of await glob(g))
-			await moov2front(file)
+	for (const file of await globAll(positionals))
+		await moov2front(file)
 }
 
-
 async function moov2front(file) {
 	if (!/\.(mp4|mov)$/i.test(file)) {
 		console.log('(skipped: not mp4/mov)', file)
@@ -48,8 +44,7 @@ async function moov2front(file) {
 		'-movflags', '+faststart',
 		tmp
 	])
-	await unlink(file)
-	await rename(tmp, file)
+	await overwrite(tmp, file)
 }
 
 async function moovIsBeforeMdat(file) {

package/src/resize.js

@@ -4,7 +4,7 @@ import { join } from 'node:path'
 import { rename } from 'node:fs/promises'
 import { parseArgs } from 'node:util'
 
-import { glob, isFile, uniqueFilenameFor } from './utils/fs-utils.js'
+import { isFile, uniqueFilenameFor, globAll } from './utils/fs-utils.js'
 import { ffmpeg, videoAttrs, assertUserHasFFmpeg } from './utils/ffmpeg.js'
 
 
@@ -28,6 +28,8 @@ Details:
 
 
 async function main() {
+	await assertUserHasFFmpeg()
+
 	const { values, positionals } = parseArgs({
 		options: {
 			width: { type: 'string', default: '-2' },
@@ -53,23 +55,21 @@ async function main() {
 	if (!positionals.length)
 		throw new Error('No video files specified')
 
-	await assertUserHasFFmpeg()
 
 	console.log('Resizing…')
-	for (const g of positionals)
-		for (const file of await glob(g))
-			await resize({
-				file,
-				outFile: join(values['output-dir'], file),
-				overwrite: values.overwrite,
-				width,
-				height,
-			})
+	for (const file of await globAll(positionals))
+		await resize({
+			file,
+			outFile: join(values['output-dir'], file),
+			overwrite: values.overwrite,
+			width,
+			height,
+		})
 }
 
 
 async function resize({ file, outFile, overwrite, width, height }) {
-	const v = await videoAttrs(file, 'width', 'height')
+	const v = await videoAttrs(file)
 	if (width === v.width && height === v.height
 		|| width < 0 && height === v.height
 		|| height < 0 && width === v.width) {

package/src/utils/ffmpeg.js

@@ -15,17 +15,6 @@ export async function assertUserHasFFmpeg() {
 	}
 }
 
-export async function videoAttrs(v, ...props) {
-	const { stdout } = await runSilently('ffprobe', [
-		'-v', 'error',
-		'-select_streams', 'v:0',
-		'-show_entries', `stream=${props.join(',')}`,
-		'-of', 'json',
-		v
-	])
-	return JSON.parse(stdout).streams[0]
-}
-
 
 async function runSilently(program, args) {
 	return new Promise((resolve, reject) => {
@@ -66,3 +55,94 @@ export async function run(program, args) {
 }
 
 
+/**
+ * Describes disposition flags that define how the video stream should be treated
+ * by players or downstream consumers.
+ * @typedef {Object} VideoStreamDisposition
+ * @prop {number} default Is whether this stream is the default selection.
+ * @prop {number} dub is dubbed?
+ * @prop {number} original is original?
+ * @prop {number} comment contains commentary?
+ * @prop {number} lyrics has lyrics?
+ * @prop {number} karaoke is karaoke?
+ * @prop {number} forced must always be rendered?
+ * @prop {number} hearing_impaired targets hearing-impaired audiences?
+ * @prop {number} visual_impaired targets visually-impaired audiences?
+ * @prop {number} clean_effects removes certain effects or noise?
+ * @prop {number} attached_pic represents embedded artwork?
+ * @prop {number} timed_thumbnails timed thumbnail data?
+ * @prop {number} non_diegetic non-diegetic content?
+ * @prop {number} captions has captions?
+ * @prop {number} descriptions has audio descriptions?
+ * @prop {number} metadata has supplemental metadata?
+ * @prop {number} dependent depends on another stream?
+ * @prop {number} still_image still-image video content?
+ * @prop {number} multilayer multilayer stream content?
+ */
+
+/**
+ * Describes metadata tags associated with a video stream.
+ * @typedef {Object} VideoStreamTags
+ * @prop {string} language stream language.
+ * @prop {string} handler_name handler or track label.
+ * @prop {string} vendor_id vendor for the encoder or container.
+ */
+
+/**
+ * Full set of attributes returned by ffprobe for a single video stream.
+ * @typedef {Object} VideoStream
+ * @prop {number} index Numerical index of the stream within the container.
+ * @prop {string} codec_name Short codec identifier used by FFmpeg.
+ * @prop {string} codec_long_name Descriptive codec name.
+ * @prop {string} profile Codec profile used during encoding.
+ * @prop {string} codec_type The media type, typically "video".
+ * @prop {string} codec_tag_string Codec tag string declared in the container.
+ * @prop {string} codec_tag Numeric codec tag in hexadecimal form.
+ * @prop {number} width Video width in pixels.
+ * @prop {number} height Video height in pixels.
+ * @prop {number} coded_width Internal coded width, which may differ from output width.
+ * @prop {number} coded_height Internal coded height.
+ * @prop {number} has_b_frames Number of B-frames used by the encoder.
+ * @prop {string} sample_aspect_ratio Pixel aspect ratio declared in the stream.
+ * @prop {string} display_aspect_ratio Display aspect ratio after scaling.
+ * @prop {string} pix_fmt Pixel format used by the video stream.
+ * @prop {number} level Codec level used during encoding.
+ * @prop {string} chroma_location The chroma sample position pattern.
+ * @prop {string} field_order Field order (progressive, top-field-first, etc.).
+ * @prop {number} refs Number of reference frames used by the encoder.
+ * @prop {string} is_avc Indicates whether the stream uses AVC-style NAL units.
+ * @prop {string} nal_length_size Length of NAL unit size prefixes.
+ * @prop {string} id Stream identifier within the container.
+ * @prop {string} r_frame_rate Raw frame rate reported by the demuxer.
+ * @prop {string} avg_frame_rate Average frame rate.
+ * @prop {string} time_base The fundamental time base of the stream.
+ * @prop {number} start_pts Presentation timestamp where the stream begins.
+ * @prop {string} start_time Wall-clock start time in seconds.
+ * @prop {number} duration_ts Duration expressed in time-base units.
+ * @prop {string} duration Stream duration in seconds.
+ * @prop {string} bit_rate Declared bit rate of the video stream.
+ * @prop {string} bits_per_raw_sample Bit depth of the raw samples.
+ * @prop {string} nb_frames Number of frames according to the container.
+ * @prop {number} extradata_size Size of the extra codec data.
+ * @prop {VideoStreamDisposition} disposition Disposition flags describing playback intent.
+ * @prop {VideoStreamTags} tags Metadata tags for the stream.
+ */
+
+/**
+ * Extracts full metadata for the primary video stream (v:0) using ffprobe.
+ * @param {string} video Path to the video file.
+ * @returns {Promise<VideoStream>} All video stream attributes.
+ */
+export async function videoAttrs(v) {
+	const { stdout } = await runSilently('ffprobe', [
+		'-v', 'error',
+		'-select_streams', 'v:0',
+		'-show_entries', 'stream',
+		'-of', 'json',
+		v
+	])
+	return JSON.parse(stdout).streams[0]
+}
+
+
+

package/src/utils/fs-utils.js

@@ -1,10 +1,19 @@
 import { promisify } from 'node:util'
 import { randomUUID } from 'node:crypto'
+import { unlink, rename } from 'node:fs/promises'
 import { dirname, extname, join } from 'node:path'
 import { lstatSync, glob as _glob } from 'node:fs'
 
 
-export const glob = promisify(_glob)
+const glob = promisify(_glob)
+
+export async function globAll(arr) {
+	const set = new Set()
+	for (const g of arr)
+		for (const file of await glob(g))
+			set.add(file)
+	return Array.from(set)
+}
 
 export const lstat = f => lstatSync(f, { throwIfNoEntry: false })
 export const isFile = path => lstat(path)?.isFile()
@@ -19,3 +28,9 @@ export const replaceExt = (f, ext) => {
 
 export const uniqueFilenameFor = file => 
 	join(dirname(file), randomUUID() + extname(file))
+
+
+export async function overwrite(src, target) {
+	await unlink(target)
+	await rename(src, target)
+}

package/src/flattendir.py

@@ -1,23 +0,0 @@
-#!/usr/bin/env python3
-
-import shutil
-from pathlib import Path
-
-
-def flatten_dir(folder=Path().cwd()):
-  """Moves all files to top dir and deletes dirs"""
-
-  for path in folder.rglob('*'):
-    if path.is_file():
-      dest = folder / path.name
-      if dest.exists():
-        dest = folder / f'{path.stem}__{path.stat().st_mtime_ns}{path.suffix}'
-      shutil.move(str(path), str(dest))
-
-  for sub in sorted(folder.rglob('*'), reverse=True):
-    if sub.is_dir() and not any(sub.iterdir()):
-      sub.rmdir()
-
-
-if __name__ == '__main__':
-  flatten_dir()