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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 8.1.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-8.1.0 → mx_remote-9.1.0}/docs/api.md

@@ -85,6 +85,23 @@ place, backgrounds and logo images.
 .. autodata:: mx_remote.proto.Constants.OSD_SYNC_PERCENT_MAX
 ```
 
+## Overlay messages
+
+The message on a unit's output, which the overlay sync opcode carries too.
+
+```{eval-rst}
+.. autoclass:: mx_remote.OsdMessage
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.OsdMessageFlag
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.OsdMessagePriority
+   :members:
+
+.. autodata:: mx_remote.proto.Constants.OSD_MESSAGE_TEXT_MAX
+```
+
 ## Device identity
 
 ```{eval-rst}
@@ -151,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
@@ -180,6 +214,8 @@ state only the device reports.
 
 .. autodata:: mx_remote.proto.Constants.ONEIP_STREAM_TTL_DEFAULT
 
+.. autodata:: mx_remote.proto.Constants.ONEIP_SINK_ROTATION_MAX
+
 .. autodata:: mx_remote.proto.Constants.ONEIP_PTP_DOMAIN_MAX
 ```
 

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

@@ -288,10 +288,23 @@ same block, behind `SAP_EXPIRE` and `SAP_INTERVAL`, and are set the same way;
 `SAP_LISTEN` and `SAP_ANNOUNCE` are switches like the other on/off settings.
 A device with an encoder reports its streams' TTL there too, behind
 `STREAM_TTL`; a TTL of 0 is refused, as a device changes nothing for one.
+A device with an HDMI output reports the angle its output is turned by,
+clockwise, behind `SINK_ROTATION`, with the step its video processor turns by.
+It takes 0 or a multiple of that step up to `ONEIP_SINK_ROTATION_MAX`, so any
+other angle is refused before it is sent, and the step is never written.
+`set_all_oneip_device_settings` can only check the range; each device judges
+the step.
+
+```python
+m = settings.ptp_messages
+print(m.sink_rotation, m.sink_rotation_step)   # e.g. 0 and 90
+await device.set_oneip_ptp_messages(OneIPDeviceSetting.SINK_ROTATION,
+                                    OneIPPtpMessages(sink_rotation=180))
+```
 
 Only the values behind the bits named are sent. A DSCP above `ONEIP_DSCP_MAX` is
 refused, and not cached from another controller's write. A write carrying one of
-these runs on to 224 bytes, or 232 with the TTL; every other write keeps the 176
+these runs on to 224 bytes, or 232 with the TTL or the rotation; every other write keeps the 176
 every device knows.
 
 What the device's clock is actually doing is its PTP state, which only the
@@ -305,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
@@ -412,13 +450,34 @@ await mx.clear_osd_sync()          # stop answering for it
 Each unit asks for the settings it lacks and takes only those, so this client
 holds the content and answers until it is replaced or cleared, announcing
 itself meanwhile as the mesh's overlay sync manager: a unit waking from power
-save then takes this content rather than the controller's. The controller
-still answers a unit that asks for settings without naming whose sync they are
-from, as an older overlay module does, with its own sync, which replaces this
-client's on that unit. Logo images are
+save then takes this content rather than the controller's. Logo images are
 served over HTTP from this client, on `logo_port` or a free port. Content a unit
 would refuse is refused before anything is sent; see `send_osd_sync`.
 
+### Overlay messages
+
+A unit shows a message on its output, over the picture, until it restarts. The
+text is markup of at most `OSD_MESSAGE_TEXT_MAX` bytes with no control
+character, shown with a logo: 0 the built-in one, -1 none, 1 to 5 a slot. Its
+priority places it against the unit's own messages, such as Locate Device.
+
+```python
+from mx_remote.proto.Constants import OsdMessagePriority
+
+await sink.show_osd_message('Back at <b>3</b>', logo=-1, priority=OsdMessagePriority.TOP)
+await sink.request_osd_message()   # the unit answers with what it shows
+await sink.clear_osd_message()
+
+print(sink.osd_message)   # None until the unit has answered
+```
+
+A unit takes a message only from management, which this client announces
+itself as, and answers every write and request with the message it then has;
+`on_osd_message_changed` reports a change. The answer carries
+`OsdMessageFlag.REFUSED` when the unit did not take the write, as when its
+video processor has no message layer. A text, logo or priority a unit would
+refuse is refused before it is sent, as is a device that is not a OneIP output.
+
 ### Stream encryption
 
 A source unit from protocol 0x30 encrypts its video, audio and ancillary

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

@@ -6,7 +6,7 @@
 ######################################################
 
 from abc import ABC, abstractmethod
-from dataclasses import dataclass
+from dataclasses import dataclass, replace
 from datetime import datetime, timezone
 from enum import IntEnum
 import time
@@ -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:
     """
@@ -2215,8 +2255,8 @@ def _wire_enum(cls:Any, value:int) -> Any:
 @dataclass(frozen=True)
 class OneIPPtpMessages:
     """
-    How a OneIP device paces its PTP messages, its SAP timings and its streams'
-    TTL, which a frame carries in the same block. Each value is behind its own bit of
+    How a OneIP device paces its PTP messages, its SAP timings, its streams'
+    TTL and its output's rotation, which a frame carries in the same block. Each value is behind its own bit of
     OneIPDeviceSettings.valid, one of ONEIP_DEVICE_SETTINGS_BLOCK.
 
     Intervals are base-2 logarithms of seconds, so -3 is 125 ms and 1 is 2 s.
@@ -2241,6 +2281,19 @@ class OneIPPtpMessages:
     """The TTL of the device's streams, 1 to 255, behind STREAM_TTL. A device
     whose video processor cannot change it keeps the setting and sends
     ONEIP_STREAM_TTL_DEFAULT."""
+    sink_rotation: int = 0
+    """The degrees the device's HDMI output is turned by, clockwise, at most
+    ONEIP_SINK_ROTATION_MAX, behind SINK_ROTATION."""
+    sink_rotation_step: int = 0
+    """The step the output turns by: the device takes only an angle that is a
+    multiple of it, and 0 alone when it is 0. Only the device reports it,
+    behind the same bit."""
+
+    def takes_sink_rotation(self, degrees:int) -> bool:
+        """Whether a device reporting this step takes degrees as its output's
+        rotation."""
+        return (degrees == 0) or ((0 < degrees <= ONEIP_SINK_ROTATION_MAX) and (self.sink_rotation_step != 0)
+                                  and (degrees % self.sink_rotation_step == 0))
 
     def merge(self, other:'OneIPPtpMessages', which:OneIPDeviceSetting) -> 'OneIPPtpMessages':
         """The values behind the bits of which copied from other, the rest kept."""
@@ -2253,7 +2306,9 @@ class OneIPPtpMessages:
             dscp=(other if (S.PTP_DSCP in which) else self).dscp,
             sap_expire_min=(other if (S.SAP_EXPIRE in which) else self).sap_expire_min,
             sap_interval_s=(other if (S.SAP_INTERVAL in which) else self).sap_interval_s,
-            stream_ttl=(other if (S.STREAM_TTL in which) else self).stream_ttl)
+            stream_ttl=(other if (S.STREAM_TTL in which) else self).stream_ttl,
+            sink_rotation=(other if (S.SINK_ROTATION in which) else self).sink_rotation,
+            sink_rotation_step=(other if (S.SINK_ROTATION in which) else self).sink_rotation_step)
 
     def describe(self, valid:OneIPDeviceSetting) -> list[str]:
         """The values behind the bits of valid, one "name=value" each."""
@@ -2266,7 +2321,8 @@ class OneIPPtpMessages:
                     (S.PTP_DSCP, 'ptp_dscp', self.dscp),
                     (S.SAP_EXPIRE, 'sap_expire_min', self.sap_expire_min),
                     (S.SAP_INTERVAL, 'sap_interval_s', self.sap_interval_s),
-                    (S.STREAM_TTL, 'stream_ttl', self.stream_ttl))
+                    (S.STREAM_TTL, 'stream_ttl', self.stream_ttl),
+                    (S.SINK_ROTATION, 'sink_rotation', self.sink_rotation))
                 if (bit in valid)]
 
 @dataclass(frozen=True)
@@ -2317,8 +2373,7 @@ class OsdSyncRequest:
     missing: bytes
     """The settings it lacks, bit i standing for setting i, 16 bytes."""
     source: MxrDeviceUid
-    """Who sent the sync it asks about. Empty when it asks for a new sync, and
-    from a unit whose module does not name the source."""
+    """Who sent the sync it asks about. Empty when it asks for a new sync."""
 
     def is_missing(self, index:int) -> bool:
         """Whether the unit lacks setting index."""
@@ -2394,6 +2449,28 @@ class OsdSyncReport:
     reason: str
     """Why it failed or refused any."""
 
+@dataclass(frozen=True)
+class OsdMessage:
+    """
+    The message on a unit's output, as the unit last reported it. The unit
+    holds it until it restarts.
+    """
+    flags: OsdMessageFlag
+    """Whether a message is set and shown, whether the unit can show one, and
+    whether it refused the write it answers. Without SET the other fields are
+    empty."""
+    logo: int
+    """The logo shown with it: 0 the built-in logo, -1 none, 1 to 5 a slot."""
+    priority: OsdMessagePriority|int
+    """Where it stands against the unit's own messages."""
+    text: str
+    """Its markup."""
+
+    def __str__(self) -> str:
+        if (OsdMessageFlag.SET not in self.flags):
+            return f"none{' (refused)' if (OsdMessageFlag.REFUSED in self.flags) else ''}"
+        return f"'{self.text}' logo {self.logo} {self.flags!r}"
+
 @dataclass(frozen=True)
 class OsdSyncEntry:
     """One setting of an overlay sync this client sends."""
@@ -2767,16 +2844,25 @@ class OneIPDeviceSettings:
                               else previous._power_save_level),
             ptp_messages=previous._ptp_messages.merge(self._ptp_messages, valid))
 
-    def as_applied_to(self, reported:OneIPDeviceSetting) -> 'OneIPDeviceSettings':
+    def as_applied_to(self, reported:'OneIPDeviceSettings|OneIPDeviceSetting|None') -> 'OneIPDeviceSettings':
         """
-        This block limited to what a device takes from a write about it.
+        This block limited to what a device that reported reported takes from a
+        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, and never what only it can report about
-        itself.
+        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.
+
+        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.
         """
-        valid = (self._valid & reported) & ~ONEIP_DEVICE_SETTINGS_REPORTED_ONLY
+        if (reported is None):
+            reported = OneIPDeviceSettings()
+        elif not isinstance(reported, OneIPDeviceSettings):
+            reported = OneIPDeviceSettings(valid=OneIPDeviceSetting(reported))
+        own = reported._ptp_messages
+        valid = (self._valid & reported._valid) & ~ONEIP_DEVICE_SETTINGS_REPORTED_ONLY
         if not (0 <= self._ir_profile < ONEIP_IR_PROFILE_MAX):
             valid &= ~OneIPDeviceSetting.IR_PROFILE
         if not (ONEIP_IR_PROFILE_NOT_SET <= self._ir_profile_sink < ONEIP_IR_PROFILE_MAX):
@@ -2791,13 +2877,16 @@ class OneIPDeviceSettings:
             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,
                                   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,
                                   ptp_priority1=self._ptp_priority1,
                                   power_save_level=self._power_save_level,
-                                  ptp_messages=self._ptp_messages)
+                                  ptp_messages=replace(self._ptp_messages,
+                                                       sink_rotation_step=own.sink_rotation_step))
 
     def __eq__(self, other:Any) -> bool:
         if not isinstance(other, OneIPDeviceSettings):
@@ -3190,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:
@@ -3483,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'''
@@ -3505,6 +3606,26 @@ class DeviceBase(ABC):
     def osd_sync_report(self) -> OsdSyncReport|None:
         '''This unit's last report on taking an overlay sync, None until it has.'''
 
+    @property
+    @abstractmethod
+    def osd_message(self) -> OsdMessage|None:
+        '''The message on this unit's output, as it last reported it to this
+        client, None until it has. A unit reports it only when asked, or when
+        this client writes it.'''
+
+    @abstractmethod
+    async def request_osd_message(self) -> bool:
+        '''ask this unit for the message on its output'''
+
+    @abstractmethod
+    async def show_osd_message(self, text:str, logo:int=-1,
+                               priority:OsdMessagePriority=OsdMessagePriority.NORMAL) -> bool:
+        '''show a message on this unit's output, in place of any it has'''
+
+    @abstractmethod
+    async def clear_osd_message(self) -> bool:
+        '''take the message down from this unit's output'''
+
     @property
     @abstractmethod
     def oneip_sink_sdp(self) -> OneIPSinkSdp|None:
@@ -4120,6 +4241,11 @@ class MxrCallbacks:
         _LOGGER.debug(f"{dev} overlay sync {report.seq}: {report.state!r} {report.reason}")
         self.on_device_update(dev)
 
+    def on_osd_message_changed(self, dev:DeviceBase, message:OsdMessage) -> None:
+        ''' called when unit 'dev' reported something different about the message on its output '''
+        _LOGGER.debug(f"{dev} overlay message: {message}")
+        self.on_device_update(dev)
+
     def on_osd_sync_requested(self, dev:DeviceBase, request:OsdSyncRequest) -> None:
         ''' called when 'dev' asked for an overlay sync, or for settings of one '''
         pass

{mx_remote-8.1.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 = ...
@@ -787,6 +797,9 @@ class OneIPPtpMessages:
     sap_expire_min: int = ...
     sap_interval_s: int = ...
     stream_ttl: int = ...
+    sink_rotation: int = ...
+    sink_rotation_step: int = ...
+    def takes_sink_rotation(self, degrees: int) -> bool: ...
     def merge(self, other: OneIPPtpMessages, which: OneIPDeviceSetting) -> OneIPPtpMessages: ...
     def describe(self, valid: OneIPDeviceSetting) -> list[str]: ...
 
@@ -853,6 +866,13 @@ class OsdSyncReport:
     refused: int
     reason: str
 
+@dataclass(frozen=True)
+class OsdMessage:
+    flags: OsdMessageFlag
+    logo: int
+    priority: OsdMessagePriority | int
+    text: str
+
 @dataclass(frozen=True)
 class OsdSyncEntry:
     value: OsdSyncValue
@@ -968,7 +988,7 @@ class OneIPDeviceSettings:
     @property
     def ptp_messages(self) -> OneIPPtpMessages | None: ...
     def merge(self, previous: OneIPDeviceSettings | None) -> OneIPDeviceSettings: ...
-    def as_applied_to(self, reported: OneIPDeviceSetting) -> OneIPDeviceSettings: ...
+    def as_applied_to(self, reported: OneIPDeviceSettings | OneIPDeviceSetting | None) -> OneIPDeviceSettings: ...
     def __eq__(self, other: Any) -> bool: ...
     def __ne__(self, other: Any) -> bool: ...
 
@@ -1173,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
@@ -1311,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: ...
@@ -1324,6 +1349,15 @@ class DeviceBase(ABC):
     def osd_sync_report(self) -> OsdSyncReport | None: ...
     @property
     @abstractmethod
+    def osd_message(self) -> OsdMessage | None: ...
+    @abstractmethod
+    async def request_osd_message(self) -> bool: ...
+    @abstractmethod
+    async def show_osd_message(self, text: str, logo: int = -1, priority: OsdMessagePriority = ...) -> bool: ...
+    @abstractmethod
+    async def clear_osd_message(self) -> bool: ...
+    @property
+    @abstractmethod
     def oneip_sink_sdp(self) -> OneIPSinkSdp | None: ...
     @property
     @abstractmethod
@@ -1561,6 +1595,7 @@ class MxrCallbacks:
     def on_status_hdbt_connected_changed(self, bay: BayBase, val: bool) -> None: ...
     def on_osd_sync(self, dev: DeviceBase, sync: OsdSync) -> None: ...
     def on_osd_sync_report(self, dev: DeviceBase, report: OsdSyncReport) -> None: ...
+    def on_osd_message_changed(self, dev: DeviceBase, message: OsdMessage) -> None: ...
     def on_osd_sync_requested(self, dev: DeviceBase, request: OsdSyncRequest) -> None: ...
     def on_osd_sync_setting(self, dev: DeviceBase, setting: OsdSyncSetting) -> None: ...
     def on_bay_content_changed(self, bay: BayBase, content: BayContent) -> None: ...

{mx_remote-8.1.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-8.1.0 → mx_remote-9.1.0}/mx_remote/const.py

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

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

@@ -379,6 +379,9 @@ class OneIPDeviceSetting(IntFlag):
 	CLOUD              = (1 << 30)
 	'''Connects to the cloud service. A device that does not report it
 	connects regardless.'''
+	SINK_ROTATION      = (1 << 31)
+	'''The angle the device's HDMI output is turned by. Reported only by a
+	device with an HDMI output.'''
 
 ONEIP_DEVICE_SETTING_SWITCHES = OneIPDeviceSetting(0xFF) | OneIPDeviceSetting.AES67 \
 	| OneIPDeviceSetting.SAP_LISTEN | OneIPDeviceSetting.SAP_ANNOUNCE | OneIPDeviceSetting.POWER_SAVE_DISABLED \
@@ -398,14 +401,17 @@ ONEIP_DEVICE_SETTINGS_PTP_MESSAGES = OneIPDeviceSetting.PTP_ANNOUNCE | OneIPDevi
 """The PTP message settings."""
 
 ONEIP_DEVICE_SETTINGS_BLOCK = ONEIP_DEVICE_SETTINGS_PTP_MESSAGES | OneIPDeviceSetting.SAP_EXPIRE \
-	| OneIPDeviceSetting.SAP_INTERVAL | OneIPDeviceSetting.STREAM_TTL
+	| OneIPDeviceSetting.SAP_INTERVAL | OneIPDeviceSetting.STREAM_TTL | OneIPDeviceSetting.SINK_ROTATION
 """The settings whose values a frame carries in a block of their own behind the
-rest, OneIPPtpMessages: the PTP message settings, the two SAP values and the
-stream TTL."""
+rest, OneIPPtpMessages: the PTP message settings, the two SAP values, the
+stream TTL and the output's rotation."""
 
 ONEIP_STREAM_TTL_DEFAULT = 64
 """The TTL a OneIP device's streams carry until it is set."""
 
+ONEIP_SINK_ROTATION_MAX = 359
+"""The largest angle a OneIP device's HDMI output is turned by, in degrees."""
+
 class OneIPPtpMode(IntEnum):
 	'''How a OneIP device takes part in PTP.'''
 	OFF      = 0
@@ -434,6 +440,31 @@ class OsdSyncWhat(IntFlag):
 	LOGO_SLOTS  = (1 << 3)
 	'''The logo images in the four slots.'''
 
+class OsdMessageFlag(IntFlag):
+	'''What a unit says of the message on its output.'''
+	SET       = (1 << 0)
+	'''A message is set. In a write: show it, rather than take it down.'''
+	SHOWN     = (1 << 1)
+	'''The output shows it, rather than another message ahead of it.'''
+	SUPPORTED = (1 << 2)
+	'''The unit's video processor composes the message layer.'''
+	REFUSED   = (1 << 3)
+	'''The unit did not take the write it answers, and reports the message it
+	kept.'''
+
+class OsdMessagePriority(IntEnum):
+	'''Where a message stands against the unit's own messages: its upgrade,
+	Locate Device and encrypted source messages.'''
+	LOW    = 0
+	'''After them.'''
+	NORMAL = 1
+	'''Between them.'''
+	TOP    = 2
+	'''Before them.'''
+
+OSD_MESSAGE_TEXT_MAX = 255
+"""The longest message text a unit takes, in bytes."""
+
 class OsdSyncState(IntEnum):
 	'''How far a unit has got with taking an overlay sync.'''
 	TAKING   = 0
@@ -578,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)