Improve highdpi support.

new ebuild available for 1.1.0

README.md

@@ -13,18 +13,18 @@ It uses the QML port of qtermwidget (Konsole) developed by me: https://github.co
 This terminal emulator works under Linux and macOS and requires Qt 5.2 or higher.
 
 ## Screenshots
-![Image](<http://i.imgur.com/I6wq1cC.png>)
+![Image](<https://i.imgur.com/TNumkDn.png>)
-![Image](<http://i.imgur.com/12EqlpL.png>)
+![Image](<https://i.imgur.com/hfjWOM4.png>)
-![Image](<http://i.imgur.com/Lx0acQz.jpg>)
+![Image](<https://i.imgur.com/GYRDPzJ.jpg>)
 
-## Get cool-retro-term
+## Install
-You can either build cool-retro-term yourself (see below) or walk the easy way and install one of these packages:
+Walk the easy way and install cool-retro-term using one of these convenient packages:
 
-Fedora has the `cool-retro-term` in the offcial repositories. All you have to do is `sudo dnf install cool-retro-term`.
+**Fedora** has the `cool-retro-term` in the offcial repositories. All you have to do is `sudo dnf install cool-retro-term`.
 
-Users of openSUSE can grab a package from [Open Build Service](http://software.opensuse.org/package/cool-retro-term).
+Users of **openSUSE** can grab a package from [Open Build Service](http://software.opensuse.org/package/cool-retro-term).
 
-Arch users can install this [package](https://aur.archlinux.org/packages/cool-retro-term-git/) directly via the [AUR](https://aur.archlinux.org):
+**Arch** users can install this [package](https://aur.archlinux.org/packages/cool-retro-term-git/) directly via the [AUR](https://aur.archlinux.org):
 
     yaourt -S aur/cool-retro-term-git
 
@@ -34,25 +34,27 @@ or use:
 
 to install precompiled from community repository.
 
-Gentoo users can now install the second release "1.0.1" from a 3rd-party repository preferably via layman:
+**Gentoo** users can now install the third release "1.1.0" from a 3rd-party repository preferably via layman:
 
     USE="git" emerge app-portage/layman
     wget https://www.gerczei.eu/files/gerczei.xml -O /etc/layman/overlays/gerczei.xml
     layman -f -a qt -a gerczei # those who've added the repo before 27/08/17 should remove, update and add it again as its source has changed
-    ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.0.1::gerczei
+    ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.1.0::gerczei
 
 The live ebuild (version 9999-r1) tracking the bleeding-edge WIP codebase also remains available.
 
 A word of warning: USE flags and keywords are to be added to portage's configuration files and every emerge operation should be executed with '-p' (short option for --pretend) appended to the command line first as per best practice!
 
-Ubuntu users of 14.04 LTS (Trusty) up to 15.10 (Wily) can use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb).
+Users of **Ubuntu 14.04 LTS (Trusty) up to 15.10 (Wily)** can use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb).
 
-Ubuntu 17.10 can use [this PPA](https://launchpad.net/%7Evantuz/+archive/ubuntu/cool-retro-term)
+**Ubuntu 17.10** can use [this PPA](https://launchpad.net/%7Evantuz/+archive/ubuntu/cool-retro-term)
 
-macOS users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases
+**macOS** users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases
 
 ## Build instructions (Linux)
 
+Build cool-retro-term yourself, you know, the retro way.
+
 ## Dependencies
 Make sure to install these first.
 

app/qml/ApplicationSettings.qml

@@ -33,6 +33,9 @@ QtObject{
     readonly property real minimumFontScaling: 0.25
     readonly property real maximumFontScaling: 2.50
 
+    readonly property real minBurnInFadeTime: 160
+    readonly property real maxBurnInFadeTime: 1600
+
     // GENERAL SETTINGS ///////////////////////////////////////////////////////
 
     property int x: 100
@@ -52,7 +55,9 @@ QtObject{
     property bool verbose: false
 
     property real bloomQuality: 0.5
+
     property real burnInQuality: 0.5
+    property bool useFastBurnIn: Qt.platform.os === "osx" ? false : true
 
     onWindowScalingChanged: handleFontChanged();
 
@@ -202,7 +207,8 @@ QtObject{
             bloomQuality: bloomQuality,
             burnInQuality: burnInQuality,
             useCustomCommand: useCustomCommand,
-            customCommand: customCommand
+            customCommand: customCommand,
+            useFastBurnIn: useFastBurnIn
         }
         return stringify(settings);
     }
@@ -288,6 +294,8 @@ QtObject{
 
         useCustomCommand = settings.useCustomCommand !== undefined ? settings.useCustomCommand : useCustomCommand
         customCommand = settings.customCommand !== undefined ? settings.customCommand : customCommand
+
+        useFastBurnIn = settings.useFastBurnIn !== undefined ? settings.useFastBurnIn : useFastBurnIn;
     }
 
     function loadProfileString(profileString){

app/qml/BurnInEffect.qml

@@ -13,10 +13,12 @@ Loader {
     property real delay: (1.0 / appSettings.fps) * 1000
     property real burnIn: appSettings.burnIn
     property real burnInFadeTime: 1 / Utils.lint(_minBurnInFadeTime, _maxBurnInFadeTime, burnIn)
-    property real _minBurnInFadeTime: 160
+    property real _minBurnInFadeTime: appSettings.minBurnInFadeTime
-    property real _maxBurnInFadeTime: 1600
+    property real _maxBurnInFadeTime: appSettings.maxBurnInFadeTime
 
-    active: appSettings.burnIn !== 0
+    active: appSettings.useFastBurnIn && appSettings.burnIn !== 0
+
+    anchors.fill: parent
 
     function completelyUpdate() {
         prevLastUpdate = lastUpdate;
@@ -33,16 +35,6 @@ Loader {
     sourceComponent: Item {
         property alias source: burnInEffectSource
 
-        property int burnInScaling: scaleTexture * appSettings.burnInQuality
-
-        width: appSettings.lowResolutionFont
-               ? kterminal.totalWidth * Math.max(1, burnInScaling)
-               : kterminal.totalWidth * scaleTexture * appSettings.burnInQuality
-
-        height: appSettings.lowResolutionFont
-                ? kterminal.totalHeight * Math.max(1, burnInScaling)
-                : kterminal.totalHeight * scaleTexture * appSettings.burnInQuality
-
         ShaderEffectSource {
             id: burnInEffectSource
 
@@ -88,7 +80,6 @@ Loader {
             property real prevLastUpdate: burnInEffect.prevLastUpdate
 
             anchors.fill: parent
-
             blending: false
 
             fragmentShader:

app/qml/NewTerminalFrame.qml

@@ -61,7 +61,7 @@ ShaderEffect {
             float inShadowLength = shadowLength * 0.5;
 
             float outShadow = max2(1.0 - smoothstep(vec2(-outShadowLength), vec2(0.0), coords) + smoothstep(vec2(1.0), vec2(1.0 + outShadowLength), coords));
-            outShadow = clamp(0.0, 1.0, sqrt(outShadow));
+            outShadow = clamp(sqrt(outShadow), 0.0, 1.0);
             color += frameColor.rgb * outShadow;
             alpha = sum2(1.0 - smoothstep(vec2(0.0), aadelta, coords) + smoothstep(vec2(1.0) - aadelta, vec2(1.0), coords));
             alpha = clamp(alpha, 0.0, 1.0) * mix(1.0, 0.9, outShadow);

app/qml/PreprocessedTerminal.qml

@@ -33,6 +33,7 @@ Item{
 
     property ShaderEffectSource mainSource: kterminalSource
     property BurnInEffect burnInEffect: burnInEffect
+    property SlowBurnIn slowBurnInEffect: slowBurnInEffect
     property real fontWidth: 1.0
     property real screenScaling: 1.0
     property real scaleTexture: 1.0
@@ -70,12 +71,23 @@ Item{
     QMLTermWidget {
         id: kterminal
 
+        property int textureResolutionScale: appSettings.lowResolutionFont ? devicePixelRatio : 1
         property int margin: appSettings.margin / screenScaling
         property int totalWidth: Math.floor(parent.width / (screenScaling * fontWidth))
         property int totalHeight: Math.floor(parent.height / screenScaling)
 
-        width: totalWidth - 2 * margin
+        property int rawWidth: totalWidth - 2 * margin
-        height: totalHeight - 2 * margin
+        property int rawHeight: totalHeight - 2 * margin
+
+        textureSize: Qt.size(width / textureResolutionScale, height / textureResolutionScale)
+
+        width: ensureMultiple(rawWidth, devicePixelRatio)
+        height: ensureMultiple(rawHeight, devicePixelRatio)
+
+        /** Ensure size is a multiple of factor. This is needed for pixel perfect scaling on highdpi screens. */
+        function ensureMultiple(size, factor) {
+            return Math.round(size / factor) * factor;
+        }
 
         colorScheme: "cool-retro-term"
 
@@ -227,7 +239,26 @@ Item{
         sourceRect: Qt.rect(-kterminal.margin, -kterminal.margin, kterminal.totalWidth, kterminal.totalHeight)
     }
 
-    BurnInEffect {
+    Item {
-        id: burnInEffect
+        id: burnInContainer
+
+        property int burnInScaling: scaleTexture * appSettings.burnInQuality
+
+        width: Math.round(appSettings.lowResolutionFont
+               ? kterminal.totalWidth * Math.max(1, burnInScaling)
+               : kterminal.totalWidth * scaleTexture * appSettings.burnInQuality)
+
+        height: Math.round(appSettings.lowResolutionFont
+                ? kterminal.totalHeight * Math.max(1, burnInScaling)
+                : kterminal.totalHeight * scaleTexture * appSettings.burnInQuality)
+
+
+        BurnInEffect {
+            id: burnInEffect
+        }
+
+        SlowBurnIn {
+            id: slowBurnInEffect
+        }
     }
 }

app/qml/SettingsAdvancedTab.qml

@@ -133,6 +133,12 @@ Tab{
                     }
                 }
                 SizedLabel{text: Math.round(burnInSlider.value * 100) + "%"}
+                CheckBox{
+                    Layout.columnSpan: 2
+                    text: qsTr("Burnin optimization (Might display timing artifacts)")
+                    checked: appSettings.useFastBurnIn
+                    onCheckedChanged: appSettings.useFastBurnIn = checked
+                }
             }
         }
     }

app/qml/ShaderTerminal.qml

@@ -24,6 +24,7 @@ import QtGraphicalEffects 1.0
 import "utils.js" as Utils
 
 Item {
+    property SlowBurnIn slowBurnInEffect
     property ShaderEffectSource source
     property BurnInEffect burnInEffect
     property ShaderEffectSource bloomSource
@@ -56,9 +57,16 @@ Item {
          property real horizontalSync: appSettings.horizontalSync
          property real horizontalSyncStrength: Utils.lint(0.05, 0.35, horizontalSync)
          property real glowingLine: appSettings.glowingLine * 0.2
-         property real burnIn: appSettings.burnIn
+
+         // Fast burnin properties
+         property real burnIn: appSettings.useFastBurnIn ? appSettings.burnIn : 0
          property real burnInLastUpdate: burnInEffect.lastUpdate
          property real burnInTime: burnInEffect.burnInFadeTime
+
+         // Slow burnin properties
+         property real slowBurnIn: appSettings.useFastBurnIn ? 0 : appSettings.burnIn
+         property ShaderEffectSource slowBurnInSource: slowBurnInEffect.source
+
          property real jitter: appSettings.jitter
          property size jitterDisplacement: Qt.size(0.007 * jitter, 0.002 * jitter)
          property real shadowLength: 0.25 * screenCurvature * Utils.lint(0.50, 1.5, ambientLight)
@@ -162,6 +170,8 @@ Item {
                  uniform sampler2D burnInSource;
                  uniform highp float burnInLastUpdate;
                  uniform highp float burnInTime;" : "") +
+             (slowBurnIn !== 0 ? "
+                 uniform sampler2D slowBurnInSource;" : "") +
              (staticNoise !== 0 ? "
                  uniform highp float staticNoise;" : "") +
              (((staticNoise !== 0 || jitter !== 0)
@@ -292,6 +302,11 @@ Item {
                      txt_color = max(txt_color, convertWithChroma(burnInColor));"
                  : "") +
 
+                 (slowBurnIn !== 0 ? "
+                     vec4 txt_blur = texture2D(slowBurnInSource, staticCoords);
+                     txt_color = max(txt_color, convertWithChroma(txt_blur.rgb * txt_blur.a));
+                 " : "") +
+
                   "txt_color += fontColor.rgb * vec3(color);" +
 
                  "vec3 finalColor = txt_color;" +
@@ -482,7 +497,7 @@ Item {
 
                  (screenCurvature !== 0 ? "
                      float reflectionMask = sum2(step(vec2(0.0), curvatureCoords) - step(vec2(1.0), curvatureCoords));
-                     reflectionMask = clamp(0.0, 1.0, reflectionMask);"
+                     reflectionMask = clamp(reflectionMask, 0.0, 1.0);"
                  :
                      "float reflectionMask = 1.0;") +
 

app/qml/SlowBurnIn.qml

@@ -0,0 +1,122 @@
+import QtQuick 2.0
+
+import "utils.js" as Utils
+
+Loader {
+    property ShaderEffectSource source: item ? item.source : null
+
+    active: !appSettings.useFastBurnIn && appSettings.burnIn !== 0
+
+    anchors.fill: parent
+
+    sourceComponent: Item {
+        property alias source: burnInSourceEffect
+
+        property int burnInScaling: scaleTexture * appSettings.burnInQuality
+
+        ShaderEffectSource {
+            property bool updateBurnIn: false
+            property real burnIn: appSettings.burnIn
+            property real fps: appSettings.fps !== 0 ? appSettings.fps : 60
+            property real burnInFadeTime: Utils.lint(minBurnInFadeTime, maxBurnInFadeTime, burnIn)
+            property real burnInCoefficient: 1000 / (fps * burnInFadeTime)
+            property real minBurnInFadeTime: appSettings.minBurnInFadeTime
+            property real maxBurnInFadeTime: appSettings.maxBurnInFadeTime
+
+            id: burnInSourceEffect
+
+            anchors.fill: parent
+
+            sourceItem: burnInEffect
+            recursive: true
+            live: false
+            hideSource: true
+            wrapMode: kterminalSource.wrapMode
+
+            visible: false
+
+            function restartBlurSource(){
+                livetimer.restart();
+            }
+
+            // This updates the burnin synched with the timer.
+            Connections {
+                target: burnInSourceEffect.updateBurnIn ? timeManager : null
+                ignoreUnknownSignals: false
+                onTimeChanged: {
+                    burnInSourceEffect.scheduleUpdate();
+                }
+            }
+
+            Timer{
+                id: livetimer
+
+                // The interval assumes 60 fps. This is the time needed burnout a white pixel.
+                // We multiply 1.1 to have a little bit of margin over the theoretical value.
+                // This solution is not extremely clean, but it's probably the best to avoid measuring fps.
+
+                interval: burnInSourceEffect.burnInFadeTime * 1.1
+                running: true
+                onTriggered: burnInSourceEffect.updateBurnIn = false;
+            }
+            Connections{
+                target: kterminal
+                onImagePainted:{
+                    burnInSourceEffect.scheduleUpdate();
+                    burnInSourceEffect.updateBurnIn = true;
+                    livetimer.restart();
+                }
+            }
+            // Restart blurred source settings change.
+            Connections{
+                target: appSettings
+                onBurnInChanged: burnInSourceEffect.restartBlurSource();
+                onTerminalFontChanged: burnInSourceEffect.restartBlurSource();
+                onRasterizationChanged: burnInSourceEffect.restartBlurSource();
+                onBurnInQualityChanged: burnInSourceEffect.restartBlurSource();
+            }
+            Connections {
+                target: kterminalScrollbar
+                onOpacityChanged: burnInSourceEffect.restartBlurSource();
+            }
+
+            ShaderEffect {
+                id: burnInEffect
+
+                property variant txt_source: kterminalSource
+                property variant blurredSource: burnInSourceEffect
+                property real burnInCoefficient: burnInSourceEffect.burnInCoefficient
+
+                anchors.fill: parent
+                blending: false
+
+                fragmentShader:
+                    "#ifdef GL_ES
+                    precision mediump float;
+                #endif\n" +
+
+                "uniform lowp float qt_Opacity;" +
+                "uniform lowp sampler2D txt_source;" +
+
+                "varying highp vec2 qt_TexCoord0;
+             uniform lowp sampler2D blurredSource;
+             uniform highp float burnInCoefficient;" +
+
+                "float max3(vec3 v) {
+                     return max (max (v.x, v.y), v.z);
+                }" +
+
+                "void main() {" +
+                    "vec2 coords = qt_TexCoord0;" +
+                    "vec3 origColor = texture2D(txt_source, coords).rgb;" +
+                    "vec3 blur_color = texture2D(blurredSource, coords).rgb - vec3(burnInCoefficient);" +
+                    "vec3 color = min(origColor + blur_color, max(origColor, blur_color));" +
+
+                    "gl_FragColor = vec4(color, max3(color - origColor));" +
+                "}"
+
+                onStatusChanged: if (log) console.log(log) //Print warning messages
+            }
+        }
+    }
+}

app/qml/TerminalContainer.qml

@@ -12,6 +12,7 @@ ShaderTerminal {
 
     source: terminal.mainSource
     burnInEffect: terminal.burnInEffect
+    slowBurnInEffect: terminal.slowBurnInEffect
     virtual_resolution: terminal.virtualResolution
 
     TimeManager{

app/qml/resources.qrc

@@ -43,5 +43,6 @@
         <file>BurnInEffect.qml</file>
         <file>fonts/modern-terminus/TerminusTTF-4.46.0.ttf</file>
         <file>NewTerminalFrame.qml</file>
+        <file>SlowBurnIn.qml</file>
     </qresource>
 </RCC>