Merge pull request #3 from quaternionmedia/gld

🎚️ GLD

Author: mrharpo

.github/workflows/draft-release.yml

@@ -0,0 +1,14 @@
+name: 📦 Release
+on:
+  milestone:
+    types: [closed]
+jobs:
+  release:
+    name: 📝 Draft Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📰 Checkout
+        uses: actions/checkout@v3
+
+      - name: 📦 Create draft release from milestone
+        uses: quaternionmedia/milestones@main

README.md

@@ -2,13 +2,15 @@
 
 remote mixing
 
-
 ### install
+
 install locally
 `pip install -e ludwig/`
 
 ### configure
+
 edit `main.py` according to your configuration
 
 ### run
+
 `ludwig`

ludwig/__init__.py

@@ -9,4 +9,7 @@
 
 from pluggy import HookimplMarker
 
+from .mixer import Mixer
+from .midi import Midi
+
 mixer = HookimplMarker('mixer')

ludwig/boards/__init__.py

@@ -0,0 +1,2 @@
+from .qu24 import Qu24
+from .gld import Gld

ludwig/boards/gld.py

@@ -0,0 +1,110 @@
+from ludwig import mixer, Mixer, Midi
+from rtmidi.midiconstants import NOTE_ON
+from ludwig.types import uint1, uint2, uint3, uint4, uint7, uint8
+from pydantic import conint
+
+
+class Gld(Midi, Mixer):
+    def __init__(self, *args, **kwargs):
+        super().__init__(self, *args, **kwargs)
+        self.sysex_header = [0xF0, 0x0, 0x0, 0x1A, 0x50, 0x10, 0x1, 0x0, self.channel]
+
+    @mixer
+    def allCall(self):
+        self.send(self.sysex_header[:-1] + [0x7F] + [0x10, 0x0, 0xF7])
+
+    @mixer
+    def meters(self):
+        self.sysex([0x12, 0x1])
+
+    @mixer
+    def fader(self, channel: uint7, volume: uint8):
+        self.nrpn(channel=channel, param=0x17, data1=volume, data2=0x7)
+
+    @mixer
+    def channel_assign_to_main_mix(self, channel: uint7, on: bool):
+        self.nrpn(channel=channel, param=0x18, data1=0x7F if on else 0x3F, data2=0x7)
+
+    @mixer
+    def aux_send_level(self, channel: uint7, snd: uint8, level: uint8):
+        self.nrpn(channel=channel, param=snd, data1=level, data2=0x7)
+
+    @mixer
+    def dca_assign(self, channel: uint7, dca: conint(ge=1, le=16), on: bool):
+        """1 indexed"""
+        self.nrpn(
+            channel=channel, param=on * 0x40 | dca - 1, data1=0x4 | dca, data2=0x7
+        )
+
+    @mixer
+    def channel_name(self, channel: uint7, name: str):
+        if len(name) > 8:
+            raise Exception("Name must be less than 8 characters")
+        self.sysex([0x3, channel] + [ord(n) for n in name])
+
+    @mixer
+    def channel_color(self, channel: uint7, color: uint3):
+        self.sysex([0x6, channel, color])
+
+    @mixer
+    def scene_recall(self, scene: conint(ge=1, le=500)):
+        """recall scene, where scenes are 1 indexed"""
+        self.send([0xB0 | self.channel, 0x0, scene // 128, scene % 128])
+
+    @mixer
+    def mix_select(self, channel: uint7, select: bool):
+        self.send([0xA0 | self.channel, channel, int(select)])
+
+    @mixer
+    def pan(self, channel: uint7, pan: uint8):
+        self.nrpn(channel, 0x16, pan, 0x7)
+
+    @mixer
+    def mute(self, channel: uint7):
+        self.send([NOTE_ON | self.channel, channel, 127])
+
+    @mixer
+    def unmute(self, channel: uint7):
+        self.send([NOTE_ON | self.channel, channel, 1])
+
+    @mixer
+    def compressor(
+        self,
+        channel: uint7,
+        type: uint2 | None = None,
+        attack: uint7 | None = None,
+        release: uint7 | None = None,
+        knee: uint1 | None = None,
+        ratio: uint7 | None = None,
+        threshold: uint7 | None = None,
+        gain: uint7 | None = None,
+    ):
+        """send values to the compressor
+
+        Reuqired arguments:
+            channel (uint7): MIDI channel
+
+        Optional arguments:
+            type (uint2): 4 allowed types
+            attack (uint7): 300us to 300ms
+            release (uint7): 100ms to 2s
+            knee (uint1): 0 = hard, 1 = soft
+            ratio (uint7): 1:1 to inf (e.g. 2.6:1 = 80)
+            threshold (uint7): -46 to +18dB
+            gain (uint7): 0 +18dB
+        """
+
+        if type:
+            self.nrpn(channel, 0x61, type, 0x7)
+        if attack:
+            self.nrpn(channel, 0x62, attack, 0x7)
+        if release:
+            self.nrpn(channel, 0x63, release, 0x7)
+        if knee:
+            self.nrpn(channel, 0x64, knee, 0x7)
+        if ratio:
+            self.nrpn(channel, 0x65, ratio, 0x7)
+        if threshold:
+            self.nrpn(channel, 0x66, threshold, 0x7)
+        if gain:
+            self.nrpn(channel, 0x67, gain, 0x7)

ludwig/boards.py ludwig/boards/qu24.py

@@ -1,28 +1,23 @@
-from ludwig import mixer
-from ludwig.specs import Midi, Mixer
-from rtmidi.midiconstants import NOTE_ON, NOTE_OFF, CONTROL_CHANGE
-from ludwig.types import uint1, uint2, uint4, uint7, uint8, uint16
-from datetime import datetime
+from ludwig import mixer, Midi, Mixer
+from rtmidi.midiconstants import NOTE_ON
+from ludwig.types import uint1, uint2, uint7, uint8
 
 
 class Qu24(Midi, Mixer):
     def __init__(self, *args, **kwargs):
         super().__init__(self, *args, **kwargs)
-        self.header = [0xF0, 0x0, 0x0, 0x1A, 0x50, 0x11, 0x1, 0x0, self.channel]
-        self.start_time = datetime.now()
-        self.log = []
+        self.sysex_header = [0xF0, 0x0, 0x0, 0x1A, 0x50, 0x11, 0x1, 0x0, self.channel]
 
     @mixer
     def allCall(self):
-        self.send(self.header[:-1] + [0x7F] + [0x10, 0x0, 0xF7])
+        self.send(self.sysex_header[:-1] + [0x7F] + [0x10, 0x0, 0xF7])
 
     @mixer
     def meters(self):
-        self.send(self.header + [0x12, 0x1, 0xF7])
+        self.send(self.sysex_header + [0x12, 0x1, 0xF7])
 
     @mixer
     def fader(self, channel: uint7, volume: uint8):
-        print(self.client_name, 'setting channel volume', channel, volume)
         self.nrpn(channel=channel, param=0x17, data1=volume, data2=0x7)
 
     @mixer
@@ -76,5 +71,6 @@ def compressor(
             self.nrpn(channel, 0x65, ratio, 0x7)
         if threshold:
             self.nrpn(channel, 0x66, threshold, 0x7)
+
         if gain:
             self.nrpn(channel, 0x67, gain, 0x7)

ludwig/main.py

@@ -1,5 +1,5 @@
-from ludwig.specs import Mixer
-from ludwig.boards import Qu24
+from .mixer import Mixer
+from .boards import Qu24
 from pluggy import PluginManager
 from argparse import ArgumentTypeError
 

ludwig/specs.py ludwig/midi.py

@@ -1,55 +1,6 @@
-from pluggy import HookspecMarker
 from rtmidi.midiutil import open_midioutput, open_midiinput
 from rtmidi.midiconstants import CONTROL_CHANGE
-from ludwig.types import uint4, uint7, uint8, uint16
-
-mix = HookspecMarker('mixer')
-
-
-class Mixer:
-    """A generic mixer class, to be overwritten by individual boards"""
-
-    @mix
-    def mute(self, channel: int):
-        """mute channel"""
-
-    @mix
-    def unmute(self, channel: int):
-        """unmute channel"""
-
-    @mix
-    def fader(self, channel: int, volume: int):
-        """set the fader volume of a channel"""
-
-    @mix
-    def pan(self, channel: int, pan: int):
-        """set pan of the channel"""
-
-    @mix
-    def compressor(
-        self,
-        channel: int,
-        type: int | None = None,
-        attack: int | None = None,
-        release: int | None = None,
-        knee: int | None = None,
-        ratio: int | None = None,
-        threshold: int | None = None,
-        gain: int | None = None,
-    ):
-        """set the compressor of the channel"""
-
-    @mix
-    def meters(self):
-        """get all meter values"""
-
-    @mix
-    def allCall(self):
-        """get full board status"""
-
-    @mix
-    def close(self):
-        """close the midi connection"""
+from ludwig.types import uint4, uint7, uint8
 
 
 class Midi:
@@ -97,6 +48,10 @@ def nrpn(self, channel: uint7, param: uint8, data1: uint8, data2: uint8):
         self.send([header, 0x6, data1])
         self.send([header, 0x26, data2])
 
+    def sysex(self, message: list[uint8]):
+        """send a MIDI sysex message. Requires self.sysex_header to be set."""
+        self.midi.send_message([*self.sysex_header, *message, 0xF7])
+
     def __call__(self, event, data=None):
         message, deltatime = event
         print(self.client_name, message, deltatime)

ludwig/mixer.py

@@ -0,0 +1,89 @@
+from pluggy import HookspecMarker
+from ludwig.types import uint3, uint7, uint8
+from pydantic import conint
+
+mix = HookspecMarker('mixer')
+
+
+class Mixer:
+    """A generic mixer class, to be overwritten by individual boards"""
+
+    @mix
+    def mute(self, channel: int):
+        """mute channel"""
+
+    @mix
+    def unmute(self, channel: int):
+        """unmute channel"""
+
+    @mix
+    def fader(self, channel: int, volume: int):
+        """set the fader volume of a channel"""
+
+    @mix
+    def channel_assign_to_main_mix(self, channel: uint7, on: bool):
+        """assign a channel to the main mix"""
+
+    @mix
+    def aux_send_level(self, channel: uint7, snd: uint8, level: uint8):
+        """set the aux send level"""
+
+    @mix
+    def dca_assign(self, channel: uint7, dca: conint(ge=1, le=16), on: bool):
+        """set the dca assignment for a channel"""
+
+    @mix
+    def channel_name(self, channel: uint7, name: str):
+        """set the channel name. Must be less than 8 characters."""
+
+    @mix
+    def channel_color(self, channel: uint7, color: uint3):
+        """set the channel color from 8 options:
+        0: black
+        1: red
+        2: green
+        3: yellow
+        4: blue
+        5: purple
+        6: lt blue
+        7: white
+        """
+
+    @mix
+    def scene_recall(self, scene: conint(ge=1, le=500)):
+        """recall scene, where scenes are 1 indexed"""
+        self.send([0xB0 | self.channel, 0x0, scene // 128, scene % 128])
+
+    @mix
+    def mix_select(self, channel: uint7, select: bool):
+        self.send([0xA0 | self.channel, channel, int(select)])
+
+    @mix
+    def pan(self, channel: int, pan: int):
+        """set pan of the channel"""
+
+    @mix
+    def compressor(
+        self,
+        channel: int,
+        type: int | None = None,
+        attack: int | None = None,
+        release: int | None = None,
+        knee: int | None = None,
+        ratio: int | None = None,
+        threshold: int | None = None,
+        gain: int | None = None,
+    ):
+        """set the compressor of the channel"""
+
+    @mix
+    def meters(self):
+        """get all meter values"""
+
+    @mix
+    def allCall(self):
+        """get full board status"""
+
+    @mix
+    def close(self):
+        """close the midi connection"""

ludwig/types.py

@@ -8,6 +8,7 @@
 # unsigned integers
 uint1 = conint(ge=0, lt=2)
 uint2 = conint(ge=0, lt=4)
+uint3 = conint(ge=0, lt=8)
 uint4 = conint(ge=0, lt=16)
 uint7 = conint(ge=0, lt=128)
 uint8 = conint(ge=0, lt=256)

setup.py

@@ -3,9 +3,9 @@
 setup(
     name='ludwig',
     install_requires=[
-        'pluggy>=0.3,<1.0',
+        'pluggy>=1.0,<2.0',
         'python-rtmidi>=1.4.9,<1.5.0',
-        'pydantic>=1.9.0,<1.10.0',
+        'pydantic>=1.10.2,<1.11.0',
     ],
     entry_points={'console_scripts': ['ludwig=ludwig.main:main']},
     packages=find_packages(),