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

[Sam Spilsbury]

Delay unbinding of pixmaps until then next rebind (so that they stay bound until we are able to get the next one so you never actually lose the image of the window) and added a callback mechanism to notify renderers just before the pixmap is replaced (so they can do any necessary cleanup such as unbinding textures).

The reason for this is because the nvidia driver seems to require that any textures that are bound to the pixmap are unbound before the pixmap is released. Otherwise it will cause any futher rebind operations to fail silently.

[Sam Spilsbury (smspillaz)]

A small note here - I am writing the tests for this now ... they will come subsequently, some refactoring is required

[Daniel van Vugt (vanvugt)]

Looks good, works well.

I believe the static on line 129 is probably pointless, but don't care.

review: Approve

=== modified file 'plugins/composite/include/composite/composite.h'
--- plugins/composite/include/composite/composite.h	2012-02-08 10:54:35 +0000
+++ plugins/composite/include/composite/composite.h	2012-05-25 05:56:18 +0000
@@ -327,6 +327,8 @@
 {
     public:
 
+	typedef boost::function <void ()> NewPixmapReadyCallback;
+
 	CompositeWindow (CompWindow *w);
 	~CompositeWindow ();
 
@@ -424,6 +426,12 @@
 	 */
 	unsigned short saturation ();
 
+	/**
+	 * A function to call when a new pixmap is ready to
+	 * be bound just before the old one is released
+	 */
+	void setNewPixmapReadyCallback (const NewPixmapReadyCallback &cb);
+
 	WRAPABLE_HND (0, CompositeWindowInterface, bool, damageRect,
 		      bool, const CompRect &);
 

=== modified file 'plugins/composite/src/privates.h'
--- plugins/composite/src/privates.h	2012-03-27 12:14:56 +0000
+++ plugins/composite/src/privates.h	2012-05-25 05:56:18 +0000
@@ -131,6 +131,8 @@
 
 	Pixmap	      pixmap;
 	CompSize      size;
+	bool	      needsRebind;
+	CompositeWindow::NewPixmapReadyCallback newPixmapReadyCallback;
 
 	Damage	      damage;
 

=== modified file 'plugins/composite/src/window.cpp'
--- plugins/composite/src/window.cpp	2012-04-19 12:06:05 +0000
+++ plugins/composite/src/window.cpp	2012-05-25 05:56:18 +0000
@@ -82,12 +82,20 @@
     delete priv;
 }
 
+void
+CompositeWindow::setNewPixmapReadyCallback (const NewPixmapReadyCallback &cb)
+{
+    priv->newPixmapReadyCallback = cb;
+}
+
 PrivateCompositeWindow::PrivateCompositeWindow (CompWindow      *w,
 						CompositeWindow *cw) :
     window (w),
     cWindow (cw),
     cScreen (CompositeScreen::get (screen)),
     pixmap (None),
+    needsRebind (true),
+    newPixmapReadyCallback (),
     damage (None),
     damaged (false),
     redirected (cScreen->compositingActive ()),
@@ -117,7 +125,7 @@
 	return false;
 
     redirect ();
-    if (!priv->pixmap)
+    if (priv->needsRebind)
     {
 	XWindowAttributes attr;
 
@@ -141,12 +149,36 @@
 	    return false;
 	}
 
-	priv->pixmap = XCompositeNameWindowPixmap
+	Pixmap newPixmap = XCompositeNameWindowPixmap
 	    (screen->dpy (), ROOTPARENT (priv->window));
-	priv->size = CompSize (attr.border_width * 2 + attr.width,
-			       attr.border_width * 2 + attr.height);
+	CompSize newSize = CompSize (attr.border_width * 2 + attr.width,
+			             attr.border_width * 2 + attr.height);
 	XUngrabServer (screen->dpy ());
 	XSync (screen->dpy (), false);
+
+	if (newPixmap && newSize.width () && newSize.height ())
+	{
+	    /* Notify renderer that a new pixmap is about to
+	     * be bound */
+	    if (priv->newPixmapReadyCallback)
+		priv->newPixmapReadyCallback ();
+
+	    /* Release old pixmap */
+	    if (priv->pixmap)
+		XFreePixmap (screen->dpy (), priv->pixmap);
+
+	    /* Assign new pixmap */
+	    priv->pixmap = newPixmap;
+	    priv->size = newSize;
+
+	    priv->needsRebind = false;
+	}
+	else
+	{
+	    priv->bindFailed = true;
+	    priv->needsRebind = false;
+	    return false;
+	}
     }
     return true;
 }
@@ -154,17 +186,17 @@
 void
 CompositeWindow::release ()
 {
-    if (priv->pixmap)
-    {
-	XFreePixmap (screen->dpy (), priv->pixmap);
-	priv->pixmap = None;
-	priv->size = CompSize ();
-    }
+    priv->needsRebind = true;
 }
 
 Pixmap
 CompositeWindow::pixmap ()
 {
+    static Pixmap nPixmap = None;
+
+    if (priv->needsRebind)
+	return nPixmap;
+
     return priv->pixmap;
 }
 
@@ -588,8 +620,6 @@
     else
     {
 	cWindow->release ();
-	this->pixmap = pixmap;
-	this->size = size;
     }
 
     cWindow->addDamage ();

=== modified file 'plugins/opengl/src/privates.h'
--- plugins/opengl/src/privates.h	2012-04-23 05:36:16 +0000
+++ plugins/opengl/src/privates.h	2012-05-25 05:56:18 +0000
@@ -148,6 +148,8 @@
 	void setWindowMatrix ();
 	void updateWindowRegions ();
 
+	void clearTextures ();
+
 	CompWindow      *window;
 	GLWindow        *gWindow;
 	CompositeWindow *cWindow;

=== modified file 'plugins/opengl/src/window.cpp'
--- plugins/opengl/src/window.cpp	2012-04-18 11:44:01 +0000
+++ plugins/opengl/src/window.cpp	2012-05-25 05:56:18 +0000
@@ -68,10 +68,13 @@
 
     WindowInterface::setHandler (w);
     CompositeWindowInterface::setHandler (cWindow);
+
+    cWindow->setNewPixmapReadyCallback (boost::bind (&PrivateGLWindow::clearTextures, this));
 }
 
 PrivateGLWindow::~PrivateGLWindow ()
 {
+    cWindow->setNewPixmapReadyCallback (boost::function <void ()> ());
 }
 
 void
@@ -92,10 +95,16 @@
     updateState &= ~(UpdateMatrix);
 }
 
+void
+PrivateGLWindow::clearTextures ()
+{
+    textures.clear ();
+}
+
 bool
 GLWindow::bind ()
 {
-    if ((!priv->cWindow->pixmap () && !priv->cWindow->bind ()))
+    if ((priv->needsRebind && !priv->cWindow->bind ()))
     {
 	if (!priv->textures.empty ())
 	{
@@ -115,6 +124,7 @@
 	compLogMessage ("opengl", CompLogLevelInfo,
 			"Couldn't bind redirected window 0x%x to "
 			"texture\n", (int) priv->window->id ());
+	return false;
     }
     else
     {
@@ -130,11 +140,6 @@
 void
 GLWindow::release ()
 {
-    /* Release the pixmap but don't release
-     * the texture (yet) */
-    if (priv->cWindow->pixmap ())
-	priv->cWindow->release ();
-
     priv->needsRebind = true;
 }