FFmpeg + MTL classes info and mock

Author: MateuszGrabuszynski

tests/validation/Engine/extra_options/mtl_common.py

@@ -0,0 +1,67 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_common.h
+
+class MtlCommonRx:
+    def __init__(
+        self,
+        # MTL_RX_DEV_ARGS
+        p_port: str = None,
+        p_sip: str = None,
+        dma_dev: str = None,
+        rx_queues: int = -1,
+        tx_queues: int = -1,
+        # MTL_RX_PORT_ARGS
+        p_rx_ip: str = None,
+        udp_port: int = 20000,
+        payload_type: int = 112,
+    ):
+        self.p_port = p_port
+        self.p_sip = p_sip
+        self.dma_dev = dma_dev
+        self.rx_queues = rx_queues
+        self.tx_queues = tx_queues
+        self.p_rx_ip = p_rx_ip
+        self.udp_port = udp_port
+        self.payload_type = payload_type
+
+    def get_items(self):
+        response = {}
+        for key, value in self.__dict__.items():
+            if value:
+                response[key] = value
+        return response
+
+
+class MtlCommonTx:
+    def __init__(
+        self,
+        # MTL_TX_DEV_ARGS
+        p_port: str = None,
+        p_sip: str = None,
+        dma_dev: str = None,
+        rx_queues: int = -1,
+        tx_queues: int = -1,
+        # MTL_TX_PORT_ARGS
+        p_tx_ip: str = None,
+        udp_port: int = 20000,
+        payload_type: int = 112,
+    ):
+        self.p_port = p_port
+        self.p_sip = p_sip
+        self.dma_dev = dma_dev
+        self.rx_queues = rx_queues
+        self.tx_queues = tx_queues
+        self.p_tx_ip = p_tx_ip
+        self.udp_port = udp_port
+        self.payload_type = payload_type
+
+    def get_items(self):
+        response = {}
+        for key, value in self.__dict__.items():
+            if value:
+                response[key] = value
+        return response

tests/validation/Engine/extra_options/mtl_st20p_rx.py

@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on AVOption elements from
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_st20p_rx.c
+# each Rx has MTL_RX_DEV_ARGS and MTL_RX_PORT_ARGS + the options provided in AVOption elements
+
+from mtl_common import MtlCommonRx
+
+class MtlSt20pRx(MtlCommonRx):
+    def __init__(
+        self,
+        video_size: str = "1920x1080",
+        # pix_fmt: str = "", # duplicates with pixel_format, which is clearer
+        pixel_format: str = "yuv422p10le",
+        fps: float = 59.94,
+        timeout_s: int = 0,
+        init_retry: int = 5,
+        fb_cnt: int = 3,
+        gpu_direct: bool = False, # FIXME: this adds -nogpu_direct, which is unwanted
+        gpu_driver: int = 0,
+        gpu_device: int = 0,
+    ):
+        self.video_size = video_size
+        self.pixel_format = pixel_format
+        self.fps = fps
+        self.timeout_s = timeout_s
+        self.init_retry = init_retry
+        self.fb_cnt = fb_cnt
+        self.gpu_direct = gpu_direct
+        self.gpu_driver = gpu_driver
+        self.gpu_device = gpu_device
+        super().__init__()

tests/validation/Engine/extra_options/mtl_st20p_tx.py

@@ -0,0 +1,17 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on AVOption elements from
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_st20p_tx.c
+# each Tx has MTL_TX_DEV_ARGS and MTL_TX_PORT_ARGS + the options provided in AVOption elements
+
+from mtl_common import MtlCommonTx
+
+class MtlSt20pTx(MtlCommonTx):
+    def __init__(
+        self,
+        fb_cnt: int = 3,
+    ):
+        self.fb_cnt = fb_cnt
+        super().__init__()

tests/validation/Engine/extra_options/mtl_st22p_rx.py

@@ -0,0 +1,33 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on AVOption elements from
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_st22p_rx.c
+# each Rx has MTL_RX_DEV_ARGS and MTL_RX_PORT_ARGS + the options provided in AVOption elements
+
+from mtl_common import MtlCommonRx
+
+class MtlSt22pRx(MtlCommonRx):
+    def __init__(
+        self,
+        video_size: str = "1920x1080",
+        # pix_fmt: str = "", # duplicates with pixel_format, which is clearer
+        pixel_format: str = "yuv422p10le",
+        fps: float = 59.94,
+        timeout_s: int = 0,
+        init_retry: int = 5,
+        fb_cnt: int = 3,
+        codec_thread_cnt: int = 0,
+        st22_codec: str = None,
+    ):
+        self.video_size = video_size
+        self.pix_fmt = pix_fmt
+        self.pixel_format = pixel_format
+        self.fps = fps
+        self.timeout_s = timeout_s
+        self.init_retry = init_retry
+        self.fb_cnt = fb_cnt
+        self.codec_thread_cnt = codec_thread_cnt
+        self.st22_codec = st22_codec
+        super().__init__()

tests/validation/Engine/extra_options/mtl_st22p_tx.py

@@ -0,0 +1,23 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on AVOption elements from
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_st22p_tx.c
+# each Tx has MTL_TX_DEV_ARGS and MTL_TX_PORT_ARGS + the options provided in AVOption elements
+
+from mtl_common import MtlCommonTx
+
+class MtlSt22pTx(MtlCommonTx):
+    def __init__(
+        self,
+        fb_cnt: int = 3,
+        bpp: float = 3.0,
+        codec_thread_cnt: int = 0,
+        st22_codec: str = None,
+    ):
+        self.fb_cnt = fb_cnt
+        self.bpp = bpp
+        self.codec_thread_cnt = codec_thread_cnt
+        self.st22_codec = st22_codec
+        super().__init__()

tests/validation/Engine/extra_options/mtl_st30p_rx.py

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on AVOption elements from
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_st30p_rx.c
+# each Rx has MTL_RX_DEV_ARGS and MTL_RX_PORT_ARGS + the options provided in AVOption elements
+
+from mtl_common import MtlCommonRx
+
+# TODO: Think about Enums for sample rate, channels, pcm_fmt and ptime
+
+class MtlSt30pRx(MtlCommonRx):
+    def __init__(
+        self,
+        fb_cnt: int = 3,
+        timeout_s: int = 0,
+        init_retry: int = 5,
+        sample_rate: int = 48000,
+        channels: int = 2,
+        pcm_fmt: str = None,
+        ptime: str = None,
+    ):
+        self.fb_cnt = fb_cnt
+        self.timeout_s = timeout_s
+        self.init_retry = init_retry
+        self.sample_rate = sample_rate
+        self.channels = channels
+        self.pcm_fmt = pcm_fmt
+        self.ptime = ptime
+        super().__init__()

tests/validation/Engine/extra_options/mtl_st30p_tx.py

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2025 Intel Corporation
+# Media Communications Mesh
+
+# generates typed-ffmpeg's extra_options for Media Transport Library based on AVOption elements from
+# https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/ecosystem/ffmpeg_plugin/mtl_st30p_tx.c
+# each Tx has MTL_TX_DEV_ARGS and MTL_TX_PORT_ARGS + the options provided in AVOption elements
+
+from mtl_common import MtlCommonTx
+
+class MtlSt30pTx(MtlCommonTx):
+    def __init__(
+        self,
+        fb_cnt: int = 3,
+        ptime: str = None,
+    ):
+        self.fb_cnt = fb_cnt
+        self.ptime = ptime
+        super().__init__()

tests/validation/Engine/ffmpeg_wrapper.py

@@ -2,13 +2,31 @@
 # Copyright 2025 Intel Corporation
 # Media Communications Mesh
 
-# TODO: consider how we can use https://github.com/kkroening/ffmpeg-python
-# TODO: maybe we can write ffmpeg wrapper like scapy? e.g. every protocol is different class and it looks like this:
-# Ether()/IP()/TCP() so maybe: ffmpeg_cmd = Input()/Transport()/Output() etc.
+# MTL extra_options usage:
+# >>> import ffmpeg # (typed-ffmpeg library)
+# fi = ffmpeg.input(filename="-", extra_options={"ptime": "1ms"}) # extra_options to be used as a mean of adding the parameters
+# fo = (fi.output(filename="xyz"))
+# fo.compile()
+# ['ffmpeg', '-ptime', '1ms', '-i', '-', 'xyz']
+
+# >>> import ffmpeg
+# >>> import mtl_st20p_rx
+# >>> st20p_rx = mtl_st20p_rx.MtlSt20pRx(video_size="3840x2160", timeout_s=4)
+# >>> st20p_rx.get_items()
+# {'video_size': '3840x2160', 'fps': 59.94, 'timeout_s': 4, 'init_retry': 5, 'fb_cnt': 3, 'gpu_direct': False, 'gpu_driver': 0, 'gpu_device': 0, 'rx_queues': -1, 'tx_queues': -1, 'udp_port': 20000, 'payload_type': 112}
+
+# >>> fi = ffmpeg.input(filename="xyz", extra_options=st20p_rx.get_items())
+# >>> fo = fi.output(filename="abc")
+# >>> fo.compile()
+# ['ffmpeg', '-video_size', '3840x2160', '-fps', '59.94', '-timeout_s', '4', '-init_retry', '5', '-fb_cnt', '3', '-nogpu_direct', '-gpu_driver', '0', '-gpu_device', '0', '-rx_queues', '-1', '-tx_queues', '-1', '-udp_port', '20000', '-payload_type', '112', '-i', 'xyz', 'abc']
+# >>> ' '.join(fo.compile())
+# 'ffmpeg -video_size 3840x2160 -fps 59.94 -timeout_s 4 -init_retry 5 -fb_cnt 3 -nogpu_direct -gpu_driver 0 -gpu_device 0 -rx_queues -1 -tx_queues -1 -udp_port 20000 -payload_type 112 -i xyz abc'
+
+# TODO: Continue adding above to below functions
 
 class FFmpeg:
     """
-    FFMPEG wrapper with MCM plugin
+    FFmpeg wrapper with MCM plugin
     """
     def __init__(self, connection):
         self.conn = connection
@@ -19,4 +37,5 @@ def start_ffmpeg(self, cmd):
         self._processes.append(ffmpeg)
 
     def prepare_st20_tx_cmd(self):
+        # from extra_options import mcm_st20p_tx
         pass

tests/validation/requirements.txt

@@ -13,4 +13,5 @@ pytest==8.3.2
 pytest-check==2.3.1
 tomli==2.0.1
 pytest-json-report==1.5.0
-pytest-metadata==3.1.1
+pytest-metadata==3.1.1
+typed-ffmpeg==2.6.4