rocket-welder-sdk 1.1.31__py3-none-any.whl → 1.1.33__py3-none-any.whl

rocket_welder_sdk/transport/unix_socket_transport.py

@@ -0,0 +1,339 @@
+"""Unix Domain Socket transport with length-prefix framing.
+
+Frame format: [Length: 4 bytes LE][Frame Data: N bytes]
+Unix Domain Sockets provide high-performance IPC on Linux/macOS.
+"""
+
+import asyncio
+import contextlib
+import os
+import socket
+import struct
+from typing import Optional
+
+from .frame_sink import IFrameSink
+from .frame_source import IFrameSource
+
+
+class UnixSocketFrameSink(IFrameSink):
+    """
+    Frame sink that writes to a Unix Domain Socket with length-prefix framing.
+
+    Each frame is prefixed with a 4-byte little-endian length header.
+    """
+
+    def __init__(self, sock: socket.socket, leave_open: bool = False):
+        """
+        Create a Unix socket frame sink.
+
+        Args:
+            sock: Connected Unix domain socket
+            leave_open: If True, doesn't close socket on close
+        """
+        if sock.family != socket.AF_UNIX:
+            raise ValueError("Socket must be a Unix domain socket")
+
+        self._socket = sock
+        self._leave_open = leave_open
+        self._closed = False
+
+    @classmethod
+    def connect(cls, socket_path: str) -> "UnixSocketFrameSink":
+        """
+        Connect to a Unix socket path and create a frame sink.
+
+        Args:
+            socket_path: Path to Unix socket file
+
+        Returns:
+            Connected frame sink
+        """
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        sock.connect(socket_path)
+        return cls(sock, leave_open=False)
+
+    @classmethod
+    async def connect_async(cls, socket_path: str) -> "UnixSocketFrameSink":
+        """
+        Connect to a Unix socket path asynchronously and create a frame sink.
+
+        Args:
+            socket_path: Path to Unix socket file
+
+        Returns:
+            Connected frame sink
+        """
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        sock.setblocking(False)
+        loop = asyncio.get_event_loop()
+        await loop.sock_connect(sock, socket_path)
+        return cls(sock, leave_open=False)
+
+    def write_frame(self, frame_data: bytes) -> None:
+        """Write frame with 4-byte length prefix to Unix socket."""
+        if self._closed:
+            raise ValueError("Cannot write to closed sink")
+
+        # Write 4-byte length prefix (little-endian)
+        length_prefix = struct.pack("<I", len(frame_data))
+        self._socket.sendall(length_prefix)
+
+        # Write frame data
+        self._socket.sendall(frame_data)
+
+    async def write_frame_async(self, frame_data: bytes) -> None:
+        """Write frame asynchronously."""
+        if self._closed:
+            raise ValueError("Cannot write to closed sink")
+
+        loop = asyncio.get_event_loop()
+
+        # Write 4-byte length prefix (little-endian)
+        length_prefix = struct.pack("<I", len(frame_data))
+        await loop.sock_sendall(self._socket, length_prefix)
+
+        # Write frame data
+        await loop.sock_sendall(self._socket, frame_data)
+
+    def flush(self) -> None:
+        """Flush is a no-op for Unix sockets (data sent immediately)."""
+        pass
+
+    async def flush_async(self) -> None:
+        """Flush asynchronously is a no-op for Unix sockets."""
+        pass
+
+    def close(self) -> None:
+        """Close the Unix socket sink."""
+        if self._closed:
+            return
+        self._closed = True
+        if not self._leave_open:
+            with contextlib.suppress(OSError):
+                self._socket.shutdown(socket.SHUT_WR)
+            self._socket.close()
+
+    async def close_async(self) -> None:
+        """Close the Unix socket sink asynchronously."""
+        self.close()
+
+
+class UnixSocketFrameSource(IFrameSource):
+    """
+    Frame source that reads from a Unix Domain Socket with length-prefix framing.
+
+    Each frame is prefixed with a 4-byte little-endian length header.
+    """
+
+    # Maximum frame size (100 MB)
+    MAX_FRAME_SIZE = 100 * 1024 * 1024
+
+    def __init__(self, sock: socket.socket, leave_open: bool = False):
+        """
+        Create a Unix socket frame source.
+
+        Args:
+            sock: Connected Unix domain socket
+            leave_open: If True, doesn't close socket on close
+        """
+        if sock.family != socket.AF_UNIX:
+            raise ValueError("Socket must be a Unix domain socket")
+
+        self._socket = sock
+        self._leave_open = leave_open
+        self._closed = False
+        self._end_of_stream = False
+
+    @classmethod
+    def connect(cls, socket_path: str) -> "UnixSocketFrameSource":
+        """
+        Connect to a Unix socket path and create a frame source.
+
+        Args:
+            socket_path: Path to Unix socket file
+
+        Returns:
+            Connected frame source
+        """
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        sock.connect(socket_path)
+        return cls(sock, leave_open=False)
+
+    @classmethod
+    async def connect_async(cls, socket_path: str) -> "UnixSocketFrameSource":
+        """
+        Connect to a Unix socket path asynchronously and create a frame source.
+
+        Args:
+            socket_path: Path to Unix socket file
+
+        Returns:
+            Connected frame source
+        """
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        sock.setblocking(False)
+        loop = asyncio.get_event_loop()
+        await loop.sock_connect(sock, socket_path)
+        return cls(sock, leave_open=False)
+
+    @property
+    def has_more_frames(self) -> bool:
+        """Check if more frames available."""
+        return not self._closed and not self._end_of_stream
+
+    def _recv_exactly(self, n: int) -> Optional[bytes]:
+        """Receive exactly n bytes from socket."""
+        data = b""
+        while len(data) < n:
+            chunk = self._socket.recv(n - len(data))
+            if not chunk:
+                return data if data else None
+            data += chunk
+        return data
+
+    async def _recv_exactly_async(self, n: int) -> Optional[bytes]:
+        """Receive exactly n bytes from socket asynchronously."""
+        loop = asyncio.get_event_loop()
+        data = b""
+        while len(data) < n:
+            chunk = await loop.sock_recv(self._socket, n - len(data))
+            if not chunk:
+                return data if data else None
+            data += chunk
+        return data
+
+    def read_frame(self) -> Optional[bytes]:
+        """Read frame with 4-byte length prefix from Unix socket."""
+        if self._closed or self._end_of_stream:
+            return None
+
+        # Read 4-byte length prefix
+        length_data = self._recv_exactly(4)
+        if length_data is None or len(length_data) < 4:
+            self._end_of_stream = True
+            return None
+
+        frame_length = struct.unpack("<I", length_data)[0]
+
+        if frame_length == 0:
+            return b""
+
+        if frame_length > self.MAX_FRAME_SIZE:
+            raise ValueError(f"Frame length {frame_length} exceeds maximum {self.MAX_FRAME_SIZE}")
+
+        # Read frame data
+        frame_data = self._recv_exactly(frame_length)
+        if frame_data is None or len(frame_data) < frame_length:
+            self._end_of_stream = True
+            raise ValueError(
+                f"Incomplete frame data: expected {frame_length}, "
+                f"got {len(frame_data) if frame_data else 0}"
+            )
+
+        return frame_data
+
+    async def read_frame_async(self) -> Optional[bytes]:
+        """Read frame asynchronously."""
+        if self._closed or self._end_of_stream:
+            return None
+
+        # Read 4-byte length prefix
+        length_data = await self._recv_exactly_async(4)
+        if length_data is None or len(length_data) < 4:
+            self._end_of_stream = True
+            return None
+
+        frame_length = struct.unpack("<I", length_data)[0]
+
+        if frame_length == 0:
+            return b""
+
+        if frame_length > self.MAX_FRAME_SIZE:
+            raise ValueError(f"Frame length {frame_length} exceeds maximum {self.MAX_FRAME_SIZE}")
+
+        # Read frame data
+        frame_data = await self._recv_exactly_async(frame_length)
+        if frame_data is None or len(frame_data) < frame_length:
+            self._end_of_stream = True
+            raise ValueError(
+                f"Incomplete frame data: expected {frame_length}, "
+                f"got {len(frame_data) if frame_data else 0}"
+            )
+
+        return frame_data
+
+    def close(self) -> None:
+        """Close the Unix socket source."""
+        if self._closed:
+            return
+        self._closed = True
+        if not self._leave_open:
+            with contextlib.suppress(OSError):
+                self._socket.shutdown(socket.SHUT_RD)
+            self._socket.close()
+
+    async def close_async(self) -> None:
+        """Close the Unix socket source asynchronously."""
+        self.close()
+
+
+class UnixSocketServer:
+    """
+    Helper class to create a Unix socket server that accepts connections.
+    """
+
+    def __init__(self, socket_path: str):
+        """
+        Create a Unix socket server.
+
+        Args:
+            socket_path: Path to Unix socket file
+        """
+        self._socket_path = socket_path
+        self._socket: Optional[socket.socket] = None
+
+    def start(self) -> None:
+        """Start listening on the Unix socket."""
+        # Remove existing socket file if present
+        if os.path.exists(self._socket_path):
+            os.unlink(self._socket_path)
+
+        self._socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        self._socket.bind(self._socket_path)
+        self._socket.listen(1)
+
+    def accept(self) -> socket.socket:
+        """Accept a connection (blocking)."""
+        if self._socket is None:
+            raise ValueError("Server not started")
+
+        client, _ = self._socket.accept()
+        return client
+
+    async def accept_async(self) -> socket.socket:
+        """Accept a connection asynchronously."""
+        if self._socket is None:
+            raise ValueError("Server not started")
+
+        loop = asyncio.get_event_loop()
+        self._socket.setblocking(False)
+        client, _ = await loop.sock_accept(self._socket)
+        return client
+
+    def stop(self) -> None:
+        """Stop the server and clean up the socket file."""
+        if self._socket:
+            self._socket.close()
+            self._socket = None
+
+        if os.path.exists(self._socket_path):
+            os.unlink(self._socket_path)
+
+    def __enter__(self) -> "UnixSocketServer":
+        """Context manager entry."""
+        self.start()
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        """Context manager exit."""
+        self.stop()

{rocket_welder_sdk-1.1.31.dist-info → rocket_welder_sdk-1.1.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.31
+Version: 1.1.33
 Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
 Home-page: https://github.com/modelingevolution/rocket-welder-sdk
 Author: ModelingEvolution
@@ -31,6 +31,9 @@ Requires-Dist: opencv-python>=4.5.0
 Requires-Dist: zerobuffer-ipc>=1.1.17
 Requires-Dist: pydantic>=2.5.0
 Requires-Dist: py-micro-plumberd>=0.1.8
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: nng
+Requires-Dist: pynng>=0.7.2; extra == "nng"
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: pytest-cov>=4.0; extra == "dev"
@@ -39,6 +42,7 @@ Requires-Dist: black>=22.0; extra == "dev"
 Requires-Dist: mypy>=1.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: pynng>=0.7.2; extra == "dev"
 Dynamic: author
 Dynamic: home-page
 Dynamic: requires-python
@@ -169,7 +173,7 @@ Start by testing your container locally before deploying to Neuron:
 
 ```bash
 # Build your container
-docker build -t my-ai-app:v1 -f examples/python/Dockerfile .
+docker build -t my-ai-app:v1 -f python/examples/Dockerfile .
 
 # Test with a video file
 docker run --rm \
@@ -223,6 +227,15 @@ docker run --rm \
     my-ai-app:v1
 ```
 
+You can also see preview in your terminal. 
+```bash
+docker run --rm \
+    -e CONNECTION_STRING="mjpeg+tcp://<neuron-ip>:<tcp-server-sink-port>?preview=true" \
+    -e DISPLAY=$DISPLAY \
+    -v /tmp/.X11-unix:/tmp/.X11-unix \
+    --network host my-ai-app:v1
+```
+
 This allows you to:
 - Test your AI processing with real camera feeds
 - Debug frame processing logic

rocket_welder_sdk-1.1.33.dist-info/RECORD

@@ -0,0 +1,37 @@
+rocket_welder_sdk/__init__.py,sha256=nxaj88kgewtAbyTw7wLGvgjIkY9VOYUuBVtzw1MMW7c,2033
+rocket_welder_sdk/bytes_size.py,sha256=Myl29-wyWCIYdbMmgaxXebT8Dz8_Fwcr3fnfaNW81P0,7463
+rocket_welder_sdk/connection_string.py,sha256=NIC6OiOXF-DeBFCWzgMFOWsenrSS45hY81j_HLMSpgo,9974
+rocket_welder_sdk/controllers.py,sha256=X7D7OyiuHhGTrmrSNG2Tljsy1_4PGRObytB4dLyvRrg,32600
+rocket_welder_sdk/frame_metadata.py,sha256=8AbCgSQ17QeCHSzdQiSN0E1KxE5rrNpOlTYZ2em8kes,3903
+rocket_welder_sdk/gst_metadata.py,sha256=jEQvZX4BdR6OR3lqp12PV-HEXZhcxfiS010diA2CbMM,14213
+rocket_welder_sdk/keypoints_protocol.py,sha256=NKiSPrevWG4_RrD6jtFxPjwftlaPWe1CqoFVKRMwp4k,21858
+rocket_welder_sdk/opencv_controller.py,sha256=MDM6_yFBB9BaMa5jnZRqw7xZZB-WuLr7EPrrfHQ2DK4,9905
+rocket_welder_sdk/periodic_timer.py,sha256=hnObybmrnf3J47QrNKJhYAytLKwria016123NvPRfQ0,9369
+rocket_welder_sdk/py.typed,sha256=0cXFZXmes4Y-vnl4lO3HtyyyWaFNw85B7tJdFeCtHDc,67
+rocket_welder_sdk/rocket_welder_client.py,sha256=mguSN8E4nV8JsNOJvhHFNv7yIz7Ppb25_-9m68d6iD4,15244
+rocket_welder_sdk/segmentation_result.py,sha256=q3n8m1sooPcattfXisL9em5gZKbEZ1ueGqeXfOrdaHY,13417
+rocket_welder_sdk/external_controls/__init__.py,sha256=ldOLGhLLS5BQL8m4VKFYV0SvsNNlV2tghlc7rkqadU8,699
+rocket_welder_sdk/external_controls/contracts.py,sha256=3DU6pdpteN50gF2fsS7C2279dGjDa0tZLrLntkBa2LM,2607
+rocket_welder_sdk/external_controls/contracts_old.py,sha256=XWriuXJZu5caTSS0bcTIOZcKnj-IRCm96voA4gqLBfU,2980
+rocket_welder_sdk/high_level/__init__.py,sha256=5oTCBL2qMGonCytHDckmX1b1U97-7Xb8Bg9Z70nR7fc,1759
+rocket_welder_sdk/high_level/connection_strings.py,sha256=4undnkbWZ837vY-o6ybIj1827F2VlUbCJX4m3Filz-s,10469
+rocket_welder_sdk/high_level/data_context.py,sha256=Pmwsl9MgBfKA9BqmBJmAVRvnaqPdjnq2rZEA_pzzYsw,4585
+rocket_welder_sdk/high_level/schema.py,sha256=UlefNAV2UL9eO_Th2q19a7tf_eoaeLE92fYZ5LNq7-M,4849
+rocket_welder_sdk/high_level/transport_protocol.py,sha256=lvLVHikW_MNZhXqaXlyXscT68OklyMbGs8DnDEMCtgE,4515
+rocket_welder_sdk/transport/__init__.py,sha256=L-wl0YWhVbSrof94Zt4g7SIM-wTPzujdVOsEfJHiJT4,978
+rocket_welder_sdk/transport/frame_sink.py,sha256=16dUefZF1QJv62Ig0ezPR6nEho_7A3WJu4M9_PPMqJM,2164
+rocket_welder_sdk/transport/frame_source.py,sha256=G1rBAQS1AgOOdtASB0_CYon8g20hUGXpP2exCp5hlhk,2169
+rocket_welder_sdk/transport/nng_transport.py,sha256=o-qgcmHCGnwtdPe-mwwrC-a9H0rgS-VdH2QvU-6kFlI,5838
+rocket_welder_sdk/transport/stream_transport.py,sha256=FhxFlZT-CTo6aPq6VclM1A_ecqfeHcwR4Ty1vmlt3W0,5886
+rocket_welder_sdk/transport/tcp_transport.py,sha256=Tui6nKgu50C1KV_UDANQKgVK3M52XN7zrkZTcWIpGmY,4745
+rocket_welder_sdk/transport/unix_socket_transport.py,sha256=6N_V5nsoxlI5-oR1watCxU-jWVbXw4OQGhcTvCkKZh4,10612
+rocket_welder_sdk/ui/__init__.py,sha256=5-fCkv3vG0VVVZkselrifkMmx8d51EJp3nNT9mt4JK4,886
+rocket_welder_sdk/ui/controls.py,sha256=cRBxdUDWMOYlCxtw1PV11fTlte6qLxSfCGpr9bQiLcE,11162
+rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE,8934592
+rocket_welder_sdk/ui/ui_events_projection.py,sha256=siiNhjLEBOPfTKw1ZhOPGkwIN5rLDH7V9VCZTNrhEtQ,7836
+rocket_welder_sdk/ui/ui_service.py,sha256=uRdpyJGoCQmtOli_HKSrxLwhZYG-XRuHIYdkmFz1zNk,12026
+rocket_welder_sdk/ui/value_types.py,sha256=f7OA_9zgXEDPoITc8v8SfAR23I4XeFhE3E2_GcAbR6k,1616
+rocket_welder_sdk-1.1.33.dist-info/METADATA,sha256=WK6edMkZs55WIe1AOJjECFfHB2SmTMS31IpschstdpE,24847
+rocket_welder_sdk-1.1.33.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rocket_welder_sdk-1.1.33.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
+rocket_welder_sdk-1.1.33.dist-info/RECORD,,

rocket_welder_sdk-1.1.31.dist-info/RECORD

@@ -1,22 +0,0 @@
-rocket_welder_sdk/__init__.py,sha256=tL2NPprMSh19MDUtLsk1YByB0YTLp6nNAkWv2fxNKuM,2001
-rocket_welder_sdk/bytes_size.py,sha256=Myl29-wyWCIYdbMmgaxXebT8Dz8_Fwcr3fnfaNW81P0,7463
-rocket_welder_sdk/connection_string.py,sha256=NIC6OiOXF-DeBFCWzgMFOWsenrSS45hY81j_HLMSpgo,9974
-rocket_welder_sdk/controllers.py,sha256=bp4MmTSoxMKrWYTpcO6aUXqI8jpZDBEhSKuCLinVZVE,30971
-rocket_welder_sdk/gst_metadata.py,sha256=jEQvZX4BdR6OR3lqp12PV-HEXZhcxfiS010diA2CbMM,14213
-rocket_welder_sdk/opencv_controller.py,sha256=MDM6_yFBB9BaMa5jnZRqw7xZZB-WuLr7EPrrfHQ2DK4,9905
-rocket_welder_sdk/periodic_timer.py,sha256=hnObybmrnf3J47QrNKJhYAytLKwria016123NvPRfQ0,9369
-rocket_welder_sdk/py.typed,sha256=0cXFZXmes4Y-vnl4lO3HtyyyWaFNw85B7tJdFeCtHDc,67
-rocket_welder_sdk/rocket_welder_client.py,sha256=u2XYY1RVyP2rKu2zUZpObKVa4nlTKDUNI0YlFXt8ePE,14401
-rocket_welder_sdk/external_controls/__init__.py,sha256=ldOLGhLLS5BQL8m4VKFYV0SvsNNlV2tghlc7rkqadU8,699
-rocket_welder_sdk/external_controls/contracts.py,sha256=3DU6pdpteN50gF2fsS7C2279dGjDa0tZLrLntkBa2LM,2607
-rocket_welder_sdk/external_controls/contracts_old.py,sha256=XWriuXJZu5caTSS0bcTIOZcKnj-IRCm96voA4gqLBfU,2980
-rocket_welder_sdk/ui/__init__.py,sha256=5-fCkv3vG0VVVZkselrifkMmx8d51EJp3nNT9mt4JK4,886
-rocket_welder_sdk/ui/controls.py,sha256=cRBxdUDWMOYlCxtw1PV11fTlte6qLxSfCGpr9bQiLcE,11162
-rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE,8934592
-rocket_welder_sdk/ui/ui_events_projection.py,sha256=siiNhjLEBOPfTKw1ZhOPGkwIN5rLDH7V9VCZTNrhEtQ,7836
-rocket_welder_sdk/ui/ui_service.py,sha256=uRdpyJGoCQmtOli_HKSrxLwhZYG-XRuHIYdkmFz1zNk,12026
-rocket_welder_sdk/ui/value_types.py,sha256=f7OA_9zgXEDPoITc8v8SfAR23I4XeFhE3E2_GcAbR6k,1616
-rocket_welder_sdk-1.1.31.dist-info/METADATA,sha256=bQqMPxDVBAmDkYrsDO3MYL3sPdKqojvQhHUanbPxfpY,24438
-rocket_welder_sdk-1.1.31.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rocket_welder_sdk-1.1.31.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
-rocket_welder_sdk-1.1.31.dist-info/RECORD,,