initial commit

Author: Gurvan

.gitignore

@@ -0,0 +1,18 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Custom
+junk/

LICENSE

@@ -0,0 +1,34 @@
+# go-gc-adapter
+
+A Go library for interfacing with the Gamecube controller adapter.
+
+## Example
+
+```go
+package main
+
+import (
+	"fmt"
+	"log"
+	"time"
+
+	gcadapter "github.com/Gurvan/go-gc-adapter"
+)
+
+func main() {
+	adapter, err := gcadapter.NewGCAdapter()
+	if err != nil {
+		log.Fatalf("%v", err)
+	}
+	defer adapter.Close()
+	go adapter.StartPolling()
+
+	go func() {
+		for range time.Tick(time.Second / time.Duration(60.)) {
+			inputs := adapter.Controllers()
+			fmt.Println(inputs[0])
+		}
+	}()
+	time.Sleep(10 * time.Second)
+}
+```

README.md

@@ -0,0 +1,330 @@
+package gcadapter
+
+import (
+	"errors"
+	"log"
+	"sync"
+
+	"github.com/google/gousb"
+)
+
+const (
+	gcAdapterVendorID  gousb.ID = 0x057E
+	gcAdapterProductID gousb.ID = 0x0337
+	startEndpoint      int      = 0x02
+	readEndpoint       int      = 0x81
+)
+
+var startPayload = []byte{0x13}
+
+// GCAdapter represents a Gamecube controller usb adapter
+type GCAdapter struct {
+	ctx         *gousb.Context
+	dev         *gousb.Device
+	cfg         *gousb.Config
+	intf        *gousb.Interface
+	endpoint    *gousb.InEndpoint
+	controllers map[uint8]*rawGCInput
+	offsets     map[uint8]*Offsets
+	mutex       sync.RWMutex
+}
+
+// NewGCAdapter connects to a Gamecube controller usb adapter and returns a pointer to it.
+// An adapter should be closed with adapter.Close() once it's not required anymore or when the program closes.
+// The best way of achieving that is calling defer adapter.Close() right after adapter, err := NewGCAdapter()
+func NewGCAdapter() (*GCAdapter, error) {
+	var adapter *GCAdapter = nil
+	ctx := gousb.NewContext()
+	dev, err := ctx.OpenDeviceWithVIDPID(gcAdapterVendorID, gcAdapterProductID)
+	if dev == nil {
+		err = errors.New("GC Adapter: no adapter found")
+	}
+	if err != nil {
+		// log.Fatalf("list: %s", err)
+		return adapter, err
+	}
+
+	dev.SetAutoDetach(true)
+
+	cfg, err := dev.Config(1)
+	if err != nil {
+		// log.Fatalf("%s.Config(1): %v", dev, err)
+		return adapter, err
+	}
+
+	intf, err := cfg.Interface(0, 0)
+	if err != nil {
+		// log.Fatalf("%s.Interface(0, 0): %v", cfg, err)
+		return adapter, err
+	}
+
+	outep, err := intf.OutEndpoint(startEndpoint)
+	if err != nil {
+		// log.Fatalf("%s.OutEndpoint(%d): %v", outep, startEndpoint, err)
+		return adapter, err
+	}
+
+	_, err = outep.Write(startPayload)
+	if err != nil {
+		// log.Fatalf("Can't write payload %d: %v", out, err)
+		return adapter, err
+	}
+
+	inep, err := intf.InEndpoint(readEndpoint)
+	if err != nil {
+		// log.Fatalf("%s.InEndpoint(%d): %v", inep, readEndpoint, err)
+		return adapter, err
+	}
+
+	adapter = newGCAdapterFromEndpoint(inep)
+	adapter.ctx = ctx
+	adapter.dev = dev
+	adapter.cfg = cfg
+	adapter.intf = intf
+	adapter.mutex.Lock()
+	adapter.controllers = make(map[uint8]*rawGCInput)
+	adapter.offsets = make(map[uint8]*Offsets)
+	for _, PORT := range []uint8{0, 1, 2, 3} {
+		adapter.controllers[PORT] = &rawGCInput{}
+		adapter.offsets[PORT] = &Offsets{}
+	}
+	adapter.mutex.Unlock()
+	return adapter, nil
+}
+
+func newGCAdapterFromEndpoint(endpoint *gousb.InEndpoint) *GCAdapter {
+	adapter := &GCAdapter{}
+	adapter.endpoint = endpoint
+	return adapter
+}
+
+// Poll polls the Gamecube usb adapter once
+func (adapter *GCAdapter) Poll() error {
+	return adapter.step()
+}
+
+// StartPolling starts a Gamecube adapter polling loop, where the adapter is polled at its defined polling rate
+// (which is 125Hz by default on the official adapter).
+// The function is meant to be wrapped in a goroutine.
+func (adapter *GCAdapter) StartPolling() {
+	var err error
+	for {
+		err = adapter.step()
+		if err != nil {
+			log.Printf("%v", err)
+		}
+	}
+}
+
+// Close properly closes the adapter once it's not required anymore
+func (adapter *GCAdapter) Close() error {
+	var err error
+	err = adapter.ctx.Close()
+	if err != nil {
+		return err
+	}
+	err = adapter.dev.Close()
+	if err != nil {
+		return err
+	}
+	err = adapter.cfg.Close()
+	if err != nil {
+		return err
+	}
+	adapter.intf.Close()
+	return nil
+}
+
+// Buttons represents the Gamecube controller buttons
+type Buttons struct {
+	UP    bool
+	DOWN  bool
+	RIGHT bool
+	LEFT  bool
+	Y     bool
+	X     bool
+	B     bool
+	A     bool
+	L     bool
+	R     bool
+	Z     bool
+	START bool
+}
+
+type rawGCInput struct {
+	Button    Buttons
+	StickX    uint8
+	StickY    uint8
+	CX        uint8
+	CY        uint8
+	LAnalog   uint8
+	RAnalog   uint8
+	PluggedIn bool
+}
+
+// GCInputs represent the state of the gamecube controller, with sticks values in [-1, 1], triggers values in [0, 1] and buttons as boolean
+// Sticks and triggers values are calibrated, and sticks values are clamped inside the unit circle, but deadzones are not enforced.
+type GCInputs struct {
+	Button    Buttons
+	StickX    float32
+	StickY    float32
+	CX        float32
+	CY        float32
+	LAnalog   float32
+	RAnalog   float32
+	PluggedIn bool
+}
+
+// Offsets are the sticks and trigger values read right after plugging the controller or resetting it with X+Y+Start.
+// They are used to calibrate the values returned in GCInputs.
+type Offsets struct {
+	StickX    uint8
+	StickY    uint8
+	CX        uint8
+	CY        uint8
+	LAnalog   uint8
+	RAnalog   uint8
+	PluggedIn bool
+}
+
+func (adapter *GCAdapter) step() error {
+	controllers, err := readGCAdapter(adapter.endpoint)
+	if err != nil {
+		return err
+	}
+
+	for PORT, controller := range controllers {
+		if adapter.controllers[PORT].PluggedIn != adapter.offsets[PORT].PluggedIn {
+			adapter.offsets[PORT].PluggedIn = adapter.controllers[PORT].PluggedIn
+			adapter.offsets[PORT].StickX = adapter.controllers[PORT].StickX
+			adapter.offsets[PORT].StickY = adapter.controllers[PORT].StickY
+			adapter.offsets[PORT].CX = adapter.controllers[PORT].CX
+			adapter.offsets[PORT].CY = adapter.controllers[PORT].CY
+			adapter.offsets[PORT].LAnalog = adapter.controllers[PORT].LAnalog
+			adapter.offsets[PORT].RAnalog = adapter.controllers[PORT].RAnalog
+		}
+		adapter.mutex.Lock()
+		adapter.controllers[PORT] = controller
+		adapter.mutex.Unlock()
+	}
+
+	return nil
+}
+
+// Controller return the current state of the controller on port PORT.
+func (adapter *GCAdapter) Controller(PORT uint8) *GCInputs {
+	adapter.mutex.RLock()
+	defer adapter.mutex.RUnlock()
+	return processRawController(adapter.controllers[PORT], adapter.offsets[PORT])
+}
+
+// Controllers return the current state of the plugged in controllers.
+func (adapter *GCAdapter) Controllers() map[uint8]*GCInputs {
+	adapter.mutex.RLock()
+	defer adapter.mutex.RUnlock()
+	gcInputs := make(map[uint8]*GCInputs)
+	for _, PORT := range []uint8{0, 1, 2, 3} {
+		if adapter.controllers[PORT].PluggedIn {
+			gcInputs[PORT] = processRawController(adapter.controllers[PORT], adapter.offsets[PORT])
+		}
+	}
+	return gcInputs
+}
+
+// AllControllers return the current state of the 4 controllers (even unplugged ones)
+func (adapter *GCAdapter) AllControllers() map[uint8]*GCInputs {
+	adapter.mutex.RLock()
+	defer adapter.mutex.RUnlock()
+	gcInputs := make(map[uint8]*GCInputs)
+	for _, PORT := range []uint8{0, 1, 2, 3} {
+		gcInputs[PORT] = processRawController(adapter.controllers[PORT], adapter.offsets[PORT])
+	}
+	return gcInputs
+}
+
+func processRawController(rawInput *rawGCInput, offsets *Offsets) *GCInputs {
+	gcinput := GCInputs{}
+	gcinput.Button = rawInput.Button
+
+	x, y := rawInput.StickX, rawInput.StickY
+	dx, dy := offsets.StickX, offsets.StickY
+	x, y = correctStickOffset(x, dx), correctStickOffset(y, dy)
+	x, y = clampStick(x, y)
+	gcinput.StickX = float32(0.0125 * float64(byteToInt8(x)))
+	gcinput.StickY = float32(0.0125 * float64(byteToInt8(y)))
+
+	x, y = rawInput.CX, rawInput.CY
+	dx, dy = offsets.CX, offsets.CY
+	x, y = correctStickOffset(x, dx), correctStickOffset(y, dy)
+	x, y = clampStick(x, y)
+	gcinput.CX = float32(0.0125 * float64(byteToInt8(x)))
+	gcinput.CY = float32(0.0125 * float64(byteToInt8(y)))
+
+	l := rawInput.LAnalog
+	l = correctTriggerOffset(l, offsets.LAnalog)
+	if l > 140 {
+		l = 140
+	}
+	gcinput.LAnalog = float32(l) / 140.
+
+	r := rawInput.RAnalog
+	r = correctTriggerOffset(r, offsets.LAnalog)
+	if r > 140 {
+		r = 140
+	}
+	gcinput.RAnalog = float32(r) / 140.
+
+	// Deadzone
+	// if math.Abs(float64(gcinput.StickX)) < 0.28 {
+	// 	gcinput.StickX = 0
+	// }
+	// if math.Abs(float64(gcinput.StickY)) < 0.28 {
+	// 	gcinput.StickY = 0
+	// }
+	return &gcinput
+}
+
+func deserializeGCControllers(data []byte) map[uint8]*rawGCInput {
+	gcInputs := make(map[uint8]*rawGCInput)
+	for _, PORT := range []uint8{0, 1, 2, 3} {
+		gcInput := &rawGCInput{}
+
+		gcInput.PluggedIn = data[9*PORT+1] == 20 || data[9*PORT+1] == 16
+
+		gcInput.Button.UP = data[9*PORT+2]&0b10000000 != 0
+		gcInput.Button.DOWN = data[9*PORT+2]&0b01000000 != 0
+		gcInput.Button.RIGHT = data[9*PORT+2]&0b00100000 != 0
+		gcInput.Button.LEFT = data[9*PORT+2]&0b00010000 != 0
+		gcInput.Button.Y = data[9*PORT+2]&0b00001000 != 0
+		gcInput.Button.X = data[9*PORT+2]&0b00000100 != 0
+		gcInput.Button.B = data[9*PORT+2]&0b00000010 != 0
+		gcInput.Button.A = data[9*PORT+2]&0b00000001 != 0
+		gcInput.Button.L = data[9*PORT+3]&0b00001000 != 0
+		gcInput.Button.R = data[9*PORT+3]&0b00000100 != 0
+		gcInput.Button.Z = data[9*PORT+3]&0b00000010 != 0
+		gcInput.Button.START = data[9*PORT+3]&0b00000001 != 0
+
+		gcInput.StickX = data[9*PORT+4]
+		gcInput.StickY = data[9*PORT+5]
+		gcInput.CX = data[9*PORT+6]
+		gcInput.CX = data[9*PORT+7]
+		gcInput.LAnalog = data[9*PORT+8]
+		gcInput.RAnalog = data[9*PORT+9]
+
+		gcInputs[PORT] = gcInput
+	}
+	return gcInputs
+}
+
+func readGCAdapter(adapterEndpoint *gousb.InEndpoint) (map[uint8]*rawGCInput, error) {
+	rawGcInputs := make(map[uint8]*rawGCInput)
+
+	data := make([]byte, adapterEndpoint.Desc.MaxPacketSize)
+	_, err := adapterEndpoint.Read(data)
+	if err != nil {
+		// fmt.Printf("Couldn't read adapter. Error: %v\n", err)
+		return rawGcInputs, err
+	}
+	rawGcInputs = deserializeGCControllers(data)
+	return rawGcInputs, nil
+}