mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-06-05 06:58:56 +00:00
Code Issues 1 Projects Releases Wiki Activity

command-line-formatter: Reindent command line options array

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-editing-services/-/merge_requests/227>
This commit is contained in:
Thibault Saunier 2021-01-15 08:49:20 -03:00
parent d7764275d8
commit ba763cfaf3
1 changed files with 90 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

156
ges/ges-command-line-formatter.c
View file

@ -79,40 +79,43 @@ typedef struct
/* *INDENT-OFF* */ /* *INDENT-OFF* */
static GESCommandLineOption options[] = { static GESCommandLineOption options[] = {
{"clip", 'c', (ActionFromStructureFunc) _ges_command_line_formatter_add_clip, {
"<clip uri>", .long_name = "clip",
"Adds a clip in the timeline. " .short_name='c',
"See documentation for the --track-types option to ges-launch-1.0, as it " .callback=(ActionFromStructureFunc) _ges_command_line_formatter_add_clip,
" will affect the result of this command.", .synopsis="<clip uri>",
" ges-launch-1.0 +clip /path/to/media\n\n" .description="Adds a clip in the timeline. "
"This will simply play the sample from its beginning to its end.\n\n" "See documentation for the --track-types option to ges-launch-1.0, as it "
" ges-launch-1.0 +clip /path/to/media inpoint=4.0\n\n" " will affect the result of this command.",
"Assuming 'media' is a 10 second long media sample, this will play the sample\n" .examples=" ges-launch-1.0 +clip /path/to/media\n\n"
"from the 4th second to the 10th, resulting in a 6-seconds long playback.\n\n" "This will simply play the sample from its beginning to its end.\n\n"
" ges-launch-1.0 +clip /path/to/media inpoint=4.0 duration=2.0 start=4.0\n\n" " ges-launch-1.0 +clip /path/to/media inpoint=4.0\n\n"
"Assuming \"media\" is an audio video sample longer than 6 seconds, this will play\n" "Assuming 'media' is a 10 second long media sample, this will play the sample\n"
"a black frame and silence for 4 seconds, then the sample from its 4th second to\n" "from the 4th second to the 10th, resulting in a 6-seconds long playback.\n\n"
"its sixth second, resulting in a 6-seconds long playback.\n\n" " ges-launch-1.0 +clip /path/to/media inpoint=4.0 duration=2.0 start=4.0\n\n"
" ges-launch-1.0 --track-types=audio +clip /path/to/media\n\n" "Assuming \"media\" is an audio video sample longer than 6 seconds, this will play\n"
"Assuming \"media\" is an audio video sample, this will only play the audio of the\n" "a black frame and silence for 4 seconds, then the sample from its 4th second to\n"
"sample in its entirety.\n\n" "its sixth second, resulting in a 6-seconds long playback.\n\n"
" ges-launch-1.0 +clip /path/to/media1 layer=1 set-alpha 0.9 +clip /path/to/media2 layer=0\n\n" " ges-launch-1.0 --track-types=audio +clip /path/to/media\n\n"
"Assume media1 and media2 both contain audio and video and last for 10 seconds.\n\n" "Assuming \"media\" is an audio video sample, this will only play the audio of the\n"
"This will first add media1 in a new layer of \"priority\" 1, thus implicitly\n" "sample in its entirety.\n\n"
"creating a layer of \"priority\" 0, the start of the clip will be 0 as no clip\n" " ges-launch-1.0 +clip /path/to/media1 layer=1 set-alpha 0.9 +clip /path/to/media2 layer=0\n\n"
"had been added in that layer before.\n\n" "Assume media1 and media2 both contain audio and video and last for 10 seconds.\n\n"
"It will then add media2 in the layer of \"priority\" 0 which was created\n" "This will first add media1 in a new layer of \"priority\" 1, thus implicitly\n"
"previously, the start of this new clip will also be 0 as no clip has been added\n" "creating a layer of \"priority\" 0, the start of the clip will be 0 as no clip\n"
"in this layer before.\n\n" "had been added in that layer before.\n\n"
"Both clips will thus overlap on two layers for 10 seconds.\n\n" "It will then add media2 in the layer of \"priority\" 0 which was created\n"
"The \"alpha\" property of the second clip will finally be set to a value of 0.9.\n\n" "previously, the start of this new clip will also be 0 as no clip has been added\n"
"All this will result in a 10 seconds playback, where media2 is barely visible\n" "in this layer before.\n\n"
"through media1, which is nearly opaque. If alpha was set to 0.5, both clips\n" "Both clips will thus overlap on two layers for 10 seconds.\n\n"
"would be equally visible, and if it was set to 0.0, media1 would be invisible\n" "The \"alpha\" property of the second clip will finally be set to a value of 0.9.\n\n"
"and media2 completely opaque.\n", "All this will result in a 10 seconds playback, where media2 is barely visible\n"
{ "through media1, which is nearly opaque. If alpha was set to 0.5, both clips\n"
"would be equally visible, and if it was set to 0.0, media1 would be invisible\n"
"and media2 completely opaque.\n",
.properties={
{ {
"uri", "u", 0, "asset-id", "uri", 0, 0, "asset-id",
"The URI of the media file." "The URI of the media file."
}, },
{ {
@ -120,7 +123,7 @@ static GESCommandLineOption options[] = {
"The name of the clip, can be used as an ID later." "The name of the clip, can be used as an ID later."
}, },
{ {
"start", "s",GST_TYPE_CLOCK_TIME, NULL, "start", "s", GST_TYPE_CLOCK_TIME, NULL,
"The starting position of the clip in the timeline." "The starting position of the clip in the timeline."
}, },
{ {
@ -142,13 +145,16 @@ static GESCommandLineOption options[] = {
{NULL, 0, 0, NULL, FALSE}, {NULL, 0, 0, NULL, FALSE},
}, },
}, },
{"effect", 'e', (ActionFromStructureFunc) _ges_command_line_formatter_add_effect, {
"<effect bin description>", .long_name="effect",
"Adds an effect as specified by 'bin-description', similar to gst-launch-style" .short_name='e',
" pipeline description, without setting properties (see `set-<property-name>` for information" .callback=(ActionFromStructureFunc) _ges_command_line_formatter_add_effect,
" about how to set properties).", .synopsis="<effect bin description>",
" ges-launch-1.0 +clip /path/to/media +effect \"agingtv\"\n\n" .description="Adds an effect as specified by 'bin-description', similar to gst-launch-style"
"This will apply the agingtv effect to \"media\" and play it back.", " pipeline description, without setting properties (see `set-<property-name>` for information"
" about how to set properties).",
.examples=" ges-launch-1.0 +clip /path/to/media +effect \"agingtv\"\n\n"
"This will apply the agingtv effect to \"media\" and play it back.",
{ {
{ {
"bin-description", "d", 0, "asset-id", "bin-description", "d", 0, "asset-id",
@ -170,12 +176,16 @@ static GESCommandLineOption options[] = {
{NULL, NULL, 0, NULL, FALSE}, {NULL, NULL, 0, NULL, FALSE},
}, },
}, },
{"test-clip", 0, (ActionFromStructureFunc) _ges_command_line_formatter_add_test_clip, {
"<test clip pattern>", "Add a test clip in the timeline.", .long_name="test-clip",
NULL, .short_name=0,
{ .callback=(ActionFromStructureFunc) _ges_command_line_formatter_add_test_clip,
.synopsis="<test clip pattern>",
.description="Add a test clip in the timeline.",
.examples=NULL,
.properties={
{ {
"pattern", "p", 0, NULL, "vpattern", "p", 0, NULL,
"The testsource pattern name." "The testsource pattern name."
}, },
{ {
@ -201,9 +211,14 @@ static GESCommandLineOption options[] = {
{NULL, 0, 0, NULL, FALSE}, {NULL, 0, 0, NULL, FALSE},
}, },
}, },
{"title", 'c', (ActionFromStructureFunc) _ges_command_line_formatter_add_title_clip, {
"<title text>", "Adds a clip in the timeline.", NULL, .long_name="title",
{ .short_name='c',
.callback=(ActionFromStructureFunc) _ges_command_line_formatter_add_title_clip,
.synopsis="<title text>",
.description="Adds a clip in the timeline.",
.examples=NULL,
.properties={
{ {
"text", "t", 0, NULL, "text", "t", 0, NULL,
"The text to be used as title." "The text to be used as title."
@ -235,9 +250,15 @@ static GESCommandLineOption options[] = {
{NULL, 0, 0, NULL, FALSE}, {NULL, 0, 0, NULL, FALSE},
}, },
}, },
{"track", 't', (ActionFromStructureFunc) _ges_command_line_formatter_add_track, {
"<track type>", "Adds a track to the timeline.", NULL, .long_name="track",
{ .short_name='t',
.callback=(ActionFromStructureFunc) _ges_command_line_formatter_add_track,
.synopsis="<track type>",
.description="Adds a track to the timeline.",
.examples=NULL,
.properties={
{"track-type", 0, 0, NULL, NULL},
{ {
"restrictions", "r", 0, NULL, "restrictions", "r", 0, NULL,
"The restriction caps to set on the track." "The restriction caps to set on the track."
@ -246,20 +267,23 @@ static GESCommandLineOption options[] = {
}, },
}, },
{ {
"set-", 0, NULL, .long_name="set-",
"<property name> <value>", "Set a property on the last added element." .short_name=0,
" Any child property that exists on the previously added element" .callback=NULL,
" can be used as <property name>" .synopsis="<property name> <value>",
"By default, set-<property-name> will lookup the property on the last added" .description="Set a property on the last added element."
"object.", " Any child property that exists on the previously added element"
" ges-launch-1.0 +clip /path/to/media set-alpha 0.3\n\n" " can be used as <property name>"
"This will set the alpha property on \"media\" then play it back, assuming \"media\"" "By default, set-<property-name> will lookup the property on the last added"
"contains a video stream.\n\n" "object.",
" ges-launch-1.0 +clip /path/to/media +effect \"agingtv\" set-dusts false\n\n" .examples=" ges-launch-1.0 +clip /path/to/media set-alpha 0.3\n\n"
"This will set the \"dusts\" property of the agingtv to false and play the\n" "This will set the alpha property on \"media\" then play it back, assuming \"media\""
"timeline back.", "contains a video stream.\n\n"
{ " ges-launch-1.0 +clip /path/to/media +effect \"agingtv\" set-dusts false\n\n"
{NULL, NULL, 0, NULL, FALSE}, "This will set the \"dusts\" property of the agingtv to false and play the\n"
"timeline back.",
.properties={
{NULL, 0, 0, NULL, FALSE},
}, },
}, },
}; };