CodeReel

A CLI tool for creating videos and animations using FFmpeg, inspired by FFCreator functionality.

Installation

npm install -g codereel

Prerequisites

• Node.js (v12 or higher)
• FFmpeg must be installed and available in your PATH

Installing FFmpeg

macOS:

brew install ffmpeg

Ubuntu/Debian:

sudo apt update
sudo apt install ffmpeg

Windows: Download from ffmpeg.org and add to PATH

Usage

codereel <command> [options]

Commands

create-video

Create a video from a single image.

codereel create-video <input> <output> [options]

Options:

• --duration <seconds> - Video duration in seconds (default: 5)
• --fps <frames per second> - Frame rate (default: 30)
• --width <pixels> - Video width (default: 1920)
• --height <pixels> - Video height (default: 1080)

Example:

codereel create-video image.jpg output.mp4 --duration 10 --width 1280 --height 720

animate-images

Create an animation video from a sequence of images in a folder.

codereel animate-images <folder> <output> [fps]

Parameters:

• folder - Path to folder containing image sequence
• output - Output video file path
• fps - Frames per second (default: 30)

Requirements:

• Images should be named sequentially (e.g., 0001.png, 0002.png, etc.)
• Supported formats: JPG, JPEG, PNG, BMP, TIFF

Example:

codereel animate-images ./frames animation.mp4 24

demo

Create a demo video by combining an image with MP3 audio.

codereel demo <image> <audio> <output>

Parameters:

• image - Path to image file
• audio - Path to MP3 audio file
• output - Output video file path

Features:

• Video duration matches audio length
• Image is scaled to 1920x1080
• H.264 video codec with AAC audio

Example:

codereel demo poster.jpg soundtrack.mp3 demo.mp4

help

Display help information.

codereel help
# or
codereel --help
codereel -h

Examples

Basic Image to Video

codereel create-video photo.jpg video.mp4

Custom Duration and Resolution

codereel create-video image.png output.mp4 --duration 15 --width 1920 --height 1080 --fps 60

Image Sequence Animation

# Assuming you have 0001.png, 0002.png, ... in ./frames/
codereel animate-images ./frames movie.mp4 30

Audio-Visual Demo

codereel demo cover.jpg music.mp3 presentation.mp4

Error Handling

The tool includes comprehensive error checking:

• Validates FFmpeg installation
• Checks file existence before processing
• Provides clear error messages for missing parameters
• Handles FFmpeg execution errors gracefully

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

License

ISC