mirror of
https://github.com/keylase/nvidia-patch.git
synced 2024-08-30 18:32:50 +00:00
170 lines
7.2 KiB
Cheetah
170 lines
7.2 KiB
Cheetah
NVENC and NvFBC patches for Nvidia drivers
|
|
==========================================
|
|
|
|
 
|
|
|
|
[NVENC patch](patch.sh) removes restriction on maximum number of simultaneous NVENC video encoding sessions imposed by Nvidia to consumer-grade GPUs.
|
|
|
|
[NvFBC patch](patch-fbc.sh) 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)](win).
|
|
|
|
---
|
|
|
|
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](https://www.ffmpeg.org/donations.html), [VideoLAN](http://www.videolan.org/contribute.html#money)
|
|
|
|
---
|
|
|
|
## 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 |
|
|
| :--- | :---: | :---: | ---: |
|
|
$version_list
|
|
|
|
## 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 ${example_driver_version}. 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.
|
|
|
|
```bash
|
|
mkdir /opt/nvidia && cd /opt/nvidia
|
|
wget ${example_driver_url}
|
|
chmod +x ./${example_driver_file}
|
|
./${example_driver_file}
|
|
```
|
|
|
|
### Check driver
|
|
|
|
```bash
|
|
nvidia-smi
|
|
```
|
|
|
|
Output should show no errors and details about your driver and GPU.
|
|
You can also check if [ffmpeg can encode without limit](https://github.com/keylase/nvidia-patch/wiki/Verify-NVENC-patch), and check NVFBC via OBS.
|
|
|
|
### Patch driver
|
|
|
|
This patch performs backup of original file prior to making changes.
|
|
|
|
```bash
|
|
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](#download-and-install-driver).
|
|
|
|
## Rollback
|
|
|
|
If something got broken you may restore patched driver from backup:
|
|
|
|
```bash
|
|
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
|
|
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](https://www.elpamsoft.com/?p=Plex-Hardware-Transcoding) - useful benchmark of achieved simultaneous transcodes with various stream quality and hardware with patched drivers.
|
|
|
|
## See also
|
|
|
|
* Plex Media Server: enable HW **decoding**:
|
|
* [GH Issue](https://github.com/keylase/nvidia-patch/issues/51)
|
|
* PMS Forum:
|
|
1. [https://forums.plex.tv/t/hardware-accelerated-decode-nvidia-for-linux/233510/158](https://forums.plex.tv/t/hardware-accelerated-decode-nvidia-for-linux/233510/158)
|
|
2. [https://forums.plex.tv/t/hardware-accelerated-decode-nvidia-for-linux/233510/172](https://forums.plex.tv/t/hardware-accelerated-decode-nvidia-for-linux/233510/172)
|
|
* Unraid / Docker:
|
|
* [GH Issue](https://github.com/keylase/nvidia-patch/issues/43)
|
|
* Unraid Nvidia plugin:
|
|
* [Repo](https://github.com/linuxserver/Unraid-Nvidia-Plugin)
|
|
* [Forum page](https://forums.unraid.net/topic/77813-plugin-linuxserverio-unraid-nvidia/) ([archive link](https://web.archive.org/web/20190211145338/https://forums.unraid.net/topic/77813-plugin-linuxserverio-unraid-nvidia/))
|
|
* Original research behind this patch
|
|
* [Original post in Russian](https://web.archive.org/web/20201111201711/https://habr.com/en/post/262563/)
|
|
* [3rd party English translation](https://web.archive.org/web/20190904221644/https://weekly-geekly.github.io/articles/262563/index.html)
|
|
|
|
If you experience `CreateBitstreamBuffer failed: out of memory (10)`, then you have to lower buffers number used for every encoding session. If you are using `ffmpeg`, see option `-surfaces` ("Number of concurrent surfaces") and try value near `-surfaces 8`.
|