Add plugin for Final Fantasy XIV #2653

EmperorArthur · 2016-11-25T04:05:10Z

This is the first draft of a positional audio plugin for Final Fantasy XIV. It probably requires more work before being merge ready. I used the l4d2 plugin as a base, with a few patterns found in the wow plugin.

I'd appreciate some feedback, especially since I'm pretty sure I've messed up the coordinate system. I couldn't find any documentation on how to debug this thing aside from littering the code with cout statements.

The plugin does compile on Linux, though it's not set to in this pull request. I'm in the process of setting up a Windows build environment, so I haven't had a chance to do any testing.

What do you all like about this code? What do you dislike, and what should I change?

mkrautz · 2016-11-25T09:57:02Z

Hi @EmperorArthur,
Do you run FFXIV on Wine?

I haven't yet reviewed the PR, but here's my WIP branch for wine plugin support, if you're interested:
https://github.com/mkrautz/mumble/commits/wine-plugins-v5

davidebeatrici · 2016-11-25T12:32:07Z

plugins/plugins.pro

@@ -12,7 +12,7 @@ SUBDIRS = link
 DIST = plugins.pri

 win32 {
-	SUBDIRS += aoc arma2 bf1942 bf2 bf3 bf2142 bfbc2 bfheroes bf4_x86 blacklight borderlands borderlands2 breach cod2 cod4 cod5 codmw2 codmw2so cs css dods dys etqw tf2 gmod gtaiv gw hl2dm insurgency jc2 l4d l4d2 lol lotro ql rl sr sto ut2004 ut3 ut99 wolfet wow
+	SUBDIRS += aoc arma2 bf1942 bf2 bf3 bf2142 bfbc2 bfheroes bf4_x86 blacklight borderlands borderlands2 breach cod2 cod4 cod5 codmw2 codmw2so cs css dods dys etqw tf2 gmod gtaiv gw hl2dm insurgency jc2 l4d l4d2 lol lotro ql rl sr sto ut2004 ut3 ut99 wolfet wow ffxiv


ffxiv should be after etqw, to keep the alphabetical order.

davidebeatrici · 2016-11-25T12:33:02Z

plugins/ffxiv/ffxiv.pro

+include(../plugins.pri)
+
+TARGET		= ffxiv
+SOURCES		= ffxiv.cpp


Wrong indentation.

This looks like a github issue. If you view the file directly, the problem disappears.

davidebeatrici · 2016-11-25T12:38:43Z

plugins/ffxiv/ffxiv.cpp

+	avatar_front[2] = 0;
+
+	if(camera_is_free) {
+		camera_front[0] = -std::cos(camera_heading) ;


Space after the bracket.

davidebeatrici · 2016-11-25T12:39:21Z

plugins/ffxiv/ffxiv.cpp

+const procptr32_t identity_offset       = 48;  // Name
+const procptr32_t avatar_pos_offset     = 160; // X, Z, Y
+const procptr32_t avatar_heading_offset = 176; // Heading (-pi to pi)
+//Camera struct offsets


This comment should be "// Camera struct offsets".

davidebeatrici · 2016-11-25T12:42:44Z

plugins/ffxiv/ffxiv.cpp

+			peekProc(avatar_address + avatar_pos_offset, &avatar_pos_corrector, 12) && // Avatar Position values (X, Z and Y).
+			peekProc(avatar_address + avatar_heading_offset, &avatar_heading, 4)    && //Avatar heading float.
+//			peekProc(pModule, servername)                                          && // Server name.
+			peekProc(pModule + map_id_address, &map_id,4)                              && // Map id.


Missing space after the comma.

davidebeatrici · 2016-11-25T12:44:59Z

plugins/ffxiv/ffxiv.cpp

+const procptr32_t camera_ptr           = 0x1045C40;
+const procptr32_t avatar_ptr           = 0x10468EC;
+const procptr32_t state_address        = 0x1048C60;
+//const procptr32_t servername_address = 0;


If the server name isn't available I would just remove it.

davidebeatrici · 2016-11-25T12:45:08Z

plugins/ffxiv/ffxiv.cpp

+			peekProc(camera_address + camera_is_free_offset, &camera_is_free, 1)    && // Camera is in first person mode
+			peekProc(avatar_address + avatar_pos_offset, &avatar_pos_corrector, 12) && // Avatar Position values (X, Z and Y).
+			peekProc(avatar_address + avatar_heading_offset, &avatar_heading, 4)    && //Avatar heading float.
+//			peekProc(pModule, servername)                                          && // Server name.


If the server name isn't available I would just remove it.

davidebeatrici · 2016-11-25T12:45:18Z

plugins/ffxiv/ffxiv.cpp

+	std::ostringstream ocontext;
+	ocontext << "{";
+
+	// Server name


If the server name isn't available I would just remove it.

davidebeatrici · 2016-11-25T12:45:29Z

plugins/ffxiv/ffxiv.cpp

+	std::wostringstream oidentity;
+	oidentity << "{";
+
+	// Server name


If the server name isn't available I would just remove it.

davidebeatrici · 2016-11-25T12:53:11Z

Hi @EmperorArthur,

You're not obliged to setup a full environment to compile plugins, see the Wiki page for a small guide on how to do it.

To test plugins we have a dedicated program called MumblePAHelper, you can download it from here or build it yourself if you want the latest version; we still have to setup a builder for it. 😉

mkrautz · 2016-11-25T18:58:00Z

plugins/ffxiv/ffxiv.cpp

+	avatar_front[1] = std::sin(avatar_heading);
+	avatar_front[2] = 0;
+
+	if(camera_is_free) {


Should be if (camera_is_free) {

mkrautz · 2016-11-25T18:59:00Z

plugins/ffxiv/ffxiv.cpp

+// that can be found in the LICENSE file at the root of the
+// Mumble source tree or at <https://www.mumble.info/LICENSE>.
+
+#ifdef WIN32


No need to ifdef. This plugin is only for Windows for now. Just replace this block with the Windows include.

We'll handle Wine inside mumble_plugin_win32_32bit.h/mumble_plugin_win32_64bit.h when it lands.

mkrautz · 2016-11-25T18:59:45Z

plugins/ffxiv/ffxiv.cpp

+// X is East/West, West is increasing values
+// Heading is in radians, 0 faces south
+
+// Memory offsets


Please use tabs for indentation, but spaces for lining things up.

In this case, the whitespace between camera_ptr, avatar_ptr, etc. should be spaces, not tabs.

Ok, i was worried about it after @davidebeatrici mentioned them being mixed. It's the same in the l4d2 plugin.

Will work on fixing.

I was referring to the peekProc and variables parts. 😉

mkrautz · 2016-11-25T22:23:41Z

plugins/ffxiv/ffxiv.cpp

+	// Create containers to stuff our raw data into, so we can convert it to Mumble's coordinate system
+	float avatar_pos_corrector[3], camera_pos_corrector[3], avatar_heading, camera_heading;
+	// Values for extra features
+//  char servername[50];


mkrautz · 2016-11-25T22:24:25Z

plugins/ffxiv/ffxiv.pro

+include(../plugins.pri)
+
+TARGET		= ffxiv
+SOURCES		= ffxiv.cpp


EmperorArthur · 2016-11-26T15:58:14Z

Good news, this compiles successfully on MSVC 2010, 2013, and 2015. I know because I installed all three of them yesterday.

Bad news (for me), MumblePAHelper and Mumble snapshot don't recognize any compiled plugin. At this point I'm stuck.

davidebeatrici · 2016-11-26T16:00:12Z

You must use the same compiler (and architecture) for Mumble/MumblePAHelper and the plugins.

mkrautz · 2016-11-26T16:29:49Z

For Mumble 1.3.x, that's MSVC 2013, for Mumble 1.2.x, it's MSVC2010.

EmperorArthur · 2016-11-26T22:06:38Z

Ok, the problem was everything, including MumblePAHelper, is compiled for X64, but the wiki didn't mention that. That should probably be fixed.

One final question before this thing is ready. Does this sound correct?

With the character facing South, Avatar Front is X: 1, Y: 0, Z: 0
With the character facing East, Avatar Front is X: 0, Y: 0, Z: 1
With the character facing South Avatar_Pos_X increases while going West.
With the character facing South Avatar_Pos_Z increases while going South.
With the character facing South Avatar_Pos_Y increases while going Up.

South was chosen as the reference direction since heading (in radians) is 0 pointing South.

mkrautz · 2016-11-27T02:02:50Z

Seems wrong that the coordinate system for avatar_front is different from avatar_pos.. (South is X is one, in the other?)

Also, how is avatar_front's Z ever anything but 0 when it's set to 0 here? https://github.com/mumble-voip/mumble/pull/2653/files#diff-be1da379944da5c11f9a33c6658fcc3aR128

EmperorArthur · 2016-11-27T05:55:52Z

I was confused about the coordinate system. Looking at the code for the manual placement plugin helped straighten things out.

actor_front Y is always zero. The player can not tilt up and down. There may be motions that look like it, but those animations do not affect the player's coordinates.

This code works, but I believe I can move things to North aligned instead of South aligned. Also, would you like me to squash all commits and rebase to master?

side note: I really wish the manual placement plugin was an actual plugin. It would have made experimenting, and understanding the coordinate system so much easier.

EmperorArthur · 2016-11-27T06:02:06Z

plugins/ffxiv/ffxiv.cpp

+
+	/*
+	Mumble | Game (in L hand coordinate system)
+	X      | -X


I may be able to swap this to X, -Y, Z and save all the negatives in the azimuth calculations.

I have no opinion. As long as the coordinate system is mapped sensibly onto the Mumble coordinate system, I'm happy.

EmperorArthur · 2016-11-27T06:11:03Z

plugins/ffxiv/ffxiv.cpp

+	if (!camera_address) return false;
+
+	// Peekproc and assign game addresses to our containers, so we can retrieve positional data
+	ok = peekProc(pModule + state_offset, &state, 1) && // Magical state value: 0 or 255 when in main menu and 1 when in-game.


Tabs or Spaces in aligning things here?

Tabs are OK here. It's once you start aligning things you should use spaces.

Ok, I'm aligning all the && // so I'll use tabs for the indentation, and spaces to align those.

mkrautz · 2016-11-27T13:34:40Z

I was confused about the coordinate system. Looking at the code for the manual placement plugin helped straighten things out.

actor_front Y is always zero. The player can not tilt up and down. There may be motions that look like it, but those animations do not affect the player's coordinates.

This code works, but I believe I can move things to North aligned instead of South aligned.

Sounds like a good idea to me. I'm not sure what other plugins do, though!
Not a top priority, as long as the coordinate system is consistent.

Also, would you like me to squash all commits and rebase to master?

Yes, please!

side note: I really wish the manual placement plugin was an actual plugin. It would have made experimenting, and understanding the coordinate system so much easier.

It was, until very recently. We made it part of Mumble because of the Qt UI... Perhaps we can do something similar in MumblePAHelper, but use the link plugin?

This only supports the DirectX 9 version of the game.

EmperorArthur · 2016-11-27T21:01:07Z

Here's, what should be, the final version. Ready to merge, hopefully.

There is a 64 bit version of the game, but I will submit that as a separate pull request.

davidebeatrici · 2016-11-27T21:14:29Z

Looks good to me. 😉

Does the DirectX 11 version of the game use a different executable?

mkrautz · 2016-11-27T21:21:38Z

Landed. Thanks a bunch! :-)

EmperorArthur · 2016-11-27T21:54:42Z

Thanks for all your help. I enjoy Mumble, and appreciate everything you all do.

davidebeatrici · 2016-11-27T22:01:06Z

You're welcome!
Thank you very much for your contribution! 😄

davidebeatrici added client positional audio labels Nov 25, 2016

davidebeatrici reviewed Nov 25, 2016

View reviewed changes

mkrautz suggested changes Nov 25, 2016

View reviewed changes

EmperorArthur commented Nov 27, 2016

View reviewed changes

ffxiv Plugin: Add a plugin for Final Fantasy XIV

07308dc

This only supports the DirectX 9 version of the game.

EmperorArthur force-pushed the ffxiv branch from 0b6c6fd to 07308dc Compare November 27, 2016 20:56

mkrautz changed the title ~~Add a plugin for Final Fantasy XIV (feedback needed)~~ Add plugin for Final Fantasy XIV Nov 27, 2016

mkrautz approved these changes Nov 27, 2016

View reviewed changes

mkrautz merged commit 8bbb34d into mumble-voip:master Nov 27, 2016

EmperorArthur deleted the ffxiv branch November 27, 2016 21:35

Add plugin for Final Fantasy XIV #2653

Add plugin for Final Fantasy XIV #2653

Conversation

EmperorArthur commented Nov 25, 2016

mkrautz commented Nov 25, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidebeatrici commented Nov 25, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EmperorArthur commented Nov 26, 2016

davidebeatrici commented Nov 26, 2016

mkrautz commented Nov 26, 2016

EmperorArthur commented Nov 26, 2016

mkrautz commented Nov 27, 2016

EmperorArthur commented Nov 27, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkrautz commented Nov 27, 2016

EmperorArthur commented Nov 27, 2016

davidebeatrici commented Nov 27, 2016 • edited Loading

mkrautz commented Nov 27, 2016

EmperorArthur commented Nov 27, 2016

davidebeatrici commented Nov 27, 2016

davidebeatrici commented Nov 27, 2016 •

edited

Loading