vrpn_CHProducts_Controller_Raw.C

// vrpn_CHProducts_Controller_Raw.C: VRPN driver for CHProducts Controller Raw devices

#include <stdio.h>                      // for fprintf, stderr, NULL
#include <string.h>                     // for memset
#include <math.h>                       // for sqrt and fabs

#include "vrpn_CHProducts_Controller_Raw.h"

VRPN_SUPPRESS_EMPTY_OBJECT_WARNING()

#if defined(VRPN_USE_HID)

// USB vendor and product IDs for the models we support
static const vrpn_uint16 CHPRODUCTS_VENDOR = 0x068e;
static const vrpn_uint16 FIGHTERSTICK_USB = 0x00f3;

static const double POLL_INTERVAL = 1e+6 / 30.0;		// If we have not heard, ask.

#define GAMEPAD_TRIGGER_THRESHOLD 30

//////////////////////////////////////////////////////////////////////////
// helpers
//////////////////////////////////////////////////////////////////////////

static vrpn_float64 normalize_dpad(unsigned char up, unsigned char right, unsigned char down, unsigned char left)
{
	int x = 0;
	int y = 0;
	if (right) {
		x += 1;
	}
	if (left) {
		x -= 1;
	}
	if (up) {
		y += 1;
	}
	if (down) {
		y -= 1;
	}
	size_t index = ((x + 1) * 3) + (y + 1);
	vrpn_float64 angles[] = {225, 270, 315, 180, -1, 0, 135, 90, 45};
	return (angles[index]);
}

static void normalize_axis(const unsigned int value, const short deadzone, const vrpn_float64 scale, vrpn_float64& channel, int wordSize = 16)
{
	channel = (static_cast<float>(value) - (float) (1 << (wordSize - 1)));
	if (fabs(channel) < (deadzone * 3 / 4))
	{
		channel = 0.0f;
	}
	else
	{
		channel /= (float) (1 << (wordSize - 1));
	}
	channel *= scale;
	if (channel < -1.0) { channel = -1.0; }
	if (channel > 1.0) { channel = 1.0; }
}

static void normalize_axes(const unsigned int x, const unsigned int y, const short deadzone, const vrpn_float64 scale, vrpn_float64& channelX, vrpn_float64& channelY, int wordSize = 16)
{
	normalize_axis(x, deadzone, scale, channelX, wordSize);
	normalize_axis(y, deadzone, scale, channelY, wordSize);
}

//////////////////////////////////////////////////////////////////////////
// Common base class
//////////////////////////////////////////////////////////////////////////
vrpn_CHProducts_Controller_Raw::vrpn_CHProducts_Controller_Raw(vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c) :
	vrpn_BaseClass(name, c)
	, vrpn_HidInterface(filter)
	, _filter(filter)
{
	init_hid();
}

vrpn_CHProducts_Controller_Raw::~vrpn_CHProducts_Controller_Raw(void)
{
	delete _filter;
}

void vrpn_CHProducts_Controller_Raw::init_hid()
{
	// Get notifications when clients connect and disconnect
	register_autodeleted_handler(d_connection->register_message_type(vrpn_dropped_last_connection), on_last_disconnect, this);
	register_autodeleted_handler(d_connection->register_message_type(vrpn_got_connection), on_connect, this);
}

void vrpn_CHProducts_Controller_Raw::on_data_received(size_t bytes, vrpn_uint8 *buffer)
{
	decodePacket(bytes, buffer);
}

int vrpn_CHProducts_Controller_Raw::on_last_disconnect(void* /* thisPtr */, vrpn_HANDLERPARAM /*p*/)
{
	return (0);
}

int vrpn_CHProducts_Controller_Raw::on_connect(void* /* thisPtr */, vrpn_HANDLERPARAM /*p*/)
{
	return (0);
}

//////////////////////////////////////////////////////////////////////////
// ST290 Pro Joystick
//////////////////////////////////////////////////////////////////////////
vrpn_CHProducts_Fighterstick_USB::vrpn_CHProducts_Fighterstick_USB(const char *name, vrpn_Connection *c) :
	vrpn_CHProducts_Controller_Raw(_filter = new vrpn_HidProductAcceptor(CHPRODUCTS_VENDOR, FIGHTERSTICK_USB), name, c),
	vrpn_Analog(name, c), vrpn_Button_Filter(name, c), vrpn_Dial(name, c)
{
	vrpn_Analog::num_channel = 8;
	vrpn_Dial::num_dials = 0;
	vrpn_Button::num_buttons = 24;

	// Initialize the state of all the analogs, buttons, and dials
	memset(buttons, 0, sizeof(buttons));
	memset(lastbuttons, 0, sizeof(lastbuttons));
	memset(channel, 0, sizeof(channel));
	memset(last, 0, sizeof(last));
}

void vrpn_CHProducts_Fighterstick_USB::mainloop(void)
{
	update();
	server_mainloop();
	struct timeval current_time;
	vrpn_gettimeofday(&current_time, NULL);
	if (vrpn_TimevalDuration(current_time, _timestamp) > POLL_INTERVAL)
	{
		_timestamp = current_time;
		report_changes();

		vrpn_Analog::server_mainloop();
		vrpn_Button::server_mainloop();
		if (vrpn_Dial::num_dials > 0)
		{
			vrpn_Dial::server_mainloop();
		}
	}
}

void vrpn_CHProducts_Fighterstick_USB::report(vrpn_uint32 class_of_service)
{
	vrpn_Analog::timestamp = _timestamp;
	vrpn_Button::timestamp = _timestamp;
	if (vrpn_Dial::num_dials > 0)
	{
		vrpn_Dial::timestamp = _timestamp;
	}

	vrpn_Analog::report_changes(class_of_service);
	vrpn_Button::report_changes();
	if (vrpn_Dial::num_dials > 0)
	{
		vrpn_Dial::report();
	}
}

void vrpn_CHProducts_Fighterstick_USB::report_changes(vrpn_uint32 class_of_service)
{
	vrpn_Analog::timestamp = _timestamp;
	vrpn_Button::timestamp = _timestamp;
	if (vrpn_Dial::num_dials > 0)
	{
		vrpn_Dial::timestamp = _timestamp;
	}

	vrpn_Analog::report(class_of_service);
	vrpn_Button::report_changes();
	if (vrpn_Dial::num_dials > 0)
	{
		vrpn_Dial::report();
	}
}

void vrpn_CHProducts_Fighterstick_USB::decodePacket(size_t bytes, vrpn_uint8 *buffer)
{
	// Fighterstick USB joystick

	// Decode all full reports, each of which is 6 bytes long.
		// Because there is only one type of report, the initial "0" report-type
		// byte is removed by the HIDAPI driver.
	/*
	[0]:	X-axis (left=00, right=ff, center=80)
	[1]:	Y-axis (up=00, down=ff, center=80)
	[2]:	throttle wheel (up=00, down=ff)
	[3]:	buttons high nibble: 0x10=trigger, 0x20=top red, 0x40=upper index red (toggles buttons 17-19), 0x80=pinky red,
	-		-	low nibble 8-way POV hat upper-right on top: none=0x00, N=0x01, NE=0x02, ... NW=0x08
	[4]:	high nibble 4-way hat #2 (lower-right on top): none=0x00, N=0x10, E=0x20, S=0x40, W=0x80
	-		-	low nibble 4-way hat #1 (left on top): none=0x00, N=0x01, E=0x02, S=0x04, W=0x08
	[5]:	upper nibble mode bits: 0x10=green, 0x20=red, 0x40=yellow, 0x80=<not used>
	-		-	low nibble 4-way hat #3 (thumb): none=0x00, N=0x01, E=0x02, S=0x04, W=0x08
	*/
	// XXX Check to see that this works with HIDAPI, there may be two smaller reports.
	if (bytes == 6)
	{
		normalize_axes(buffer[0], buffer[1], 0x08, 1.0f, channel[0], channel[1], 8);
		normalize_axis(buffer[2], 0x08, 1.0f, channel[2], 8);

		vrpn_uint8 value, mask;
		value = (buffer[3] >> 4);
		for (int btn = 0; btn < 4; btn++)
		{
			mask = static_cast<vrpn_uint8>(1 << (btn % 8));
			buttons[btn] = ((value & mask) != 0);
		}

		// Point of View Hat
		buttons[4] = buttons[5] = buttons[6] = buttons[7] = 0;
		switch (buffer[3] & 0x0f)
		{
		case 1:		// up
			buttons[4] = true;
			break;
		case 2:
			buttons[4] = buttons[5] = true;
			break;
		case 3:		// right
			buttons[5] = true;
			break;
		case 4:
			buttons[5] = buttons[6] = true;
			break;
		case 5:		// down
			buttons[6] = true;
			break;
		case 6:
			buttons[6] = buttons[7] = true;
			break;
		case 7:		// left
			buttons[7] = true;
			break;
		case 8:
			buttons[7] = buttons[4] = true;
			break;
		case 0:
		default:
			// nothing to do
			break;
		}
		channel[3] = normalize_dpad(buttons[4], buttons[5], buttons[6], buttons[7]);

		// 4-way Hat #2
		buttons[8] = buttons[9] = buttons[10] = buttons[11] = 0;
		switch (buffer[4] >> 4)
		{
		case 1:		// up
			buttons[8] = true;
			break;
		case 2:		// right
			buttons[9] = true;
			break;
		case 4:		// down
			buttons[10] = true;
			break;
		case 8:		// left
			buttons[11] = true;
			break;
		case 0:
		default:
			// nothing to do
			break;
		}
		channel[4] = normalize_dpad(buttons[8], buttons[9], buttons[10], buttons[11]);
		// 4-way Hat #1
		buttons[12] = buttons[13] = buttons[14] = buttons[15] = 0;
		switch (buffer[4] & 0x0f)
		{
		case 1:		// up
			buttons[12] = true;
			break;
		case 2:		// right
			buttons[13] = true;
			break;
		case 4:		// down
			buttons[14] = true;
			break;
		case 8:		// left
			buttons[15] = true;
			break;
		case 0:
		default:
			// nothing to do
			break;
		}
		channel[5] = normalize_dpad(buttons[12], buttons[13], buttons[14], buttons[15]);

		// mode
		// keep pseudo-button pressed to indicate mode
		//buttons[16] = buttons[17] = buttons[18] = buttons[19] = 0;
		switch (buffer[5] >> 4)
		{
		case 1:		// green
			buttons[16] = true;
			buttons[17] = buttons[18] = false;
			break;
		case 2:		// red
			buttons[17] = true;
			buttons[16] = buttons[18] = false;
			break;
		case 4:		// yellow
			buttons[18] = true;
			buttons[16] = buttons[17] = false;
			break;
/*
		case 8:		// none
			buttons[19] = true;
			break;
*/
		case 0:
		default:
			// nothing to do
			break;
		}
		if (buttons[16] || buttons[17] || buttons[18] || buttons[19])
		{
			channel[6] = (normalize_dpad(buttons[16], buttons[17], buttons[18], buttons[19]) / 90.0f) + 1.0f;
		}
		// 4-way Hat #3
		buttons[20] = buttons[21] = buttons[22] = buttons[23] = 0;
		switch (buffer[5] & 0x0f)
		{
		case 1:		// up
			buttons[20] = true;
			break;
		case 2:		// right
			buttons[21] = true;
			break;
		case 4:		// down
			buttons[22] = true;
			break;
		case 8:		// left
			buttons[23] = true;
			break;
		case 0:
		default:
			// nothing to do
			break;
		}
		channel[7] = normalize_dpad(buttons[20], buttons[21], buttons[22], buttons[23]);
	}
	else
	{
		fprintf(stderr, "vrpn_CHProducts_Fighterstick_USB: Found a corrupted report; # total bytes = %u\n", static_cast<unsigned>(bytes));
	}
}

// End of VRPN_USE_HID
#endif