fixing issue #287

Adjustments to return to a single requirements.txt

.github/workflows/nightly.yml

@@ -1,7 +1,7 @@
 # Name: Video2X Nightly Build
 # Creator: K4YT3X
 # Date Created: May 12, 2020
-# Last Modified: May 13, 2020
+# Last Modified: May 28, 2020
 
 name: Video2X Nightly Build
 

Dockerfile

@@ -0,0 +1,187 @@
+# Name: Video2X Dockerfile
+# Creator: Danielle Douglas
+# Date Created: Unknown
+# Last Modified: January 14, 2020
+
+# Editor: Lhanjian
+# Last Modified: May 24, 2020
+
+# Editor: K4YT3X
+# Last Modified: May 30, 2020
+
+FROM ubuntu:19.10
+#FROM nvidia/cuda:10.1-cudnn7-devel-ubuntu18.04
+
+LABEL maintainer="Danielle Douglas <ddouglas87@gmail.com>"
+LABEL maintainer="Lhanjian <lhjay1@foxmail.com>"
+LABEL maintainer="K4YT3X <k4yt3x@k4yt3x.com>"
+
+# Don't ask questions during image setup.
+ENV DEBIAN_FRONTEND noninteractive
+ENV NASM_VERSION 2.14
+ENV NVCODEC_VERSION 8.2.15.6
+ENV PKG_CONFIG_PATH /usr/local/lib/pkgconfig
+ENV FFMPEG_VERSION 4.1.2
+
+# Install apt-fast, because we got gigs to download.
+RUN apt-get update && apt-get install -y apt-utils &&\
+    apt-get install -y --no-install-recommends software-properties-common &&\
+    add-apt-repository ppa:apt-fast/stable &&\
+    add-apt-repository -y ppa:graphics-drivers/ppa &&\
+    apt-get install -y --no-install-recommends apt-fast && apt-fast update
+
+# Install dependencies
+RUN apt-fast install -y --no-install-recommends autoconf ca-certificates curl ffmpeg frei0r-plugins-dev g++ gcc git-core gnupg2 gnutls-dev ladspa-sdk libass-dev libass-dev libbluray-dev libc6-dev libcaca-dev libcdio-paranoia-dev libchromaprint-dev libcodec2-dev libfdk-aac-dev libfdk-aac-dev libfontconfig1-dev libfreetype6-dev libfreetype6-dev libfreetype6-dev libfribidi-dev libgme-dev libgnutls28-dev libgsm1-dev libjack-dev libjack-dev liblilv-dev libmagic-dev libmagic1 libmodplug-dev libmp3lame-dev libmp3lame-dev libmysofa-dev libnuma-dev libopenal-dev libopencore-amrnb-dev libopencore-amrwb-dev libopenjp2-7-dev libopenmpt-dev libopus-dev libopus-dev libpulse-dev librsvg2-dev librtmp-dev librubberband-dev libsdl2-dev libsdl2-dev libshine-dev libsmbclient-dev libsnappy-dev libsoxr-dev libspeex-dev libssh-dev libtesseract-dev libtheora-dev libtool libtwolame-dev libv4l-dev libva-dev libva-dev libvdpau-dev libvdpau-dev libvo-amrwbenc-dev libvorbis-dev libvorbis-dev libvorbis-dev libvpx-dev libvpx-dev libwavpack-dev libwebp-dev libx264-dev libx264-dev libx265-dev libx265-dev libxcb-shm0-dev libxcb-shm0-dev libxcb-xfixes0-dev libxcb-xfixes0-dev libxcb1-dev libxcb1-dev libxml2-dev libxvidcore-dev libzmq3-dev libzvbi-dev nvidia-cuda-toolkit nvidia-driver-440 opencl-dev p11-kit pkg-config pkg-config python3-dev python3-pip python3-setuptools python3-wheel python3.8 texinfo texinfo wget wget yasm zlib1g-dev zlib1g-dev
+
+# Install NASM
+RUN curl -vfsSLO https://www.nasm.us/pub/nasm/releasebuilds/$NASM_VERSION/nasm-$NASM_VERSION.tar.bz2 \
+    && tar -xjf nasm-$NASM_VERSION.tar.bz2 \
+    && cd nasm-$NASM_VERSION \
+    && ./autogen.sh \
+    && ./configure \
+    && make -j$(nproc) \
+    && make install
+
+# Compile FFmpeg with CUDA support
+
+RUN git clone --recurse-submodules -b n$NVCODEC_VERSION --depth 1 https://git.videolan.org/git/ffmpeg/nv-codec-headers \
+    && cd nv-codec-headers \
+    && make install
+
+RUN curl -vfsSLO https://ffmpeg.org/releases/ffmpeg-$FFMPEG_VERSION.tar.bz2 \
+    && tar -xjf ffmpeg-$FFMPEG_VERSION.tar.bz2 \
+    && cd ffmpeg-$FFMPEG_VERSION \
+    && ./configure --enable-cuda-sdk --enable-cuvid --enable-nonfree --enable-libnpp --enable-nvenc \
+    --enable-gpl --enable-version3 \
+    --enable-small --enable-avisynth --enable-chromaprint \
+    --enable-frei0r --enable-gmp --enable-gnutls --enable-ladspa \
+    --enable-libass --enable-libcaca --enable-libcdio \
+    --enable-libcodec2 --enable-libfontconfig --enable-libfreetype \
+    --enable-libfribidi --enable-libgme --enable-libgsm --enable-libjack \
+    --enable-libmodplug --enable-libmp3lame --enable-libopencore-amrnb \
+    --enable-libopencore-amrwb --enable-libopencore-amrwb \
+    --enable-libopenjpeg --enable-libopenmpt --enable-libopus --enable-libpulse \
+    --enable-librsvg --enable-librubberband --enable-librtmp --enable-libshine \
+    --enable-libsnappy --enable-libsoxr --enable-libspeex \
+    --enable-libssh --enable-libtesseract --enable-libtheora \
+    --enable-libtwolame --enable-libv4l2 --enable-libvo-amrwbenc \
+    --enable-libvorbis --enable-libvpx --enable-libwavpack --enable-libwebp \
+    --enable-libx264 --enable-libx265 --enable-libxvid --enable-libxml2 \
+    --enable-libzmq --enable-libzvbi --enable-lv2 \
+    --enable-libmysofa \
+    --enable-openal --enable-opencl --enable-opengl --enable-libdrm \
+    --enable-libfdk-aac --enable-libbluray \
+    && make -j$(nproc) \
+    && make install
+
+# Add Nvidia's machine-learning repository for libcudnn7 and libcudnn7-dev
+RUN curl -fsSL https://developer.download.nvidia.com/compute/cuda/repos/ubuntu1804/x86_64/7fa2af80.pub | apt-key add - &&\
+    echo "deb https://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu1804/x86_64 /" > /etc/apt/sources.list.d/nvidia-ml.list
+
+# Install Video2X
+RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.7 1 && update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.8 2
+RUN cd / && python3.8 -m pip install --upgrade pip &&\
+    git clone --recurse-submodules --progress https://github.com/k4yt3x/video2x.git --depth=1 &&\
+    python3.8 -m pip install -U -r video2x/src/requirements.txt
+
+# Compile drivers
+
+# example: docker build -t video2x . --build-arg driver=waifu2x_ncnn_vulkan
+ARG driver=all
+
+# Check if driver exists.
+SHELL ["/bin/bash", "-c"]
+RUN drivers=(all waifu2x_caffe waifu2x_converter waifu2x_ncnn_vulkan) &&\
+    case ${drivers[@]} in (*${driver,,}*) true ;; (*)\
+    echo "ERROR: Unrecognized driver." >&2 &&\
+    printf "%s " "Choices are: ${drivers[@]}" >&2 | printf "\n" >&2 &&\
+    exit 1 ;;\
+    esac
+
+RUN if [ "$driver" = "all" ] || [ "$driver" = "waifu2x_caffe" ] ; then \
+    # nagadomi/caffe prerequisites
+    apt-fast update &&\
+    apt-fast install -y --no-install-recommends build-essential cmake libboost-system-dev libboost-thread-dev libboost-filesystem-dev libboost-chrono-dev libboost-date-time-dev libboost-atomic-dev libboost-python-dev libprotobuf-dev protobuf-compiler libhdf5-dev liblmdb-dev libleveldb-dev libsnappy-dev libopencv-dev libatlas-base-dev python-numpy libgflags-dev libgoogle-glog-dev &&\
+    # nagadomi/waifu2x-caffee-ubuntu prerequisites
+    apt-fast install -y --no-install-recommends libboost-iostreams-dev;\
+    fi
+# build waifu2x-caffe && install caffe
+RUN if [ "$driver" = "all" ] || [ "$driver" = "waifu2x_caffe" ] ; then \
+    git clone --recurse-submodules --depth=1 --progress --recurse-submodules https://github.com/nagadomi/waifu2x-caffe-ubuntu.git &&\
+    cd waifu2x-caffe-ubuntu &&\
+    git clone --recurse-submodules --progress --depth=1 https://github.com/nagadomi/caffe.git;\
+    fi
+
+RUN if [ "$driver" = "all" ] || [ "$driver" = "waifu2x_caffe" ] ; then \
+    apt-fast install --no-install-recommends -y gcc-8 libcudnn7 libcudnn7-dev &&\
+    apt-get remove -y gcc g++ &&\
+    ln -s /usr/bin/gcc-8 /usr/bin/gcc && ln -s /usr/bin/g++-8 /usr/bin/g++ &&\
+    cd /waifu2x-caffe-ubuntu &&\
+    mkdir build &&\
+    cd build &&\
+    cmake .. -DCMAKE_INSTALL_PREFIX=/usr &&\
+    make -j$(nproc) install;\
+    fi
+
+RUN if [ "$driver" = "all" ] || [ "$driver" = "waifu2x_caffe" ] ; then \
+    # install waifu2x-caffe
+    cd /waifu2x-caffe-ubuntu/build &&\
+    cp waifu2x-caffe ../bin/ &&\
+    mv ../bin tempname &&\
+    mv tempname /video2x/ &&\
+    mv /video2x/tempname /video2x/waifu2x-caffe &&\
+    rm -rf ../waifu2x-caffe-ubuntu ;\
+    fi
+
+RUN if [ "$driver" = "all" ] || [ "$driver" = "waifu2x_ncnn_vulkan" ] ; then \
+    apt-fast install -y --no-install-recommends software-properties-common build-essential cmake libvulkan-dev glslang-tools libprotobuf-dev protobuf-compiler &&\
+    git clone --recurse-submodules --depth=1 --progress https://github.com/Tencent/ncnn.git &&\
+    cd ncnn &&\
+    mkdir -p build &&\
+    cd build &&\
+    cmake -DCMAKE_INSTALL_PREFIX=/usr -DNCNN_VULKAN=ON .. &&\
+    make -j$(nproc) install &&\
+    rm -rf ../../ncnn &&\
+    cd / &&\
+    # Compile waifu2x-ncnn-vulkan
+    git clone --recurse-submodules --depth=1 --progress https://github.com/nihui/waifu2x-ncnn-vulkan.git &&\
+    cd waifu2x-ncnn-vulkan &&\
+    mkdir -p build &&\
+    cd build &&\
+    cmake ../src &&\
+    make -j$(nproc) &&\
+    # Incall waifu2x-ncnn-vulkan
+    cd /waifu2x-ncnn-vulkan &&\
+    mkdir waifu2x-ncnn-vulkan &&\
+    mv models/models-cunet waifu2x-ncnn-vulkan/ &&\
+    mv build/waifu2x-ncnn-vulkan waifu2x-ncnn-vulkan/ &&\
+    mv waifu2x-ncnn-vulkan /video2x/ &&\
+    rm -rf ../waifu2x-ncnn-vulkan ;\
+    fi
+
+RUN if [ "$driver" = "all" ] || [ "$driver" = "waifu2x_converter" ] ;\
+    then \
+    # Prerequisits for waifu2x-converter-cpp
+    apt-fast install -y --no-install-recommends build-essential cmake libopencv-dev ocl-icd-opencl-dev &&\
+    # Compile & Install
+    git clone --recurse-submodules --depth=1 --progress https://github.com/DeadSix27/waifu2x-converter-cpp &&\
+    cd waifu2x-converter-cpp &&\
+    mkdir build &&\
+    cd build &&\
+    cmake .. &&\
+    make -j$(nproc) &&\
+    #ldconfig &&\
+    cp -r ../models_rgb ./&&\
+    cd / ;\
+    fi
+
+# Go!
+#COPY entrypoint.sh /
+#ENTRYPOINT ["/entrypoint.sh"]
+
+WORKDIR /host
+ENTRYPOINT ["python3", "/video2x/src/video2x.py"]
+
+ENV NVIDIA_DRIVER_CAPABILITIES all
+# Docker image can ask questions now, if needed.
+ENV DEBIAN_FRONTEND teletype

README.md

@@ -4,10 +4,11 @@
 
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/k4yt3x/video2x?style=flat-square)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/k4yt3x/video2x/Video2X%20Nightly%20Build?label=Nightly&style=flat-square)
+![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/k4yt3x/video2x?style=flat-square)
 ![GitHub All Releases](https://img.shields.io/github/downloads/k4yt3x/video2x/total?style=flat-square)
 ![GitHub](https://img.shields.io/github/license/k4yt3x/video2x?style=flat-square)
 ![Platforms](https://img.shields.io/badge/Platforms-Windows%20%7C%20Linux%20%7C%20macOS-blue?style=flat-square)
-<img alt="Become a Patron!" src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" href="https://www.patreon.com/bePatron?u=34970782" height=20>
+![Become A Patron!](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fk4yt3x&style=flat-square)
 
 <!--# Video2X Lossless Video Enlarger-->
 
@@ -32,7 +33,16 @@ To download the latest nightly build, go to the [GitHub Actions](https://github.
 
 ## Introduction
 
-Video2X is a video/GIF/image upscaling software based on Waifu2X, Anime4K and SRMD written in Python 3. It upscales videos, GIFs and images, restoring details from low-resolution inputs. Video2X also accepts GIF input to video output and video input to GIF output.
+Video2X is a video/GIF/image upscaling software based on Waifu2X, Anime4K, SRMD and RealSR written in Python 3. It upscales videos, GIFs and images, restoring details from low-resolution inputs. Video2X also accepts GIF input to video output and video input to GIF output.
+
+Currently, Video2X supports the following drivers (implementations of algorithms).
+
+- **Waifu2X Caffe**: Caffe implementation of waifu2x
+- **Waifu2X Converter CPP**: CPP implementation of waifu2x based on OpenCL and OpenCV
+- **Waifu2X NCNN Vulkan**: NCNN implementation of waifu2x based on Vulkan API
+- **SRMD NCNN Vulkan**: NCNN implementation of SRMD based on Vulkan API
+- **RealSR NCNN Vulkan**: NCNN implementation of RealSR based on Vulkan API
+- **Anime4KCPP**: CPP implementation of Anime4K
 
 ### Video Upscaling
 
@@ -170,6 +180,14 @@ To see a help page for driver-specific settings, use `-d` to select the driver a
 python video2x.py -d waifu2x_caffe -- --help
 ```
 
+### Running Video2X (Docker)
+
+Video2X can be deployed via Docker.
+
+```shell
+docker pull k4yt3x/video2x
+```
+
 ---
 
 ## Documentations
@@ -216,6 +234,12 @@ Are you interested in how the idea of Video2X was born? Do you want to know the
 ### -c CONFIG, --config CONFIG
     video2x config file path
 
+### --log LOG
+    log file path (default: program_directory\video2x_%Y-%m-%d_%H-%M-%S.log)
+
+### --nolog
+    disable logging (default: False)
+
 ### -v, --version
     display version, lawful information and exit
 
@@ -230,6 +254,7 @@ Available options are:
 - waifu2x_converter_cpp
 - waifu2x_ncnn_vulkan
 - srmd_ncnn_vulkan
+- realsr_ncnn_vulkan
 - anime4kcpp
 
 ### -r RATIO, --ratio RATIO
@@ -261,16 +286,19 @@ This project relies on the following software and projects.
 - [waifu2x-converter-cpp](https://github.com/DeadSix27/waifu2x-converter-cpp)
 - [waifu2x-ncnn-vulkan](https://github.com/nihui/waifu2x-ncnn-vulkan)
 - [srmd-ncnn-vulkan](https://github.com/nihui/srmd-ncnn-vulkan)
+- [realsr-ncnn-vulkan](https://github.com/nihui/realsr-ncnn-vulkan)
 - [Anime4K](https://github.com/bloc97/Anime4K)
 - [Anime4KCPP](https://github.com/TianZerL/Anime4KCPP)
 - [Gifski](https://github.com/ImageOptim/gifski)
 
 ## Special Thanks
 
-Appreciations given to the following code contributors:
+Appreciations given to the following personnel who have contributed significantly to the project (specifically the technical perspective).
 
-- @BrianPetkovsek
-- @SAT3LL
+- [@BrianPetkovsek](https://github.com/BrianPetkovsek)
+- [@sat3ll](https://github.com/sat3ll)
+- [@ddouglas87](https://github.com/ddouglas87)
+- [@lhanjian](https://github.com/lhanjian)
 
 ## Related Projects
 

src/bilogger.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Creator: Video2X Bidirectional Logger
+Author: K4YT3X
+Date Created: June 4, 2020
+Last Modified: June 4, 2020
+"""
+
+# built-in imports
+import _io
+import pathlib
+
+
+class BiLogger(object):
+    """ A bidirectional logger that both prints the output
+    and log all output to file.
+
+    Original code from: https://stackoverflow.com/a/14906787
+    """
+
+    def __init__(self, terminal: _io.TextIOWrapper, logfile: pathlib.Path):
+        """ initialize BiLogger
+
+        Args:
+            terminal (_io.TextIOWrapper): original terminal IO wrapper
+            logfile (pathlib.Path): target log file path object
+        """
+        self.terminal = terminal
+        self.log = logfile.open(mode='a+')
+
+    def write(self, message: str):
+        """ write message to original terminal output and log file
+
+        Args:
+            message (str): message to write
+        """
+        self.terminal.write(message)
+        self.terminal.flush()
+        self.log.write(message)
+        self.log.flush()
+
+    def flush(self):
+        """ flush logger (for compability only)
+        """
+        pass

src/build.ps1

@@ -9,7 +9,7 @@ executable (PE) releases automatically using PyInstaller.
 This script is currently only tuned for K4YT3X's environment.
 
 To start a PowerShell session with execution policy bypass
-powershell –ExecutionPolicy Bypass
+powershell -ExecutionPolicy Bypass
 #>
 
 if ($args.count -ne 1){

src/requirements.txt

@@ -1,11 +1,9 @@
 avalon_framework
 colorama
 patool
-psutil
 pyqt5
-python-magic
-python-magic-bin
-pyunpack
+python-magic; platform_system != "Windows"
+python-magic-bin; platform_system == "Windows"
 pyyaml
 requests
 tqdm

src/upscaler.py

@@ -4,7 +4,7 @@
 Name: Video2X Upscaler
 Author: K4YT3X
 Date Created: December 10, 2018
-Last Modified: May 22, 2020
+Last Modified: June 4, 2020
 
 Description: This file contains the Upscaler class. Each
 instance of the Upscaler class is an upscaler on an image or
@@ -50,7 +50,7 @@ language.install()
 _ = language.gettext
 
 # version information
-UPSCALER_VERSION = '4.1.1'
+UPSCALER_VERSION = '4.2.1'
 
 # these names are consistent for
 # - driver selection in command line
@@ -60,6 +60,7 @@ AVAILABLE_DRIVERS = ['waifu2x_caffe',
                      'waifu2x_converter_cpp',
                      'waifu2x_ncnn_vulkan',
                      'srmd_ncnn_vulkan',
+                     'realsr_ncnn_vulkan',
                      'anime4kcpp']
 
 
@@ -281,7 +282,7 @@ class Upscaler:
             process_directory.mkdir(parents=True, exist_ok=True)
 
         # waifu2x-converter-cpp will perform multi-threading within its own process
-        if self.driver in ['waifu2x_converter_cpp', 'waifu2x_ncnn_vulkan', 'srmd_ncnn_vulkan']:
+        if self.driver in ['waifu2x_converter_cpp', 'waifu2x_ncnn_vulkan', 'srmd_ncnn_vulkan', 'realsr_ncnn_vulkan', 'anime4kcpp']:
             process_directories = [self.extracted_frames]
 
         else:
@@ -468,9 +469,12 @@ class Upscaler:
                 self.current_input_file, output_path = self.processing_queue.get()
 
                 # get file type
-                input_file_mime_type = magic.from_file(str(self.current_input_file.absolute()), mime=True)
-                input_file_type = input_file_mime_type.split('/')[0]
-                input_file_subtype = input_file_mime_type.split('/')[1]
+                try:
+                    input_file_mime_type = magic.from_file(str(self.current_input_file.absolute()), mime=True)
+                    input_file_type = input_file_mime_type.split('/')[0]
+                    input_file_subtype = input_file_mime_type.split('/')[1]
+                except magic.magic.MagicException:
+                    input_file_type = input_file_subtype = None
 
                 # in case python-magic fails to detect file type
                 # try guessing file mime type with mimetypes

src/video2x.py

@@ -13,7 +13,7 @@ __      __  _       _                  ___   __   __
 Name: Video2X Controller
 Creator: K4YT3X
 Date Created: Feb 24, 2018
-Last Modified: May 23, 2020
+Last Modified: June 4, 2020
 
 Editor: BrianPetkovsek
 Last Modified: June 17, 2019
@@ -49,12 +49,14 @@ smooth and edges sharp.
 """
 
 # local imports
+from bilogger import BiLogger
 from upscaler import AVAILABLE_DRIVERS
 from upscaler import UPSCALER_VERSION
 from upscaler import Upscaler
 
 # built-in imports
 import argparse
+import datetime
 import gettext
 import importlib
 import locale
@@ -79,8 +81,7 @@ language = gettext.translation(DOMAIN, LOCALE_DIRECTORY, [default_locale], fallb
 language.install()
 _ = language.gettext
 
-
-CLI_VERSION = '4.0.1'
+CLI_VERSION = '4.1.0'
 
 LEGAL_INFO = _('''Video2X CLI Version: {}
 Upscaler Version: {}
@@ -118,6 +119,9 @@ def parse_arguments():
 
     video2x_options.add_argument('-c', '--config', type=pathlib.Path, help=_('video2x config file path'), action='store',
                                  default=pathlib.Path(__file__).parent.absolute() / 'video2x.yaml')
+    video2x_options.add_argument('--log', type=pathlib.Path, help=_('log file path'),
+                                 default=pathlib.Path(__file__).parent.absolute() / f'video2x_{datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S")}.log')
+    video2x_options.add_argument('--nolog', help=_('disable logging'), action='store_true')
     video2x_options.add_argument('-v', '--version', help=_('display version, lawful information and exit'), action='store_true')
 
     # scaling options
@@ -179,6 +183,13 @@ if video2x_args.version:
     print(LEGAL_INFO)
     sys.exit(0)
 
+# redirect output to both terminal and log file
+if video2x_args.nolog is False:
+    LOGFILE = video2x_args.log
+    Avalon.debug_info(_('Redirecting console logs to {}').format(LOGFILE))
+    sys.stdout = BiLogger(sys.stdout, LOGFILE)
+    sys.stderr = BiLogger(sys.stderr, LOGFILE)
+
 # read configurations from configuration file
 config = read_config(video2x_args.config)
 

src/video2x.yaml

@@ -1,7 +1,7 @@
 # Name: Video2X Configuration File
 # Creator: K4YT3X
 # Date Created: October 23, 2018
-# Last Modified: May 23, 2020
+# Last Modified: May 29, 2020
 # Values here are the default values. Change the value here to
 #   save the default value permanently.
 # Items commented out are parameters irrelevant to this context
@@ -76,6 +76,17 @@ srmd_ncnn_vulkan:
   g: 0 # gpu device to use (default=0)
   j: '1:2:2' # thread count for load/proc/save (default=1:2:2)
   x: false # enable tta mode
+realsr_ncnn_vulkan:
+  path: '%LOCALAPPDATA%\video2x\realsr-ncnn-vulkan\realsr-ncnn-vulkan'
+  v: null # verbose output
+  #i: null # input-path: input image path (jpg/png) or directory
+  #o: null # output-path: output image path (png) or directory
+  s: 4 # upscale ratio (4, default=4)
+  t: 0 # tile size (>=32/0=auto, default=0)
+  m: null # realsr model path (default=models-DF2K)
+  g: 0 # gpu device to use (default=0)
+  j: '1:2:2' # thread count for load/proc/save (default=1:2:2)
+  x: false # enable tta mode
 anime4kcpp:
   path: '%LOCALAPPDATA%\video2x\anime4kcpp\CLI\Anime4KCPP_CLI\Anime4KCPP_CLI'
   #input: null # File for loading (string [=./pic/p1.png])
@@ -156,6 +167,6 @@ gifski:
   nosort: false # Use files exactly in the order given, rather than sorted
   quiet: false # Do not show a progress bar
 video2x:
-  video2x_cache_directory: null # default: %TEMP%\video2x
-  image_format: png
-  preserve_frames: false
+  video2x_cache_directory: null # default: %TEMP%\video2x, directory where cache files are stored, will be deleted if preserve_frames is not set to true
+  image_format: png # png/jpg intermediate file format used for extracted frames during video processing
+  preserve_frames: false # if set to true, the cache directory won't be cleaned upon task completion

src/video2x_gui.py

@@ -4,16 +4,18 @@
 Creator: Video2X GUI
 Author: K4YT3X
 Date Created: May 5, 2020
-Last Modified: May 23, 2020
+Last Modified: June 4, 2020
 """
 
 # local imports
+from bilogger import BiLogger
 from upscaler import UPSCALER_VERSION
 from upscaler import Upscaler
 from wrappers.ffmpeg import Ffmpeg
 
 # built-in imports
 import contextlib
+import datetime
 import json
 import mimetypes
 import os
@@ -32,7 +34,7 @@ from PyQt5.QtGui import *
 from PyQt5.QtWidgets import *
 import magic
 
-GUI_VERSION = '2.4.0'
+GUI_VERSION = '2.6.0'
 
 LEGAL_INFO = f'''Video2X GUI Version: {GUI_VERSION}\\
 Upscaler Version: {UPSCALER_VERSION}\\
@@ -46,6 +48,7 @@ AVAILABLE_DRIVERS = {
     'Waifu2X Converter CPP': 'waifu2x_converter_cpp',
     'Waifu2X NCNN Vulkan': 'waifu2x_ncnn_vulkan',
     'SRMD NCNN Vulkan': 'srmd_ncnn_vulkan',
+    'RealSR NCNN Vulkan': 'realsr_ncnn_vulkan',
     'Anime4KCPP': 'anime4kcpp'
 }
 
@@ -130,9 +133,12 @@ class InputTableModel(QAbstractTableModel):
                 # if path is single file
                 # determine file type
                 elif file_path.is_file():
-                    input_file_mime_type = magic.from_file(str(file_path.absolute()), mime=True)
-                    input_file_type = input_file_mime_type.split('/')[0]
-                    input_file_subtype = input_file_mime_type.split('/')[1]
+                    try:
+                        input_file_mime_type = magic.from_file(str(file_path.absolute()), mime=True)
+                        input_file_type = input_file_mime_type.split('/')[0]
+                        input_file_subtype = input_file_mime_type.split('/')[1]
+                    except magic.magic.MagicException:
+                        input_file_type = input_file_subtype = None
 
                     # in case python-magic fails to detect file type
                     # try guessing file mime type with mimetypes
@@ -186,6 +192,9 @@ class Video2XMainWindow(QMainWindow):
         super().__init__(*args, **kwargs)
         uic.loadUi(str(resource_path('video2x_gui.ui')), self)
 
+        # generate log file name
+        self.logfile = pathlib.Path(__file__).parent.absolute() / f'video2x_{datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S")}.log'
+
         # create thread pool for upscaler workers
         self.threadpool = QThreadPool()
 
@@ -346,6 +355,17 @@ class Video2XMainWindow(QMainWindow):
         self.srmd_ncnn_vulkan_jobs_line_edit = self.findChild(QLineEdit, 'srmdNcnnVulkanJobsLineEdit')
         self.srmd_ncnn_vulkan_tta_check_box = self.findChild(QCheckBox, 'srmdNcnnVulkanTtaCheckBox')
 
+        # realsr-ncnn-vulkan
+        self.realsr_ncnn_vulkan_path_line_edit = self.findChild(QLineEdit, 'realsrNcnnVulkanPathLineEdit')
+        self.enable_line_edit_file_drop(self.realsr_ncnn_vulkan_path_line_edit)
+        self.realsr_ncnn_vulkan_path_select_button = self.findChild(QPushButton, 'realsrNcnnVulkanPathSelectButton')
+        self.realsr_ncnn_vulkan_path_select_button.clicked.connect(lambda: self.select_driver_binary_path(self.realsr_ncnn_vulkan_path_line_edit))
+        self.realsr_ncnn_vulkan_tile_size_spin_box = self.findChild(QSpinBox, 'realsrNcnnVulkanTileSizeSpinBox')
+        self.realsr_ncnn_vulkan_model_combo_box = self.findChild(QComboBox, 'realsrNcnnVulkanModelComboBox')
+        self.realsr_ncnn_vulkan_gpu_id_spin_box = self.findChild(QSpinBox, 'realsrNcnnVulkanGpuIdSpinBox')
+        self.realsr_ncnn_vulkan_jobs_line_edit = self.findChild(QLineEdit, 'realsrNcnnVulkanJobsLineEdit')
+        self.realsr_ncnn_vulkan_tta_check_box = self.findChild(QCheckBox, 'realsrNcnnVulkanTtaCheckBox')
+
         # anime4k
         self.anime4kcpp_path_line_edit = self.findChild(QLineEdit, 'anime4kCppPathLineEdit')
         self.enable_line_edit_file_drop(self.anime4kcpp_path_line_edit)
@@ -497,6 +517,14 @@ class Video2XMainWindow(QMainWindow):
         self.srmd_ncnn_vulkan_jobs_line_edit.setText(settings['j'])
         self.srmd_ncnn_vulkan_tta_check_box.setChecked(settings['x'])
 
+        # realsr-ncnn-vulkan
+        settings = self.config['realsr_ncnn_vulkan']
+        self.realsr_ncnn_vulkan_path_line_edit.setText(str(pathlib.Path(os.path.expandvars(settings['path'])).absolute()))
+        self.realsr_ncnn_vulkan_tile_size_spin_box.setValue(settings['t'])
+        self.realsr_ncnn_vulkan_gpu_id_spin_box.setValue(settings['g'])
+        self.realsr_ncnn_vulkan_jobs_line_edit.setText(settings['j'])
+        self.realsr_ncnn_vulkan_tta_check_box.setChecked(settings['x'])
+
         # anime4k
         settings = self.config['anime4kcpp']
         self.anime4kcpp_path_line_edit.setText(str(pathlib.Path(os.path.expandvars(settings['path'])).absolute()))
@@ -598,6 +626,14 @@ class Video2XMainWindow(QMainWindow):
         self.config['srmd_ncnn_vulkan']['j'] = self.srmd_ncnn_vulkan_jobs_line_edit.text()
         self.config['srmd_ncnn_vulkan']['x'] = self.srmd_ncnn_vulkan_tta_check_box.isChecked()
 
+        # realsr-ncnn-vulkan
+        self.config['realsr_ncnn_vulkan']['path'] = os.path.expandvars(self.realsr_ncnn_vulkan_path_line_edit.text())
+        self.config['realsr_ncnn_vulkan']['t'] = self.realsr_ncnn_vulkan_tile_size_spin_box.value()
+        self.config['realsr_ncnn_vulkan']['m'] = str((pathlib.Path(self.config['realsr_ncnn_vulkan']['path']).parent / self.realsr_ncnn_vulkan_model_combo_box.currentText()).absolute())
+        self.config['realsr_ncnn_vulkan']['g'] = self.realsr_ncnn_vulkan_gpu_id_spin_box.value()
+        self.config['realsr_ncnn_vulkan']['j'] = self.realsr_ncnn_vulkan_jobs_line_edit.text()
+        self.config['realsr_ncnn_vulkan']['x'] = self.realsr_ncnn_vulkan_tta_check_box.isChecked()
+
         # anime4k
         self.config['anime4kcpp']['path'] = os.path.expandvars(self.anime4kcpp_path_line_edit.text())
         self.config['anime4kcpp']['passes'] = self.anime4kcpp_passes_spin_box.value()
@@ -788,6 +824,10 @@ class Video2XMainWindow(QMainWindow):
             self.scale_ratio_double_spin_box.setMinimum(2.0)
             self.scale_ratio_double_spin_box.setMaximum(4.0)
             self.scale_ratio_double_spin_box.setValue(2.0)
+        elif current_driver == 'realsr_ncnn_vulkan':
+            self.scale_ratio_double_spin_box.setMinimum(4.0)
+            self.scale_ratio_double_spin_box.setMaximum(4.0)
+            self.scale_ratio_double_spin_box.setValue(4.0)
 
         # update preferred processes/threads count
         if current_driver == 'anime4kcpp':
@@ -802,12 +842,9 @@ class Video2XMainWindow(QMainWindow):
         self.input_table_view.setModel(self.input_table_model)
 
     def input_table_delete_selected(self):
-        items_to_delete = []
-        for index in [i.row() for i in self.input_table_view.selectedIndexes()]:
-            items_to_delete.append(self.input_table_data[index])
-
-        for item in items_to_delete:
-            self.input_table_data.remove(item)
+        indexes_to_delete = [i.row() for i in self.input_table_view.selectedIndexes()]
+        for index in sorted(indexes_to_delete, reverse=True):
+            del self.input_table_data[index]
 
         self.update_output_path()
         self.update_input_table()
@@ -858,9 +895,12 @@ class Video2XMainWindow(QMainWindow):
             if input_path.is_file():
 
                 # generate suffix automatically
-                input_file_mime_type = magic.from_file(str(input_path.absolute()), mime=True)
-                input_file_type = input_file_mime_type.split('/')[0]
-                input_file_subtype = input_file_mime_type.split('/')[1]
+                try:
+                    input_file_mime_type = magic.from_file(str(input_path.absolute()), mime=True)
+                    input_file_type = input_file_mime_type.split('/')[0]
+                    input_file_subtype = input_file_mime_type.split('/')[1]
+                except magic.magic.MagicException:
+                    input_file_type = input_file_subtype = None
 
                 # in case python-magic fails to detect file type
                 # try guessing file mime type with mimetypes
@@ -994,8 +1034,9 @@ class Video2XMainWindow(QMainWindow):
 {}\\
 Check the console output for details.\\
 When reporting an error, please include console output.\\
-You can [submit an issue on GitHub](https://github.com/k4yt3x/video2x/issues/new?assignees=K4YT3X&labels=bug&template=bug-report.md&title={}) to report this error.'''
-        message_box.setText(error_message.format(exception, urllib.parse.quote(str(exception))))
+You can [submit an issue on GitHub](https://github.com/k4yt3x/video2x/issues/new?assignees=K4YT3X&labels=bug&template=bug-report.md&title={}) to report this error.\\
+It\'s also highly recommended for you to attach the [log file]({}) under the programs\'s parent folder named {}.'''
+        message_box.setText(error_message.format(exception, urllib.parse.quote(str(exception)), self.logfile.as_uri(), self.logfile.name))
         message_box.exec_()
 
     def progress_monitor(self, progress_callback: pyqtSignal):
@@ -1099,6 +1140,10 @@ You can [submit an issue on GitHub](https://github.com/k4yt3x/video2x/issues/new
                 self.show_warning('Output path unspecified')
                 return
 
+            print(f'Redirecting console logs to {self.logfile}', file=sys.stderr)
+            sys.stdout = BiLogger(sys.stdout, self.logfile)
+            sys.stderr = BiLogger(sys.stderr, self.logfile)
+
             if len(self.input_table_data) == 1:
                 input_directory = self.input_table_data[0]
             else:

src/video2x_gui.pyproject.user

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 4.12.0, 2020-05-23T08:51:47. -->
+<!-- Written by QtCreator 4.12.0, 2020-05-26T06:35:20. -->
 <qtcreator>
  <data>
   <variable>EnvironmentId</variable>

src/video2x_gui.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>673</width>
-    <height>802</height>
+    <height>844</height>
    </rect>
   </property>
   <property name="acceptDrops">
@@ -342,6 +342,11 @@
                    <string>SRMD NCNN Vulkan</string>
                   </property>
                  </item>
+                 <item>
+                  <property name="text">
+                   <string>RealSR NCNN Vulkan</string>
+                  </property>
+                 </item>
                  <item>
                   <property name="text">
                    <string>Anime4KCPP</string>
@@ -1384,6 +1389,131 @@
             </item>
            </layout>
           </widget>
+          <widget class="QWidget" name="realsrNcnnVulkanTab">
+           <attribute name="title">
+            <string>RealSR NCNN Vulkan</string>
+           </attribute>
+           <layout class="QVBoxLayout" name="verticalLayout_34">
+            <item>
+             <layout class="QHBoxLayout" name="realsrNcnnVulkanPathHorizontalLayout">
+              <item>
+               <widget class="QLineEdit" name="realsrNcnnVulkanPathLineEdit"/>
+              </item>
+              <item>
+               <widget class="QPushButton" name="realsrNcnnVulkanPathSelectButton">
+                <property name="text">
+                 <string>Select Binary Path</string>
+                </property>
+               </widget>
+              </item>
+             </layout>
+            </item>
+            <item>
+             <layout class="QHBoxLayout" name="realsrNcnnVulkanTileSizeHorizontalLayout">
+              <item>
+               <widget class="QLabel" name="realsrNcnnVulkanTileSizeLabel">
+                <property name="text">
+                 <string>Tile Size</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="QSpinBox" name="realsrNcnnVulkanTileSizeSpinBox">
+                <property name="minimum">
+                 <number>0</number>
+                </property>
+                <property name="maximum">
+                 <number>99999</number>
+                </property>
+                <property name="value">
+                 <number>0</number>
+                </property>
+               </widget>
+              </item>
+             </layout>
+            </item>
+            <item>
+             <layout class="QHBoxLayout" name="realsrNcnnVulkanModelHorizontalLayout">
+              <item>
+               <widget class="QLabel" name="realsrNcnnVulkanModelLabel">
+                <property name="text">
+                 <string>Model</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="QComboBox" name="realsrNcnnVulkanModelComboBox">
+                <property name="toolTip">
+                 <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;If the input file contains very little noise, DF2K will produce sharper outputs.&lt;/p&gt;&lt;p&gt;However, if the input is noisy, DF2K might produce artifacts. DF2K_JPEG will then be preferred.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+                </property>
+                <item>
+                 <property name="text">
+                  <string>models-DF2K_JPEG</string>
+                 </property>
+                </item>
+                <item>
+                 <property name="text">
+                  <string>models-DF2K</string>
+                 </property>
+                </item>
+               </widget>
+              </item>
+             </layout>
+            </item>
+            <item>
+             <layout class="QHBoxLayout" name="realsrNcnnVulkanGpuIdHorizontalLayout">
+              <item>
+               <widget class="QLabel" name="realsrNcnnVulkanGpuIdLabel">
+                <property name="text">
+                 <string>GPU ID</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="QSpinBox" name="realsrNcnnVulkanGpuIdSpinBox"/>
+              </item>
+             </layout>
+            </item>
+            <item>
+             <layout class="QHBoxLayout" name="realsrNcnnVulkanJobsHorizontalLayout">
+              <item>
+               <widget class="QLabel" name="realsrNcnnVulkanJobsLabel">
+                <property name="text">
+                 <string>Jobs</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="QLineEdit" name="realsrNcnnVulkanJobsLineEdit">
+                <property name="text">
+                 <string>1:2:2</string>
+                </property>
+               </widget>
+              </item>
+             </layout>
+            </item>
+            <item>
+             <widget class="QCheckBox" name="realsrNcnnVulkanTtaCheckBox">
+              <property name="text">
+               <string>TTA</string>
+              </property>
+             </widget>
+            </item>
+            <item>
+             <spacer name="realsrNcnnVulkanVerticalSpacer">
+              <property name="orientation">
+               <enum>Qt::Vertical</enum>
+              </property>
+              <property name="sizeHint" stdset="0">
+               <size>
+                <width>20</width>
+                <height>331</height>
+               </size>
+              </property>
+             </spacer>
+            </item>
+           </layout>
+          </widget>
           <widget class="QWidget" name="anime4kCppTab">
            <attribute name="title">
             <string>Anime4K CPP</string>

src/video2x_setup.py

@@ -4,7 +4,7 @@
 Name: Video2X Setup Script
 Creator: K4YT3X
 Date Created: November 28, 2018
-Last Modified: May 16, 2020
+Last Modified: May 30, 2020
 
 Editor: BrianPetkovsek
 Editor: SAT3LL
@@ -17,8 +17,9 @@ Installation Details:
 - waifu2x-caffe: %LOCALAPPDATA%\\video2x\\waifu2x-caffe
 - waifu2x-cpp-converter: %LOCALAPPDATA%\\video2x\\waifu2x-converter-cpp
 - waifu2x_ncnn_vulkan: %LOCALAPPDATA%\\video2x\\waifu2x-ncnn-vulkan
-- anime4kcpp: %LOCALAPPDATA%\\video2x\\anime4kcpp
 - srmd_ncnn_vulkan: %LOCALAPPDATA%\\video2x\\srmd-ncnn-vulkan
+- realsr_ncnn_vulkan: %LOCALAPPDATA%\\video2x\\realsr-ncnn-vulkan
+- anime4kcpp: %LOCALAPPDATA%\\video2x\\anime4kcpp
 """
 
 # built-in imports
@@ -43,7 +44,7 @@ import zipfile
 # Therefore, they will be installed during the Python dependency
 #   installation step and imported later in the script.
 
-SETUP_VERSION = '2.1.0'
+SETUP_VERSION = '2.2.1'
 
 # global static variables
 LOCALAPPDATA = pathlib.Path(os.getenv('localappdata'))
@@ -54,8 +55,9 @@ DRIVER_OPTIONS = ['all',
                   'waifu2x_caffe',
                   'waifu2x_converter_cpp',
                   'waifu2x_ncnn_vulkan',
-                  'anime4kcpp',
-                  'srmd_ncnn_vulkan']
+                  'srmd_ncnn_vulkan',
+                  'realsr_ncnn_vulkan',
+                  'anime4kcpp']
 
 
 def parse_arguments():
@@ -137,7 +139,7 @@ class Video2xSetup:
         print('\nInstalling Gifski')
         import requests
 
-        # Get latest release of waifu2x-ncnn-vulkan via Github API
+        # Get latest release of Gifski via Github API
         latest_release = requests.get('https://api.github.com/repos/ImageOptim/gifski/releases/latest').json()
 
         for a in latest_release['assets']:
@@ -193,7 +195,7 @@ class Video2xSetup:
         latest_release = requests.get('https://api.github.com/repos/nihui/waifu2x-ncnn-vulkan/releases/latest').json()
 
         for a in latest_release['assets']:
-            if re.search(r'waifu2x-ncnn-vulkan-\d*\.zip', a['browser_download_url']):
+            if re.search(r'waifu2x-ncnn-vulkan-\d*-windows\.zip', a['browser_download_url']):
                 waifu2x_ncnn_vulkan_zip = download(a['browser_download_url'], tempfile.gettempdir())
                 self.trash.append(waifu2x_ncnn_vulkan_zip)
 
@@ -209,6 +211,58 @@ class Video2xSetup:
             # rename the newly extracted directory
             (LOCALAPPDATA / 'video2x' / zipf.namelist()[0]).rename(waifu2x_ncnn_vulkan_directory)
 
+    def _install_srmd_ncnn_vulkan(self):
+        """ Install srmd-ncnn-vulkan
+        """
+        print('\nInstalling srmd-ncnn-vulkan')
+        import requests
+
+        # Get latest release of srmd-ncnn-vulkan via Github API
+        latest_release = requests.get('https://api.github.com/repos/nihui/srmd-ncnn-vulkan/releases/latest').json()
+
+        for a in latest_release['assets']:
+            if re.search(r'srmd-ncnn-vulkan-\d*-windows\.zip', a['browser_download_url']):
+                srmd_ncnn_vulkan_zip = download(a['browser_download_url'], tempfile.gettempdir())
+                self.trash.append(srmd_ncnn_vulkan_zip)
+
+        # extract and rename
+        srmd_ncnn_vulkan_directory = LOCALAPPDATA / 'video2x' / 'srmd-ncnn-vulkan'
+        with zipfile.ZipFile(srmd_ncnn_vulkan_zip) as zipf:
+            zipf.extractall(LOCALAPPDATA / 'video2x')
+
+            # if directory already exists, remove it
+            if srmd_ncnn_vulkan_directory.exists():
+                shutil.rmtree(srmd_ncnn_vulkan_directory)
+
+            # rename the newly extracted directory
+            (LOCALAPPDATA / 'video2x' / zipf.namelist()[0]).rename(srmd_ncnn_vulkan_directory)
+
+    def _install_realsr_ncnn_vulkan(self):
+        """ Install realsr-ncnn-vulkan
+        """
+        print('\nInstalling realsr-ncnn-vulkan')
+        import requests
+
+        # Get latest release of realsr-ncnn-vulkan via Github API
+        latest_release = requests.get('https://api.github.com/repos/nihui/realsr-ncnn-vulkan/releases/latest').json()
+
+        for a in latest_release['assets']:
+            if re.search(r'realsr-ncnn-vulkan-\d*-windows\.zip', a['browser_download_url']):
+                realsr_ncnn_vulkan_zip = download(a['browser_download_url'], tempfile.gettempdir())
+                self.trash.append(realsr_ncnn_vulkan_zip)
+
+        # extract and rename
+        realsr_ncnn_vulkan_directory = LOCALAPPDATA / 'video2x' / 'realsr-ncnn-vulkan'
+        with zipfile.ZipFile(realsr_ncnn_vulkan_zip) as zipf:
+            zipf.extractall(LOCALAPPDATA / 'video2x')
+
+            # if directory already exists, remove it
+            if realsr_ncnn_vulkan_directory.exists():
+                shutil.rmtree(realsr_ncnn_vulkan_directory)
+
+            # rename the newly extracted directory
+            (LOCALAPPDATA / 'video2x' / zipf.namelist()[0]).rename(realsr_ncnn_vulkan_directory)
+
     def _install_anime4kcpp(self):
         """ Install Anime4KCPP
         """
@@ -238,32 +292,6 @@ class Video2xSetup:
             shutil.rmtree(LOCALAPPDATA / 'video2x' / 'anime4kcpp')
         patoolib.extract_archive(str(anime4kcpp_7z), outdir=str(LOCALAPPDATA / 'video2x' / 'anime4kcpp'))
 
-    def _install_srmd_ncnn_vulkan(self):
-        """ Install srmd-ncnn-vulkan
-        """
-        print('\nInstalling srmd-ncnn-vulkan')
-        import requests
-
-        # Get latest release of srmd-ncnn-vulkan via Github API
-        latest_release = requests.get('https://api.github.com/repos/nihui/srmd-ncnn-vulkan/releases/latest').json()
-
-        for a in latest_release['assets']:
-            if re.search(r'srmd-ncnn-vulkan-\d*\.zip', a['browser_download_url']):
-                srmd_ncnn_vulkan_zip = download(a['browser_download_url'], tempfile.gettempdir())
-                self.trash.append(srmd_ncnn_vulkan_zip)
-
-        # extract and rename
-        srmd_ncnn_vulkan_directory = LOCALAPPDATA / 'video2x' / 'srmd-ncnn-vulkan'
-        with zipfile.ZipFile(srmd_ncnn_vulkan_zip) as zipf:
-            zipf.extractall(LOCALAPPDATA / 'video2x')
-
-            # if directory already exists, remove it
-            if srmd_ncnn_vulkan_directory.exists():
-                shutil.rmtree(srmd_ncnn_vulkan_directory)
-
-            # rename the newly extracted directory
-            (LOCALAPPDATA / 'video2x' / zipf.namelist()[0]).rename(srmd_ncnn_vulkan_directory)
-
 
 def download(url, save_path, chunk_size=4096):
     """ Download file to local with requests library

src/wrappers/realsr_ncnn_vulkan.py

@@ -0,0 +1,102 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Name: RealSR NCNN Vulkan Driver
+Creator: K4YT3X
+Date Created: May 26, 2020
+Last Modified: May 26, 2020
+
+Description: This class is a high-level wrapper
+for realsr_ncnn_vulkan.
+"""
+
+# built-in imports
+import argparse
+import os
+import pathlib
+import platform
+import shlex
+import subprocess
+import threading
+
+# third-party imports
+from avalon_framework import Avalon
+
+
+class WrapperMain:
+    """This class communicates with RealSR NCNN Vulkan engine
+
+    An object will be created for this class, containing information
+    about the binary address and the processing method. When being called
+    by the main program, other detailed information will be passed to
+    the upscale function.
+    """
+
+    def __init__(self, driver_settings):
+        self.driver_settings = driver_settings
+        self.print_lock = threading.Lock()
+
+    @staticmethod
+    def parse_arguments(arguments):
+        parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, add_help=False)
+        parser.error = lambda message: (_ for _ in ()).throw(AttributeError(message))
+        parser.add_argument('--help', action='help', help='show this help message and exit')
+        parser.add_argument('-v', action='store_true', help='verbose output')
+        parser.add_argument('-i', type=str, help=argparse.SUPPRESS)  # help='input image path (jpg/png) or directory')
+        parser.add_argument('-o', type=str, help=argparse.SUPPRESS)  # help='output image path (png) or directory')
+        parser.add_argument('-s', type=int, choices=[4], help='upscale ratio')
+        parser.add_argument('-t', type=int, help='tile size (>=32/0=auto)')
+        parser.add_argument('-m', type=str, help='realsr model path')
+        parser.add_argument('-g', type=int, help='gpu device to use')
+        parser.add_argument('-j', type=str, help='thread count for load/proc/save')
+        parser.add_argument('-x', action='store_true', help='enable tta mode')
+        return parser.parse_args(arguments)
+
+    def load_configurations(self, upscaler):
+        self.driver_settings['s'] = int(upscaler.scale_ratio)
+        self.driver_settings['j'] = '{}:{}:{}'.format(upscaler.processes, upscaler.processes, upscaler.processes)
+
+    def upscale(self, input_directory, output_directory):
+        """This is the core function for RealSR NCNN Vulkan class
+
+        Arguments:
+            input_directory {string} -- source directory path
+            output_directory {string} -- output directory path
+            ratio {int} -- output video ratio
+        """
+
+        # overwrite config file settings
+        self.driver_settings['i'] = input_directory
+        self.driver_settings['o'] = output_directory
+
+        # by default, realsr-ncnn-vulkan will look for the models under the current working directory
+        # change the working directory to its containing folder if model directory not specified
+        if self.driver_settings['m'] is None and platform.system() == 'Windows':
+            os.chdir(pathlib.Path(self.driver_settings['path']).parent)
+
+        # list to be executed
+        # initialize the list with the binary path as the first element
+        execute = [self.driver_settings['path']]
+
+        for key in self.driver_settings.keys():
+
+            value = self.driver_settings[key]
+
+            # null or None means that leave this option out (keep default)
+            if key == 'path' or value is None or value is False:
+                continue
+            else:
+                if len(key) == 1:
+                    execute.append(f'-{key}')
+                else:
+                    execute.append(f'--{key}')
+
+                # true means key is an option
+                if value is not True:
+                    execute.append(str(value))
+
+        # return the Popen object of the new process created
+        self.print_lock.acquire()
+        Avalon.debug_info(f'[upscaler] Subprocess {os.getpid()} executing: {shlex.join(execute)}')
+        self.print_lock.release()
+        return subprocess.Popen(execute)