From ef53eabee3f5323be3b0dcf11d3672752900ef0e Mon Sep 17 00:00:00 2001 From: Luis de Bethencourt Date: Tue, 15 Dec 2015 11:59:00 +0000 Subject: [PATCH] geometrictransform: add headers with example launch lines Add description headers for all geometrictransform elements so we can have gst-launch-1.0 example launch lines for all of them. --- gst/geometrictransform/gstbulge.c | 15 +++++++++++++++ gst/geometrictransform/gstcircle.c | 14 ++++++++++++++ gst/geometrictransform/gstdiffuse.c | 14 ++++++++++++++ gst/geometrictransform/gstfisheye.c | 15 +++++++++++++++ gst/geometrictransform/gstkaleidoscope.c | 14 ++++++++++++++ gst/geometrictransform/gstmarble.c | 14 ++++++++++++++ gst/geometrictransform/gstmirror.c | 15 +++++++++++++++ gst/geometrictransform/gstperspective.c | 14 ++++++++++++++ gst/geometrictransform/gstpinch.c | 13 +++++++++++++ gst/geometrictransform/gstrotate.c | 13 +++++++++++++ gst/geometrictransform/gstsphere.c | 13 +++++++++++++ gst/geometrictransform/gstsquare.c | 14 ++++++++++++++ gst/geometrictransform/gststretch.c | 14 ++++++++++++++ gst/geometrictransform/gsttunnel.c | 15 +++++++++++++++ gst/geometrictransform/gsttwirl.c | 13 +++++++++++++ gst/geometrictransform/gstwaterripple.c | 13 +++++++++++++ 16 files changed, 223 insertions(+) diff --git a/gst/geometrictransform/gstbulge.c b/gst/geometrictransform/gstbulge.c index 4baf223..98a7849 100644 --- a/gst/geometrictransform/gstbulge.c +++ b/gst/geometrictransform/gstbulge.c @@ -41,6 +41,21 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:element-bulge + * @see_also: geometrictransform + * + * Bugle is a geometric image transform element. It adds a protuberance in the + * center point. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! bulge ! videoconvert ! autovideosink + * ]| + * + */ + #ifdef HAVE_CONFIG_H # include #endif diff --git a/gst/geometrictransform/gstcircle.c b/gst/geometrictransform/gstcircle.c index cf6ab01..da4f48b 100644 --- a/gst/geometrictransform/gstcircle.c +++ b/gst/geometrictransform/gstcircle.c @@ -47,6 +47,20 @@ * his code. */ +/** + * SECTION:element-circle + * @see_also: geometrictransform + * + * Circle is a geometric image transform element. It warps the picture into an + * arc shaped form. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! circle ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstdiffuse.c b/gst/geometrictransform/gstdiffuse.c index 97225c1..03009c7 100644 --- a/gst/geometrictransform/gstdiffuse.c +++ b/gst/geometrictransform/gstdiffuse.c @@ -47,6 +47,20 @@ * his code. */ +/** + * SECTION:element-diffuse + * @see_also: geometrictransform + * + * Diffuse is a geometric image transform element. It diffuses the image by + * moving its pixels in random directions. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! diffuse ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstfisheye.c b/gst/geometrictransform/gstfisheye.c index 0d9f2b9..d08069c 100644 --- a/gst/geometrictransform/gstfisheye.c +++ b/gst/geometrictransform/gstfisheye.c @@ -41,6 +41,21 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:element-fisheye + * @see_also: geometrictransform + * + * Fisheye is a geometric image transform element. It simulates a fisheye lens + * by zooming on the center of the image and compressing the edges. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! fisheye ! videoconvert ! autovideosink + * ]| + * + */ + #ifdef HAVE_CONFIG_H # include #endif diff --git a/gst/geometrictransform/gstkaleidoscope.c b/gst/geometrictransform/gstkaleidoscope.c index 5546558..bb1bdfc 100644 --- a/gst/geometrictransform/gstkaleidoscope.c +++ b/gst/geometrictransform/gstkaleidoscope.c @@ -47,6 +47,20 @@ * his code. */ +/** + * SECTION:element-kaleidoscope + * @see_also: geometrictransform + * + * The kaleidscope element applies 'kaleidoscope' geometric transform to the + * image. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! kaleidoscope ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstmarble.c b/gst/geometrictransform/gstmarble.c index a268a3d..6898453 100644 --- a/gst/geometrictransform/gstmarble.c +++ b/gst/geometrictransform/gstmarble.c @@ -47,6 +47,20 @@ * his code. */ +/** + * SECTION:element-marble + * @see_also: geometrictransform + * + * Marble is a geometric image transform element. It applies a marbling effect + * to the image. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! marble ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstmirror.c b/gst/geometrictransform/gstmirror.c index dceb3c5..df18234 100644 --- a/gst/geometrictransform/gstmirror.c +++ b/gst/geometrictransform/gstmirror.c @@ -41,6 +41,21 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:element-mirror + * @see_also: geometrictransform + * + * Mirror is a geometric transform element. It splits the image into two halves + * and reflects one over each other. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! mirror ! videoconvert ! autovideosink + * ]| + * + */ + #ifdef HAVE_CONFIG_H # include #endif diff --git a/gst/geometrictransform/gstperspective.c b/gst/geometrictransform/gstperspective.c index e9ed230..bafa1fc 100644 --- a/gst/geometrictransform/gstperspective.c +++ b/gst/geometrictransform/gstperspective.c @@ -47,6 +47,20 @@ * http://docs.oracle.com/cd/E17802_01/products/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/PerspectiveTransform.html */ +/** + * SECTION:element-perspective + * @see_also: geometrictransform + * + * The perspective element applies a 2D perspective transform. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! perspective ! videoconvert ! autovideosink + * ]| + * + */ + /* FIXME: suppress warnings for deprecated API such as GValueArray * with newer GLib versions (>= 2.31.0) * diff --git a/gst/geometrictransform/gstpinch.c b/gst/geometrictransform/gstpinch.c index 296b84a..d68dcd1 100644 --- a/gst/geometrictransform/gstpinch.c +++ b/gst/geometrictransform/gstpinch.c @@ -47,6 +47,19 @@ * his code. */ +/** + * SECTION:element-pinch + * @see_also: geometrictransform + * + * Pinch applies a 'pinch' geometric transform to the image. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! pinch ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstrotate.c b/gst/geometrictransform/gstrotate.c index 693c898..1e03339 100644 --- a/gst/geometrictransform/gstrotate.c +++ b/gst/geometrictransform/gstrotate.c @@ -47,6 +47,19 @@ * his code. */ +/** + * SECTION:element-rotate + * @see_also: geometrictransform + * + * The rotate element transforms the image by rotating it by a specified angle. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! rotate angle=0.78 ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstsphere.c b/gst/geometrictransform/gstsphere.c index a425470..5f39a47 100644 --- a/gst/geometrictransform/gstsphere.c +++ b/gst/geometrictransform/gstsphere.c @@ -47,6 +47,19 @@ * his code. */ +/** + * SECTION:element-sphere + * @see_also: geometrictransform + * + * The sphere element applies a 'sphere' geometric transform to the image. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! sphere ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstsquare.c b/gst/geometrictransform/gstsquare.c index ba0d2bf..4b044f1 100644 --- a/gst/geometrictransform/gstsquare.c +++ b/gst/geometrictransform/gstsquare.c @@ -41,6 +41,20 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:element-square + * @see_also: geometrictransform + * + * The square element distorts the center part of the image into a square. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! square zoom=100 ! videoconvert ! autovideosink + * ]| + * + */ + #ifdef HAVE_CONFIG_H # include #endif diff --git a/gst/geometrictransform/gststretch.c b/gst/geometrictransform/gststretch.c index f0c7998..61eed37 100644 --- a/gst/geometrictransform/gststretch.c +++ b/gst/geometrictransform/gststretch.c @@ -41,6 +41,20 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:element-stretch + * @see_also: geometrictransform + * + * The stretch element stretches the image in a circle around the center point. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! stretch ! videoconvert ! autovideosink + * ]| + * + */ + #ifdef HAVE_CONFIG_H # include #endif diff --git a/gst/geometrictransform/gsttunnel.c b/gst/geometrictransform/gsttunnel.c index a71f0ef..94b6070 100644 --- a/gst/geometrictransform/gsttunnel.c +++ b/gst/geometrictransform/gsttunnel.c @@ -41,6 +41,21 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:element-tunnel + * @see_also: geometrictransform + * + * Tunnel is a geometric image transform element. It applies a light tunnel + * effect. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! tunnel ! videoconvert ! autovideosink + * ]| + * + */ + #ifdef HAVE_CONFIG_H # include #endif diff --git a/gst/geometrictransform/gsttwirl.c b/gst/geometrictransform/gsttwirl.c index 33222c8..962d3ba 100644 --- a/gst/geometrictransform/gsttwirl.c +++ b/gst/geometrictransform/gsttwirl.c @@ -47,6 +47,19 @@ * his code. */ +/** + * SECTION:element-twirl + * @see_also: geometrictransform + * + * The twirl element twists the image from the center out. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! twirl ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include diff --git a/gst/geometrictransform/gstwaterripple.c b/gst/geometrictransform/gstwaterripple.c index 4daff2a..96af6e8 100644 --- a/gst/geometrictransform/gstwaterripple.c +++ b/gst/geometrictransform/gstwaterripple.c @@ -47,6 +47,19 @@ * his code. */ +/** + * SECTION:element-waterripple + * @see_also: geometrictransform + * + * The waterripple element creates a water ripple effect on the image. + * + * + * Example launch line + * |[ + * gst-launch-1.0 -v videotestsrc ! waterripple ! videoconvert ! autovideosink + * ]| + * + */ #ifdef HAVE_CONFIG_H # include -- 2.7.4