rocket-welder-sdk 1.1.27__py3-none-any.whl → 1.1.28__py3-none-any.whl

{rocket_welder_sdk-1.1.27.dist-info → rocket_welder_sdk-1.1.28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.27
+Version: 1.1.28
 Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
 Home-page: https://github.com/modelingevolution/rocket-welder-sdk
 Author: ModelingEvolution
@@ -17,6 +17,7 @@ Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -93,6 +94,18 @@ shm://<buffer_name>?mode=duplex&buffer_size=10MB
 - `buffer_size`: Size of the data buffer (default: 20MB, supports units: B, KB, MB, GB)
 - `metadata_size`: Size of the metadata buffer (default: 4KB, supports units: B, KB, MB)
 
+#### File (Video File Playback)
+```
+file:///path/to/video.mp4
+file:///path/to/video.mp4?loop=true
+file:///path/to/video.mp4?preview=true
+file:///path/to/video.mp4?loop=true&preview=true
+```
+
+**Optional Parameters:**
+- `loop`: Loop video playback when end is reached (`true` or `false`; default: `false`)
+- `preview`: Enable preview window display (`true` or `false`; default: `false`)
+
 #### MJPEG over HTTP
 ```
 mjpeg+http://192.168.1.100:8080
@@ -318,6 +331,44 @@ for frame in client.frames():
     print(f"Received frame: {frame.shape}")
 ```
 
+## Preview Display
+
+When using the `file://` protocol with `preview=true` parameter, you can display frames in a window. The `Show()` method must be called from the main thread:
+
+### C# Preview
+```csharp
+var client = RocketWelderClient.FromConnectionString(
+    "file:///path/to/video.mp4?preview=true&loop=true"
+);
+
+// Start processing in background
+client.Start(frame => {
+    // Process frame
+});
+
+// Show preview window in main thread (blocks until 'q' pressed)
+client.Show();
+```
+
+### Python Preview
+```python
+client = rw.Client.from_connection_string(
+    "file:///path/to/video.mp4?preview=true&loop=true"
+)
+
+# Start processing in background
+client.start(lambda frame: process_frame(frame))
+
+# Show preview window in main thread (blocks until 'q' pressed)
+client.show()
+```
+
+**Note**: The `Show()` method:
+- Blocks when `preview=true` is set in the connection string
+- Returns immediately when `preview` is not set or `false`
+- Must be called from the main thread (X11/GUI requirement)
+- Stops when 'q' key is pressed in the preview window
+
 ## Docker Integration
 
 ### C++ Dockerfile
@@ -385,6 +436,75 @@ COPY . .
 CMD ["python", "app.py"]
 ```
 
+### Running Docker with X11 Display Support (Preview)
+
+When using the `preview=true` parameter with file protocol, you need to enable X11 forwarding for Docker containers to display the preview window.
+
+#### Linux
+
+```bash
+# Allow X server connections from Docker
+xhost +local:docker
+
+# Run container with display support
+docker run --rm \
+    -e DISPLAY=$DISPLAY \
+    -e CONNECTION_STRING="file:///data/video.mp4?preview=true&loop=true" \
+    -v /tmp/.X11-unix:/tmp/.X11-unix:rw \
+    -v /path/to/video.mp4:/data/video.mp4:ro \
+    --network host \
+    your-image:latest
+
+# Restore X server security after running
+xhost -local:docker
+```
+
+#### Windows WSL2
+
+WSL2 includes WSLg which provides automatic X11 support:
+
+```bash
+# WSLg sets DISPLAY automatically, just verify it's set
+echo $DISPLAY  # Should show :0 or similar
+
+# Allow X server connections
+xhost +local:docker 2>/dev/null || xhost +local: 2>/dev/null
+
+# Run container with display support (same as Linux)
+docker run --rm \
+    -e DISPLAY=$DISPLAY \
+    -e CONNECTION_STRING="file:///data/video.mp4?preview=true&loop=true" \
+    -v /tmp/.X11-unix:/tmp/.X11-unix:rw \
+    -v /mnt/c/path/to/video.mp4:/data/video.mp4:ro \
+    --network host \
+    your-image:latest
+
+# Restore X server security
+xhost -local:docker 2>/dev/null || xhost -local: 2>/dev/null
+```
+
+#### Helper Scripts
+
+The SDK includes helper scripts for easy testing:
+
+```bash
+# Build Docker images with sample clients
+./build_docker_samples.sh
+
+# Test Python client with preview
+./run_docker_x11.sh python
+
+# Test C# client with preview
+./run_docker_x11.sh csharp
+```
+
+These scripts automatically:
+- Configure X11 display forwarding
+- Use a test video from the repository's data folder
+- Mount the video into the container
+- Set up the connection string with preview enabled
+- Clean up X server permissions after running
+
 ## Protocol Details
 
 ### Shared Memory Protocol (shm://)
@@ -394,6 +514,15 @@ High-performance local data transfer between processes:
 - **Performance**: Minimal latency, maximum throughput
 - **Use Cases**: Local processing, multi-container applications on same host
 
+### File Protocol (file://)
+
+Local video file playback with OpenCV:
+
+- **Performance**: Controlled playback speed based on video FPS
+- **Features**: Loop playback, preview window, frame-accurate timing
+- **Use Cases**: Testing, development, offline processing, demos
+- **Supported Formats**: All formats supported by OpenCV (MP4, AVI, MOV, etc.)
+
 ### MJPEG over HTTP (mjpeg+http://)
 
 Motion JPEG streaming over HTTP:

{rocket_welder_sdk-1.1.27.dist-info → rocket_welder_sdk-1.1.28.dist-info}/RECORD

@@ -1,10 +1,12 @@
-rocket_welder_sdk/__init__.py,sha256=hv0U_UsvIjyLhZLsumjGwKrBJs8vzb1kczUzANilHug,1789
+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=msDgHD7525UXvrNPqKGpYgQJJtmOfS_XEnX3JA8LIz0,7731
-rocket_welder_sdk/controllers.py,sha256=IhPJfwVlk0pxOuTRPW_Xp_3H_BZG6AJXQfS7DCfBrhg,26177
+rocket_welder_sdk/connection_string.py,sha256=hW61Yf1uCGTWz5KA-yis1nrXO5pyTOCTzxJUbAxf7uk,9685
+rocket_welder_sdk/controllers.py,sha256=DGy33gikQEi8HhdC3JHKN38ADa-qlSE5acKEsnZLzNA,26593
 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=uvaAtog-xVCY9YldisgkCnCkbEWMHEgrJUUWJA1J3hg,5237
+rocket_welder_sdk/rocket_welder_client.py,sha256=aiNfNJjDXLWJ-vw5uDg2tv0HuSkerCVMl109zQaVjGg,14311
 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
@@ -14,7 +16,7 @@ rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE
 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.27.dist-info/METADATA,sha256=7ASdgQYwEmQFNAHNxEzgdTJycgy-5J59uujE9Zwxw6I,14402
-rocket_welder_sdk-1.1.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rocket_welder_sdk-1.1.27.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
-rocket_welder_sdk-1.1.27.dist-info/RECORD,,
+rocket_welder_sdk-1.1.28.dist-info/METADATA,sha256=_4x2JrvbxuknI2dU9FeuZFX_SZ3SEPcnnG5U_ZI_DKU,18081
+rocket_welder_sdk-1.1.28.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rocket_welder_sdk-1.1.28.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
+rocket_welder_sdk-1.1.28.dist-info/RECORD,,