Merge lp:~compiz-team/compiz/compiz.workaround_92599 into lp:compiz/0.9.8

[Sam Spilsbury]

Workaround (LP: #92599) by forcing the user specified refresh rate on nvidia.

Workaround (LP: #92599) by forcing the user specified refresh rate on nvidia. There are no tests as I anticipate this feature will be removed once we hear about the correct way to handle this.

[jenkins (martin-mrazik+qa)]

PASSED: Continuous integration, rev:3388
http://jenkins.qa.ubuntu.com/job/compiz-ci/122/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/compiz-ci/./build=pbuilder,distribution=quantal,flavor=amd64/122/console

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

No obvious regressions. I've only tested on intel though. Not Nvidia.

It's not important but I would have written:
    const bool forceRefreshRate = (pHnd ? pHnd->requiredForcedRefreshRate () : false);
as:
    const bool forceRefreshRate = pHnd && pHnd->requiredForcedRefreshRate ();
which is a little bit more readable.

What is important is this fix/workaround. Approved.

review: Approve

=== modified file 'plugins/composite/include/composite/composite.h'
--- plugins/composite/include/composite/composite.h	2012-09-20 09:35:40 +0000
+++ plugins/composite/include/composite/composite.h	2012-09-25 11:20:51 +0000
@@ -30,7 +30,7 @@
 
 #include <X11/extensions/Xcomposite.h>
 
-#define COMPIZ_COMPOSITE_ABI 4
+#define COMPIZ_COMPOSITE_ABI 5
 
 #include "core/pluginclasshandler.h"
 #include "core/timer.h"
@@ -106,6 +106,7 @@
 			       const CompRegion    &region) = 0;
 
     virtual bool hasVSync () { return false; };
+    virtual bool requiredForcedRefreshRate () { return false; };
 
     virtual void prepareDrawing () {};
     virtual bool compositingActive () { return false; };

=== modified file 'plugins/composite/src/screen.cpp'
--- plugins/composite/src/screen.cpp	2012-09-20 09:35:40 +0000
+++ plugins/composite/src/screen.cpp	2012-09-25 11:20:51 +0000
@@ -427,6 +427,8 @@
 
     priv->pHnd = pHnd;
 
+    priv->detectRefreshRate ();
+
     showOutputWindow ();
 
     return true;
@@ -457,6 +459,8 @@
     priv->pHnd = NULL;
     priv->paintTimer.stop ();
 
+    priv->detectRefreshRate ();
+
     hideOutputWindow ();
 }
 
@@ -650,7 +654,10 @@
 void
 PrivateCompositeScreen::detectRefreshRate ()
 {
-    if (optionGetDetectRefreshRate ())
+    const bool forceRefreshRate = (pHnd ? pHnd->requiredForcedRefreshRate () : false);
+    const bool detect = optionGetDetectRefreshRate () && !forceRefreshRate;
+
+    if (detect)
     {
 	CompString        name;
 	CompOption::Value value;

=== modified file 'plugins/opengl/src/privates.h'
--- plugins/opengl/src/privates.h	2012-09-20 09:35:40 +0000
+++ plugins/opengl/src/privates.h	2012-09-25 11:20:51 +0000
@@ -135,6 +135,7 @@
 			   const CompRegion    &region);
 
 	bool hasVSync ();
+	bool requiredForcedRefreshRate ();
 
 	void updateRenderMode ();
 
@@ -199,6 +200,8 @@
 	std::vector<GLTexture::BindPixmapProc> bindPixmap;
 	bool hasCompositing;
 	bool commonFrontbuffer;
+	bool incorrectRefreshRate; // hack for NVIDIA specifying an incorrect
+				   // refresh rate, causing us to miss vblanks
 
 	GLIcon defaultIcon;
 

=== modified file 'plugins/opengl/src/screen.cpp'
--- plugins/opengl/src/screen.cpp	2012-09-25 08:11:48 +0000
+++ plugins/opengl/src/screen.cpp	2012-09-25 11:20:51 +0000
@@ -500,6 +500,8 @@
     if (GL::textureFromPixmap)
 	registerBindPixmap (EglTexture::bindPixmapToTexture);
 
+    priv->incorrectRefreshRate = false;
+
     #else
 
     Display		 *dpy = screen->dpy ();
@@ -509,6 +511,7 @@
     GLfloat		 diffuseLight[]   = { 0.9f, 0.9f,  0.9f, 0.9f };
     GLfloat		 light0Position[] = { -0.5f, 0.5f, -9.0f, 1.0f };
     const char           *glRenderer;
+    const char           *glVendor;
     CompOption::Vector o (0);
 
     priv->ctx = glXCreateContext (dpy, visinfo, NULL, True);
@@ -548,6 +551,7 @@
     }
 
     glRenderer = (const char *) glGetString (GL_RENDERER);
+    glVendor = (const char *) glGetString (GL_VENDOR);
     if (glRenderer != NULL &&
 	(strcmp (glRenderer, "Software Rasterizer") == 0 ||
 	 strcmp (glRenderer, "Mesa X11") == 0))
@@ -560,6 +564,7 @@
     }
 
     priv->commonFrontbuffer = true;
+    priv->incorrectRefreshRate = false;
     if (glRenderer != NULL && strstr (glRenderer, "on llvmpipe"))
     {
 	/*
@@ -572,6 +577,14 @@
 	priv->commonFrontbuffer = false;
     }
 
+    if (glVendor != NULL && strstr (glVendor, "NVIDIA"))
+    {
+	/*
+	 * NVIDIA provides an incorrect refresh rate, we need to
+	 * force 60Hz */
+	priv->incorrectRefreshRate = true;
+    }
+
     if (strstr (glExtensions, "GL_ARB_texture_non_power_of_two"))
 	GL::textureNonPowerOfTwo = true;
     GL::textureNonPowerOfTwoMipmap = GL::textureNonPowerOfTwo;
@@ -2086,6 +2099,12 @@
 }
 
 bool
+PrivateGLScreen::requiredForcedRefreshRate ()
+{
+    return incorrectRefreshRate;
+}
+
+bool
 PrivateGLScreen::compositingActive ()
 {
     return true;

=== added file 'tests/manual/NVIDIAForceRefreshRate.txt'
--- tests/manual/NVIDIAForceRefreshRate.txt	1970-01-01 00:00:00 +0000
+++ tests/manual/NVIDIAForceRefreshRate.txt	2012-09-25 11:20:51 +0000
@@ -0,0 +1,12 @@
+NVIDIA REFRESH RATE
+===================
+Sam Spilsbury <[e-mail]>
+
+Force Refresh Rate
+------------------
+Actions
+#. Open ccsm and turn "Benchmark" on
+#. Hit Alt-F12
+#. Run glxgears
+#. Benchmark should display roughly under 60 frames per second
+   and not under 50 frames per second