mirror of https://github.com/keylase/nvidia-patch.git synced 2024-11-27 07:57:18 +00:00

This patch removes restriction on maximum number of simultaneous NVENC video encoding sessions imposed by Nvidia to consumer-grade GPUs.

Go to file

Nostrus Admin 5c7b570254 Added root check to patch.sh and patch-fbc.sh		2024-11-24 12:50:17 +05:30
.github	workflows: push to separate branch	2023-12-05 08:16:40 +05:30
tools	update_patch_tester	2024-10-26 21:58:08 +05:30
win	win: add support for DCH driver 566.14	2024-11-13 12:30:51 +05:30
.gitignore	linux: autopatch: Find bytecode and update patch.sh	2023-11-24 01:37:17 +05:30
.gitmodules	maintenance: retire NvencSessionLimitBump	2020-07-09 18:35:16 +03:00
docker-entrypoint.sh	docker-entrypoint: ensure output dir	2019-07-11 03:31:06 +03:00
Dockerfile	dockerfile: add some reasonable ENV defaults	2019-07-11 03:26:23 +03:00
drivers.json	win: add support for DCH driver 566.14	2024-11-13 12:30:51 +05:30
patch-fbc.sh	Added root check to patch.sh and patch-fbc.sh	2024-11-24 12:50:17 +05:30
patch.sh	Added root check to patch.sh and patch-fbc.sh	2024-11-24 12:50:17 +05:30
PULL_REQUEST_TEMPLATE.md	Add PR template	2018-12-26 18:43:19 +02:00
README.md	linux: add support for driver 550.127.05	2024-10-31 18:16:40 +05:30

README.md

NVENC and NvFBC patches for Nvidia drivers

NVENC patch removes restriction on maximum number of simultaneous NVENC video encoding sessions imposed by Nvidia to consumer-grade GPUs.

NvFBC patch allows to use NvFBC on consumer-grade GPUs. It should be applied same way as NVENC patch.sh, except you have to use patch-fbc.sh instead.

Main target operating system is GNU/Linux, but for Windows support see win (clickable).

If you like this project, best way to contribute is by sending PRs and fixing documentation.

If you want to donate, please send it to your favorite open source organizations, for example FFmpeg, VideoLAN

Requirements

x86_64 system architecture
GNU/Linux operating system
nvenc-compatible gpu (https://developer.nvidia.com/video-encode-decode-gpu-support-matrix#Encoder)
Nvidia driver. Patch available for versions in version table below.

Version Table

Version	NVENC patch	NVFBC patch	Driver link
375.39	YES	NO	Driver link
390.77	YES	NO	Driver link
390.87	YES	NO	Driver link
390.147	YES	NO	Driver link
396.24	YES	NO	Driver link
396.26	YES	NO	Driver link
396.37	YES	NO	Driver link
396.54	YES	NO	Driver link
410.48	YES	NO
410.57	YES	NO	Driver link
410.73	YES	NO	Driver link
410.78	YES	NO	Driver link
410.79	YES	NO	Driver link
410.93	YES	NO	Driver link
410.104	YES	NO	Driver link
415.18	YES	NO	Driver link
415.25	YES	NO	Driver link
415.27	YES	NO	Driver link
418.30	YES	NO	Driver link
418.43	YES	NO	Driver link
418.56	YES	NO	Driver link
418.67	YES	NO	Driver link
418.74	YES	NO	Driver link
418.87.00	YES	NO	Driver link
418.87.01	YES	NO	Driver link
418.88	YES	NO	Driver link
418.113	YES	NO	Driver link
430.09	YES	NO	Driver link
430.14	YES	NO	Driver link
430.26	YES	NO	Driver link
430.34	YES	NO	Driver link
430.40	YES	NO	Driver link
430.50	YES	NO	Driver link
430.64	YES	NO	Driver link
435.17	YES	NO	Driver link
435.21	YES	NO	Driver link
440.26	YES	YES	Driver link
440.31	YES	YES	Driver link
440.33.01	YES	YES	Driver link
440.36	YES	YES	Driver link
440.43.01	YES	YES
440.44	YES	YES	Driver link
440.48.02	YES	YES
440.58.01	YES	YES
440.58.02	YES	YES
440.59	YES	YES	Driver link
440.64	YES	YES	Driver link
440.64.00	YES	YES	Driver link
440.66.02	YES	YES
440.66.03	YES	YES
440.66.04	YES	YES
440.66.08	YES	YES
440.66.09	YES	YES
440.66.11	YES	YES
440.66.12	YES	YES
440.66.14	YES	YES
440.66.15	YES	YES
440.66.17	YES	YES
440.82	YES	YES	Driver link
440.95.01	YES	YES	Driver link
440.100	YES	YES	Driver link
440.118.02	YES	YES	Driver link
450.36.06	YES	YES	Driver link
450.51	YES	YES	Driver link
450.51.05	YES	YES	Driver link
450.51.06	YES	YES	Driver link
450.56.01	YES	YES
450.56.02	YES	YES
450.56.06	YES	YES
450.56.11	YES	YES
450.57	YES	YES	Driver link
450.66	YES	YES	Driver link
450.80.02	YES	YES	Driver link
450.102.04	YES	NO	Driver link
455.22.04	YES	NO
455.23.04	YES	YES	Driver link
455.23.05	YES	YES
455.26.01	YES	YES
455.26.02	YES	YES
455.28	YES	YES	Driver link
455.32.00	YES	YES
455.38	YES	YES	Driver link
455.45.01	YES	YES	Driver link
455.46.01	YES	YES
455.46.02	YES	YES
455.46.04	YES	YES
455.50.02	YES	YES
455.50.03	NO	YES
455.50.04	YES	YES
455.50.05	YES	YES
455.50.07	YES	YES
455.50.10	YES	YES
460.27.04	YES	YES	Driver link
460.32.03	YES	YES	Driver link
460.39	YES	YES	Driver link
460.56	YES	YES	Driver link
460.67	YES	YES	Driver link
460.73.01	YES	YES	Driver link
460.80	YES	YES	Driver link
460.84	YES	YES	Driver link
460.91.03	YES	YES	Driver link
465.19.01	YES	YES	Driver link
465.24.02	YES	YES	Driver link
465.27	YES	YES	Driver link
465.31	YES	YES	Driver link
470.42.01	YES	YES	Driver link
470.57.02	YES	YES	Driver link
470.62.02	YES	YES
470.62.05	YES	YES
470.63.01	YES	YES	Driver link
470.74	YES	YES	Driver link
470.82.00	YES	YES	Driver link
470.82.01	YES	YES	Driver link
470.86	YES	YES	Driver link
470.94	YES	YES	Driver link
470.103.01	YES	YES	Driver link
470.129.06	YES	YES	Driver link
470.141.03	YES	YES	Driver link
470.161.03	YES	YES	Driver link
470.182.03	YES	YES	Driver link
470.199.02	YES	YES	Driver link
470.223.02	YES	YES	Driver link
470.239.06	YES	YES	Driver link
470.256.02	YES	YES	Driver link
495.29.05	YES	YES	Driver link
495.44	YES	YES	Driver link
495.46	YES	YES	Driver link
510.39.01	YES	YES	Driver link
510.47.03	YES	YES	Driver link
510.54	YES	YES	Driver link
510.60.02	YES	YES	Driver link
510.68.02	YES	YES	Driver link
510.73.05	YES	YES	Driver link
510.73.08	YES	YES	Driver link
510.85.02	YES	YES	Driver link
510.108.03	YES	YES	Driver link
515.43.04	YES	YES	Driver link
515.48.07	YES	YES	Driver link
515.57	YES	YES	Driver link
515.65.01	YES	YES	Driver link
515.76	YES	YES	Driver link
515.86.01	YES	YES	Driver link
515.105.01	YES	YES	Driver link
520.56.06	YES	YES	Driver link
520.61.05	YES	YES	Driver link
525.60.11	YES	YES	Driver link
525.60.13	YES	YES
525.78.01	YES	YES	Driver link
525.85.05	YES	YES	Driver link
525.85.12	YES	YES
525.89.02	YES	YES	Driver link
525.105.17	YES	YES	Driver link
525.116.03	YES	YES	Driver link
525.116.04	YES	YES	Driver link
525.125.06	YES	YES	Driver link
525.147.05	YES	YES	Driver link
530.30.02	YES	YES	Driver link
530.41.03	YES	YES	Driver link
535.43.02	YES	YES	Driver link
535.43.25	YES	YES	Driver link
535.54.03	YES	YES	Driver link
535.86.05	YES	YES	Driver link
535.86.10	YES	YES
535.98	YES	YES	Driver link
535.104.05	YES	YES	Driver link
535.104.12	YES	YES	Driver link
535.113.01	YES	YES	Driver link
535.129.03	YES	YES	Driver link
535.146.02	YES	YES	Driver link
535.154.05	YES	YES	Driver link
535.161.07	YES	YES	Driver link
535.161.08	YES	YES
535.171.04	YES	YES	Driver link
535.183.01	YES	YES	Driver link
535.183.06	YES	YES	Driver link
545.23.06	YES	YES	Driver link
545.23.08	YES	YES
545.29.02	YES	YES	Driver link
545.29.06	YES	YES	Driver link
550.40.07	YES	YES	Driver link
550.54.14	YES	YES	Driver link
550.54.15	YES	YES
550.67	YES	YES	Driver link
550.76	YES	YES	Driver link
550.78	YES	YES	Driver link
550.90.07	YES	YES	Driver link
550.100	YES	YES	Driver link
550.107.02	YES	YES	Driver link
550.120	YES	YES	Driver link
550.127.05	YES	YES	Driver link
555.42.02	YES	YES	Driver link
555.58	YES	YES	Driver link
555.58.02	YES	YES	Driver link
560.28.03	YES	YES	Driver link
560.35.03	YES	YES	Driver link
565.57.01	YES	YES	Driver link

Synopsis

# bash ./patch.sh -h

SYNOPSIS
       patch.sh [-s] [-r|-h|-c VERSION|-l|-f]

DESCRIPTION
       The patch for Nvidia drivers to remove NVENC session limit

       -s             Silent mode (No output)
       -r             Rollback to original (Restore lib from backup)
       -h             Print this help message
       -c VERSION     Check if version VERSION supported by this patch.
                      Returns true exit code (0) if version is supported.
       -l             List supported driver versions
       -d VERSION     Use VERSION driver version when looking for libraries
                      instead of using nvidia-smi to detect it.
       -f             Enable support for Flatpak NVIDIA drivers.

# bash ./patch-fbc.sh -h

SYNOPSIS
       patch-fbc.sh [-s] [-r|-h|-c VERSION|-l|-f]

DESCRIPTION
       The patch for Nvidia drivers to allow FBC on consumer devices

       -s             Silent mode (No output)
       -r             Rollback to original (Restore lib from backup)
       -h             Print this help message
       -c VERSION     Check if version VERSION supported by this patch.
                      Returns true exit code (0) if version is supported.
       -l             List supported driver versions
       -d VERSION     Use VERSION driver version when looking for libraries
                      instead of using nvidia-smi to detect it.
       -f             Enable support for Flatpak NVIDIA drivers.

Step-by-Step guide

Examples are provided for driver version 430.50. All commands are executed as root.

Download and install driver

Skip this step if you already have installed driver with version supported by this patch.

Make sure you have kernel headers and compiler installed before running Nvidia driver installer. Kernel headers and compiler are required to build nvidia kernel module. Recommended way to do this is to install dkms package, if it is available in your distro. This way dkms package will pull all required dependencies to allow building kernel modules and kernel module builds will be automated in a reliable fashion.

mkdir /opt/nvidia && cd /opt/nvidia
wget https://international.download.nvidia.com/XFree86/Linux-x86_64/430.50/NVIDIA-Linux-x86_64-430.50.run
chmod +x ./NVIDIA-Linux-x86_64-430.50.run
./NVIDIA-Linux-x86_64-430.50.run

Check driver

nvidia-smi

Output should show no errors and details about your driver and GPU. You can also check if ffmpeg can encode without limit, and check NVFBC via OBS.

Patch driver

This patch performs backup of original file prior to making changes.

bash ./patch.sh

You're all set!

Note: Sometimes distribution installed drivers are not found by the patch script. In that case, please uninstall the nvidia driver using your distribution package manager, and install it using the steps above.

Rollback

If something got broken you may restore patched driver from backup:

bash ./patch.sh -r

Docker support

It is possible to use this patch with nvidia-docker containers, even if host machine hasn't patched drivers. See Dockerfile for example.

Essentially all you need to do during build is:

COPY the patch.sh and docker-entrypoint.sh files into your container.
Make sure docker-entrypoint.sh is invoked on container start.

docker-entrypoint.sh script does on-the-fly patching by means of manipulating dynamic linker to workaround read-only mount of Nvidia runtime. Finally it passes original docker command to shell, like if entrypoint was not restricted by ENTRYPOINT directive. So docker run --runtime=nvidia -it mycontainer echo 123 will print 123. Also it can be just invoked from your entrypoint script, if you have any.

Flatpak support

If you use a Flatpak app that uses NVENC/NvFBC (e.g. OBS Studio, Kdenlive), it's recommended that you patch the NVIDIA drivers for Flatpak as well. To do so, just pass the -f parameter to either patch.sh or patch-fbc.sh, like so:

bash ./patch.sh -f
bash ./patch-fbc.sh -f

In case something goes wrong, you can restore the original Flatpak drivers by adding the -r paramater:

bash ./patch.sh -f -r
bash ./patch-fbc.sh -f -r

Benchmarks

Plex Media Server: nVidia Hardware Transcoding Calculator for Plex Estimates - useful benchmark of achieved simultaneous transcodes with various stream quality and hardware with patched drivers.