diff --git a/ext/aom/gstav1dec.c b/ext/aom/gstav1dec.c index 6e0a9bd5db..dcc4955392 100644 --- a/ext/aom/gstav1dec.c +++ b/ext/aom/gstav1dec.c @@ -21,12 +21,11 @@ * * AV1 Decoder. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 -v filesrc location=videotestsrc.webm ! matroskademux ! av1dec ! videoconvert ! videoscale ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/aom/gstav1enc.c b/ext/aom/gstav1enc.c index c8bca7de5e..6dd214710a 100644 --- a/ext/aom/gstav1enc.c +++ b/ext/aom/gstav1enc.c @@ -21,12 +21,11 @@ * * AV1 Encoder. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc num-buffers=50 ! av1enc ! webmmux ! filesink location=av1.webm * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/closedcaption/sliced.h b/ext/closedcaption/sliced.h index 1b209d4ca5..e5c24b66e0 100644 --- a/ext/closedcaption/sliced.h +++ b/ext/closedcaption/sliced.h @@ -178,10 +178,11 @@ extern "C" { * "625-line television Wide Screen Signalling (WSS)". * * vbi_sliced payload: - * 
+ * ```
  * Byte         0                  1
  *       msb         lsb  msb             lsb
- * bit   7 6 5 4 3 2 1 0  x x 13 12 11 10 9 8
+ * bit 7 6 5 4 3 2 1 0 x x 13 12 11 10 9 8 + * ``` * according to EN 300 294, Table 1, lsb first transmitted. */ #define VBI_SLICED_WSS_625 0x00000400 @@ -280,11 +281,11 @@ extern "C" { * Reference: EIA-J CPR-1204 * * vbi_sliced payload: - * 
+ * ```
  * Byte         0                    1                  2
  *       msb         lsb  msb               lsb  msb             lsb
  * bit   7 6 5 4 3 2 1 0  15 14 13 12 11 10 9 8  x x x x 19 18 17 16
- *
+ * ``` */ #define VBI_SLICED_WSS_CPR1204 0x00000800 diff --git a/ext/colormanagement/gstlcms.c b/ext/colormanagement/gstlcms.c index 831af2e603..acb9de99e0 100644 --- a/ext/colormanagement/gstlcms.c +++ b/ext/colormanagement/gstlcms.c @@ -28,15 +28,14 @@ * frames using the given ICC (International Color Consortium) profiles. * Falls back to internal sRGB profile if no ICC file is specified in property. * - * - * Example launch line - * (write everything in one line, without the backslash characters) + * ## Example launch line + * + * (write everything in one line, without the backslash characters) * |[ * gst-launch-1.0 filesrc location=photo_camera.png ! pngdec ! \ * videoconvert ! lcms input-profile=sRGB.icc dest-profile=printer.icc \ * pngenc ! filesink location=photo_print.png * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/curl/gstcurlhttpsrc.c b/ext/curl/gstcurlhttpsrc.c index b11521980c..adecfcbd8d 100644 --- a/ext/curl/gstcurlhttpsrc.c +++ b/ext/curl/gstcurlhttpsrc.c @@ -59,8 +59,8 @@ * If the "http_proxy" environment variable is set, its value is used. * The #GstCurlHttpSrc:proxy property can be used to override the default. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 curlhttpsrc location=http://127.0.1.1/index.html ! fakesink dump=1 * ]| The above pipeline reads a web page from the local machine using HTTP and @@ -70,7 +70,6 @@ * ]| The above pipeline will start up a DASH streaming session from the given * MPD file. This requires GStreamer to have been built with dashdemux from * gst-plugins-bad. - * */ /* diff --git a/ext/modplug/gstmodplug.cc b/ext/modplug/gstmodplug.cc index b5fbcb2527..a106f8c7f8 100644 --- a/ext/modplug/gstmodplug.cc +++ b/ext/modplug/gstmodplug.cc @@ -31,12 +31,11 @@ * Modplug uses the modplug * library to decode tracked music in the MOD/S3M/XM/IT and related formats. * - * - * Example pipeline + * ## Example pipeline + * * |[ * gst-launch-1.0 -v filesrc location=1990s-nostalgia.xm ! modplug ! audioconvert ! alsasink * ]| Play a FastTracker xm file. - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/mpeg2enc/gstmpeg2enc.cc b/ext/mpeg2enc/gstmpeg2enc.cc index 61bea2c3ab..a86804d7bd 100644 --- a/ext/mpeg2enc/gstmpeg2enc.cc +++ b/ext/mpeg2enc/gstmpeg2enc.cc @@ -31,13 +31,13 @@ * and on the various available parameters in the documentation * of the mpeg2enc tool in particular, which shares options with this element. * - * - * Example pipeline + * ## Example pipeline + * * |[ * gst-launch-1.0 videotestsrc num-buffers=1000 ! mpeg2enc ! filesink location=videotestsrc.m1v * ]| This example pipeline will encode a test video source to a an MPEG1 * elementary stream (with Generic MPEG1 profile). - * + * * Likely, the #GstMpeg2enc:format property * is most important, as it selects the type of MPEG stream that is produced. * In particular, default property values are dependent on the format, @@ -45,12 +45,11 @@ * Note that the (S)VCD profiles also restrict the image size, so some scaling * may be needed to accomodate this. The so-called generic profiles (as used * in the example above) allow most parameters to be adjusted. - * + * * |[ * gst-launch-1.0 videotestsrc num-buffers=1000 ! videoscale ! mpeg2enc format=1 norm=p ! filesink location=videotestsrc.m1v * ]| This will produce an MPEG1 profile stream according to VCD2.0 specifications * for PAL #GstMpeg2enc:norm (as the image height is dependent on video norm). - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/mplex/gstmplex.cc b/ext/mplex/gstmplex.cc index 7f7b4ecae7..f78e5bd340 100644 --- a/ext/mplex/gstmplex.cc +++ b/ext/mplex/gstmplex.cc @@ -32,19 +32,17 @@ * and the man-page of the mplex tool documents the properties of this element, * which are shared with the mplex tool. * - * - * Example pipeline + * ## Example pipeline + * * |[ * gst-launch-1.0 -v videotestsrc num-buffers=1000 ! mpeg2enc ! mplex ! filesink location=videotestsrc.mpg * ]| This example pipeline will encode a test video source to an * MPEG1 elementary stream and multiplexes this to an MPEG system stream. - * + * * If several streams are being multiplexed, there should (as usual) be * a queue in each stream, and due to mplex' buffering the capacities of these * may have to be set to a few times the default settings to prevent the * pipeline stalling. - * - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstcameracalibrate.cpp b/ext/opencv/gstcameracalibrate.cpp index b44a07bd5a..ccf7aff447 100644 --- a/ext/opencv/gstcameracalibrate.cpp +++ b/ext/opencv/gstcameracalibrate.cpp @@ -57,12 +57,11 @@ * * Based on this tutorial: https://docs.opencv.org/2.4/doc/tutorials/calib3d/camera_calibration/camera_calibration.html * - * - * Example pipelines + * ## Example pipelines + * * |[ * gst-launch-1.0 -v v4l2src ! videoconvert ! cameraundistort ! cameracalibrate | autovideosink * ]| will correct camera distortion once camera calibration is done. - * */ /* diff --git a/ext/opencv/gstcameraundistort.cpp b/ext/opencv/gstcameraundistort.cpp index ca45ce2150..baad9cbde4 100644 --- a/ext/opencv/gstcameraundistort.cpp +++ b/ext/opencv/gstcameraundistort.cpp @@ -55,15 +55,14 @@ * * Based on this tutorial: https://docs.opencv.org/2.4/doc/tutorials/calib3d/camera_calibration/camera_calibration.html * - * - * Example pipelines + * ## Example pipelines + * * |[ * gst-launch-1.0 -v v4l2src ! videoconvert ! cameraundistort settings="???" ! autovideosink * ]| will correct camera distortion based on provided settings. * |[ * gst-launch-1.0 -v v4l2src ! videoconvert ! cameraundistort ! cameracalibrate ! autovideosink * ]| will correct camera distortion once camera calibration is done. - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstcvdilate.cpp b/ext/opencv/gstcvdilate.cpp index 12802f0f71..defe2d4642 100644 --- a/ext/opencv/gstcvdilate.cpp +++ b/ext/opencv/gstcvdilate.cpp @@ -46,12 +46,11 @@ * * Dilates the image with the cvDilate OpenCV function. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! cvdilate ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstcvequalizehist.cpp b/ext/opencv/gstcvequalizehist.cpp index 9c4de608b2..742a414362 100644 --- a/ext/opencv/gstcvequalizehist.cpp +++ b/ext/opencv/gstcvequalizehist.cpp @@ -47,12 +47,11 @@ * Equalizes the histogram of a grayscale image with the cvEqualizeHist OpenCV * function. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc pattern=23 ! cvequalizehist ! videoconvert ! autovideosink * ]| - * */ diff --git a/ext/opencv/gstcverode.cpp b/ext/opencv/gstcverode.cpp index e7d2385d86..28551b004a 100644 --- a/ext/opencv/gstcverode.cpp +++ b/ext/opencv/gstcverode.cpp @@ -46,12 +46,11 @@ * * Erodes the image with the cvErode OpenCV function. * - * - * Example launch line + * Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! cverode ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstcvlaplace.cpp b/ext/opencv/gstcvlaplace.cpp index b285b8f347..e18e9e939d 100644 --- a/ext/opencv/gstcvlaplace.cpp +++ b/ext/opencv/gstcvlaplace.cpp @@ -46,12 +46,11 @@ * * Applies cvLaplace OpenCV function to the image. * - * - * Example launch line + * Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! cvlaplace ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstcvsmooth.cpp b/ext/opencv/gstcvsmooth.cpp index 3186427dbd..02c995d5d6 100644 --- a/ext/opencv/gstcvsmooth.cpp +++ b/ext/opencv/gstcvsmooth.cpp @@ -46,12 +46,11 @@ * * Smooths the image using thes cvSmooth OpenCV function. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! cvsmooth ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstcvsobel.cpp b/ext/opencv/gstcvsobel.cpp index ffeeba5727..5cca14d8d7 100644 --- a/ext/opencv/gstcvsobel.cpp +++ b/ext/opencv/gstcvsobel.cpp @@ -46,12 +46,11 @@ * * Applies the cvSobel OpenCV function to the image. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! cvsobel ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstdewarp.cpp b/ext/opencv/gstdewarp.cpp index 1d5e912858..3c123c573f 100644 --- a/ext/opencv/gstdewarp.cpp +++ b/ext/opencv/gstdewarp.cpp @@ -47,12 +47,11 @@ * * Dewarp fisheye images * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! videoconvert ! circle radius=0.1 height=80 ! dewarp outer-radius=0.35 inner-radius=0.1 ! videoconvert ! xvimagesink * ]| - * */ diff --git a/ext/opencv/gstdisparity.cpp b/ext/opencv/gstdisparity.cpp index d274b76a80..e584c26c6a 100644 --- a/ext/opencv/gstdisparity.cpp +++ b/ext/opencv/gstdisparity.cpp @@ -97,8 +97,8 @@ * [D] Scharstein, D. & Szeliski, R. (2001). A taxonomy and evaluation of dense two-frame stereo * correspondence algorithms, International Journal of Computer Vision 47: 7–42. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! video/x-raw,width=320,height=240 ! videoconvert ! disp0.sink_right videotestsrc ! video/x-raw,width=320,height=240 ! videoconvert ! disp0.sink_left disparity name=disp0 ! videoconvert ! ximagesink * ]| @@ -112,7 +112,6 @@ gst-launch-1.0 multifilesrc location=~/im3.png ! pngdec ! videoconvert ! di * |[ gst-launch-1.0 v4l2src device=/dev/video1 ! video/x-raw,width=320,height=240 ! videoconvert ! disp0.sink_right v4l2src device=/dev/video0 ! video/x-raw,width=320,height=240 ! videoconvert ! disp0.sink_left disparity name=disp0 method=sgbm disp0.src ! videoconvert ! ximagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstedgedetect.cpp b/ext/opencv/gstedgedetect.cpp index e5a706335f..04a4681ba3 100644 --- a/ext/opencv/gstedgedetect.cpp +++ b/ext/opencv/gstedgedetect.cpp @@ -48,12 +48,11 @@ * * Performs canny edge detection on videos and images * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! videoconvert ! edgedetect ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstfaceblur.cpp b/ext/opencv/gstfaceblur.cpp index 9d99aca6dd..7de576dcd6 100644 --- a/ext/opencv/gstfaceblur.cpp +++ b/ext/opencv/gstfaceblur.cpp @@ -49,12 +49,11 @@ * * Blurs faces in images and videos. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 autovideosrc ! videoconvert ! faceblur ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstfacedetect.cpp b/ext/opencv/gstfacedetect.cpp index c1b89ea337..e6a32df390 100644 --- a/ext/opencv/gstfacedetect.cpp +++ b/ext/opencv/gstfacedetect.cpp @@ -56,8 +56,8 @@ * until the size is <= GstFaceDetect::min-size-width or * GstFaceDetect::min-size-height. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 autovideosrc ! decodebin ! colorspace ! facedetect ! videoconvert ! xvimagesink * ]| Detect and show faces @@ -65,7 +65,6 @@ * gst-launch-1.0 autovideosrc ! video/x-raw,width=320,height=240 ! videoconvert ! facedetect min-size-width=60 min-size-height=60 ! colorspace ! xvimagesink * ]| Detect large faces on a smaller image * - * */ /* FIXME: development version of OpenCV has CV_HAAR_FIND_BIGGEST_OBJECT which diff --git a/ext/opencv/gstgrabcut.cpp b/ext/opencv/gstgrabcut.cpp index 0d8ec70d62..4c32c1029c 100644 --- a/ext/opencv/gstgrabcut.cpp +++ b/ext/opencv/gstgrabcut.cpp @@ -68,8 +68,8 @@ * extraction using iterated graph cuts, ACM Trans. Graph., vol. 23, pp. 309–314, * 2004. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 --gst-debug=grabcut=4 v4l2src device=/dev/video0 ! videoconvert ! grabcut ! videoconvert ! video/x-raw,width=320,height=240 ! ximagesink * ]| @@ -77,7 +77,6 @@ * |[ * gst-launch-1.0 --gst-debug=grabcut=4 v4l2src device=/dev/video0 ! videoconvert ! facedetect display=0 ! videoconvert ! grabcut test-mode=true ! videoconvert ! video/x-raw,width=320,height=240 ! ximagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gsthanddetect.cpp b/ext/opencv/gsthanddetect.cpp index 73da2f88db..912bebef35 100644 --- a/ext/opencv/gsthanddetect.cpp +++ b/ext/opencv/gsthanddetect.cpp @@ -47,13 +47,12 @@ * FIXME:operates hand gesture detection in video streams and images, * and enable media operation e.g. play/stop/fast forward/back rewind. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 autovideosrc ! videoconvert ! "video/x-raw, format=RGB, width=320, height=240" ! \ * videoscale ! handdetect ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstmotioncells.cpp b/ext/opencv/gstmotioncells.cpp index ac1350a04f..b0a6d1ab90 100644 --- a/ext/opencv/gstmotioncells.cpp +++ b/ext/opencv/gstmotioncells.cpp @@ -47,12 +47,11 @@ * * Performs motion detection on videos. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc pattern=18 ! videorate ! videoscale ! video/x-raw,width=320,height=240,framerate=5/1 ! videoconvert ! motioncells ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstretinex.cpp b/ext/opencv/gstretinex.cpp index c5c9f5689e..84706f04a0 100644 --- a/ext/opencv/gstretinex.cpp +++ b/ext/opencv/gstretinex.cpp @@ -50,12 +50,11 @@ * color image enhancement." Image Processing, 1996. Proceedings., International * Conference on. Vol. 3. IEEE, 1996. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! videoconvert ! retinex ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstsegmentation.cpp b/ext/opencv/gstsegmentation.cpp index b7de6f0998..e0401d0e7b 100644 --- a/ext/opencv/gstsegmentation.cpp +++ b/ext/opencv/gstsegmentation.cpp @@ -78,12 +78,11 @@ * per Image Pixel for the Task of Background Subtraction", Pattern Recognition * Letters, vol. 27, no. 7, pages 773-780, 2006. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 v4l2src device=/dev/video0 ! videoconvert ! segmentation test-mode=true method=2 ! videoconvert ! ximagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gstskindetect.cpp b/ext/opencv/gstskindetect.cpp index c13c80bc57..60d0697be2 100644 --- a/ext/opencv/gstskindetect.cpp +++ b/ext/opencv/gstskindetect.cpp @@ -46,12 +46,11 @@ * * Human skin detection on videos and images * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! decodebin ! videoconvert ! skindetect ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gsttemplatematch.cpp b/ext/opencv/gsttemplatematch.cpp index b0b2aa8819..9f613c0e49 100644 --- a/ext/opencv/gsttemplatematch.cpp +++ b/ext/opencv/gsttemplatematch.cpp @@ -49,12 +49,11 @@ * * Performs template matching on videos and images, providing detected positions via bus messages. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! videoconvert ! templatematch template=/path/to/file.jpg ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/opencv/gsttextoverlay.cpp b/ext/opencv/gsttextoverlay.cpp index f72b1ee007..b8e2be300a 100644 --- a/ext/opencv/gsttextoverlay.cpp +++ b/ext/opencv/gsttextoverlay.cpp @@ -48,12 +48,11 @@ * * opencvtextoverlay renders the text on top of the video frames * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 videotestsrc ! videoconvert ! opencvtextoverlay text="Opencv Text Overlay " ! videoconvert ! xvimagesink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/openmpt/gstopenmptdec.c b/ext/openmpt/gstopenmptdec.c index 4c0bba1aa5..bc8c04fd58 100644 --- a/ext/openmpt/gstopenmptdec.c +++ b/ext/openmpt/gstopenmptdec.c @@ -26,12 +26,11 @@ * It uses the OpenMPT library * for this purpose. It can be autoplugged and therefore works with decodebin. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 filesrc location=media/example.it ! openmptdec ! audioconvert ! audioresample ! autoaudiosink * ]| - * */ diff --git a/ext/openni2/gstopenni2.cpp b/ext/openni2/gstopenni2.cpp index ee396cd3a8..493f0a57b1 100644 --- a/ext/openni2/gstopenni2.cpp +++ b/ext/openni2/gstopenni2.cpp @@ -33,15 +33,9 @@ * More concretely on the "libopenni2-dev" and "libopenni2" packages - that can * be downloaded in http://goo.gl/2H6SZ6. * - * - * Examples - * - * Some recorded .oni files are available at: - * - * http://people.cs.pitt.edu/~chang/1635/proj11/kinectRecord - * - * - * + * ## Examples + * + * Some recorded .oni files are available at */ diff --git a/ext/openni2/gstopenni2src.cpp b/ext/openni2/gstopenni2src.cpp index 88e6a168db..6d8dc77b83 100644 --- a/ext/openni2/gstopenni2src.cpp +++ b/ext/openni2/gstopenni2src.cpp @@ -18,22 +18,17 @@ /** * SECTION:element-openni2src * - * - * Examples - * - * Some recorded .oni files are available at: - * - * http://people.cs.pitt.edu/~chang/1635/proj11/kinectRecord - * + * ## Examples * - * - LD_LIBRARY_PATH=/usr/lib/OpenNI2/Drivers/ gst-launch-1.0 --gst-debug=openni2src:5 openni2src location='Downloads/mr.oni' sourcetype=depth ! videoconvert ! ximagesink - * - * - LD_LIBRARY_PATH=/usr/lib/OpenNI2/Drivers/ gst-launch-1.0 --gst-debug=openni2src:5 openni2src location='Downloads/mr.oni' sourcetype=color ! videoconvert ! ximagesink - * - * - * + * Some recorded .oni files are available at + * + * ``` shell + * LD_LIBRARY_PATH=/usr/lib/OpenNI2/Drivers/ gst-launch-1.0 --gst-debug=openni2src:5 openni2src location='Downloads/mr.oni' sourcetype=depth ! videoconvert ! ximagesink + * ``` + * + * ``` shell + * LD_LIBRARY_PATH=/usr/lib/OpenNI2/Drivers/ gst-launch-1.0 --gst-debug=openni2src:5 openni2src location='Downloads/mr.oni' sourcetype=color ! videoconvert ! ximagesink + * ``` */ #ifdef HAVE_CONFIG_H diff --git a/ext/srt/gstsrtsink.c b/ext/srt/gstsrtsink.c index 4af2bb1a3b..8d499f2fbb 100644 --- a/ext/srt/gstsrtsink.c +++ b/ext/srt/gstsrtsink.c @@ -26,8 +26,8 @@ * srtsink is a network sink that sends SRT * packets to the network. * - * - * Examples + * ## Examples + * * |[ * gst-launch-1.0 -v audiotestsrc ! srtsink uri=srt://host * ]| This pipeline shows how to serve SRT packets through the default port. @@ -35,7 +35,6 @@ * |[ * gst-launch-1.0 -v audiotestsrc ! srtsink uri=srt://:port * ]| This pipeline shows how to wait SRT callers. - * * */ diff --git a/ext/srt/gstsrtsrc.c b/ext/srt/gstsrtsrc.c index f929e3f013..cc52a60faa 100644 --- a/ext/srt/gstsrtsrc.c +++ b/ext/srt/gstsrtsrc.c @@ -26,8 +26,7 @@ * srtsrc is a network source that reads SRT * packets from the network. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 -v srtsrc uri="srt://127.0.0.1:7001" ! fakesink * ]| This pipeline shows how to connect SRT server by setting #GstSRTSrc:uri property. @@ -39,7 +38,6 @@ * |[ * gst-launch-1.0 -v srtclientsrc uri="srt://192.168.1.10:7001?mode=rendez-vous" ! fakesink * ]| This pipeline shows how to connect SRT server by setting #GstSRTSrc:uri property and using the rendez-vous mode. - * * */ diff --git a/ext/wildmidi/gstwildmididec.c b/ext/wildmidi/gstwildmididec.c index 3a3814833f..ea88f74294 100644 --- a/ext/wildmidi/gstwildmididec.c +++ b/ext/wildmidi/gstwildmididec.c @@ -26,12 +26,11 @@ * It uses WildMidi * for this purpose. It can be autoplugged and therefore works with decodebin. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 filesrc location=media/example.mid ! wildmididec ! audioconvert ! audioresample ! autoaudiosink * ]| - * */ diff --git a/gst-libs/gst/audio/gstnonstreamaudiodecoder.c b/gst-libs/gst/audio/gstnonstreamaudiodecoder.c index 4889ca659c..ef1361c655 100644 --- a/gst-libs/gst/audio/gstnonstreamaudiodecoder.c +++ b/gst-libs/gst/audio/gstnonstreamaudiodecoder.c @@ -74,110 +74,85 @@ * @get_property then reports the corrected versions. * * The base class operates as follows: - * - * - * Unloaded mode - * - * Initial values are set. If a current subsong has already been - * defined (for example over the command line with gst-launch), then - * the subsong index is copied over to current_subsong . - * Same goes for the num-loops and output-mode properties. - * Media is NOT loaded yet. - * - * - * Once the sinkpad is activated, the process continues. The sinkpad is - * activated in push mode, and the class accumulates the incoming media - * data in an adapter inside the sinkpad's chain function until either an - * EOS event is received from upstream, or the number of bytes reported - * by upstream is reached. Then it loads the media, and starts the decoder - * output task. - * - * If upstream cannot respond to the size query (in bytes) of @load_from_buffer - * fails, an error is reported, and the pipeline stops. - * - * - * If there are no errors, @load_from_buffer is called to load the media. The - * subclass must at least call gst_nonstream_audio_decoder_set_output_audioinfo() - * there, and is free to make use of the initial subsong, output mode, and - * position. If the actual output mode or position differs from the initial - * value,it must set the initial value to the actual one (for example, if - * the actual starting position is always 0, set *initial_position to 0). - * If loading is unsuccessful, an error is reported, and the pipeline - * stops. Otherwise, the base class calls @get_current_subsong to retrieve - * the actual current subsong, @get_subsong_duration to report the current - * subsong's duration in a duration event and message, and @get_subsong_tags - * to send tags downstream in an event (these functions are optional; if - * set to NULL, the associated operation is skipped). Afterwards, the base - * class switches to loaded mode, and starts the decoder output task. - * - * - * Loaded mode - * - * Inside the decoder output task, the base class repeatedly calls @decode, - * which returns a buffer with decoded, ready-to-play samples. If the - * subclass reached the end of playback, @decode returns FALSE, otherwise - * TRUE. - * - * - * Upon reaching a loop end, subclass either ignores that, or loops back - * to the beginning of the loop. In the latter case, if the output mode is set - * to LOOPING, the subclass must call gst_nonstream_audio_decoder_handle_loop() - * *after* the playback position moved to the start of the loop. In - * STEADY mode, the subclass must *not* call this function. - * Since many decoders only provide a callback for when the looping occurs, - * and that looping occurs inside the decoding operation itself, the following - * mechanism for subclass is suggested: set a flag inside such a callback. - * Then, in the next @decode call, before doing the decoding, check this flag. - * If it is set, gst_nonstream_audio_decoder_handle_loop() is called, and the - * flag is cleared. - * (This function call is necessary in LOOPING mode because it updates the - * current segment and makes sure the next buffer that is sent downstream - * has its DISCONT flag set.) - * - * - * When the current subsong is switched, @set_current_subsong is called. - * If it fails, a warning is reported, and nothing else is done. Otherwise, - * it calls @get_subsong_duration to get the new current subsongs's - * duration, @get_subsong_tags to get its tags, reports a new duration - * (i.e. it sends a duration event downstream and generates a duration - * message), updates the current segment, and sends the subsong's tags in - * an event downstream. (If @set_current_subsong has been set to NULL by - * the subclass, attempts to set a current subsong are ignored; likewise, - * if @get_subsong_duration is NULL, no duration is reported, and if - * @get_subsong_tags is NULL, no tags are sent downstream.) - * - * - * When an attempt is made to switch the output mode, it is checked against - * the bitmask returned by @get_supported_output_modes. If the proposed - * new output mode is supported, the current segment is updated - * (it is open-ended in STEADY mode, and covers the (sub)song length in - * LOOPING mode), and the subclass' @set_output_mode function is called - * unless it is set to NULL. Subclasses should reset internal loop counters - * in this function. - * - * - * - * + * * Unloaded mode + * - Initial values are set. If a current subsong has already been + * defined (for example over the command line with gst-launch), then + * the subsong index is copied over to current_subsong . + * Same goes for the num-loops and output-mode properties. + * Media is NOT loaded yet. + * - Once the sinkpad is activated, the process continues. The sinkpad is + * activated in push mode, and the class accumulates the incoming media + * data in an adapter inside the sinkpad's chain function until either an + * EOS event is received from upstream, or the number of bytes reported + * by upstream is reached. Then it loads the media, and starts the decoder + * output task. + * - If upstream cannot respond to the size query (in bytes) of @load_from_buffer + * fails, an error is reported, and the pipeline stops. + * - If there are no errors, @load_from_buffer is called to load the media. The + * subclass must at least call gst_nonstream_audio_decoder_set_output_audioinfo() + * there, and is free to make use of the initial subsong, output mode, and + * position. If the actual output mode or position differs from the initial + * value,it must set the initial value to the actual one (for example, if + * the actual starting position is always 0, set *initial_position to 0). + * If loading is unsuccessful, an error is reported, and the pipeline + * stops. Otherwise, the base class calls @get_current_subsong to retrieve + * the actual current subsong, @get_subsong_duration to report the current + * subsong's duration in a duration event and message, and @get_subsong_tags + * to send tags downstream in an event (these functions are optional; if + * set to NULL, the associated operation is skipped). Afterwards, the base + * class switches to loaded mode, and starts the decoder output task. + * + * * Loaded mode + * - Inside the decoder output task, the base class repeatedly calls @decode, + * which returns a buffer with decoded, ready-to-play samples. If the + * subclass reached the end of playback, @decode returns FALSE, otherwise + * TRUE. + * - Upon reaching a loop end, subclass either ignores that, or loops back + * to the beginning of the loop. In the latter case, if the output mode is set + * to LOOPING, the subclass must call gst_nonstream_audio_decoder_handle_loop() + * *after* the playback position moved to the start of the loop. In + * STEADY mode, the subclass must *not* call this function. + * Since many decoders only provide a callback for when the looping occurs, + * and that looping occurs inside the decoding operation itself, the following + * mechanism for subclass is suggested: set a flag inside such a callback. + * Then, in the next @decode call, before doing the decoding, check this flag. + * If it is set, gst_nonstream_audio_decoder_handle_loop() is called, and the + * flag is cleared. + * (This function call is necessary in LOOPING mode because it updates the + * current segment and makes sure the next buffer that is sent downstream + * has its DISCONT flag set.) + * - When the current subsong is switched, @set_current_subsong is called. + * If it fails, a warning is reported, and nothing else is done. Otherwise, + * it calls @get_subsong_duration to get the new current subsongs's + * duration, @get_subsong_tags to get its tags, reports a new duration + * (i.e. it sends a duration event downstream and generates a duration + * message), updates the current segment, and sends the subsong's tags in + * an event downstream. (If @set_current_subsong has been set to NULL by + * the subclass, attempts to set a current subsong are ignored; likewise, + * if @get_subsong_duration is NULL, no duration is reported, and if + * @get_subsong_tags is NULL, no tags are sent downstream.) + * - When an attempt is made to switch the output mode, it is checked against + * the bitmask returned by @get_supported_output_modes. If the proposed + * new output mode is supported, the current segment is updated + * (it is open-ended in STEADY mode, and covers the (sub)song length in + * LOOPING mode), and the subclass' @set_output_mode function is called + * unless it is set to NULL. Subclasses should reset internal loop counters + * in this function. * * The relationship between (sub)song duration, output mode, and number of loops * is defined this way (this is all done by the base class automatically): - * - * - * Segments have their duration and stop values set to GST_CLOCK_TIME_NONE in + * + * * Segments have their duration and stop values set to GST_CLOCK_TIME_NONE in * STEADY mode, and to the duration of the (sub)song in LOOPING mode. - * - * - * The duration that is returned to a DURATION query is always the duration + * + * * The duration that is returned to a DURATION query is always the duration * of the (sub)song, regardless of number of loops or output mode. The same * goes for DURATION messages and tags. - * - * - * If the number of loops is >0 or -1, durations of TOC entries are set to + * + * * If the number of loops is >0 or -1, durations of TOC entries are set to * the duration of the respective subsong in LOOPING mode and to G_MAXINT64 in * STEADY mode. If the number of loops is 0, entry durations are set to the * subsong duration regardless of the output mode. - * - * */ #ifdef HAVE_CONFIG_H diff --git a/gst-libs/gst/audio/gstnonstreamaudiodecoder.h b/gst-libs/gst/audio/gstnonstreamaudiodecoder.h index 563a99e1b3..4de1fc7ee9 100644 --- a/gst-libs/gst/audio/gstnonstreamaudiodecoder.h +++ b/gst-libs/gst/audio/gstnonstreamaudiodecoder.h @@ -293,11 +293,11 @@ struct _GstNonstreamAudioDecoder * * All functions are called with a locked decoder mutex. * - * If GST_ELEMENT_ERROR, GST_ELEMENT_WARNING, or GST_ELEMENT_INFO are called from - * inside one of these functions, it is strongly recommended to unlock the decoder mutex - * before and re-lock it after these macros to prevent potential deadlocks in case the - * application does something with the element when it receives an ERROR/WARNING/INFO - * message. Same goes for gst_element_post_message() calls and non-serialized events. + * > If GST_ELEMENT_ERROR, GST_ELEMENT_WARNING, or GST_ELEMENT_INFO are called from + * > inside one of these functions, it is strongly recommended to unlock the decoder mutex + * > before and re-lock it after these macros to prevent potential deadlocks in case the + * > application does something with the element when it receives an ERROR/WARNING/INFO + * > message. Same goes for gst_element_post_message() calls and non-serialized events. * * By default, this class works by reading media data from the sinkpad, and then commencing * playback. Some decoders cannot be given data from a memory block, so the usual way of diff --git a/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c b/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c index ed3e74c6b3..889355e693 100644 --- a/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c +++ b/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c @@ -29,13 +29,8 @@ * * The design mandates that the subclasses implement the following features and * behaviour: - * - * - * 3 pads: viewfinder, image capture, video capture - * - * - * - * + * + * * 3 pads: viewfinder, image capture, video capture * * During construct_pipeline() vmethod a subclass can add several elements into * the bin and expose 3 srcs pads as ghostpads implementing the 3 pad templates. diff --git a/gst-libs/gst/interfaces/photography.c b/gst-libs/gst/interfaces/photography.c index 1799c52ba8..72fda1db9d 100644 --- a/gst-libs/gst/interfaces/photography.c +++ b/gst-libs/gst/interfaces/photography.c @@ -34,10 +34,8 @@ * * The interface allows access to some common digital image capture parameters. * - * - * The GstPhotography interface is unstable API and may change in future. - * One can define GST_USE_UNSTABLE_API to acknowledge and avoid this warning. - * + * > The GstPhotography interface is unstable API and may change in future. + * > One can define GST_USE_UNSTABLE_API to acknowledge and avoid this warning. */ static void gst_photography_iface_base_init (GstPhotographyInterface * iface); diff --git a/gst-libs/gst/interfaces/photography.h b/gst-libs/gst/interfaces/photography.h index 9a09c5511a..a43d42034a 100644 --- a/gst-libs/gst/interfaces/photography.h +++ b/gst-libs/gst/interfaces/photography.h @@ -50,38 +50,17 @@ G_BEGIN_DECLS * Name of custom GstMessage that will be posted to #GstBus when autofocusing * is complete. * This message contains following fields: - * - * - * - * #GstPhotographyFocusStatus - * "status": - * Tells if focusing succeeded or failed. - * - * - * - * - * #G_TYPE_INT - * "focus-window-rows": - * Tells number of focus matrix rows. - * - * - * - * - * #G_TYPE_INT - * "focus-window-columns": - * Tells number of focus matrix columns. - * - * - * - * - * #G_TYPE_INT - * "focus-window-mask": - * Bitmask containing rows x columns bits which mark the focus points in the - * focus matrix. Lowest bit (LSB) always represents the top-left corner of the - * focus matrix. This field is only valid when focusing status is SUCCESS. - * - * - * + * + * * `status` (#GstPhotographyFocusStatus): Tells if focusing succeeded or failed. + * + * * `focus-window-rows` (#G_TYPE_INT): Tells number of focus matrix rows. + * + * * `focus-window-columns` (#G_TYPE_INT): Tells number of focus matrix columns. + * + * * `focus-window-mask` (#G_TYPE_INT): Bitmask containing rows x columns bits + * which mark the focus points in the focus matrix. Lowest bit (LSB) always + * represents the top-left corner of the focus matrix. This field is only valid + * when focusing status is SUCCESS. */ #define GST_PHOTOGRAPHY_AUTOFOCUS_DONE "autofocus-done" @@ -93,15 +72,8 @@ G_BEGIN_DECLS * becoming "shaken" due to camera movement and too long exposure time. * * This message contains following fields: - * - * - * - * #GstPhotographyShakeRisk - * "status": - * Tells risk level of capturing shaken image. - * - * - * + * + * * `status` (#GstPhotographyShakeRisk): Tells risk level of capturing shaken image. */ #define GST_PHOTOGRAPHY_SHAKE_RISK "shake-risk" diff --git a/gst/faceoverlay/gstfaceoverlay.c b/gst/faceoverlay/gstfaceoverlay.c index c5c8fe0b8c..236d483db3 100644 --- a/gst/faceoverlay/gstfaceoverlay.c +++ b/gst/faceoverlay/gstfaceoverlay.c @@ -47,12 +47,11 @@ * x, y, w, and h properties are optional, and change the image position and * size relative to the detected face position and size. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 autovideosrc ! videoconvert ! faceoverlay location=/path/to/gnome-video-effects/pixmaps/bow.svg x=0.5 y=0.5 w=0.7 h=0.7 ! videoconvert ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/gst/festival/gstfestival.c b/gst/festival/gstfestival.c index 407fa3bc2c..e3206ef768 100644 --- a/gst/festival/gstfestival.c +++ b/gst/festival/gstfestival.c @@ -67,7 +67,7 @@ * This element connects to a * festival * server process and uses it to synthesize speech. Festival need to run already - * in server mode, started as festival --server + * in server mode, started as `festival --server` * * ## Example pipeline * |[ diff --git a/sys/applemedia/avfassetsrc.m b/sys/applemedia/avfassetsrc.m index f7de87e156..20478bda5a 100644 --- a/sys/applemedia/avfassetsrc.m +++ b/sys/applemedia/avfassetsrc.m @@ -26,12 +26,11 @@ * * Read and decode samples from AVFoundation assets using the AVFAssetReader API * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 -v -m avfassetsrc uri="file://movie.mp4" ! autovideosink * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/sys/applemedia/iosassetsrc.m b/sys/applemedia/iosassetsrc.m index 6a8b937056..0ea3a0751f 100644 --- a/sys/applemedia/iosassetsrc.m +++ b/sys/applemedia/iosassetsrc.m @@ -26,12 +26,11 @@ * * Read data from an iOS asset from the media library. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 iosassetsrc uri=assets-library://asset/asset.M4V?id=11&ext=M4V ! decodebin ! autoaudiosink * ]| Plays asset with id a song.ogg from local dir. - * */ #ifdef HAVE_CONFIG_H diff --git a/sys/vdpau/mpeg/gstvdpmpegdec.c b/sys/vdpau/mpeg/gstvdpmpegdec.c index 1bcf9d9a5e..b7f95695cf 100644 --- a/sys/vdpau/mpeg/gstvdpmpegdec.c +++ b/sys/vdpau/mpeg/gstvdpmpegdec.c @@ -23,12 +23,11 @@ * * FIXME:Describe vdpaumpegdec here. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 -v -m fakesrc ! vdpaumpegdec ! fakesink silent=TRUE * ]| - * */ #ifdef HAVE_CONFIG_H diff --git a/sys/vdpau/mpeg4/gstvdpmpeg4dec.c b/sys/vdpau/mpeg4/gstvdpmpeg4dec.c index ccbdbc6480..a871f5a13d 100644 --- a/sys/vdpau/mpeg4/gstvdpmpeg4dec.c +++ b/sys/vdpau/mpeg4/gstvdpmpeg4dec.c @@ -23,12 +23,11 @@ * * FIXME:Describe vdpaumpeg4dec here. * - * - * Example launch line + * ## Example launch line + * * |[ * gst-launch-1.0 -v -m fakesrc ! vdpaumpeg4dec ! fakesink silent=TRUE * ]| - * */ #ifdef HAVE_CONFIG_H