vlad.os/Warlock-Studio-Universal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Iván Eduardo Chavez Ayub
2025-08-19 04:14:45 -06:00
committed by GitHub
parent 7e0eae18d3
commit 7cfaf59961
1 changed files with 115 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+115 -103
View File
@@ -13,16 +13,16 @@ _Transform your media with cutting-edge AI technology_
---
**Warlock-Studio** is an open-source desktop application for **Windows** that integrates state-of-the-art AI models for video and image enhancement.
Inspired by [Djdefrag](https://github.com/Djdefrag) tools like **QualityScaler** and **FluidFrames**, this suite offers a unified, high-performance interface for **upscaling, restoration, and frame interpolation**.
**Warlock-Studio** is a professional, open-source desktop application for **Windows**, designed to integrate state-of-the-art AI models for **image and video enhancement**.
Inspired by [Djdefrag](https://github.com/Djdefrag) tools such as **QualityScaler** and **FluidFrames**, Warlock-Studio provides a unified, high-performance platform for **upscaling, restoration, denoising, and frame interpolation**.
Version **4.1** introduces improved GPU utilization, compatibility fixes, and optimized model loading for a faster, more stable experience.
Version **4.1** introduces **enhanced GPU utilization**, **robust ONNX model loading**, and multiple **stability and compatibility improvements**, ensuring a smoother, faster, and more reliable user experience.
---
## 📥 Download Installer (v4.1)
Get the latest stable release:
Get the latest stable release from multiple sources:
<table>
<tr>
@@ -48,40 +48,40 @@ Get the latest stable release:
## ✨ Key Features
- **AI Upscaling & Restoration** – Real-ESRGAN, BSRGAN, IRCNN for denoising, upscaling, and detail recovery.
- **Face Restoration (GFPGAN)** – Revive blurry or low-quality portraits in photos and videos.
- **Frame Interpolation (RIFE)** – Generate **2×, 4×, 8×** smoother motion or slow-motion.
- **Modern UI** – Redesigned in v4.0 for an intuitive, streamlined experience.
- **Batch Processing** – Handle multiple media files simultaneously.
- **Custom Workflows** – Full control over models, resolution, output format, and quality.
- **Open-Source & Extensible** – Licensed under MIT, with a modular architecture for contributors.
- **AI Upscaling & Restoration** – Utilize **Real-ESRGAN, BSRGAN, and IRCNN** models for denoising, super-resolution, and detail recovery.
- **Face Restoration (GFPGAN)** – Recover facial details from low-resolution or blurry images and video frames.
- **Frame Interpolation (RIFE)** – Smooth motion or generate slow-motion content with **2×, 4×, or 8× interpolation**.
- **Modern UI** – Redesigned interface in v4.0 for **intuitive workflow and streamlined navigation**.
- **Batch Processing** – Process multiple media files simultaneously, saving time and effort.
- **Custom Workflows** – Fine-grained control over models, resolution, output formats, and quality parameters.
- **Open-Source & Extensible** – Fully MIT licensed, with a modular architecture for contributors and developers.
---
## 🆕 What’s New in v4.1
- 🔧 Removed outdated SuperResolution-10 model.
- ✅ Robust ONNX loading & GPU acceleration.
- ✅ Fixed import errors & improved type annotations.
- ✅ Enhanced error handling with graceful fallbacks.
- 🟢 Better GPU utilization & resource management.
- 🚀 Compatibility fixes for NumPy & OpenCV.
- 📦 Stability improvements & refined memory usage.
- ✅ Improved startup reliability & user notifications.
- 🔧 **Removed outdated SuperResolution-10 model** to streamline resources.
- ✅ **Enhanced ONNX loading** with better GPU acceleration.
- ✅ **Fixed import and type annotation issues** for cleaner code execution.
- ✅ **Improved error handling** with graceful fallback mechanisms.
- 🟢 Optimized **GPU resource management** for faster processing.
- 🚀 Compatibility fixes for **NumPy** and **OpenCV**.
- 📦 Stability and memory usage improvements for longer sessions.
- ✅ Increased startup reliability with enhanced user notifications.
---
## 🌐 Smart Model Distribution System (v4.0+)
### 🎯 Lightweight Installation
- Installer reduced from **1.4GB → 450MB** (–68%).
- Models (~400MB) download automatically on first launch.
- Bandwidth-friendly setup.
- Installer reduced from **1.4GB → 450MB** (–68%) for faster downloads.
- Core AI models (~400MB) downloaded automatically on first launch.
- Bandwidth-friendly and modular setup for selective installation.
### 🛡️ Reliability
- **Integrity checks** on downloaded models.
- **Graceful degradation** if models are missing.
- **Offline support** for manual model placement.
- **Integrity checks** on downloaded model files.
- **Graceful degradation** in case of missing models.
- **Offline support** allows manual placement of model files.
---
@@ -97,19 +97,19 @@ Get the latest stable release:
## 🚀 How to Use
1. Run as **Administrator** (recommended).
2. **Load Media**: Import images or videos.
3. **Configure Settings**:
- Choose AI model (Real-ESRGAN, GFPGAN, etc.)
- Set resolution, format, interpolation, etc.
4. **Start Processing** with **"Make Magic"**.
5. Retrieve results from the output folder.
1. Run Warlock-Studio as **Administrator** (recommended for full GPU access).
2. **Load Media** – Import images or videos.
3. **Configure Processing Settings**:
- Select AI model (Real-ESRGAN, GFPGAN, etc.)
- Set resolution, format, frame interpolation, and quality.
4. **Start Processing** using **"Make Magic"**.
5. Retrieve the processed results from the designated output folder.
---
## 🖼️ Quality Comparison
Enhanced image using **BSRGANx2**
Enhanced image using **BSRGANx2**:
![Comparison](rsc/image_comparison.png)
---
@@ -117,27 +117,27 @@ Enhanced image using **BSRGANx2**
## 📊 Model Comparison
| Model File | Use Case | Speed | Quality | Notes |
|--------------------------|------------------------------------------|---------|---------|-------|
| **GFPGANv1.4** | Face restoration | High | High | Great for blurry faces |
| **BSRGANx2** | 2× upscale + denoising | Medium | Very High | For lightly degraded images |
| **BSRGANx4** | 4× upscale + denoising | Low | Very High | For heavily degraded media |
| **RIFE** | Smooth frame interpolation | High | High | Best quality for motion |
| **RIFE-Lite** | Faster interpolation | Very High | Medium | Lightweight alternative |
| **RealESRGANx4** | General 4× upscale | Medium | High | Great all-rounder |
| **RealESRNetx4** | Subtle restoration without oversharpen | Medium | High | Preserves natural look |
| **RealSRx4_Anime** | Anime / line-art upscale | Medium | High | Clean edges for 2D art |
| **IRCNN_L** | Light denoising | High | Medium | Mild artifact removal |
| **IRCNN_M** | Medium denoising | High | Medium | Stronger artifact cleanup |
|--------------------------|----------------------------------------|---------|---------|-------|
| **GFPGANv1.4** | Face restoration | High | High | Optimal for portraits |
| **BSRGANx2** | 2× upscale + denoising | Medium | Very High | Suitable for lightly degraded media |
| **BSRGANx4** | 4× upscale + denoising | Low | Very High | For heavily degraded content |
| **RIFE** | Frame interpolation | High | High | Smooth motion, slow-motion support |
| **RIFE-Lite** | Lightweight interpolation | Very High | Medium | Faster, lower resource usage |
| **RealESRGANx4** | General 4× upscaling | Medium | High | Balanced performance |
| **RealESRNetx4** | Subtle restoration | Medium | High | Preserves natural image texture |
| **RealSRx4_Anime** | Anime / line-art enhancement | Medium | High | Sharp edges for 2D art |
| **IRCNN_L** | Light denoising | High | Medium | Mild artifact removal |
| **IRCNN_M** | Medium denoising | High | Medium | Stronger artifact cleanup |
---
## ⚙️ Installation
1. **Download installer** (links above).
2. **Run setup** and follow steps.
3. Launch from Start Menu / Desktop shortcut.
1. **Download installer** (see links above).
2. Run the **setup wizard** and follow prompts.
3. Launch via Start Menu or Desktop shortcut.
Warlock-Studio is packaged with **PyInstaller** + **Inno Setup**.
> Warlock-Studio is packaged using **PyInstaller** and deployed with **Inno Setup** for seamless installation.
### Installer Previews
@@ -149,10 +149,10 @@ Warlock-Studio is packaged with **PyInstaller** + **Inno Setup**.
## 🖥️ System Requirements
- **OS:** Windows 10+ (64-bit)
- **OS:** Windows 10 or higher (64-bit)
- **RAM:** 8GB+ recommended
- **GPU:** NVIDIA or DirectML-compatible GPU recommended
- **Storage:** Enough for input + processed media
- **Storage:** Sufficient free space for input and processed media
---
@@ -160,22 +160,22 @@ Warlock-Studio is packaged with **PyInstaller** + **Inno Setup**.
| Component | Status | Notes |
|-----------------------------|------------|-------|
| Upscaling Models | 🟢 Stable | VRAM recovery integrated |
| Optimized Model Suite | 🟢 Enhanced | Streamlined & reliable |
| Face Restoration (GFPGAN) | 🟢 Stable | High-quality face fix |
| Frame Interpolation (RIFE) | 🟢 Stable | Smooth motion, slow-mo |
| Batch Processing | 🟢 Stable | Improved error handling |
| User Interface (UI/UX) | 🟢 Refined | Clean, integrated models |
| GPU Management | 🟢 Enhanced | Robust ONNX + fallbacks |
| Code Quality | 🟢 Improved | Refactored & type-safe |
| Installer & Packaging | 🟢 Stable | Seamless setup |
| Upscaling Models | 🟢 Stable | Includes VRAM recovery integration |
| Optimized Model Suite | 🟢 Enhanced | Streamlined and reliable |
| Face Restoration (GFPGAN) | 🟢 Stable | High-quality face reconstruction |
| Frame Interpolation (RIFE) | 🟢 Stable | Smooth motion and slow-motion support |
| Batch Processing | 🟢 Stable | Improved error handling and logging |
| User Interface (UI/UX) | 🟢 Refined | Clean, modern design with integrated models |
| GPU Management | 🟢 Enhanced | Robust ONNX handling and fallbacks |
| Code Quality | 🟢 Improved | Refactored, type-safe, maintainable |
| Installer & Packaging | 🟢 Stable | Smooth setup experience |
---
## 📂 Project Structure
</div>
```bash
```
Warlock-Studio/
├── AI-onnx/ # Pre-trained ONNX models for AI processing
│ ├── BSRGANx2_fp16.onnx
@@ -191,7 +191,7 @@ Warlock-Studio/
│ ├── RIFE_fp32.onnx
│ └── RIFE_Lite_fp32.onnx
│
├── Assets/ # App assets and third-party binaries
├── Assets/ # Application assets and third-party binaries
│ ├── banner.png
│ ├── clear_icon.png
│ ├── exiftool.exe
@@ -204,7 +204,7 @@ Warlock-Studio/
│ ├── wizard-image.bmp
│ └── wizard-small.bmp
│
├── rsc/ # UI images, workflows, and branding
├── rsc/ # UI previews, workflows, and branding resources
│ ├── badge-color.png
│ ├── Capture.png
│ ├── CaptureRIFE.png
@@ -222,62 +222,74 @@ Warlock-Studio/
│ └── Manual_ES.pdf
│
├── Warlock-Studio.py # Main application script
├── Warlock-Studio.spec # PyInstaller spec file
├── Warlock-Studio.spec # PyInstaller specification file
├── Setup.iss # Inno Setup installer script
│
├── README.md # Project overview (this file)
├── requirements.txt
├── CHANGELOG.md # Version history
├── LICENSE # License info (standard)
├── License.txt
├── NOTICE.md # Notices and attributions
├── CODE_OF_CONDUCT.md # Contributor behavior guidelines
├── CONTRIBUTING.md # Contribution guide
└── SECURITY.md # Security reporting policies
├── README.md # Project overview
├── requirements.txt # Python dependencies
├── CHANGELOG.md # Version history and updates
├── LICENSE # MIT License information
├── License.txt # Additional license info
├── NOTICE.md # Legal notices and attributions
├── CODE_OF_CONDUCT.md # Contributor guidelines
├── CONTRIBUTING.md # Contribution guide
└── SECURITY.md # Security reporting policies
```
<div align="center">
🔗 Integrated Technologies & Licenses
Technology License Author Source
Real-ESRGAN BSD/Apache Xintao Wang
GitHub
---
GFPGAN Apache 2.0 TencentARC
GitHub
## 🔗 Integrated Technologies & Licenses
RIFE Apache 2.0 hzwer
GitHub
| Technology | License | Author | Source |
|---------------|------------|--------|--------|
| Real-ESRGAN | BSD/Apache | [Xintao Wang](https://github.com/xinntao) | [GitHub](https://github.com/xinntao/Real-ESRGAN) |
| GFPGAN | Apache 2.0 | [TencentARC](https://github.com/TencentARC) | [GitHub](https://github.com/TencentARC/GFPGAN) |
| RIFE | Apache 2.0 | [hzwer](https://github.com/hzwer) | [GitHub](https://github.com/megvii-research/ECCV2022-RIFE) |
| BSRGAN | Apache 2.0 | [Kai Zhang](https://github.com/cszn) | [GitHub](https://github.com/cszn/BSRGAN) |
| IRCNN | BSD/Mixed | [Kai Zhang](https://github.com/cszn) | [GitHub](https://github.com/cszn/IRCNN) |
| Anime4K | MIT | [bloc97](https://github.com/bloc97) | [GitHub](https://github.com/bloc97/Anime4K) |
| ONNX Runtime | MIT | [Microsoft](https://github.com/microsoft) | [GitHub](https://github.com/microsoft/onnxruntime) |
| PyTorch | BSD-3 | [Meta AI](https://pytorch.org/) | [GitHub](https://github.com/pytorch/pytorch) |
| FFmpeg | LGPL/GPL | [FFmpeg Team](https://ffmpeg.org) | [Site](https://ffmpeg.org) |
| ExifTool | Artistic | [Phil Harvey](https://exiftool.org/) | [Site](https://exiftool.org/) |
| PyInstaller | GPLv2+ | [Team](https://github.com/pyinstaller) | [GitHub](https://github.com/pyinstaller/pyinstaller) |
| Inno Setup | Custom | [Jordan Russell](http://www.jrsoftware.org/) | [Site](http://www.jrsoftware.org/isinfo.php) |
BSRGAN Apache 2.0 Kai Zhang
GitHub
---
IRCNN BSD/Mixed Kai Zhang
GitHub
## 🤝 Contributions
Anime4K MIT bloc97
GitHub
We welcome community contributions!
ONNX Runtime MIT Microsoft
GitHub
1. **Fork** the repo
2. **Create a branch** for your feature/fix
3. **Submit a Pull Request** with details
PyTorch BSD-3 Meta AI
GitHub
📧 Contact: **[negroayub97@gmail.com](mailto:negroayub97@gmail.com)**
FFmpeg LGPL/GPL FFmpeg Team
Site
---
ExifTool Artistic Phil Harvey
Site
## 📜 License
PyInstaller GPLv2+ Team
GitHub
© 2025 Iván Eduardo Chavez Ayub
Licensed under **MIT**. Additional terms in `NOTICE.md`.
</div>
Inno Setup Custom Jordan Russell
Site
🤝 Contributions
We welcome contributions from the community:
Fork the repository.
Create a branch for your feature or bug fix.
Submit a Pull Request with detailed description and testing notes.
📧 Contact: negroayub97@gmail.com
📜 License
© 2025 Iván Eduardo Chavez Ayub
Licensed under MIT. Additional terms and attributions are provided in NOTICE.md.
</div> ```
This version preserves all content but enhances technical clarity, professional formatting, and structured readability for developers and end-users.