@irsdk-node/native 4.1.0 → 5.0.0

package/lib/irsdk_diskclient.h

@@ -0,0 +1,205 @@
+/*
+Copyright (c) 2013, iRacing.com Motorsport Simulations, LLC.
+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 iRacing.com Motorsport Simulations 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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 IRSDKDISKCLIENT_H
+#define IRSDKDISKCLIENT_H
+
+// A C++ wrapper around the irsdk calls that takes care of reading a .ibt file
+
+//****FixMe, rename to irsdkDiskReader
+class irsdkDiskClient 
+{
+public:
+
+	irsdkDiskClient();
+	irsdkDiskClient(const char *path);
+	~irsdkDiskClient() { closeFile(); }
+
+	bool isFileOpen() { return m_ibtFile != NULL; }
+	bool openFile(const char *path);
+	void closeFile();
+
+	// read next line out of file
+	bool getNextData(); //****Note, should be called readLine();
+	int getDataCount() { return m_diskSubHeader.sessionRecordCount; }
+
+	// return how many variables this .ibt file has in the header
+	int getNumVars();
+
+	int getVarIdx(const char *name);
+
+	// get info on the var
+	const char* getVarName(int idx);
+	const char* getVarDesc(int idx);
+	const char* getVarUnit(int idx);
+
+	// what is the base type of the data
+	irsdk_VarType getVarType(int idx);
+	irsdk_VarType getVarType(const char *name) { return getVarType(getVarIdx(name)); }
+
+	// how many elements in array, or 1 if not an array
+	int getVarCount(int idx);
+	int getVarCount(const char *name) { return getVarCount(getVarIdx(name)); }
+
+	// idx is the variables index, entry is the array offset, or 0 if not an array element
+	// will convert data to requested type
+	bool getVarBool(int idx, int entry = 0);
+	bool getVarBool(const char *name, int entry = 0) { return getVarBool(getVarIdx(name), entry); }
+
+	int getVarInt(int idx, int entry = 0);
+	int getVarInt(const char *name, int entry = 0) { return getVarInt(getVarIdx(name), entry); }
+	
+	float getVarFloat(int idx, int entry = 0);
+	float getVarFloat(const char *name, int entry = 0) { return getVarFloat(getVarIdx(name), entry); }
+
+	double getVarDouble(int idx, int entry = 0);
+	double getVarDouble(const char *name, int entry = 0) { return getVarDouble(getVarIdx(name), entry); }
+
+	// 1 success, 0 failure, -n minimum buffer size
+	int getSessionStrVal(const char *path, char *val, int valLen);
+	// get the whole string
+	const char *getSessionStr() { return m_sessionInfoString; }
+
+	// we track session time and lap count in the disk sub header
+	time_t getSessionStartDate() { return m_diskSubHeader.sessionStartDate; }
+	double getSessionStartTime_s() { return m_diskSubHeader.sessionStartTime; }
+	double getSessionEndTime_s() { return m_diskSubHeader.sessionEndTime; }
+	int getSessionLapCount() { return m_diskSubHeader.sessionLapCount; }
+
+	long getFileSize() { return m_ibtFileSize; }
+
+protected:
+
+	irsdk_header m_header;
+	irsdk_diskSubHeader m_diskSubHeader;
+
+	char *m_sessionInfoString;
+	irsdk_varHeader *m_varHeaders;
+	char *m_varBuf;
+
+	FILE *m_ibtFile;
+	long m_ibtFileSize;
+};
+
+class irsdkDiskWriter
+{
+public:
+
+	irsdkDiskWriter();
+	irsdkDiskWriter(const char *path);
+	~irsdkDiskWriter() { closeFile(); }
+
+	bool isFileOpen() { return m_ibtFile != NULL; }
+	bool openFile(const char *path);
+	void closeFile();
+
+	int addNewVariable(const char *name, const char *desc, const char *unit, const irsdk_VarType type, int count = 1);
+	bool isHeaderFinalized() { return m_isHeaderFinalized; }
+	void finalizeHeader();
+
+	// write next line to file and clear buffers
+	void writeLine();
+	int getDataCount() { return m_diskSubHeader.sessionRecordCount; }
+
+	// return how many variables this .ibt file has in the header
+	int getNumVars();
+
+	int getVarIdx(const char *name);
+
+	// get info on the var
+	const char* getVarName(int idx);
+	const char* getVarDesc(int idx);
+	const char* getVarUnit(int idx);
+
+	// what is the base type of the data
+	irsdk_VarType getVarType(int idx);
+	irsdk_VarType getVarType(const char *name) { return getVarType(getVarIdx(name)); }
+
+	// how many elements in array, or 1 if not an array
+	int getVarCount(int idx);
+	int getVarCount(const char *name) { return getVarCount(getVarIdx(name)); }
+
+	// idx is the variables index, entry is the array offset, or 0 if not an array element
+	// will convert data to requested type
+	bool setVar(bool val, int idx, int entry = 0);
+	bool setVar(bool val, const char *name, int entry = 0) { return setVar(val, getVarIdx(name), entry); }
+
+	bool setVar(int val, int idx, int entry = 0);
+	bool setVar(int val, const char *name, int entry = 0) { return setVar(val, getVarIdx(name), entry); }
+	
+	bool setVar(float val, int idx, int entry = 0);
+	bool setVar(float val, const char *name, int entry = 0) { return setVar(val, getVarIdx(name), entry); }
+
+	bool setVar(double val, int idx, int entry = 0);
+	bool setVar(double val, const char *name, int entry = 0) { return setVar(val, getVarIdx(name), entry); }
+
+	// get the whole string
+	char* getSessionStr() { return m_sessionInfoString; }
+	void setSessionStr(const char* str)
+	{
+		strncpy_s(m_sessionInfoString, str, MAX_SESSIONSTR_LEN);
+		m_sessionInfoString[MAX_SESSIONSTR_LEN-1] = '\0';
+	}
+
+	// we track session time and lap count in the disk sub header
+	time_t getSessionStartDate() { return m_diskSubHeader.sessionStartDate; }
+	void setSessionStartDate(const time_t date) { m_diskSubHeader.sessionStartDate = date; }
+
+	double getSessionStartTime_s() { return m_diskSubHeader.sessionStartTime; }
+	void setSessionStartTime_s(const double time) { m_diskSubHeader.sessionStartTime = time; }
+
+	double getSessionEndTime_s() { return m_diskSubHeader.sessionEndTime; }
+	void setSessionEndTime_s(const double time) { m_diskSubHeader.sessionEndTime = time; }
+
+	int getSessionLapCount() { return m_diskSubHeader.sessionLapCount; }
+	void setSessionLapCount(const int lap) { m_diskSubHeader.sessionLapCount = lap; }
+
+	int getTickRate() { return m_header.tickRate; }
+	void setTickRate(int rate) { m_header.tickRate = rate; }
+
+protected:
+
+	void initialize();
+
+	irsdk_header m_header;
+	irsdk_diskSubHeader m_diskSubHeader;
+	int m_diskSubHeaderOffset;
+	bool m_isHeaderFinalized;
+
+	//****Note, for now static allocate our buffers
+	// could easily aquire these at creation time
+	const static int MAX_SESSIONSTR_LEN = 1048576;
+	const static int MAX_VAR_COUNT = 1000;
+	const static int MAX_VAR_BUF_SIZE = MAX_VAR_COUNT * 32;
+
+	char m_sessionInfoString[MAX_SESSIONSTR_LEN];
+	irsdk_varHeader m_varHeaders[MAX_VAR_COUNT];
+	char m_varBuf[MAX_VAR_BUF_SIZE];
+
+	FILE *m_ibtFile;
+};
+#endif // IRSDKDISKCLIENT_H

package/lib/irsdk_node.cc

@@ -227,7 +227,7 @@ Napi::Value iRacingSdkNode::BroadcastMessage(const Napi::CallbackInfo &info)
   case irsdk_BroadcastPitCommand: // arg1 == irsdk_PitCommandMode
   case irsdk_BroadcastFFBCommand: // arg1 == irsdk_FFBCommandMode
   case irsdk_BroadcastReplaySearchSessionTime:
-  case irskd_BroadcastReplaySetPlayPosition:
+  case irsdk_BroadcastReplaySetPlayPosition:
     if (this->_loggingEnabled)
       printf("BroadcastMessage(msgType: %d, arg1: %d, arg2: %f)\n", msgType, arg1, (float)arg2.FloatValue());
     irsdk_broadcastMsg(msgType, arg1, (float)arg2.FloatValue());

package/lib/irsdk_utils.cpp

@@ -4,14 +4,14 @@ 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 iRacing.com Motorsport Simulations nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
+	* 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 iRacing.com Motorsport Simulations 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
@@ -56,8 +56,8 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 static HANDLE hDataValidEvent = NULL;
 static HANDLE hMemMapFile = NULL;
 
-static const char *pSharedMem = NULL;
-static const irsdk_header *pHeader = NULL;
+static const char* pSharedMem = NULL;
+static const irsdk_header* pHeader = NULL;
 
 static int lastTickCount = INT_MAX;
 static bool isInitialized = false;
@@ -69,30 +69,30 @@ static time_t lastValidTime = 0;
 
 bool irsdk_startup()
 {
-	if(!hMemMapFile)
+	if (!hMemMapFile)
 	{
-		hMemMapFile = OpenFileMapping( FILE_MAP_READ, FALSE, IRSDK_MEMMAPFILENAME);
+		hMemMapFile = OpenFileMapping(FILE_MAP_READ, FALSE, IRSDK_MEMMAPFILENAME);
 		lastTickCount = INT_MAX;
 	}
 
-	if(hMemMapFile)
+	if (hMemMapFile)
 	{
-		if(!pSharedMem)
+		if (!pSharedMem)
 		{
-			pSharedMem = (const char *)MapViewOfFile(hMemMapFile, FILE_MAP_READ, 0, 0, 0);
-			pHeader = (irsdk_header *)pSharedMem;
+			pSharedMem = (const char*)MapViewOfFile(hMemMapFile, FILE_MAP_READ, 0, 0, 0);
+			pHeader = (irsdk_header*)pSharedMem;
 			lastTickCount = INT_MAX;
 		}
 
-		if(pSharedMem)
+		if (pSharedMem)
 		{
-			if(!hDataValidEvent)
+			if (!hDataValidEvent)
 			{
 				hDataValidEvent = OpenEvent(SYNCHRONIZE, false, IRSDK_DATAVALIDEVENTNAME);
 				lastTickCount = INT_MAX;
 			}
 
-			if(hDataValidEvent)
+			if (hDataValidEvent)
 			{
 				isInitialized = true;
 				return isInitialized;
@@ -109,13 +109,13 @@ bool irsdk_startup()
 
 void irsdk_shutdown()
 {
-	if(hDataValidEvent)
+	if (hDataValidEvent)
 		CloseHandle(hDataValidEvent);
 
-	if(pSharedMem)
+	if (pSharedMem)
 		UnmapViewOfFile(pSharedMem);
 
-	if(hMemMapFile)
+	if (hMemMapFile)
 		CloseHandle(hMemMapFile);
 
 	hDataValidEvent = NULL;
@@ -127,38 +127,38 @@ void irsdk_shutdown()
 	lastTickCount = INT_MAX;
 }
 
-bool irsdk_getNewData(char *data)
+bool irsdk_getNewData(char* data)
 {
-	if(isInitialized || irsdk_startup())
+	if (isInitialized || irsdk_startup())
 	{
 #ifdef _MSC_VER
 		_ASSERTE(NULL != pHeader);
 #endif
 
 		// if sim is not active, then no new data
-		if(!(pHeader->status & irsdk_stConnected))
+		if (!(pHeader->status & irsdk_stConnected))
 		{
 			lastTickCount = INT_MAX;
 			return false;
 		}
 
 		int latest = 0;
-		for(int i=1; i<pHeader->numBuf; i++)
-			if(pHeader->varBuf[latest].tickCount < pHeader->varBuf[i].tickCount)
-			   latest = i;	
+		for (int i = 1; i < pHeader->numBuf; i++)
+			if (pHeader->varBuf[latest].tickCount < pHeader->varBuf[i].tickCount)
+				latest = i;
 
 		// if newer than last recieved, than report new data
-		if(lastTickCount < pHeader->varBuf[latest].tickCount)
+		if (lastTickCount < pHeader->varBuf[latest].tickCount)
 		{
 			// if asked to retrieve the data
-			if(data)
+			if (data)
 			{
 				// try twice to get the data out
-				for(int count = 0; count < 2; count++)
+				for (int count = 0; count < 2; count++)
 				{
-					int curTickCount =  pHeader->varBuf[latest].tickCount;
+					int curTickCount = pHeader->varBuf[latest].tickCount;
 					memcpy(data, pSharedMem + pHeader->varBuf[latest].bufOffset, pHeader->bufLen);
-					if(curTickCount ==  pHeader->varBuf[latest].tickCount)
+					if (curTickCount == pHeader->varBuf[latest].tickCount)
 					{
 						lastTickCount = curTickCount;
 						lastValidTime = time(NULL);
@@ -170,15 +170,15 @@ bool irsdk_getNewData(char *data)
 			}
 			else
 			{
-				lastTickCount =  pHeader->varBuf[latest].tickCount;
+				lastTickCount = pHeader->varBuf[latest].tickCount;
 				lastValidTime = time(NULL);
 				return true;
 			}
 		}
 		// if older than last recieved, than reset, we probably disconnected
-		else if(lastTickCount >  pHeader->varBuf[latest].tickCount)
+		else if (lastTickCount > pHeader->varBuf[latest].tickCount)
 		{
-			lastTickCount =  pHeader->varBuf[latest].tickCount;
+			lastTickCount = pHeader->varBuf[latest].tickCount;
 			return false;
 		}
 		// else the same, and nothing changed this tick
@@ -188,30 +188,30 @@ bool irsdk_getNewData(char *data)
 }
 
 
-bool irsdk_waitForDataReady(int timeOut, char *data)
+bool irsdk_waitForDataReady(int timeOut, char* data)
 {
 #ifdef _MSC_VER
 	_ASSERTE(timeOut >= 0);
 #endif
 
-	if(isInitialized || irsdk_startup())
+	if (isInitialized || irsdk_startup())
 	{
 		// just to be sure, check before we sleep
-		if(irsdk_getNewData(data))
+		if (irsdk_getNewData(data))
 			return true;
 
 		// sleep till signaled
 		WaitForSingleObject(hDataValidEvent, timeOut);
 
 		// we woke up, so check for data
-		if(irsdk_getNewData(data))
+		if (irsdk_getNewData(data))
 			return true;
 		else
 			return false;
 	}
 
 	// sleep if error
-	if(timeOut > 0)
+	if (timeOut > 0)
 		Sleep(timeOut);
 
 	return false;
@@ -219,7 +219,7 @@ bool irsdk_waitForDataReady(int timeOut, char *data)
 
 bool irsdk_isConnected()
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
 		int elapsed = (int)difftime(time(NULL), lastValidTime);
 		return (pHeader->status & irsdk_stConnected) > 0 && elapsed < timeout;
@@ -228,9 +228,9 @@ bool irsdk_isConnected()
 	return false;
 }
 
-const irsdk_header *irsdk_getHeader()
+const irsdk_header* irsdk_getHeader()
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
 		return pHeader;
 	}
@@ -241,9 +241,9 @@ const irsdk_header *irsdk_getHeader()
 // direct access to the data buffer
 // Warnign! This buffer is volitile so read it out fast!
 // Use the cached copy from irsdk_waitForDataReady() or irsdk_getNewData() instead
-const char *irsdk_getData(int index)
+const char* irsdk_getData(int index)
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
 		return pSharedMem + pHeader->varBuf[index].bufOffset;
 	}
@@ -251,9 +251,9 @@ const char *irsdk_getData(int index)
 	return NULL;
 }
 
-const char *irsdk_getSessionInfoStr()
+const char* irsdk_getSessionInfoStr()
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
 		return pSharedMem + pHeader->sessionInfoOffset;
 	}
@@ -262,27 +262,27 @@ const char *irsdk_getSessionInfoStr()
 
 int irsdk_getSessionInfoStrUpdate()
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
 		return pHeader->sessionInfoUpdate;
 	}
 	return -1;
 }
 
-const irsdk_varHeader *irsdk_getVarHeaderPtr()
+const irsdk_varHeader* irsdk_getVarHeaderPtr()
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
 		return ((irsdk_varHeader*)(pSharedMem + pHeader->varHeaderOffset));
 	}
 	return NULL;
 }
 
-const irsdk_varHeader *irsdk_getVarHeaderEntry(int index)
+const irsdk_varHeader* irsdk_getVarHeaderEntry(int index)
 {
-	if(isInitialized)
+	if (isInitialized)
 	{
-		if(index >= 0 && index < pHeader->numVars)
+		if (index >= 0 && index < pHeader->numVars)
 		{
 			return &((irsdk_varHeader*)(pSharedMem + pHeader->varHeaderOffset))[index];
 		}
@@ -291,16 +291,16 @@ const irsdk_varHeader *irsdk_getVarHeaderEntry(int index)
 }
 
 // Note: this is a linear search, so cache the results
-int irsdk_varNameToIndex(const char *name)
+int irsdk_varNameToIndex(const char* name)
 {
-	const irsdk_varHeader *pVar;
+	const irsdk_varHeader* pVar;
 
-	if(name)
+	if (name)
 	{
-		for(int index=0; index<pHeader->numVars; index++)
+		for (int index = 0; index < pHeader->numVars; index++)
 		{
 			pVar = irsdk_getVarHeaderEntry(index);
-			if(pVar && 0 == strncmp(name, pVar->name, IRSDK_MAX_STRING))
+			if (pVar && 0 == strncmp(name, pVar->name, IRSDK_MAX_STRING))
 			{
 				return index;
 			}
@@ -310,16 +310,16 @@ int irsdk_varNameToIndex(const char *name)
 	return -1;
 }
 
-int irsdk_varNameToOffset(const char *name)
+int irsdk_varNameToOffset(const char* name)
 {
-	const irsdk_varHeader *pVar;
+	const irsdk_varHeader* pVar;
 
-	if(name)
+	if (name)
 	{
-		for(int index=0; index<pHeader->numVars; index++)
+		for (int index = 0; index < pHeader->numVars; index++)
 		{
 			pVar = irsdk_getVarHeaderEntry(index);
-			if(pVar && 0 == strncmp(name, pVar->name, IRSDK_MAX_STRING))
+			if (pVar && 0 == strncmp(name, pVar->name, IRSDK_MAX_STRING))
 			{
 				return pVar->offset;
 			}
@@ -331,14 +331,14 @@ int irsdk_varNameToOffset(const char *name)
 
 unsigned int irsdk_getBroadcastMsgID()
 {
-	static unsigned int msgId = RegisterWindowMessage(IRSDK_BROADCASTMSGNAME); 
+	static unsigned int msgId = RegisterWindowMessage(IRSDK_BROADCASTMSGNAME);
 
 	return msgId;
 }
 
 void irsdk_broadcastMsg(irsdk_BroadcastMsg msg, int var1, int var2, int var3)
 {
-	irsdk_broadcastMsg(msg, var1, static_cast<int>MAKELONG(var2, var3));
+	irsdk_broadcastMsg(msg, var1, (int)MAKELONG(var2, var3));
 }
 
 void irsdk_broadcastMsg(irsdk_BroadcastMsg msg, int var1, float var2)
@@ -353,7 +353,7 @@ void irsdk_broadcastMsg(irsdk_BroadcastMsg msg, int var1, int var2)
 {
 	static unsigned int msgId = irsdk_getBroadcastMsgID();
 
-	if(msgId && msg >= 0 && msg < irsdk_BroadcastLast)
+	if (msgId && msg >= 0 && msg < irsdk_BroadcastLast)
 	{
 		SendNotifyMessage(HWND_BROADCAST, msgId, MAKELONG(msg, var1), var2);
 	}
@@ -363,14 +363,14 @@ int irsdk_padCarNum(int num, int zero)
 {
 	int retVal = num;
 	int numPlace = 1;
-	if(num > 99)
+	if (num > 99)
 		numPlace = 3;
-	else if(num > 9)
+	else if (num > 9)
 		numPlace = 2;
-	if(zero)
+	if (zero)
 	{
 		numPlace += zero;
-		retVal = num + 1000*numPlace;
+		retVal = num + 1000 * numPlace;
 	}
 
 	return retVal;