@barbapapazes/video-toolkit 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 - Estéban Soubiran <esteban@soubiran.dev> (https://soubiran.dev)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,150 @@
+# @barbapapazes/video-toolkit
+
+A simple and efficient CLI toolkit for video automation. It automates the process of extracting audio, generating transcriptions using OpenAI Whisper, and creating video thumbnails with text overlays.
+
+## Features
+
+- **Audio Extraction**: Automatically extracts audio from video files using `ffmpeg`.
+- **AI Transcription**: Generates high-quality SRT subtitles using OpenAI's `whisper-1` model (defaulted to French).
+- **Thumbnail Generation**:
+  - Extracts 5 frames from the video (Start, 25%, 50%, 75%, and End).
+  - Overlays custom text using SVG templates with `sharp` for high-quality rendering.
+  - Supports multiple SVG templates - choose different templates for different video series.
+  - Generates 5 distinct PNG thumbnails for you to choose from.
+- **Template Management**: Easily add and manage SVG templates for different use cases.
+- **Automatic Cleanup**: Removes temporary audio and image files after processing.
+- **Global Configuration**: Use a global configuration file to set up your preferences once and use the tool from anywhere.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) (v22 or later recommended)
+- [ffmpeg](https://ffmpeg.org/) installed and available in your PATH.
+- [OpenAI API Key](https://platform.openai.com/)
+- macOS (this tool is designed for macOS only)
+
+## Installation
+
+```bash
+pnpm install @barbapapazes/video-toolkit
+```
+
+## Configuration
+
+The toolkit uses [c12](https://github.com/unjs/c12) for configuration loading from a global config file.
+
+Create a configuration file at `~/.video-toolkitrc`:
+
+```json
+{
+  "openaiApiKey": "your-api-key-here",
+  "language": "fr",
+  "model": "whisper-1"
+}
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `openaiApiKey` | string | - | **Required.** Your OpenAI API key |
+| `language` | string | `'fr'` | Language code for transcription (e.g., 'en', 'fr', 'es', 'de') |
+| `model` | string | `'whisper-1'` | OpenAI Whisper model to use |
+
+## Usage
+
+You can run the toolkit directly using `npx` or by installing it globally.
+
+### Process a specific video
+
+```bash
+video-toolkit path/to/your-video.mp4
+```
+
+### Interactive selection
+
+If you run the command without arguments, it will list all `.mp4` files in the current directory and let you choose one:
+
+```bash
+video-toolkit
+```
+
+### Add a template
+
+Add an SVG template to your templates directory:
+
+```bash
+video-toolkit add-template path/to/your-template.svg
+```
+
+You'll be prompted to name the template (use lowercase letters, numbers, and hyphens, e.g., `series-x`, `youtube-intro`).
+
+### Workflow
+
+1. **Select Video**: Provide a path or choose from the list.
+2. **Transcription**: The tool extracts audio and sends it to OpenAI.
+3. **Thumbnail Text**: You will be prompted to enter text for the thumbnails.
+   - If you provide text, you'll be asked to select a template.
+   - 5 thumbnails will be generated with that text using the selected template.
+   - If you leave it empty, thumbnail generation will be skipped.
+4. **Results**: SRT subtitles and PNG thumbnails are saved in the same directory as the video.
+
+## SVG Templates
+
+The toolkit uses SVG templates to render text overlays on thumbnails using the `sharp` library.
+
+### Template Location
+
+Templates are stored in `~/.config/video-toolkit/templates/`. Each template is a separate SVG file.
+
+### Template Naming Convention
+
+Template names should use lowercase letters, numbers, and hyphens only:
+- ✅ `series-x.svg`
+- ✅ `youtube-intro.svg`
+- ✅ `podcast-2024.svg`
+- ❌ `Series X.svg`
+- ❌ `MyTemplate.svg`
+
+### Creating a Template
+
+Create an SVG file with a `{{text}}` placeholder where you want the text to appear:
+
+```xml
+<svg width="1920" height="1080" viewBox="0 0 1920 1080" xmlns="http://www.w3.org/2000/svg">
+  <!-- Semi-transparent overlay -->
+  <rect width="1920" height="1080" fill="rgba(0, 0, 0, 0.5)" />
+
+  <!-- Text placeholder -->
+  <text x="960" y="540" font-family="Arial, Helvetica, sans-serif"
+        font-size="80" font-weight="bold" fill="#ffffff"
+        text-anchor="middle" dominant-baseline="middle">
+    {{text}}
+  </text>
+</svg>
+```
+
+The `{{text}}` placeholder will be replaced with the actual text you provide during thumbnail generation. The SVG should match the dimensions of your video frames (typically 1920x1080 for HD video).
+
+### Managing Multiple Templates
+
+You can have multiple templates for different purposes:
+- `series-x.svg` - For your X video series
+- `series-y.svg` - For your Y video series
+- `youtube-intro.svg` - For YouTube introductions
+- `podcast.svg` - For podcast episodes
+
+Use the `add-template` command to easily add new templates, and during thumbnail generation, you'll be prompted to select which template to use.
+
+## Output Files
+
+For an input file `my-video.mp4`, the tool generates:
+- `my-video.srt`: The generated subtitles.
+- `my-video_thumbnail_first.png`: Thumbnail from the first frame.
+- `my-video_thumbnail_25.png`: Thumbnail at 25% duration.
+- `my-video_thumbnail_50.png`: Thumbnail at 50% duration.
+- `my-video_thumbnail_75.png`: Thumbnail at 75% duration.
+- `my-video_thumbnail_last.png`: Thumbnail from the last frame.
+
+## License
+
+MIT