Auto midi port (#58)

Author: modyf01

docs/controllers.md

@@ -29,6 +29,8 @@ button_value_on: 127
 knob_value_min: 0
 knob_value_max: 127
 default_channel: 1
+preferred_midi_in: "Some midi input port"
+preferred_midi_out: "Some midi output port"
 buttons:
   - id: 1
     name: "Button 1"

midi_app_controller/actions/_tests/test_actions_handler.py

@@ -37,6 +37,8 @@ def bound_controller() -> BoundController:
         "knob_value_min": 0,
         "knob_value_max": 127,
         "default_channel": 3,
+        "preferred_midi_in": "TestMidiIn",
+        "preferred_midi_out": "TestMidiOut",
         "buttons": [{"id": 0, "name": "Button1"}, {"id": 1, "name": "Button2"}],
         "knobs": [{"id": 2, "name": "Knob1"}, {"id": 3, "name": "Knob2"}],
     }

midi_app_controller/actions/_tests/test_bound_controller.py

@@ -42,6 +42,8 @@ def controller() -> Controller:
         "knob_value_min": 33,
         "knob_value_max": 55,
         "default_channel": 4,
+        "preferred_midi_in": "TestMidiIn",
+        "preferred_midi_out": "TestMidiOut",
         "buttons": [
             {"id": 0, "name": "Button1"},
             {"id": 1, "name": "Button2"},

midi_app_controller/controller/_tests/test_connected_controller.py

@@ -23,6 +23,8 @@ def controller():
         knob_value_min=0,
         knob_value_max=127,
         default_channel=1,
+        preferred_midi_in="TestMidiIn",
+        preferred_midi_out="TestMidiOut",
         buttons=buttons,
         knobs=knobs,
     )

midi_app_controller/gui/_tests/test_binds_editor.py

@@ -35,6 +35,8 @@ def controller_sample() -> Controller:
         button_value_on=127,
         knob_value_min=0,
         knob_value_max=127,
+        preferred_midi_in="TestMidiIn",
+        preferred_midi_out="TestMidiOut",
         buttons=buttons,
         knobs=knobs,
         default_channel=1,

midi_app_controller/gui/_tests/test_midi_status.py

@@ -64,6 +64,8 @@ def create_controller(path):
     index = match.group(1)
     mock = MagicMock(spec=Controller)
     mock.name = f"Controller {index}"
+    mock.preferred_midi_in = "TestMidiIn"
+    mock.preferred_midi_out = "TestMidiOut"
     mock.buttons = []
     mock.knobs = []
     mock.knob_value_min = 0

midi_app_controller/gui/midi_status.py

@@ -186,6 +186,7 @@ def _select_controller(self, controller: Optional[SelectedItem]) -> None:
         state = get_state_manager()
         state.select_controller(controller)
         state.select_recent_binds()
+        state.select_default_midi_ports()
         state.select_recent_midi_ports()
         self.refresh()
 

midi_app_controller/models/_tests/test_controller.py

@@ -13,6 +13,8 @@ def controller_data() -> dict:
         "knob_value_min": 33,
         "knob_value_max": 55,
         "default_channel": 2,
+        "preferred_midi_in": "TestMidiIn",
+        "preferred_midi_out": "TestMidiOut",
         "buttons": [{"id": 1, "name": "Button1"}, {"id": 2, "name": "Button2"}],
         "knobs": [{"id": 3, "name": "Knob1"}, {"id": 4, "name": "Knob2"}],
     }

midi_app_controller/models/binds.py

@@ -58,7 +58,7 @@ class Binds(YamlBaseModel):
     name: str = Field(min_length=1)
     app_name: str = Field(min_length=1)
     controller_name: str = Field(min_length=1)
-    description: Optional[str]
+    description: Optional[str] = None
     button_binds: list[ButtonBind]
     knob_binds: list[KnobBind]
 

midi_app_controller/models/controller.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from pydantic import BaseModel, Field, field_validator, model_validator
 
 from .utils import YamlBaseModel, find_duplicate
@@ -42,6 +44,10 @@ class Controller(YamlBaseModel):
     default_channel : int
         The default channel which MIDI messages will be sent on. Should
         be in the range [1, 16].
+    preferred_midi_in : Optional[str]
+        MIDI input name that is preferred for this controller.
+    preferred_midi_out : Optional[str]
+        MIDI output name that is preferred for this controller.
     buttons : list[ControllerElement]
         List of available buttons on the controller.
     knobs : list[ControllerElement]
@@ -54,6 +60,8 @@ class Controller(YamlBaseModel):
     knob_value_min: int = Field(ge=0, le=127)
     knob_value_max: int = Field(ge=0, le=127)
     default_channel: int = Field(ge=1, le=16)
+    preferred_midi_in: Optional[str] = None
+    preferred_midi_out: Optional[str] = None
     buttons: list[ControllerElement]
     knobs: list[ControllerElement]
 

midi_app_controller/state/_tests/test_state_manager.py

@@ -67,6 +67,8 @@ def controller() -> Controller:
         "knob_value_min": 33,
         "knob_value_max": 55,
         "default_channel": 5,
+        "preferred_midi_in": "TestMidiIn",
+        "preferred_midi_out": "TestMidiOut",
         "buttons": [{"id": 0, "name": "Button1"}, {"id": 1, "name": "Button2"}],
         "knobs": [{"id": 2, "name": "Knob1"}, {"id": 3, "name": "Knob2"}],
     }

midi_app_controller/state/state_manager.py

@@ -284,6 +284,16 @@ def start_handling(self) -> None:
             midi_out=self._midi_out,
         )
 
+    def select_default_midi_ports(self):
+        """Selects default port for the controller."""
+        if self.selected_controller:
+            controller = Controller.load_from(self.selected_controller.path)
+            if controller.preferred_midi_in in self.get_available_midi_in():
+                self.selected_midi_in = controller.preferred_midi_in
+
+            if controller.preferred_midi_out in self.get_available_midi_out():
+                self.selected_midi_out = controller.preferred_midi_out
+
     def select_recent_midi_ports(self):
         """Select MIDI ports that were recently used with the current controller."""
         if (