diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 22 insertions, 17 deletions
@@ -7,6 +7,8 @@ similar to shadowplay on windows. This is the fastest screen recording tool for This screen recorder can be used for recording your desktop offline, for live streaming and for nvidia shadowplay-like instant replay, where only the last few minutes are saved. +This software can also take screenshots. + This is a cli-only tool, if you want an UI for this check out [GPU Screen Recorder GTK](https://git.dec05eba.com/gpu-screen-recorder-gtk/) or if you prefer a ShadowPlay-like UI then check out [GPU Screen Recorder UI](https://git.dec05eba.com/gpu-screen-recorder-ui/). Supported video codecs: @@ -20,31 +22,34 @@ Supported audio codecs: * Opus (default) * AAC -## Note -This software works on X11 and Wayland on AMD, Intel and NVIDIA. +Supported image formats: +* JPEG +* PNG + +This software works on X11 and Wayland on AMD, Intel and NVIDIA. Replay data is stored in RAM, not disk. ### TEMPORARY ISSUES -1) screen-direct capture has been temporary disabled as it causes issues with stuttering. This might be a nvfbc bug. -2) Videos are in variable framerate format. Use MPV to play such videos, otherwise you might experience stuttering in the video if you are using a buggy video player. You can try saving the video into a .mkv file instead as some software may have better support for .mkv files (such as kdenlive). You can use the "-fm cfr" option to to use constant framerate mode. -3) FLAC audio codec is disabled at the moment because of temporary issues. +1) Videos are in variable framerate format. Use MPV to play such videos, otherwise you might experience stuttering in the video if you are using a buggy video player. You can try saving the video into a .mkv file instead as some software may have better support for .mkv files (such as kdenlive). You can use the "-fm cfr" option to to use constant framerate mode. +2) FLAC audio codec is disabled at the moment because of temporary issues. ### AMD/Intel/Wayland root permission -When recording a window or when using the `-w portal` option under AMD/Intel no special user permission is required, -however when recording a monitor (or when using wayland) the program needs root permission (to access KMS).\ +When recording a window or when using the `-w portal` option no special user permission is required, +however when recording a monitor the program needs root permission (to access KMS).\ This is safe in GPU Screen Recorder as the part that needs root access has been moved to its own small program that only does one thing.\ -For you as a user this only means that if you installed GPU Screen Recorder as a flatpak then a prompt asking for root password will show up when you start recording. +For you as a user this only means that if you installed GPU Screen Recorder as a flatpak then a prompt asking for root password will show up once when you start recording. # Performance On a system with a i5 4690k CPU and a GTX 1080 GPU:\ When recording Legend of Zelda Breath of the Wild at 4k, fps drops from 30 to 7 when using OBS Studio + nvenc, however when using this screen recorder the fps remains at 30.\ When recording GTA V at 4k on highest settings, fps drops from 60 to 23 when using obs-nvfbc + nvenc, however when using this screen recorder the fps only drops to 58.\ GPU Screen Recorder also produces much smoother videos than OBS when GPU utilization is close to 100%, see comparison here: [https://www.youtube.com/watch?v=zfj4sNVLLLg](https://www.youtube.com/watch?v=zfj4sNVLLLg).\ GPU Screen Recorder has much better performance than OBS Studio even with version 30.2 that does "zero-copy" recording and encoding, see: [https://www.youtube.com/watch?v=jdroRjibsDw](https://www.youtube.com/watch?v=jdroRjibsDw).\ -It is recommended to save the video to a SSD because of the large file size, which a slow HDD might not be fast enough to handle. Using variable framerate mode (-fm vfr) which is the default is also recommended as this reduces encoding load. Ultra quality is also overkill most of the time, very high (the default) or lower quality is usually enough. +It is recommended to save the video to a SSD because of the large file size, which a slow HDD might not be fast enough to handle. Using variable framerate mode (-fm vfr) which is the default is also recommended as this reduces encoding load. Ultra quality is also overkill most of the time, very high (the default) or lower quality is usually enough.\ +Note that recording on AMD can have some performance issues on Wayland in the recording itself when recording without desktop portal unless your mesa version is 25.0.0 or greater. ## Note about optimal performance on NVIDIA NVIDIA driver has a "feature" (read: bug) where it will downclock memory transfer rate when a program uses cuda (or nvenc, which uses cuda), such as GPU Screen Recorder. To work around this bug, GPU Screen Recorder can overclock your GPU memory transfer rate to it's normal optimal level.\ To enable overclocking for optimal performance use the `-oc` option when running GPU Screen Recorder. You also need to have "Coolbits" NVIDIA X setting set to "12" to enable overclocking. You can automatically add this option if you run `sudo nvidia-xconfig --cool-bits=12` and then reboot your computer.\ Note that this only works when Xorg server is running as root, and using this option will only give you a performance boost if the game you are recording is bottlenecked by your GPU.\ Note! use at your own risk! # VRR/G-SYNC -This should work fine on AMD/Intel X11 or Wayland. On Nvidia X11 G-SYNC only works with the -w screen-direct-force option, but because of bugs in the Nvidia driver this option is not always recommended. +This should work fine on AMD/Intel X11 or Wayland. On Nvidia X11 G-SYNC only works with the -w screen-direct option, but because of bugs in the Nvidia driver this option is not always recommended. For example it can cause your computer to freeze when recording certain games. # Installation @@ -62,7 +67,8 @@ Here are some known unofficial packages: * Debian/Ubuntu: [Pacstall](https://pacstall.dev/packages/gpu-screen-recorder) * Nix: [NixOS wiki](https://wiki.nixos.org/wiki/Gpu-screen-recorder) * openSUSE: [openSUSE software repository](https://software.opensuse.org/package/gpu-screen-recorder) -* Gentoo: [Guru](https://github.com/gentoo/guru/blob/master/media-video/gpu-screen-recorder/gpu-screen-recorder-9999.ebuild) +* Fedora: [Copr](https://copr.fedorainfracloud.org/coprs/brycensranch/gpu-screen-recorder-git/) +* OpenMandriva: [gpu-screen-recorder](https://github.com/OpenMandrivaAssociation/gpu-screen-recorder/tree/master) # Dependencies GPU Screen Recorder uses meson build system so you need to install `meson` to build GPU Screen Recorder. @@ -145,12 +151,8 @@ You have to reboot your computer after installing GPU Screen Recorder for the fi # Examples Look at the [scripts](https://git.dec05eba.com/gpu-screen-recorder/tree/scripts) directory for script examples. For example if you want to automatically save a recording/replay into a folder with the same name as the game you are recording. -# Reporting bugs -Issues are reported on this Github page: [https://github.com/dec05eba/gpu-screen-recorder-issues](https://github.com/dec05eba/gpu-screen-recorder-issues). -# Contributing patches -See [https://git.dec05eba.com/?p=about](https://git.dec05eba.com/?p=about) for contribution steps. -# Donations -See [https://git.dec05eba.com/?p=about](https://git.dec05eba.com/?p=about) for donation options. +# Reporting bugs, contributing patches, questions or donation +See [https://git.dec05eba.com/?p=about](https://git.dec05eba.com/?p=about). # Demo [](https://www.youtube.com/watch?v=n5tm0g01n6A) @@ -179,3 +181,6 @@ You have to either record in hdr mode (-k `hevc_hdr` or -k `av1_hdr` option) to You can record with desktop portal option (`-w portal`) instead which ignores night light, if you are ok with recording without HDR. ## Kdenlive says that the video is not usable for editing because it has variable frame rate To fix this you can either record the video in .mkv format or constant frame rate (-fm cfr). +## Colors look incorrect when recording HDR (with hevc_hdr/av1_hdr) or using an ICC profile +KDE Plasma version 6.2 broke HDR and ICC profiles for screen recorders. This was changed in KDE plasma version 6.3 and recording HDR works now, as long as you set HDR brightness to 100% (which means setting "Maximum SDR Brightness" in KDE plasma display settings to 203) and set color accuracy to "Prefer color accuracy". If you want to convert HDR to SDR then record with desktop portal option (`-w portal`) instead. +I don't know how well recording HDR works in wayland compositors other than KDE plasma. |