mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-30 05:31:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

doc: remove xml from comments

Browse source
This commit is contained in:
Mathieu Duponchelle 2019-05-29 23:08:22 +02:00
parent 3ccf3f3334
commit df3989865e
12 changed files with 40 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
gst-libs/gst/vaapi/gstvaapitypes.h
View file

@ -57,11 +57,10 @@ typedef gsize GstVaapiID;
* *
* Can be used together with #GST_VAAPI_ID_ARGS to properly output an * Can be used together with #GST_VAAPI_ID_ARGS to properly output an
* integer value in a printf()-style text message. * integer value in a printf()-style text message.
* <informalexample> *
* <programlisting> * ``` C
* printf("id: %" GST_VAAPI_ID_FORMAT "\n", GST_VAAPI_ID_ARGS(id)); * printf("id: %" GST_VAAPI_ID_FORMAT "\n", GST_VAAPI_ID_ARGS(id));
* </programlisting> * ```
* </informalexample>
*/ */
#define GST_VAAPI_ID_FORMAT "p" #define GST_VAAPI_ID_FORMAT "p"

5
gst/vaapi/gstvaapidecodebin.c
View file

@ -33,12 +33,11 @@
* It offers the functionality of GstVaapiDecoder and the many options * It offers the functionality of GstVaapiDecoder and the many options
* of #GstVaapiPostproc. * of #GstVaapiPostproc.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/big_buck_bunny.mov ! qtdemux ! h264parse ! vaapidecodebin ! vaapisink * gst-launch-1.0 filesrc location=~/big_buck_bunny.mov ! qtdemux ! h264parse ! vaapidecodebin ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

44
gst/vaapi/gstvaapidecodedoc.c
View file

@ -37,12 +37,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/image.jpeg ! jpegparse ! vaapijpegdec ! imagefreeze ! vaapisink * gst-launch-1.0 filesrc location=~/image.jpeg ! jpegparse ! vaapijpegdec ! imagefreeze ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -63,12 +62,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/sample.mpg ! mpegpsdemux ! vaapimpeg2dec ! vaapisink * gst-launch-1.0 filesrc location=~/sample.mpg ! mpegpsdemux ! vaapimpeg2dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -89,12 +87,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/sample.mpeg4 ! mpeg4videoparse ! vaapimpeg4dec ! vaapisink * gst-launch-1.0 filesrc location=~/sample.mpeg4 ! mpeg4videoparse ! vaapimpeg4dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -115,12 +112,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/sample.h263 ! h263parse ! vaapih263dec ! vaapisink * gst-launch-1.0 filesrc location=~/sample.h263 ! h263parse ! vaapih263dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -141,12 +137,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/big_buck_bunny.mov ! qtdemux ! h264parse ! vaapih264dec ! vaapisink * gst-launch-1.0 filesrc location=~/big_buck_bunny.mov ! qtdemux ! h264parse ! vaapih264dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -167,12 +162,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=./sample.bin ! h265parse ! vaapih265dec ! vaapisink * gst-launch-1.0 filesrc location=./sample.bin ! h265parse ! vaapih265dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -193,12 +187,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=~/elephants_dream.wmv ! asfdemux ! vaapivc1dec ! vaapisink * gst-launch-1.0 filesrc location=~/elephants_dream.wmv ! asfdemux ! vaapivc1dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -219,12 +212,11 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 filesrc location=./sample.webm ! matroskademux ! vaapivp8dec ! vaapisink * gst-launch-1.0 filesrc location=./sample.webm ! matroskademux ! vaapivp8dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
/** /**
@ -245,10 +237,8 @@
* processed by other elements, but the performance would be rather * processed by other elements, but the performance would be rather
* bad. * bad.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title>
* |[ * |[
* gst-launch-1.0 filesrc location=./sample.vp9.webm ! ivfparse ! vaapivp9dec ! vaapisink * gst-launch-1.0 filesrc location=./sample.vp9.webm ! ivfparse ! vaapivp9dec ! vaapisink
* ]| * ]|
* </refsect2>
*/ */

5
gst/vaapi/gstvaapiencode_h264.c
View file

@ -52,12 +52,11 @@
* you can set #GstVaapiEncodeH264:tune, if your backend supports it, * you can set #GstVaapiEncodeH264:tune, if your backend supports it,
* for low-power mode or high compression. * for low-power mode or high compression.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapih264enc ! h264parse ! mp4mux ! filesink location=test.mp4 * gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapih264enc ! h264parse ! mp4mux ! filesink location=test.mp4
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapiencode_h264_fei.c
View file

@ -27,12 +27,11 @@
* *
* Encodes raw video streams into H.264 bitstreams. * Encodes raw video streams into H.264 bitstreams.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=60 ! vaapih264feienc fei-mode=ENC_PAK ! filesink location=test.264 * gst-launch-1.0 -ev videotestsrc num-buffers=60 ! vaapih264feienc fei-mode=ENC_PAK ! filesink location=test.264
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapiencode_h265.c
View file

@ -26,12 +26,11 @@
* *
* Encodes raw video streams into HEVC bitstreams. * Encodes raw video streams into HEVC bitstreams.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapih265enc ! h265parse ! matroskamux ! filesink location=test.mkv * gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapih265enc ! h265parse ! matroskamux ! filesink location=test.mkv
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapiencode_jpeg.c
View file

@ -26,12 +26,11 @@
* *
* Encodes raw images into JPEG images. * Encodes raw images into JPEG images.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=1 ! timeoverlay ! vaapijpegenc ! filesink location=test.jpg * gst-launch-1.0 -ev videotestsrc num-buffers=1 ! timeoverlay ! vaapijpegenc ! filesink location=test.jpg
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapiencode_mpeg2.c
View file

@ -27,12 +27,11 @@
* *
* Encodes raw video streams into MPEG2 bitstreams. * Encodes raw video streams into MPEG2 bitstreams.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapimpeg2enc ! matroskamux ! filesink location=test.mkv * gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapimpeg2enc ! matroskamux ! filesink location=test.mkv
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapiencode_vp8.c
View file

@ -26,12 +26,11 @@
* *
* Encodes raw video streams into VP8 bitstreams. * Encodes raw video streams into VP8 bitstreams.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapivp8enc ! matroskamux ! filesink location=test.mkv * gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapivp8enc ! matroskamux ! filesink location=test.mkv
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapiencode_vp9.c
View file

@ -26,12 +26,11 @@
* *
* Encodes raw video streams into VP9 bitstreams. * Encodes raw video streams into VP9 bitstreams.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapivp9enc ! matroskamux ! filesink location=test.mkv * gst-launch-1.0 -ev videotestsrc num-buffers=60 ! timeoverlay ! vaapivp9enc ! matroskamux ! filesink location=test.mkv
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapipostproc.c
View file

@ -27,12 +27,11 @@
* vaapipostproc consists in various postprocessing algorithms to be * vaapipostproc consists in various postprocessing algorithms to be
* applied to VA surfaces. * applied to VA surfaces.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 videotestsrc ! vaapipostproc ! video/x-raw width=1920, height=1080 ! vaapisink * gst-launch-1.0 videotestsrc ! vaapipostproc ! video/x-raw width=1920, height=1080 ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"

5
gst/vaapi/gstvaapisink.c
View file

@ -30,12 +30,11 @@
* display using the Video Acceleration (VA) API. The element will * display using the Video Acceleration (VA) API. The element will
* create its own internal window and render into it. * create its own internal window and render into it.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title> *
* |[ * |[
* gst-launch-1.0 videotestsrc ! vaapisink * gst-launch-1.0 videotestsrc ! vaapisink
* ]| * ]|
* </refsect2>
*/ */
#include "gstcompat.h" #include "gstcompat.h"