Skip to content

andrewandneil/JellyfinUpscalerPlugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

104 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

updated and final version


Jellyfin Upscaler Plugin

Description

The Jellyfin Upscaler Plugin enhances video quality in real-time by using AI upscaling and shader-based optimizations. It offers predefined profiles and custom settings to ensure optimal performance and image quality on supported devices.


Features

  1. AI Upscaling:

    • Utilizes models like ESRGAN and Waifu2x to improve video quality.
  2. Automatic Library Recognition:

    • Adjusts settings based on library types such as Anime, Movies, or TV Shows.
  3. Custom Profiles:

    • Create your own profiles with settings for FPS, resolution, sharpness, saturation, contrast, and noise reduction.
  4. Benchmark Test:

    • Automatically or manually checks if your device supports AI upscaling.
  5. Traditional Shaders:

    • Uses shaders like Bicubic, Bilinear, or Lanczos for devices with limited performance.

Installation

  1. Download:

    • Download the plugin as a ZIP file and unzip it into the Jellyfin plugin directory.
    • Alternatively, you can clone it directly from GitHub:
    soon
  2. Plugin Directory:

    • The plugin should be placed in Jellyfin's plugin directory:
    /path/to/jellyfin/plugins/UpscalerPlugin/
    
  3. Restart:

    • Restart the Jellyfin server to activate the plugin.

Usage

  1. Go to the settings in Jellyfin and open the Upscaler Plugin section.

  2. Select one of the following profiles:

    • Default: Automatic detection based on library type.
    • Anime: Waifu2x for animations.
    • Movies: ESRGAN for high-quality movie enhancement.
    • TV Shows: Traditional shaders for TV series.
    • Custom: Custom settings.
  3. Benchmark Test:

    • Run an automatic or manual test to check your device's AI upscaling capabilities.
  4. Custom Profile:

    • Fine-tune your settings:
      • FPS: Unlimited, 30 FPS, 60 FPS, 120 FPS.
      • Resolution: 480p to 8K.
      • Image Quality: Sharpness, saturation, contrast, noise reduction.

Settings

  • Profile Selection:

    • Default, Anime, Movies, TV Shows, Custom.
  • Custom Profile Settings:

    1. FPS Settings:

      • Max FPS: Unlimited, 30, 60, 120.
    2. Resolution Settings:

      • Min. Resolution: 480p to 8K.
      • Max. Resolution: 480p to 8K.
      • Shaders for lower/higher resolutions: Bilinear, Bicubic, Lanczos.
    3. Image Quality:

      • Sharpness (0–5).
      • Saturation (-1 to 3).
      • Contrast (0.5–2.0).
      • Noise Reduction (0–3).

License

This project is licensed under the MIT License. See LICENSE for more details.


Contact

  • Developed by: Kuschel-Code

Profile Recommended GPU Recommended CPU Notes
Default NVIDIA GTX 1650 / RTX 2060 or better (or AMD Radeon RX 580 / RX 5700) Intel i5 (6th or 7th Gen) or AMD Ryzen 5 Automatic detection based on library type, moderate requirements.
Anime NVIDIA RTX 3070 or better (Waifu2x requires more GPU power) Intel i7 or AMD Ryzen 7 or better Waifu2x algorithm needs more power, especially for 1080p+ anime.
Movies NVIDIA RTX 3070 / RTX 4080 or AMD Radeon RX 6800 XT or better Intel i7/i9 or AMD Ryzen 7/9 ESRGAN for high-quality movie enhancement needs more GPU power, especially for 4K/8K.
TV Shows NVIDIA GTX 1650 or better (no heavy GPU required) Intel i5 or AMD Ryzen 5 Traditional shaders are less GPU-intensive, fine for TV series.
Custom Depends on settings, especially high resolution and FPS Depends on settings. A balanced GPU and CPU are recommended. Fine-tuning requires more resources depending on selected settings.

Additional Notes:

  • FPS: Higher frame rates (e.g., 120 FPS) demand significantly more GPU and CPU power, especially at 4K or higher resolution.
  • Resolution: For 4K or higher resolutions, a powerful GPU (RTX 3070 or better) is recommended to avoid lag or stuttering.
  • Image Quality: Higher image quality settings (sharpness, saturation, contrast) can require more GPU power, especially at higher resolutions.

The choice of GPU and CPU depends largely on the selected upscaling profile and content requirements. It's important to balance both GPU and CPU performance to ensure smooth playback and upscaling, especially for higher resolutions and more complex algorithms like Waifu2x and ESRGAN.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.4%
  • GLSL 16.6%