mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-26 17:18:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Update rawparser documentation

Browse source 
Signed-off-by: Carlos Rafael Giani <dv@pseudoterminal.org>

https://bugzilla.gnome.org/show_bug.cgi?id=767011
This commit is contained in:
Carlos Rafael Giani 2016-07-25 17:55:24 +02:00 committed by Sebastian Dröge
parent 403499a0c0
commit efa5b219e6
3 changed files with 137 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/plugins/gst-plugins-bad-plugins-docs.sgml
View file

@ -23,6 +23,7 @@
<xi:include href="xml/element-assrender.xml" /> <xi:include href="xml/element-assrender.xml" />
<xi:include href="xml/element-audiointerleave.xml" /> <xi:include href="xml/element-audiointerleave.xml" />
<xi:include href="xml/element-audiomixer.xml" /> <xi:include href="xml/element-audiomixer.xml" />
<xi:include href="xml/element-audioparse.xml" />
<xi:include href="xml/element-autoconvert.xml" /> <xi:include href="xml/element-autoconvert.xml" />
<xi:include href="xml/element-bs2b.xml" /> <xi:include href="xml/element-bs2b.xml" />
<xi:include href="xml/element-bulge.xml" /> <xi:include href="xml/element-bulge.xml" />
@ -75,6 +76,8 @@
<xi:include href="xml/element-openalsink.xml" /> <xi:include href="xml/element-openalsink.xml" />
<xi:include href="xml/element-pcapparse.xml" /> <xi:include href="xml/element-pcapparse.xml" />
<xi:include href="xml/element-pinch.xml" /> <xi:include href="xml/element-pinch.xml" />
<xi:include href="xml/element-rawaudioparse.xml" />
<xi:include href="xml/element-rawvideoparse.xml" />
<xi:include href="xml/element-rfbsrc.xml" /> <xi:include href="xml/element-rfbsrc.xml" />
<xi:include href="xml/element-rtmpsink.xml" /> <xi:include href="xml/element-rtmpsink.xml" />
<xi:include href="xml/element-rtmpsrc.xml" /> <xi:include href="xml/element-rtmpsrc.xml" />
@ -93,6 +96,8 @@
<xi:include href="xml/element-opencvtextoverlay.xml" /> <xi:include href="xml/element-opencvtextoverlay.xml" />
<xi:include href="xml/element-tunnel.xml" /> <xi:include href="xml/element-tunnel.xml" />
<xi:include href="xml/element-twirl.xml" /> <xi:include href="xml/element-twirl.xml" />
<xi:include href="xml/element-unalignedaudioparse.xml" />
<xi:include href="xml/element-unalignedvideoparse.xml" />
<xi:include href="xml/element-videoparse.xml" /> <xi:include href="xml/element-videoparse.xml" />
<xi:include href="xml/element-waterripple.xml" /> <xi:include href="xml/element-waterripple.xml" />
<xi:include href="xml/element-zbar.xml" /> <xi:include href="xml/element-zbar.xml" />

64
docs/plugins/gst-plugins-bad-plugins-sections.txt
View file

@ -30,6 +30,22 @@ GST_TYPE_CM_ENC
gst_cm_enc_get_type gst_cm_enc_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>element-audioparse</FILE>
<TITLE>audioparse</TITLE>
GstAudioParse
<SUBSECTION Standard>
GstAudioParseClass
GST_AUDIO_PARSE
GST_AUDIO_PARSE_CAST
GST_IS_AUDIO_PARSE
GST_AUDIO_PARSE_CLASS
GST_IS_AUDIO_PARSE_CLASS
GST_TYPE_AUDIO_PARSE
<SUBSECTION Private>
gst_audio_parse_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>element-dvbbasebin</FILE> <FILE>element-dvbbasebin</FILE>
<TITLE>dvbbasebin</TITLE> <TITLE>dvbbasebin</TITLE>
@ -3891,6 +3907,22 @@ GST_TYPE_UNALIGNED_AUDIO_PARSE
gst_unaligned_audio_parse_get_type gst_unaligned_audio_parse_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>element-unalignedvideoparse</FILE>
<TITLE>unalignedvideoparse</TITLE>
GstUnalignedVideoParse
<SUBSECTION Standard>
GstUnalignedVideoParseClass
GST_UNALIGNED_VIDEO_PARSE
GST_UNALIGNED_VIDEO_PARSE_CAST
GST_IS_UNALIGNED_VIDEO_PARSE
GST_UNALIGNED_VIDEO_PARSE_CLASS
GST_IS_UNALIGNED_VIDEO_PARSE_CLASS
GST_TYPE_UNALIGNED_VIDEO_PARSE
<SUBSECTION Private>
gst_unaligned_video_parse_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>element-uvch264mjpgdemux</FILE> <FILE>element-uvch264mjpgdemux</FILE>
<TITLE>uvch264mjpgdemux</TITLE> <TITLE>uvch264mjpgdemux</TITLE>
@ -4051,6 +4083,38 @@ GST_TYPE_VIDEO_PARSE
gst_video_parse_get_type gst_video_parse_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>element-rawaudioparse</FILE>
<TITLE>rawaudioparse</TITLE>
GstRawAudioParse
<SUBSECTION Standard>
GstRawAudioParseClass
GST_RAW_AUDIO_PARSE
GST_RAW_AUDIO_PARSE_CAST
GST_IS_AUDIO_PARSE
GST_RAW_AUDIO_PARSE_CLASS
GST_IS_AUDIO_PARSE_CLASS
GST_TYPE_AUDIO_PARSE
<SUBSECTION Private>
gst_raw_audio_parse_get_type
</SECTION>
<SECTION>
<FILE>element-rawvideoparse</FILE>
<TITLE>rawvideoparse</TITLE>
GstRawVideoParse
<SUBSECTION Standard>
GstRawVideoParseClass
GST_RAW_VIDEO_PARSE
GST_RAW_VIDEO_PARSE_CAST
GST_IS_VIDEO_PARSE
GST_RAW_VIDEO_PARSE_CLASS
GST_IS_VIDEO_PARSE_CLASS
GST_TYPE_VIDEO_PARSE
<SUBSECTION Private>
gst_raw_video_parse_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>element-videosegmentclip</FILE> <FILE>element-videosegmentclip</FILE>
<TITLE>videosegmentclip</TITLE> <TITLE>videosegmentclip</TITLE>

73
docs/plugins/inspect/plugin-rawparse.xml
View file

@ -3,17 +3,17 @@
<description>Parses byte streams into raw frames</description> <description>Parses byte streams into raw frames</description>
<filename>../../gst/rawparse/.libs/libgstrawparse.so</filename> <filename>../../gst/rawparse/.libs/libgstrawparse.so</filename>
<basename>libgstrawparse.so</basename> <basename>libgstrawparse.so</basename>
<version>1.9.1</version> <version>1.9.1.1</version>
<license>LGPL</license> <license>LGPL</license>
<source>gst-plugins-bad</source> <source>gst-plugins-bad</source>
<package>GStreamer Bad Plug-ins source release</package> <package>GStreamer Bad Plug-ins git</package>
<origin>Unknown package origin</origin> <origin>Unknown package origin</origin>
<elements> <elements>
<element> <element>
<name>audioparse</name> <name>audioparse</name>
<longname>Audio Parse</longname> <longname>Audio Parse</longname>
<class>Filter/Audio</class> <class>Filter/Audio</class>
<description>Converts stream into audio frames</description> <description>Converts stream into audio frames (deprecated: use rawaudioparse instead)</description>
<author>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author> <author>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
<pads> <pads>
<caps> <caps>
@ -30,6 +30,48 @@
</caps> </caps>
</pads> </pads>
</element> </element>
<element>
<name>rawaudioparse</name>
<longname>rawaudioparse</longname>
<class>Codec/Parser/Audio</class>
<description>Converts unformatted data streams into timestamped raw audio frames</description>
<author>Carlos Rafael Giani &lt;dv@pseudoterminal.org&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-unaligned-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }; audio/x-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }; audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }; audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
</caps>
</pads>
</element>
<element>
<name>rawvideoparse</name>
<longname>rawvideoparse</longname>
<class>Codec/Parser/Video</class>
<description>Converts unformatted data streams into timestamped raw video frames</description>
<author>Carlos Rafael Giani &lt;dv@pseudoterminal.org&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-unaligned-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]; video/x-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
<element> <element>
<name>unalignedaudioparse</name> <name>unalignedaudioparse</name>
<longname>unalignedaudioparse</longname> <longname>unalignedaudioparse</longname>
@ -51,11 +93,32 @@
</caps> </caps>
</pads> </pads>
</element> </element>
<element>
<name>unalignedvideoparse</name>
<longname>unalignedvideoparse</longname>
<class>Codec/Parser/Bin/Video</class>
<description>Parse unaligned raw video data</description>
<author>Carlos Rafael Giani &lt;dv@pseudoterminal.org&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-unaligned-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
<element> <element>
<name>videoparse</name> <name>videoparse</name>
<longname>Video Parse</longname> <longname>Video Parse</longname>
<class>Filter/Video</class> <class>Filter/Video</class>
<description>Converts stream into video frames</description> <description>Converts stream into video frames (deprecated: use rawvideoparse instead)</description>
<author>David Schleef &lt;ds@schleef.org&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author> <author>David Schleef &lt;ds@schleef.org&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
<pads> <pads>
<caps> <caps>
@ -68,7 +131,7 @@
<name>src</name> <name>src</name>
<direction>source</direction> <direction>source</direction>
<presence>always</presence> <presence>always</presence>
<details>video/x-raw; video/x-bayer</details> <details>video/x-raw</details>
</caps> </caps>
</pads> </pads>
</element> </element>