Skip to content

Commit 6a3dbf7

Browse files
authored
Update README.md
1 parent 147acc3 commit 6a3dbf7

File tree

1 file changed

+44
-29
lines changed

1 file changed

+44
-29
lines changed

README.md

Lines changed: 44 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
# 🎨 Anime Enhancement
1+
# 🎨 Anime Enhancement Suite
22

3-
**Cross-platform Python tool for anime video upscaling with neural networks.**
4-
Enhances Full HD anime to 4K (or higher) using [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN), while preserving original audio and optimizing for performance via **batching and multithreading**.
3+
**Cross-platform Python toolchain for high-quality anime video restoration using neural networks.**
4+
Upscales, denoises, and interpolates anime videos — from old 360p/480p to sharp 4K+ — while preserving original audio and optimizing for performance via **batching, parallelism, and lightweight binaries**.
55

66
<div align="center">
77
<img src="https://img.shields.io/badge/Python-3.12+-orange?logo=python" alt="Python">
88
<img src="https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS-blue" alt="Platform">
99
<img src="https://img.shields.io/badge/License-MIT-green" alt="License">
10+
<img src="https://img.shields.io/badge/Upscale-Real--ESRGAN-purple" alt="Upscale">
11+
<img src="https://img.shields.io/badge/Denoise-Waifu2x-yellow" alt="Denoise">
12+
<img src="https://img.shields.io/badge/Interpolation-RIFE-red" alt="Interpolation">
1013
</div>
1114

1215
---
1316

14-
## 🔍 Overview
17+
## 🔍 What It Does
1518

16-
- 📹 **Automatic video enhancement**: Input → extract frames → upscale → merge video/audio
17-
- 🔊 **Audio preservation**: Extracts, encodes, and merges audio back into final output
18-
-**Optimized batching**: Processes frames in parallel using threading/multiprocessing
19-
- 🧠 **Anime-specialized upscaling model**: Uses pretrained Real-ESRGAN models (animevideo-v3)
20-
- 🖥️ **Runs anywhere**: Includes platform-specific binaries (Windows, Linux, macOS)
19+
- 🎨 **Upscaling**: Enhances frames with [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN)
20+
- 🧹 **Denoising**: Removes noise/artifacts with [waifu2x-ncnn-vulkan](https://github.com/nihui/waifu2x-ncnn-vulkan)
21+
- 🎞️ **Interpolation**: Smooths motion & increases FPS with [RIFE-ncnn-vulkan](https://github.com/nihui/rife-ncnn-vulkan)
22+
- 🔊 **Audio preservation**: Extracts, encodes, and syncs back audio tracks
23+
-**Optimized performance**: Frame batching + threading/multiprocessing
24+
- 🖥️ **Cross-platform binaries included**: Works out-of-the-box on Windows, Linux, macOS
2125

2226
---
2327

@@ -41,7 +45,7 @@ poetry install
4145
### ▶️ Usage
4246
1. Place your video file in `data/input_video`;
4347
2. Set video filename in `src/config/settings.py` under `ORIGINAL_VIDEO`
44-
3. Optional: Edit `.env` or config variables (e.g. batch size, scale factor)
48+
3. (Optional) Edit `.env`or settings (batch size, scale factor, FPS, denoise strength)
4549
4. Run enhancement:
4650
```bash
4751
python main.py
@@ -50,24 +54,31 @@ poetry run python main.py
5054
```
5155
---
5256

53-
## 📦 Example
57+
## 📦 Example Workflow
5458

55-
Given: `data/input_video/naruto_war.mp4`
59+
Input: `data/input_video/naruto_war.mp4`
60+
61+
Pipeline:
62+
1. Extract audio
63+
2. Extract frames
64+
3. Apply **denoise****upscale****interpolation**
65+
4. Merge video parts
66+
5. Reattach synced audio
5667

5768
Output:
58-
- Enhanced video at `data/output_video/naruto_war_enhanced.mp4`
59-
- Audio preserved and synced
69+
- `data/output_video/naruto_war_enhanced.mp4`
6070

6171
---
6272

6373
## 🧩 Features
6474

65-
- 🔁 Frame batching to reduce memory load
66-
- 🧵 IO-bound multithreading for faster file ops
75+
- 🔁 Batch-based frame processing (low memory footprint)
76+
- 🧵 IO-bound multithreading + CPU/GPU parallelism
6777
- ⚙️ Custom Real-ESRGAN execution per OS
68-
- 🎛️ Configurable enhancement parameters (batch size, threads, model scale)
69-
- 💾 Temporary and output directory management
70-
- 📤 GUI and API interfaces under development
78+
- 🎛️ Configurable stages: enable/disable upscale, denoise, interpolation
79+
- ⚙️ Cross-OS binaries for ESRGAN, waifu2x, RIFE
80+
- 💾 Automatic cleanup of temp files
81+
- 📤 GUI and CLI (in progress)
7182

7283
---
7384

@@ -79,13 +90,15 @@ Main settings:
7990

8091
---
8192

82-
## 🧠 Technology Stack
93+
## 🧠 Tech Stack
8394

8495
- Python 3.12+
85-
- [ffmpeg](https://ffmpeg.org/) for audio/video processing
86-
- `Real-ESRGAN` for frame enhancement (binaries included for 3 OSes)
87-
- `threading`, `multiprocessing`, `asyncio` for parallelism
88-
- `poetry` for dependency management
96+
- [ffmpeg](https://ffmpeg.org/) — audio/video I/O
97+
- [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan) — upscaling
98+
- [Waifu2x](https://github.com/nihui/waifu2x-ncnn-vulkan) — denoising
99+
- [RIFE](https://github.com/nihui/rife-ncnn-vulkan) — frame interpolation
100+
- `threading`, `multiprocessing`, `asyncio` — parallel execution
101+
- `poetry` — dependency management
89102

90103
---
91104

@@ -140,11 +153,11 @@ poetry run pytest
140153

141154
## 💬 Contributing
142155

143-
Want to improve anime upscaling tools? Help is welcome!
156+
Contributions welcome!
144157

145-
- Fork the repo and create PRs
146-
- File issues or suggest features
147-
- Test on your platform and report bugs
158+
- Fork → PR
159+
- File issues & feature requests
160+
- Test across OSes & report bugs
148161

149162
---
150163

@@ -156,5 +169,7 @@ MIT License — see [LICENSE](./LICENSE) file for full text.
156169

157170
## 🧠 Credits
158171

172+
- [Waifu2x](https://github.com/nihui/waifu2x-ncnn-vulkan) by nihui
159173
- [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN) by Xintao
160-
- Inspired by anime remastering communities
174+
- [RIFE](https://github.com/nihui/rife-ncnn-vulkan) by nihui
175+
- Inspired by anime remastering communities

0 commit comments

Comments
 (0)