Merge lp:~timfelgentreff/stratagus/timfelgentreff-zoomeable-view into lp:stratagus

[timfelgentreff]

This branch adds an option to zoom the viewport using opengl. This is particularily useful when playing on tablets using the touchscreen, as the zoomed view provides large targets. Also, it looks retro with the pixelation :)

[Kyran Jackson (erstmap)]

Gooooooooooooooooooood.

[Travis (dinky-dye-aussie)]

oh nice this sounds like a great addition! :)

[lp:~timfelgentreff/stratagus/timfelgentreff-zoomeable-view]

8699. By timfelgentreff on 2013-04-22

* Translate touch coordinates when using OpenGL zoom
* have the resolution option affect the viewport when using OpenGL zoom

8700. By timfelgentreff on 2013-04-22

Fix bogus rectangle select when touch events jump around

8701. By timfelgentreff on 2013-04-22

Ensure we use absolute mouse coordinates on Windows touchscreen devices in fullscreen

[timfelgentreff (timfelgentreff)]

The additional commits fix mouse-coordinates and -behaviour on windows in both fullscreen and windowed modes

[lp:~timfelgentreff/stratagus/timfelgentreff-zoomeable-view]

8702. By timfelgentreff on 2013-04-22

merge lp:stratagus

[timfelgentreff (timfelgentreff)]

Hi, just wondering if you can provide any feedback on this (even if it is "we don't want this / we're not going to merge this")

[Joris Dauphin (joris-dauphin)]

By a quick code review, it seems good, but I don't have touch screen, so I can't test it.
So I let someone else review/commit (Pali ?).

[Pali (pali)]

I see that all touchscreen code changes are only for windows platform (#ifdef USE_WIN32). I added touchscreen code to Stratagus for Nokia N900 device which is Linux (Xserver/X11) based. So this (windows) not changing anything for my N900.

But I can test OpenGL ES changes on Linux desktop and Nokia N900.

[timfelgentreff (timfelgentreff)]

@Pali The relative mouse coordinates in fullscreen can on Linux be disabled by setting SDL_MOUSE_RELATIVE (or something like it) in your environment, but not on Windows, so this really only applies to Windows.

On any touchscreen device you'll need to test whether the changes from line 87 in the diff work for you, if not I'll need to #ifdef those, too. I had to click twice very often on my tablet to get rid of the selection rectangle without that change.

Besides that, could you also test whether the viewport zooming works with OpenGL ES? I tested with OpenGL on Windows and Linux (played through half the Tides of Darkness campaign with it).

[Pali (pali)]

Matchbox Window Manager on Maemo 5 does not support resizing application windows, so I cannot test this on Nokia N900.

But I have working OpenGL ES driver on desktop, so I can test that here.

[Joris Dauphin (joris-dauphin)]

I suggest to merge if all (partial) tests pass.

[Pali (pali)]

I tested it on Linux in both opengl and opengles and there is problem. Resolution of monitor is 800x600 and original resolution of stratagus is 1600x900. In this mode I can move mouse only in rectangle (800/1600 * 800) x (600/900 * 600). So I cannot click on exit button, because mouse is only in subrectangle 800x600 from full screen 1600x900 (scaled to 800x600).

review: Needs Fixing

[timfelgentreff (timfelgentreff)]

ah, okay, i hadn't thought about scaling down. i'll get on it.

[Pali (pali)]

Fix also function PlayMovie in https://bazaar.launchpad.net/~stratagus/stratagus/trunk/view/head:/src/video/movie.cpp
Because YUV overlay cannot be created in OpenGL mode, that function first turn off OpenGL. And that function using Video.Width Video.Height, so movie is not scaled to full screen.

[lp:~timfelgentreff/stratagus/timfelgentreff-zoomeable-view]

8703. By timfelgentreff on 2013-04-30

merge lp:stratagus

8704. By timfelgentreff on 2013-05-01

use Viewport dimensions for video when using OpenGL

8705. By timfelgentreff on 2013-05-01

always translate mouse coordinates if we are zoomed

[timfelgentreff (timfelgentreff)]

@Pali I fixed the video dimensions and the issue with the mouse coordinates.

[Pali (pali)]

Ok, now scaling working fine on desktop with both OpenGL and OpenGL ES.

But there is problem if I compile stratagus with OpenGL/ES and start it with param -o (disable opengl/es). then stratagus freeze and show this error.

$ ./stratagus-dbg -d /usr/share/games/stratagus/wargus/ -v 800x600 -Z -o
...
X Error of failed request: BadValue (integer parameter out of range for operation)
  Major opcode of failed request: 130 (MIT-SHM)
  Minor opcode of failed request: 3 (X_ShmPutImage)
  Value in failed request: 0x640
  Serial number of failed request: 25
  Current serial number in output stream: 26

And other small note: Help text for -Z should not be visible/compiled if opengl/es is not enabled at compile time (like options -O and -O)

[timfelgentreff (timfelgentreff)]

Since disabling OpenGL with -Z is illegal, should I just print an error message in this case and exit? Or should it be a warning and I continue launching with zoom disabled in this case?

[Pali (pali)]

I think that when opengl is disabled (via -o or via preferences/game menu) startagus should write error message when -Z is specified and exit. (Like when opengl is disabled and compile time and stratagus write error message that -Z is incorrect param)

[lp:~timfelgentreff/stratagus/timfelgentreff-zoomeable-view]

8706. By timfelgentreff on 2013-05-01

Only show -Z option in help text if compiled with OpenGL(ES) and make certain that -Z only works with OpenGL enabled

8707. By timfelgentreff on 2013-05-01

print error message to stderr, not stdout

[timfelgentreff (timfelgentreff)]

@Pali I have clarified that using -Z implies -O. If you use "-Z -o" in that order, it now prints an error message and exits. The other way around works, which I think is consistent with what happens if you do "-o -O".

[Pali (pali)]

Ok, I think this merge request can be merged to trunk now.

review: Approve

[Pali (pali)]

@Joris: It is Ok for merging?

[Joris Dauphin (joris-dauphin)]

No objection.

review: Approve

[Pali (pali)]

@timfelgentreff: Go ahead and merge code to trunk.

review: Approve

=== modified file 'src/include/video.h'
--- src/include/video.h	2013-04-13 00:57:39 +0000
+++ src/include/video.h	2013-05-01 16:44:24 +0000
@@ -53,6 +53,7 @@
 #if defined(USE_OPENGL) || defined(USE_GLES)
 extern char ForceUseOpenGL;
 extern bool UseOpenGL;
+extern bool ZoomNoResize;
 #endif
 
 class CGraphic : public gcn::Image
@@ -351,6 +352,13 @@
 
 	int Width;
 	int Height;
+#if defined(USE_OPENGL) || defined(USE_GLES)
+	int ViewportWidth;         /// Actual width of the window
+	int ViewportHeight;        /// Actual height of the window
+#endif
+#if defined(USE_TOUCHSCREEN) && defined(USE_WIN32)
+	SDL_Cursor *blankCursor;
+#endif
 	int Depth;
 	bool FullScreen;
 };

=== modified file 'src/stratagus/stratagus.cpp'
--- src/stratagus/stratagus.cpp	2013-04-29 13:31:19 +0000
+++ src/stratagus/stratagus.cpp	2013-05-01 16:44:24 +0000
@@ -456,6 +456,9 @@
 		"\t-u userpath\tPath where stratagus saves preferences, log and savegame\n"
 		"\t-v mode\t\tVideo mode resolution in format <xres>x<yres>\n"
 		"\t-W\t\tWindowed video mode\n"
+#if defined(USE_OPENGL) || defined(USE_GLES)
+		"\t-Z\t\tUse OpenGL to scale the screen to the viewport (retro-style). Implies -O.\n"
+#endif
 		"map is relative to StratagusLibPath=datapath, use ./map for relative to cwd\n",
 		Parameters::Instance.applicationName.c_str());
 }
@@ -506,7 +509,7 @@
 void ParseCommandLine(int argc, char **argv, Parameters &parameters)
 {
 	for (;;) {
-		switch (getopt(argc, argv, "ac:d:D:eE:FhiI:lN:oOP:ps:S:u:v:W?")) {
+		switch (getopt(argc, argv, "ac:d:D:eE:FhiI:lN:oOP:ps:S:u:v:WZ?")) {
 			case 'a':
 				EnableAssert = true;
 				continue;
@@ -550,6 +553,11 @@
 			case 'o':
 				ForceUseOpenGL = 1;
 				UseOpenGL = 0;
+				if (ZoomNoResize) {
+					fprintf(stderr, "Error: -Z only works with OpenGL enabled\n");
+					Usage();
+					ExitFatal(-1);
+				}
 				continue;
 			case 'O':
 				ForceUseOpenGL = 1;
@@ -586,12 +594,31 @@
 					Usage();
 					ExitFatal(-1);
 				}
+#if defined(USE_OPENGL) || defined(USE_GLES)
+				if (ZoomNoResize) {
+					Video.ViewportHeight = Video.Height;
+					Video.ViewportWidth = Video.Width;
+					Video.Height = 0;
+					Video.Width = 0;
+				}
+#endif
 				continue;
 			}
 			case 'W':
 				VideoForceFullScreen = 1;
 				Video.FullScreen = 0;
 				continue;
+#if defined(USE_OPENGL) || defined(USE_GLES)
+		        case 'Z':
+				ForceUseOpenGL = 1;
+				UseOpenGL = 1;
+				ZoomNoResize = 1;
+				Video.ViewportHeight = Video.Height;
+				Video.ViewportWidth = Video.Width;
+				Video.Height = 0;
+				Video.Width = 0;
+				continue;
+#endif
 			case -1:
 				break;
 			case '?':

=== modified file 'src/ui/interface.cpp'
--- src/ui/interface.cpp	2013-04-16 17:55:29 +0000
+++ src/ui/interface.cpp	2013-05-01 16:44:24 +0000
@@ -1367,6 +1367,13 @@
 		|| ((y - buff) <= MouseY && MouseY <= (y + buff)) == 0) {
 		MouseState = InitialMouseState;
 		LastMouseTicks = ticks;
+		// Reset rectangle select cursor state if we moved by a lot
+		// - rectangle select should be a drag, not a tap
+		if (CursorState == CursorStateRectangle
+			&& (((x - buff * 2) <= MouseX && MouseX <= (x + buff * 2)) == 0
+				|| ((y - buff * 2) <= MouseY && MouseY <= (y + buff * 2)) == 0)) {
+			CursorState = CursorStatePoint;
+		}
 	}
 	if (MouseX != x || MouseY != y) {
 		MouseX = x;

=== modified file 'src/ui/script_ui.cpp'
--- src/ui/script_ui.cpp	2013-04-25 13:57:02 +0000
+++ src/ui/script_ui.cpp	2013-05-01 16:44:24 +0000
@@ -203,6 +203,23 @@
 	return 0;
 }
 
+static int CclSetZoomNoResize(lua_State *l)
+{
+	LuaCheckArgs(l, 1);
+#if defined(USE_OPENGL) || defined(USE_GLES)
+	if (CclInConfigFile) {
+		// May have been set from the command line
+		if (!ForceUseOpenGL) {
+			ZoomNoResize = LuaToBoolean(l, 1);
+			if (ZoomNoResize) {
+			    UseOpenGL = true;
+			}
+		}
+	}
+#endif
+	return 0;
+}
+
 /**
 **  Set the video resolution.
 **
@@ -1151,6 +1168,7 @@
 
 	lua_register(Lua, "SetMaxOpenGLTexture", CclSetMaxOpenGLTexture);
 	lua_register(Lua, "SetUseOpenGL", CclSetUseOpenGL);
+	lua_register(Lua, "SetZoomNoResize", CclSetZoomNoResize);
 	lua_register(Lua, "SetVideoResolution", CclSetVideoResolution);
 	lua_register(Lua, "GetVideoResolution", CclGetVideoResolution);
 	lua_register(Lua, "SetVideoFullScreen", CclSetVideoFullScreen);

=== modified file 'src/video/movie.cpp'
--- src/video/movie.cpp	2013-02-08 17:53:21 +0000
+++ src/video/movie.cpp	2013-05-01 16:44:24 +0000
@@ -175,6 +175,15 @@
 {
 	char buffer[PATH_MAX];
 
+	int videoWidth, videoHeight;
+#if defined(USE_OPENGL) || defined(USE_GLES)
+	videoWidth  = Video.ViewportWidth;
+	videoHeight = Video.ViewportHeight;
+#else
+	videoWidth  = Video.Width;
+	videoHeight = Video.Height;
+#endif
+
 	LibraryFileName(name.c_str(), buffer, sizeof(buffer));
 
 	CFile f;
@@ -195,14 +204,14 @@
 	SDL_Rect rect;
 
 	if (data.tinfo.frame_width * 300 / 4 > data.tinfo.frame_height * 100) {
-		rect.w = Video.Width;
-		rect.h = Video.Width * data.tinfo.frame_height / data.tinfo.frame_width;
+		rect.w = videoWidth;
+		rect.h = videoWidth * data.tinfo.frame_height / data.tinfo.frame_width;
 		rect.x = 0;
-		rect.y = (Video.Height - rect.h) / 2;
+		rect.y = (videoHeight - rect.h) / 2;
 	} else {
-		rect.w = Video.Height * data.tinfo.frame_width / data.tinfo.frame_height;
-		rect.h = Video.Height;
-		rect.x = (Video.Width - rect.w) / 2;
+		rect.w = videoHeight * data.tinfo.frame_width / data.tinfo.frame_height;
+		rect.h = videoHeight;
+		rect.x = (videoWidth - rect.w) / 2;
 		rect.y = 0;
 	}
 
@@ -210,7 +219,7 @@
 	// When SDL_OPENGL is used, it is not possible to call SDL_CreateYUVOverlay, so turn temporary OpenGL off
 	// With GLES is all ok
 	if (UseOpenGL) {
-		SDL_SetVideoMode(Video.Width, Video.Height, Video.Depth, SDL_GetVideoSurface()->flags & ~SDL_OPENGL);
+		SDL_SetVideoMode(Video.ViewportWidth, Video.ViewportHeight, Video.Depth, SDL_GetVideoSurface()->flags & ~SDL_OPENGL);
 	}
 #endif
 
@@ -291,7 +300,7 @@
 
 #ifdef USE_OPENGL
 	if (UseOpenGL) {
-		SDL_SetVideoMode(Video.Width, Video.Height, Video.Depth, SDL_GetVideoSurface()->flags | SDL_OPENGL);
+		SDL_SetVideoMode(Video.ViewportWidth, Video.ViewportHeight, Video.Depth, SDL_GetVideoSurface()->flags | SDL_OPENGL);
 		ReloadOpenGL();
 	}
 #endif

=== modified file 'src/video/sdl.cpp'
--- src/video/sdl.cpp	2013-04-13 00:57:39 +0000
+++ src/video/sdl.cpp	2013-05-01 16:44:24 +0000
@@ -270,7 +270,7 @@
 
 	InitOpenGLExtensions();
 
-	glViewport(0, 0, (GLsizei)Video.Width, (GLsizei)Video.Height);
+	glViewport(0, 0, (GLsizei)Video.ViewportWidth, (GLsizei)Video.ViewportHeight);
 
 #ifdef USE_OPENGL
 	glMatrixMode(GL_PROJECTION);
@@ -628,11 +628,23 @@
 		Video.Depth = 32;
 	}
 
+#if defined(USE_OPENGL) || defined(USE_GLES)
+	if (!Video.ViewportWidth || !Video.ViewportHeight) {
+		Video.ViewportWidth = Video.Width;
+		Video.ViewportHeight = Video.Height;
+	}
+	TheScreen = SDL_SetVideoMode(Video.ViewportWidth, Video.ViewportHeight, Video.Depth, flags);
+#else
 	TheScreen = SDL_SetVideoMode(Video.Width, Video.Height, Video.Depth, flags);
+#endif
 	if (TheScreen && (TheScreen->format->BitsPerPixel != 16
 					  && TheScreen->format->BitsPerPixel != 32)) {
 		// Only support 16 and 32 bpp, default to 16
+#if defined(USE_OPENGL) || defined(USE_GLES)
+		TheScreen = SDL_SetVideoMode(Video.ViewportWidth, Video.ViewportHeight, 16, flags);
+#else
 		TheScreen = SDL_SetVideoMode(Video.Width, Video.Height, 16, flags);
+#endif
 	}
 	if (TheScreen == NULL) {
 		fprintf(stderr, "Couldn't set %dx%dx%d video mode: %s\n",
@@ -643,8 +655,17 @@
 	Video.FullScreen = (TheScreen->flags & SDL_FULLSCREEN) ? 1 : 0;
 	Video.Depth = TheScreen->format->BitsPerPixel;
 
+#if defined(USE_TOUCHSCREEN) && defined(USE_WIN32)
+	// Must not allow SDL to switch to relative mouse coordinates
+	// with touchscreen when going fullscreen. So we don't hide the
+	// cursor, but instead set a transparent 1px cursor
+	Uint8 emptyCursor[] = {'\0'};
+	Video.blankCursor = SDL_CreateCursor(emptyCursor, emptyCursor, 1, 1, 0, 0);
+	SDL_SetCursor(Video.blankCursor);
+#else
 	// Turn cursor off, we use our own.
-	SDL_ShowCursor(0);
+	SDL_ShowCursor(SDL_DISABLE);
+#endif
 
 	// Make default character translation easier
 	SDL_EnableUNICODE(1);
@@ -797,8 +818,15 @@
 **  @param callbacks  Callback structure for events.
 **  @param event      SDL event structure pointer.
 */
-static void SdlDoEvent(const EventCallback &callbacks, const SDL_Event &event)
+static void SdlDoEvent(const EventCallback &callbacks, SDL_Event &event)
 {
+#if (defined(USE_OPENGL) || defined(USE_GLES))
+	// Scale mouse-coordinates to viewport
+	if (ZoomNoResize && (event.type & (SDL_MOUSEBUTTONUP | SDL_MOUSEBUTTONDOWN | SDL_MOUSEMOTION))) {
+		event.button.x = (Uint16)floor(event.button.x * float(Video.Width) / Video.ViewportWidth);
+		event.button.y = (Uint16)floor(event.button.y * float(Video.Height) / Video.ViewportHeight);
+	}
+#endif
 	switch (event.type) {
 		case SDL_MOUSEBUTTONDOWN:
 			InputMouseButtonPress(callbacks, SDL_GetTicks(), event.button.button);
@@ -1151,10 +1179,16 @@
 		}
 	}
 
+#ifndef USE_TOUCHSCREEN
+	// Cannot hide cursor on Windows with touchscreen, as it switches
+	// to relative mouse coordinates in fullscreen. See above initial
+	// call to ShowCursor
+	//
 	// Windows shows the SDL cursor when starting in fullscreen mode
 	// then switching to window mode.  This hides the cursor again.
 	SDL_ShowCursor(SDL_ENABLE);
 	SDL_ShowCursor(SDL_DISABLE);
+#endif
 
 #if defined(USE_OPENGL) || defined(USE_GLES)
 	if (UseOpenGL) {

=== modified file 'src/video/video.cpp'
--- src/video/video.cpp	2013-04-13 00:57:39 +0000
+++ src/video/video.cpp	2013-05-01 16:44:24 +0000
@@ -168,6 +168,7 @@
 #if defined(USE_OPENGL) || defined(USE_GLES)
 char ForceUseOpenGL;
 bool UseOpenGL;                      /// Use OpenGL
+bool ZoomNoResize;
 #endif
 
 char VideoForceFullScreen;           /// fullscreen set from commandline
@@ -289,14 +290,24 @@
 			UI.Minimap.FreeOpenGL();
 		}
 #endif
+		TheScreen = SDL_SetVideoMode(w, h, TheScreen->format->BitsPerPixel, TheScreen->flags);
+#if defined(USE_OPENGL) || defined(USE_GLES)
+		ViewportWidth = w;
+		ViewportHeight = h;
+		if (ZoomNoResize) {
+			ReloadOpenGL();
+		} else {
+			Width = w;
+			Height = h;
+			SetClipping(0, 0, Video.Width - 1, Video.Height - 1);
+			if (UseOpenGL) {
+				ReloadOpenGL();
+			}
+		}
+#else
 		Width = w;
 		Height = h;
-		TheScreen = SDL_SetVideoMode(w, h, TheScreen->format->BitsPerPixel, TheScreen->flags);
 		SetClipping(0, 0, Video.Width - 1, Video.Height - 1);
-#if defined(USE_OPENGL) || defined(USE_GLES)
-		if (UseOpenGL) {
-			ReloadOpenGL();
-		}
 #endif
 		return true;
 	}