[1/4] controls: Add SyncAdjustment and SyncInterface controls
diff mbox series

Message ID 20250829091011.2628954-2-paul.elder@ideasonboard.com
State New
Headers show
Series
  • Add Sync Layer
Related show

Commit Message

Paul Elder Aug. 29, 2025, 9:10 a.m. UTC
Add a couple of controls related to the sync algorithm.

The SyncAdjustment control signals to the Camera the amount to adjust
the frame duration by for a single frame. Any Camera that implements
this control (and FrameDurationLimits and SensorTimestamp metadata) will
be supported by the sync algorithm layer.

The SyncInterface control signals to the sync layer which network
interface to use for listening (on client mode) or for multicasting (on
server mode). Given that enabling/disabling sync is done via control (as
opposed to always being on via environment variable), choosing the
network interface should be chosen in a similar manner.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
---
 src/libcamera/control_ids_core.yaml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Patch
diff mbox series

diff --git a/src/libcamera/control_ids_core.yaml b/src/libcamera/control_ids_core.yaml
index eec4b4f937ee..8721b5e80e97 100644
--- a/src/libcamera/control_ids_core.yaml
+++ b/src/libcamera/control_ids_core.yaml
@@ -1284,4 +1284,27 @@  controls:
 
         The FrameWallClock control can only be returned in metadata.
 
+  - SyncAdjustment:
+      type: int32_t
+      direction: inout
+      description: |
+        This is an adjustment value that can be either positive or negative, in
+        microseconds, that tells the Camera how much to adjust the frame
+        duration by. This is meant to be used by the Sync layer, and any camera
+        that implements this control (and FrameDurationLimits) will be
+        supported by the sync layer. When reported in metadata, this reports
+        any frame duration adjustment that occurred based on the control value
+        that was passed in.
+
+  - SyncInterface:
+      type: string
+      direction: inout
+      description: |
+        This is the IP address of the network interface to use for the Sync
+        algorithm provided by the Sync layer. When set using the SyncMode
+        control to client mode, this will be the network interface to listen
+        on, and for server mode it will multicast from this network interface.
+        If no network interface is supplied by this control then INADDR_ANY
+        will be used.
+
 ...