diff --git a/Readme.md b/Readme.md index a51f147..b03f440 100644 --- a/Readme.md +++ b/Readme.md @@ -1,20 +1,33 @@ ## Upscale Automatically upscale and interpolate video files. -### Usage -0. Preparing video file (MKVToolNix) +### Table of Contents +- [Usage](#usage) +- [Configuration](#configuration) +- [Stats](#stats) + - [Real-ESRGAN](#real-esrgan) + - [RIFE](#rife) +- [Requirements](#requirements) + - [Requirements for 1080p, 1080p@48, 4k](#requirements-for-1080p-1080p48-4k) + - [Requirements for 4k48fps](#requirements-for-4k48fps) +- [Installation](#installation) + - [Windows](#windows) + - [Arch Linux](#arch-linux) + +## Usage +1. Preparing video file (MKVToolNix) - Make sure video file does NOT have an image attachment - Video file should have ONE `ass` subtitle file - Name video file similar to the following: `Your Title - 01.mkv` -1. Place `.mkv` file inside `0-Source` folder -2. Execute `python Start.py` +2. Place `.mkv` file inside `0-Source` folder +3. Execute `python Start.py` -### Configuration +## Configuration The `Start.py` file has two options INSIDE, edit in text editor: - `INTERPOLATE_4K`: `True` or `False` (wether or not 4k48fps should be outputted) - `MAX_INPUT_WIDTH`: `'720'` (downscales the video to this width, as 1080p upscaling would be insane) -### Stats +## Stats #### Real-ESRGAN | Input | Output | VRAM | RAM | GPU | FPS | OS | @@ -26,16 +39,21 @@ The `Start.py` file has two options INSIDE, edit in text editor: | :----------: | :----------: | :----: | :----: | :----------: | :----: | :-----: | | 1080p@23.976 | 1080p@47.952 | ~6.6GB | ~4.0GB | 3090 (@360W) | ~60fps | Windows | -### Requirements +## Requirements - **OS**: Windows or Linux -- **GPU**: NVIDIA GPU with 16GB of VRAM -- **RAM**: Min: 16GB, Recommended: 32GB - **Python**: >=3.12 (Windows) or Python 3.13 (Linux) -#### Additional Requirements for 4k48fps +- **RAM**: Min: 16GB - Recommended: 32GB + +#### Requirements for 1080p, 1080p@48, 4k +- **GPU**: NVIDIA GPU with 8GB+ of VRAM + +#### Requirements for 4k48fps - **GPU**: NVIDIA GPU with 24GB of VRAM - **RAM** (Linux): 48GB (there is a memory leak in VapourSynth) -### Installation (Windows) +## Installation + +#### Windows 1. Download and install [Python 3.12](https://www.python.org/ftp/python/3.12.8/python-3.12.8-amd64.exe) - Check option to add to path 2. Download and install [Imagemagick](https://imagemagick.org/script/download.php#windows) - Check option to install legacy tools (Required for creating player previews `thumbs.vtt` and `sprite.jpg`) 3. Download and install [MKVToolNix](https://mkvtoolnix.download/downloads.html#windows) - **Add to system path environment manually** @@ -63,7 +81,7 @@ The `Start.py` file has two options INSIDE, edit in text editor: python -m vsrife ``` -### Installation (Arch Linux) +#### Arch Linux Sadly there is some sort of memory leak in vsrife or vapoursynth under Linux. If you have 32GB of RAM it should suffice for everything EXCEPT 4k48p, there you probably need 48GB or 64GB of RAM.