Skip to content

Commit b4fcb98

Browse files
Docs: add the first mention of new arguemnts
1 parent 515164b commit b4fcb98

File tree

4 files changed

+32
-1193
lines changed

4 files changed

+32
-1193
lines changed

ecosystem/gstreamer_plugin/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -395,14 +395,15 @@ The `mtl_st40p_tx` plugin supports all pad capabilities (the data is not checked
395395
- **Capabilities**: Any (GST_STATIC_CAPS_ANY)
396396
397397
**Arguments**
398-
| Property Name | Type | Description | Range | Default Value |
399-
|--------------------|----------|--------------------------------------------------------------------|---------------|---------------|
400-
| tx-framebuff-cnt | uint | Number of framebuffers to be used for transmission. | 0 to G_MAXUINT| 3 |
401-
| tx-fps | uint | Framerate of the video to which the ancillary data is synchronized.| [Supported video fps fractions](#231-supported-video-fps-fractions) | 25/1 |
402-
| tx-did | uint | Data ID for the ancillary data. | 0 to 255 | 0 |
403-
| tx-sdid | uint | Secondary Data ID for the ancillary data. | 0 to 255 | 0 |
404-
| use-pts-for-pacing | gboolean | [User controlled timestamping offset](#233-pts-controlled-pacing) | 0 to G_MAXUINT | 0 |
405-
| pts-pacing-offset | uint | [User controlled timestamping offset](#233-pts-controlled-pacing) | 0 to G_MAXUINT | 0 |
398+
| Property Name | Type | Description | Range | Default Value |
399+
|-----------------------|----------|--------------------------------------------------------------------|----------------|---------------|
400+
| tx-framebuff-cnt | uint | Number of framebuffers to be used for transmission. | 0 to G_MAXUINT | 3 |
401+
| tx-fps | uint | Framerate of the video to which the ancillary data is synchronized.| [Supported vid eo fps fractions](#231-supported-video-fps-fractions) | 25/1 |
402+
| tx-did | uint | Data ID for the ancillary data. | 0 to 255 | 0 |
403+
| tx-sdid | uint | Secondary Data ID for the ancillary data. | 0 to 255 | 0 |
404+
| use-pts-for-pacing | gboolean | [User controlled timestamping offset](#233-pts-controlled-pacing) | 0 to G_MAXUINT | 0 |
405+
| pts-pacing-offset | uint | [User controlled timestamping offset](#233-pts-controlled-pacing) | 0 to G_MAXUINT | 0 |
406+
| max-combined-udw-size | uint | Maximum combined size of all user data words to send in one buffer | 0 to G_MAXUINT | 20 * 255 |
406407
407408
#### 5.1.2. Example GStreamer Pipeline for Transmission
408409

ecosystem/gstreamer_plugin/gst_mtl_st40p_tx.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@ static GstFlowReturn st40p_tx_parse_8331_gstbuffer(Gst_Mtl_St40p_Tx* sink,
657657

658658
/* Get the ANC 8331 header and move the goalpost variables */
659659
payload_cursor = map_info.data + (buffer_size - *bytes_left_to_process);
660-
memcpy(&rfc8331_meta.hdr, payload_cursor, sizeof(struct gst_st40_rfc8331_hdr1_le));
660+
memcpy(&rfc8331_meta.hdr, payload_cursor, sizeof(struct gst_st40_rfc8331_payload_first_word));
661661

662662
ST40P_TX_SHIFT_BUFFER(payload_cursor, *bytes_left_to_process, RFC_8331_WORD_BYTE_SIZE);
663663
/*TODO add support for parity bit checking we are ignoring the parity bits */

ecosystem/gstreamer_plugin/gst_mtl_st40p_tx.h

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ struct _Gst_Mtl_St40p_Tx {
8686
};
8787

8888

89-
struct gst_st40_rfc8331_hdr1_le {
89+
#ifdef MTL_LITTLE_ENDIAN
90+
struct gst_st40_rfc8331_payload_first_word {
9091
union {
9192
struct {
9293
/** the ANC data uses luma (Y) data channel */
@@ -103,10 +104,29 @@ struct gst_st40_rfc8331_hdr1_le {
103104
uint32_t handle;
104105
};
105106
};
107+
#else
108+
struct gst_st40_rfc8331_payload_first_word {
109+
union {
110+
struct {
111+
/** whether the data stream number of a multi-stream data mapping */
112+
uint32_t s : 1;
113+
/** the source data stream number of the ANC data packet */
114+
uint32_t stream_num : 7;
115+
/** the location of the ANC data packet in the SDI raster */
116+
uint32_t horizontal_offset : 12;
117+
/** line number corresponds to the location (vertical) of the ANC data packet */
118+
uint32_t line_number : 11;
119+
/** the ANC data uses luma (Y) data channel */
120+
uint32_t c : 1;
121+
} header;
122+
uint32_t handle;
123+
};
124+
};
125+
#endif
106126

107127

108128
struct gst_st40_rfc8331_meta {
109-
struct gst_st40_rfc8331_hdr1_le hdr;
129+
struct gst_st40_rfc8331_payload_first_word hdr;
110130
/** Data Count */
111131
guint16 data_count;
112132
/** Secondary Data Identification Word */

0 commit comments

Comments
 (0)