multiplane 0.3.3 → 0.3.7

package/src/format.mjs

@@ -1,27 +1,27 @@
-import path from 'node:path';
-import { MultiplaneError, invalidOption } from './errors.mjs';
-import { encoderArgs } from './encoder.mjs';
-
-export function resolveFormat(options = {}) {
-  const extension = path.extname(options.out ?? '').slice(1).toLowerCase();
-  const formats = ['mp4', 'webm', 'mov'];
-  const format = options.format ?? (formats.includes(extension) ? extension : 'mp4');
-  if (!formats.includes(format)) throw invalidOption('--format', '--format must be mp4, webm or mov.');
-  // TODO(design): Document rejection of unknown output extensions as well as conflicts.
-  if (extension && extension !== format) throw invalidOption('--out', '--out extension must match --format.');
-  if (format !== 'mp4' && options.encoder !== undefined) throw invalidOption('--encoder', '--encoder only applies to mp4; omit it for webm or mov.');
-  // TODO(design): Define bitrate controls for the fixed-codec formats if needed.
-  if (format !== 'mp4' && options['max-bitrate'] !== undefined) throw invalidOption('--max-bitrate', '--max-bitrate currently only applies to mp4.');
-  if (format === 'mp4' && options.alpha) throw new MultiplaneError('invalid_option', 'MP4 does not support alpha.', { details: { option: '--alpha' }, hint: 'Use --format webm or --format mov and a matching --out extension.' });
-  return format;
-}
-
-export function videoEncoding(options) {
-  const { format, alpha } = options;
-  if (format === 'webm') {
-    // TODO(design): Document the fixed VP9 quality preset and audio codec.
-    return { encoder: 'libvpx-vp9', args: ['-c:v', 'libvpx-vp9', '-crf', alpha ? '0' : '16', '-b:v', '0', '-auto-alt-ref', '0', ...(alpha ? ['-lossless', '1'] : [])], pixelFormat: alpha ? 'yuva420p' : 'yuv420p', mux: [], audio: ['-c:a', 'libopus', '-b:a', '320k', '-ac', '2'] };
-  }
-  if (format === 'mov') return { encoder: 'prores_ks', args: ['-c:v', 'prores_ks', '-profile:v', '4'], pixelFormat: alpha ? 'yuva444p10le' : 'yuv444p10le', mux: ['-movflags', '+faststart'], audio: ['-c:a', 'aac', '-b:a', '320k', '-ac', '2'] };
-  return { encoder: options.encoder ?? 'x264', args: encoderArgs(options.encoder ?? 'x264', undefined, options['max-bitrate']), pixelFormat: 'yuv420p', mux: ['-movflags', '+faststart'], audio: ['-c:a', 'aac', '-b:a', '320k', '-ac', '2'] };
-}
+import path from 'node:path';
+import { MultiplaneError, invalidOption } from './errors.mjs';
+import { encoderArgs } from './encoder.mjs';
+
+export function resolveFormat(options = {}) {
+  const extension = path.extname(options.out ?? '').slice(1).toLowerCase();
+  const formats = ['mp4', 'webm', 'mov'];
+  const format = options.format ?? (formats.includes(extension) ? extension : 'mp4');
+  if (!formats.includes(format)) throw invalidOption('--format', '--format must be mp4, webm or mov.');
+  // TODO(design): Document rejection of unknown output extensions as well as conflicts.
+  if (extension && extension !== format) throw invalidOption('--out', '--out extension must match --format.');
+  if (format !== 'mp4' && options.encoder !== undefined) throw invalidOption('--encoder', '--encoder only applies to mp4; omit it for webm or mov.');
+  // TODO(design): Define bitrate controls for the fixed-codec formats if needed.
+  if (format !== 'mp4' && options['max-bitrate'] !== undefined) throw invalidOption('--max-bitrate', '--max-bitrate currently only applies to mp4.');
+  if (format === 'mp4' && options.alpha) throw new MultiplaneError('invalid_option', 'MP4 does not support alpha.', { details: { option: '--alpha' }, hint: 'Use --format webm or --format mov and a matching --out extension.' });
+  return format;
+}
+
+export function videoEncoding(options) {
+  const { format, alpha } = options;
+  if (format === 'webm') {
+    // TODO(design): Document the fixed VP9 quality preset and audio codec.
+    return { encoder: 'libvpx-vp9', args: ['-c:v', 'libvpx-vp9', '-crf', alpha ? '0' : '16', '-b:v', '0', '-auto-alt-ref', '0', ...(alpha ? ['-lossless', '1'] : [])], pixelFormat: alpha ? 'yuva420p' : 'yuv420p', mux: [], audio: ['-c:a', 'libopus', '-b:a', '320k', '-ac', '2'] };
+  }
+  if (format === 'mov') return { encoder: 'prores_ks', args: ['-c:v', 'prores_ks', '-profile:v', '4'], pixelFormat: alpha ? 'yuva444p10le' : 'yuv444p10le', mux: ['-movflags', '+faststart'], audio: ['-c:a', 'aac', '-b:a', '320k', '-ac', '2'] };
+  return { encoder: options.encoder ?? 'x264', args: encoderArgs(options.encoder ?? 'x264', undefined, options['max-bitrate']), pixelFormat: 'yuv420p', mux: ['-movflags', '+faststart'], audio: ['-c:a', 'aac', '-b:a', '320k', '-ac', '2'] };
+}

package/src/frame-rate.mjs

@@ -1,28 +1,28 @@
-import { invalidOption } from './errors.mjs';
-
-// Encoding time only: capture and post-processing must keep the requested fps.
-// Snap NTSC shorthand within 0.0001 fps of n * 1000 / 1001. Otherwise round
-// to six decimal places (at most 0.0000005 fps error) and reduce the fraction.
-// FFmpeg's AVRational stores both terms as signed 32-bit integers.
-export function frameRate(fps) {
-  if (!Number.isFinite(fps) || fps <= 0) throw invalidOption('--fps', '--fps must be positive and finite.');
-  const nominal = Math.round(fps * 1001 / 1000);
-  let numerator, denominator;
-  if (nominal > 0 && Math.abs(fps - nominal * 1000 / 1001) <= 0.0001) {
-    numerator = nominal * 1000;
-    denominator = 1001;
-  } else {
-    numerator = Math.round(fps * 1e6);
-    denominator = 1e6;
-  }
-  if (!Number.isSafeInteger(numerator) || numerator <= 0) throw invalidOption('--fps', 'Frame rate cannot be represented at micro-fps precision.');
-  let a = numerator, b = denominator;
-  while (b) [a, b] = [b, a % b];
-  numerator /= a; denominator /= a;
-  if (numerator > 2147483647) throw invalidOption('--fps', 'Frame rate exceeds FFmpeg rational precision.');
-  return {
-    numerator, denominator, argument: `${numerator}/${denominator}`,
-    fps: numerator / denominator,
-    seconds: frames => frames * denominator / numerator,
-  };
-}
+import { invalidOption } from './errors.mjs';
+
+// Encoding time only: capture and post-processing must keep the requested fps.
+// Snap NTSC shorthand within 0.0001 fps of n * 1000 / 1001. Otherwise round
+// to six decimal places (at most 0.0000005 fps error) and reduce the fraction.
+// FFmpeg's AVRational stores both terms as signed 32-bit integers.
+export function frameRate(fps) {
+  if (!Number.isFinite(fps) || fps <= 0) throw invalidOption('--fps', '--fps must be positive and finite.');
+  const nominal = Math.round(fps * 1001 / 1000);
+  let numerator, denominator;
+  if (nominal > 0 && Math.abs(fps - nominal * 1000 / 1001) <= 0.0001) {
+    numerator = nominal * 1000;
+    denominator = 1001;
+  } else {
+    numerator = Math.round(fps * 1e6);
+    denominator = 1e6;
+  }
+  if (!Number.isSafeInteger(numerator) || numerator <= 0) throw invalidOption('--fps', 'Frame rate cannot be represented at micro-fps precision.');
+  let a = numerator, b = denominator;
+  while (b) [a, b] = [b, a % b];
+  numerator /= a; denominator /= a;
+  if (numerator > 2147483647) throw invalidOption('--fps', 'Frame rate exceeds FFmpeg rational precision.');
+  return {
+    numerator, denominator, argument: `${numerator}/${denominator}`,
+    fps: numerator / denominator,
+    seconds: frames => frames * denominator / numerator,
+  };
+}

package/src/home-migration.mjs

@@ -1,54 +1,54 @@
-import path from 'node:path';
-import os from 'node:os';
-import { randomUUID } from 'node:crypto';
-import { lstatSync, mkdirSync, openSync, closeSync, copyFileSync, renameSync, unlinkSync } from 'node:fs';
-import { userHome } from './platform.mjs';
-
-const present = file => {
-  try { lstatSync(file); return true; }
-  catch (error) { if (error.code === 'ENOENT') return false; throw error; }
-};
-
-// Use the writers' locks, including the config lock introduced in 038.
-// Publish only complete copies, and recheck the destination under the lock.
-export function migrateUserHome(env = process.env, platform = process.platform, home = os.homedir()) {
-  const result = { migrated: [], warnings: [] };
-  if (platform !== 'win32' || env.MULTIPLANE_HOME) return result;
-  const directory = userHome(env, platform, home);
-  const previous = path.win32.join(env.APPDATA || path.win32.join(env.USERPROFILE || home, 'AppData', 'Roaming'), 'multiplane');
-  if (path.win32.resolve(previous).toLowerCase() === path.win32.resolve(directory).toLowerCase()) return result;
-  for (const [lockName, names] of [['config.json.lock', ['config.json']], ['jobs.lock', ['jobs.jsonl', 'jobs.1.jsonl']]]) {
-    let handle;
-    const lock = path.join(directory, lockName);
-    try {
-      if (!names.some(name => !present(path.join(directory, name)) && present(path.join(previous, name)))) continue;
-      mkdirSync(directory, { recursive: true });
-      const deadline = performance.now() + 10000;
-      for (;;) {
-        try { handle = openSync(lock, 'wx'); break; }
-        catch (error) {
-          if (error.code !== 'EEXIST' || performance.now() >= deadline) throw error;
-          Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, 25);
-        }
-      }
-      for (const name of names) {
-        const target = path.join(directory, name), source = path.join(previous, name);
-        if (present(target) || !present(source)) continue;
-        const temporary = target + '.' + randomUUID() + '.tmp';
-        try {
-          copyFileSync(source, temporary);
-          renameSync(temporary, target);
-          result.migrated.push({ name, source });
-        } finally { try { unlinkSync(temporary); } catch (error) { if (error.code !== 'ENOENT') throw error; } }
-      }
-    } catch {
-      result.warnings.push({ code: 'home_unavailable', message: 'User directory migration could not be completed.' });
-    } finally {
-      if (handle !== undefined) {
-        closeSync(handle);
-        try { unlinkSync(lock); } catch { result.warnings.push({ code: 'home_unavailable', message: 'User directory migration lock could not be removed.' }); }
-      }
-    }
-  }
-  return result;
-}
+import path from 'node:path';
+import os from 'node:os';
+import { randomUUID } from 'node:crypto';
+import { lstatSync, mkdirSync, openSync, closeSync, copyFileSync, renameSync, unlinkSync } from 'node:fs';
+import { userHome } from './platform.mjs';
+
+const present = file => {
+  try { lstatSync(file); return true; }
+  catch (error) { if (error.code === 'ENOENT') return false; throw error; }
+};
+
+// Use the writers' locks, including the config lock introduced in 038.
+// Publish only complete copies, and recheck the destination under the lock.
+export function migrateUserHome(env = process.env, platform = process.platform, home = os.homedir()) {
+  const result = { migrated: [], warnings: [] };
+  if (platform !== 'win32' || env.MULTIPLANE_HOME) return result;
+  const directory = userHome(env, platform, home);
+  const previous = path.win32.join(env.APPDATA || path.win32.join(env.USERPROFILE || home, 'AppData', 'Roaming'), 'multiplane');
+  if (path.win32.resolve(previous).toLowerCase() === path.win32.resolve(directory).toLowerCase()) return result;
+  for (const [lockName, names] of [['config.json.lock', ['config.json']], ['jobs.lock', ['jobs.jsonl', 'jobs.1.jsonl']]]) {
+    let handle;
+    const lock = path.join(directory, lockName);
+    try {
+      if (!names.some(name => !present(path.join(directory, name)) && present(path.join(previous, name)))) continue;
+      mkdirSync(directory, { recursive: true });
+      const deadline = performance.now() + 10000;
+      for (;;) {
+        try { handle = openSync(lock, 'wx'); break; }
+        catch (error) {
+          if (error.code !== 'EEXIST' || performance.now() >= deadline) throw error;
+          Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, 25);
+        }
+      }
+      for (const name of names) {
+        const target = path.join(directory, name), source = path.join(previous, name);
+        if (present(target) || !present(source)) continue;
+        const temporary = target + '.' + randomUUID() + '.tmp';
+        try {
+          copyFileSync(source, temporary);
+          renameSync(temporary, target);
+          result.migrated.push({ name, source });
+        } finally { try { unlinkSync(temporary); } catch (error) { if (error.code !== 'ENOENT') throw error; } }
+      }
+    } catch {
+      result.warnings.push({ code: 'home_unavailable', message: 'User directory migration could not be completed.' });
+    } finally {
+      if (handle !== undefined) {
+        closeSync(handle);
+        try { unlinkSync(lock); } catch { result.warnings.push({ code: 'home_unavailable', message: 'User directory migration lock could not be removed.' }); }
+      }
+    }
+  }
+  return result;
+}

package/src/hosted.mjs

@@ -28,7 +28,7 @@ export async function hostedAvailable(command, options, env = process.env) {
 }
 
 export function hostedEnvironment(env) {
-  const allowed = /^(PATH|MULTIPLANE_.*|HTTPS?_PROXY|ALL_PROXY|NO_PROXY|TEMP|TMP|TMPDIR|HOME|USERPROFILE|APPDATA|LOCALAPPDATA|SystemRoot|ComSpec|PATHEXT|LANG|LC_.*)$/i;
+  const allowed = /^(PATH|MULTIPLANE_.*|ELECTRON_RUN_AS_NODE|HTTPS?_PROXY|ALL_PROXY|NO_PROXY|TEMP|TMP|TMPDIR|HOME|USERPROFILE|APPDATA|LOCALAPPDATA|SystemRoot|ComSpec|PATHEXT|LANG|LC_.*)$/i;
   const secret = /TOKEN|SECRET|PASSWORD|PASSWD|CREDENTIAL|AUTH|BEARER|COOKIE|SESSION|API_?KEY|PRIVATE_?KEY|ACCESS_?KEY/i;
   return Object.fromEntries(Object.entries(env).filter(([key, value]) => {
     if (value === undefined || !allowed.test(key) || secret.test(key)) return false;