reelme 0.2.1 → 0.3.0

package/assets/audio/PROVENANCE.md

@@ -0,0 +1,16 @@
+# ReelMe Bundled Audio Provenance
+
+The bundled tracks in this directory are instrumental loops generated by
+`generate-tracks.mjs` for ReelMe. They do not sample third-party recordings,
+loops, MIDI files, or stems.
+
+The generated tracks are dedicated to the public domain under CC0 1.0. The
+manifest source URLs point to the generator definition used to create each
+track. Regenerate the MP3 files with:
+
+```bash
+node cli/assets/audio/generate-tracks.mjs
+```
+
+Each track is 32 seconds long, encoded as MP3, and kept below 2 MB for package
+size.

package/assets/audio/generate-tracks.mjs

@@ -0,0 +1,213 @@
+#!/usr/bin/env node
+
+import { rmSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { spawnSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+
+const SAMPLE_RATE = 44100;
+const DURATION = 32;
+const TWO_PI = Math.PI * 2;
+
+const TRACKS = [
+  {
+    id: "calm-keys",
+    file: "calm-keys.mp3",
+    bpm: 92,
+    key: 57,
+    scale: [0, 2, 4, 7, 9],
+    chords: [[0, 4, 7, 11], [9, 0, 4, 7], [5, 9, 0, 4], [7, 11, 2, 5]],
+    melody: [0, 2, 4, 7, 4, 2, 0, 9],
+    mood: "soft",
+  },
+  {
+    id: "steady-launch",
+    file: "steady-launch.mp3",
+    bpm: 104,
+    key: 50,
+    scale: [0, 2, 5, 7, 9],
+    chords: [[0, 5, 9], [7, 0, 5], [9, 2, 5], [5, 9, 0]],
+    melody: [0, 5, 7, 9, 7, 5, 2, 0],
+    mood: "drive",
+  },
+  {
+    id: "clean-horizon",
+    file: "clean-horizon.mp3",
+    bpm: 88,
+    key: 55,
+    scale: [0, 2, 4, 7, 11],
+    chords: [[0, 4, 7], [4, 7, 11], [9, 0, 4], [7, 11, 2]],
+    melody: [7, 4, 2, 0, 2, 4, 7, 11],
+    mood: "soft",
+  },
+  {
+    id: "bright-sparks",
+    file: "bright-sparks.mp3",
+    bpm: 118,
+    key: 60,
+    scale: [0, 2, 4, 7, 9],
+    chords: [[0, 4, 7], [5, 9, 0], [7, 11, 2], [4, 7, 11]],
+    melody: [0, 4, 7, 9, 7, 4, 2, 4],
+    mood: "bounce",
+  },
+  {
+    id: "pixel-bounce",
+    file: "pixel-bounce.mp3",
+    bpm: 126,
+    key: 58,
+    scale: [0, 3, 5, 7, 10],
+    chords: [[0, 3, 7], [10, 3, 5], [5, 8, 0], [7, 10, 2]],
+    melody: [0, 3, 7, 10, 7, 3, 5, 7],
+    mood: "chip",
+  },
+  {
+    id: "sunny-loop",
+    file: "sunny-loop.mp3",
+    bpm: 112,
+    key: 62,
+    scale: [0, 2, 4, 7, 9],
+    chords: [[0, 4, 7], [9, 0, 4], [5, 9, 0], [7, 11, 2]],
+    melody: [4, 7, 9, 12, 9, 7, 4, 2],
+    mood: "bounce",
+  },
+  {
+    id: "circuit-pulse",
+    file: "circuit-pulse.mp3",
+    bpm: 124,
+    key: 45,
+    scale: [0, 2, 3, 7, 10],
+    chords: [[0, 3, 7], [7, 10, 2], [3, 7, 10], [10, 2, 5]],
+    melody: [0, 7, 3, 10, 2, 7, 3, 0],
+    mood: "pulse",
+  },
+  {
+    id: "vector-grid",
+    file: "vector-grid.mp3",
+    bpm: 116,
+    key: 48,
+    scale: [0, 2, 5, 7, 10],
+    chords: [[0, 5, 10], [7, 0, 5], [10, 2, 7], [5, 10, 0]],
+    melody: [0, 2, 5, 7, 10, 7, 5, 2],
+    mood: "pulse",
+  },
+  {
+    id: "midnight-protocol",
+    file: "midnight-protocol.mp3",
+    bpm: 98,
+    key: 47,
+    scale: [0, 2, 3, 7, 9],
+    chords: [[0, 3, 7], [9, 0, 3], [7, 10, 2], [3, 7, 9]],
+    melody: [0, 3, 7, 9, 7, 3, 2, 0],
+    mood: "drive",
+  },
+];
+
+function midiToFreq(note) {
+  return 440 * 2 ** ((note - 69) / 12);
+}
+
+function triangle(phase) {
+  return (2 / Math.PI) * Math.asin(Math.sin(phase));
+}
+
+function env(position, attack, release) {
+  if (position < attack) return position / attack;
+  return Math.exp(-(position - attack) * release);
+}
+
+function renderSample(track, t, i) {
+  const beat = 60 / track.bpm;
+  const bar = beat * 4;
+  const chord = track.chords[Math.floor(t / (bar * 2)) % track.chords.length];
+  const chordPos = (t % (bar * 2)) / (bar * 2);
+  const noteStep = Math.floor(t / (beat / 2)) % track.melody.length;
+  const notePos = (t % (beat / 2)) / (beat / 2);
+  const root = track.key;
+
+  let sample = 0;
+
+  for (let c = 0; c < chord.length; c += 1) {
+    const freq = midiToFreq(root + chord[c]);
+    const wobble = 1 + Math.sin(TWO_PI * t * 0.08 + c) * 0.002;
+    const amp = track.mood === "soft" ? 0.055 : 0.04;
+    sample += Math.sin(TWO_PI * freq * wobble * t) * amp * env(chordPos, 0.08, 1.2);
+    sample += triangle(TWO_PI * freq * 2 * t) * amp * 0.18;
+  }
+
+  // Sustained sub-bass that swells once per chord — a smooth harmonic floor
+  // rather than a per-beat thump. The old per-beat kick/hat read as a disturbing
+  // pulse under narration, so these beds are now ambient, not percussive.
+  const bassRoot = root - 24 + chord[0];
+  sample += Math.sin(TWO_PI * midiToFreq(bassRoot) * t) * 0.11 * env(chordPos, 0.06, 0.9);
+
+  const melodyNote = root + 12 + track.melody[noteStep];
+  const leadWave = track.mood === "chip"
+    ? Math.sign(Math.sin(TWO_PI * midiToFreq(melodyNote) * t))
+    : triangle(TWO_PI * midiToFreq(melodyNote) * t);
+  sample += leadWave * 0.06 * env(notePos, 0.03, track.mood === "soft" ? 4 : 7);
+
+  return Math.max(-0.98, Math.min(0.98, sample));
+}
+
+function writeWav(path, track) {
+  const frames = SAMPLE_RATE * DURATION;
+  const dataSize = frames * 2 * 2;
+  const buffer = Buffer.alloc(44 + dataSize);
+
+  buffer.write("RIFF", 0);
+  buffer.writeUInt32LE(36 + dataSize, 4);
+  buffer.write("WAVE", 8);
+  buffer.write("fmt ", 12);
+  buffer.writeUInt32LE(16, 16);
+  buffer.writeUInt16LE(1, 20);
+  buffer.writeUInt16LE(2, 22);
+  buffer.writeUInt32LE(SAMPLE_RATE, 24);
+  buffer.writeUInt32LE(SAMPLE_RATE * 2 * 2, 28);
+  buffer.writeUInt16LE(4, 32);
+  buffer.writeUInt16LE(16, 34);
+  buffer.write("data", 36);
+  buffer.writeUInt32LE(dataSize, 40);
+
+  for (let i = 0; i < frames; i += 1) {
+    const t = i / SAMPLE_RATE;
+    const left = renderSample(track, t, i);
+    const right = renderSample(track, t + 0.006, i + 17);
+    buffer.writeInt16LE(Math.round(left * 32767), 44 + i * 4);
+    buffer.writeInt16LE(Math.round(right * 32767), 44 + i * 4 + 2);
+  }
+
+  writeFileSync(path, buffer);
+}
+
+const outDir = dirname(fileURLToPath(import.meta.url));
+
+for (const track of TRACKS) {
+  const wavPath = join(outDir, `${track.id}.wav`);
+  const mp3Path = join(outDir, track.file);
+  writeWav(wavPath, track);
+  const result = spawnSync(
+    "ffmpeg",
+    [
+      "-y",
+      "-hide_banner",
+      "-loglevel",
+      "error",
+      "-i",
+      wavPath,
+      "-af",
+      "loudnorm=I=-21:LRA=10:TP=-1.5",
+      "-codec:a",
+      "libmp3lame",
+      "-b:a",
+      "96k",
+      mp3Path,
+    ],
+    { stdio: "inherit" }
+  );
+  rmSync(wavPath, { force: true });
+  if (result.error || result.status !== 0) {
+    process.exitCode = result.status || 1;
+    break;
+  }
+  console.log(`wrote ${mp3Path}`);
+}

package/assets/audio/manifest.json

@@ -0,0 +1,83 @@
+[
+  {
+    "file": "calm-keys.mp3",
+    "title": "Calm Keys",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#calm-keys",
+    "license": "CC0",
+    "tones": ["professional"],
+    "duration": 32
+  },
+  {
+    "file": "steady-launch.mp3",
+    "title": "Steady Launch",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#steady-launch",
+    "license": "CC0",
+    "tones": ["professional", "technical"],
+    "duration": 32
+  },
+  {
+    "file": "clean-horizon.mp3",
+    "title": "Clean Horizon",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#clean-horizon",
+    "license": "CC0",
+    "tones": ["professional"],
+    "duration": 32
+  },
+  {
+    "file": "bright-sparks.mp3",
+    "title": "Bright Sparks",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#bright-sparks",
+    "license": "CC0",
+    "tones": ["playful"],
+    "duration": 32
+  },
+  {
+    "file": "pixel-bounce.mp3",
+    "title": "Pixel Bounce",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#pixel-bounce",
+    "license": "CC0",
+    "tones": ["playful", "technical"],
+    "duration": 32
+  },
+  {
+    "file": "sunny-loop.mp3",
+    "title": "Sunny Loop",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#sunny-loop",
+    "license": "CC0",
+    "tones": ["playful"],
+    "duration": 32
+  },
+  {
+    "file": "circuit-pulse.mp3",
+    "title": "Circuit Pulse",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#circuit-pulse",
+    "license": "CC0",
+    "tones": ["technical"],
+    "duration": 32
+  },
+  {
+    "file": "vector-grid.mp3",
+    "title": "Vector Grid",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#vector-grid",
+    "license": "CC0",
+    "tones": ["technical"],
+    "duration": 32
+  },
+  {
+    "file": "midnight-protocol.mp3",
+    "title": "Midnight Protocol",
+    "artist": "ReelMe procedural audio generator",
+    "source": "https://github.com/RubenGlez/reelme/blob/main/cli/assets/audio/generate-tracks.mjs#midnight-protocol",
+    "license": "CC0",
+    "tones": ["technical", "professional"],
+    "duration": 32
+  }
+]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reelme",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Turn your repo into launch videos for social platforms. Local Remotion rendering, zero cloud.",
   "type": "module",
   "bin": {
@@ -8,6 +8,7 @@
   },
   "files": [
     "src",
+    "assets",
     "template",
     "!template/out",
     "!template/src/__tests__",

package/src/cache.mjs

@@ -20,6 +20,7 @@ export const CACHE_ROOT = join(homedir(), ".reelme", "cache");
 
 const PKG_ROOT = join(dirname(fileURLToPath(import.meta.url)), "..");
 export const TEMPLATE_DIR = join(PKG_ROOT, "template");
+export const AUDIO_DIR = join(PKG_ROOT, "assets", "audio");
 
 const CLI_VERSION = JSON.parse(
   readFileSync(join(PKG_ROOT, "package.json"), "utf8")

package/src/render.mjs

@@ -2,14 +2,17 @@
 // variant per social platform when the brief has a teaser cut. Outputs land
 // in <repo>/reelme-out/; the heavy Remotion project stays in the cache.
 
-import { cpSync, mkdirSync } from "node:fs";
-import { basename, join } from "node:path";
+import { cpSync, existsSync, mkdirSync, readFileSync } from "node:fs";
+import { basename, dirname, join } from "node:path";
 import { spawnSync } from "node:child_process";
-import { ensureScaffold, loadPlatforms, readBrief, fail } from "./cache.mjs";
+import { AUDIO_DIR, ensureScaffold, loadPlatforms, readBrief, fail } from "./cache.mjs";
 
 function renderComposition(cacheDir, compositionId, outFile, codec) {
   const args = ["exec", "remotion", "render", compositionId, join("out", outFile)];
-  if (codec === "gif") args.push("--codec=gif");
+  // Render gifs at 0.6 scale (e.g. 1920x1080 -> 1152x648): a README gif needs no
+  // more, and fewer pixels roughly halves the file size. Layout and timing are
+  // unchanged — --scale downscales the output, not the composition coordinates.
+  if (codec === "gif") args.push("--codec=gif", "--scale=0.6");
   console.log(`reelme: rendering ${compositionId} → reelme-out/${outFile}`);
   const result = spawnSync("pnpm", args, { cwd: cacheDir, stdio: "inherit" });
   if (result.error || result.status !== 0) {
@@ -17,6 +20,90 @@ function renderComposition(cacheDir, compositionId, outFile, codec) {
   }
 }
 
+function collectAssets(brief) {
+  const assets = [];
+  const cuts = [brief.cuts.main, brief.cuts.vertical, brief.cuts.teaser].filter(Boolean);
+  for (const cut of cuts) {
+    for (const scene of cut) {
+      if (scene.type === "clip" && scene.src) assets.push(scene.src);
+      if (scene.type === "mobile" && scene.screenshot) assets.push(scene.screenshot);
+      if (scene.type === "browser" && scene.image) assets.push(scene.image);
+    }
+  }
+  return [...new Set(assets)];
+}
+
+function copyAssets(repoRoot, cacheDir, brief) {
+  const assets = collectAssets(brief);
+  if (assets.length === 0) return;
+  const publicDir = join(cacheDir, "public");
+  mkdirSync(publicDir, { recursive: true });
+  const missing = assets.filter((a) => !existsSync(join(repoRoot, a)));
+  if (missing.length > 0) {
+    fail(`missing asset file(s):\n${missing.map((a) => `  ${join(repoRoot, a)}`).join("\n")}`);
+  }
+  for (const asset of assets) {
+    const dest = join(publicDir, asset);
+    mkdirSync(dirname(dest), { recursive: true });
+    cpSync(join(repoRoot, asset), dest);
+  }
+}
+
+function loadAudioManifest() {
+  const manifestPath = join(AUDIO_DIR, "manifest.json");
+  if (!existsSync(manifestPath)) {
+    fail(`audio manifest is missing from the package: ${manifestPath}`);
+  }
+  try {
+    const manifest = JSON.parse(readFileSync(manifestPath, "utf8"));
+    if (!Array.isArray(manifest)) throw new Error("manifest must be an array");
+    return manifest;
+  } catch (e) {
+    fail(`audio manifest is invalid: ${e.message}`);
+  }
+}
+
+function copyAudioTrack(cacheDir, brief) {
+  const audio = brief.project?.audio;
+  if (!audio) return;
+
+  const track = audio.track;
+  if (typeof track !== "string" || track.length === 0 || basename(track) !== track) {
+    fail(`project.audio.track must be a filename from the bundled audio manifest.`);
+  }
+
+  const manifest = loadAudioManifest();
+  const validTracks = manifest.map((entry) => entry.file).filter(Boolean);
+  const entry = manifest.find((item) => item.file === track);
+  if (!entry) {
+    fail(
+      `unknown audio track "${track}". Valid tracks: ${validTracks.join(", ")}.`
+    );
+  }
+
+  const source = join(AUDIO_DIR, track);
+  if (!existsSync(source)) {
+    fail(`bundled audio track "${track}" is missing from ${AUDIO_DIR}.`);
+  }
+
+  const audioDir = join(cacheDir, "public", "audio");
+  mkdirSync(audioDir, { recursive: true });
+  cpSync(source, join(audioDir, track));
+}
+
+function copyLogo(repoRoot, cacheDir, brief) {
+  const logo = brief.project?.logo;
+  if (!logo) return;
+  const source = join(repoRoot, logo);
+  if (!existsSync(source)) {
+    fail(`project.logo file not found: ${source}`);
+  }
+  const publicDir = join(cacheDir, "public");
+  const dest = join(publicDir, logo);
+  mkdirSync(dirname(dest), { recursive: true });
+  cpSync(source, dest);
+}
+
 export function render(repoRoot) {
   const brief = readBrief(repoRoot);
   const platforms = loadPlatforms();
@@ -24,6 +111,20 @@ export function render(repoRoot) {
   const outDir = join(repoRoot, "reelme-out");
   mkdirSync(outDir, { recursive: true });
 
+  copyAssets(repoRoot, cacheDir, brief);
+  copyAudioTrack(cacheDir, brief);
+  copyLogo(repoRoot, cacheDir, brief);
+
+  const verticalFallback = brief.project.platforms.filter(
+    (id) => platforms[id].cut === "vertical" && !brief.cuts.vertical?.length
+  );
+  if (verticalFallback.length > 0) {
+    console.warn(
+      `reelme: warning — no cuts.vertical in reelme.json; ${verticalFallback.join(", ")} will render ` +
+        `the main cut letterboxed into 9:16. Author a vertical cut for better results.`
+    );
+  }
+
   for (const id of brief.project.platforms) {
     const preset = platforms[id];
     const outFile = basename(preset.output.file);

package/template/package.json

@@ -10,6 +10,7 @@
   },
   "dependencies": {
     "@remotion/cli": "4.0.290",
+    "@remotion/gif": "4.0.290",
     "@remotion/google-fonts": "4.0.290",
     "chroma-js": "^3.1.2",
     "lucide-react": "^0.511.0",
@@ -24,6 +25,7 @@
     "react": "^18.3.0",
     "react-dom": "^18.3.0",
     "typescript": "^5.4.0",
-    "vitest": "^4.1.0"
+    "vite": "^7.3.5",
+    "vitest": "^4.1.8"
   }
 }