mx-remote 9.0.0__tar.gz → 9.1.0__tar.gz

{mx_remote-9.0.0 → mx_remote-9.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 9.0.0
+Version: 9.1.0
 Summary: Python 3 library for interfacing with MX Remote compatible devices
 Project-URL: Homepage, https://github.com/opdenkamp/mx-remote/
 Project-URL: Documentation, https://opdenkamp.github.io/mx-remote/

{mx_remote-9.0.0 → mx_remote-9.1.0}/docs/api.md

@@ -168,6 +168,23 @@ bit, and the range of the infrared profiles.
 .. autodata:: mx_remote.proto.Constants.ONEIP_VLAN_ID_MAX
 ```
 
+## OneIP stereo downmix
+
+How a device's output mixes 5.1 and 7.1 PCM down to stereo.
+
+```{eval-rst}
+.. autoclass:: mx_remote.OneIPDownmix
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.OneIPDownmixMode
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.OneIPDownmixLevel
+   :members:
+
+.. autodata:: mx_remote.proto.Constants.ONEIP_DOWNMIX_LFE_MAX
+```
+
 ## OneIP PTP
 
 A device's PTP settings, which it reports and a controller writes, and the PTP

{mx_remote-9.0.0 → mx_remote-9.1.0}/docs/oneip.md

@@ -318,6 +318,31 @@ if ptp is not None:
     print(ptp.grandmaster)    # its clock identity, None while there is none
 ```
 
+### Stereo downmix
+
+A device whose output can mix 5.1 and 7.1 PCM down to stereo reports how,
+once its video processor has answered for it: a mode, a level and the percent
+the LFE channel is mixed in at, which a controller writes, and the state and
+channel count, which only the device reports. A device that reports none has
+no downmix to set, so a write to one is refused, as is a mode, level or LFE
+percent out of range. The write sends the mode, level and LFE together; the
+state and channels are never sent.
+
+```python
+from mx_remote import OneIPDownmix
+from mx_remote.proto.Constants import OneIPDownmixMode, OneIPDownmixLevel
+
+downmix = device.oneip_downmix    # None: no report yet, or no downmix
+if downmix is not None:
+    print(downmix.mode, downmix.level, downmix.lfe)   # LFE up to ONEIP_DOWNMIX_LFE_MAX
+    print(downmix.state, downmix.channels)            # the device's own
+    await device.set_oneip_downmix(OneIPDownmix(mode=OneIPDownmixMode.AUTO,
+                                                level=OneIPDownmixLevel.NORMALISED, lfe=50))
+```
+
+The downmix ends the settings block, behind a second valid word, so the write
+runs on to 248 bytes and carries no other setting.
+
 ### VLAN
 
 A device that announces `DeviceFeature.VLAN` tags its uplink by a VLAN

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/Interface.py

@@ -2135,6 +2135,46 @@ class OneIPPtpState:
         return (f"{mode} domain {self.domain} port state {self.port_state} {lock}"
                 f"{' followed' if self.followed else ''} clock {self.clock_identity.hex(':')} grandmaster {gm}")
 
+@dataclass(frozen=True)
+class OneIPDownmix:
+    """
+    How a OneIP output mixes 5.1 and 7.1 PCM down to stereo, and whether it
+    does now.
+
+    A device reports it once its video processor has answered for it, so never
+    one whose output cannot mix down.
+    """
+    mode: OneIPDownmixMode|int = OneIPDownmixMode.OFF
+    """When the output mixes down; a raw int for a mode this library does not
+    name."""
+    level: OneIPDownmixLevel|int = OneIPDownmixLevel.NORMALISED
+    """How loud the mix is; a raw int for a level this library does not name."""
+    lfe: int = 0
+    """The percent the LFE channel is mixed in at, at most
+    ONEIP_DOWNMIX_LFE_MAX; 0 leaves it out."""
+    state: int = 0
+    """Why the stream is or is not mixed down, as the device's own code. Only
+    the device reports it."""
+    channels: int = 0
+    """The stream's channels while it is mixed down, else 0. Only the device
+    reports it."""
+
+    def is_valid(self) -> bool:
+        """Whether the settings a write carries are in range."""
+        return ((OneIPDownmixMode.OFF <= self.mode <= OneIPDownmixMode.ALWAYS)
+                and (OneIPDownmixLevel.NORMALISED <= self.level <= OneIPDownmixLevel.UNSCALED)
+                and (0 <= self.lfe <= ONEIP_DOWNMIX_LFE_MAX))
+
+    def written(self, write:'OneIPDownmix') -> 'OneIPDownmix':
+        """The settings of write applied to this report, which keeps what only
+        the device reports."""
+        return replace(self, mode=write.mode, level=write.level, lfe=write.lfe)
+
+    def __str__(self) -> str:
+        mode = self.mode.name.lower() if isinstance(self.mode, OneIPDownmixMode) else self.mode
+        level = self.level.name.lower() if isinstance(self.level, OneIPDownmixLevel) else self.level
+        return f"{mode} {level} lfe {self.lfe}% state {self.state} channels {self.channels}"
+
 @dataclass(frozen=True)
 class OneIPVlan:
     """
@@ -3239,6 +3279,14 @@ class DeviceBase(ABC):
     async def confirm_unit_network(self) -> bool:
         '''keep the unit's pending IP configuration'''
 
+    @property
+    @abstractmethod
+    def oneip_downmix(self) -> OneIPDownmix|None:
+        '''How this OneIP device's output mixes down to stereo, as it last
+        reported, None while it reports no downmix: until its video processor
+        has answered for it, and always for one whose output cannot mix
+        down.'''
+
     @property
     @abstractmethod
     def oneip_ptp(self) -> OneIPPtpState|None:
@@ -3532,6 +3580,10 @@ class DeviceBase(ABC):
     async def set_oneip_ptp_messages(self, which:OneIPDeviceSetting, messages:OneIPPtpMessages) -> bool:
         '''set how the device paces its PTP messages, its SAP timings and its streams' TTL: the values of messages behind the bits of which'''
 
+    @abstractmethod
+    async def set_oneip_downmix(self, downmix:OneIPDownmix) -> bool:
+        '''set how the device's output mixes down to stereo'''
+
     @abstractmethod
     async def set_oneip_vlan(self, vlan:OneIPVlan) -> bool:
         '''change the device's VLAN configuration'''

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/Interface.pyi

@@ -757,6 +757,16 @@ class OneIPPtpState:
     @property
     def grandmaster(self) -> bytes | None: ...
 
+@dataclass(frozen=True)
+class OneIPDownmix:
+    mode: OneIPDownmixMode | int = ...
+    level: OneIPDownmixLevel | int = ...
+    lfe: int = ...
+    state: int = ...
+    channels: int = ...
+    def is_valid(self) -> bool: ...
+    def written(self, write: OneIPDownmix) -> OneIPDownmix: ...
+
 @dataclass(frozen=True)
 class OneIPVlan:
     flags: OneIPVlanFlag = ...
@@ -1183,6 +1193,9 @@ class DeviceBase(ABC):
     async def confirm_unit_network(self) -> bool: ...
     @property
     @abstractmethod
+    def oneip_downmix(self) -> OneIPDownmix | None: ...
+    @property
+    @abstractmethod
     def oneip_ptp(self) -> OneIPPtpState | None: ...
     @property
     @abstractmethod
@@ -1321,6 +1334,8 @@ class DeviceBase(ABC):
     @abstractmethod
     async def set_oneip_ptp_messages(self, which: OneIPDeviceSetting, messages: OneIPPtpMessages) -> bool: ...
     @abstractmethod
+    async def set_oneip_downmix(self, downmix: OneIPDownmix) -> bool: ...
+    @abstractmethod
     async def set_oneip_vlan(self, vlan: OneIPVlan) -> bool: ...
     @abstractmethod
     async def set_audio_endpoint_locked(self, endpoint: int, locked: bool) -> bool: ...

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/Uid.py

@@ -14,6 +14,7 @@ class MxrDeviceUid:
 
     def __init__(self, value: object) -> None:
         self._value:bytes
+        self._str:str|None = None
 
         if value is None:
             self._value = bytes([ 0 for _ in range(16)])
@@ -44,11 +45,11 @@ class MxrDeviceUid:
 
     @property
     def value(self) -> str:
-        ''' value as human readble string '''
-        return ''.join('%02x'%i for i in reversed(self._value[0:4])) + '.' + \
-            ''.join('%02x'%i for i in reversed(self._value[4:8])) + '.' + \
-            ''.join('%02x'%i for i in reversed(self._value[8:12])) + '.' + \
-            ''.join('%02x'%i for i in reversed(self._value[12:16]))
+        ''' value as human readable string, formatted once, as every hash and
+        comparison reads it '''
+        if (self._str is None):
+            self._str = '.'.join(self._value[i:i + 4][::-1].hex() for i in (0, 4, 8, 12))
+        return self._str
 
     @property
     def empty(self) -> bool:
@@ -70,12 +71,14 @@ class MxrDeviceUid:
         return str(self)
 
     def __eq__(self, value: object) -> bool:
-        if isinstance(value, str) or isinstance(value, MxrDeviceUid):
-            return str(self) == str(value)
+        if isinstance(value, MxrDeviceUid):
+            return self.value == value.value
+        if isinstance(value, str):
+            return self.value == value
         return False
 
     def __hash__(self) -> int:
-        return hash(str(self))
+        return hash(self.value)
 
 class MxrBayUidOld:
     '''Legacy bay identifier using serial number and port name.'''

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/const.py

@@ -14,7 +14,7 @@ Default communication modes:
 """
 import os
 
-VERSION = '9.0.0'
+VERSION = '9.1.0'
 __version__ = VERSION
 
 MX_BCAST_UDP_PORT = 8811

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/proto/Constants.py

@@ -609,6 +609,25 @@ class OneIPPowerSaveLevel(IntEnum):
 	OFF     = 3
 	'''Everything but the network powers down.'''
 
+class OneIPDownmixMode(IntEnum):
+	'''When a OneIP output mixes 5.1 and 7.1 PCM down to stereo.'''
+	OFF    = 0
+	'''Never.'''
+	AUTO   = 1
+	'''When the display's EDID lists two PCM channels or fewer.'''
+	ALWAYS = 2
+	'''Always.'''
+
+class OneIPDownmixLevel(IntEnum):
+	'''How loud a OneIP output's stereo downmix is.'''
+	NORMALISED = 0
+	'''Scaled so the mix never clips.'''
+	UNSCALED   = 1
+	'''Unscaled, with dialogue at the level it has in stereo.'''
+
+ONEIP_DOWNMIX_LFE_MAX = 100
+"""The largest percent a OneIP output mixes its LFE channel in at."""
+
 class UnitPowerSave(IntFlag):
 	'''What a unit offers at one power save level.'''
 	SUPPORTED   = (1 << 0)

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/proto/Constants.pyi

@@ -236,6 +236,17 @@ class OneIPPowerSaveLevel(IntEnum):
     LOW: int
     OFF: int
 
+class OneIPDownmixMode(IntEnum):
+    OFF: int
+    AUTO: int
+    ALWAYS: int
+
+class OneIPDownmixLevel(IntEnum):
+    NORMALISED: int
+    UNSCALED: int
+
+ONEIP_DOWNMIX_LFE_MAX: int
+
 class UnitPowerSave(IntFlag):
     SUPPORTED: Incomplete
     INPUT_WAKE: Incomplete

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/proto/FrameV2IPDeviceConfiguration.py

@@ -14,9 +14,9 @@ from .FrameHeader import FrameHeader
 from ..Uid import MxrDeviceUid
 from ..Interface import (DeviceBase, DeviceRegistry, DeviceOneIPDetails, DeviceOneIPScalingSettings,
                          DeviceOneIPSink, OneIPAudioFormat, OneIPDeviceSettings, OneIPDscpConfig,
-                         OneIPPowerSaveSchedule, OneIPPtpMessages, OneIPPtpState, OneIPStreamSource,
-                         OneIPVlan, _wire_enum)
-from .Constants import (ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTINGS_PTP, OneIPPtpFlag, OneIPPtpLock, OneIPPtpMode, OneIPDeviceSetting, OneIPVideoProcessorFeature, OneIPVlanFlag, MXR_SCALING_FLAG_AUTO_SCALING,
+                         OneIPDownmix, OneIPPowerSaveSchedule, OneIPPtpMessages, OneIPPtpState,
+                         OneIPStreamSource, OneIPVlan, _wire_enum)
+from .Constants import (ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTINGS_PTP, OneIPDownmixLevel, OneIPDownmixMode, OneIPPtpFlag, OneIPPtpLock, OneIPPtpMode, OneIPDeviceSetting, OneIPVideoProcessorFeature, OneIPVlanFlag, MXR_SCALING_FLAG_AUTO_SCALING,
                         MXR_SCALING_FLAG_MODE_VALID,
                         MXR_SCALING_FLAG_OPTIONS_VALID, MXR_SCALING_FLAG_OPTIONS2_VALID,
                         MXR_SCALING_OPTIONS2_SETTINGS, MxrSignalType, oneip_dscp_value,
@@ -48,13 +48,19 @@ from .V2IPConfig import V2IPStreamSourceImpl, parse_v2ip_av_source
 #   216..224  the settings' own block: the PTP announce, sync and delay
 #             request intervals as i8, u8 announce timeout, u8 PTP DSCP,
 #             u8 SAP expiry in minutes, u16 SAP interval in seconds, and
-#             from a device with the stream TTL, u8 TTL and 7 reserved
+#             from a device with the stream TTL, u8 TTL, a reserved byte,
+#             u16 output rotation and u16 rotation step at 224..230, 2
+#             reserved
+#   232..248  from a device with the downmix: u32 second valid word, then
+#             the downmix's u8 mode, level, LFE percent, state and channels
+#             at 236..241, 7 reserved
 #
 # That block is the last of its frame, so it is read by its length: shorter
 # than 8 carries none of its values, and 8, which every device without the TTL
 # sends, carries all but the TTL. A write grows it to 16 only when it carries
-# the TTL, so the frames other writes send are unchanged for units that
-# predate it.
+# the TTL or the rotation, and to 32 only for the downmix, so the frames other
+# writes send are unchanged for units that predate them. A block too short to
+# hold the downmix's channels carries no bit of the second valid word.
 #
 # Each of those blocks was appended behind what came before it, leaving every
 # offset ahead of it where it was, so the length is what says whether one is
@@ -136,6 +142,14 @@ _STREAM_TTL_AT = 8
 _SINK_ROTATION_AT = 10
 _SINK_ROTATION_STEP_AT = 12
 _SETTINGS_BLOCK_LONG_SIZE = 16
+_VALID_EXT_OFFSET = SETTINGS_BLOCK_OFFSET + _SETTINGS_BLOCK_LONG_SIZE
+'''The second valid word of the settings, behind the block of their own.'''
+_DOWNMIX_OFFSET = _VALID_EXT_OFFSET + 4
+_DOWNMIX_SIZE = 5
+_WITH_DOWNMIX_SIZE = SETTINGS_BLOCK_OFFSET + 32
+'''The frame a downmix write sends: the settings block run on to 32 bytes.'''
+_SETTING_EXT_DOWNMIX = 1 << 0
+'''The bit of the second valid word that carries the downmix.'''
 
 def carries_settings_block(settings:OneIPDeviceSettings) -> bool:
     '''Whether settings carry a value only the block of their own can hold.'''
@@ -424,6 +438,28 @@ class FrameV2IPDeviceConfiguration(FrameBase):
             payload += own_settings_block(settings)
         return FrameBase.construct_base(target=target, mxr=mxr, opcode=_OPCODE, payload=bytes(payload))
 
+    @staticmethod
+    def construct_downmix(mxr:DeviceRegistry, target:Any, target_uid:MxrDeviceUid,
+                          downmix:OneIPDownmix) -> FrameBase|None:
+        '''Build the 0x3C write that changes how a device's output mixes down to
+        stereo and nothing else.
+
+        248 bytes: the frame construct_settings() builds, with a settings block
+        that carries no setting, zeroed to 232, then the second valid word
+        carrying the downmix and its mode, level and LFE percent at 236..239.
+        The state and channels at 239 and 240 are the device's to report, and
+        are left 0.
+        '''
+        frame = FrameV2IPDeviceConfiguration.construct_settings(
+            mxr=mxr, target=target, target_uid=target_uid, settings=OneIPDeviceSettings())
+        if (frame is None):
+            return None
+        payload = bytearray(frame.payload or b"")
+        payload += bytes(_WITH_DOWNMIX_SIZE - len(payload))
+        struct.pack_into('<IBBB', payload, _VALID_EXT_OFFSET, _SETTING_EXT_DOWNMIX,
+                         int(downmix.mode), int(downmix.level), downmix.lfe)
+        return FrameBase.construct_base(target=target, mxr=mxr, opcode=_OPCODE, payload=bytes(payload))
+
     @staticmethod
     def construct_vlan(mxr:DeviceRegistry, target:Any, target_uid:MxrDeviceUid,
                        vlan:OneIPVlan) -> FrameBase|None:
@@ -580,6 +616,28 @@ class FrameV2IPDeviceConfiguration(FrameBase):
                              port_state=port_state, lock=_wire_enum(OneIPPtpLock, lock),
                              clock_identity=clock, grandmaster_identity=grandmaster)
 
+    @property
+    def carries_downmix(self) -> bool:
+        '''Whether the frame is long enough to say whether it carries a downmix.'''
+        return (self.payload is not None) and (len(self.payload) >= (_DOWNMIX_OFFSET + _DOWNMIX_SIZE))
+
+    @cached_property
+    def downmix(self) -> OneIPDownmix|None:
+        '''The downmix the frame carries, None when it carries none: in a frame
+        too short to hold it, or without its bit of the second valid word.
+
+        From the subject itself, None reports that it has no downmix; from
+        another sender it is a write, of which only the mode, level and LFE
+        percent count.'''
+        if not self.carries_downmix:
+            return None
+        p = self.payload or b""
+        valid_ext, mode, level, lfe, state, channels = struct.unpack_from('<IBBBBB', p, _VALID_EXT_OFFSET)
+        if not (valid_ext & _SETTING_EXT_DOWNMIX):
+            return None
+        return OneIPDownmix(mode=_wire_enum(OneIPDownmixMode, mode), level=_wire_enum(OneIPDownmixLevel, level),
+                            lfe=lfe, state=state, channels=channels)
+
     def process(self) -> None:
         '''Update the cache of the device this configuration names, not of its sender.'''
         if ((dev := self.subject_device) is None):
@@ -595,6 +653,8 @@ class FrameV2IPDeviceConfiguration(FrameBase):
             dev.on_mxr_update(vlan)
         if ((ptp := self.ptp) is not None):
             dev.on_mxr_update(ptp)
+        if self.carries_downmix:
+            dev.on_mxr_update(self)
 
     def __str__(self) -> str:
         sink_str = f" sink=[{self.sink}]" if (self.sink is not None) else ""

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/proto/FrameV2IPDeviceConfiguration.pyi

@@ -1,6 +1,6 @@
-from ..Interface import DeviceBase as DeviceBase, DeviceOneIPDetails as DeviceOneIPDetails, DeviceOneIPScalingSettings as DeviceOneIPScalingSettings, DeviceOneIPSink as DeviceOneIPSink, DeviceRegistry as DeviceRegistry, OneIPAudioFormat as OneIPAudioFormat, OneIPDeviceSettings as OneIPDeviceSettings, OneIPDscpConfig as OneIPDscpConfig, OneIPPowerSaveSchedule as OneIPPowerSaveSchedule, OneIPPtpMessages as OneIPPtpMessages, OneIPPtpState as OneIPPtpState, OneIPStreamSource as OneIPStreamSource, OneIPVlan as OneIPVlan
+from ..Interface import DeviceBase as DeviceBase, DeviceOneIPDetails as DeviceOneIPDetails, DeviceOneIPScalingSettings as DeviceOneIPScalingSettings, DeviceOneIPSink as DeviceOneIPSink, DeviceRegistry as DeviceRegistry, OneIPAudioFormat as OneIPAudioFormat, OneIPDeviceSettings as OneIPDeviceSettings, OneIPDownmix as OneIPDownmix, OneIPDscpConfig as OneIPDscpConfig, OneIPPowerSaveSchedule as OneIPPowerSaveSchedule, OneIPPtpMessages as OneIPPtpMessages, OneIPPtpState as OneIPPtpState, OneIPStreamSource as OneIPStreamSource, OneIPVlan as OneIPVlan
 from ..Uid import MxrDeviceUid as MxrDeviceUid
-from .Constants import MXR_SCALING_FLAG_AUTO_SCALING as MXR_SCALING_FLAG_AUTO_SCALING, MXR_SCALING_FLAG_MODE_VALID as MXR_SCALING_FLAG_MODE_VALID, MXR_SCALING_FLAG_OPTIONS2_VALID as MXR_SCALING_FLAG_OPTIONS2_VALID, MXR_SCALING_FLAG_OPTIONS_VALID as MXR_SCALING_FLAG_OPTIONS_VALID, MXR_SCALING_OPTIONS2_SETTINGS as MXR_SCALING_OPTIONS2_SETTINGS, MxrSignalType as MxrSignalType, ONEIP_DEVICE_SETTINGS_BLOCK as ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTINGS_PTP as ONEIP_DEVICE_SETTINGS_PTP, OneIPDeviceSetting as OneIPDeviceSetting, OneIPPtpFlag as OneIPPtpFlag, OneIPPtpLock as OneIPPtpLock, OneIPPtpMode as OneIPPtpMode, OneIPVideoProcessorFeature as OneIPVideoProcessorFeature, OneIPVlanFlag as OneIPVlanFlag, oneip_dscp_value as oneip_dscp_value, oneip_rate_valid as oneip_rate_valid
+from .Constants import MXR_SCALING_FLAG_AUTO_SCALING as MXR_SCALING_FLAG_AUTO_SCALING, MXR_SCALING_FLAG_MODE_VALID as MXR_SCALING_FLAG_MODE_VALID, MXR_SCALING_FLAG_OPTIONS2_VALID as MXR_SCALING_FLAG_OPTIONS2_VALID, MXR_SCALING_FLAG_OPTIONS_VALID as MXR_SCALING_FLAG_OPTIONS_VALID, MXR_SCALING_OPTIONS2_SETTINGS as MXR_SCALING_OPTIONS2_SETTINGS, MxrSignalType as MxrSignalType, ONEIP_DEVICE_SETTINGS_BLOCK as ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTINGS_PTP as ONEIP_DEVICE_SETTINGS_PTP, OneIPDeviceSetting as OneIPDeviceSetting, OneIPDownmixLevel as OneIPDownmixLevel, OneIPDownmixMode as OneIPDownmixMode, OneIPPtpFlag as OneIPPtpFlag, OneIPPtpLock as OneIPPtpLock, OneIPPtpMode as OneIPPtpMode, OneIPVideoProcessorFeature as OneIPVideoProcessorFeature, OneIPVlanFlag as OneIPVlanFlag, oneip_dscp_value as oneip_dscp_value, oneip_rate_valid as oneip_rate_valid
 from .FrameBase import FrameBase as FrameBase
 from .FrameHeader import FrameHeader as FrameHeader
 from .V2IPConfig import V2IPStreamSourceImpl as V2IPStreamSourceImpl, parse_v2ip_av_source as parse_v2ip_av_source
@@ -48,6 +48,8 @@ class FrameV2IPDeviceConfiguration(FrameBase):
     @staticmethod
     def construct_settings(mxr: DeviceRegistry, target: Any, target_uid: MxrDeviceUid, settings: OneIPDeviceSettings) -> FrameBase | None: ...
     @staticmethod
+    def construct_downmix(mxr: DeviceRegistry, target: Any, target_uid: MxrDeviceUid, downmix: OneIPDownmix) -> FrameBase | None: ...
+    @staticmethod
     def construct_vlan(mxr: DeviceRegistry, target: Any, target_uid: MxrDeviceUid, vlan: OneIPVlan) -> FrameBase | None: ...
     @property
     def target_uid(self) -> MxrDeviceUid | None: ...
@@ -67,4 +69,8 @@ class FrameV2IPDeviceConfiguration(FrameBase):
     def vlan(self) -> OneIPVlan | None: ...
     @cached_property
     def ptp(self) -> OneIPPtpState | None: ...
+    @property
+    def carries_downmix(self) -> bool: ...
+    @cached_property
+    def downmix(self) -> OneIPDownmix | None: ...
     def process(self) -> None: ...

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/proto/FrameV2IPSources.py

@@ -26,9 +26,10 @@ class FrameV2IPSources(FrameBase):
         that list was when the frame was built. None when the payload is neither
         form this opcode carries.
 
-        A list that fits one frame is sent as bare records from the first byte.
-        A longer one is split into pages, each behind a header. That header is
-        not a whole record, so the remainder separates the two forms - and a
+        A list that fits one frame is sent as bare records from the first byte,
+        and a unit that knows no source sends it with none. A longer one is
+        split into pages, each behind a header. That header is not a whole
+        record, so the remainder separates the two forms - and a
         payload that is neither is refused rather than read from byte zero,
         which would shift every record by the header's width and report a full
         set of plausible addresses belonging to no bay.
@@ -37,9 +38,7 @@ class FrameV2IPSources(FrameBase):
         rather than a promise about the set, so it says whether this frame is
         the whole list and nothing more.
         '''
-        pl = self.payload
-        if (pl is None):
-            return None
+        pl = self.payload or b''
         rest = (len(pl) % _RECORD_SIZE)
         if (rest == 0):
             return (0, int(len(pl) / _RECORD_SIZE))

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/remote/Bay.py

@@ -175,9 +175,10 @@ class Bay(BayBase):
         device = self.device
         if (getattr(device, 'local_bay')(self.is_input) is not self):
             return []
+        owner = device.remote_id
         return [bay for dev in device.registry.remotes.values() if (dev is not device)
                 for bay in dev.bays.values()
-                if isinstance(bay, Bay) and (bay.mesh_owner is self)]
+                if isinstance(bay, Bay) and (bay._v2ip_uid == owner) and (bay.mesh_owner is self)]
 
     def register_callback(self, callback:Callable[[BayBase],None]) -> None:
          '''register a callback, called when the device state changed'''

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/remote/Device.py

@@ -12,6 +12,7 @@ from ..Interface import (
 	OneIPStreamSources,
 	OneIPPtpMessages,
 	OneIPPtpState,
+	OneIPDownmix,
 	UnitNetConfig,
 	UnitStatus,
 	AmpDolbySettings,
@@ -81,7 +82,7 @@ import time
 
 from ..Interface import DeviceBase, BayBase, DeviceRegistry
 from ..proto.FrameBase import FrameBase
-from ..proto.Constants import (MXR_PROTOCOL_VERSION_SLOW_HELLO, OSD_MESSAGE_TEXT_MAX, OsdMessageFlag, OsdMessagePriority, BayFeaturesMask, DeviceFeature, MxrSignalType, OneIPDeviceSetting, OneIPVideoProcessorFeature, OneIPVlanFlag,
+from ..proto.Constants import (MXR_PROTOCOL_VERSION_SLOW_HELLO, ONEIP_DOWNMIX_LFE_MAX, OSD_MESSAGE_TEXT_MAX, OsdMessageFlag, OsdMessagePriority, BayFeaturesMask, DeviceFeature, MxrSignalType, OneIPDeviceSetting, OneIPVideoProcessorFeature, OneIPVlanFlag,
                               OneIPTestPattern, OneIPToneMode,
                               MXR_SCALING_FLAG_AUTO_SCALING, MXR_SCALING_FLAG_MODE_VALID,
                               MXR_SCALING_FLAG_OPTIONS_VALID, ONEIP_DEVICE_SETTING_SWITCHES,
@@ -173,6 +174,7 @@ class Device(DeviceBase):
 		self._v2ip_settings:OneIPDeviceSettings|None = None
 		self._v2ip_vlan:OneIPVlan|None = None
 		self._v2ip_ptp:OneIPPtpState|None = None
+		self._v2ip_downmix:OneIPDownmix|None = None
 		self._unit_status:UnitStatus|None = None
 		self._v2ip_testcard:OneIPTestcard|None = None
 		self._v2ip_sink_sdp:OneIPSinkSdp|None = None
@@ -453,6 +455,11 @@ class Device(DeviceBase):
 	def oneip_ptp(self) -> OneIPPtpState|None:
 		return self._v2ip_ptp
 
+	@property
+	@override
+	def oneip_downmix(self) -> OneIPDownmix|None:
+		return self._v2ip_downmix
+
 	@property
 	@override
 	def unit_status(self) -> UnitStatus|None:
@@ -1050,6 +1057,8 @@ class Device(DeviceBase):
 			if (self._v2ip_ptp != ptp):
 				self._v2ip_ptp = ptp
 				self.call_callbacks()
+		elif isinstance(data, FrameV2IPDeviceConfiguration):
+			self._on_oneip_downmix(data.downmix, reported=data.target_self)
 		elif isinstance(data, OneIPTestcard):
 			if (self._v2ip_testcard != data):
 				self._v2ip_testcard = data
@@ -1606,6 +1615,47 @@ class Device(DeviceBase):
 			messages = dataclasses.replace(messages, sink_rotation_step=own.sink_rotation_step)
 		return self._send_v2ip_settings(OneIPDeviceSettings(valid=which, ptp_messages=messages))
 
+	def _on_oneip_downmix(self, downmix:OneIPDownmix|None, reported:bool) -> None:
+		'''Take the downmix a configuration carries as the device takes it: a
+		report replaces the one held, None included, and another sender's write
+		is applied only to a device that reports a downmix, and never to what
+		only the device reports.'''
+		if not reported:
+			if (downmix is None) or (self._v2ip_downmix is None):
+				return
+			downmix = self._v2ip_downmix.written(downmix)
+		if (self._v2ip_downmix != downmix):
+			self._v2ip_downmix = downmix
+			self.call_callbacks()
+
+	async def set_oneip_downmix(self, downmix:OneIPDownmix) -> bool:
+		'''Set how this OneIP device's output mixes 5.1 and 7.1 PCM down to
+		stereo: the mode, level and LFE percent of downmix, which the device
+		applies together. Its state and channels are the device's to report,
+		and are not sent.
+
+		Refused before anything is sent for a mode, level or LFE percent out of
+		range, and unless the device reports a downmix, which one whose output
+		cannot mix down never does. The new downmix is cached once the frame is
+		sent, and the device's next report replaces it.
+		'''
+		why = None
+		if not downmix.is_valid():
+			why = f'no such mode or level, or an LFE above {ONEIP_DOWNMIX_LFE_MAX} percent'
+		elif (self._v2ip_settings is None):
+			why = 'it has not reported its settings'
+		elif ((reported := self._v2ip_downmix) is None):
+			why = 'its output does not mix down'
+		if (why is not None):
+			_LOGGER.warning(f"not changing the downmix of {self}: {why}")
+			return False
+		frame = FrameV2IPDeviceConfiguration.construct_downmix(
+			mxr=self.registry, target=self, target_uid=self.remote_id, downmix=downmix)
+		if (frame is None) or (self.registry.transmit(frame.frame) != len(frame.frame)):
+			return False
+		self._on_oneip_downmix(reported.written(downmix), reported=True)
+		return True
+
 	async def set_oneip_vlan(self, vlan:OneIPVlan) -> bool:
 		'''Change this OneIP device's VLAN configuration.
 

{mx_remote-9.0.0 → mx_remote-9.1.0}/mx_remote/remote/Device.pyi

@@ -1,9 +1,9 @@
-from ..Interface import AmpDolbySettings as AmpDolbySettings, AudioChangeSource as AudioChangeSource, AudioEndpoint as AudioEndpoint, AudioEndpoints as AudioEndpoints, AudioLinks as AudioLinks, BayBase as BayBase, DeviceBase as DeviceBase, DeviceClock as DeviceClock, DeviceOneIPDetails as DeviceOneIPDetails, DeviceOneIPScalingSettings as DeviceOneIPScalingSettings, DeviceOneIPSink as DeviceOneIPSink, DeviceRegistry as DeviceRegistry, DeviceStatus as DeviceStatus, Multiviewer as Multiviewer, MxrCallbacks as MxrCallbacks, OneIPDeviceSettings as OneIPDeviceSettings, OneIPOutputMode as OneIPOutputMode, OneIPPowerSaveSchedule as OneIPPowerSaveSchedule, OneIPPrivacy as OneIPPrivacy, OneIPPtpMessages as OneIPPtpMessages, OneIPPtpState as OneIPPtpState, OneIPScalingSettings as OneIPScalingSettings, OneIPSinkSdp as OneIPSinkSdp, OneIPStreamSources as OneIPStreamSources, OneIPStreamSourcesList as OneIPStreamSourcesList, OneIPTestSync as OneIPTestSync, OneIPTestTone as OneIPTestTone, OneIPTestcard as OneIPTestcard, OneIPVlan as OneIPVlan, OsdMessage as OsdMessage, OsdSync as OsdSync, OsdSyncReport as OsdSyncReport, SystemTemperature as SystemTemperature, TimeZone as TimeZone, UnitNetConfig as UnitNetConfig, UnitStatus as UnitStatus
+from ..Interface import AmpDolbySettings as AmpDolbySettings, AudioChangeSource as AudioChangeSource, AudioEndpoint as AudioEndpoint, AudioEndpoints as AudioEndpoints, AudioLinks as AudioLinks, BayBase as BayBase, DeviceBase as DeviceBase, DeviceClock as DeviceClock, DeviceOneIPDetails as DeviceOneIPDetails, DeviceOneIPScalingSettings as DeviceOneIPScalingSettings, DeviceOneIPSink as DeviceOneIPSink, DeviceRegistry as DeviceRegistry, DeviceStatus as DeviceStatus, Multiviewer as Multiviewer, MxrCallbacks as MxrCallbacks, OneIPDeviceSettings as OneIPDeviceSettings, OneIPDownmix as OneIPDownmix, OneIPOutputMode as OneIPOutputMode, OneIPPowerSaveSchedule as OneIPPowerSaveSchedule, OneIPPrivacy as OneIPPrivacy, OneIPPtpMessages as OneIPPtpMessages, OneIPPtpState as OneIPPtpState, OneIPScalingSettings as OneIPScalingSettings, OneIPSinkSdp as OneIPSinkSdp, OneIPStreamSources as OneIPStreamSources, OneIPStreamSourcesList as OneIPStreamSourcesList, OneIPTestSync as OneIPTestSync, OneIPTestTone as OneIPTestTone, OneIPTestcard as OneIPTestcard, OneIPVlan as OneIPVlan, OsdMessage as OsdMessage, OsdSync as OsdSync, OsdSyncReport as OsdSyncReport, SystemTemperature as SystemTemperature, TimeZone as TimeZone, UnitNetConfig as UnitNetConfig, UnitStatus as UnitStatus
 from ..Uid import MxrDeviceUid as MxrDeviceUid
 from ..compat import override as override
 from ..const import MXR_CONFIG_TIMEOUT as MXR_CONFIG_TIMEOUT
 from ..proto.BayConfig import BayConfig as BayConfig
-from ..proto.Constants import BayFeaturesMask as BayFeaturesMask, DeviceFeature as DeviceFeature, MXR_PROTOCOL_VERSION_SLOW_HELLO as MXR_PROTOCOL_VERSION_SLOW_HELLO, MXR_SCALING_FLAG_AUTO_SCALING as MXR_SCALING_FLAG_AUTO_SCALING, MXR_SCALING_FLAG_MODE_VALID as MXR_SCALING_FLAG_MODE_VALID, MXR_SCALING_FLAG_OPTIONS_VALID as MXR_SCALING_FLAG_OPTIONS_VALID, MxrSignalType as MxrSignalType, ONEIP_DEVICE_SETTINGS_BLOCK as ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTING_SWITCHES as ONEIP_DEVICE_SETTING_SWITCHES, ONEIP_DSCP_MAX as ONEIP_DSCP_MAX, ONEIP_IR_PROFILE_MAX as ONEIP_IR_PROFILE_MAX, ONEIP_IR_PROFILE_NOT_SET as ONEIP_IR_PROFILE_NOT_SET, ONEIP_PTP_DOMAIN_MAX as ONEIP_PTP_DOMAIN_MAX, ONEIP_SDP_MAX as ONEIP_SDP_MAX, ONEIP_VLAN_PORT_SFP as ONEIP_VLAN_PORT_SFP, OSD_MESSAGE_TEXT_MAX as OSD_MESSAGE_TEXT_MAX, OneIPDeviceSetting as OneIPDeviceSetting, OneIPPowerSaveLevel as OneIPPowerSaveLevel, OneIPPtpFlag as OneIPPtpFlag, OneIPPtpMode as OneIPPtpMode, OneIPTestPattern as OneIPTestPattern, OneIPToneMode as OneIPToneMode, OneIPVideoProcessorFeature as OneIPVideoProcessorFeature, OneIPVlanFlag as OneIPVlanFlag, OsdMessageFlag as OsdMessageFlag, OsdMessagePriority as OsdMessagePriority, UnitCommandFlag as UnitCommandFlag, UnitCommandKind as UnitCommandKind
+from ..proto.Constants import BayFeaturesMask as BayFeaturesMask, DeviceFeature as DeviceFeature, MXR_PROTOCOL_VERSION_SLOW_HELLO as MXR_PROTOCOL_VERSION_SLOW_HELLO, MXR_SCALING_FLAG_AUTO_SCALING as MXR_SCALING_FLAG_AUTO_SCALING, MXR_SCALING_FLAG_MODE_VALID as MXR_SCALING_FLAG_MODE_VALID, MXR_SCALING_FLAG_OPTIONS_VALID as MXR_SCALING_FLAG_OPTIONS_VALID, MxrSignalType as MxrSignalType, ONEIP_DEVICE_SETTINGS_BLOCK as ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTING_SWITCHES as ONEIP_DEVICE_SETTING_SWITCHES, ONEIP_DOWNMIX_LFE_MAX as ONEIP_DOWNMIX_LFE_MAX, ONEIP_DSCP_MAX as ONEIP_DSCP_MAX, ONEIP_IR_PROFILE_MAX as ONEIP_IR_PROFILE_MAX, ONEIP_IR_PROFILE_NOT_SET as ONEIP_IR_PROFILE_NOT_SET, ONEIP_PTP_DOMAIN_MAX as ONEIP_PTP_DOMAIN_MAX, ONEIP_SDP_MAX as ONEIP_SDP_MAX, ONEIP_VLAN_PORT_SFP as ONEIP_VLAN_PORT_SFP, OSD_MESSAGE_TEXT_MAX as OSD_MESSAGE_TEXT_MAX, OneIPDeviceSetting as OneIPDeviceSetting, OneIPPowerSaveLevel as OneIPPowerSaveLevel, OneIPPtpFlag as OneIPPtpFlag, OneIPPtpMode as OneIPPtpMode, OneIPTestPattern as OneIPTestPattern, OneIPToneMode as OneIPToneMode, OneIPVideoProcessorFeature as OneIPVideoProcessorFeature, OneIPVlanFlag as OneIPVlanFlag, OsdMessageFlag as OsdMessageFlag, OsdMessagePriority as OsdMessagePriority, UnitCommandFlag as UnitCommandFlag, UnitCommandKind as UnitCommandKind
 from ..proto.FrameBase import FrameBase as FrameBase
 from ..proto.FrameFirmwareVersion import FirmwareType as FirmwareType, FirmwareVersion as FirmwareVersion
 from ..proto.FrameHello import FrameHello as FrameHello
@@ -111,6 +111,9 @@ class Device(DeviceBase):
     def oneip_ptp(self) -> OneIPPtpState | None: ...
     @property
     @override
+    def oneip_downmix(self) -> OneIPDownmix | None: ...
+    @property
+    @override
     def unit_status(self) -> UnitStatus | None: ...
     @property
     @override
@@ -269,6 +272,7 @@ class Device(DeviceBase):
     async def set_oneip_ptp_priority1(self, priority1: int) -> bool: ...
     async def set_oneip_power_save_level(self, level: OneIPPowerSaveLevel) -> bool: ...
     async def set_oneip_ptp_messages(self, which: OneIPDeviceSetting, messages: OneIPPtpMessages) -> bool: ...
+    async def set_oneip_downmix(self, downmix: OneIPDownmix) -> bool: ...
     async def set_oneip_vlan(self, vlan: OneIPVlan) -> bool: ...
     async def set_audio_endpoint_locked(self, endpoint: int, locked: bool) -> bool: ...
     async def request_oneip_testcard(self) -> bool: ...