Resent-Date: Thu, 04 Nov 2021 22:28:26 +0100
Resent-Message-ID: <5d04bcf0-09f3-418c-be27-9540b6e0fccd@jankundrat.com>
Resent-From: =?iso-8859-1?Q?Jan_Kundr=E1t?= <jkt@jankundrat.com>
Resent-To: openswitcher ML <~martijnbraam/openatem@lists.sr.ht>
Message-Id: <a7096a800d4215828da5fa0e8e4ef97f86570932.1636061134.git.jkt@jankundrat.com>
In-Reply-To: <cover.1636061134.git.jkt@jankundrat.com>
References: <cover.1636061134.git.jkt@jankundrat.com>
From: =?UTF-8?q?Jan=20Kundr=C3=A1t?= <jkt@jankundrat.com>
Date: Thu, 20 May 2021 02:09:45 +0200
Subject: [PATCH 5/5] Implement reading of headphone monitoring: FMHP and FAMS
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
To: "openswitcher ML" <~martijnbraam/openatem@lists.sr.ht>

Signed-off-by: Jan Kundrát <jkt@jankundrat.com>
---
 pyatem/field.py    | 53 ++++++++++++++++++++++++++++++++++++++++++++++
 pyatem/protocol.py |  2 ++
 2 files changed, 55 insertions(+)

diff --git a/pyatem/field.py b/pyatem/field.py
index 67e03af..d2cd92f 100644
--- a/pyatem/field.py
+++ b/pyatem/field.py
@@ -1560,6 +1560,59 @@ class FairlightTallyField(FieldBase):
         return '<fairlight-tally {}>'.format(self.tally)
 
 
+class FairlightHeadphonesField(FieldBase):
+    """
+    Data from the `FMHP`, phones output volume and mute
+
+    This doesn't get triggered when soloing channels.
+
+    ====== ==== ====== ===========
+    Offset Size Type   Descriptions
+    ====== ==== ====== ===========
+    0      4    i32    Volume in 0.01 dB (-60.00 to +6.00 dB)
+    5      4    ?      Unknown
+    8      1    bool   Muted (0) / Umuted (1)
+    9      1    u8     Last soloed channel (just the main part)
+    10     22   ?      Unknown
+
+    """
+
+    def __init__(self, raw):
+        self.raw = raw
+        self.volume, self.unmuted = struct.unpack('> i 4x ? 23x', raw)
+
+    def __repr__(self):
+        return '<fairlight-headphones volume={} unmuted={}>'.format(self.volume, self.unmuted)
+
+
+class FairlightSoloField(FieldBase):
+    """
+    Data from the `FAMS`, soloing channels to phones
+
+    ====== ==== ====== ===========
+    Offset Size Type   Descriptions
+    ====== ==== ====== ===========
+    0      1    bool   Anything soloed?
+    1      7    ?      Unknown
+    8      1    u8     Unknown: 0x00 for HDMI channels, 0x05 for 3.5mm jack
+    9      1    u8     Soloed channel (main)
+    10     12   ?      Unknown
+    22     1    u8     No subchannels (0x01), split into L/R (0xff)
+    23     1    u8     Soloed channel (subchannel)
+
+    """
+
+    def __init__(self, raw):
+        self.raw = raw
+        self.solo, self.channel, self.is_split_lr, self.subchannel = struct.unpack('> ? 8x B 12x BB', raw)
+
+    def __repr__(self):
+        return '<fairlight-solo active={} source={}>'.format(
+            self.solo,
+            self.channel if self.is_split_lr == 0x01 else '{}.{}'.format(self.channel, self.subchannel),
+        )
+
+
 class AtemEqBandPropertiesField(FieldBase):
     """
     Data from the `AEBP` field. This encodes the EQ settings in the fairlight mixer. For every channel there will
diff --git a/pyatem/protocol.py b/pyatem/protocol.py
index 2ee2b86..bf1be27 100644
--- a/pyatem/protocol.py
+++ b/pyatem/protocol.py
@@ -124,6 +124,8 @@ class AtemProtocol:
             'AMTl': 'audio-mixer-tally',
             'FASP': 'fairlight-strip-properties',
             'FAMP': 'fairlight-master-properties',
+            'FMHP': 'fairlight-headphones',
+            'FAMS': 'fairlight-solo',
             '_TlC': 'tally-config',
             'TlIn': 'tally-index',
             'TlSr': 'tally-source',
-- 
2.33.0