dany/clapper
1
0
Fork 0
mirror of https://github.com/Rafostar/clapper.git synced 2025-08-30 07:42:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add some missing info to Readme #19

Browse Source 
Add some missing information about why Flatpak right now is recommended, that otherwise patching is required and why Wayland is recommended. Hopefully with this, I will not have to keep repeating those to everyone on each day :-)
This commit is contained in:
Rafostar
2020-11-25 10:58:18 +01:00
committed by GitHub
parent 9ad1a11452
commit 2ed3e1dce6
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -20,18 +20,17 @@ A GNOME media player build using [GJS](https://gitlab.gnome.org/GNOME/gjs) with
This is still early WIP. Many features are not implemented yet and quite a few are still unstable. This is still early WIP. Many features are not implemented yet and quite a few are still unstable.
### Features: ### Features:
* [Playlists](https://github.com/Rafostar/clapper/wiki/Playlists)
* [Hardware acceleration](https://github.com/Rafostar/clapper/wiki/Hardware-acceleration) * [Hardware acceleration](https://github.com/Rafostar/clapper/wiki/Hardware-acceleration)
* [Floating mode](https://github.com/Rafostar/clapper/wiki/Floating-mode) * [Floating mode](https://github.com/Rafostar/clapper/wiki/Floating-mode)
## Installation from Flatpak (recommended) ## Installation from Flatpak (recommended)
The flatpak package includes all required dependencies and codecs. Additionally it also has a few patches, thus some functionalities work better (or are only available) in flatpak version (until my changes are accepted upstream). The `Flatpak` package includes all required dependencies and codecs. Additionally it also has a few patches, thus some functionalities work better (or are only available) in `Flatpak` version (until my changes are accepted upstream). It is provided as an easy "just install and use" solution.
```sh ```sh
flatpak install https://rafostar.github.io/flatpak/com.github.rafostar.Clapper.flatpakref flatpak install https://rafostar.github.io/flatpak/com.github.rafostar.Clapper.flatpakref
``` ```
## Packages ## Packages / Installation from source code
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: 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:
#### Debian, Fedora, openSUSE & Ubuntu #### Debian, Fedora, openSUSE & Ubuntu
@@ -40,14 +39,17 @@ Pre-built packages are available in [my repo](https://software.opensuse.org//dow
#### Arch Linux #### Arch Linux
You can get Clapper from the AUR: [clapper-git](https://aur.archlinux.org/packages/clapper-git) You can get Clapper from the AUR: [clapper-git](https://aur.archlinux.org/packages/clapper-git)
## Installation from source code **Important:** If you build `Clapper` from source code or install it using any other packaging system than `Flatpak`, you will still need some additional `GStreamer` elements and patches that are not upstreamed in `GStreamer` source code yet. The requirements and how to build from git source code are described in the [wiki](https://github.com/Rafostar/clapper/wiki#installation-from-source-code).
The requirements and how to build from git source code are described in the [wiki](https://github.com/Rafostar/clapper/wiki#installation-from-source-code).
## Q&A ## Q&A
**Q:** Does using `GJS` negatively impact video performance?<br> **Q:** Does using `GJS` negatively impact video performance?<br>
**A:** Absolutely not. `GJS` here is used to put together the GUI during startup. **A:** Absolutely not. `GJS` here is used to put together the GUI during startup.
It has nothing to do with video rendering. All used `GTK4` and `GStreamer` libraries are in C. It has nothing to do with video rendering. All used `GTK4` and `GStreamer` libraries are in C.
Even the custom video widget that I prepared for this player (based on original `GTK3` implementation) is in C. Even the custom video widget that I prepared for this player (based on original `GTK3` implementation) is a compiled C code.
All these libs are acting "on their own" and no function calls from `GJS` related to video decoding and rendering are performed during playback.
**Q:** What settings should I set to maximize performance?<br>
**A:** As of now, player works best on `Wayland` session. `Wayland` users might want to try enabling the experimental `vah264dec` plugin for improved performance (this plugin does not work on `Xorg` right now) for standard (8-bit) `H.264` videos. It can be enabled from inside player preferences dialog inside `Advanced -> GStreamer` tab using customizable `Plugin Ranking` feature. Since the whole app is rendered using your GPU, users of VERY weak GPUs might try to disable the "render window shadows" option to have more GPU power available for non-fullscreen video rendering.
## Special Thanks ## Special Thanks
Many thanks to [sp1ritCS](https://github.com/sp1ritCS) for creating and maintaining package build files. Many thanks to [sp1ritCS](https://github.com/sp1ritCS) for creating and maintaining package build files.