@irsdk-node/native 3.0.0

package/lib/irsdk_client.cpp

@@ -0,0 +1,495 @@
+/*
+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.
+*/
+
+#include <stdio.h>
+#include <string.h>
+
+#include <assert.h>
+#include "irsdk_defines.h"
+#include "yaml_parser.h"
+#include "irsdk_client.h"
+
+#pragma warning(disable:4996)
+
+irsdkClient& irsdkClient::instance()
+{
+	static irsdkClient INSTANCE;
+	return INSTANCE;
+}
+
+bool irsdkClient::waitForData(int timeoutMS)
+{
+	// wait for start of session or new data
+	if(irsdk_waitForDataReady(timeoutMS, m_data) && irsdk_getHeader())
+	{
+		// if new connection, or data changed lenght then init
+		if(!m_data || m_nData != irsdk_getHeader()->bufLen)
+		{
+			// allocate memory to hold incoming data from sim
+			if(m_data) delete [] m_data;
+			m_nData = irsdk_getHeader()->bufLen;
+			m_data = new char[m_nData];
+
+			// indicate a new connection
+			m_statusID++;
+
+			// reset session info str status
+			m_lastSessionCt = -1;
+
+			// and try to fill in the data
+			if(irsdk_getNewData(m_data))
+				return true;
+		}
+		else if(m_data)
+		{
+			// else we are allready initialized, and data is ready for processing
+			return true;
+		}
+	}
+	else if(!isConnected())
+	{
+		// else session ended
+		if(m_data)
+			delete[] m_data;
+		m_data = NULL;
+
+		// reset session info str status
+		m_lastSessionCt = -1;
+	}
+
+	return false;
+}
+
+void irsdkClient::shutdown()
+{
+	irsdk_shutdown();
+	if(m_data)
+		delete[] m_data;
+	m_data = NULL;
+
+	// reset session info str status
+	m_lastSessionCt = -1;
+}
+
+bool irsdkClient::isConnected()
+{
+	return m_data != NULL && irsdk_isConnected();
+}
+
+int irsdkClient::getVarIdx(const char*name)
+{
+	if(isConnected())
+	{
+		return irsdk_varNameToIndex(name);
+	}
+
+	return -1;
+}
+
+int /*irsdk_VarType*/ irsdkClient::getVarType(int idx)
+{
+	if(isConnected())
+	{
+		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
+		if(vh)
+		{
+			return vh->type;
+		}
+		else
+		{
+			//invalid variable index
+			assert(false);
+		}
+	}
+
+	return irsdk_char;
+}
+
+int irsdkClient::getVarCount(int idx)
+{
+	if(isConnected())
+	{
+		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
+		if(vh)
+		{
+			return vh->count;
+		}
+		else
+		{
+			//invalid variable index
+			assert(false);
+		}
+	}
+
+	return 0;
+}
+
+bool irsdkClient::getVarBool(int idx, int entry)
+{
+	if(isConnected())
+	{
+		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
+		if(vh)
+		{
+			if(entry >= 0 && entry < vh->count)
+			{
+				const char * data = m_data + vh->offset;
+				switch(vh->type)
+				{
+				// 1 byte
+				case irsdk_char:
+				case irsdk_bool:
+					return (((const char*)data)[entry]) != 0;
+					break;
+
+				// 4 bytes
+				case irsdk_int:
+				case irsdk_bitField:
+					return (((const int*)data)[entry]) != 0;
+					break;
+					
+				// test float/double for greater than 1.0 so that
+				// we have a chance of this being usefull
+				// technically there is no right conversion...
+				case irsdk_float:
+					return (((const float*)data)[entry]) >= 1.0f;
+					break;
+
+				// 8 bytes
+				case irsdk_double:
+					return (((const double*)data)[entry]) >= 1.0;
+					break;
+				}
+			}
+			else
+			{
+				// invalid offset
+				assert(false);
+			}
+		}
+		else
+		{
+			//invalid variable index
+			assert(false);
+		}
+	}
+
+	return false;
+}
+
+int irsdkClient::getVarInt(int idx, int entry)
+{
+	if(isConnected())
+	{
+		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
+		if(vh)
+		{
+			if(entry >= 0 && entry < vh->count)
+			{
+				const char * data = m_data + vh->offset;
+				switch(vh->type)
+				{
+				// 1 byte
+				case irsdk_char:
+				case irsdk_bool:
+					return (int)(((const char*)data)[entry]);
+					break;
+
+				// 4 bytes
+				case irsdk_int:
+				case irsdk_bitField:
+					return (int)(((const int*)data)[entry]);
+					break;
+					
+				case irsdk_float:
+					return (int)(((const float*)data)[entry]);
+					break;
+
+				// 8 bytes
+				case irsdk_double:
+					return (int)(((const double*)data)[entry]);
+					break;
+				}
+			}
+			else
+			{
+				// invalid offset
+				assert(false);
+			}
+		}
+		else
+		{
+			//invalid variable index
+			assert(false);
+		}
+	}
+
+	return 0;
+}
+
+float irsdkClient::getVarFloat(int idx, int entry)
+{
+	if(isConnected())
+	{
+		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
+		if(vh)
+		{
+			if(entry >= 0 && entry < vh->count)
+			{
+				const char * data = m_data + vh->offset;
+				switch(vh->type)
+				{
+				// 1 byte
+				case irsdk_char:
+				case irsdk_bool:
+					return (float)(((const char*)data)[entry]);
+					break;
+
+				// 4 bytes
+				case irsdk_int:
+				case irsdk_bitField:
+					return (float)(((const int*)data)[entry]);
+					break;
+					
+				case irsdk_float:
+					return (float)(((const float*)data)[entry]);
+					break;
+
+				// 8 bytes
+				case irsdk_double:
+					return (float)(((const double*)data)[entry]);
+					break;
+				}
+			}
+			else
+			{
+				// invalid offset
+				assert(false);
+			}
+		}
+		else
+		{
+			//invalid variable index
+			assert(false);
+		}
+	}
+
+	return 0.0f;
+}
+
+double irsdkClient::getVarDouble(int idx, int entry)
+{
+	if(isConnected())
+	{
+		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
+		if(vh)
+		{
+			if(entry >= 0 && entry < vh->count)
+			{
+				const char * data = m_data + vh->offset;
+				switch(vh->type)
+				{
+				// 1 byte
+				case irsdk_char:
+				case irsdk_bool:
+					return (double)(((const char*)data)[entry]);
+					break;
+
+				// 4 bytes
+				case irsdk_int:
+				case irsdk_bitField:
+					return (double)(((const int*)data)[entry]);
+					break;
+					
+				case irsdk_float:
+					return (double)(((const float*)data)[entry]);
+					break;
+
+				// 8 bytes
+				case irsdk_double:
+					return (double)(((const double*)data)[entry]);
+					break;
+				}
+			}
+			else
+			{
+				// invalid offset
+				assert(false);
+			}
+		}
+		else
+		{
+			//invalid variable index
+			assert(false);
+		}
+	}
+
+	return 0.0;
+}
+
+//path is in the form of "DriverInfo:Drivers:CarIdx:{%d}UserName:"
+int irsdkClient::getSessionStrVal(const char *path, char *val, int valLen)
+{
+	if(isConnected() && path && val && valLen > 0)
+	{
+		// track changes in string
+		m_lastSessionCt = getSessionCt(); 
+
+		const char *tVal = NULL;
+		int tValLen = 0;
+		if(parseYaml(irsdk_getSessionInfoStr(), path, &tVal, &tValLen))
+		{
+			// dont overflow out buffer
+			int len = tValLen;
+			if(len > valLen)
+				len = valLen;
+
+			// copy what we can, even if buffer too small
+			memcpy(val, tVal, len);
+			val[len] = '\0'; // origional string has no null termination...
+
+			// if buffer was big enough, return success
+			if(valLen >= tValLen)
+				return 1;
+			else // return size of buffer needed
+				return -tValLen;
+		}
+	}
+
+	return 0;
+}
+
+// get the whole string
+const char* irsdkClient::getSessionStr() 
+{ 
+	if(isConnected())
+	{
+		m_lastSessionCt = getSessionCt(); 
+		return irsdk_getSessionInfoStr(); 
+	}
+
+	return NULL;
+}
+
+
+//----------------------------------
+
+irsdkCVar::irsdkCVar()
+	: m_idx(-1)
+	, m_statusID(-1)
+{
+	m_name[0] = '\0';
+}
+
+irsdkCVar::irsdkCVar(const char *name)
+{
+	m_name[0] = '\0';
+	setVarName(name);
+}
+
+void irsdkCVar::setVarName(const char *name)
+{
+	if(!name || 0 != strncmp(name, m_name, sizeof(m_name)))
+	{
+		m_idx = -1;
+		m_statusID = -1;
+
+		if(name)
+		{
+			strncpy(m_name, name, max_string);
+			m_name[max_string-1] = '\0';
+		}
+		else
+			m_name[0] = '\0';
+	}
+}
+
+bool irsdkCVar::checkIdx()
+{
+	if(irsdkClient::instance().isConnected())
+	{
+		if(m_statusID != irsdkClient::instance().getStatusID())
+		{
+			m_statusID = irsdkClient::instance().getStatusID();
+			m_idx = irsdkClient::instance().getVarIdx(m_name);
+		}
+
+		return true;
+	}
+
+	return false;
+}
+
+int /*irsdk_VarType*/ irsdkCVar::getType()
+{
+	if(checkIdx())
+		return irsdkClient::instance().getVarType(m_idx);
+	return 0;
+}
+
+int irsdkCVar::getCount()
+{
+	if(checkIdx())
+		return irsdkClient::instance().getVarCount(m_idx);
+	return 0;
+}
+
+bool irsdkCVar::isValid()
+{
+	checkIdx();
+	return (m_idx > -1);
+}
+
+
+bool irsdkCVar::getBool(int entry)
+{
+	if(checkIdx())
+		return irsdkClient::instance().getVarBool(m_idx, entry);
+	return false;
+}
+
+int irsdkCVar::getInt(int entry)
+{
+	if(checkIdx())
+		return irsdkClient::instance().getVarInt(m_idx, entry);
+	return 0;
+}
+
+float irsdkCVar::getFloat(int entry)
+{
+	if(checkIdx())
+		return irsdkClient::instance().getVarFloat(m_idx, entry);
+	return 0.0f;
+}
+
+double irsdkCVar::getDouble(int entry)
+{
+	if(checkIdx())
+		return irsdkClient::instance().getVarDouble(m_idx, entry);
+	return 0.0;
+}
+

package/lib/irsdk_client.h

@@ -0,0 +1,139 @@
+/*
+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 IRSDKCLIENT_H
+#define IRSDKCLIENT_H
+
+// A C++ wrapper around the irsdk calls that takes care of the details of maintaining a connection.
+// reads out the data into a cache so you don't have to worry about timming
+class irsdkClient
+{
+public:
+	// singleton
+	static irsdkClient& instance();
+
+	// wait for live data, or if a .ibt file is open
+	// then read the next line from the file.
+	bool waitForData(int timeoutMS = 16);
+
+	bool isConnected();
+	int getStatusID() { return m_statusID; }
+
+	int getVarIdx(const char*name);
+
+	// what is the base type of the data
+	// returns irsdk_VarType as int so we don't depend on irsdk_defines.h
+	int getVarType(int idx);
+	int 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); }
+
+	//---
+
+	// value that increments with each update to string
+	int getSessionCt() { return irsdk_getSessionInfoStrUpdate(); }
+
+	// has string changed since we last read any values from it
+	bool wasSessionStrUpdated() { return m_lastSessionCt != getSessionCt(); } 
+
+	// pars string for individual value, 1 success, 0 failure, -n minimum buffer size
+	//****Note, this is a linear parser, so it is slow!
+	int getSessionStrVal(const char *path, char *val, int valLen);
+
+	// get the whole string
+	const char *getSessionStr();
+
+protected:
+
+	irsdkClient()
+		: m_data(NULL)
+		, m_nData(0)
+		, m_statusID(0)
+		, m_lastSessionCt(-1)
+	{ }
+
+	~irsdkClient() { shutdown(); }
+
+	void shutdown();
+
+	char *m_data;
+	int m_nData;
+	int m_statusID;
+
+	int m_lastSessionCt;
+
+	static irsdkClient *m_instance;
+};
+
+
+// helper class to keep track of our variables index
+// Create a global instance of this and it will take care of the details for you.
+class irsdkCVar
+{
+public:
+	irsdkCVar();
+	irsdkCVar(const char *name);
+
+	void setVarName(const char *name);
+
+	// returns irsdk_VarType as int so we don't depend on irsdk_defines.h
+	int getType();
+	int getCount();
+	bool isValid();
+
+	// entry is the array offset, or 0 if not an array element
+	bool getBool(int entry = 0);
+	int getInt(int entry = 0);
+	float getFloat(int entry = 0);
+	double getDouble(int entry = 0);
+
+protected:
+	bool checkIdx();
+
+	static const int max_string = 32; //IRSDK_MAX_STRING
+	char m_name[max_string];
+	int m_idx;
+	int m_statusID;
+};
+
+#endif // IRSDKCLIENT_H