summaryrefslogtreecommitdiffhomepage
path: root/ftnoir_protocol_ft/ftnoir_protocol_ft.cpp
blob: 503961fa5a0a459b285966feb7919dc0987b290d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
/********************************************************************************
* FaceTrackNoIR		This program is a private project of the some enthusiastic	*
*					gamers from Holland, who don't like to pay much for			*
*					head-tracking.												*
*																				*
* Copyright (C) 2013	Wim Vriend (Developing)									*
*						Ron Hendriks (Researching and Testing)					*
*																				*
* Homepage																		*
*																				*
* This program is free software; you can redistribute it and/or modify it		*
* under the terms of the GNU General Public License as published by the			*
* Free Software Foundation; either version 3 of the License, or (at your		*
* option) any later version.													*
*																				*
* This program is distributed in the hope that it will be useful, but			*
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY	*
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for	*
* more details.																	*
*																				*
* You should have received a copy of the GNU General Public License along		*
* with this program; if not, see <http://www.gnu.org/licenses/>.				*
*																				*
* FTServer		FTServer is the Class, that communicates headpose-data			*
*				to games, using the FreeTrackClient.dll.	         			*
********************************************************************************/
/*
	Modifications (last one on top):
	20130209 - WVR: Some games support both interfaces and cause trouble. Added ComboBox to fix this (hide one interface 
					by clearing the appropriate Registry-setting).
	20130203 - WVR: Added Tirviews and dummy checkboxes to the Settings dialog. This is necessary for CFS3 etc.
	20130125 - WVR: Upgraded to FT2.0: now the FreeTrack protocol supports all TIR-enabled games.
	20110401 - WVR: Moved protocol to a DLL, convenient for installation etc.
	20101224 - WVR: Base class is no longer inheriting QThread. sendHeadposeToGame
					is called from run() of Tracker.cpp
	20100601 - WVR: Added Mutex-bit in run(). Thought it wasn't so important (still do...). 
	20100523 - WVR: Implemented the Freetrack-protocol just like Freetrack does. Earlier 
					FaceTrackNoIR only worked with an adapted DLL, with a putdata function.
					Now it works direcly in shared memory!
*/
#include "ftnoir_protocol_ft.h"
#include "csv.h"

/** constructor **/
FTNoIR_Protocol::FTNoIR_Protocol()
{
	useTIRViews	= false;
	useDummyExe	= false;
	intUsedInterface = 0;

	//
	// Load the INI-settings.
	//
	loadSettings();

	ProgramName = "";
	intGameID = 0;

	viewsStart = 0;
	viewsStop = 0;

    pMemData = NULL;
    force_dummy = false;
    force_tirviews = false;

}

/** destructor **/
FTNoIR_Protocol::~FTNoIR_Protocol()
{

	qDebug()<< "~FTNoIR_Protocol: Destructor started.";

	//
	// Stop if started
	//
	if (viewsStop != NULL) {
		qDebug()<< "~FTNoIR_Protocol: Stopping TIRViews.";
		viewsStop();
		FTIRViewsLib.unload();
	}

	//
	// Destroy the File-mapping
	//
	FTDestroyMapping();
}

void FTNoIR_Protocol::Initialize()
{
	return;
}

//
// Read the game-data from CSV
//
void FTNoIR_Protocol::getGameData( QString gameID, bool& tirviews, bool& dummy){
    QStringList gameLine;
	qDebug() << "getGameData, ID = " << gameID;

	//
	// Open the supported games list, to get the Name.
	//
	QFile file(QCoreApplication::applicationDirPath() + "/Settings/FaceTrackNoIR Supported Games.csv");
	if (!file.open(QIODevice::ReadOnly | QIODevice::Text)){
        return;
	}
	CSV csv(&file);
	gameLine = csv.parseLine();

	while (gameLine.count() > 2) {
		//qDebug() << "Column 0: " << gameLine.at(0);		// No.
		//qDebug() << "Column 1: " << gameLine.at(1);		// Game Name
		//qDebug() << "Column 2: " << gameLine.at(2);		// Game Protocol
		//qDebug() << "Column 3: " << gameLine.at(3);		// Supported since version
		//qDebug() << "Column 4: " << gameLine.at(4);		// Verified
		//qDebug() << "Column 5: " << gameLine.at(5);		// By
		//qDebug() << "Column 6: " << gameLine.at(6);		// International ID
		//qDebug() << "Column 7: " << gameLine.at(7);		// FaceTrackNoIR ID
		
		//
		// If the gameID was found, fill the shared memory
		//
		if (gameLine.count() > 6) {
			if (gameLine.at(6).compare( gameID, Qt::CaseInsensitive ) == 0) {
                QByteArray id = gameLine.at(7).toAscii();
                int tmp[8];
                int fuzz[3];
                if (gameLine.at(3) == QString("V160"))
                {
                    qDebug() << "no table";
                    memset(pMemData->table, 0, 8);
                }
                else if (sscanf(id.constData(),
                           "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
                           fuzz + 2,
                           fuzz + 0,
                           tmp + 3,
                           tmp + 2,
                           tmp + 1,
                           tmp + 0,
                           tmp + 7,
                           tmp + 6,
                           tmp + 5,
                           tmp + 4,
                           fuzz + 1) != 11 || ((fuzz[2] << 8) | fuzz[0]) != gameLine.at(0).toInt())
                {
                    qDebug() << "scanf failed" << fuzz[0] << fuzz[1] << fuzz[2];
                    memset(pMemData->table, 0, 8);
                }
                else
                    for (int i = 0; i < 8; i++)
                        pMemData->table[i] = tmp[i];
                qDebug() << gameID << "game-id" << gameLine.at(7);
                game_name = gameLine.at(1);
                dummy = fuzz[1] & 0xf;
                tirviews = fuzz[1] & 0xf0;
                file.close();
                return;
			}
		}

		gameLine = csv.parseLine();
	}

	//
	// If the gameID was NOT found, fill only the name "Unknown game connected"
	//
    qDebug() << "Unknown game connected" << pMemData->GameID;
    file.close();
}

//
// Load the current Settings from the currently 'active' INI-file.
//
void FTNoIR_Protocol::loadSettings() {
	QSettings settings("Abbequerque Inc.", "FaceTrackNoIR");	// Registry settings (in HK_USER)

	QString currentFile = settings.value ( "SettingsFile", QCoreApplication::applicationDirPath() + "/Settings/default.ini" ).toString();
	QSettings iniFile( currentFile, QSettings::IniFormat );		// Application settings (in INI-file)

	iniFile.beginGroup ( "FT" );
	intUsedInterface = iniFile.value ( "UsedInterface", 0 ).toInt();
	iniFile.endGroup ();

	//
	// Use the settings-section from the deprecated fake-TIR protocol, as they are most likely to be found there.
	//
	iniFile.beginGroup ( "FTIR" );
	useTIRViews	= iniFile.value ( "useTIRViews", 0 ).toBool();
	useDummyExe	= iniFile.value ( "useDummyExe", 1 ).toBool();
	iniFile.endGroup ();
}

//
// Update Headpose in Game.
//
void FTNoIR_Protocol::sendHeadposeToGame(double *headpose, double *rawheadpose ) {
float virtPosX;
float virtPosY;
float virtPosZ;

float virtRotX;
float virtRotY;
float virtRotZ;

float headPosX;
float headPosY;
float headPosZ;

float headRotX;
float headRotY;
float headRotZ;

    //
	// Scale the Raw measurements to the client measurements.
	//
    headRotX = getRadsFromDegrees(headpose[RY]);
    headRotY = getRadsFromDegrees(headpose[RX]);
    headRotZ = getRadsFromDegrees(headpose[RZ]);
    headPosX = headpose[TX] * 10;
    headPosY = headpose[TY] * 10;
    headPosZ = headpose[TZ] * 10;

    virtRotX = getRadsFromDegrees(headpose[RY]);
    virtRotY = getRadsFromDegrees(headpose[RX]);
    virtRotZ = getRadsFromDegrees(headpose[RZ]);
    virtPosX = headpose[TX] * 10;
    virtPosY = headpose[TY] * 10;
    virtPosZ = headpose[TZ] * 10;

	//
	// Check if the pointer is OK and wait for the Mutex.
	//
	if ( (pMemData != NULL) && (WaitForSingleObject(hFTMutex, 100) == WAIT_OBJECT_0) ) {

		//
		// Copy the Raw measurements directly to the client.
		//
		pMemData->data.RawX = headPosX;
		pMemData->data.RawY = headPosY;
		pMemData->data.RawZ = headPosZ;
		pMemData->data.RawPitch = headRotX;
		pMemData->data.RawYaw = headRotY;
		pMemData->data.RawRoll = headRotZ;

		//
		//
		pMemData->data.X = virtPosX;
		pMemData->data.Y = virtPosY;
		pMemData->data.Z = virtPosZ;
		pMemData->data.Pitch = virtRotX;
		pMemData->data.Yaw = virtRotY;
		pMemData->data.Roll = virtRotZ;

		//
		// Leave some values 0 yet...
		//
		pMemData->data.X1 = pMemData->data.DataID + 10;
		pMemData->data.X2 = 0;
		pMemData->data.X3 = 0;
		pMemData->data.X4 = 0;
		pMemData->data.Y1 = 0;
		pMemData->data.Y2 = 0;
		pMemData->data.Y3 = 0;
		pMemData->data.Y4 = 0;

		//
		// Check if the handle that was sent to the Game, was changed (on x64, this will be done by the ED-API)
		// If the "Report Program Name" command arrives (which is a '1', for now), raise the event from here!
		//
		//
		// The game-ID was changed?
		//
        if (intGameID != pMemData->GameID)
        {
            memset(pMemData->table, 0, 8);
            QString gameID = QString::number(pMemData->GameID);
            bool tirviews = false, dummy = false;
            getGameData(gameID, tirviews, dummy);
            if (tirviews)
                start_tirviews();
            if (dummy)
                start_dummy();
            pMemData->GameID2 = pMemData->GameID;
            intGameID = pMemData->GameID;
        }

        ReleaseMutex(hFTMutex);
	}

	pMemData->data.DataID += 1;
}

//
// Set the Path variables and load the memory-mapping.
// Simplified function: No need to check if the DLL's actually exist. The are installed by the installer.
// If they are absent, something went terribly wrong anyway...
//
// Returns 'true' if all seems OK.
//
//

void FTNoIR_Protocol::start_tirviews() {
    QString aFileName = QCoreApplication::applicationDirPath() + "/TIRViews.dll";
    if ( QFile::exists( aFileName ) && !force_tirviews ) {
        force_tirviews = true;
        FTIRViewsLib.setFileName(aFileName);
        FTIRViewsLib.load();

        viewsStart = (importTIRViewsStart) FTIRViewsLib.resolve("TIRViewsStart");
        if (viewsStart == NULL) {
            qDebug() << "FTServer::run() says: TIRViewsStart function not found in DLL!";
        }
        else {
            qDebug() << "FTServer::run() says: TIRViewsStart executed!";
            viewsStart();
        }

        //
        // Load the Stop function from TIRViews.dll. Call it when terminating the thread.
        //
        viewsStop = (importTIRViewsStop) FTIRViewsLib.resolve("TIRViewsStop");
        if (viewsStop == NULL) {
            qDebug() << "FTServer::run() says: TIRViewsStop function not found in DLL!";
        }
    }
}

void FTNoIR_Protocol::start_dummy() {
    if (!force_dummy) {
        force_dummy = true;
        QString program = QCoreApplication::applicationDirPath() + "/TrackIR.exe";
        dummyTrackIR.start(program);
    
        qDebug() << "FTServer::run() says: TrackIR.exe executed!";
    }
}

bool FTNoIR_Protocol::checkServerInstallationOK()
{   
	QSettings settings("Freetrack", "FreetrackClient");							// Registry settings (in HK_USER)
	QSettings settingsTIR("NaturalPoint", "NATURALPOINT\\NPClient Location");	// Registry settings (in HK_USER)
	QString aLocation;															// Location of Client DLL

	qDebug() << "checkServerInstallationOK says: Starting Function";

	try {

		//
		// Write the path in the registry (for FreeTrack and FreeTrack20), for the game(s).
		//
		aLocation =  QCoreApplication::applicationDirPath() + "/";

		qDebug() << "checkServerInstallationOK says: used interface = " << intUsedInterface;
		switch (intUsedInterface) {
			case 0:									// Use both interfaces
				settings.setValue( "Path" , aLocation );
				settingsTIR.setValue( "Path" , aLocation );
				break;
			case 1:									// Use FreeTrack, disable TrackIR
				settings.setValue( "Path" , aLocation );
				settingsTIR.setValue( "Path" , "" );
				break;
			case 2:									// Use TrackIR, disable FreeTrack
				settings.setValue( "Path" , "" );
				settingsTIR.setValue( "Path" , aLocation );
				break;
			default:
				// should never be reached
			break;
		}

		//
		// TIRViews must be started first, or the NPClient DLL will never be loaded.
		//
		if (useTIRViews) {
            start_tirviews();
		}

		//
		// Check if TIRViews or dummy TrackIR.exe is required for this game
		//
		if (useDummyExe) {
            start_dummy();
		}


	} catch(...) {
		settings.~QSettings();
	}
	return FTCreateMapping();
}

//
// Create a memory-mapping to the FreeTrack data.
// It contains the tracking data, a handle to the main-window and the program-name of the Game!
//
//
bool FTNoIR_Protocol::FTCreateMapping()
{
bool bFirst = false;

	qDebug() << "FTCreateMapping says: Starting Function";

	//
	// A FileMapping is used to create 'shared memory' between the FTServer and the FTClient.
	//
	// Try to create a FileMapping to the Shared Memory.
	// If one already exists: close it.
	//
    hFTMemMap = CreateFileMappingA( INVALID_HANDLE_VALUE , 00 , PAGE_READWRITE , 0 ,
//		                           sizeof( TFreeTrackData ) + sizeof( HANDLE ) + 100, 
		                           sizeof( FTMemMap ), 
								   (LPCSTR) FT_MM_DATA );

	if ( hFTMemMap != 0 ) {
		bFirst = true;
		qDebug() << "FTCreateMapping says: FileMapping Created!" << hFTMemMap;
	}

	if ( ( hFTMemMap != 0 ) && ( (long) GetLastError == ERROR_ALREADY_EXISTS ) ) {
		bFirst = false;
		qDebug() << "FTCreateMapping says: FileMapping already exists!" << hFTMemMap;
		CloseHandle( hFTMemMap );
		hFTMemMap = 0;
	}

	//
	// Create a new FileMapping, Read/Write access
    //
    hFTMemMap = OpenFileMappingA( FILE_MAP_WRITE, false , (LPCSTR) FT_MM_DATA );
	if ( ( hFTMemMap != 0 ) ) {
		qDebug() << "FTCreateMapping says: FileMapping Opened:" << hFTMemMap;
        pMemData = (FTMemMap *) MapViewOfFile(hFTMemMap, FILE_MAP_WRITE, 0, 0,
//					sizeof(TFreeTrackData) + sizeof(hFTMemMap) + 100);
					sizeof(FTMemMap));
	    hFTMutex = CreateMutexA(NULL, false, FREETRACK_MUTEX);
	}


    if (!hFTMemMap || !pMemData) {
		QMessageBox::information(0, "FaceTrackNoIR error", QString("FTServer Error! \n"));
		return false;
	}

    pMemData->data.DataID = 1;
    pMemData->data.CamWidth = 100;
    pMemData->data.CamHeight = 250;
    pMemData->GameID2 = 0;
    memset(pMemData->table, 0, 8);

    return true;
}

//
// Destory the FileMapping to the shared memory
//
void FTNoIR_Protocol::FTDestroyMapping()
{
	if ( pMemData != NULL ) {
		UnmapViewOfFile ( pMemData );
	}
	
	CloseHandle( hFTMutex );
	CloseHandle( hFTMemMap );
	hFTMemMap = 0;

}

//
// Return a name, if present the name from the Game, that is connected...
//
void FTNoIR_Protocol::getNameFromGame( char *dest )
{   
    QByteArray foo = game_name.toUtf8();
    memcpy(dest, foo.constData(), std::min<int>(foo.size(), 98));
    dest[foo.size()] = 0;
}


////////////////////////////////////////////////////////////////////////////////
// Factory function that creates instances if the Protocol object.

// Export both decorated and undecorated names.
//   GetProtocol     - Undecorated name, which can be easily used with GetProcAddress
//                Win32 API function.
//   _GetProtocol@0  - Common name decoration for __stdcall functions in C language.
//#pragma comment(linker, "/export:GetProtocol=_GetProtocol@0")

extern "C" FTNOIR_PROTOCOL_BASE_EXPORT void* CALLING_CONVENTION GetConstructor()
{
    return (IProtocol*) new FTNoIR_Protocol;
}