update nvidia docs.
This commit is contained in:
parent
14777501ee
commit
7b7c876775
3 changed files with 39 additions and 6 deletions
|
|
@ -279,6 +279,33 @@ See documentation for [ximagesrc](https://gstreamer.freedesktop.org/documentatio
|
||||||
|
|
||||||
This configuration requires [Nvidia GPU](https://developer.nvidia.com/cuda-gpus) with [NVENC](https://developer.nvidia.com/nvidia-video-codec-sdk) support.
|
This configuration requires [Nvidia GPU](https://developer.nvidia.com/cuda-gpus) with [NVENC](https://developer.nvidia.com/nvidia-video-codec-sdk) support.
|
||||||
|
|
||||||
|
```yaml title="config.yaml"
|
||||||
|
capture:
|
||||||
|
video:
|
||||||
|
codec: h264
|
||||||
|
ids: [ main ]
|
||||||
|
pipelines:
|
||||||
|
main:
|
||||||
|
gst_pipeline: |
|
||||||
|
ximagesrc display-name={display} show-pointer=true use-damage=false
|
||||||
|
! cudaupload ! cudaconvert ! queue
|
||||||
|
! video/x-raw(memory:CUDAMemory),format=NV12
|
||||||
|
! nvh264enc
|
||||||
|
name=encoder
|
||||||
|
preset=2
|
||||||
|
gop-size=25
|
||||||
|
spatial-aq=true
|
||||||
|
temporal-aq=true
|
||||||
|
bitrate=4096
|
||||||
|
vbv-buffer-size=4096
|
||||||
|
rc-mode=6
|
||||||
|
! h264parse config-interval=-1
|
||||||
|
! video/x-h264,stream-format=byte-stream
|
||||||
|
! appsink name=appsink
|
||||||
|
```
|
||||||
|
|
||||||
|
This configuration requires [Nvidia GPU](https://developer.nvidia.com/cuda-gpus) with [NVENC](https://developer.nvidia.com/nvidia-video-codec-sdk) support and [Cuda](https://developer.nvidia.com/cuda-zone) support.
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -241,7 +241,7 @@ For images with Nvidia GPU hardware acceleration using EGL use:
|
||||||
- [`ghcr.io/m1k1o/neko/nvidia-microsoft-edge`](https://ghcr.io/m1k1o/neko/nvidia-microsoft-edge)
|
- [`ghcr.io/m1k1o/neko/nvidia-microsoft-edge`](https://ghcr.io/m1k1o/neko/nvidia-microsoft-edge)
|
||||||
- [`ghcr.io/m1k1o/neko/nvidia-brave`](https://ghcr.io/m1k1o/neko/nvidia-brave)
|
- [`ghcr.io/m1k1o/neko/nvidia-brave`](https://ghcr.io/m1k1o/neko/nvidia-brave)
|
||||||
|
|
||||||
The base image is available at [`ghcr.io/m1k1o/neko/nvidia-base`](https://ghcr.io/m1k1o/neko/nvidia-base).
|
The base image is available at [`ghcr.io/m1k1o/neko/nvidia-base`](https://ghcr.io/m1k1o/neko/nvidia-base). See [Examples](/docs/v3/installation/examples#nvidia) for more information and usage.
|
||||||
|
|
||||||
## Supported Architectures {#arch}
|
## Supported Architectures {#arch}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -113,9 +113,9 @@ services:
|
||||||
|
|
||||||
## Nvidia GPU Acceleration {#nvidia}
|
## Nvidia GPU Acceleration {#nvidia}
|
||||||
|
|
||||||
Neko supports hardware acceleration using Nvidia GPUs. To use this feature, you need to have the Nvidia Container Toolkit installed on your system. You can find the installation instructions [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html).
|
Neko supports hardware acceleration using Nvidia GPUs. To use this feature, you need to have the Nvidia Container Toolkit installed on your system. You can find the installation instructions [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html). Check if your GPU supports hardware encoding with [this list](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix).
|
||||||
|
|
||||||
This example shows how to accelerate video encoding and as well the browser rendering using the GPU. You can test if the GPU is used by running `nvidia-smi`, which should show the GPU usage of both the browser and neko. In the browser, you can run the [WebGL Aquarium Demo](https://webglsamples.org/aquarium/aquarium.html) to test the GPU usage.
|
This example shows how to accelerate video encoding and as well the browser rendering using the GPU. You can test if the GPU is used by running `nvtop` or `nvidia-smi`, which should show the GPU usage of both the browser and neko. In the browser, you can run the [WebGL Aquarium Demo](https://webglsamples.org/aquarium/aquarium.html) to test the GPU usage.
|
||||||
|
|
||||||
```yaml title="docker-compose.yaml"
|
```yaml title="docker-compose.yaml"
|
||||||
services:
|
services:
|
||||||
|
|
@ -130,8 +130,8 @@ services:
|
||||||
NEKO_CAPTURE_VIDEO_PIPELINE: |
|
NEKO_CAPTURE_VIDEO_PIPELINE: |
|
||||||
ximagesrc display-name={display} show-pointer=true use-damage=false
|
ximagesrc display-name={display} show-pointer=true use-damage=false
|
||||||
! video/x-raw,framerate=25/1
|
! video/x-raw,framerate=25/1
|
||||||
! videoconvert ! queue
|
! cudaupload ! cudaconvert ! queue
|
||||||
! video/x-raw,format=NV12
|
! video/x-raw(memory:CUDAMemory),format=NV12
|
||||||
! nvh264enc
|
! nvh264enc
|
||||||
name=encoder
|
name=encoder
|
||||||
preset=2
|
preset=2
|
||||||
|
|
@ -161,7 +161,11 @@ services:
|
||||||
|
|
||||||
See available [Nvidia Docker Images](/docs/v3/installation/docker-images#nvidia).
|
See available [Nvidia Docker Images](/docs/v3/installation/docker-images#nvidia).
|
||||||
|
|
||||||
If you only want to accelerate the encoding, **not the browser rendering**, you can use the default image with additional environment variables:
|
:::note
|
||||||
|
If your Nvidia GPU does not support CUDA, you can use the pipeline below without `cudaupload` and `cudaconvert`. This should work with older GPUs, but the performance might be lower.
|
||||||
|
:::
|
||||||
|
|
||||||
|
If you only want to accelerate the encoding, **not the browser rendering**, and you do not need [Cuda library](https://gstreamer.freedesktop.org/documentation/cuda/index.html?gi-language=c), you can use the default image with additional environment variables:
|
||||||
|
|
||||||
```yaml title="docker-compose.yaml"
|
```yaml title="docker-compose.yaml"
|
||||||
services:
|
services:
|
||||||
|
|
@ -181,8 +185,10 @@ services:
|
||||||
NEKO_CAPTURE_VIDEO_PIPELINE: |
|
NEKO_CAPTURE_VIDEO_PIPELINE: |
|
||||||
ximagesrc display-name={display} show-pointer=true use-damage=false
|
ximagesrc display-name={display} show-pointer=true use-damage=false
|
||||||
! video/x-raw,framerate=25/1
|
! video/x-raw,framerate=25/1
|
||||||
|
# highlight-start
|
||||||
! videoconvert ! queue
|
! videoconvert ! queue
|
||||||
! video/x-raw,format=NV12
|
! video/x-raw,format=NV12
|
||||||
|
# highlight-end
|
||||||
! nvh264enc
|
! nvh264enc
|
||||||
name=encoder
|
name=encoder
|
||||||
preset=2
|
preset=2
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue