Merge with upstream

BUILD_NOTES.md

@@ -61,7 +61,10 @@ Or you can build with [ninja](https://ninja-build.org/):
 #### Generating the package
 A Debian package can be created with cmake on any system:
 
-    cmake -DCMAKE_INSTALL_PREFIX=/usr -DGSETTINGS_COMPILE=OFF ..
+    cmake \
+      -DCMAKE_INSTALL_PREFIX=/usr \
+      -DCMAKE_BUILD_TYPE=Release \
+      -DGSETTINGS_COMPILE=OFF ..
     make package
 
 ### Flatpak

CHANGES.md

@@ -1,7 +1,15 @@
 # Version 1.?.? - 2017-??-??
- * feat: Optional GIF conversion with Ffmpeg
+ * feat: GIF conversion with gifski if installed for improved quality (#212, #179)
+ * feat: GIF quality level can be set in preferences, if gifski is available (#212)
+ * feat: GIF conversion with FFmpeg as default instead of ImageMagick (#125)
  * feat: Support APNG as output format (#108)
- * fix: Temporary files get unique name again
+ * fix: Temporary files get unique name again (was broken in #161)
+ * fix: Quitting application does not interrupt rendering (#189)
+ * fix: Much smaller temporary file sizes
+ * fix: Do not load local settings schema in release builds
+ * i18n: Added Chinese (Traditional)
+ * i18n: Updated translations for Esperanto, Italian, Norwegian Bokmål, Serbian,
+         Swedish
 
 # Version 1.1.0 - 2017-10-05
  * feat: Transparent recording area without compositor (#147, #7)

CMakeLists.txt

@@ -53,6 +53,11 @@ GLIB_COMPILE_RESOURCES(GLIB_RESOURCES
 
 set(VALA_DEFINITIONS "")
 
+if(NOT CMAKE_BUILD_TYPE STREQUAL Release)
+  message (STATUS "Debug build")
+  list(APPEND VALA_DEFINITIONS "DEBUG")
+endif()
+
 # Check for GTK features
 if(${GTK_VERSION} VERSION_EQUAL "3.16" OR ${GTK_VERSION} VERSION_GREATER "3.16")
   message(STATUS "Compiling with features for GTK >= 3.16")
@@ -95,15 +100,20 @@ vala_precompile(VALA_C
     src/dbus/freedesktop-dbus.vala
     src/dbus/freedesktop-filemanager.vala
     src/dbus/gnome-shell-screencast.vala
+    src/post-processing/cli-post-processor.vala
+    src/post-processing/extract-frames-post-processor.vala
     src/post-processing/ffmpeg-post-processor.vala
+    src/post-processing/gifski-post-processor.vala
     src/post-processing/imagemagick-post-processor.vala
+    src/post-processing/post-processing-pipeline.vala
     src/post-processing/post-processor.vala
     src/recording/screen-recorder.vala
     src/recording/base-screen-recorder.vala
     src/recording/screen-recorder-factory.vala
     src/recording/recording-area.vala
+    src/recording/recording-config.vala
     src/recording/gnome-shell-dbus-recorder.vala
-    src/recording/command-line-screen-recorder.vala
+    src/recording/cli-screen-recorder.vala
     src/recording/avconv-screen-recorder.vala
     src/recording/ffmpeg-screen-recorder.vala
     src/ui/about-dialog.vala
@@ -170,9 +180,9 @@ set(CPACK_PACKAGE_VERSION_MINOR ${PEEK_VERSION_MINOR})
 set(CPACK_PACKAGE_VERSION_PATCH ${PEEK_VERSION_PATCH})
 set(CPACK_PACKAGE_INSTALL_DIRECTORY "Peek")
 
-set(CPACK_DEBIAN_PACKAGE_DEPENDS "libgtk-3-0 (>= ${REQUIRE_GTK}), libglib2.0-0 (>= 2.38), libkeybinder-3.0-0, ffmpeg | libav-tools")
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "libgtk-3-0 (>= ${REQUIRE_GTK}), libglib2.0-0 (>= 2.38), libkeybinder-3.0-0, ffmpeg")
 set(CPACK_DEBIAN_PACKAGE_RECOMMENDS "gstreamer1.0-plugins-good, gstreamer1.0-plugins-ugly")
-set(CPACK_DEBIAN_PACKAGE_SUGGESTS "imagemagick")
+set(CPACK_DEBIAN_PACKAGE_SUGGESTS "gifski")
 set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64")
 set(CPACK_DEBIAN_PACKAGE_SECTION "video")
 

README.md

@@ -33,11 +33,12 @@ Simple screen recorder with an easy to use interface
   - [From source](#from-source)
 - [Frequently Asked Questions](#frequently-asked-questions)
   - [How can I capture mouse clicks and/or key strokes?](#how-can-i-capture-mouse-clicks-andor-key-strokes)
-  - [My recorded GIFs flicker, what is wrong?](#my-recorded-gifs-flicker-what-is-wrong)
+  - [How can I improve the quality of recorded GIF files](#how-can-i-improve-the-quality-of-recorded-gif-files)
   - [Why are the GIF files so big?](#why-are-the-gif-files-so-big)
   - [If GIF is so bad why use it at all?](#if-gif-is-so-bad-why-use-it-at-all)
   - [What about WebM or MP4? Those are well supported on the web.](#what-about-webm-or-mp4-those-are-well-supported-on-the-web)
   - [Why can't I interact with the UI elements inside the recording area?](#why-cant-i-interact-with-the-ui-elements-inside-the-recording-area)
+  - [My recorded GIFs flicker, what is wrong?](#my-recorded-gifs-flicker-what-is-wrong)
   - [On i3 the recording area is all black, how can I record anything?](#on-i3-the-recording-area-is-all-black-how-can-i-record-anything)
   - [Why no native Wayland support?](#why-no-native-wayland-support)
 - [Contribute](#contribute)
@@ -70,8 +71,8 @@ Support for more Wayland desktops might be added in the future (see FAQs below).
 - GTK+ >= 3.14
 - GLib >= 2.38
 - [libkeybinder3](https://github.com/kupferlauncher/keybinder)
-- FFmpeg or libav-tools
-- ImageMagick (optional)
+- FFmpeg
+- [gifski](https://gif.ski/) (optional but recommended for improved GIF quality)
 
 ### Development
 
@@ -124,6 +125,11 @@ environment or from command line:
 
     snap run peek
 
+In case it fails to start with the message `You need to connect this snap to the gnome platform snap`
+do the following command via command-line:
+
+    sudo snap connect peek:gnome-3-26-1604 gnome-3-26-1604:gnome-3-26-1604
+
 Snaps should automatically update in the background. If this is not happening
 you can update Peek manually to the latest version:
 
@@ -176,7 +182,7 @@ Then build Peek and package it:
 This will create the package `peek-x.y.z-Linux.deb` (where `x.y.z` is the
 current version). You can install it with dpkg:
 
-    sudo dpkg -i peek-x.y.z-Linux.deb
+    sudo dpkg -i peek-*-Linux.deb
 
 ### Fedora
 Fedora 25 users can use this repository:
@@ -234,30 +240,31 @@ in most distributions, so you can easily install with your package manager.
 Then start key-mon with `key-mon --visible_click`. The `--visible_click` option
 is for drawing small circles around mouse clicks.
 
-### My recorded GIFs flicker, what is wrong?
-Some users have experienced recorded windows flicker or other strange visual
-artifacts only visible in the recorded GIF. This is most likely a video driver
-issue. If you are using Intel video drivers switching between the SNA and UXA
-acceleration methods can help. For NVIDIA drivers changing the "Allow Flipping"
-setting in the NVIDIA control panel
-[was reported to help](https://github.com/phw/peek/issues/86).
+### How can I improve the quality of recorded GIF files
+To get the best possible quality you should install the [gifski](https://gif.ski/)
+GIF encoder. If available Peek will automatically use gifski and will provide
+a quality slider in the preferences dialog. The default value will give a
+balanced result between quality and file size. Set the quality to maximum if you
+want to get the highest possible quality even with thousands of colors. The file
+size will increase significantly, though (see below).
 
 ### Why are the GIF files so big?
-Peek is using ImageMagick to optimize the GIF files and reduce the file size.
-As was shown in
-[issue #3](https://github.com/phw/peek/issues/3#issuecomment-243872774)
-the resulting files are already small and compare well to other GIF recording
-software. In the end the GIF format is not well suited for doing large
-animations with a lot of changes and colors. For best results:
+The GIF format is highly inefficient and not well suited for doing large
+animations with a lot of changes and colors. Peek tries its best to reduce the
+file size by using FFmpeg or [gifski](https://gif.ski/) to generate optimized
+GIF files. For best results:
 
 - Use a lower frame rate. 10fps is the default and works well, but in many
   cases you can even get good results with lower framerates.
+- If you have [gifski](https://gif.ski/) installed you can adjust the GIF
+  quality in the preferences. A lower quality gives a smaller file size at the
+  expense of visual quality (see above).  
 - Avoid too much change. If there is heavy animation the frames will differ
   a lot.
 - Record small areas or use the downsample option to scale the image. The GIF
   file format is not well suited for high resolution or full screen recording.
-- Avoid too many colors, since GIF is limited to a 256 color palette. This one
-  is not so much about file size but more about visual quality.
+- Avoid too many colors, since GIF is limited to a 256 color palette per frame.
+  This one is not so much about file size but more about visual quality.
 - If the above suggestions are not suitable for your use case, consider using
   WebM or MP4 format (see below).
 
@@ -277,9 +284,19 @@ online services as GIFs.
 
 ### Why can't I interact with the UI elements inside the recording area?
 You absolutely should be able to click the UI elements inside the area you are
-recording. However this does not work as intended on some window managers,
-most notably i3. If this does not work for you on any other window manager
-please open an [issue on Github](https://github.com/phw/peek/issues).
+recording. If you use i3 you should stack Peek with the window you intend to record
+or make sure all windows are floating and uncheck "Always on top" from the Peek settings.  
+If you want to be able to control the area when recording in i3 you can move Peek
+to the Scratchpad it will keep recording the area once you hide the window.
+If this does not work for you on any other window manager please open an [issue on GitHub](https://github.com/phw/peek/issues).
+
+### My recorded GIFs flicker, what is wrong?
+Some users have experienced recorded windows flicker or other strange visual
+artifacts only visible in the recorded GIF. This is most likely a video driver
+issue. If you are using Intel video drivers switching between the SNA and UXA
+acceleration methods can help. For NVIDIA drivers changing the "Allow Flipping"
+setting in the NVIDIA control panel
+[was reported to help](https://github.com/phw/peek/issues/86).
 
 ### On i3 the recording area is all black, how can I record anything?
 i3 does not support the X shape extension. In order to get a transparent

data/appimage/appimage.yml

@@ -16,13 +16,12 @@ build:
     - https://git.videolan.org/git/x264.git
 
   files:
-    - https://ffmpeg.org/releases/ffmpeg-3.3.4.tar.xz
-    - https://github.com/ImageMagick/ImageMagick/archive/6.9.9-19.tar.gz
+    - https://ffmpeg.org/releases/ffmpeg-3.4.tar.xz
 
 script:
   # Build Peek
   - cd $BUILD_SOURCE_DIR/peek
-  - cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr -DGSETTINGS_COMPILE=OFF -DLOCALEDIR=share/locale .
+  - cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr -DCMAKE_BUILD_TYPE=Release -DGSETTINGS_COMPILE=OFF -DLOCALEDIR=share/locale .
   - make
   - make DESTDIR=$BUILD_APPDIR install
   # Build libx264
@@ -32,22 +31,14 @@ script:
   - make DESTDIR=$BUILD_APPDIR install
   # Build FFmpeg
   - cd $BUILD_SOURCE_DIR
-  - tar -xf ffmpeg-3.3.4.tar.xz
-  - cd ffmpeg-3.3.4
-  - ./configure --prefix=/usr --extra-ldflags="-L${BUILD_APPDIR}/usr/lib" --extra-cflags="-I${BUILD_APPDIR}/usr/include" --disable-debug --disable-static --enable-gpl --enable-libvpx --enable-libx264 --enable-shared --enable-libxcb --enable-libxcb-xfixes --disable-libxcb-shape --disable-ffplay --disable-ffprobe --disable-ffserver --disable-doc --disable-everything --enable-decoder=png --enable-decoder=rawvideo --enable-encoder=gif --enable-encoder=gif --enable-encoder=libvpx_vp8 --enable-encoder=libx264 --enable-encoder=pam --enable-encoder=png --enable-encoder=rawvideo --enable-demuxer=avi --enable-demuxer=image2 --enable-muxer=apng --enable-muxer=gif --enable-muxer=image2 --enable-muxer=mp4 --enable-muxer=rawvideo --enable-muxer=webm --enable-filter=crop --enable-filter=fps --enable-filter=palettegen --enable-filter=paletteuse --enable-filter=scale --enable-protocol=file --enable-indev=xcbgrab
-  - make
-  - make DESTDIR=$BUILD_APPDIR install
-  # Build ImageMagick
-  - cd $BUILD_SOURCE_DIR
-  - tar -xf ImageMagick-6.9.9-19.tar.gz
-  - cd ImageMagick-6.9.9-19
-  - ./configure --prefix=/usr --enable-static=no --disable-docs --disable-deprecated --without-autotrace --without-bzlib --without-djvu --without-dps --without-fftw --without-fontconfig --without-fpx --without-freetype --without-gvc --without-jbig --without-jpeg --without-lcms --without-lzma --without-magick-plus-plus --without-openexr --without-openjp2 --without-pango --without-png --without-raqm --without-tiff --without-webp --without-wmf --without-x --without-xml --without-zlib --enable-filter=crop --enable-filter=scale --enable-protocol=file --enable-indev=xcbgrab
+  - tar -xf ffmpeg-3.4.tar.xz
+  - cd ffmpeg-3.4
+  - ./configure --prefix=/usr --extra-ldflags="-L${BUILD_APPDIR}/usr/lib" --extra-cflags="-I${BUILD_APPDIR}/usr/include"  --disable-debug --disable-static --enable-gpl --enable-libvpx --enable-libx264 --enable-shared --enable-libxcb --enable-libxcb-xfixes --disable-libxcb-shape --disable-ffplay --disable-ffprobe --disable-ffserver --disable-doc --disable-everything --enable-decoder=libvpx_vp8 --enable-decoder=h264 --enable-decoder=png --enable-decoder=rawvideo --enable-encoder=apng --enable-encoder=ffvhuff --enable-encoder=gif --enable-encoder=libvpx_vp8 --enable-encoder=libx264 --enable-encoder=libx264rgb --enable-encoder=png --enable-demuxer=image2 --enable-demuxer=matroska --enable-muxer=apng --enable-muxer=gif --enable-muxer=image2 --enable-muxer=matroska --enable-muxer=mp4 --enable-muxer=webm --enable-filter=crop --enable-filter=fps --enable-filter=palettegen --enable-filter=paletteuse --enable-filter=scale --enable-protocol=file --enable-indev=xcbgrab
   - make
   - make DESTDIR=$BUILD_APPDIR install
   # Finalize AppDir
   - export LD_LIBRARY_PATH=${BUILD_APPDIR}/usr/lib:$LD_LIBRARY_PATH
   - linuxdeployqt ${BUILD_APPDIR}/usr/bin/ffmpeg -bundle-non-qt-libs
-  - linuxdeployqt ${BUILD_APPDIR}/usr/bin/convert -bundle-non-qt-libs
   - linuxdeployqt ${BUILD_APPDIR}/usr/bin/peek -bundle-non-qt-libs
   - glib-compile-schemas $BUILD_APPDIR/usr/share/glib-2.0/schemas
   - cp $BUILD_APPDIR/usr/share/applications/com.uploadedlobster.peek.desktop $BUILD_APPDIR

data/appimage/launch-peek

@@ -3,7 +3,6 @@ SCRIPT=$(readlink -f "$0")
 BIN_DIR=$(dirname "$SCRIPT")
 BASE_DIR=$(readlink -f "$BIN_DIR/../..")
 
-export MAGICK_CONFIGURE_PATH="$BASE_DIR/usr/etc/ImageMagick-7/"
 export XDG_CONFIG_DIRS=$BASE_DIR/usr/etc:$XDG_CONFIG_DIRS
 export XDG_DATA_DIRS=$BASE_DIR/usr/share/:$XDG_DATA_DIRS
 export PATH=$BIN_DIR:$PATH

data/com.uploadedlobster.peek.gschema.xml

@@ -38,6 +38,11 @@
       <default>"gif"</default>
       <summary>Output file format</summary>
     </key>
+    <key name="recording-gifski-quality" type="i">
+      <range min="20" max="100"/>
+      <default>60</default>
+      <summary>Quality setting for the gifski GIF encoder</summary>
+    </key>
     <key name="recording-start-delay" type="i">
       <range min="0" max="60"/>
       <default>3</default>

data/flatpak/flatpak-master.json

@@ -20,7 +20,7 @@
     "--talk-name=ca.desrt.dconf",
     "--env=DCONF_USER_CONFIG_DIR=.config/dconf"
   ],
-  "build-options" : {
+  "build-options": {
     "cflags": "-O2 -g -fstack-protector-strong -D_FORTIFY_SOURCE=2",
     "cxxflags": "-O2 -g -fstack-protector-strong -D_FORTIFY_SOURCE=2",
     "ldflags": "-fstack-protector-strong -Wl,-z,relro,-z,now"
@@ -48,22 +48,24 @@
       "--disable-ffserver",
       "--disable-doc",
       "--disable-everything",
+      "--enable-decoder=libvpx_vp8",
+      "--enable-decoder=h264",
       "--enable-decoder=png",
       "--enable-decoder=rawvideo",
       "--enable-encoder=apng",
+      "--enable-encoder=ffvhuff",
       "--enable-encoder=gif",
       "--enable-encoder=libvpx_vp8",
       "--enable-encoder=libx264",
-      "--enable-encoder=pam",
+      "--enable-encoder=libx264rgb",
       "--enable-encoder=png",
-      "--enable-encoder=rawvideo",
-      "--enable-demuxer=avi",
       "--enable-demuxer=image2",
+      "--enable-demuxer=matroska",
       "--enable-muxer=apng",
       "--enable-muxer=gif",
       "--enable-muxer=image2",
+      "--enable-muxer=matroska",
       "--enable-muxer=mp4",
-      "--enable-muxer=rawvideo",
       "--enable-muxer=webm",
       "--enable-filter=crop",
       "--enable-filter=fps",
@@ -75,8 +77,8 @@
     ],
     "sources": [{
       "type": "archive",
-      "url": "https://ffmpeg.org/releases/ffmpeg-3.3.4.tar.xz",
-      "sha256": "98b97e1b908dfeb6aeb6d407e5a5eacdfc253a40c2d195f5867ed2d1d46ea957"
+      "url": "https://ffmpeg.org/releases/ffmpeg-3.4.tar.xz",
+      "sha256": "aeee06e4d8b18d852c61ebbfe5e1bb7014b1e118e8728c1c2115f91e51bffbef"
     }],
     "modules": [{
       "name": "libx264",
@@ -95,50 +97,46 @@
       ]
     }]
   }, {
-    "name": "imagemagick",
-    "config-opts": [
-      "--enable-static=no",
-      "--disable-docs",
-      "--disable-deprecated",
-      "--without-autotrace",
-      "--without-bzlib",
-      "--without-djvu",
-      "--without-dps",
-      "--without-fftw",
-      "--without-fontconfig",
-      "--without-fpx",
-      "--without-freetype",
-      "--without-gvc",
-      "--without-jbig",
-      "--without-jpeg",
-      "--without-lcms",
-      "--without-lzma",
-      "--without-magick-plus-plus",
-      "--without-openexr",
-      "--without-openjp2",
-      "--without-pango",
-      "--without-png",
-      "--without-raqm",
-      "--without-tiff",
-      "--without-webp",
-      "--without-wmf",
-      "--without-x",
-      "--without-xml",
-      "--without-zlib"
-    ],
+    "name": "gifski",
+    "buildsystem": "simple",
+    "build-options": {
+      "build-args": ["--share=network"]
+    },
     "sources": [{
-      "type": "git",
-      "url": "https://github.com/ImageMagick/ImageMagick.git",
-      "branch": "6.9.9-12",
-      "commit": "8359cc4b039711baef43c3ea6108a801b11f1254"
-    }]
+      "type": "archive",
+      "url": "https://github.com/ImageOptim/gifski/archive/0.5.0.tar.gz",
+      "sha256": "6cf9a69ad141c6bf61f6f8b5ba507c06aaf0d401351768d2cd790fe27d6a9de7"
+    },
+    {
+      "type": "archive",
+      "url": "https://static.rust-lang.org/dist/rust-1.21.0-x86_64-unknown-linux-gnu.tar.gz",
+      "sha256": "b41e70e018402bc04d02fde82f91bea24428e6be432f0df12ac400cfb03108e8",
+      "only-arches": ["x86_64"],
+      "dest": "rust"
+    },
+    {
+      "type": "archive",
+      "url": "https://static.rust-lang.org/dist/rust-1.21.0-i686-unknown-linux-gnu.tar.gz",
+      "sha256": "b7caed0f602cdb8ef22e0bfa9125a65bec411e15c0b8901d937e43303ec7dbee",
+      "only-arches": ["i386"],
+      "dest": "rust"
+    }],
+    "build-commands": [
+      "rust/install.sh --prefix=/app",
+      "cargo build --release --features=openmp",
+      "install -Dm755 target/release/gifski /app/bin/gifski"
+    ],
+    "post-install": [
+      "/app/lib/rustlib/uninstall.sh"
+    ]
   }, {
     "name": "peek",
     "buildsystem": "cmake",
     "config-opts": [
-      "-DCMAKE_VERBOSE_MAKEFILE=TRUE"
+      "-DCMAKE_VERBOSE_MAKEFILE=TRUE",
+      "-DCMAKE_BUILD_TYPE=Release"
     ],
-    "build-options" : {
+    "build-options": {
       "cflags": "-L/app/lib"
     },
     "sources": [{