3 Documentation
Gemini CLI edited this page 2026-03-15 14:37:09 -04:00

VideoTools Documentation

VideoTools is a desktop video processing application built on FFmpeg. It provides a graphical interface for converting, inspecting, and preparing video.

For a high-level overview of what is currently implemented, in progress, or planned, please see the Project Status Page.

Builds

Documentation Structure

Core Modules (Implementation Status)

Implemented

  • Convert - Video transcoding and format conversion with DVD presets.
  • Merge - Join multiple clips with format presets and queue support.
  • Filters - FFmpeg filter chains and stylistic presets.
  • Audio - Audio extraction and batch output tools.
  • Thumb - Thumbnail/contact sheet generation.
  • Inspect - Metadata viewing with interlacing analysis.
  • Compare - Side-by-side playback comparison.
  • Rip - Extraction from VIDEO_TS folders and .iso images.
  • Author - DVD authoring and menu generation.
  • Queue System - Batch processing with job management.
  • Settings - Preferences for language and hardware acceleration.

Implemented With Known Issues / Partial

  • Player - Core playback works but has critical issues. See PLAYER_PERFORMANCE_ISSUES.md.
  • Upscale - Traditional scaling plus Real-ESRGAN (ncnn) integration.

Planned

  • Trim - [PLANNED] Cut and split videos.
  • Subtitles - [PLANNED] Subtitle management.
  • Blu-ray - [PLANNED] Disc authoring pipeline.
  • Enhancement - [PLANNED] Unified enhancement pipeline (post-player).

Additional Modules (All Planned)

  • Streams - [PLANNED] Multi-stream handling.
  • GIF - [PLANNED] Animated GIF creation.
  • Crop - [PLANNED] Video cropping tools.
  • Screenshots - [PLANNED] Frame extraction.

Implementation Documents

Development Documentation

  • Integration Guide - System architecture and integration plans.
  • Build and Run Guide - Instructions for setting up a development environment.
  • Dev30 Finalization Checklist - Release-close checklist for CI, smoke tests, docs, and tag handoff.
  • FFmpeg Integration - [PLANNED] Documentation on FFmpeg command building.
  • Contributing - [PLANNED] Contribution guidelines.

User Guides

  • Installation Guide - Comprehensive installation instructions.
  • DVD User Guide - A step-by-step guide to the DVD encoding workflow.
  • Quick Start - The fastest way to get up and running.
  • Workflows - [PLANNED] Guides for common multi-module tasks.
  • Keyboard Shortcuts - [PLANNED] A reference for all keyboard shortcuts.