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-10-06 22:59:14 -06:00
committed by GitHub
parent 9b3969052c
commit 90bb143ab5
1 changed files with 86 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+77 -105
View File
@@ -5,7 +5,7 @@
### _AI Media Enhancement Suite_ ### _AI Media Enhancement Suite_
[![Build Status](https://img.shields.io/badge/Build-Stable_Release-0A192F?style=for-the-badge&logo=github&logoColor=FFD700)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases) [![Build Status](https://img.shields.io/badge/Build-Stable_Release-0A192F?style=for-the-badge&logo=github&logoColor=FFD700)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases)
[![Version](https://img.shields.io/badge/Version-4.1--08.01-FF8C00?style=for-the-badge&logo=git&logoColor=white)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases/tag/4.1) [![Version](https://img.shields.io/badge/Version-4.2-FF8C00?style=for-the-badge&logo=git&logoColor=white)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases/tag/4.2)
[![License](https://img.shields.io/badge/License-MIT-6A0DAD?style=for-the-badge&logo=open-source-initiative&logoColor=white)](LICENSE) [![License](https://img.shields.io/badge/License-MIT-6A0DAD?style=for-the-badge&logo=open-source-initiative&logoColor=white)](LICENSE)
[![Downloads](https://img.shields.io/github/downloads/Ivan-Ayub97/Warlock-Studio/total?style=for-the-badge&color=FFD700&logo=download&logoColor=black)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases) [![Downloads](https://img.shields.io/github/downloads/Ivan-Ayub97/Warlock-Studio/total?style=for-the-badge&color=FFD700&logo=download&logoColor=black)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases)
@@ -19,14 +19,14 @@ _Transform your media with cutting-edge AI technology_
--- ---
**Warlock-Studio** is an open source desktop application for **Windows**, designed to integrate state-of-the-art AI models for **image and video enhancement**. **Warlock-Studio** is an 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**. 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 **enhanced GPU utilization**, **robust ONNX model loading**, and multiple **stability and compatibility improvements**, ensuring a smoother, faster, and more reliable user experience. Version **4.2** introduces a **full offline installer**, an **advanced ONNX Runtime engine** with CUDA support, and significant **packaging optimizations**, ensuring the most reliable and performant experience yet.
--- ---
## 📥 Download Installer (v4.1) ## 📥 Download Installer (v4.2)
Get the latest stable release from: Get the latest stable release from:
@@ -38,7 +38,7 @@ Get the latest stable release from:
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="https://github.com/Ivan-Ayub97/Warlock-Studio/releases/download/v4.1/Warlock-Studio4.1Setup_Winx64.zip"> <a href="https://github.com/Ivan-Ayub97/Warlock-Studio/releases/download/v4.2/Warlock-Studio-4.2-Full-Installer.exe">
<img src="rsc/GitHub_Logo_WS.png" alt="Download from GitHub" width="200" /> <img src="rsc/GitHub_Logo_WS.png" alt="Download from GitHub" width="200" />
</a> </a>
</td> </td>
@@ -54,40 +54,24 @@ Get the latest stable release from:
## ✨ Key Features ## ✨ Key Features
- **AI Upscaling & Restoration** – Utilize **Real-ESRGAN, BSRGAN, and IRCNN** models for denoising, super-resolution, and detail recovery. - **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. - **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**. - **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**. - **Advanced Hardware Acceleration** – Intelligent provider selection prioritizes **CUDA**, falls back to **DirectML**, and finally **CPU** for maximum compatibility and performance.
- **Batch Processing** – Process multiple media files simultaneously, saving time and effort. - **Batch Processing** – Process multiple media files simultaneously, saving time and effort.
- **Custom Workflows** – Fine-grained control over models, resolution, output formats, and quality parameters. - **Custom Workflows** – Fine-grained control over models, resolution, output formats, and quality parameters.
- **Open-Source & Extensible** – Fully MIT licensed, for contributors and developers. - **Open-Source & Extensible** – Fully MIT licensed, for contributors and developers.
--- ---
## 🆕 What’s New in v4.1 ## 🆕 What’s New in v4.2
- 🔧 **Removed outdated SuperResolution-10 model** to streamline resources. - 📦 **Full Offline Installer**: The application is now distributed as a single, self-contained offline installer. All AI models are included, eliminating the need for an internet connection during setup and ensuring a reliable installation.
- ✅ **Enhanced ONNX loading** with better GPU acceleration. - 🚀 **Advanced ONNX Runtime Engine**: The model loading architecture was re-engineered to intelligently prioritize hardware acceleration providers (**CUDA** > **DirectML** > **CPU**), maximizing performance on capable hardware and ensuring stability via a robust fallback mechanism.
- ✅ **Fixed import and type annotation issues** for cleaner code execution. - ⚙️ **Aggressive Packaging Optimization**: The final application size has been drastically reduced by aggressively pruning unnecessary dependencies from the PyInstaller build, resulting in a lighter and more efficient package.
- ✅ **Improved error handling** with graceful fallback mechanisms. - 🐛 **Enhanced Runtime Stability**: Added crucial hidden imports to the build process, preventing `ModuleNotFoundError` crashes and ensuring all components of `onnxruntime` and other libraries load correctly.
- 🟢 Optimized **GPU resource management** for faster processing. - 🖥️ **Improved Debugging Experience**: The application now runs with an attached console window, providing real-time logs and error messages for easier troubleshooting.
- 🚀 Compatibility fixes for **NumPy** and **OpenCV**. - ✨ **Professional Splash Screen**: A new startup splash screen provides immediate visual feedback while the application initializes, improving the user experience.
- 📦 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%) 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 model files.
- **Graceful degradation** in case of missing models.
- **Offline support** allows manual placement of model files.
--- ---
@@ -103,13 +87,13 @@ Get the latest stable release from:
## 🚀 How to Use ## 🚀 How to Use
1. Run Warlock-Studio as **Administrator** (recommended for full GPU access). 1. Run Warlock-Studio as **Administrator** (recommended for full GPU access).
2. **Load Media** – Import images or videos. 2. **Load Media** – Import images or videos.
3. **Configure Processing Settings**: 3. **Configure Processing Settings**:
- Select AI model (Real-ESRGAN, GFPGAN, etc.) - Select AI model (Real-ESRGAN, GFPGAN, etc.)
- Set resolution, format, frame interpolation, and quality. - Set resolution, format, frame interpolation, and quality.
4. **Start Processing** using **"Make Magic"**. 4. **Start Processing** using **"Make Magic"**.
5. Retrieve the processed results from the designated output folder. 5. Retrieve the processed results from the designated output folder.
--- ---
@@ -122,28 +106,28 @@ Enhanced image using **BSRGANx2**:
## 📊 Model Comparison ## 📊 Model Comparison
| Model File | Use Case | Speed | Quality | Notes | | Model File | Use Case | Speed | Quality | Notes |
|--------------------------|----------------------------------------|---------|---------|-------| | -------------------------- | ------------------------------ | --------- | --------- | ----------------------------------- |
| **GFPGANv1.4** | Face restoration | High | High | Optimal for portraits | | **GFPGANv1.4** | Face restoration | High | High | Optimal for portraits |
| **BSRGANx2** | 2× upscale + denoising | Medium | Very High | Suitable for lightly degraded media | | **BSRGANx2** | 2× upscale + denoising | Medium | Very High | Suitable for lightly degraded media |
| **BSRGANx4** | 4× upscale + denoising | Low | Very High | For heavily degraded content | | **BSRGANx4** | 4× upscale + denoising | Low | Very High | For heavily degraded content |
| **RIFE** | Frame interpolation | High | High | Smooth motion, slow-motion support | | **RIFE** | Frame interpolation | High | High | Smooth motion, slow-motion support |
| **RIFE-Lite** | Lightweight interpolation | Very High | Medium | Faster, lower resource usage | | **RIFE-Lite** | Lightweight interpolation | Very High | Medium | Faster, lower resource usage |
| **RealESRGANx4** | General 4× upscaling | Medium | High | Balanced performance | | **RealESRGANx4** | General 4× upscaling | Medium | High | Balanced performance |
| **RealESRNetx4** | Subtle restoration | Medium | High | Preserves natural image texture | | **RealESRNetx4** | Subtle restoration | Medium | High | Preserves natural image texture |
| **RealSRx4_Anime** | Anime / line-art enhancement | Medium | High | Sharp edges for 2D art | | **RealSRx4_Anime** | Anime / line-art enhancement | Medium | High | Sharp edges for 2D art |
| **IRCNN_L** | Light denoising | High | Medium | Mild artifact removal | | **IRCNN_L** | Light denoising | High | Medium | Mild artifact removal |
| **IRCNN_M** | Medium denoising | High | Medium | Stronger artifact cleanup | | **IRCNN_M** | Medium denoising | High | Medium | Stronger artifact cleanup |
--- ---
## ⚙️ Installation ## ⚙️ Installation
1. **Download installer** (see links above). 1. **Download the Full Offline Installer** (see links above).
2. Run the **setup wizard** and follow prompts. 2. Run the **setup wizard** and follow the prompts.
3. Launch via Start Menu or Desktop shortcut. 3. Launch via Start Menu or Desktop shortcut.
> Warlock-Studio is packaged using **PyInstaller** and deployed with **Inno Setup** for seamless installation. > Warlock-Studio is packaged using **PyInstaller** and deployed with **Inno Setup** for a seamless, self-contained installation experience.
### Installer Previews ### Installer Previews
@@ -155,26 +139,25 @@ Enhanced image using **BSRGANx2**:
## 🖥️ System Requirements ## 🖥️ System Requirements
- **OS:** Windows 10 or higher (64-bit) - **OS:** Windows 10 or higher (64-bit)
- **RAM:** 8GB+ recommended - **RAM:** 8GB+ recommended
- **GPU:** NVIDIA or DirectML-compatible GPU recommended - **GPU:** NVIDIA (for CUDA), AMD, or Intel GPU with up-to-date drivers recommended
- **Storage:** Sufficient free space for input and processed media - **Storage:** Sufficient free space for input and processed media
--- ---
## 📌 Development Status (v4.1-08.01) ## 📌 Development Status (v4.2)
| Component | Status | Notes | | Component | Status | Notes |
|-----------------------------|------------|-------| | ---------------------------- | ----------- | -------------------------------------------------------- |
| Upscaling Models | 🟢 Stable | Includes VRAM recovery integration | | ONNX Runtime Engine | 🟢 Enhanced | Prioritizes CUDA > DirectML > CPU with automatic fallback. |
| Optimized Model Suite | 🟢 Enhanced | Streamlined and reliable | | Installer & Packaging | 🟢 Overhauled | Full offline installer; heavily optimized package size. |
| Face Restoration (GFPGAN) | 🟢 Stable | High-quality face reconstruction | | Upscaling Models | 🟢 Stable | Includes VRAM recovery integration. |
| Frame Interpolation (RIFE) | 🟢 Stable | Smooth motion and slow-motion support | | Face Restoration (GFPGAN) | 🟢 Stable | High-quality face reconstruction. |
| Batch Processing | 🟢 Stable | Improved error handling and logging | | Frame Interpolation (RIFE) | 🟢 Stable | Smooth motion and slow-motion support. |
| User Interface (UI/UX) | 🟢 Refined | Clean, modern design with integrated models | | Batch Processing | 🟢 Stable | Improved error handling and logging. |
| GPU Management | 🟢 Enhanced | Robust ONNX handling and fallbacks | | User Interface (UI/UX) | 🟢 Refined | Clean, modern design with splash screen. |
| Code Quality | 🟢 Improved | Refactored, type-safe, maintainable | | Code Quality | 🟢 Improved | Refactored, modular, and more maintainable. |
| Installer & Packaging | 🟢 Stable | Smooth setup experience |
--- ---
@@ -244,27 +227,25 @@ Warlock-Studio/
``` ```
<div align="center"> <div align="center">
---
## 📊 Integrated Technologies & Licenses ## 📊 Integrated Technologies & Licenses
| Technology | License | Author / Maintainer | Source | | Technology | License | Author / Maintainer | Source |
|-----------------|---------------------|------------------------------------------|--------| | --------------- | ------------------- | ---------------------------------------- | ------------------------------------------------------------ |
| QualityScaler | MIT | [Djdefrag](https://github.com/Djdefrag) | [GitHub](https://github.com/Djdefrag/QualityScaler) | | QualityScaler | MIT | [Djdefrag](https://github.com/Djdefrag) | [GitHub](https://github.com/Djdefrag/QualityScaler) |
| RealScaler | MIT | [Djdefrag](https://github.com/Djdefrag) | [GitHub](https://github.com/Djdefrag/RealScaler) | | FluidFrames | MIT | [Djdefrag](https://github.com/Djdefrag) | [GitHub](https://github.com/Djdefrag/FluidFrames) |
| FluidFrames | MIT | [Djdefrag](https://github.com/Djdefrag) | [GitHub](https://github.com/Djdefrag/FluidFrames) | | Real-ESRGAN | BSD 3-Clause / Apache | Xintao Wang | [GitHub](https://github.com/xinntao/Real-ESRGAN) |
| Real-ESRGAN | BSD 3-Clause / Apache | Xintao Wang | [GitHub](https://github.com/xinntao/Real-ESRGAN) | | GFPGAN | Apache 2.0 | TencentARC / Xintao Wang | [GitHub](https://github.com/TencentARC/GFPGAN) |
| GFPGAN | Apache 2.0 | TencentARC / Xintao Wang | [GitHub](https://github.com/TencentARC/GFPGAN) | | RIFE | Apache 2.0 | hzwer | [GitHub](https://github.com/megvii-research/ECCV2022-RIFE) |
| RIFE | Apache 2.0 | hzwer | [GitHub](https://github.com/megvii-research/ECCV2022-RIFE) | | BSRGAN | Apache 2.0 | Kai Zhang | [GitHub](https://github.com/cszn/BSRGAN) |
| BSRGAN | Apache 2.0 | Kai Zhang | [GitHub](https://github.com/cszn/BSRGAN) | | IRCNN | BSD / Mixed | Kai Zhang | [GitHub](https://github.com/cszn/IRCNN) |
| IRCNN | BSD / Mixed | Kai Zhang | [GitHub](https://github.com/cszn/IRCNN) | | ONNX Runtime | MIT | Microsoft | [GitHub](https://github.com/microsoft/onnxruntime) |
| Anime4K | MIT | bloc97 | [GitHub](https://github.com/bloc97/Anime4K) | | FFmpeg | LGPL / GPL | FFmpeg Team | [Official Site](https://ffmpeg.org) |
| ONNX Runtime | MIT | Microsoft | [GitHub](https://github.com/microsoft/onnxruntime) | | ExifTool | Artistic License | Phil Harvey | [Official Site](https://exiftool.org/) |
| PyTorch | BSD 3-Clause | Meta AI | [GitHub](https://github.com/pytorch/pytorch) | | Python | PSF License | Python Software Foundation | [Official Site](https://www.python.org) |
| FFmpeg | LGPL / GPL | FFmpeg Team | [Official Site](https://ffmpeg.org) | | PyInstaller | GPLv2+ | PyInstaller Team | [GitHub](https://github.com/pyinstaller/pyinstaller) |
| ExifTool | Artistic License | Phil Harvey | [Official Site](https://exiftool.org/) | | Inno Setup | Custom | Jordan Russell | [Official Site](http://www.jrsoftware.org/isinfo.php) |
| DirectML | MIT | Microsoft | [GitHub](https://github.com/microsoft/DirectML) |
| Python | PSF License | Python Software Foundation | [Official Site](https://www.python.org) |
| PyInstaller | GPLv2+ | PyInstaller Team | [GitHub](https://github.com/pyinstaller/pyinstaller) |
| Inno Setup | Custom | Jordan Russell | [Official Site](http://www.jrsoftware.org/isinfo.php) |
--- ---
@@ -272,9 +253,9 @@ Warlock-Studio/
We welcome contributions from the community: We welcome contributions from the community:
1. **Fork** the repository. 1. **Fork** the repository.
2. **Create a branch** for your feature or bug fix. 2. **Create a branch** for your feature or bug fix.
3. **Submit a Pull Request** with detailed description and testing notes. 3. **Submit a Pull Request** with a detailed description and testing notes.
📧 Contact: **[negroayub97@gmail.com](mailto:negroayub97@gmail.com)** 📧 Contact: **[negroayub97@gmail.com](mailto:negroayub97@gmail.com)**
@@ -286,12 +267,3 @@ We welcome contributions from the community:
Licensed under **MIT**. Additional terms and attributions are provided in `NOTICE.md`. Licensed under **MIT**. Additional terms and attributions are provided in `NOTICE.md`.
</div> </div>