mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 00:36:51 +00:00
Code Issues 1 Projects Releases Wiki Activity

decklink: Increase section level of video sink/source element documentation

Browse source 
Should fix auto-generated follow-up sections like "Hierarchy" or
"Factory details" to be listed under the element name in the
table-of-contents of the document, instead of a stand-alone
"Duplex-Mode" section.

Also cleanup some spurious colon suffix after section names.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5625>
This commit is contained in:
Tobias Rapp 2023-11-08 16:59:48 +01:00
parent b1f3722530
commit 7ec3a97a70
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
subprojects/gst-plugins-bad/sys/decklink/gstdecklinkvideosink.cpp
View file

@ -32,7 +32,7 @@
* Playout a 1080p25 test-video to the SDI-Out of Card 0. Devices are numbered * Playout a 1080p25 test-video to the SDI-Out of Card 0. Devices are numbered
* starting with 0. * starting with 0.
* *
* # Duplex-Mode: * ## Duplex-Mode
* Certain DechLink Cards like the Duo2 or the Quad2 contain two or four * Certain DechLink Cards like the Duo2 or the Quad2 contain two or four
* independent SDI units with two connectors each. These units can operate either * independent SDI units with two connectors each. These units can operate either
* in half- or in full-duplex mode. * in half- or in full-duplex mode.
@ -40,7 +40,7 @@
* The Duplex-Mode of a Card can be configured using the `duplex-mode`-Property. * The Duplex-Mode of a Card can be configured using the `duplex-mode`-Property.
* Cards that to not support Duplex-Modes are not influenced by the property. * Cards that to not support Duplex-Modes are not influenced by the property.
* *
* ## Half-Duplex-Mode (default): * ### Half-Duplex-Mode (default)
* By default decklinkvideosink will configure them into half-duplex mode, so that * By default decklinkvideosink will configure them into half-duplex mode, so that
* each connector acts as if it were an independent DeckLink Card which can either * each connector acts as if it were an independent DeckLink Card which can either
* be used as an Input or as an Output. In this mode the Duo2 can be used as as 4 SDI * be used as an Input or as an Output. In this mode the Duo2 can be used as as 4 SDI
@ -67,7 +67,7 @@
* Playout a Test-Screen with colored Snow on the first and fourth unit * Playout a Test-Screen with colored Snow on the first and fourth unit
* (ie. the Connectors 1-4 of a Duo2 unit). * (ie. the Connectors 1-4 of a Duo2 unit).
* *
* ## Device-Number-Mapping in Half-Duplex-Mode * ### Device-Number-Mapping in Half-Duplex-Mode
* The device-number to connector-mapping is as follows for the Duo2 * The device-number to connector-mapping is as follows for the Duo2
* - `device-number=0` SDI1 * - `device-number=0` SDI1
* - `device-number=1` SDI3 * - `device-number=1` SDI3
@ -84,11 +84,11 @@
* - `device-number=6` SDI6 * - `device-number=6` SDI6
* - `device-number=7` SDI8 * - `device-number=7` SDI8
* *
* ## Full-Duplex-Mode: * ### Full-Duplex-Mode
* When operating in full-duplex mode, two connectors of a unit are combined to * When operating in full-duplex mode, two connectors of a unit are combined to
* a single device, performing keying with the second connection. * a single device, performing keying with the second connection.
* *
* ## Device-Number-Mapping in Full-Duplex-Mode * ### Device-Number-Mapping in Full-Duplex-Mode
* The device-number to connector-mapping in full-duplex-mode is as follows for the Duo2 * The device-number to connector-mapping in full-duplex-mode is as follows for the Duo2
* - `device-number=0` SDI1 primary, SDI2 secondary * - `device-number=0` SDI1 primary, SDI2 secondary
* - `device-number=1` SDI3 primaty, SDI4 secondary * - `device-number=1` SDI3 primaty, SDI4 secondary
@ -99,13 +99,13 @@
* - `device-number=2` SDI5 primary, SDI6 secondary * - `device-number=2` SDI5 primary, SDI6 secondary
* - `device-number=3` SDI7 primary, SDI8 secondary * - `device-number=3` SDI7 primary, SDI8 secondary
* *
* # Keying * ## Keying
* Keying is the process of overlaing Video with an Alpha-Channel on top of an * Keying is the process of overlaing Video with an Alpha-Channel on top of an
* existing Video-Stream. The Duo2 and Quad2-Cards can perform two different * existing Video-Stream. The Duo2 and Quad2-Cards can perform two different
* Keying-Modes when operated in full-duplex mode. Both modes expect Video with * Keying-Modes when operated in full-duplex mode. Both modes expect Video with
* an Alpha-Channel. * an Alpha-Channel.
* *
* ## Internal Keyer: * ### Internal Keyer
* In internal Keying-Mode the primary port becomes an Input and the secondary port * In internal Keying-Mode the primary port becomes an Input and the secondary port
* an Output. The unit overlays Video played back from the Computer onto the Input * an Output. The unit overlays Video played back from the Computer onto the Input
* and outputs the combined Video-Stream to the Output. * and outputs the combined Video-Stream to the Output.
@ -117,7 +117,7 @@
* decklinkvideosink device-number=0 duplex-mode=full keyer-mode=internal video-format=8bit-bgra mode=1080p25 * decklinkvideosink device-number=0 duplex-mode=full keyer-mode=internal video-format=8bit-bgra mode=1080p25
* ]| * ]|
* *
* ## External Keyer: * ### External Keyer
* In external Keying-Mode the primary port outputs the alpha-chanel as the * In external Keying-Mode the primary port outputs the alpha-chanel as the
* luma-value (key-channel). Transparent pixels are black, opaque pixels are white. * luma-value (key-channel). Transparent pixels are black, opaque pixels are white.
* The RGB-Component of the Video are output on the secondary channel. * The RGB-Component of the Video are output on the secondary channel.

10
subprojects/gst-plugins-bad/sys/decklink/gstdecklinkvideosrc.cpp
View file

@ -33,7 +33,7 @@
* Capturing 1080p25 video from the SDI-In of Card 0. Devices are numbered * Capturing 1080p25 video from the SDI-In of Card 0. Devices are numbered
* starting with 0. * starting with 0.
* *
* # Duplex-Mode: * ## Duplex-Mode
* Certain DechLink Cards like the Duo2 or the Quad2 contain two or four * Certain DechLink Cards like the Duo2 or the Quad2 contain two or four
* independent SDI units with two connectors each. These units can operate either * independent SDI units with two connectors each. These units can operate either
* in half- or in full-duplex mode. * in half- or in full-duplex mode.
@ -41,7 +41,7 @@
* The Duplex-Mode of a Card can be configured using the `duplex-mode`-Property. * The Duplex-Mode of a Card can be configured using the `duplex-mode`-Property.
* Cards that to not support Duplex-Modes are not influenced by the property. * Cards that to not support Duplex-Modes are not influenced by the property.
* *
* ## Half-Duplex-Mode (default): * ### Half-Duplex-Mode (default)
* By default decklinkvideosrc will configure them into half-duplex mode, so that * By default decklinkvideosrc will configure them into half-duplex mode, so that
* each connector acts as if it were an independent DeckLink Card which can either * each connector acts as if it were an independent DeckLink Card which can either
* be used as an Input or as an Output. In this mode the Duo2 can be used as as 4 SDI * be used as an Input or as an Output. In this mode the Duo2 can be used as as 4 SDI
@ -75,7 +75,7 @@
* Playout a Test-Screen with colored Snow on the first and fourth unit * Playout a Test-Screen with colored Snow on the first and fourth unit
* (ie. the Connectors 1-4 of a Duo2 unit). * (ie. the Connectors 1-4 of a Duo2 unit).
* *
* ## Device-Number-Mapping in Half-Duplex-Mode * ### Device-Number-Mapping in Half-Duplex-Mode
* The device-number to connector-mapping in half-duplex-mode is as follows for the Duo2 * The device-number to connector-mapping in half-duplex-mode is as follows for the Duo2
* - `device-number=0` SDI1 * - `device-number=0` SDI1
* - `device-number=1` SDI3 * - `device-number=1` SDI3
@ -92,7 +92,7 @@
* - `device-number=6` SDI6 * - `device-number=6` SDI6
* - `device-number=7` SDI8 * - `device-number=7` SDI8
* *
* ## Full-Duplex-Mode: * ### Full-Duplex-Mode
* When operating in full-duplex mode, two connectors of a unit are combined to * When operating in full-duplex mode, two connectors of a unit are combined to
* a single device, performing extra processing with the second connection. * a single device, performing extra processing with the second connection.
* *
@ -119,7 +119,7 @@
* Capturing Video on the primary port of device 0, output flipped version of the * Capturing Video on the primary port of device 0, output flipped version of the
* video on secondary port of the same device. * video on secondary port of the same device.
* *
* ## Device-Number-Mapping in Full-Duplex-Mode * ### Device-Number-Mapping in Full-Duplex-Mode
* The device-number to connector-mapping in full-duplex-mode is as follows for the Duo2 * The device-number to connector-mapping in full-duplex-mode is as follows for the Duo2
* - `device-number=0` SDI1 primary, SDI2 secondary * - `device-number=0` SDI1 primary, SDI2 secondary
* - `device-number=1` SDI3 primaty, SDI4 secondary * - `device-number=1` SDI3 primaty, SDI4 secondary