From bed6d99933d41f4002fd5a0f96cdf990d754ce48 Mon Sep 17 00:00:00 2001 From: trilene Date: Mon, 30 Nov 2020 17:04:36 -0500 Subject: [PATCH 1/2] Add GStreamer requirements to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index bd6e1a9e..c8d65704 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Most of the features you would expect from a chat application are missing right but we are getting close to a more feature complete client. Specifically there is support for: - E2E encryption. +- VoIP calls (voice & video) - User registration. - Creating, joining & leaving rooms. - Sending & receiving invites. @@ -124,6 +125,10 @@ brew cask install nheko - Boost 1.70 or greater. - [libolm](https://gitlab.matrix.org/matrix-org/olm) - [spdlog](https://github.com/gabime/spdlog) +- [GStreamer](https://gitlab.freedesktop.org/gstreamer) 1.18.0 or greater (optional, needed for VoIP support). + - gstreamer core library, gst-plugins-base, gst-plugins-good & gst-plugins-bad + - qmlgl plugin (optional, needed for video call support) + - [libnice](https://gitlab.freedesktop.org/libnice/libnice) - A compiler that supports C++ 17: - Clang 6 (tested on Travis CI) - GCC 7 (tested on Travis CI) From 7299103cf4fac7e5f17c1a624def3d0ef4381f7e Mon Sep 17 00:00:00 2001 From: trilene Date: Mon, 30 Nov 2020 17:42:08 -0500 Subject: [PATCH 2/2] List needed gstreamer plugins explicitly --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c8d65704..1f17d4a3 100644 --- a/README.md +++ b/README.md @@ -126,8 +126,11 @@ brew cask install nheko - [libolm](https://gitlab.matrix.org/matrix-org/olm) - [spdlog](https://github.com/gabime/spdlog) - [GStreamer](https://gitlab.freedesktop.org/gstreamer) 1.18.0 or greater (optional, needed for VoIP support). - - gstreamer core library, gst-plugins-base, gst-plugins-good & gst-plugins-bad - - qmlgl plugin (optional, needed for video call support) + - Installing the gstreamer core library plus gst-plugins-base, gst-plugins-good & gst-plugins-bad + is often sufficient. The qmlgl plugin though is often packaged separately. The actual plugin requirements + are as follows: + - Voice call support: dtls, opus, rtpmanager, srtp, webrtc + - Video call support (optional): compositor, opengl, qmlgl, rtp, vpx - [libnice](https://gitlab.freedesktop.org/libnice/libnice) - A compiler that supports C++ 17: - Clang 6 (tested on Travis CI)