Clean up

Adjustments to how the arduino code works
Better describe the config file

Author: Red-M

.gitignore

@@ -12,3 +12,5 @@ releases/
 *.bin
 logs/
 preferences.yaml
+arduino/**/*.hex
+

arduino/deej-5-sliders-vanilla/deej-5-sliders-vanilla.ino

@@ -1,13 +1,8 @@
 const int NUM_SLIDERS = 5;
 const int sensor_history = 5;
-const int slider_range = 2;
-const int analogInputs[NUM_SLIDERS] = {A0, A1, A2, A3, A10};
-int lastValues[NUM_SLIDERS][sensor_history] = {
-  {0,0,0,0,0},
-  {0,0,0,0,0},
-  {0,0,0,0,0},
-  {0,0,0,0,0},
-  {0,0,0,0,0}};
+const int slider_range = 4;
+const int analogInputs[NUM_SLIDERS] = {A0, A10, A1, A2, A3};
+int (*lastValues)[NUM_SLIDERS] = new int[sensor_history][NUM_SLIDERS];
 String last_string = "";
 
 int analogSliderValues[NUM_SLIDERS];
@@ -22,14 +17,15 @@ void setup() {
 
 void loop() {
   updateSliderValues();
-  sendSliderValues(); // Actually send data (all the time)
+  sendSliderValues();
   // printSliderValues(); // For debug
   delay(1);
 }
 
 void updateSliderValues() {
   int current_value = 0;
   for (int i = 0; i < NUM_SLIDERS; i++) {
+    current_value = analogRead(analogInputs[i]);
     current_value = analogRead(analogInputs[i]);
     int updateOutput = 1;
     for(int ii = 0 ; ii<sensor_history ; ii++ ){

assets/build-3d-annotated.png

@@ -1,10 +1,9 @@
-# process names are case-insensitive
+# process names are case-insensitive but also require the application binary name to match correctly. eg, ${process_binary}: ${proccess_name}
+# device names are case-sensitive and are in the format: reeemiks.device: ${device_name}~${pipewire_node_name}
+# If you can't get the name correct then running in verbose mode will print all the applications and the devices (called sinks) reeemiks can find.
 # you can use 'master' to indicate the master channel, or a list of process names to create a group
 # you can use 'mic' to control your mic input level (uses the default recording device)
-# you can use 'deej.unmapped' to control all apps that aren't bound to any slider (this ignores master, system, mic and device-targeting sessions)
-# windows only - you can use 'deej.current' to control the currently active app (whether full-screen or not)
-# windows only - you can use a device's full name, i.e. "Speakers (Realtek High Definition Audio)", to bind it. this works for both output and input devices
-# windows only - you can use 'system' to control the "system sounds" volume
+# you can use 'reeemiks.unmapped' to control all apps that aren't bound to any slider (this ignores master, system, mic and device-targeting sessions)
 # important: slider or knob indexes start at 0, regardless of which analog pins you're using!
 slider_mapping:
   0:

assets/build-3d.png

@@ -10,13 +10,13 @@ require (
 	github.com/gopherjs/gopherjs v0.0.0-20200217142428-fce0ec30dd00 // indirect
 	github.com/jacobsa/go-serial v0.0.0-20180131005756-15cf729a72d4
 	github.com/jfreymuth/pulse v0.0.0-20200608153616-84b2d752b9d4
-	github.com/kirsle/configdir v0.0.0-20170128060238-e45d2f54772f // indirect
+	github.com/kirsle/configdir v0.0.0-20170128060238-e45d2f54772f
 	github.com/lxn/win v0.0.0-20191128105842-2da648fda5b4
-	github.com/micmonay/keybd_event v1.1.1 // indirect
+	github.com/micmonay/keybd_event v1.1.1
 	github.com/mitchellh/go-ps v1.0.0
 	github.com/moutend/go-wca v0.1.2-0.20190422112502-0fa027b3d89a
 	github.com/spf13/viper v1.7.1
-	github.com/sstallion/go-hid v0.14.1 // indirect
+	github.com/sstallion/go-hid v0.14.1
 	github.com/thoas/go-funk v0.7.0
 	go.uber.org/zap v1.15.0
 )

assets/build-shoebox.jpg

@@ -197,8 +197,6 @@ github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
 github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
 github.com/spf13/viper v1.7.1 h1:pM5oEahlgWv/WnHXpgbKz7iLIxRf65tye2Ci+XFK5sk=
 github.com/spf13/viper v1.7.1/go.mod h1:8WkrPz2fc9jxqZNCJI/76HCieCp4Q8HaLFoCha5qpdg=
-github.com/sstallion/go-hid v0.0.0-20190621001400-1cf4630be9f4 h1:hczfXYN39SDj4FcN5J7sgHBtJm4U7ef2nvlonn6NvVU=
-github.com/sstallion/go-hid v0.0.0-20190621001400-1cf4630be9f4/go.mod h1:JwBz6izP5UGcbYDU5VGeLkqpRIpSBDPtCB5/XnVXz9Q=
 github.com/sstallion/go-hid v0.14.1 h1:shbZlKqv5fr1KnxwqtLEPGkOoA6OSUWTx9TblegATvc=
 github.com/sstallion/go-hid v0.14.1/go.mod h1:fPKp4rqx0xuoTV94gwKojsPG++KNKhxuU88goGuGM7I=
 github.com/sstallion/go-tools v1.0.1/go.mod h1:y3Rklut4T6cPLmNkaU0obckQpnVSSvAZlB2N87qgUtg=
@@ -294,7 +292,6 @@ golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9 h1:YTzHMGlqJu67/uEo1lBv0n3wBXhXNeUbB1XfN2vmTm0=
 golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU=
 golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

assets/community-builds/abbythegryphon.jpg

@@ -33,11 +33,11 @@ type CanonicalConfig struct {
 	}
 
 	EnableHidListen bool
-
 	InvertSliders bool
-
 	NoiseReductionLevel string
 
+	ReeemiksMatching string
+
 	logger             *zap.SugaredLogger
 	notifier           Notifier
 	stopWatcherChannel chan bool
@@ -65,6 +65,7 @@ const (
 	configKeyUsagePage           = "usage_page"
 	configKeyUsage               = "usage"
 	configKeyEnableHID           = "enable_hid_listen"
+	configReeemiksMatching = "Reeemiks.matching"
 
 	defaultCOMPort  = "COM4"
 	defaultBaudRate = 9600
@@ -90,7 +91,7 @@ var userConfigPath = func() string {
 	if !xdg_exists && rel_exists {
 		util.MoveFile(userConfigFilename,configFile)
 	} else if xdg_exists && rel_exists {
-		fmt.Printf("I'm ignoring your config relative to my binary, your config is located at: %s", configFile)
+		fmt.Printf("WARN: I'm ignoring your config relative to my binary, your config is located at: %s\n", configFile)
 	} else if !xdg_exists && !rel_exists {
 		fmt.Errorf("Config file doesn't exist: %s", configFile)
 	}
@@ -132,6 +133,7 @@ func NewConfig(logger *zap.SugaredLogger, notifier Notifier) (*CanonicalConfig,
 	userConfig.SetDefault(configKeyCOMPort, defaultCOMPort)
 	userConfig.SetDefault(configKeyBaudRate, defaultBaudRate)
 	userConfig.SetDefault(configKeyEnableHID, false)
+	userConfig.SetDefault(configReeemiksMatching, map[string]string{})
 
 	internalConfig := viper.New()
 	internalConfig.SetConfigName(internalConfigName)
@@ -291,6 +293,8 @@ func (cc *CanonicalConfig) populateFromVipers() error {
 	cc.InvertSliders = cc.userConfig.GetBool(configKeyInvertSliders)
 	cc.NoiseReductionLevel = cc.userConfig.GetString(configKeyNoiseReductionLevel)
 
+	cc.ReeemiksMatching = cc.userConfig.GetString(configReeemiksMatching)
+
 	cc.logger.Debug("Populated config fields from vipers")
 
 	return nil

assets/community-builds/aithorn.jpg

@@ -55,7 +55,7 @@ func NewDeej(logger *zap.SugaredLogger, verbose bool) (*Deej, error) {
 		verbose:     verbose,
 	}
 
-	sessionFinder, err := newSessionFinder(logger)
+	sessionFinder, err := newSessionFinder(logger,config)
 	if err != nil {
 		logger.Errorw("Failed to create SessionFinder", "error", err)
 		return nil, fmt.Errorf("create new SessionFinder: %w", err)

assets/community-builds/bao.jpg

@@ -12,12 +12,13 @@ import (
 type paSessionFinder struct {
 	logger        *zap.SugaredLogger
 	sessionLogger *zap.SugaredLogger
+	config        *CanonicalConfig
 
 	client *proto.Client
 	conn   net.Conn
 }
 
-func newSessionFinder(logger *zap.SugaredLogger) (SessionFinder, error) {
+func newSessionFinder(logger *zap.SugaredLogger, config *CanonicalConfig) (SessionFinder, error) {
 	client, conn, err := proto.Connect("")
 	if err != nil {
 		logger.Warnw("Failed to establish PulseAudio connection", "error", err)
@@ -26,7 +27,7 @@ func newSessionFinder(logger *zap.SugaredLogger) (SessionFinder, error) {
 
 	request := proto.SetClientName{
 		Props: proto.PropList{
-			"application.name": proto.PropListString("deej"),
+			"application.name": proto.PropListString("Reeemiks"),
 		},
 	}
 	reply := proto.SetClientNameReply{}
@@ -38,6 +39,7 @@ func newSessionFinder(logger *zap.SugaredLogger) (SessionFinder, error) {
 	sf := &paSessionFinder{
 		logger:        logger.Named("session_finder"),
 		sessionLogger: logger.Named("sessions"),
+		config:        config,
 		client:        client,
 		conn:          conn,
 	}
@@ -129,11 +131,28 @@ func (sf *paSessionFinder) enumerateAndAddSessions(sessions *[]Session) error {
 		return fmt.Errorf("get sink input list: %w", err)
 	}
 
-	for _, info := range reply {
-		var process_binary proto.PropListEntry
-		var process_name proto.PropListEntry
-		var name string
-		var ok bool
+	if sf.config.ReeemiksMatching == "default" {
+		for _, info := range reply {
+			name, ok := info.Properties["application.process.binary"]
+
+			if !ok {
+				sf.logger.Warnw("Failed to get sink input's process name", "sinkInputIndex", info.SinkInputIndex)
+				continue
+			}
+
+			// create the deej session object
+			newSession := newPASession(sf.sessionLogger, sf.client, info.SinkInputIndex, info.Channels, name.String())
+
+			// add it to our slice
+			*sessions = append(*sessions, newSession)
+
+		}
+	} else { // All new Reeemiks features
+		for _, info := range reply {
+			var process_binary proto.PropListEntry
+			var process_name proto.PropListEntry
+			var name string
+			var ok bool
 
 			process_binary, ok = info.Properties["media.name"]
 			if !ok {
@@ -147,69 +166,70 @@ func (sf *paSessionFinder) enumerateAndAddSessions(sessions *[]Session) error {
 			}
 			name = process_binary.String() + ": " + process_name.String()
 
-		sf.logger.Debug("Process: ", name)
-
-		// create the deej session object
-		newSession := newPASession(sf.sessionLogger, sf.client, info.SinkInputIndex, info.Channels, name)
+			sf.logger.Info("Process: ", name)
 
-		// add it to our slice
-		*sessions = append(*sessions, newSession)
+			// create the deej session object
+			newSession := newPASession(sf.sessionLogger, sf.client, info.SinkInputIndex, info.Channels, name)
 
-	}
+			// add it to our slice
+			*sessions = append(*sessions, newSession)
 
-	request2 := proto.GetSinkInfoList{}
-	reply2 := proto.GetSinkInfoListReply{}
+		}
 
-	if err := sf.client.Request(&request2, &reply2); err != nil {
-		sf.logger.Warnw("Failed to get sink list", "error", err)
-		return fmt.Errorf("get sink list: %w", err)
-	}
+		request2 := proto.GetSinkInfoList{}
+		reply2 := proto.GetSinkInfoListReply{}
 
-	for _, info := range reply2 {
-		var audio_pos proto.PropListEntry
-		var process_binary proto.PropListEntry
-		var process_name proto.PropListEntry
-		var name string
-		var ok bool
+		if err := sf.client.Request(&request2, &reply2); err != nil {
+			sf.logger.Warnw("Failed to get sink list", "error", err)
+			return fmt.Errorf("get sink list: %w", err)
+		}
 
-		audio_pos, ok = info.Properties["audio.position"]
-		if ok {
-			process_binary, ok = info.Properties["media.name"]
-			audio_pos = audio_pos
-			if !ok {
-				sf.logger.Debug("Failed to get sink's media name", "sinkInputIndex", info.SinkIndex)
-				continue
+		for _, info := range reply2 {
+			var audio_pos proto.PropListEntry
+			var process_binary proto.PropListEntry
+			var process_name proto.PropListEntry
+			var name string
+			var ok bool
+
+			audio_pos, ok = info.Properties["audio.position"]
+			if ok {
+				audio_pos = audio_pos
+				process_binary, ok = info.Properties["media.name"]
+				if !ok {
+					sf.logger.Debug("Failed to get sink's media name", "sinkInputIndex", info.SinkIndex)
+					continue
+				}
+				process_name, ok = info.Properties["node.name"]
+				if !ok {
+					sf.logger.Debug("Failed to get sink's node name", "sinkInputIndex", info.SinkIndex)
+					continue
+				}
+				// name = "deej.device: " + process_name.String()
+				name = "reeemiks.device: " + process_binary.String() + "~" + process_name.String()
 			}
-			process_name, ok = info.Properties["node.name"]
-			if !ok {
-				sf.logger.Debug("Failed to get sink's node name", "sinkInputIndex", info.SinkIndex)
-				continue
+
+			// regex_match, err := regexp.MatchString("^(Audio/(Device|Sink|Source)|Stream/Output/Audio)$", media_class.String())
+			// if err==nil {
+			// 	if regex_match {
+			// 	} else {
+			// 	}
+			// } else {
+			// 	if !ok {
+			// 		sf.logger.Warnw("Failed to regex match sink input's media class", "sinkInputIndex", info.SinkIndex)
+			// 		continue
+			// 	}
+			// }
+
+			if name != "" {
+				sf.logger.Info("Sink: ", name)
+
+				// create the deej session object
+				newSession := newPASession(sf.sessionLogger, sf.client, info.SinkIndex, info.Channels, name)
+
+				// add it to our slice
+				*sessions = append(*sessions, newSession)
 			}
-			// name = "deej.device: " + process_name.String()
-			name = "reeemiks.device: " + process_binary.String() + "~" + process_name.String()
 		}
-
-		// regex_match, err := regexp.MatchString("^(Audio/(Device|Sink|Source)|Stream/Output/Audio)$", media_class.String())
-		// if err==nil {
-		// 	if regex_match {
-		// 	} else {
-		// 	}
-		// } else {
-		// 	if !ok {
-		// 		sf.logger.Warnw("Failed to regex match sink input's media class", "sinkInputIndex", info.SinkIndex)
-		// 		continue
-		// 	}
-		// }
-
-
-		sf.logger.Debug("Sink: ", name)
-
-		// create the deej session object
-		newSession := newPASession(sf.sessionLogger, sf.client, info.SinkIndex, info.Channels, name)
-
-		// add it to our slice
-		*sessions = append(*sessions, newSession)
-
 	}
 
 	return nil

assets/community-builds/bgrier.jpg

@@ -16,6 +16,7 @@ import (
 type wcaSessionFinder struct {
 	logger        *zap.SugaredLogger
 	sessionLogger *zap.SugaredLogger
+	config         *CanonicalConfig
 
 	eventCtx *ole.GUID // needed for some session actions to successfully notify other audio consumers
 
@@ -31,8 +32,8 @@ type wcaSessionFinder struct {
 
 const (
 
-	// there's no real mystery here, it's just a random GUID
-	myteriousGUID = "{1ec920a1-7db8-44ba-9779-e5d28ed9f330}"
+	// random GUID, used for the application's GUID
+	reeemiksGUID = "{e3f979e1-2f34-4a52-9d2c-0375ea389a1f}"
 
 	// the notification client will call this multiple times in quick succession based on the
 	// default device's assigned media roles, so we need to filter out the extraneous calls
@@ -42,11 +43,12 @@ const (
 	deviceSessionFormat = "device.%s"
 )
 
-func newSessionFinder(logger *zap.SugaredLogger) (SessionFinder, error) {
+func newSessionFinder(logger *zap.SugaredLogger, config *CanonicalConfig) (SessionFinder, error) {
 	sf := &wcaSessionFinder{
 		logger:        logger.Named("session_finder"),
 		sessionLogger: logger.Named("sessions"),
-		eventCtx:      ole.NewGUID(myteriousGUID),
+		eventCtx:      ole.NewGUID(reeemiksGUID),
+		config: config,
 	}
 
 	sf.logger.Debug("Created WCA session finder instance")