Basic hat support. (#20)

Reviewed-on: #20
Co-authored-by: Anna Rose Wiggins <annabunches@gmail.com>
Co-committed-by: Anna Rose Wiggins <annabunches@gmail.com>

docs/examples/multiple_files/axes.yml

@@ -92,8 +92,9 @@ rules:
     input:
       device: left-stick
       axis: RY
-      deadzone_start: 0
+      deadzones:
-      deadzone_end: 30500
+        - start: 0
+          end: 30500
     output:
       device: mouse
       axis: REL_WHEEL
@@ -108,8 +109,9 @@ rules:
     input:
       device: left-stick
       axis: RY
-      deadzone_start: 29500
+      deadzones:
-      deadzone_end: 64000
+        - start: 29500
+          end: 64000
       inverted: true
     output:
       device: mouse

docs/examples/multiple_files/devices.yml

@@ -1,6 +1,6 @@
 devices:
   - name: primary
-    type: virtual
+    type: Virtual
     preset: joystick
   - name: secondary
     type: virtual

docs/examples/ruletypes.yml

@@ -18,8 +18,9 @@ rules:
     input:
       device: flightstick
       # To find reasonable values for your device's deadzones, use the evtest command
-      deadzone_start: 28000
+      deadzones:
-      deadzone_end: 30000
+        - start: 28000
+          end: 30000
       inverted: false
       axis: ABS_X
     output:
@@ -33,8 +34,9 @@ rules:
       # size value. This will create a deadzone that covers a range of deadzone_size,
       # centered on the center value. Note that if your deadzone_center is at the lower or upper end
       # of the axis, the total size will still be as given; the deadzone will be "shifted" into bounds.
-      deadzone_center: 29000
+      deadzones:
-      deadzone_size: 2000
+        - center: 29000
+          size: 2000
       inverted: false
       axis: Y # The ABS_ prefix is optional
     output:
@@ -46,8 +48,9 @@ rules:
       device: flightstick
       # A final way to specify deadzones is to use a size percentage instead of an absolute size.
       # This works exactly like deadzone_size, but calculates a percentage of the axis' total range.
-      deadzone_center: 29000
+      deadzones:
-      deadzone_size_percent: 5
+        - center: 29000
+          size_percent: 5
       inverted: false
       axis: Y # The ABS_ prefix is optional
     output:
@@ -67,6 +70,17 @@ rules:
       device: main
       axis: RZ
 
+  # Hat mapping. Hats are technically an axis, but only output -1, 0, or 1, so we don't normalize
+  # them to an output range, we just pass them through mostly unmodified
+  - type: hat
+    input:
+      device: flightstick
+      inverted: true # hats do support inversion. As with other rule types, this only has an effect on *inputs*.
+      hat: hat0x # a typical joystick hat actually has 2 hat axes: x and y
+    output:
+      device: main
+      hat: hat0x
+
   # Straightforward button mapping
   - type: button
     input:
@@ -108,8 +122,9 @@ rules:
     input:
       device: flightstick
       axis: ABS_RY # This axis commonly represents thumbsticks
-      deadzone_start: 0
+      deadzones:
-      deadzone_end: 30000
+        - start: 0
+          end: 30000
     output:
       device: main
       button: BTN_BASE4
@@ -126,8 +141,9 @@ rules:
     input:
       device: flightstick
       axis: ABS_Z
-      deadzone_start: 0
+      deadzones:
-      deadzone_end: 500
+        - start: 0
+          end: 500
     output:
       device: mouse
       button: REL_WHEEL

docs/readme.md

@@ -48,6 +48,7 @@ All `rules` must have a `type` parameter. Valid values for this parameter are:
 * `axis-combined` - a mapping that combines 2 input axes into a single output axis.
 * `axis-to-button` - causes an axis input to produce a button output. This can be repeated with variable speed proportional to the axis' input value
 * `axis-to-relaxis` - like axis-to-button, but produces a "relative axis" output value. This is useful for simulating mouse scrollwheel and movement events.
+* `hat` - a special type of axis with ternary output. Each joystick hat will typically be 2 hat axes named `ABS_HAT0X` / `ABS_HAT0Y`, where the `0` is an index between 0 - 3. So for a typical hat you would define 2 `hat` rules.
 
 Configuration options for each rule type vary. See [examples/ruletypes.yml](examples/ruletypes.yml) for an example of each type with all options specified.
 
@@ -73,13 +74,17 @@ evtest | grep BTN_
 
 **NOTE: For most axis mappings, you probably don't want to specify a deadzone!** Use deadzone configurations in your target game instead. Joyful-configured deadzones are intended to be used in conjunction with the `axis-to-button` and `axis-to-relaxis` input types, or when splitting an axis into multiple outputs. Using them with standard `axis` mappings may result in a loss of fidelity and "stuck" inputs.
 
-There are three ways to specify deadzones:
+Axis inputs can define a list of deadzones. Each deadzone can be specified a few ways:
 
-* Define `deadzone_start` and `deadzone_end` to explicitly set the deadzone bounds.
+* Define `start` and `end` to explicitly set the deadzone bounds.
-* Define `deadzone_center` and `deadzone_size`; this will create a deadzone of the indicated size centered at the given axis position.
+* Define `center` and `size`; this will create a deadzone of the indicated size centered at the given axis position.
-* Define `deadzone_center` and `deadzone_size_percent` to use a percentage of the total axis size.
+* Define `center` and `size_percent` to use a percentage of the total axis size.
 
-See <examples/ruletypes.yml> for usage examples.
+In addition, deadzones can set `emit` to `true` and `emit_value` to a value that should be emitted when inside the deadzone.
+
+**Note**: The `emit_value` is the final output value and should be between -32,768 and 32,767.
+
+See the <examples/> directory for usage examples.
 
 ## Modes
 

internal/configparser/ruleconfig.go

@@ -54,6 +54,10 @@ func (dc *RuleConfig) UnmarshalYAML(unmarshal func(data interface{}) error) erro
 		config := RuleConfigModeSelect{}
 		err = unmarshal(&config)
 		dc.Config = config
+	case RuleTypeHat:
+		config := RuleConfigHat{}
+		err = unmarshal(&config)
+		dc.Config = config
 	}
 
 	return err

internal/configparser/ruletarget.go

@@ -0,0 +1,39 @@
+package configparser
+
+type RuleTargetConfigButton struct {
+	Device   string
+	Button   string
+	Inverted bool
+}
+
+type RuleTargetConfigAxis struct {
+	Device    string
+	Axis      string
+	Inverted  bool
+	Deadzones []DeadzoneConfig
+}
+
+type DeadzoneConfig struct {
+	Center      int32 `yaml:"center,omitempty"`
+	Size        int32 `yaml:"size,omitempty"`
+	SizePercent int32 `yaml:"size_percent,omitempty"`
+	Start       int32 `yaml:"start,omitempty"`
+	End         int32 `yaml:"end,omitempty"`
+	Emit        bool  `yaml:"emit,omitempty"`
+	Value       int32 `yaml:"emit_value,omitempty"`
+}
+
+type RuleTargetConfigRelaxis struct {
+	Device string
+	Axis   string
+}
+
+type RuleTargetConfigModeSelect struct {
+	Modes []string
+}
+
+type RuleTargetConfigHat struct {
+	Device   string
+	Hat      string
+	Inverted bool
+}

internal/configparser/ruletype.go

@@ -18,6 +18,7 @@ const (
 	RuleTypeAxisToButton  RuleType = "axis-to-button"
 	RuleTypeAxisToRelaxis RuleType = "axis-to-relaxis"
 	RuleTypeModeSelect    RuleType = "mode-select"
+	RuleTypeHat           RuleType = "hat"
 )
 
 var (
@@ -30,6 +31,7 @@ var (
 		"axis-to-button":  RuleTypeAxisToButton,
 		"axis-to-relaxis": RuleTypeAxisToRelaxis,
 		"mode-select":     RuleTypeModeSelect,
+		"hat":             RuleTypeHat,
 	}
 )
 

internal/configparser/schema.go

@@ -40,6 +40,11 @@ type RuleConfigAxis struct {
 	Output RuleTargetConfigAxis
 }
 
+type RuleConfigHat struct {
+	Input  RuleTargetConfigHat
+	Output RuleTargetConfigHat
+}
+
 type RuleConfigAxisCombined struct {
 	InputLower RuleTargetConfigAxis `yaml:"input_lower,omitempty"`
 	InputUpper RuleTargetConfigAxis `yaml:"input_upper,omitempty"`
@@ -65,29 +70,3 @@ type RuleConfigModeSelect struct {
 	Input  RuleTargetConfigButton
 	Output RuleTargetConfigModeSelect
 }
-
-type RuleTargetConfigButton struct {
-	Device   string
-	Button   string
-	Inverted bool
-}
-
-type RuleTargetConfigAxis struct {
-	Device              string
-	Axis                string
-	DeadzoneCenter      int32 `yaml:"deadzone_center,omitempty"`
-	DeadzoneSize        int32 `yaml:"deadzone_size,omitempty"`
-	DeadzoneSizePercent int32 `yaml:"deadzone_size_percent,omitempty"`
-	DeadzoneStart       int32 `yaml:"deadzone_start,omitempty"`
-	DeadzoneEnd         int32 `yaml:"deadzone_end,omitempty"`
-	Inverted            bool
-}
-
-type RuleTargetConfigRelaxis struct {
-	Device string
-	Axis   string
-}
-
-type RuleTargetConfigModeSelect struct {
-	Modes []string
-}

internal/mappingrules/deadzone.go

@@ -0,0 +1,98 @@
+package mappingrules
+
+import (
+	"errors"
+	"fmt"
+
+	"git.annabunches.net/annabunches/joyful/internal/configparser"
+	"github.com/holoplot/go-evdev"
+)
+
+// TODO: need tests for multiple deadzones
+// TODO: need tests for emitting deadzones
+
+type Deadzone struct {
+	Start     int32
+	End       int32
+	Size      int32
+	Emit      bool
+	EmitValue int32
+}
+
+// DeadzoneState indicates whether a value is in a Deadzone and, if it is, whether the deadzone
+// should emit an event
+type DeadzoneState int
+
+const (
+	// DeadzoneClear indicates the value is *not* in the deadzone.
+	DeadzoneClear DeadzoneState = iota
+	DeadzoneEmit
+	DeadzoneNoEmit
+)
+
+// calculateDeadzones produces the deadzone start and end values in absolute terms
+func NewDeadzoneFromConfig(dzConfig configparser.DeadzoneConfig, device Device, axis evdev.EvCode) (Deadzone, error) {
+	dz := Deadzone{}
+	dz.Emit = dzConfig.Emit
+	dz.EmitValue = dzConfig.Value
+
+	var min, max int32
+	absInfoMap, err := device.AbsInfos()
+
+	if err != nil {
+		return dz, err
+	} else {
+		absInfo := absInfoMap[axis]
+		min = absInfo.Minimum
+		max = absInfo.Maximum
+	}
+
+	if dzConfig.Start != 0 || dzConfig.End != 0 {
+		dz.Start = Clamp(dzConfig.Start, min, max)
+		dz.End = Clamp(dzConfig.End, min, max)
+		if dz.Start > dz.End {
+			return dz, errors.New("deadzone end must be greater than deadzone start")
+		}
+	} else {
+		center := Clamp(dzConfig.Center, min, max)
+		var deadzoneSize int32
+
+		switch {
+		case dzConfig.Size != 0:
+			deadzoneSize = dzConfig.Size
+		case dzConfig.SizePercent != 0:
+			deadzoneSize = (max - min) / dzConfig.SizePercent
+		default:
+			return dz, fmt.Errorf("deadzone configured incorrectly; must define start and end or center and size")
+		}
+
+		dz.Start = center - deadzoneSize/2
+		dz.End = center + deadzoneSize/2
+		dz.Start, dz.End = clampAndShift(dz.Start, dz.End, min, max)
+	}
+
+	dz.Size = dz.End - dz.Start
+	return dz, nil
+}
+
+func CalculateDeadzoneSize(dzs []Deadzone) int32 {
+	var size int32
+
+	for _, dz := range dzs {
+		size += dz.Size
+	}
+
+	return size
+}
+
+// Match checks whether the target value is inside the deadzone.
+// It returns a DeadzoneState enum and possibly an int32.
+func (dz Deadzone) Match(value int32) (DeadzoneState, int32) {
+	if value < dz.Start || value > dz.End {
+		return DeadzoneClear, value
+	}
+	if dz.Emit {
+		return DeadzoneEmit, dz.EmitValue
+	}
+	return DeadzoneNoEmit, value
+}

internal/mappingrules/init_rule_targets_test.go

@@ -125,8 +125,12 @@ func (t *MakeRuleTargetsTests) TestMakeRuleTargetAxis() {
 	t.Run("Invalid deadzone", func() {
 		config := configparser.RuleTargetConfigAxis{Device: "test"}
 		config.Axis = "x"
-		config.DeadzoneEnd = 100
+		config.Deadzones = []configparser.DeadzoneConfig{
-		config.DeadzoneStart = 1000
+			{
+				End:   100,
+				Start: 1000,
+			},
+		}
 		_, err := NewRuleTargetAxisFromConfig(config, t.devs)
 		t.NotNil(err)
 	})
@@ -147,28 +151,19 @@ func (t *MakeRuleTargetsTests) TestMakeRuleTargetAxis() {
 			config := configparser.RuleTargetConfigAxis{
 				Device: "test",
 				Axis:   "x",
-				DeadzoneCenter: tc.inCenter,
+				Deadzones: []configparser.DeadzoneConfig{{
-				DeadzoneSize:   tc.inSize,
+					Center: tc.inCenter,
+					Size:   tc.inSize,
+				}},
 			}
 			rule, err := NewRuleTargetAxisFromConfig(config, t.devs)
 
 			t.Nil(err)
-			t.Equal(tc.outStart, rule.DeadzoneStart)
+			t.Equal(tc.outStart, rule.Deadzones[0].Start)
-			t.Equal(tc.outEnd, rule.DeadzoneEnd)
+			t.Equal(tc.outEnd, rule.Deadzones[0].End)
 		})
 	}
 
-	t.Run("Deadzone center/size invalid center", func() {
-		config := configparser.RuleTargetConfigAxis{
-			Device:         "test",
-			Axis:           "x",
-			DeadzoneCenter: 20000,
-			DeadzoneSize:   500,
-		}
-		_, err := NewRuleTargetAxisFromConfig(config, t.devs)
-		t.NotNil(err)
-	})
-
 	relDeadzonePercentTestCases := []struct {
 		inCenter      int32
 		inSizePercent int32
@@ -185,27 +180,18 @@ func (t *MakeRuleTargetsTests) TestMakeRuleTargetAxis() {
 			config := configparser.RuleTargetConfigAxis{
 				Device: "test",
 				Axis:   "x",
-				DeadzoneCenter:      tc.inCenter,
+				Deadzones: []configparser.DeadzoneConfig{{
-				DeadzoneSizePercent: tc.inSizePercent,
+					Center:      tc.inCenter,
+					SizePercent: tc.inSizePercent,
+				}},
 			}
 			rule, err := NewRuleTargetAxisFromConfig(config, t.devs)
 
 			t.Nil(err)
-			t.Equal(tc.outStart, rule.DeadzoneStart)
+			t.Equal(tc.outStart, rule.Deadzones[0].Start)
-			t.Equal(tc.outEnd, rule.DeadzoneEnd)
+			t.Equal(tc.outEnd, rule.Deadzones[0].End)
 		})
 	}
-
-	t.Run("Deadzone center/percent invalid center", func() {
-		config := configparser.RuleTargetConfigAxis{
-			Device:              "test",
-			Axis:                "x",
-			DeadzoneCenter:      20000,
-			DeadzoneSizePercent: 10,
-		}
-		_, err := NewRuleTargetAxisFromConfig(config, t.devs)
-		t.NotNil(err)
-	})
 }
 
 func (t *MakeRuleTargetsTests) TestMakeRuleTargetRelaxis() {

internal/mappingrules/init_rules.go

@@ -49,6 +49,8 @@ func NewRule(config configparser.RuleConfig, pDevs map[string]Device, vDevs map[
 		newRule, err = NewMappingRuleAxisToRelaxis(config.Config.(configparser.RuleConfigAxisToRelaxis), pDevs, vDevs, base)
 	case configparser.RuleTypeModeSelect:
 		newRule, err = NewMappingRuleModeSelect(config.Config.(configparser.RuleConfigModeSelect), pDevs, modes, base)
+	case configparser.RuleTypeHat:
+		newRule, err = NewMappingRuleHat(config.Config.(configparser.RuleConfigHat), pDevs, vDevs, base)
 	default:
 		// Shouldn't actually be possible to get here...
 		err = fmt.Errorf("bad rule type '%s' for rule '%s'", config.Type, config.Name)

internal/mappingrules/interfaces.go

@@ -22,9 +22,6 @@ type RuleTarget interface {
 	// (e.g., inverting the value if Inverted == true)
 	NormalizeValue(int32) int32
 
-	// MatchEvent returns true if the provided device and input event are a match for this rule target
-	ValidateEvent(*evdev.InputDevice, *evdev.InputEvent) bool
-
 	// CreateEvent creates an event that can be emitted on a virtual device.
 	// For RuleTargetModeSelect, this method modifies the active mode and returns nil.
 	//
@@ -35,6 +32,7 @@ type RuleTarget interface {
 	// for most implementations.
 	CreateEvent(int32, *string) *evdev.InputEvent
 
+	// MatchEvent returns true if the provided device and input event are a match for this rule target
 	MatchEvent(device Device, event *evdev.InputEvent) bool
 }
 

internal/mappingrules/mapping_rule_axis_combined_test.go

@@ -28,6 +28,7 @@ func TestRunnerMappingRuleAxisCombined(t *testing.T) {
 }
 
 func (t *MappingRuleAxisCombinedTests) SetupTest() {
+	noDeadzone := make([]Deadzone, 0)
 	mode := "*"
 	t.mode = &mode
 
@@ -37,13 +38,13 @@ func (t *MappingRuleAxisCombinedTests) SetupTest() {
 		evdev.ABS_Y: {Minimum: 0, Maximum: 10000},
 	}, nil)
 
-	t.inputTargetLower, _ = NewRuleTargetAxis("test-input", t.inputDevice, evdev.ABS_X, true, 0, 0)
+	t.inputTargetLower, _ = NewRuleTargetAxis("test-input", t.inputDevice, evdev.ABS_X, true, noDeadzone)
 	t.inputTargetLower.OutputMax = 0
-	t.inputTargetUpper, _ = NewRuleTargetAxis("test-input", t.inputDevice, evdev.ABS_Y, false, 0, 0)
+	t.inputTargetUpper, _ = NewRuleTargetAxis("test-input", t.inputDevice, evdev.ABS_Y, false, noDeadzone)
 	t.inputTargetUpper.OutputMin = 0
 
 	t.outputDevice = &evdev.InputDevice{}
-	t.outputTarget, _ = NewRuleTargetAxis("test-output", t.outputDevice, evdev.ABS_X, false, 0, 0)
+	t.outputTarget, _ = NewRuleTargetAxis("test-output", t.outputDevice, evdev.ABS_X, false, noDeadzone)
 
 	t.base = NewMappingRuleBase("", []string{"*"})
 
@@ -67,10 +68,10 @@ func (t *MappingRuleAxisCombinedTests) TestNewMappingRuleAxisCombined() {
 	}, nil)
 
 	rule := &MappingRuleAxisCombined{
-		MappingRuleBase: t.base,
+		// MappingRuleBase: t.base,
 		InputLower: t.inputTargetLower,
 		InputUpper: t.inputTargetUpper,
-		Output:          t.outputTarget,
+		// Output:          t.outputTarget,
 	}
 	t.EqualValues(0, rule.InputLower.OutputMax)
 	t.EqualValues(0, rule.InputUpper.OutputMin)

internal/mappingrules/mapping_rule_axis_to_button_test.go

@@ -67,7 +67,7 @@ func (t *MappingRuleAxisToButtonTests) SetupTest() {
 			Maximum: 10000,
 		},
 	}, nil)
-	t.inputRule, _ = NewRuleTargetAxis("test-input", t.inputDevice, evdev.ABS_X, false, int32(0), int32(1000))
+	t.inputRule, _ = NewRuleTargetAxis("test-input", t.inputDevice, evdev.ABS_X, false, []Deadzone{{Start: 0, End: 1000}})
 
 	t.outputDevice = &evdev.InputDevice{}
 	t.outputRule, _ = NewRuleTargetButton("test-output", t.outputDevice, evdev.ABS_X, false)
@@ -113,14 +113,16 @@ func (t *MappingRuleAxisToButtonTests) TestMatchEvent() {
 			Code:  evdev.ABS_X,
 			Value: 1001,
 		}, t.mode)
-		t.True(testRule.nextEvent > time.Duration(700*time.Millisecond))
+		// Allow leeway since time passes during the test
+		t.True(testRule.nextEvent > time.Duration(650*time.Millisecond))
 
 		testRule.MatchEvent(t.inputDevice, &evdev.InputEvent{
 			Type:  evdev.EV_ABS,
 			Code:  evdev.ABS_X,
 			Value: 5500,
 		}, t.mode)
-		t.Equal(time.Duration(500*time.Millisecond), testRule.nextEvent)
+		// Allow up to 50 ms leeway since time passes during the test
+		t.InDelta(time.Duration(500*time.Millisecond), testRule.nextEvent, 50000000)
 	})
 }
 

internal/mappingrules/mapping_rule_hat.go

@@ -0,0 +1,45 @@
+package mappingrules
+
+import (
+	"git.annabunches.net/annabunches/joyful/internal/configparser"
+	"github.com/holoplot/go-evdev"
+)
+
+// A Simple Mapping Rule can map a button to a button or an axis to an axis.
+type MappingRuleHat struct {
+	MappingRuleBase
+	Input  *RuleTargetHat
+	Output *RuleTargetHat
+}
+
+func NewMappingRuleHat(ruleConfig configparser.RuleConfigHat,
+	pDevs map[string]Device,
+	vDevs map[string]Device,
+	base MappingRuleBase) (*MappingRuleHat, error) {
+
+	input, err := NewRuleTargetHatFromConfig(ruleConfig.Input, pDevs)
+	if err != nil {
+		return nil, err
+	}
+
+	output, err := NewRuleTargetHatFromConfig(ruleConfig.Output, vDevs)
+	if err != nil {
+		return nil, err
+	}
+
+	return &MappingRuleHat{
+		MappingRuleBase: base,
+		Input:           input,
+		Output:          output,
+	}, nil
+}
+
+func (rule *MappingRuleHat) MatchEvent(device Device, event *evdev.InputEvent, mode *string) (*evdev.InputDevice, *evdev.InputEvent) {
+	if !rule.MappingRuleBase.modeCheck(mode) ||
+		!rule.Input.MatchEvent(device, event) {
+		return nil, nil
+	}
+
+	// The cast here is safe because the interface is only ever different for unit tests
+	return rule.Output.Device.(*evdev.InputDevice), rule.Output.CreateEvent(rule.Input.NormalizeValue(event.Value), mode)
+}

internal/mappingrules/rule_target_axis.go

@@ -14,8 +14,7 @@ type RuleTargetAxis struct {
 	Device       Device
 	Axis         evdev.EvCode
 	Inverted     bool
-	DeadzoneStart int32
+	Deadzones    []Deadzone
-	DeadzoneEnd   int32
 	OutputMin    int32
 	OutputMax    int32
 	axisSize     int32
@@ -28,77 +27,34 @@ func NewRuleTargetAxisFromConfig(targetConfig configparser.RuleTargetConfigAxis,
 		return nil, fmt.Errorf("non-existent device '%s'", targetConfig.Device)
 	}
 
-	if targetConfig.DeadzoneEnd < targetConfig.DeadzoneStart {
-		return nil, errors.New("deadzone_end must be greater than deadzone_start")
-	}
-
 	eventCode, err := eventcodes.ParseCode(targetConfig.Axis, eventcodes.CodePrefixAxis)
 	if err != nil {
 		return nil, err
 	}
 
-	deadzoneStart, deadzoneEnd, err := calculateDeadzones(targetConfig, device, eventCode)
+	deadzones := make([]Deadzone, 0)
+	for _, dzConfig := range targetConfig.Deadzones {
+		dz, err := NewDeadzoneFromConfig(dzConfig, device, eventCode)
 		if err != nil {
 			return nil, err
 		}
+		deadzones = append(deadzones, dz)
+	}
 
 	return NewRuleTargetAxis(
 		targetConfig.Device,
 		device,
 		eventCode,
 		targetConfig.Inverted,
-		deadzoneStart,
+		deadzones,
-		deadzoneEnd,
 	)
 }
 
-// calculateDeadzones produces the deadzone start and end values in absolute terms
-func calculateDeadzones(targetConfig configparser.RuleTargetConfigAxis, device Device, axis evdev.EvCode) (int32, int32, error) {
-
-	var deadzoneStart, deadzoneEnd int32
-	deadzoneStart = 0
-	deadzoneEnd = 0
-
-	if targetConfig.DeadzoneStart != 0 || targetConfig.DeadzoneEnd != 0 {
-		return targetConfig.DeadzoneStart, targetConfig.DeadzoneEnd, nil
-	}
-
-	var min, max int32
-	absInfoMap, err := device.AbsInfos()
-
-	if err != nil {
-		min = AxisValueMin
-		max = AxisValueMax
-	} else {
-		absInfo := absInfoMap[axis]
-		min = absInfo.Minimum
-		max = absInfo.Maximum
-	}
-
-	if targetConfig.DeadzoneCenter < min || targetConfig.DeadzoneCenter > max {
-		return 0, 0, fmt.Errorf("deadzone_center '%d' is out of bounds", targetConfig.DeadzoneCenter)
-	}
-
-	switch {
-	case targetConfig.DeadzoneSize != 0:
-		deadzoneStart = targetConfig.DeadzoneCenter - targetConfig.DeadzoneSize/2
-		deadzoneEnd = targetConfig.DeadzoneCenter + targetConfig.DeadzoneSize/2
-	case targetConfig.DeadzoneSizePercent != 0:
-		deadzoneSize := (max - min) / targetConfig.DeadzoneSizePercent
-		deadzoneStart = targetConfig.DeadzoneCenter - deadzoneSize/2
-		deadzoneEnd = targetConfig.DeadzoneCenter + deadzoneSize/2
-	}
-
-	deadzoneStart, deadzoneEnd = clampAndShift(deadzoneStart, deadzoneEnd, min, max)
-	return deadzoneStart, deadzoneEnd, nil
-}
-
 func NewRuleTargetAxis(device_name string,
 	device Device,
 	axis evdev.EvCode,
 	inverted bool,
-	deadzoneStart int32,
+	deadzones []Deadzone) (*RuleTargetAxis, error) {
-	deadzoneEnd int32) (*RuleTargetAxis, error) {
 
 	info, err := device.AbsInfos()
 
@@ -117,11 +73,7 @@ func NewRuleTargetAxis(device_name string,
 		return nil, fmt.Errorf("device does not support axis %v", axis)
 	}
 
-	if deadzoneStart > deadzoneEnd {
+	deadzoneSize := CalculateDeadzoneSize(deadzones)
-		return nil, errors.New("deadzone_end must be a higher value than deadzone_start")
-	}
-
-	deadzoneSize := Abs(deadzoneEnd - deadzoneStart)
 
 	// Our output range is limited to 16 bits, but we represent values internally with 32 bits.
 	// As a result, we shouldn't need to worry about integer overruns
@@ -138,8 +90,7 @@ func NewRuleTargetAxis(device_name string,
 		Inverted:     inverted,
 		OutputMin:    AxisValueMin,
 		OutputMax:    AxisValueMax,
-		DeadzoneStart: deadzoneStart,
+		Deadzones:    deadzones,
-		DeadzoneEnd:   deadzoneEnd,
 		deadzoneSize: deadzoneSize,
 		axisSize:     axisSize,
 	}, nil
@@ -150,9 +101,17 @@ func NewRuleTargetAxis(device_name string,
 // Axis inputs are normalized to the full signed int32 range to match the virtual device's axis
 // characteristics.
 //
+// If the raw value is inside the deadzone, we either emit no event, or we emit the deadzoneValue.
 // Typically this function is called after RuleTargetAxis.MatchEvent, which checks whether we are
 // in the deadzone, among other things.
 func (target *RuleTargetAxis) NormalizeValue(value int32) int32 {
+	for _, dz := range target.Deadzones {
+		state, dzValue := dz.Match(value)
+		if state == DeadzoneEmit {
+			return Clamp(dzValue, target.OutputMin, target.OutputMax)
+		}
+	}
+
 	axisStrength := target.GetAxisStrength(value)
 	return LerpInt(target.OutputMin, target.OutputMax, axisStrength)
 }
@@ -178,19 +137,30 @@ func (target *RuleTargetAxis) MatchEventDeviceAndCode(device Device, event *evde
 		event.Code == target.Axis
 }
 
+// InDeadZone checks each deadzone for whether the target value falls within it.
+// If *any* non-emitting deadzone matches, we return true.
 // TODO: Add tests
 func (target *RuleTargetAxis) InDeadZone(value int32) bool {
-	return target.deadzoneSize > 0 && value >= target.DeadzoneStart && value <= target.DeadzoneEnd
+	for _, dz := range target.Deadzones {
+		state, _ := dz.Match(value)
+		if state == DeadzoneNoEmit {
+			return true
+		}
+	}
+	return false
 }
 
 // GetAxisStrength returns a float between 0.0 and 1.0, representing the proportional
 // position along the axis' full range. (after factoring in deadzones)
 // Calling this function with `value` inside the deadzone range will produce undefined behavior
 func (target *RuleTargetAxis) GetAxisStrength(value int32) float64 {
-	if value > target.DeadzoneEnd {
+	adjValue := value
-		value -= target.deadzoneSize
+	for _, dz := range target.Deadzones {
+		if value > dz.End {
+			adjValue -= dz.Size
 		}
-	strength := float64(value) / float64(target.axisSize)
+	}
+	strength := float64(adjValue) / float64(target.axisSize)
 	if target.Inverted {
 		strength = 1.0 - strength
 	}

internal/mappingrules/rule_target_axis_test.go

@@ -38,42 +38,42 @@ func (t *RuleTargetAxisTests) TearDownTest() {
 }
 
 func (t *RuleTargetAxisTests) TestNewRuleTargetAxis() {
+	noDeadzone := make([]Deadzone, 0)
+
 	// RuleTargets should get created
-	ruleTarget, err := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+	ruleTarget, err := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 	t.Nil(err)
 	t.EqualValues(10000, ruleTarget.axisSize)
 
-	ruleTarget, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, 0, 0)
+	ruleTarget, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, noDeadzone)
 	t.Nil(err)
 	t.EqualValues(20000, ruleTarget.axisSize)
 
 	// Creating a rule with a deadzone should work and reduce the axisSize
-	ruleTarget, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, -500, 500)
+	ruleTarget, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, []Deadzone{{Start: -500, End: 500, Size: 1000}})
 	t.Nil(err)
 	t.EqualValues(19000, ruleTarget.axisSize)
-	t.EqualValues(-500, ruleTarget.DeadzoneStart)
+	t.EqualValues(-500, ruleTarget.Deadzones[0].Start)
-	t.EqualValues(500, ruleTarget.DeadzoneEnd)
+	t.EqualValues(500, ruleTarget.Deadzones[0].End)
-
-	// Creating a rule with a deadzone should fail if end > start
-	_, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, 500, -500)
-	t.NotNil(err)
 
 	// Creating a rule on a non-existent axis should err
-	_, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Z, false, 0, 0)
+	_, err = NewRuleTargetAxis("", t.mock, evdev.ABS_Z, false, noDeadzone)
 	t.NotNil(err)
 
 	// If Absinfo has an error, we should create a device with permissive bounds
 	t.call.Unset()
 	t.mock.On("AbsInfos").Return(map[evdev.EvCode]evdev.AbsInfo{}, errors.New("Test Error"))
-	ruleTarget, err = NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+	ruleTarget, err = NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 	t.Nil(err)
 	t.Equal(AxisValueMax-AxisValueMin, ruleTarget.axisSize)
 }
 
 func (t *RuleTargetAxisTests) TestNormalizeValue() {
+	noDeadzone := make([]Deadzone, 0)
+
 	// Basic normalization should work
 	t.Run("Simple normalization", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 		t.Equal(AxisValueMax, ruleTarget.NormalizeValue(int32(10000)))
 		t.Equal(AxisValueMin, ruleTarget.NormalizeValue(int32(0)))
 		t.EqualValues(0, ruleTarget.NormalizeValue(int32(5000)))
@@ -81,26 +81,26 @@ func (t *RuleTargetAxisTests) TestNormalizeValue() {
 
 	// Normalization with a deadzone should work
 	t.Run("With Deadzone", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 5000)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, []Deadzone{{Start: 0, End: 5000, Size: 5000}})
 		t.Equal(AxisValueMax, ruleTarget.NormalizeValue(int32(10000)))
-		t.True(ruleTarget.NormalizeValue(int32(5001)) < int32(-31000))
+		t.InDelta(int32(-32000), ruleTarget.NormalizeValue(int32(5001)), 1000)
 		t.EqualValues(0, ruleTarget.NormalizeValue(int32(7500)))
 	})
 
 	t.Run("Inverted", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, 0, 0)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, noDeadzone)
 		t.Equal(AxisValueMax, ruleTarget.NormalizeValue(int32(0)))
 		t.Equal(AxisValueMin, ruleTarget.NormalizeValue(int32(10000)))
 	})
 
 	t.Run("Out of bounds", func() { // Normalization past the stated axis bounds should clamp
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 		t.Equal(AxisValueMin, ruleTarget.NormalizeValue(int32(-30000)))
 		t.Equal(AxisValueMax, ruleTarget.NormalizeValue(int32(30000)))
 	})
 
 	t.Run("With partial output range", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 		ruleTarget.OutputMin = 0
 		ruleTarget.OutputMax = AxisValueMax
 		t.EqualValues(0, ruleTarget.NormalizeValue(int32(0)))
@@ -110,7 +110,7 @@ func (t *RuleTargetAxisTests) TestNormalizeValue() {
 }
 
 func (t *RuleTargetAxisTests) TestMatchEvent() {
-	ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, -500, 500)
+	ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_Y, false, []Deadzone{{Start: -500, End: 500}})
 	validEvent := &evdev.InputEvent{
 		Type:  evdev.EV_ABS,
 		Code:  evdev.ABS_Y,
@@ -133,7 +133,9 @@ func (t *RuleTargetAxisTests) TestMatchEvent() {
 }
 
 func (t *RuleTargetAxisTests) TestCreateEvent() {
-	ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+	noDeadzone := make([]Deadzone, 0)
+
+	ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 	expected := &evdev.InputEvent{
 		Type: evdev.EV_ABS,
 		Code: evdev.ABS_X,
@@ -155,43 +157,45 @@ func (t *RuleTargetAxisTests) TestCreateEvent() {
 }
 
 func (t *RuleTargetAxisTests) TestGetAxisStrength() {
+	noDeadzone := make([]Deadzone, 0)
+
 	t.Run("With no deadzone", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 0)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, noDeadzone)
 		t.Equal(0.0, ruleTarget.GetAxisStrength(0))
 		t.Equal(1.0, ruleTarget.GetAxisStrength(10000))
 		t.Equal(0.5, ruleTarget.GetAxisStrength(5000))
 	})
 
 	t.Run("With low deadzone", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 0, 5000)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, []Deadzone{{Start: 0, End: 5000, Size: 5000}})
 		t.InDelta(0.0, ruleTarget.GetAxisStrength(5001), 0.01)
 		t.InDelta(0.5, ruleTarget.GetAxisStrength(7500), 0.01)
 		t.Equal(1.0, ruleTarget.GetAxisStrength(10000))
 	})
 
 	t.Run("With high deadzone", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, 5000, 10000)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, false, []Deadzone{{Start: 5000, End: 10000, Size: 5000}})
 		t.Equal(0.0, ruleTarget.GetAxisStrength(0))
 		t.InDelta(0.5, ruleTarget.GetAxisStrength(2500), 0.01)
 		t.InDelta(1.0, ruleTarget.GetAxisStrength(4999), 0.01)
 	})
 
 	t.Run("Inverted", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, 0, 0)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, noDeadzone)
 		t.Equal(1.0, ruleTarget.GetAxisStrength(0))
 		t.Equal(0.5, ruleTarget.GetAxisStrength(5000))
 		t.Equal(0.0, ruleTarget.GetAxisStrength(10000))
 	})
 
 	t.Run("Inverted with low deadzone", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, 0, 5000)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, []Deadzone{{Start: 0, End: 5000, Size: 5000}})
 		t.InDelta(1.0, ruleTarget.GetAxisStrength(5001), 0.01)
 		t.InDelta(0.5, ruleTarget.GetAxisStrength(7500), 0.01)
 		t.Equal(0.0, ruleTarget.GetAxisStrength(10000))
 	})
 
 	t.Run("Inverted with high deadzone", func() {
-		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, 5000, 10000)
+		ruleTarget, _ := NewRuleTargetAxis("", t.mock, evdev.ABS_X, true, []Deadzone{{Start: 5000, End: 10000, Size: 5000}})
 		t.InDelta(0.0, ruleTarget.GetAxisStrength(4999), 0.01)
 		t.InDelta(0.5, ruleTarget.GetAxisStrength(2500), 0.01)
 		t.Equal(1.0, ruleTarget.GetAxisStrength(0))

internal/mappingrules/rule_target_hat.go

@@ -0,0 +1,53 @@
+package mappingrules
+
+import (
+	"fmt"
+
+	"git.annabunches.net/annabunches/joyful/internal/configparser"
+	"git.annabunches.net/annabunches/joyful/internal/eventcodes"
+	"github.com/holoplot/go-evdev"
+)
+
+type RuleTargetHat struct {
+	Device   Device
+	Hat      evdev.EvCode
+	Inverted bool
+}
+
+func NewRuleTargetHatFromConfig(config configparser.RuleTargetConfigHat, devs map[string]Device) (*RuleTargetHat, error) {
+	dev, ok := devs[config.Device]
+	if !ok {
+		return nil, fmt.Errorf("device '%s' not found", config.Device)
+	}
+
+	code, err := eventcodes.ParseCode(config.Hat, eventcodes.CodePrefixAxis)
+	if err != nil {
+		return nil, err
+	}
+
+	return &RuleTargetHat{
+		Device:   dev,
+		Hat:      code,
+		Inverted: config.Inverted,
+	}, nil
+}
+
+func (target *RuleTargetHat) NormalizeValue(value int32) int32 {
+	if !target.Inverted {
+		return value
+	}
+
+	return value * -1
+}
+
+func (target *RuleTargetHat) CreateEvent(value int32, _ *string) *evdev.InputEvent {
+	return &evdev.InputEvent{
+		Type:  evdev.EV_ABS,
+		Code:  target.Hat,
+		Value: value,
+	}
+}
+
+func (target *RuleTargetHat) MatchEvent(device Device, event *evdev.InputEvent) bool {
+	return device == target.Device && event.Code == target.Hat
+}

internal/virtualdevice/variables.go

@@ -49,6 +49,15 @@ var (
 			evdev.ABS_RZ,
 			evdev.ABS_THROTTLE, // Also called "Slider" or "Slider1"
 			evdev.ABS_RUDDER,   // Also called "Dial", "Slider2", or "RSlider"
+			// Hats
+			evdev.ABS_HAT0X,
+			evdev.ABS_HAT0Y,
+			evdev.ABS_HAT1X,
+			evdev.ABS_HAT1Y,
+			evdev.ABS_HAT2X,
+			evdev.ABS_HAT2Y,
+			evdev.ABS_HAT3X,
+			evdev.ABS_HAT3Y,
 		},
 		evdev.EV_KEY: {
 			evdev.BTN_TRIGGER,

readme.md

@@ -10,13 +10,13 @@ Joyful is ideal for Linux gamers who enjoy space and flight sims and miss the fe
 
 ### Current Features
 
-* Create virtual devices with up to 8 axes and 74 buttons.
+* Create virtual devices with up to 8 axes, 4 hats, and 74 buttons.
 * Flexible rule system that allows several different types of rules, including:
-    * Simple 1:1 mappings of buttons and axes: Button1 -> VirtualButtonA
+    * Simple 1:1 mappings of buttons, axes, and hats: Button1 -> VirtualButtonA
     * Combination mappings: Button1 + Button2 -> VirtualButtonA
     * "Split" axis mapping: map sections of an axis to different outputs using deadzones.
     * "Combined" axis mapping: map two physical axes to one virtual axis.
-    * Axis -> button mapping with optional "proportional" repeat speed (i.e. repeat faster as the axis is engaged further)
+    * Axis -> Button mapping with optional "proportional" repeat speed (i.e. repeat faster as the axis is engaged further)
     * Axis -> Relative Axis mapping, for converting a joystick axis to mouse movement and scrollwheel events.
 * Define keyboard, mouse, and gamepad outputs in addition to joysticks.
 * Configure per-rule configurable deadzones for axes, with multiple ways to specify deadzones.
@@ -27,10 +27,10 @@ Joyful is ideal for Linux gamers who enjoy space and flight sims and miss the fe
 
 * Macros - have a single input produce a sequence of button presses with configurable pauses.
 * Sequence combos - Button1, Button2, Button3 -> VirtualButtonA
-* Hat support
+* Hat -> Button and Button -> Hat support.
-* HIDRAW support for more button options.
+* HIDRAW support for more button options
 * Sensitivity Curves?
-* Packaged builds non-Arch distributions.
+* Packaged builds for non-Arch distributions.
 
 ## Configure