mediasnacks 0.17.0 → 0.18.1

package/.zsh/completions/_mediasnacks

@@ -45,9 +45,3 @@ case "$cmd" in
 		_files -/
 		;;
 esac
-
-
-# INSTALL in: ~/.zshrc
-#fpath=(~/.zsh/completions $fpath)
-#zmodload zsh/complist
-#autoload -U compinit && compinit

package/README.md

@@ -1,15 +1,22 @@
 # mediasnacks
 
-Utilities optimizing and preparing video and images for the web.
+Utilities video and images.
 
 
-## Overview
+### Install
 **FFmpeg and Node.js must be installed.**
 
 ```shell
-npx mediasnacks <command> <args>
+npm install -g mediasnacks --ignore-scripts=true
 ```
 
+
+## Overview
+```shell
+mediasnacks <command> <args>
+```
+
+
 ### Commands
 - `avif` Converts images to AVIF
 - `sqcrop` Square crops images

package/install-zsh-completions.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+set -eu
+
+# Exit on systems without ZSH
+zsh=$(command -v zsh) || exit 0
+
+# Exit on non-global (npm -g) installations
+[ "${npm_config_global:-}" = "true" ] || 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mediasnacks",
-  "version": "0.17.0",
-  "description": "Utilities for optimizing and preparing videos and images for the web",
+  "version": "0.18.1",
+  "description": "Utilities for optimizing and preparing videos and images",
   "license": "MIT",
   "author": "Eric Fortis",
   "type": "module",
@@ -9,6 +9,12 @@
 		"mediasnacks": "src/cli.js"
 	},
 	"scripts": {
-		"test": "docker run --rm $(docker build -q .)"
-	}
+		"test": "docker run --rm $(docker build -q .)",
+		"postinstall": "sh install-zsh-completions.sh"
+	},
+	"files": [
+		"src",
+		".zsh",
+		"install-zsh-completions.sh"
+	]
 }

package/src/cli.js

@@ -21,7 +21,7 @@ const COMMANDS = {
 	vconcat: ['vconcat.sh', 'Concatenates videos'],
 	vdiff: ['vdiff.sh', 'Plays a video with the difference of two videos'],
 	vsplit: ['vsplit.js', 'Splits a video into multiple clips from CSV timestamps'],
-	vtrim: ['vtrim.sh', 'Trims video from start to end time'],
+	vtrim: ['vtrim.js', 'Trims video from start to end time'],
 	prores: ['prores.js', 'Converts video to ProRes\n'],
 
 	flattendir: ['flattendir.sh', 'Moves all files to top dir and deletes dirs'],

package/src/prores.js

@@ -23,8 +23,8 @@ Arguments:
   <video>  Video file to convert
 
 Options:
-  --profile <n>  ProRes profile (default: 3 (HQ))
-  -h, --help      Show this help message
+  -p, --profile <n>  ProRes profile (default: 3 (422 HQ))
+  -h, --help         Show this help message
 
 Example:
   npx mediasnacks prores video.mov
@@ -51,6 +51,7 @@ async function main() {
 		throw new Error('Expected 1 argument: video file. See npx mediasnacks prores --help')
 
 	const videoPath = resolve(files[0])
+
 	const { name, dir } = parse(videoPath)
 	const outputPath = join(dir, `${name}.prores.mov`)
 

package/src/vtrim.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+
+import { resolve, parse } from 'node:path'
+import { parseOptions } from './utils/parseOptions.js'
+import { ffmpeg, assertUserHasFFmpeg } from './utils/ffmpeg.js'
+
+
+const USAGE = `
+Usage: mediasnacks vtrim [--start <time>] [--end <time>] <video>
+
+Trims a video without re-encoding (fast, but approximate cuts).
+
+Options:
+  -s, --start <time>   Start time (e.g. 10, 00:00:10, 1:23.5). Default: beginning.
+  -e, --end <time>     End time (e.g. 30, 00:00:30, 2:45.0). Default: end of video.
+  -h, --help
+`.trim()
+
+
+async function main() {
+	await assertUserHasFFmpeg()
+
+	const { values, files } = await parseOptions({
+		start: { short: 's', type: 'string', default: '' },
+		end: { short: 'e', type: 'string', default: '' },
+		help: { short: 'h', type: 'boolean' }
+	})
+
+	if (values.help) {
+		console.log(USAGE)
+		process.exit(0)
+	}
+
+	if (!files.length)
+		throw new Error('No video specified. See npx mediasnacks vtrim --help')
+
+	for (const file of files)
+		await trim(resolve(file), values.start, values.end)
+}
+
+async function trim(video, start, end) {
+	const { dir, name, ext } = parse(video)
+	await ffmpeg([
+		'-v', 'error',
+		'-y',
+		start ? ['-ss', start] : [],
+		end ? ['-to', end] : [],
+		'-i', video,
+		'-c', 'copy',
+		resolve(dir, `${name}.trim${ext}`)
+	].flat())
+}
+
+main().catch(err => {
+	console.error(err.message || err)
+	process.exit(1)
+})

package/src/vtrim.test.js

@@ -1,7 +1,7 @@
 import { ok } from 'node:assert/strict'
 import { join } from 'node:path'
-import { test } from 'node:test'
 import { cpSync } from 'node:fs'
+import { describe, test } from 'node:test'
 
 import { videoAttrs } from './utils/ffmpeg.js'
 import { mkTempDir, cli } from './utils/test-utils.js'
@@ -9,14 +9,32 @@ import { mkTempDir, cli } from './utils/test-utils.js'
 const rel = f => join(import.meta.dirname, f)
 
 
-test('vtrim trims video from start to end time', async () => {
-	const tmp = mkTempDir('vtrim')
+describe('vtrim', () => {
+	function almostEqual(actual, expected) {
+		const EPSILON = 0.05
+		ok(Math.abs(parseFloat(actual) - expected) < EPSILON,
+			`Duration should be around ${expected}s, got ${actual}s`)
+	}
 
+	const tmp = mkTempDir('vtrim')
 	const inputFile = join(tmp, '60fps.mp4')
 	cpSync(rel('fixtures/60fps.mp4'), inputFile)
-	cli('vtrim', 5, 10, inputFile)
 
-	const { duration } = await videoAttrs(join(tmp, '60fps.trim.mp4'))
-	const EPSILON = 0.05
-	ok(Math.abs(parseFloat(duration) - 5) < EPSILON, `Duration should be 5s, got ${duration}s`)
+	test('from start to end time', async () => {
+		cli('vtrim', '--start', 5, '--end', 11, inputFile)
+		const { duration } = await videoAttrs(join(tmp, '60fps.trim.mp4'))
+		almostEqual(duration, 6)
+	})
+
+	test('start time only', async () => {
+		cli('vtrim', '--start', 5, inputFile)
+		const { duration } = await videoAttrs(join(tmp, '60fps.trim.mp4'))
+		almostEqual(duration, 25)
+	})
+
+	test('end time only', async () => {
+		cli('vtrim', '--end', 11, inputFile)
+		const { duration } = await videoAttrs(join(tmp, '60fps.trim.mp4'))
+		almostEqual(duration, 11)
+	})
 })

package/.editorconfig

@@ -1,11 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = tab
-insert_final_newline = true
-
-[*.md]
-indent_style = space

package/.github/workflows/test.yml

@@ -1,25 +0,0 @@
-name: Test
-
-on: [ push, pull_request, workflow_dispatch ]
-
-permissions:
-  contents: read
-  pull-requests: write
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v6
-      - uses: docker/setup-buildx-action@v4
-      - uses: docker/build-push-action@v7
-        with:
-          context: .
-          load: true
-          tags: app-test
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-
-      - name: Tests
-        run: docker run --rm app-test

package/Dockerfile

@@ -1,13 +0,0 @@
-FROM mwader/static-ffmpeg:8.0.1 AS ffmpeg
-FROM node:24-bookworm-slim
-
-COPY --from=ffmpeg /ffmpeg /usr/local/bin/ffmpeg
-COPY --from=ffmpeg /ffprobe /usr/local/bin/ffprobe
-
-ENV FORCE_COLOR=1
-WORKDIR /workspace
-
-COPY src/ src/
-COPY package.json .
-
-CMD ["node", "--test"]

package/TODO.md

@@ -1,7 +0,0 @@
-# TODO
-
-- Test on Windows
-- Test on Linux
-
-
-Handle when shell expands, but files have special chars

package/generate-fixtures.sh

@@ -1,11 +0,0 @@
-#!/bin/sh
-
-docker run --rm \
-  -v "$(pwd)/src/fixtures:/workspace/src/fixtures" \
-  $(docker build -q .) \
-  /bin/bash -c "
-node --test 
-cp /tmp/avif*/lenna.avif /workspace/src/fixtures/ 
-cp /tmp/edgespic*/edgespic/*.png /workspace/src/fixtures/edgespic/
-"
-

package/src/vtrim.sh

@@ -1,36 +0,0 @@
-#!/bin/sh
-
-if [ "$#" -ne 3 ]; then
-	cat << EOF
-Usage:
-    $(basename $0) <start-time> <end-time> <video-file>
-
-Examples:
-    $(basename $0) 10 30 input.mp4
-    $(basename $0) 00:00:10 00:00:30 input.mkv
-    $(basename $0) 1:23.5 2:45.0 video.mov
-EOF
-	exit 1
-fi
-
-START="$1"
-END="$2"
-VIDEO="$3"
-
-if [ ! -f "$VIDEO" ]; then
-	echo "Error: file not found: $VIDEO"
-	exit 1
-fi
-
-BASENAME=$(basename "$VIDEO")
-DIRNAME=$(dirname "$VIDEO")
-EXT="${BASENAME##*.}"
-NAME="${BASENAME%.*}"
-
-# For speed, we copy without re-encoding (with -ss before -i), but 
-# that means that the output isn’t going to be exact
-ffmpeg -v error -y \
-  -ss "$START" \
-	-to "$END" \
-  -i "$VIDEO" \
-	-c copy "$DIRNAME/${NAME}.trim.$EXT"