rocket-welder-sdk 1.1.34.dev10__tar.gz → 1.1.34.dev11__tar.gz

{rocket_welder_sdk-1.1.34.dev10 → rocket_welder_sdk-1.1.34.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.34.dev10
+Version: 1.1.34.dev11
 Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
 Home-page: https://github.com/modelingevolution/rocket-welder-sdk
 Author: ModelingEvolution

rocket_welder_sdk-1.1.34.dev11/VERSION

@@ -0,0 +1 @@
+1.1.34.dev11

{rocket_welder_sdk-1.1.34.dev10 → rocket_welder_sdk-1.1.34.dev11}/pyproject.toml

@@ -82,8 +82,7 @@ show_error_codes = true
 show_column_numbers = true
 pretty = true
 exclude = [
-    "examples/05-traktorek",
-    "examples/rocket-welder-client-python-yolo",
+    "examples/",  # Examples are not packages, exclude from type checking
 ]
 
 [[tool.mypy.overrides]]
@@ -148,6 +147,7 @@ ignore = [
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]  # imported but unused
 "tests/*" = ["S101"]  # use of assert
+"examples/*" = ["N999", "SIM112"]  # Module names and env var casing (matches C# SDK)
 
 [tool.pytest.ini_options]
 minversion = "7.0"

{rocket_welder_sdk-1.1.34.dev10 → rocket_welder_sdk-1.1.34.dev11}/rocket_welder_sdk/controllers.py

@@ -338,7 +338,7 @@ class OneWayShmController(IController):
         Matches C# CreateMat behavior - creates Mat wrapping the data.
 
         Frame data layout from GStreamer zerosink:
-        [FrameMetadata (16 bytes)][Pixel Data (W×H×C bytes)]
+        [FrameMetadata (16 bytes)][Pixel Data (WxHxC bytes)]
 
         Args:
             frame: ZeroBuffer frame

{rocket_welder_sdk-1.1.34.dev10 → rocket_welder_sdk-1.1.34.dev11}/rocket_welder_sdk/frame_metadata.py

@@ -18,7 +18,7 @@ from __future__ import annotations
 
 import struct
 from dataclasses import dataclass
-from typing import Optional
+from typing import ClassVar, Dict, Optional
 
 # Size of the FrameMetadata structure in bytes
 FRAME_METADATA_SIZE = 16
@@ -113,7 +113,7 @@ class GstVideoFormat:
     GRAY16_BE = 26
     GRAY16_LE = 27
 
-    _FORMAT_NAMES: dict[int, str] = {
+    _FORMAT_NAMES: ClassVar[Dict[int, str]] = {
         0: "UNKNOWN",
         2: "I420",
         3: "YV12",

rocket_welder_sdk-1.1.34.dev11/rocket_welder_sdk/high_level/__init__.py

@@ -0,0 +1,52 @@
+"""
+High-level API for RocketWelder SDK.
+
+Mirrors C# RocketWelder.SDK API for consistent developer experience.
+
+Example:
+    from rocket_welder_sdk.high_level import RocketWelderClient
+
+    with RocketWelderClient.from_environment() as client:
+        nose = client.keypoints.define_point("nose")
+        person = client.segmentation.define_class(1, "person")
+        client.start(process_frame)
+"""
+
+from .client import RocketWelderClient, RocketWelderClientOptions
+from .connection_strings import (
+    KeyPointsConnectionString,
+    SegmentationConnectionString,
+    VideoSourceConnectionString,
+    VideoSourceType,
+)
+from .data_context import (
+    IKeyPointsDataContext,
+    ISegmentationDataContext,
+)
+from .schema import (
+    IKeyPointsSchema,
+    ISegmentationSchema,
+    KeyPointDefinition,
+    SegmentClass,
+)
+from .transport_protocol import (
+    TransportKind,
+    TransportProtocol,
+)
+
+__all__ = [
+    "IKeyPointsDataContext",
+    "IKeyPointsSchema",
+    "ISegmentationDataContext",
+    "ISegmentationSchema",
+    "KeyPointDefinition",
+    "KeyPointsConnectionString",
+    "RocketWelderClient",
+    "RocketWelderClientOptions",
+    "SegmentClass",
+    "SegmentationConnectionString",
+    "TransportKind",
+    "TransportProtocol",
+    "VideoSourceConnectionString",
+    "VideoSourceType",
+]

rocket_welder_sdk-1.1.34.dev11/rocket_welder_sdk/high_level/client.py

@@ -0,0 +1,262 @@
+"""
+RocketWelderClient - High-level API matching C# RocketWelder.SDK.
+
+Usage:
+    with RocketWelderClient.from_environment() as client:
+        # Define schema
+        nose = client.keypoints.define_point("nose")
+        person = client.segmentation.define_class(1, "person")
+
+        # Start processing
+        client.start(process_frame)
+"""
+
+from __future__ import annotations
+
+import logging
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, Any, Callable, Optional
+
+import numpy as np
+import numpy.typing as npt
+from typing_extensions import TypeAlias
+
+from .connection_strings import (
+    KeyPointsConnectionString,
+    SegmentationConnectionString,
+    VideoSourceConnectionString,
+)
+from .data_context import (
+    IKeyPointsDataContext,
+    ISegmentationDataContext,
+    KeyPointsDataContext,
+    SegmentationDataContext,
+)
+from .schema import (
+    IKeyPointsSchema,
+    ISegmentationSchema,
+    KeyPointsSchema,
+    SegmentationSchema,
+)
+from .transport_protocol import TransportKind
+
+if TYPE_CHECKING:
+    from rocket_welder_sdk.keypoints_protocol import KeyPointsSink
+    from rocket_welder_sdk.transport.frame_sink import IFrameSink
+
+# Type alias for OpenCV Mat (numpy array)
+Mat: TypeAlias = npt.NDArray[np.uint8]
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass
+class RocketWelderClientOptions:
+    """Configuration options for RocketWelderClient."""
+
+    video_source: VideoSourceConnectionString = field(
+        default_factory=VideoSourceConnectionString.default
+    )
+    keypoints: KeyPointsConnectionString = field(default_factory=KeyPointsConnectionString.default)
+    segmentation: SegmentationConnectionString = field(
+        default_factory=SegmentationConnectionString.default
+    )
+
+    @classmethod
+    def from_environment(cls) -> RocketWelderClientOptions:
+        """Create from environment variables."""
+        return cls(
+            video_source=VideoSourceConnectionString.from_environment(),
+            keypoints=KeyPointsConnectionString.from_environment(),
+            segmentation=SegmentationConnectionString.from_environment(),
+        )
+
+
+class RocketWelderClient:
+    """
+    High-level client for RocketWelder SDK.
+
+    Mirrors C# RocketWelder.SDK.IRocketWelderClient interface.
+    """
+
+    def __init__(self, options: RocketWelderClientOptions) -> None:
+        self._options = options
+        self._keypoints_schema = KeyPointsSchema()
+        self._segmentation_schema = SegmentationSchema()
+        self._keypoints_sink: Optional[KeyPointsSink] = None
+        self._keypoints_frame_sink: Optional[IFrameSink] = None
+        self._segmentation_frame_sink: Optional[IFrameSink] = None
+        self._closed = False
+        logger.debug("RocketWelderClient created with options: %s", options)
+
+    @classmethod
+    def from_environment(cls) -> RocketWelderClient:
+        """Create client from environment variables."""
+        logger.info("Creating RocketWelderClient from environment variables")
+        return cls(RocketWelderClientOptions.from_environment())
+
+    @classmethod
+    def create(cls, options: Optional[RocketWelderClientOptions] = None) -> RocketWelderClient:
+        """Create client with explicit options."""
+        return cls(options or RocketWelderClientOptions())
+
+    @property
+    def keypoints(self) -> IKeyPointsSchema:
+        """Schema for defining keypoints."""
+        return self._keypoints_schema
+
+    @property
+    def segmentation(self) -> ISegmentationSchema:
+        """Schema for defining segmentation classes."""
+        return self._segmentation_schema
+
+    def start(
+        self,
+        process_frame: Callable[[Mat, ISegmentationDataContext, IKeyPointsDataContext, Mat], None],
+    ) -> None:
+        """Start with both keypoints and segmentation."""
+        self._run_loop(process_frame, use_keypoints=True, use_segmentation=True)
+
+    def start_keypoints(
+        self,
+        process_frame: Callable[[Mat, IKeyPointsDataContext, Mat], None],
+    ) -> None:
+        """Start with keypoints only."""
+        self._run_loop(process_frame, use_keypoints=True, use_segmentation=False)
+
+    def start_segmentation(
+        self,
+        process_frame: Callable[[Mat, ISegmentationDataContext, Mat], None],
+    ) -> None:
+        """Start with segmentation only."""
+        self._run_loop(process_frame, use_keypoints=False, use_segmentation=True)
+
+    def _run_loop(
+        self,
+        process_frame: Callable[..., None],
+        use_keypoints: bool,
+        use_segmentation: bool,
+    ) -> None:
+        """Run processing loop."""
+        from rocket_welder_sdk.keypoints_protocol import KeyPointsSink
+
+        logger.info(
+            "Starting processing loop (keypoints=%s, segmentation=%s)",
+            use_keypoints,
+            use_segmentation,
+        )
+
+        # Initialize sinks
+        if use_keypoints:
+            cs = self._options.keypoints
+            logger.info("Initializing keypoints sink: %s -> %s", cs.protocol, cs.address)
+            self._keypoints_frame_sink = self._create_frame_sink(cs.protocol, cs.address)
+            self._keypoints_sink = KeyPointsSink(
+                frame_sink=self._keypoints_frame_sink,
+                master_frame_interval=cs.master_frame_interval,
+                owns_sink=False,  # We manage frame sink lifecycle in close()
+            )
+            logger.debug(
+                "KeyPointsSink created with master_frame_interval=%d", cs.master_frame_interval
+            )
+
+        if use_segmentation:
+            seg_cs = self._options.segmentation
+            logger.info("Initializing segmentation sink: %s -> %s", seg_cs.protocol, seg_cs.address)
+            self._segmentation_frame_sink = self._create_frame_sink(seg_cs.protocol, seg_cs.address)
+            logger.debug("Segmentation frame sink created")
+
+        # TODO: Video capture loop - for now raise NotImplementedError
+        raise NotImplementedError(
+            "Video capture not implemented. Use process_frame_sync() or low-level API."
+        )
+
+    def process_frame_sync(
+        self,
+        frame_id: int,
+        input_frame: Mat,
+        output_frame: Mat,
+        width: int,
+        height: int,
+    ) -> tuple[Optional[IKeyPointsDataContext], Optional[ISegmentationDataContext]]:
+        """
+        Process a single frame synchronously.
+
+        Returns (keypoints_context, segmentation_context) for the caller to use.
+        Caller must call commit() on contexts when done.
+        """
+        from rocket_welder_sdk.segmentation_result import SegmentationResultWriter
+
+        kp_ctx: Optional[IKeyPointsDataContext] = None
+        seg_ctx: Optional[ISegmentationDataContext] = None
+
+        if self._keypoints_sink is not None:
+            kp_writer = self._keypoints_sink.create_writer(frame_id)
+            kp_ctx = KeyPointsDataContext(frame_id, kp_writer)
+
+        if self._segmentation_frame_sink is not None:
+            seg_writer = SegmentationResultWriter(
+                frame_id, width, height, frame_sink=self._segmentation_frame_sink
+            )
+            seg_ctx = SegmentationDataContext(frame_id, seg_writer)
+
+        return kp_ctx, seg_ctx
+
+    def _create_frame_sink(self, protocol: Any, address: str) -> IFrameSink:
+        """Create frame sink from protocol."""
+        from rocket_welder_sdk.transport import NngFrameSink
+        from rocket_welder_sdk.transport.stream_transport import StreamFrameSink
+        from rocket_welder_sdk.transport.unix_socket_transport import UnixSocketFrameSink
+
+        from .transport_protocol import TransportProtocol
+
+        if not isinstance(protocol, TransportProtocol):
+            raise TypeError(f"Expected TransportProtocol, got {type(protocol)}")
+
+        if protocol.kind == TransportKind.FILE:
+            logger.debug("Creating file sink: %s", address)
+            file_handle = open(address, "wb")
+            try:
+                return StreamFrameSink(file_handle)
+            except Exception:
+                file_handle.close()
+                raise
+        elif protocol.kind == TransportKind.SOCKET:
+            logger.debug("Creating Unix socket sink: %s", address)
+            return UnixSocketFrameSink.connect(address)
+        elif protocol.kind in (TransportKind.NNG_PUSH_IPC, TransportKind.NNG_PUSH_TCP):
+            logger.debug("Creating NNG pusher: %s", address)
+            return NngFrameSink.create_pusher(address)
+        elif protocol.kind in (TransportKind.NNG_PUB_IPC, TransportKind.NNG_PUB_TCP):
+            logger.debug("Creating NNG publisher: %s", address)
+            return NngFrameSink.create_publisher(address)
+        else:
+            raise ValueError(f"Unsupported protocol: {protocol}")
+
+    def close(self) -> None:
+        """Release resources."""
+        if self._closed:
+            return
+
+        logger.info("Closing RocketWelderClient")
+
+        # Close frame sinks (KeyPointsSink has owns_sink=False, so we manage lifecycle)
+        self._keypoints_sink = None
+        if self._keypoints_frame_sink is not None:
+            logger.debug("Closing keypoints frame sink")
+            self._keypoints_frame_sink.close()
+            self._keypoints_frame_sink = None
+
+        if self._segmentation_frame_sink is not None:
+            logger.debug("Closing segmentation frame sink")
+            self._segmentation_frame_sink.close()
+            self._segmentation_frame_sink = None
+
+        self._closed = True
+        logger.info("RocketWelderClient closed")
+
+    def __enter__(self) -> RocketWelderClient:
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()

{rocket_welder_sdk-1.1.34.dev10 → rocket_welder_sdk-1.1.34.dev11}/rocket_welder_sdk/high_level/connection_strings.py

@@ -6,7 +6,8 @@ Connection string format: protocol://path?param1=value1&param2=value2
 Examples:
     nng+push+ipc://tmp/keypoints?masterFrameInterval=300
     nng+pub+tcp://localhost:5555
-    file://path/to/output.bin
+    file:///path/to/output.bin
+    socket:///tmp/my.sock
 """
 
 from __future__ import annotations
@@ -144,19 +145,19 @@ class KeyPointsConnectionString:
     """
     Strongly-typed connection string for KeyPoints output.
 
-    Supported protocols (composable with + operator):
-    - Transport.Nng + Transport.Push + Transport.Ipc → nng+push+ipc://tmp/keypoints
-    - Transport.Nng + Transport.Push + Transport.Tcp → nng+push+tcp://host:port
-    - file://path/to/file.bin - File output
+    Supported protocols:
+    - file:///path/to/file.bin - File output (absolute path)
+    - socket:///tmp/socket.sock - Unix domain socket
+    - nng+push+ipc://tmp/keypoints - NNG Push over IPC
+    - nng+push+tcp://host:port - NNG Push over TCP
 
     Supported parameters:
     - masterFrameInterval: Interval between master frames (default: 300)
     """
 
     value: str
-    protocol: Optional[TransportProtocol] = None
-    is_file: bool = False
-    address: str = ""
+    protocol: TransportProtocol
+    address: str
     master_frame_interval: int = 300
     parameters: Dict[str, str] = field(default_factory=dict)
 
@@ -199,25 +200,26 @@ class KeyPointsConnectionString:
 
         # Parse protocol and address
         scheme_end = endpoint_part.find("://")
-        if scheme_end > 0:
-            protocol_str = endpoint_part[:scheme_end]
-            path_part = endpoint_part[scheme_end + 3 :]  # skip "://"
-
-            if protocol_str.lower() == "file":
-                address = "/" + path_part  # Restore absolute path
-                is_file = True
-                protocol = None
-            else:
-                protocol = TransportProtocol.try_parse(protocol_str)
-                if protocol is None:
-                    return None
-                address = protocol.create_nng_address(path_part)
-                is_file = False
-        elif s.startswith("/"):
-            # Assume absolute file path
-            address = s
-            is_file = True
-            protocol = None
+        if scheme_end <= 0:
+            return None
+
+        schema_str = endpoint_part[:scheme_end]
+        path_part = endpoint_part[scheme_end + 3 :]  # skip "://"
+
+        protocol = TransportProtocol.try_parse(schema_str)
+        if protocol is None:
+            return None
+
+        # Build address based on protocol type
+        if protocol.is_file:
+            # file:///absolute/path -> /absolute/path
+            address = path_part if path_part.startswith("/") else "/" + path_part
+        elif protocol.is_socket:
+            # socket:///tmp/sock -> /tmp/sock
+            address = path_part if path_part.startswith("/") else "/" + path_part
+        elif protocol.is_nng:
+            # NNG protocols need proper address format
+            address = protocol.create_nng_address(path_part)
         else:
             return None
 
@@ -230,7 +232,6 @@ class KeyPointsConnectionString:
         return cls(
             value=s,
             protocol=protocol,
-            is_file=is_file,
             address=address,
             master_frame_interval=master_frame_interval,
             parameters=parameters,
@@ -245,16 +246,16 @@ class SegmentationConnectionString:
     """
     Strongly-typed connection string for Segmentation output.
 
-    Supported protocols (composable with + operator):
-    - Transport.Nng + Transport.Push + Transport.Ipc → nng+push+ipc://tmp/segmentation
-    - Transport.Nng + Transport.Push + Transport.Tcp → nng+push+tcp://host:port
-    - file://path/to/file.bin - File output
+    Supported protocols:
+    - file:///path/to/file.bin - File output (absolute path)
+    - socket:///tmp/socket.sock - Unix domain socket
+    - nng+push+ipc://tmp/segmentation - NNG Push over IPC
+    - nng+push+tcp://host:port - NNG Push over TCP
     """
 
     value: str
-    protocol: Optional[TransportProtocol] = None
-    is_file: bool = False
-    address: str = ""
+    protocol: TransportProtocol
+    address: str
     parameters: Dict[str, str] = field(default_factory=dict)
 
     @classmethod
@@ -296,32 +297,32 @@ class SegmentationConnectionString:
 
         # Parse protocol and address
         scheme_end = endpoint_part.find("://")
-        if scheme_end > 0:
-            protocol_str = endpoint_part[:scheme_end]
-            path_part = endpoint_part[scheme_end + 3 :]  # skip "://"
-
-            if protocol_str.lower() == "file":
-                address = "/" + path_part  # Restore absolute path
-                is_file = True
-                protocol = None
-            else:
-                protocol = TransportProtocol.try_parse(protocol_str)
-                if protocol is None:
-                    return None
-                address = protocol.create_nng_address(path_part)
-                is_file = False
-        elif s.startswith("/"):
-            # Assume absolute file path
-            address = s
-            is_file = True
-            protocol = None
+        if scheme_end <= 0:
+            return None
+
+        schema_str = endpoint_part[:scheme_end]
+        path_part = endpoint_part[scheme_end + 3 :]  # skip "://"
+
+        protocol = TransportProtocol.try_parse(schema_str)
+        if protocol is None:
+            return None
+
+        # Build address based on protocol type
+        if protocol.is_file:
+            # file:///absolute/path -> /absolute/path
+            address = path_part if path_part.startswith("/") else "/" + path_part
+        elif protocol.is_socket:
+            # socket:///tmp/sock -> /tmp/sock
+            address = path_part if path_part.startswith("/") else "/" + path_part
+        elif protocol.is_nng:
+            # NNG protocols need proper address format
+            address = protocol.create_nng_address(path_part)
         else:
             return None
 
         return cls(
             value=s,
             protocol=protocol,
-            is_file=is_file,
             address=address,
             parameters=parameters,
         )

{rocket_welder_sdk-1.1.34.dev10 → rocket_welder_sdk-1.1.34.dev11}/rocket_welder_sdk/high_level/data_context.py

@@ -17,7 +17,7 @@ if TYPE_CHECKING:
     from rocket_welder_sdk.keypoints_protocol import IKeyPointsWriter
     from rocket_welder_sdk.segmentation_result import SegmentationResultWriter
 
-    from .schema import KeyPoint, SegmentClass
+    from .schema import KeyPointDefinition, SegmentClass
 
 # Type aliases
 Point = Tuple[int, int]
@@ -37,12 +37,12 @@ class IKeyPointsDataContext(ABC):
         pass
 
     @abstractmethod
-    def add(self, point: KeyPoint, x: int, y: int, confidence: float) -> None:
+    def add(self, point: KeyPointDefinition, x: int, y: int, confidence: float) -> None:
         """
         Add a keypoint detection for this frame.
 
         Args:
-            point: KeyPoint from schema definition
+            point: KeyPointDefinition from schema definition
             x: X coordinate in pixels
             y: Y coordinate in pixels
             confidence: Detection confidence (0.0 to 1.0)
@@ -50,17 +50,22 @@ class IKeyPointsDataContext(ABC):
         pass
 
     @abstractmethod
-    def add_point(self, point: KeyPoint, position: Point, confidence: float) -> None:
+    def add_point(self, point: KeyPointDefinition, position: Point, confidence: float) -> None:
         """
         Add a keypoint detection using a Point tuple.
 
         Args:
-            point: KeyPoint from schema definition
+            point: KeyPointDefinition from schema definition
             position: (x, y) tuple
             confidence: Detection confidence (0.0 to 1.0)
         """
         pass
 
+    @abstractmethod
+    def commit(self) -> None:
+        """Commit the context (called automatically when delegate returns)."""
+        pass
+
 
 class ISegmentationDataContext(ABC):
     """
@@ -92,6 +97,11 @@ class ISegmentationDataContext(ABC):
         """
         pass
 
+    @abstractmethod
+    def commit(self) -> None:
+        """Commit the context (called automatically when delegate returns)."""
+        pass
+
 
 class KeyPointsDataContext(IKeyPointsDataContext):
     """Implementation of keypoints data context."""
@@ -101,8 +111,6 @@ class KeyPointsDataContext(IKeyPointsDataContext):
         frame_id: int,
         writer: IKeyPointsWriter,
     ) -> None:
-        from .schema import KeyPoint  # noqa: F401
-
         self._frame_id = frame_id
         self._writer = writer
 
@@ -110,11 +118,11 @@ class KeyPointsDataContext(IKeyPointsDataContext):
     def frame_id(self) -> int:
         return self._frame_id
 
-    def add(self, point: KeyPoint, x: int, y: int, confidence: float) -> None:
+    def add(self, point: KeyPointDefinition, x: int, y: int, confidence: float) -> None:
         """Add a keypoint detection for this frame."""
         self._writer.append(point.id, x, y, confidence)
 
-    def add_point(self, point: KeyPoint, position: Point, confidence: float) -> None:
+    def add_point(self, point: KeyPointDefinition, position: Point, confidence: float) -> None:
         """Add a keypoint detection using a Point tuple."""
         self._writer.append_point(point.id, position, confidence)
 
@@ -131,8 +139,6 @@ class SegmentationDataContext(ISegmentationDataContext):
         frame_id: int,
         writer: SegmentationResultWriter,
     ) -> None:
-        from .schema import SegmentClass  # noqa: F401
-
         self._frame_id = frame_id
         self._writer = writer