Move touch driver test to tools.

Also replace gwin buttons as they comptete with the test for touch events

2 files changed, 418 insertions, 0 deletions

diff --git a/tools/touch_driver_test/gfxconf.h b/tools/touch_driver_test/gfxconf.h
new file mode 100644
index 00000000..9cd0cf1f
--- /dev/null
+++ b/tools/touch_driver_test/gfxconf.h
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2012, 2013, Joel Bodenmann aka Tectu <joel@unormal.org>
+ * Copyright (c) 2012, 2013, Andrew Hannam aka inmarket
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *    * Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *    * Neither the name of the <organization> nor the
+ *      names of its contributors may be used to endorse or promote products
+ *      derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _GFXCONF_H
+#define _GFXCONF_H
+
+/* The operating system to use. One of these must be defined - preferably in your Makefile */
+//#define GFX_USE_OS_CHIBIOS	FALSE
+//#define GFX_USE_OS_WIN32		FALSE
+//#define GFX_USE_OS_LINUX		FALSE
+//#define GFX_USE_OS_OSX		FALSE
+
+/* GFX sub-systems to turn on */
+#define GFX_USE_GDISP			TRUE
+#define GFX_USE_GWIN			TRUE
+#define GFX_USE_GEVENT			TRUE
+#define GFX_USE_GTIMER			TRUE
+#define GFX_USE_GINPUT			TRUE
+
+/* Features for the GDISP sub-system. */
+#define GDISP_NEED_VALIDATION	TRUE
+#define GDISP_NEED_CLIP			TRUE
+#define GDISP_NEED_TEXT			TRUE
+#define GDISP_NEED_MULTITHREAD	TRUE
+
+/* Builtin Fonts */
+#define GDISP_INCLUDE_FONT_UI2			TRUE
+
+/* Features for the GWIN sub-system. */
+#define GWIN_NEED_CONSOLE		TRUE
+
+/* Features for the GINPUT sub-system. */
+#define GINPUT_NEED_MOUSE		TRUE
+
+#endif /* _GFXCONF_H */
diff --git a/tools/touch_driver_test/main.c b/tools/touch_driver_test/main.c
new file mode 100644
index 00000000..ef00f008
--- /dev/null
+++ b/tools/touch_driver_test/main.c
@@ -0,0 +1,357 @@
+/*
+ * Copyright (c) 2012, 2013, Joel Bodenmann aka Tectu <joel@unormal.org>
+ * Copyright (c) 2012, 2013, Andrew Hannam aka inmarket
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *    * Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *    * Neither the name of the <organization> nor the
+ *      names of its contributors may be used to endorse or promote products
+ *      derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "gfx.h"
+
+static GConsoleObject			gc;
+static GListener				gl;
+static font_t					font;
+
+/*------------------------------------------------------------------------*
+ * GINPUT Touch Driver Calibrator.                                        *
+ *------------------------------------------------------------------------*/
+int main(void) {
+	GSourceHandle			gs;
+	GEventMouse				*pem;
+	coord_t					swidth, sheight;
+	GHandle					ghc;
+	GEventType				deviceType;
+	bool_t					calibrated;
+	coord_t					bWidth, bHeight;
+
+	gfxInit();		// Initialize the display
+
+	// Get the display dimensions
+	swidth = gdispGetWidth();
+	sheight = gdispGetHeight();
+	calibrated = FALSE;
+
+	// Create our title
+	font = gdispOpenFont("UI2");
+	gwinSetDefaultFont(font);
+	bWidth = gdispGetStringWidth("Next", font);
+	bHeight = gdispGetStringWidth("Prev", font);
+	if (bHeight > bWidth) bWidth = bHeight;
+	bWidth += 4;
+	bHeight = gdispGetFontMetric(font, fontHeight)+2;
+	gdispFillStringBox(0, 0, swidth, bHeight, "Touch Calibration", font, Red, White, justifyLeft);
+
+	// Create our main display window
+	{
+		GWindowInit				wi;
+
+		wi.show = TRUE; wi.x = 0; wi.y = bHeight; wi.width = swidth; wi.height = sheight-bHeight;
+		ghc = gwinConsoleCreate(&gc, &wi);
+	}
+	gwinClear(ghc);
+
+	// Initialize the mouse in our special no calibration mode.
+	geventListenerInit(&gl);
+	gs = ginputGetMouse(9999);
+	geventAttachSource(&gl, gs, GLISTEN_MOUSEDOWNMOVES|GLISTEN_MOUSEMETA);
+
+	/*
+	 * Test: Device Type
+	 */
+
+StepDeviceType:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n1. DEVICE TYPE\n\n");
+
+	pem = (GEventMouse *)&gl.event;
+	ginputGetMouseStatus(0, pem);
+	deviceType = pem->type;
+
+	gwinSetColor(ghc, White);
+	gwinPrintf(ghc, "This is detected as a %s device\n\n",
+		deviceType == GEVENT_MOUSE ? "MOUSE" : (pem->type == GEVENT_TOUCH ? "TOUCH" : "UNKNOWN"));
+
+	if (calibrated)
+		gwinPrintf(ghc, "Press Next or Back to continue.\n");
+	else if (deviceType == GEVENT_MOUSE)
+		gwinPrintf(ghc, "Click the mouse button to move on to the next test.\n");
+	else
+		gwinPrintf(ghc, "Press and release your finger to move on to the next test.\n");
+
+	while(1) {
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (calibrated) {
+			if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+				if ((pem->meta & GMETA_MOUSE_UP)) {
+					if (pem->x >= swidth-bWidth)
+						break;
+					goto StepClickJitter;
+				}
+			}
+		} else if ((pem->meta & GMETA_MOUSE_UP))
+			break;
+	}
+
+	/*
+	 * Test: Mouse raw reading jitter
+	 */
+
+StepRawJitter:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n2. GINPUT_MOUSE_READ_CYCLES\n\n");
+
+	gwinSetColor(ghc, White);
+	if (deviceType == GEVENT_MOUSE)
+		gwinPrintf(ghc, "Press and hold the mouse button.\n\n");
+	else
+		gwinPrintf(ghc, "Press and hold on the surface.\n\n");
+	gwinPrintf(ghc, "Numbers will display in this window.\n"
+			"Ensure that values don't jump around very much when your finger is stationary.\n\n"
+			"Increasing GINPUT_MOUSE_READ_CYCLES helps reduce jitter but increases CPU usage.\n\n");
+
+	if (calibrated)
+		gwinPrintf(ghc, "Press Next or Back to continue.\n");
+	else if (deviceType == GEVENT_MOUSE)
+		gwinPrintf(ghc, "Release the mouse button to move on to the next test.\n");
+	else
+		gwinPrintf(ghc, "Release your finger to move on to the next test.\n");
+
+	// For this test turn on ALL mouse movement events
+	geventAttachSource(&gl, gs, GLISTEN_MOUSEDOWNMOVES|GLISTEN_MOUSEMETA|GLISTEN_MOUSENOFILTER);
+
+	while(1) {
+		// Always sleep a bit first to enable other events. We actually don't
+		// mind missing events for this test.
+		gfxSleepMilliseconds(100);
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (calibrated) {
+			if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+				if ((pem->meta & GMETA_MOUSE_UP)) {
+					if (pem->x >= swidth-bWidth)
+						break;
+					goto StepDeviceType;
+				}
+			}
+		} else if ((pem->meta & GMETA_MOUSE_UP))
+			break;
+		if ((pem->current_buttons & GINPUT_MOUSE_BTN_LEFT))
+			gwinPrintf(ghc, "%u:%u\n", pem->x, pem->y);
+	}
+
+	// Reset to just changed movements.
+	geventAttachSource(&gl, gs, GLISTEN_MOUSEDOWNMOVES|GLISTEN_MOUSEMETA);
+
+	/*
+	 * Test: Calibration
+	 */
+
+StepCalibrate:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n3. GINPUT_MOUSE_CALIBRATION_ERROR\n\n");
+	gwinSetColor(ghc, Gray);
+	gwinPrintf(ghc, "Ensure GINPUT_MOUSE_NEED_CALIBRATION = TRUE and GINPUT_MOUSE_CALIBRATION_ERROR is >= 0\n\n");
+	gwinSetColor(ghc, White);
+	gwinPrintf(ghc, "You will be presented with a number of points to touch.\nPress them in turn.\n\n"
+			"If the calibration repeatedly fails, increase GINPUT_MOUSE_CALIBRATION_ERROR and try again.\n\n");
+
+	if (calibrated)
+		gwinPrintf(ghc, "Press Next to start the calibration.\n");
+	else if (deviceType == GEVENT_MOUSE)
+		gwinPrintf(ghc, "Click the mouse button to start the calibration.\n");
+	else
+		gwinPrintf(ghc, "Press and release your finger to start the calibration.\n");
+
+	while(1) {
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (calibrated) {
+			if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+				if ((pem->meta & GMETA_MOUSE_UP)) {
+					if (pem->x >= swidth-bWidth)
+						break;
+					goto StepRawJitter;
+				}
+			}
+		} else if ((pem->meta & GMETA_MOUSE_UP))
+			break;
+	}
+
+	// Calibrate
+	ginputCalibrateMouse(0);
+	calibrated = TRUE;
+
+	// Calibration used the whole screen - re-establish our title and Next and Previous Buttons
+	gdispFillStringBox(0, 0, swidth, bHeight, "Touch Calibration", font, Green, White, justifyLeft);
+	gdispFillStringBox(swidth-2*bWidth, 0, bWidth-1, bHeight, "Prev", font, Black, Gray, justifyCenter);
+	gdispFillStringBox(swidth-1*bWidth, 0, bWidth  , bHeight, "Next", font, Black, Gray, justifyCenter);
+
+	/*
+	 * Test: Mouse coords
+	 */
+
+StepMouseCoords:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n4. Show Mouse Coordinates\n\n");
+
+	gwinSetColor(ghc, White);
+	if (deviceType == GEVENT_MOUSE)
+		gwinPrintf(ghc, "Press and hold the mouse button.\n\n");
+	else
+		gwinPrintf(ghc, "Press and hold on the surface.\n\n");
+	gwinPrintf(ghc, "Numbers will display in this window.\n"
+			"Check the coordinates against where it should be on the screen.\n\n");
+
+	gwinPrintf(ghc, "Press Next or Back to continue.\n");
+
+	// For this test normal mouse movement events
+	geventAttachSource(&gl, gs, GLISTEN_MOUSEDOWNMOVES|GLISTEN_MOUSEMETA);
+
+	while(1) {
+		// Always sleep a bit first to enable other events. We actually don't
+		// mind missing events for this test.
+		gfxSleepMilliseconds(100);
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+			if ((pem->meta & GMETA_MOUSE_UP)) {
+				if (pem->x >= swidth-bWidth)
+					break;
+				goto StepCalibrate;
+			}
+		}
+		if ((pem->current_buttons & GINPUT_MOUSE_BTN_LEFT))
+			gwinPrintf(ghc, "%u:%u\n", pem->x, pem->y);
+	}
+
+	// Reset to just changed movements.
+	geventAttachSource(&gl, gs, GLISTEN_MOUSEDOWNMOVES|GLISTEN_MOUSEMETA);
+
+	/*
+	 * Test: Mouse movement jitter
+	 */
+
+StepJitter:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n4. GINPUT_MOUSE_MOVE_JITTER\n\n");
+
+	gwinSetColor(ghc, White);
+	if (deviceType == GEVENT_MOUSE)
+		gwinPrintf(ghc, "Press and hold the mouse button and move around as if to draw.\n\n");
+	else
+		gwinPrintf(ghc, "Press firmly on the surface and move around as if to draw.\n\n");
+
+	gwinPrintf(ghc, "Dots will display in this window. Ensure that when you stop moving your finger that "
+			"new dots stop displaying.\nNew dots should only display when your finger is moving.\n\n"
+			"Adjust GINPUT_MOUSE_MOVE_JITTER to the smallest value that this reliably works for.\n\n");
+	gwinPrintf(ghc, "Press Next or Back to continue.\n\n");
+
+	while(1) {
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+			if ((pem->meta & GMETA_MOUSE_UP)) {
+				if (pem->x >= swidth-bWidth)
+					break;
+				goto StepMouseCoords;
+			}
+		}
+		if ((pem->current_buttons & GINPUT_MOUSE_BTN_LEFT))
+			gwinPrintf(ghc, ".");
+	}
+
+	/*
+	 * Test: Polling frequency
+	 */
+
+StepPolling:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n5. GINPUT_MOUSE_POLL_PERIOD\n\n");
+
+	gwinSetColor(ghc, White);
+	gwinPrintf(ghc, "Press firmly on the surface (or press and hold the mouse button) and move around as if to draw.\n\n");
+	gwinPrintf(ghc, "A green line will follow your finger.\n"
+			"Adjust GINPUT_MOUSE_POLL_PERIOD to the highest value that provides a line without "
+			"gaps that are too big.\nDecreasing the value increases CPU usage.\n"
+			"About 25 (millisecs) normally produces good results."
+			"This test can be ignored for interrupt driven drivers.\n\n");
+	gwinPrintf(ghc, "Press Next or Back to continue.\n\n");
+
+	while(1) {
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+			if ((pem->meta & GMETA_MOUSE_UP)) {
+				if (pem->x >= swidth-bWidth)
+					break;
+				goto StepJitter;
+			}
+		}
+		if ((pem->current_buttons & GINPUT_MOUSE_BTN_LEFT))
+			gdispDrawPixel(pem->x, pem->y, Green);
+	}
+	
+	/*
+	 * Test: Click Jitter
+	 */
+
+StepClickJitter:
+	gwinClear(ghc);
+	gwinSetColor(ghc, Yellow);
+	gwinPrintf(ghc, "\n6. GINPUT_MOUSE_MAX_CLICK_JITTER\n\n");
+
+	gwinSetColor(ghc, White);
+	gwinPrintf(ghc, "Press and release the touch surface to \"click\".\nTry both short and long presses.\n");
+	gwinPrintf(ghc, "For a mouse click with the left and right buttons.\n\n");
+	gwinPrintf(ghc, "Dots will display in this window. A yellow dash is a left (or short) click. "
+			"A red x is a right (or long) click.\n\n"
+			"Adjust GINPUT_MOUSE_CLICK_JITTER to the smallest value that this reliably works for.\n"
+			"Adjust GINPUT_MOUSE_CLICK_TIME to adjust distinguishing short vs long presses.\n"
+			"TIME_INFINITE means there are no long presses (although a right mouse button will still work).\n\n"
+			"Note: moving your finger (mouse) during a click cancels it.\n\n");
+	gwinPrintf(ghc, "This is the last test but you can press Next or Back to continue.\n\n");
+
+	while(1) {
+		pem = (GEventMouse *)geventEventWait(&gl, TIME_INFINITE);
+		if (pem->y < bHeight && pem->x >= swidth-2*bWidth) {
+			if ((pem->meta & GMETA_MOUSE_UP)) {
+				if (pem->x >= swidth-bWidth)
+					break;
+				goto StepPolling;
+			}
+		}
+		if ((pem->meta & GMETA_MOUSE_CLICK)) {
+			gwinSetColor(ghc, Yellow);
+			gwinPrintf(ghc, "-");
+		}
+		if ((pem->meta & GMETA_MOUSE_CXTCLICK)) {
+			gwinSetColor(ghc, Red);
+			gwinPrintf(ghc, "x");
+		}
+	}
+
+	// Can't let this really exit
+	goto StepDeviceType;
+}