Merge lp:~mc-return/compiz/compiz.merge-fix1106270-showmouse-plugin-needs-port-to-GLES into lp:compiz/0.9.9

[MC Return]

Showmouse plugin OpenGL|ES port.

Thanks go to Michail Bitzes for porting Firepaint first,
as those 2 plugins share a lot of code, his work made this
job here possible in the first place.

Build showmouse for OpenGL|ES as well.
Also install showmouse on armel and armhf.

(LP: #1106270)

[Sam Spilsbury (smspillaz)]

Again, well done, thanks for the effort.

The only things I would point out are:

1. You probably need to update .install.armhf too (only .install.armel is updated)
2. Coding style: spaces between both brackets () and operators foo + bar not foo+ bar

[Sam Spilsbury (smspillaz)]

review: Needs Fixing

[lp:~mc-return/compiz/compiz.merge-fix1106270-showmouse-plugin-needs-port-to-GLES]

3588. By MC Return on 2013-01-27

Also install showmouse on armhf

3589. By MC Return on 2013-01-27

Hopefully fixed coding style

[MC Return (mc-return)]

> Again, well done, thanks for the effort.
>
Most credit in this case goes to Michail Bitzes.

> The only things I would point out are:
>
> 1. You probably need to update .install.armhf too (only .install.armel is
> updated)

Seems I forgot to save the file before the commit. Thanks for noticing. Fixed.

> 2. Coding style: spaces between both brackets () and operators foo + bar not
> foo+ bar

I hope I got them all. We need to fix those for firepaint as well then, seems
they slipped through there as well...

review: Needs Resubmitting

[Sam Spilsbury (smspillaz)]

Not able to test it at the moment but code wise this is a +1 from me.

review: Approve

[Michail Bitzes (bitzesmichail)]

Line 83 in showmouse.cpp:

I think it's:
      if (particles.size () * 6 * 3 > vertices_cache.size ())
Not:
      if (particles.size () > vertices_cache.size ())

vertices_cache needs space for 6 vertices, 3 for each triangle(2 triangles per particle), each vertex is stored as 3 GLfloats.

It could be inverted like that(and similarly for the rest caches):
      if (vertices_cache.size () < particles.size () * 6 * 3)
it makes reading it a bit clearer.

review: Needs Fixing

[lp:~mc-return/compiz/compiz.merge-fix1106270-showmouse-plugin-needs-port-to-GLES]

3590. By MC Return on 2013-01-27

Fixed wrong calculation in if condition, vertices_cache needs place for 6 vertices
(3 for each triangle, 2 triangles per particle)
Also inverted the statements in the if conditions checking cache_size to improve
readability
Credits & thanks (once again): Michail Bitzes

3591. By MC Return on 2013-01-27

Fixed indentation

[MC Return (mc-return)]

> Line 83 in showmouse.cpp:
>
> I think it's:
> if (particles.size () * 6 * 3 > vertices_cache.size ())
> Not:
> if (particles.size () > vertices_cache.size ())
>
> vertices_cache needs space for 6 vertices, 3 for each triangle(2 triangles per
> particle), each vertex is stored as 3 GLfloats.
>
> It could be inverted like that(and similarly for the rest caches):
> if (vertices_cache.size () < particles.size () * 6 * 3)
> it makes reading it a bit clearer.

Hopefully fixed now. :) Thanks for noticing.
Michail, could you (and do you want to) do some wizard GLES magic as well ?

review: Needs Resubmitting

[Michail Bitzes (bitzesmichail)]

Yes, I will look at wizard soon.

You can also fix the C++-style comments in showmouse.cpp, there are several, including the ones in my code ("//first triangle" etc)

(http://wiki.compiz.org/Development/CodingStyle says that only /* */ comments should be used)

[MC Return (mc-return)]

> Yes, I will look at wizard soon.
>
Cool, that are awesome news :)

> You can also fix the C++-style comments in showmouse.cpp, there are several,
> including the ones in my code ("//first triangle" etc)
>
> (http://wiki.compiz.org/Development/CodingStyle says that only /* */ comments
> should be used)
I think it is no big deal to use "//" comments for one-liners, not sure if those
really need fixing...

[Michail Bitzes (bitzesmichail)]

review: Approve

[Timo Jyrinki (timo-jyrinki)]

Looks and builds fine for me.

review: Approve

=== modified file 'debian/compiz-plugins.install.armel'
--- debian/compiz-plugins.install.armel	2013-01-24 08:14:41 +0000
+++ debian/compiz-plugins.install.armel	2013-01-27 19:37:21 +0000
@@ -33,6 +33,8 @@
 debian/tmp/usr/*/compiz/*shelf.*
 debian/tmp/usr/*/compiz/*shift.*
 debian/tmp/usr/*/compiz/*showdesktop.*
+debian/tmp/usr/*/compiz/*showmouse.*
+debian/tmp/usr/share/compiz/showmouse
 debian/tmp/usr/*/compiz/*switcher.*
 debian/tmp/usr/*/compiz/*text.*
 debian/tmp/usr/*/compiz/*titleinfo.*

=== modified file 'debian/compiz-plugins.install.armhf'
--- debian/compiz-plugins.install.armhf	2013-01-24 08:14:41 +0000
+++ debian/compiz-plugins.install.armhf	2013-01-27 19:37:21 +0000
@@ -33,6 +33,8 @@
 debian/tmp/usr/*/compiz/*shelf.*
 debian/tmp/usr/*/compiz/*shift.*
 debian/tmp/usr/*/compiz/*showdesktop.*
+debian/tmp/usr/*/compiz/*showmouse.*
+debian/tmp/usr/share/compiz/showmouse
 debian/tmp/usr/*/compiz/*switcher.*
 debian/tmp/usr/*/compiz/*text.*
 debian/tmp/usr/*/compiz/*titleinfo.*

=== modified file 'plugins/CMakeLists.txt'
--- plugins/CMakeLists.txt	2013-01-20 11:15:20 +0000
+++ plugins/CMakeLists.txt	2013-01-27 19:37:21 +0000
@@ -46,7 +46,6 @@
     set (COMPIZ_DISABLE_PLUGIN_BENCH ON)
     set (COMPIZ_DISABLE_PLUGIN_SHOWREPAINT ON)
     set (COMPIZ_DISABLE_PLUGIN_WIDGET ON)
-    set (COMPIZ_DISABLE_PLUGIN_SHOWMOUSE ON)
     set (COMPIZ_DISABLE_PLUGIN_SPLASH ON)
     set (COMPIZ_DISABLE_PLUGIN_THUMBNAIL ON)
     set (COMPIZ_DISABLE_PLUGIN_WIZARD ON)

=== modified file 'plugins/showmouse/src/showmouse.cpp'
--- plugins/showmouse/src/showmouse.cpp	2013-01-07 19:48:41 +0000
+++ plugins/showmouse/src/showmouse.cpp	2013-01-27 19:37:21 +0000
@@ -84,20 +84,10 @@
     darken = 0;
 
     // Initialize cache
-    vertices_cache.cache = NULL;
-    colors_cache.cache   = NULL;
-    coords_cache.cache   = NULL;
-    dcolors_cache.cache  = NULL;
-
-    vertices_cache.count  = 0;
-    colors_cache.count   = 0;
-    coords_cache.count  = 0;
-    dcolors_cache.count = 0;
-
-    vertices_cache.size  = 0;
-    colors_cache.size   = 0;
-    coords_cache.size  = 0;
-    dcolors_cache.size = 0;
+    vertices_cache.clear ();
+    coords_cache.clear ();
+    colors_cache.clear ();
+    dcolors_cache.clear ();
 
     for (int i = 0; i < f_numParticles; i++)
     {
@@ -108,14 +98,23 @@
 }
 
 void
-ParticleSystem::drawParticles ()
+ParticleSystem::drawParticles (const GLMatrix    &transform)
 {
-    GLfloat *dcolors;
-    GLfloat *vertices;
-    GLfloat *coords;
-    GLfloat *colors;
-
-    glPushMatrix ();
+    int i, j, k, l;
+
+    /* Check that the cache is big enough */
+    if (vertices_cache.size () < particles.size () * 6 * 3)
+	vertices_cache.resize (particles.size () * 6 * 3);
+
+    if (coords_cache.size () < particles.size () * 6 * 2)
+	coords_cache.resize (particles.size () * 6 * 2);
+
+    if (colors_cache.size () < particles.size () * 6 * 4)
+	colors_cache.resize (particles.size () * 6 * 4);
+
+    if (darken > 0)
+	if (dcolors_cache.size () < particles.size () * 6 * 4)
+	    dcolors_cache.resize (particles.size () * 6 * 4);
 
     glEnable (GL_BLEND);
 
@@ -125,172 +124,171 @@
 	glEnable (GL_TEXTURE_2D);
     }
 
-    glTexEnvf (GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
-
-    /* Check that the cache is big enough */
-
-    if (particles.size () > vertices_cache.count)
-    {
-	vertices_cache.cache = (GLfloat *) realloc (vertices_cache.cache,
-						    particles.size () * 4 * 3 *
-						    sizeof (GLfloat));
-	vertices_cache.size = particles.size () * 4 * 3;
-	vertices_cache.count = particles.size ();
-    }
-
-    if (particles.size () > coords_cache.count)
-    {
-	coords_cache.cache = (GLfloat *) realloc (coords_cache.cache,
-						  particles.size () * 4 * 2 *
-						  sizeof (GLfloat));
-	coords_cache.size = particles.size () * 4 * 2;
-	coords_cache.count = particles.size ();
-    }
-
-    if (particles.size () > colors_cache.count)
-    {
-	colors_cache.cache = (GLfloat *) realloc (colors_cache.cache,
-						  particles.size () * 4 * 4 *
-						  sizeof (GLfloat));
-	colors_cache.size = particles.size () * 4 * 4;
-	colors_cache.count = particles.size ();
-    }
-
-    if (darken > 0)
-    {
-	if (dcolors_cache.count < particles.size ())
-	{
-	    dcolors_cache.cache = (GLfloat *) realloc (dcolors_cache.cache,
-						       particles.size () * 4 * 4 *
-						       sizeof (GLfloat));
-	    dcolors_cache.size = particles.size () * 4 * 4;
-	    dcolors_cache.count = particles.size ();
-	}
-    }
-
-    dcolors  = dcolors_cache.cache;
-    vertices = vertices_cache.cache;
-    coords   = coords_cache.cache;
-    colors   = colors_cache.cache;
-
-    int numActive = 0;
-
+    i = j = k = l = 0;
+
+    /* use 2 triangles per particle */
     foreach (Particle &part, particles)
     {
 	if (part.life > 0.0f)
 	{
-	    numActive += 4;
-
 	    float w = part.width / 2;
 	    float h = part.height / 2;
 
+	    GLushort r, g, b, a, dark_a;
+
+	    r = part.r * 65535.0f;
+	    g = part.g * 65535.0f;
+	    b = part.b * 65535.0f;
+	    a = part.life * part.a * 65535.0f;
+	    dark_a = part.life * part.a * darken * 65535.0f;
+
 	    w += (w * part.w_mod) * part.life;
 	    h += (h * part.h_mod) * part.life;
 
-	    vertices[0]  = part.x - w;
-	    vertices[1]  = part.y - h;
-	    vertices[2]  = part.z;
-
-	    vertices[3]  = part.x - w;
-	    vertices[4]  = part.y + h;
-	    vertices[5]  = part.z;
-
-	    vertices[6]  = part.x + w;
-	    vertices[7]  = part.y + h;
-	    vertices[8]  = part.z;
-
-	    vertices[9]  = part.x + w;
-	    vertices[10] = part.y - h;
-	    vertices[11] = part.z;
-
-	    vertices += 12;
-
-	    coords[0] = 0.0;
-	    coords[1] = 0.0;
-
-	    coords[2] = 0.0;
-	    coords[3] = 1.0;
-
-	    coords[4] = 1.0;
-	    coords[5] = 1.0;
-
-	    coords[6] = 1.0;
-	    coords[7] = 0.0;
-
-	    coords += 8;
-
-	    colors[0]  = part.r;
-	    colors[1]  = part.g;
-	    colors[2]  = part.b;
-	    colors[3]  = part.life * part.a;
-	    colors[4]  = part.r;
-	    colors[5]  = part.g;
-	    colors[6]  = part.b;
-	    colors[7]  = part.life * part.a;
-	    colors[8]  = part.r;
-	    colors[9]  = part.g;
-	    colors[10] = part.b;
-	    colors[11] = part.life * part.a;
-	    colors[12] = part.r;
-	    colors[13] = part.g;
-	    colors[14] = part.b;
-	    colors[15] = part.life * part.a;
-
-	    colors += 16;
-
-	    if (darken > 0)
+	    //first triangle
+	    vertices_cache[i + 0] = part.x - w;
+	    vertices_cache[i + 1] = part.y - h;
+	    vertices_cache[i + 2] = part.z;
+
+	    vertices_cache[i + 3] = part.x - w;
+	    vertices_cache[i + 4] = part.y + h;
+	    vertices_cache[i + 5] = part.z;
+
+	    vertices_cache[i + 6] = part.x + w;
+	    vertices_cache[i + 7] = part.y + h;
+	    vertices_cache[i + 8] = part.z;
+
+	    //second triangle
+	    vertices_cache[i + 9] = part.x + w;
+	    vertices_cache[i + 10] = part.y + h;
+	    vertices_cache[i + 11] = part.z;
+
+	    vertices_cache[i + 12] = part.x + w;
+	    vertices_cache[i + 13] = part.y - h;
+	    vertices_cache[i + 14] = part.z;
+
+	    vertices_cache[i + 15] = part.x - w;
+	    vertices_cache[i + 16] = part.y - h;
+	    vertices_cache[i + 17] = part.z;
+
+	    i += 18;
+
+	    coords_cache[j + 0] = 0.0;
+	    coords_cache[j + 1] = 0.0;
+
+	    coords_cache[j + 2] = 0.0;
+	    coords_cache[j + 3] = 1.0;
+
+	    coords_cache[j + 4] = 1.0;
+	    coords_cache[j + 5] = 1.0;
+
+	    //second
+	    coords_cache[j + 6] = 1.0;
+	    coords_cache[j + 7] = 1.0;
+
+	    coords_cache[j + 8] = 1.0;
+	    coords_cache[j + 9] = 0.0;
+	    
+	    coords_cache[j + 10] = 0.0;
+	    coords_cache[j + 11] = 0.0;
+
+	    j += 12;
+
+	    colors_cache[k + 0] = r;
+	    colors_cache[k + 1] = g;
+	    colors_cache[k + 2] = b;
+	    colors_cache[k + 3] = a;
+
+	    colors_cache[k + 4] = r;
+	    colors_cache[k + 5] = g;
+	    colors_cache[k + 6] = b;
+	    colors_cache[k + 7] = a;
+
+	    colors_cache[k + 8] = r;
+	    colors_cache[k + 9] = g;
+	    colors_cache[k + 10] = b;
+	    colors_cache[k + 11] = a;
+
+	    //second
+	    colors_cache[k + 12] = r;
+	    colors_cache[k + 13] = g;
+	    colors_cache[k + 14] = b;
+	    colors_cache[k + 15] = a;
+
+	    colors_cache[k + 16] = r;
+	    colors_cache[k + 17] = g;
+	    colors_cache[k + 18] = b;
+	    colors_cache[k + 19] = a;
+
+	    colors_cache[k + 20] = r;
+	    colors_cache[k + 21] = g;
+	    colors_cache[k + 22] = b;
+	    colors_cache[k + 23] = a;
+
+	    k += 24;
+
+	    if(darken > 0)
 	    {
-
-		dcolors[0]  = part.r;
-		dcolors[1]  = part.g;
-		dcolors[2]  = part.b;
-		dcolors[3]  = part.life * part.a * darken;
-		dcolors[4]  = part.r;
-		dcolors[5]  = part.g;
-		dcolors[6]  = part.b;
-		dcolors[7]  = part.life * part.a * darken;
-		dcolors[8]  = part.r;
-		dcolors[9]  = part.g;
-		dcolors[10] = part.b;
-		dcolors[11] = part.life * part.a * darken;
-		dcolors[12] = part.r;
-		dcolors[13] = part.g;
-		dcolors[14] = part.b;
-		dcolors[15] = part.life * part.a * darken;
-
-		dcolors += 16;
+		dcolors_cache[l + 0] = r;
+		dcolors_cache[l + 1] = g;
+		dcolors_cache[l + 2] = b;
+		dcolors_cache[l + 3] = dark_a;
+
+		dcolors_cache[l + 4] = r;
+		dcolors_cache[l + 5] = g;
+		dcolors_cache[l + 6] = b;
+		dcolors_cache[l + 7] = dark_a;
+
+		dcolors_cache[l + 8] = r;
+		dcolors_cache[l + 9] = g;
+		dcolors_cache[l + 10] = b;
+		dcolors_cache[l + 11] = dark_a;
+
+		//second
+		dcolors_cache[l + 12] = r;
+		dcolors_cache[l + 13] = g;
+		dcolors_cache[l + 14] = b;
+		dcolors_cache[l + 15] = dark_a;
+
+		dcolors_cache[l + 16] = r;
+		dcolors_cache[l + 17] = g;
+		dcolors_cache[l + 18] = b;
+		dcolors_cache[l + 19] = dark_a;
+
+		dcolors_cache[l + 20] = r;
+		dcolors_cache[l + 21] = g;
+		dcolors_cache[l + 22] = b;
+		dcolors_cache[l + 23] = dark_a;
+
+		l += 24;
 	    }
 	}
     }
-    glEnableClientState (GL_VERTEX_ARRAY);
-    glEnableClientState (GL_TEXTURE_COORD_ARRAY);
-    glEnableClientState (GL_COLOR_ARRAY);
-
-    glTexCoordPointer (2, GL_FLOAT, 2 * sizeof (GLfloat), coords_cache.cache);
-    glVertexPointer (3, GL_FLOAT, 3 * sizeof (GLfloat), vertices_cache.cache);
-
-    // darken the background
+
+    GLVertexBuffer *stream = GLVertexBuffer::streamingBuffer ();
 
     if (darken > 0)
     {
 	glBlendFunc (GL_ZERO, GL_ONE_MINUS_SRC_ALPHA);
-	glColorPointer (4, GL_FLOAT, 4 * sizeof (GLfloat), dcolors_cache.cache);
-	glDrawArrays (GL_QUADS, 0, numActive);
+	stream->begin (GL_TRIANGLES);
+	stream->addVertices (i / 3, &vertices_cache[0]);
+	stream->addTexCoords (0, j / 2, &coords_cache[0]);
+	stream->addColors (l / 4, &dcolors_cache[0]);
+
+	if (stream->end ())
+	    stream->render (transform);
     }
 
     // draw particles
     glBlendFunc (GL_SRC_ALPHA, blendMode);
-
-    glColorPointer (4, GL_FLOAT, 4 * sizeof (GLfloat), colors_cache.cache);
-    glDrawArrays (GL_QUADS, 0, numActive);
-    glDisableClientState (GL_COLOR_ARRAY);
-    glDisableClientState (GL_TEXTURE_COORD_ARRAY);
-    glDisableClientState (GL_VERTEX_ARRAY);
-
-    glPopMatrix ();
-    glColor4usv (defaultColor);
-
-    GLScreen::get(screen)->setTexEnvMode (GL_REPLACE); // ??? 
+    stream->begin (GL_TRIANGLES);
+
+    stream->addVertices (i / 3, &vertices_cache[0]);
+    stream->addTexCoords (0, j / 2, &coords_cache[0]);
+    stream->addColors (k / 4, &colors_cache[0]);
+
+    if (stream->end ())
+	stream->render (transform);
 
     glBlendFunc (GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
     glDisable (GL_TEXTURE_2D);
@@ -333,30 +331,6 @@
 
     if (tex)
 	glDeleteTextures (1, &tex);
-
-    if (vertices_cache.cache)
-    {
-	free (vertices_cache.cache);
-	vertices_cache.cache = NULL;
-    }
-
-    if (colors_cache.cache)
-    {
-	free (colors_cache.cache);
-	colors_cache.cache = NULL;
-    }
-
-    if (coords_cache.cache)
-    {
-	free (coords_cache.cache);
-	coords_cache.cache = NULL;
-    }
-
-    if (dcolors_cache.cache)
-    {
-	free (dcolors_cache.cache);
-	dcolors_cache.cache = NULL;
-    }
 }
 
 static void
@@ -591,14 +565,7 @@
 
     sTransform.toScreenSpace (output, -DEFAULT_Z_CAMERA);
 
-    glPushMatrix ();
-    glLoadMatrixf (sTransform.getMatrix ());
-
-    ps.drawParticles ();
-
-    glPopMatrix();
-
-    glColor4usv (defaultColor);
+    ps.drawParticles (sTransform);
 
     return status;
 }

=== modified file 'plugins/showmouse/src/showmouse.h'
--- plugins/showmouse/src/showmouse.h	2012-09-04 15:33:44 +0000
+++ plugins/showmouse/src/showmouse.h	2013-01-27 19:37:21 +0000
@@ -62,15 +62,6 @@
 	float zo;		/* orginal Z position */
 };
 
-class ParticleCache
-{
-    public:
-
-	GLfloat *cache;
-	unsigned int count;
-	unsigned int size;
-};
-
 class ParticleSystem
 {
     public:
@@ -87,17 +78,19 @@
 	float    darken;
 	GLuint   blendMode;
 
-	/* Moved from drawParticles to get rid of spurious malloc's */
-	ParticleCache vertices_cache;
-	ParticleCache coords_cache;
-	ParticleCache colors_cache;
-	ParticleCache dcolors_cache;
+	/* Cache used in drawParticles 
+        It's here to avoid multiple mem allocation 
+        during drawing */
+	std::vector<GLfloat>  vertices_cache;
+	std::vector<GLfloat>  coords_cache;
+	std::vector<GLushort> colors_cache;
+	std::vector<GLushort> dcolors_cache;
 
 	void
 	initParticles (int            f_numParticles);
 
 	void
-	drawParticles ();
+	drawParticles (const GLMatrix    &transform);
 
 	void
 	updateParticles (float          time);