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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 9.0.0
+Version: 9.2.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.2.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.2.0}/docs/oneip.md

@@ -225,27 +225,36 @@ goes out at 176 bytes: a receiver with the schedule ignores the settings of a
 shorter frame, and one whose settings end at the idle minutes takes it all the
 same.
 
-How far a device powers down is its power save level: reduced, low or off, each
-powering more down than the one before. Its unit status says which levels it
-supports and what wakes it at each.
+Power save is switched on or off. Switched on, a device powers down by itself
+to its power save level: reduced, low or off, each powering more down than the
+one before. The device picks the level itself, the one that saves the most
+while its input and display can still wake it, and reports it. Its unit status
+says which levels it supports and what wakes it at each.
 
 ```python
 from mx_remote import OneIPPowerSaveLevel, UnitPowerSave
 
-print(settings.power_save_level)
+print(settings.get(OneIPDeviceSetting.POWER_SAVE_DISABLED))         # False: switched on
+print(settings.power_save_level)                                    # the level it picked
 print(device.unit_status.power_save_level(OneIPPowerSaveLevel.LOW))  # e.g. SUPPORTED|INPUT_WAKE
 
-await device.set_oneip_power_save_level(OneIPPowerSaveLevel.LOW)
+await device.set_oneip_power_save(True)
+await mx.set_all_oneip_power_save(False)   # every OneIP device of the mesh
 ```
 
-A level this library does not name is refused before it is sent, and not cached
-from another controller's write.
+Switched off, `OneIPDeviceSetting.POWER_SAVE_DISABLED` is on: the device does
+not power down by itself, and a power save request still powers it down.
+Switching on is written as a mesh controller writes it, with that switch clear
+and the power save level at 0, so a device whose firmware still takes the level
+as its setting returns to its own default.
 
-`OneIPDeviceSetting.POWER_SAVE_DISABLED` is a switch that keeps a device from
-powering down by itself; a power save request still powers it down. A device
-that takes a power save level switches it off, so a level write, this client's
-or another sender's, clears it unless the same frame states it. Firmware
-without the bit never reports it, and the switch is refused there.
+`set_oneip_power_save_level()` writes a level, which switches power save on. A
+current device ignores the level; one whose firmware predates picking it takes
+it. A written level is never cached, from this client or another controller:
+`power_save_level` is what the device reports. A level write without the switch
+only clears `POWER_SAVE_DISABLED` on a device that reports it. A level this
+library does not name is refused before it is sent. Firmware without the switch
+never reports it, and switching is refused there.
 
 `OneIPDeviceSetting.CLOUD` is a switch for whether a device connects to the
 cloud service. A device that does not report it connects regardless, and the
@@ -318,6 +327,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.2.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:
     """
@@ -2672,6 +2712,16 @@ class OneIPDeviceSettings:
         self._power_save_level = int(power_save_level)
         self._ptp_messages = ptp_messages if (ptp_messages is not None) else OneIPPtpMessages()
 
+    @classmethod
+    def power_save_switch(cls, enabled:bool) -> 'OneIPDeviceSettings':
+        """The settings that switch a device's power save on or off. On is both
+        POWER_SAVE_DISABLED, clear, and POWER_SAVE_LEVEL, at 0."""
+        disabled = OneIPDeviceSetting.POWER_SAVE_DISABLED
+        if enabled:
+            return cls(valid=(disabled | OneIPDeviceSetting.POWER_SAVE_LEVEL),
+                       power_save_level=OneIPPowerSaveLevel.NONE)
+        return cls(valid=disabled, flags=disabled)
+
     @property
     def valid(self) -> OneIPDeviceSetting:
         """The settings reported so far."""
@@ -2751,8 +2801,9 @@ class OneIPDeviceSettings:
 
     @property
     def power_save_level(self) -> OneIPPowerSaveLevel|int|None:
-        """The level the device powers down to in power save, a raw int for one
-        this library does not name, None while it is not reported."""
+        """The level the device powers down to in power save, which it picks
+        itself, a raw int for one this library does not name, None while it is
+        not reported."""
         if (OneIPDeviceSetting.POWER_SAVE_LEVEL not in self._valid):
             return None
         return _wire_enum(OneIPPowerSaveLevel, self._power_save_level)
@@ -2772,18 +2823,14 @@ class OneIPDeviceSettings:
 
         Each bit in this block's ``valid`` replaces its own setting and leaves
         the others alone, so a write about one setting does not clear what was
-        known about the rest. The exception is POWER_SAVE_DISABLED: a device
-        takes a power save level as switching it off.
+        known about the rest.
         """
         if (previous is None):
             previous = OneIPDeviceSettings()
         valid = self._valid
-        flags = (previous._flags & ~valid) | (self._flags & valid)
-        if (OneIPDeviceSetting.POWER_SAVE_LEVEL in valid) and (OneIPDeviceSetting.POWER_SAVE_DISABLED not in valid):
-            flags &= ~OneIPDeviceSetting.POWER_SAVE_DISABLED
         return OneIPDeviceSettings(
             valid=(previous._valid | valid),
-            flags=flags,
+            flags=((previous._flags & ~valid) | (self._flags & valid)),
             ir_profiles=(self._ir_profiles if (OneIPDeviceSetting.IR_PROFILES in valid)
                          else previous._ir_profiles),
             ir_profile=(self._ir_profile if (OneIPDeviceSetting.IR_PROFILE in valid)
@@ -2810,9 +2857,11 @@ class OneIPDeviceSettings:
         write about it.
 
         A device applies a setting only if it has it, a profile, PTP mode, PTP
-        domain, power save level or PTP DSCP only within its range, a stream
-        TTL only when it is not 0, a rotation only by its own step, and never
-        what only it can report about itself. The step stays the device's.
+        domain or PTP DSCP only within its range, a stream TTL only when it is
+        not 0, a rotation only by its own step, and never what only it can
+        report about itself. The step stays the device's. It picks its power
+        save level itself, and takes a level it is written, without
+        POWER_SAVE_DISABLED, as switching power save on.
 
         reported may be only the bits the device reported, which says nothing
         of its step, so a rotation other than 0 is then left out.
@@ -2831,15 +2880,20 @@ class OneIPDeviceSettings:
             valid &= ~OneIPDeviceSetting.PTP_MODE
         if (self._ptp_domain > ONEIP_PTP_DOMAIN_MAX):
             valid &= ~OneIPDeviceSetting.PTP_DOMAIN
-        if (self._power_save_level > OneIPPowerSaveLevel.OFF):
-            valid &= ~OneIPDeviceSetting.POWER_SAVE_LEVEL
         if (self._ptp_messages.dscp > ONEIP_DSCP_MAX):
             valid &= ~OneIPDeviceSetting.PTP_DSCP
         if (self._ptp_messages.stream_ttl == 0):
             valid &= ~OneIPDeviceSetting.STREAM_TTL
         if not own.takes_sink_rotation(self._ptp_messages.sink_rotation):
             valid &= ~OneIPDeviceSetting.SINK_ROTATION
-        return OneIPDeviceSettings(valid=valid, flags=self._flags, ir_profiles=self._ir_profiles,
+        flags = self._flags
+        if (OneIPDeviceSetting.POWER_SAVE_LEVEL in valid):
+            valid &= ~OneIPDeviceSetting.POWER_SAVE_LEVEL
+            if (OneIPDeviceSetting.POWER_SAVE_DISABLED not in valid) \
+                    and (OneIPDeviceSetting.POWER_SAVE_DISABLED in reported._valid):
+                valid |= OneIPDeviceSetting.POWER_SAVE_DISABLED
+                flags &= ~OneIPDeviceSetting.POWER_SAVE_DISABLED
+        return OneIPDeviceSettings(valid=valid, flags=flags, ir_profiles=self._ir_profiles,
                                   ir_profile=self._ir_profile, ir_profile_sink=self._ir_profile_sink,
                                   auto_power_save=self._auto_power_save, power_save=self._power_save,
                                   ptp_mode=self._ptp_mode, ptp_domain=self._ptp_domain,
@@ -3239,6 +3293,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:
@@ -3524,14 +3586,22 @@ class DeviceBase(ABC):
     async def set_oneip_ptp_priority1(self, priority1:int) -> bool:
         '''set the priority1 the device announces as a PTP grandmaster'''
 
+    @abstractmethod
+    async def set_oneip_power_save(self, enabled:bool) -> bool:
+        '''switch power save on, so the device powers down by itself to the level it picks, or off'''
+
     @abstractmethod
     async def set_oneip_power_save_level(self, level:OneIPPowerSaveLevel) -> bool:
-        '''set the level the device powers down to in power save'''
+        '''write the level the device powers down to in power save, which switches power save on'''
 
     @abstractmethod
     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.2.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 = ...
@@ -952,6 +962,8 @@ class OneIPTestcard:
 
 class OneIPDeviceSettings:
     def __init__(self, valid: OneIPDeviceSetting = ..., flags: OneIPDeviceSetting = ..., ir_profiles: int = 0, ir_profile: int = 0, ir_profile_sink: int = 0, auto_power_save: int = 0, power_save: OneIPPowerSaveSchedule | None = None, ptp_mode: OneIPPtpMode | int = ..., ptp_domain: int = 0, ptp_priority1: int = 0, power_save_level: OneIPPowerSaveLevel | int = ..., ptp_messages: OneIPPtpMessages | None = None) -> None: ...
+    @classmethod
+    def power_save_switch(cls, enabled: bool) -> OneIPDeviceSettings: ...
     @property
     def valid(self) -> OneIPDeviceSetting: ...
     @property
@@ -1183,6 +1195,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
@@ -1317,10 +1332,14 @@ class DeviceBase(ABC):
     @abstractmethod
     async def set_oneip_ptp_priority1(self, priority1: int) -> bool: ...
     @abstractmethod
+    async def set_oneip_power_save(self, enabled: bool) -> bool: ...
+    @abstractmethod
     async def set_oneip_power_save_level(self, level: OneIPPowerSaveLevel) -> bool: ...
     @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.2.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.2.0}/mx_remote/const.py

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

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

@@ -349,7 +349,11 @@ class OneIPDeviceSetting(IntFlag):
 	AES67              = (1 << 17)
 	'''Sends the source's audio as an AES67 flow, where the source allows.'''
 	POWER_SAVE_LEVEL   = (1 << 18)
-	'''The power save level the device powers down to.'''
+	'''The level the device powers down to in power save. A device picks it
+	itself: the level that saves the most while its input and display can
+	still wake it. Written without POWER_SAVE_DISABLED, it switches power save
+	on, and the level written is ignored, except by a device whose firmware
+	predates picking it, which takes the level as its setting.'''
 	PTP_ANNOUNCE       = (1 << 19)
 	'''The interval between the device's PTP announce messages.'''
 	PTP_SYNC           = (1 << 20)
@@ -609,6 +613,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.2.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.2.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.2.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.2.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.2.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'''