From 8fb41b41b4e5fd8abd4234b724f231109eb49d20 Mon Sep 17 00:00:00 2001 From: Rafostar <40623528+Rafostar@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:40:23 +0200 Subject: [PATCH] Update README.md --- README.md | 132 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 78 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index b84ed129..b006da0a 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,11 @@ Using hardware acceleration is highly recommended. As stated in `GStreamer` wiki In the case of OpenGL based elements, the buffers have the GstVideoGLTextureUploadMeta meta, which efficiently copies the content of the VA-API surface into a GL texture. ``` -Clapper uses `OpenGL` based sinks, so when `VA-API` is available, both CPU and RAM usage is much lower. +Clapper uses `OpenGL` based sinks, so when `VA-API` is available, both CPU and RAM usage is much lower. Especially if you have `gst-plugins-bad` 1.18+ with new `vah264dec` decoder which shares a single GL context with Clapper and uses DRM connection. If you have an AMD/Intel GPU, I highly recommend this new decoder. -To use `VA-API` make sure you have `gstreamer1-vaapi` installed. Verify with: +To use `VA-API` with H.264 videos, make sure you have `gst-plugins-bad` 1.18+. For other codecs additionally install `gstreamer1-vaapi`. Verify with: ```shell +gst-inspect-1.0 vah264dec gst-inspect-1.0 vaapi ``` On some older GPUs you might need to export `GST_VAAPI_ALL_DRIVERS=1` environment variable. @@ -40,11 +41,13 @@ Other acceleration methods (supported by `GStreamer`) should also work, but I ha ## Requirements -Clapper uses `GStreamer` bindings from `GI` repository, so if your distro ships them as separate package, they must be installed first. +Clapper uses GTK4 along with `GStreamer` bindings from `GI` repository, so if your distro ships them as separate package, they must be installed first. Additionally Clapper requires these `GStreamer` elements: -* [gtkglsink](https://gstreamer.freedesktop.org/documentation/gtk/gtkglsink.html) +* [gtk4glsink](https://gstreamer.freedesktop.org/documentation/gtk/gtkglsink.html) * [glsinkbin](https://gstreamer.freedesktop.org/documentation/opengl/glsinkbin.html) +**Attention:** `gtk4glsink` is my own port of current GStreamer `gtkglsink` to GTK4. The element is not part of GStreamer yet (pending review). Fedora package is available in my OBS repository. It will be installed along with Clapper if you add my repo to `dnf` package manager. Otherwise you might want to build it yourself from [source code](https://gitlab.freedesktop.org/Rafostar/gst-plugins-good/-/tree/GTK4) of my gstreamer GTK4 branch. + Other required plugins (codecs) depend on video format. Recommended additional packages you should install manually via package manager: @@ -53,69 +56,90 @@ Recommended additional packages you should install manually via package manager: Please note that packages naming varies by distro. -## Installation -Run in terminal: -```shell -meson builddir --prefix=/usr/local -sudo meson install -C builddir -``` - -Additional GStreamer elements installation: -
- Fedora - -Enable RPM Fusion and run: -```shell -sudo dnf install \ - gstreamer1-plugins-base \ - gstreamer1-plugins-good-gtk \ - gstreamer1-libav \ - gstreamer1-vaapi -``` -
- -
- openSUSE - -```shell -sudo zypper install \ - gstreamer-plugins-base \ - gstreamer-plugins-good \ - gstreamer-plugins-libav \ - gstreamer-plugins-vaapi -``` -
- -
- Arch Linux - -```shell -sudo pacman -S \ - gst-plugins-base \ - gst-plugin-gtk \ - gst-libav \ - gstreamer-vaapi -``` -
- ## Packages The [pkgs folder](https://github.com/Rafostar/clapper/tree/master/pkgs) in this repository contains build scripts for various package formats. You can use them to build package yourself or download one of pre-built packages:
- Fedora, openSUSE & SLE (rpm) + Debian, Fedora, openSUSE & Ubuntu -Pre-built packages are available here:
-[software.opensuse.org//download.html?project=home:sp1rit&package=clapper](https://software.opensuse.org//download.html?project=home%3Asp1rit&package=clapper) ([See status](https://build.opensuse.org/package/show/home:sp1rit/clapper)) +Pre-built packages are available in [my repo](https://software.opensuse.org//download.html?project=home%3ARafostar&package=clapper) ([see status](https://build.opensuse.org/package/show/home:Rafostar/clapper))
-Arch Linux +Arch Linux -You can get clapper from the AUR: [clapper-git](https://aur.archlinux.org/packages/clapper-git), or +You can get Clapper from the AUR: [clapper-git](https://aur.archlinux.org/packages/clapper-git), or ```shell cd pkgs/arch makepkg -si ```
+## Installation from source code +Run in terminal: +```shell +meson builddir --prefix=/usr/local +sudo meson install -C builddir +``` + +GStreamer elements installation: +
+ Debian/Ubuntu + +```shell +sudo apt install \ + gstreamer1.0-plugins-base \ + gstreamer1.0-plugins-good \ + gstreamer1.0-plugins-bad \ + gstreamer1.0-gl \ + gstreamer1.0-gtk4 \ + gstreamer1.0-libav \ + gstreamer-vaapi +``` +
+ +
+ Fedora + +Enable RPM Fusion and run: +```shell +sudo dnf install \ + gstreamer1-plugins-base \ + gstreamer1-plugins-good \ + gstreamer1-plugins-good-gtk4 \ + gstreamer1-plugins-bad-free \ + gstreamer1-plugins-bad-free-extras \ + gstreamer1-libav \ + gstreamer1-vaapi +``` +
+ +
+ openSUSE + +```shell +sudo zypper install \ + gstreamer-plugins-base \ + gstreamer-plugins-good \ + gstreamer-plugins-good-gtk4 \ + gstreamer-plugins-bad \ + gstreamer-plugins-libav \ + gstreamer-plugins-vaapi +``` +
+ +
+ Arch Linux + +```shell +sudo pacman -S \ + gst-plugins-base \ + gst-plugins-good \ + gst-plugin-gtk4 \ + gst-plugins-bad-libs \ + gst-libav \ + gstreamer-vaapi +``` +
+ ## Special Thanks Many thanks to [sp1ritCS](https://github.com/sp1ritCS) for creating and maintaining package build files.