FaSTTUBe/GST-Tensordecoder-ov_ep
37
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ges: Update children properties documentation

Browse Source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5987>
This commit is contained in:
Thibault Saunier 2024-01-24 18:29:29 -03:00 committed by GStreamer Marge Bot
parent 84580ebf08
commit e8cb82137c
8 changed files with 560 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
subprojects/gst-editing-services/docs/libs/GESAudioTestSource-children-props.md
View File

@ -6,6 +6,42 @@ Value type: #gdouble
See #audiotestsrc:freq
#### `input-channels-reorder`
The positions configuration to use to reorder the input channels consecutively
according to their index.
Valid values:
- **Reorder the input channels using the default GStreamer order** (0) – gst
- **Reorder the input channels using the SMPTE order** (1) – smpte
- **Reorder the input channels using the CINE order** (2) – cine
- **Reorder the input channels using the AC3 order** (3) – ac3
- **Reorder the input channels using the AAC order** (4) – aac
- **Reorder and mix all input channels to a single mono channel** (5) – mono
- **Reorder and mix all input channels to a single left and a single right stereo channels alternately** (6) – alternate
See #audioconvert:input-channels-reorder
#### `input-channels-reorder-mode`
The input channels reordering mode used to apply the selected positions
configuration.
Valid values:
- **Never reorder the input channels** (0) – none
- **Reorder the input channels only if they are unpositioned** (1) – unpositioned
- **Always reorder the input channels according to the selected configuration** (2) – force
See #audioconvert:input-channels-reorder-mode
#### `mix-matrix`
Transformation matrix for input/output channels.
Value type: #GstValueArray
See #audioconvert:mix-matrix
#### `mute`
mute channel
@ -14,13 +50,13 @@ Value type: #gboolean
See #volume:mute
#### `volume`
#### `reverse`
volume factor, 1.0=100%
Whether to playback the source reverse or not
Value type: #gdouble
Value type: #gboolean
See #volume:volume
See #nlesource:reverse
#### `volume`
@ -30,3 +66,11 @@ Value type: #gdouble
See #audiotestsrc:volume
#### `volume`
volume factor, 1.0=100%
Value type: #gdouble
See #volume:volume

44
subprojects/gst-editing-services/docs/libs/GESAudioUriSource-children-props.md
View File

@ -1,3 +1,39 @@
#### `input-channels-reorder`
The positions configuration to use to reorder the input channels consecutively
according to their index.
Valid values:
- **Reorder the input channels using the default GStreamer order** (0) – gst
- **Reorder the input channels using the SMPTE order** (1) – smpte
- **Reorder the input channels using the CINE order** (2) – cine
- **Reorder the input channels using the AC3 order** (3) – ac3
- **Reorder the input channels using the AAC order** (4) – aac
- **Reorder and mix all input channels to a single mono channel** (5) – mono
- **Reorder and mix all input channels to a single left and a single right stereo channels alternately** (6) – alternate
See #audioconvert:input-channels-reorder
#### `input-channels-reorder-mode`
The input channels reordering mode used to apply the selected positions
configuration.
Valid values:
- **Never reorder the input channels** (0) – none
- **Reorder the input channels only if they are unpositioned** (1) – unpositioned
- **Always reorder the input channels according to the selected configuration** (2) – force
See #audioconvert:input-channels-reorder-mode
#### `mix-matrix`
Transformation matrix for input/output channels.
Value type: #GstValueArray
See #audioconvert:mix-matrix
#### `mute`
mute channel
@ -6,6 +42,14 @@ Value type: #gboolean
See #volume:mute
#### `reverse`
Whether to playback the source reverse or not
Value type: #gboolean
See #nlesource:reverse
#### `volume`
volume factor, 1.0=100%

299
subprojects/gst-editing-services/docs/libs/GESTimeOverlaySourceClip-children-props.md Normal file
View File

@ -0,0 +1,299 @@
#### `alpha`
alpha of the stream
Value type: #gdouble
#### `background-color`
Background color to use (big-endian ARGB)
Value type: #guint
See #videotestsrc:background-color
#### `fheight`
height of the source in float
Value type: #gfloat
#### `font-desc`
Pango font description of font to be used for rendering. See documentation of
pango_font_description_from_string for syntax.
Value type: #gchararray
See #GstBaseTextOverlay:font-desc
#### `foreground-color`
Foreground color to use (big-endian ARGB)
Value type: #guint
See #videotestsrc:foreground-color
#### `fposx`
x position of the stream in float
Value type: #gfloat
#### `fposy`
y position of the stream in float
Value type: #gfloat
#### `freq`
Frequency of test signal. The sample rate needs to be at least 2 times higher.
Value type: #gdouble
See #audiotestsrc:freq
#### `fwidth`
width of the source in float
Value type: #gfloat
#### `halignment`
Horizontal alignment of the text
Valid values:
- **left** (0) – left
- **center** (1) – center
- **right** (2) – right
- **Value_3** (3) – value-3
- **position** (4) – Absolute position clamped to canvas
See #GstBaseTextOverlay:halignment
#### `height`
height of the source
Value type: #gint
#### `input-channels-reorder`
The positions configuration to use to reorder the input channels consecutively
according to their index.
Valid values:
- **Reorder the input channels using the default GStreamer order** (0) – gst
- **Reorder the input channels using the SMPTE order** (1) – smpte
- **Reorder the input channels using the CINE order** (2) – cine
- **Reorder the input channels using the AC3 order** (3) – ac3
- **Reorder the input channels using the AAC order** (4) – aac
- **Reorder and mix all input channels to a single mono channel** (5) – mono
- **Reorder and mix all input channels to a single left and a single right stereo channels alternately** (6) – alternate
See #audioconvert:input-channels-reorder
#### `input-channels-reorder-mode`
The input channels reordering mode used to apply the selected positions
configuration.
Valid values:
- **Never reorder the input channels** (0) – none
- **Reorder the input channels only if they are unpositioned** (1) – unpositioned
- **Always reorder the input channels according to the selected configuration** (2) – force
See #audioconvert:input-channels-reorder-mode
#### `mix-matrix`
Transformation matrix for input/output channels.
Value type: #GstValueArray
See #audioconvert:mix-matrix
#### `mute`
mute channel
Value type: #gboolean
See #volume:mute
#### `operator`
Blending operator to use for blending this pad over the previous ones
Valid values:
- **Source** (0) – source
- **Over** (1) – over
- **Add** (2) – add
#### `pattern`
Type of test pattern to generate
Valid values:
- **SMPTE 100% color bars** (0) – smpte
- **Random (television snow)** (1) – snow
- **100% Black** (2) – black
- **100% White** (3) – white
- **Red** (4) – red
- **Green** (5) – green
- **Blue** (6) – blue
- **Checkers 1px** (7) – checkers-1
- **Checkers 2px** (8) – checkers-2
- **Checkers 4px** (9) – checkers-4
- **Checkers 8px** (10) – checkers-8
- **Circular** (11) – circular
- **Blink** (12) – blink
- **SMPTE 75% color bars** (13) – smpte75
- **Zone plate** (14) – zone-plate
- **Gamut checkers** (15) – gamut
- **Chroma zone plate** (16) – chroma-zone-plate
- **Solid color** (17) – solid-color
- **Moving ball** (18) – ball
- **SMPTE 100% color bars** (19) – smpte100
- **Bar** (20) – bar
- **Pinwheel** (21) – pinwheel
- **Spokes** (22) – spokes
- **Gradient** (23) – gradient
- **Colors** (24) – colors
- **SMPTE test pattern, RP 219 conformant** (25) – smpte-rp-219
See #videotestsrc:pattern
#### `posx`
x position of the stream
Value type: #gint
#### `posy`
y position of the stream
Value type: #gint
#### `reverse`
Whether to playback the source reverse or not
Value type: #gboolean
See #nlesource:reverse
#### `reverse`
Whether to playback the source reverse or not
Value type: #gboolean
See #nlesource:reverse
#### `text-width`
Resulting width of font rendering
Value type: #guint
See #GstBaseTextOverlay:text-width
#### `text-x`
Resulting X position of font rendering.
Value type: #gint
See #GstBaseTextOverlay:text-x
#### `text-y`
Resulting Y position of font rendering.
Value type: #gint
See #GstBaseTextOverlay:text-y
#### `time-mode`
What time to show
Valid values:
- **buffer-time** (0) – buffer-time
- **stream-time** (1) – stream-time
- **running-time** (2) – running-time
- **time-code** (3) – time-code
- **elapsed-running-time** (4) – elapsed-running-time
- **reference-timestamp** (5) – reference-timestamp
- **buffer-count** (6) – buffer-count
- **buffer-offset** (7) – buffer-offset
See #timeoverlay:time-mode
#### `valignment`
Vertical alignment of the text
Valid values:
- **baseline** (0) – baseline
- **bottom** (1) – bottom
- **top** (2) – top
- **position** (3) – Absolute position clamped to canvas
- **center** (4) – center
- **absolute** (5) – Absolute position
See #GstBaseTextOverlay:valignment
#### `video-direction`
Video direction: rotation and flipping
Valid values:
- **GST_VIDEO_ORIENTATION_IDENTITY** (0) – identity
- **GST_VIDEO_ORIENTATION_90R** (1) – 90r
- **GST_VIDEO_ORIENTATION_180** (2) – 180
- **GST_VIDEO_ORIENTATION_90L** (3) – 90l
- **GST_VIDEO_ORIENTATION_HORIZ** (4) – horiz
- **GST_VIDEO_ORIENTATION_VERT** (5) – vert
- **GST_VIDEO_ORIENTATION_UL_LR** (6) – ul-lr
- **GST_VIDEO_ORIENTATION_UR_LL** (7) – ur-ll
- **GST_VIDEO_ORIENTATION_AUTO** (8) – auto
- **GST_VIDEO_ORIENTATION_CUSTOM** (9) – custom
See #GstVideoDirection:video-direction
#### `volume`
Volume of test signal
Value type: #gdouble
See #audiotestsrc:volume
#### `volume`
volume factor, 1.0=100%
Value type: #gdouble
See #volume:volume
#### `width`
width of the source
Value type: #gint
#### `zorder`
z order of the stream.
**WARNING**: Setting it manually overrides the #GESLayer:priority and should be
used very carefully
Value type: #guint

62
subprojects/gst-editing-services/docs/libs/GESTitleSource-children-props.md
View File

@ -12,6 +12,20 @@ Value type: #guint
See #GstBaseTextOverlay:color
#### `draw-shadow`
Whether to draw shadow
Value type: #gboolean
See #GstBaseTextOverlay:draw-shadow
#### `fheight`
height of the source in float
Value type: #gfloat
#### `font-desc`
Pango font description of font to be used for rendering. See documentation of
@ -29,6 +43,24 @@ Value type: #guint
See #videotestsrc:foreground-color
#### `fposx`
x position of the stream in float
Value type: #gfloat
#### `fposy`
y position of the stream in float
Value type: #gfloat
#### `fwidth`
width of the source in float
Value type: #gfloat
#### `halignment`
Horizontal alignment of the text
@ -37,8 +69,8 @@ Valid values:
- **left** (0) – left
- **center** (1) – center
- **right** (2) – right
- **Value_3** (3) – value-3
- **position** (4) – Absolute position clamped to canvas
- **absolute** (5) – Absolute position
See #GstBaseTextOverlay:halignment
@ -48,6 +80,15 @@ height of the source
Value type: #gint
#### `operator`
Blending operator to use for blending this pad over the previous ones
Valid values:
- **Source** (0) – source
- **Over** (1) – over
- **Add** (2) – add
#### `outline-color`
Color to use for outline the text (big-endian ARGB).
@ -86,6 +127,7 @@ Valid values:
- **Spokes** (22) – spokes
- **Gradient** (23) – gradient
- **Colors** (24) – colors
- **SMPTE test pattern, RP 219 conformant** (25) – smpte-rp-219
See #videotestsrc:pattern
@ -101,6 +143,14 @@ y position of the stream
Value type: #gint
#### `reverse`
Whether to playback the source reverse or not
Value type: #gboolean
See #nlesource:reverse
#### `shaded-background`
Whether to shade the background under the text area
@ -143,7 +193,7 @@ See #GstBaseTextOverlay:text-x
#### `text-y`
Resulting X position of font rendering.
Resulting Y position of font rendering.
Value type: #gint
@ -219,3 +269,11 @@ Value type: #gdouble
See #GstBaseTextOverlay:ypos
#### `zorder`
z order of the stream.
**WARNING**: Setting it manually overrides the #GESLayer:priority and should be
used very carefully
Value type: #guint

16
subprojects/gst-editing-services/docs/libs/GESTransitionClip-children-props.md
View File

@ -1,5 +1,13 @@
#### `border`
The border width of the transition
Value type: #gint
See #smptealpha:border
#### `border`
The border width
Value type: #guint
@ -8,6 +16,14 @@ See #GESVideoTransition:border
#### `invert`
Invert transition mask
Value type: #gboolean
See #smptealpha:invert
#### `invert`
Whether the transition is inverted
Value type: #gboolean

50
subprojects/gst-editing-services/docs/libs/GESVideoTestSource-children-props.md
View File

@ -12,6 +12,12 @@ Value type: #guint
See #videotestsrc:background-color
#### `fheight`
height of the source in float
Value type: #gfloat
#### `foreground-color`
Foreground color to use (big-endian ARGB)
@ -20,12 +26,39 @@ Value type: #guint
See #videotestsrc:foreground-color
#### `fposx`
x position of the stream in float
Value type: #gfloat
#### `fposy`
y position of the stream in float
Value type: #gfloat
#### `fwidth`
width of the source in float
Value type: #gfloat
#### `height`
height of the source
Value type: #gint
#### `operator`
Blending operator to use for blending this pad over the previous ones
Valid values:
- **Source** (0) – source
- **Over** (1) – over
- **Add** (2) – add
#### `pattern`
Type of test pattern to generate
@ -56,6 +89,7 @@ Valid values:
- **Spokes** (22) – spokes
- **Gradient** (23) – gradient
- **Colors** (24) – colors
- **SMPTE test pattern, RP 219 conformant** (25) – smpte-rp-219
See #videotestsrc:pattern
@ -71,6 +105,14 @@ y position of the stream
Value type: #gint
#### `reverse`
Whether to playback the source reverse or not
Value type: #gboolean
See #nlesource:reverse
#### `video-direction`
Video direction: rotation and flipping
@ -95,3 +137,11 @@ width of the source
Value type: #gint
#### `zorder`
z order of the stream.
**WARNING**: Setting it manually overrides the #GESLayer:priority and should be
used very carefully
Value type: #guint

60
subprojects/gst-editing-services/docs/libs/GESVideoUriSource-children-props.md
View File

@ -4,17 +4,29 @@ alpha of the stream
Value type: #gdouble
#### `fields`
#### `fheight`
Fields to use for deinterlacing
height of the source in float
Valid values:
- **All fields** (0) – all
- **Top fields only** (1) – top
- **Bottom fields only** (2) – bottom
- **Automatically detect** (3) – auto
Value type: #gfloat
See #deinterlace:fields
#### `fposx`
x position of the stream in float
Value type: #gfloat
#### `fposy`
y position of the stream in float
Value type: #gfloat
#### `fwidth`
width of the source in float
Value type: #gfloat
#### `height`
@ -22,17 +34,14 @@ height of the source
Value type: #gint
#### `mode`
#### `operator`
Deinterlace Mode
Blending operator to use for blending this pad over the previous ones
Valid values:
- **Auto detection (best effort)** (0) – auto
- **Force deinterlacing** (1) – interlaced
- **Run in passthrough mode** (2) – disabled
- **Auto detection (strict)** (3) – auto-strict
See #deinterlace:mode
- **Source** (0) – source
- **Over** (1) – over
- **Add** (2) – add
#### `posx`
@ -46,16 +55,13 @@ y position of the stream
Value type: #gint
#### `tff`
#### `reverse`
Deinterlace top field first
Whether to playback the source reverse or not
Valid values:
- **Auto detection** (0) – auto
- **Top field first** (1) – tff
- **Bottom field first** (2) – bff
Value type: #gboolean
See #deinterlace:tff
See #nlesource:reverse
#### `video-direction`
@ -81,3 +87,11 @@ width of the source
Value type: #gint
#### `zorder`
z order of the stream.
**WARNING**: Setting it manually overrides the #GESLayer:priority and should be
used very carefully
Value type: #guint

11
subprojects/gst-editing-services/docs/libs/document-children-props.py
View File

@ -9,6 +9,7 @@ import gi
import os
import sys
import textwrap
from itertools import chain
gi.require_version("Gst", "1.0")
gi.require_version("GObject", "2.0")
@ -18,8 +19,8 @@ from gi.repository import Gst, GES, GObject
overrides = {
"GstFramePositioner": False,
"GstBaseTextOverlay": "timeoverlay",
"GstVideoDirection": "videoflip",
"GstBaseTextOverlay": "GstBaseTextOverlay", # Use the actual class name for proper linking
"GstVideoDirection": "GstVideoDirection", # Use the actual interface name for proper linking
"GESVideoTestSource": "GESVideoTestSource",
"GESVideoTransition": "GESVideoTransition",
}
@ -33,6 +34,7 @@ if __name__ == "__main__":
layer = tl.append_layer()
elements = []
def add_clip(c, add=True, override_name=None):
c.props.duration = Gst.SECOND
c.props.start = layer.get_duration()
@ -63,13 +65,13 @@ if __name__ == "__main__":
prefix = '#### `%s`\n\n' % (prop.name)
prefix_len = len(prefix)
lines = textwrap.wrap(prop.blurb, width=80)
lines = [i for i in chain.from_iterable([textwrap.wrap(t, width=80) for t in prop.blurb.split('\n')])]
doc = prefix + lines[0]
if GObject.type_is_a(prop, GObject.ParamSpecEnum.__gtype__):
lines += ["", "Valid values:"]
for value in prop.enum_class.__enum_values__.values():
for value in prop.enum_class.__enum_values__.values():
lines.append(" - **%s** (%d) – %s" % (value.value_name,
int(value), value.value_nick))
else:
@ -86,5 +88,4 @@ if __name__ == "__main__":
doc += '\n'
doc += '\n'.join(lines[1:])
print(doc + "\n", file=f)