Update README.md

This commit is contained in:
Iván Eduardo Chavez Ayub
2025-11-23 22:35:25 -06:00
committed by GitHub
parent d6aa49ee3b
commit 5ffe4249d6
+82 -75
View File
@@ -2,50 +2,77 @@
<div align="center"> <div align="center">
[![License](https://img.shields.io/badge/License-MIT-6A0DAD?style=for-the-badge&logo=open-source-initiative&logoColor=white)](LICENSE) [![Release](https://img.shields.io/github/v/release/Ivan-Ayub97/Warlock-Studio?style=for-the-badge&color=ff0000&labelColor=1a1a1a)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases/latest)
[![Last Commit](https://img.shields.io/github/last-commit/Ivan-Ayub97/Warlock-Studio?style=for-the-badge&color=2E8B57&logo=git&logoColor=white)](https://github.com/Ivan-Ayub97/Warlock-Studio/commits/main) [![Platform](https://img.shields.io/badge/Platform-Windows_10_%7C_11-blue?style=for-the-badge&logo=windows&labelColor=1a1a1a)](https://microsoft.com)
[![Downloads](https://img.shields.io/github/downloads/Ivan-Ayub97/Warlock-Studio/total.svg?style=for-the-badge&color=FFD700&logo=download&logoColor=black)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases) [![Python](https://img.shields.io/badge/Python-3.10+-yellow?style=for-the-badge&logo=python&logoColor=gold&labelColor=1a1a1a)](https://www.python.org/)
[![License](https://img.shields.io/badge/License-MIT-6A0DAD?style=for-the-badge&logo=open-source-initiative&logoColor=white&labelColor=1a1a1a)](LICENSE)
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**. [![Last Commit](https://img.shields.io/github/last-commit/Ivan-Ayub97/Warlock-Studio?style=for-the-badge&color=2E8B57&logo=git&logoColor=white&labelColor=1a1a1a)](https://github.com/Ivan-Ayub97/Warlock-Studio/commits/main)
[![Repo Size](https://img.shields.io/github/repo-size/Ivan-Ayub97/Warlock-Studio?style=for-the-badge&color=teal&labelColor=1a1a1a)](https://github.com/Ivan-Ayub97/Warlock-Studio)
[![GitHub Downloads](https://img.shields.io/github/downloads/Ivan-Ayub97/Warlock-Studio/total.svg?style=for-the-badge&color=FFD700&logo=github&logoColor=black&labelColor=1a1a1a&label=GH%20Downloads)](https://github.com/Ivan-Ayub97/Warlock-Studio/releases)
[![SourceForge Downloads](https://img.shields.io/sourceforge/dt/warlock-studio?style=for-the-badge&color=orange&logo=sourceforge&labelColor=1a1a1a&label=SF%20Downloads)](https://sourceforge.net/projects/warlock-studio/)
<br>
**Warlock-Studio** is a unified, high-performance platform for **upscaling, restoration, denoising, and frame interpolation**.
<br>
Inspired by [Djdefrag](https://github.com/Djdefrag) tools such as **QualityScaler** and **FluidFrames**.
</div>
--- ---
## 📥 <span style="color:#00ffcc;">Download Installer</span> ## 📥 <span style="color:#FFD700;">Download Installer</span>
<div style="color:#ccc; font-size:14px; margin-top:-6px;"> <div align="center">
You can download the installer from either option below: <p style="color:#ccc; font-size:14px;">Select your preferred mirror to download the latest version (v5.0):</p>
</div> </div>
<table style="width:100%; border-collapse:collapse;"> <table align="center" style="width:100%; border-collapse:collapse; border:none;">
<tr> <tr>
<td align="center" style="vertical-align:top; padding:px;"> <td align="center" style="vertical-align:top; width:50%; border:none; padding:20px;">
<a href="https://sourceforge.net/projects/warlock-studio/" target="_blank"> <a href="https://sourceforge.net/projects/warlock-studio/" target="_blank">
<img src="https://sourceforge.net/cdn/syndication/badge_img/3880091/oss-rising-star-black" <img src="https://sourceforge.net/cdn/syndication/badge_img/3880091/oss-rising-star-black" alt="Warlock-Studio on SourceForge" width="200" style="display:block; margin:auto; margin-bottom:15px; border-radius:5px;" />
alt="Warlock-Studio on SourceForge"
width="190" style="display:block; margin:auto; margin-bottom:1px;" />
</a> </a>
<p><i>Recommended Mirror</i></p>
</td> </td>
<td align="center" style="vertical-align:top; padding:10px;"> <td align="center" style="vertical-align:top; width:50%; border:none; padding:20px;">
<a href="https://github.com/Ivan-Ayub97/Warlock-Studio/releases/download/v5.0/Warlock-Studio-5.0-Full-Installer.exe" target="_blank"> <a href="https://github.com/Ivan-Ayub97/Warlock-Studio/releases/download/v5.0/Warlock-Studio-5.0-Full-Installer.exe" target="_blank">
<img src="rsc/GitHub_Logo_WS.png" alt="Download from GitHub" <img src="rsc/GitHub_Logo_WS.png" alt="Download from GitHub" width="300" style="display:block; margin:auto; margin-bottom:15px;" />
width="300" style="display:block; margin:auto; margin-bottom:10px;" />
</a> </a>
<p><i>Direct Release</i></p>
</td> </td>
</tr> </tr>
</table> </table>
--- ---
## 🖼️ Interface Previews ## ✨ What is New in v5.0
![interface](rsc/Capture.png) The **v5.0** release represents a foundational transformation of the application:
[Preferences.webm](https://github.com/user-attachments/assets/933003de-7618-4ed4-8815-077c69bf1ebc)
* **🧩 Modular Architecture:** The core has been re-engineered into specialized components (`core`, `preferences`, `console`, `drag_drop`) for superior stability and fault isolation.
* **🧠 NEO Engine:** A new diagnostic subsystem that scans CPU topology, RAM, and GPU VRAM to automatically recommend optimal tiling and thread settings.
* **🖥️ Integrated Debug Console:** A real-time GUI terminal that intercepts `stdout` and `stderr` with syntax highlighting, allowing users to diagnose FFmpeg or ONNX issues instantly.
* **⚡ Native CUDA & Failover:** The backend now strictly prioritizes **CUDA** (NVIDIA Optimized) > **DirectML** > **CPU**, with corrected integer typing for device IDs.
* **💎 Lossless Pipeline:** Deprecated `.jpg` usage in favor of `.png` for intermediate frames to prevent compression artifacts (blurriness).
--- ---
## 🖼️ Quality Comparison ## 🖼️ Interface Previews
<div align="center">
<img src="rsc/Capture.png" alt="Main Interface" style="border-radius: 10px; box-shadow: 0px 0px 20px rgba(0,0,0,0.5);">
</div>
<br>
### ⚙️ Preferences
[Preferences.webm](https://github.com/user-attachments/assets/933003de-7618-4ed4-8815-077c69bf1ebc)
---
## 🔍 Quality Comparison
[WsvideovsGit.webm](https://github.com/user-attachments/assets/c72f389d-827e-49b9-91b7-fd13e5b59f22) [WsvideovsGit.webm](https://github.com/user-attachments/assets/c72f389d-827e-49b9-91b7-fd13e5b59f22)
@@ -55,37 +82,27 @@ Inspired by [Djdefrag](https://github.com/Djdefrag) tools such as **QualityScale
--- ---
## ✨ Update 5.0
- **Modular Architecture (v5.0):** The code has been refactored into specialized components (`core`, `preferences`, `console`, `drag_drop`) for **superior stability, fault isolation, and code maintainability**.
- **NEO Engine:** Advanced diagnostic subsystem that scans **VRAM, RAM, and CPU topology** to generate **optimal configuration recommendations** in real-time.
- **⚙️ Centralized Preferences Panel:** Provides a quick-access **Settings Button** that opens a comprehensive panel for system management:
- **UI Control:** Customize the Theme (Light/Dark), Interface Scaling, and Window Opacity.
- **Hardware Configuration:** Adjust the **VRAM limit**, select the preferred GPU device, and configure \texttt{tiling} parameters based on **NEO Engine** data.
- **Maintenance:** Tools to clear the model cache, manage error logs, and perform online update checks.
- **Integrated Console:** A GUI terminal that intercepts `sys.stdout` and `sys.stderr` to display inference logs, errors, and warnings with **syntax highlighting** for instant debugging.
- **Native Drag & Drop:** Direct support for dragging and dropping image and video files from the operating system explorer.
- ***
## ✨ 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**.
- **Advanced Hardware Acceleration** Intelligent provider selection prioritizes **CUDA**, falls back to **DirectML**, and finally **CPU** for maximum compatibility and performance. * **Advanced Hardware Acceleration** Intelligent provider selection prioritizes **CUDA**, falls back to **DirectML**, and finally **CPU** for maximum compatibility.
- **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.
--- ---
## 🖥️ System Requirements ## 🖥️ System Requirements
- **OS:** Windows 11 or Windows 10 (64-bit) | Component | Minimum Specification | Recommended Specification |
- **RAM:** 8GB (minimum) / 16GB+ (recommended for 4K Video) | :--- | :--- | :--- |
- **GPU:** DirectX 12 compatible graphics card. NVIDIA (for CUDA), AMD, or Intel GPU with up-to-date drivers. | **OS** | Windows 10 (64-bit) | Windows 11 (64-bit) |
- **VRAM:** 4GB+ recommended. The **NEO Engine** automatically tunes limits on startup. | **RAM** | 8 GB | 16 GB+ (Recommended for 4K Video) |
- **Storage:** Sufficient free space for input and processed media. SSD highly recommended for video I/O. | **GPU** | DirectX 12 Compatible | NVIDIA RTX 3000/4000 Series (for CUDA) |
| **VRAM** | 4 GB | 8 GB+ (NEO Engine auto-tunes limits) |
| **Storage** | HDD Space | NVMe SSD (Highly recommended for RIFE) |
--- ---
@@ -93,43 +110,33 @@ Inspired by [Djdefrag](https://github.com/Djdefrag) tools such as **QualityScale
We welcome contributions from the community: We welcome contributions from the community:
**Fork** the repository. 1. **Fork** the repository.
**Create a branch** for your feature or bug fix. 2. **Create a branch** for your feature or bug fix.
**Submit a Pull Request** with a 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)**
--- ---
## 📜 License ## 📜 License & Credits
© 2025 Iván Eduardo Chavez Ayub © 2025 **Iván Eduardo Chavez Ayub**
Licensed under **MIT**. Additional terms and attributions are provided in **NOTICE.md**. <br>Licensed under **MIT**. Additional terms and attributions are provided in **NOTICE.md**.
### 📊 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) |
| 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 | 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 | [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)          | | **ONNX Runtime** | MIT | Microsoft | [GitHub](https://github.com/microsoft/onnxruntime) |
| FFmpeg        | LGPL / GPL            | FFmpeg Team                              | [Official Site](https://ffmpeg.org)                        | | **FFmpeg** | LGPL / GPL | FFmpeg Team | [Official Site](https://ffmpeg.org) |
| ExifTool      | Artistic License      | Phil Harvey                              | [Official Site](https://exiftool.org/)                      | | **ExifTool** | Artistic | Phil Harvey | [Official Site](https://exiftool.org/) |
| Python        | PSF License            | Python Software Foundation              | [Official Site](https://www.python.org)                    | | **Python** | PSF License | Python Software Foundation | [Official Site](https://www.python.org) |
| PyInstaller    | GPLv2+                | PyInstaller Team                        | [GitHub](https://github.com/pyinstaller/pyinstaller)        | | **PyInstaller** | GPLv2+ | PyInstaller Team | [GitHub](https://github.com/pyinstaller/pyinstaller) |
| Inno Setup    | Custom                | Jordan Russell                          | [Official Site](http://www.jrsoftware.org/isinfo.php)      | | **Inno Setup** | Custom | Jordan Russell | [Official Site](http://www.jrsoftware.org/isinfo.php) |
</div>