Add disclaimers on y210 support

OpenVisualCloud · Jan 24, 2025 · e8185e6 · e8185e6
1 parent b94d318
commit e8185e6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/ecosystem/ffmpeg_plugin/README.md b/ecosystem/ffmpeg_plugin/README.md
@@ -20,7 +20,7 @@ cd ../
 
 ### 1.2 Build ffmpeg with MTL patches
 
-Note: $mtl_source_code should be pointed to top source code tree of Media Transport Library.
+Note: `$mtl_source_code` should be pointed to top source code tree of Media Transport Library.
 
 ```bash
 git clone https://github.com/FFmpeg/FFmpeg.git
@@ -82,6 +82,10 @@ Reading from a yuv stream from a local file and sending a st2110-20 10bit YUV422
 ffmpeg -stream_loop -1 -video_size 1920x1080 -f rawvideo -pix_fmt yuv422p10le -i yuv422p10le_1080p.yuv -filter:v fps=59.94 -p_port 0000:af:01.1 -p_sip 192.168.96.3 -p_tx_ip 239.168.85.20 -udp_port 20000 -payload_type 112 -f mtl_st20p -
 ```
 
+### 2.3. y210 format
+
+Note: The format y210 is not supported by the Ffmpeg plugins for MTL.
+
 ## 3. ST22 compressed video run guide
 
 A typical workflow for processing an MTL ST22 compressed stream with FFMpeg is outlined in the following steps: Initially, FFMpeg reads a YUV frame from the input source, then forwards the frame to a codec to encode the raw video into a compressed codec stream. Finally, the codec stream is sent to the MTL ST22 plugin.

diff --git a/ecosystem/ffmpeg_plugin/mtl_st20p_rx.c b/ecosystem/ffmpeg_plugin/mtl_st20p_rx.c
@@ -122,7 +122,9 @@ static int mtl_st20p_read_header(AVFormatContext* ctx) {
       ops_rx.transport_fmt = ST20_FMT_YUV_422_10BIT;
       ops_rx.output_fmt = ST_FRAME_FMT_YUV422PLANAR10LE;
       break;
-    case AV_PIX_FMT_Y210LE:
+    case AV_PIX_FMT_Y210LE: /* This format is not supported by MTL plugin.
+                               This is workaround
+                               for Intel(R) Tiber(TM) Broadcast Suite */
       ops_rx.transport_fmt = ST20_FMT_YUV_422_10BIT;
       ops_rx.output_fmt = ST_FRAME_FMT_Y210;
       break;
@@ -263,6 +265,8 @@ static int mtl_st20p_read_packet(AVFormatContext* ctx, AVPacket* pkt) {
     return ret;
   }
 
+  /* This format is not supported by MTL plugin.
+     This is workaround for Intel(R) Tiber(TM) Broadcast Suite */
   if (s->pixel_format == AV_PIX_FMT_Y210LE) {
     ret = st20_rfc4175_422be10_to_y210((struct st20_rfc4175_422_10_pg2_be*)frame,
                                        (uint16_t*)pkt->data, s->width, s->height);