mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-25 01:30:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add new audiovisualizers to the plugin docs

Browse source
This commit is contained in:
Stefan Kost 2011-06-04 16:12:40 +03:00
parent f66a88bc70
commit bff846b76a
7 changed files with 409 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/plugins/Makefile.am
View file

@ -133,6 +133,11 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/aiff/aiffparse.h \
$(top_srcdir)/gst/aiff/aiffmux.h \
$(top_srcdir)/gst/autoconvert/gstautoconvert.h \
$(top_srcdir)/gst/audiovisualizers/gstbaseaudiovisualizer.h \
$(top_srcdir)/gst/audiovisualizers/gstspacescope.h \
$(top_srcdir)/gst/audiovisualizers/gstspectrascope.h \
$(top_srcdir)/gst/audiovisualizers/gstsynaescope.h \
$(top_srcdir)/gst/audiovisualizers/gstwavescope.h \
$(top_srcdir)/gst/camerabin/gstcamerabin.h \
$(top_srcdir)/gst/coloreffects/gstcoloreffects.h \
$(top_srcdir)/gst/dataurisrc/gstdataurisrc.h \

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

@ -100,6 +100,9 @@
<xi:include href="xml/element-shmsrc.xml" />
<xi:include href="xml/element-sdpdemux.xml" />
<xi:include href="xml/element-solarize.xml" />
<xi:include href="xml/element-spacescope.xml" />
<xi:include href="xml/element-spectrascope.xml" />
<xi:include href="xml/element-synaescope.xml" />
<xi:include href="xml/element-speed.xml" />
<xi:include href="xml/element-sphere.xml" />
<xi:include href="xml/element-square.xml" />
@ -124,11 +127,13 @@
<xi:include href="xml/element-voamrwbenc.xml" />
<xi:include href="xml/element-vp8dec.xml" />
<xi:include href="xml/element-vp8enc.xml" />
<xi:include href="xml/element-wavescope.xml" />
</chapter>
<chapter>
<title>gst-plugins-bad Plugins</title>
<xi:include href="xml/plugin-aiff.xml" />
<xi:include href="xml/plugin-audiovisualizers.xml" />
<xi:include href="xml/plugin-autoconvert.xml" />
<xi:include href="xml/plugin-legacyresample.xml" />
<xi:include href="xml/plugin-assrender.xml" />

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

@ -1332,6 +1332,34 @@ gst_solarize_get_type
gst_solarize_plugin_init
</SECTION>
<SECTION>
<FILE>element-spacescope</FILE>
<TITLE>spacescope</TITLE>
GstSpaceScope
<SUBSECTION Standard>
GstSpaceScopeClass
GST_SPACE_SCOPE
GST_SPACE_SCOPE_CLASS
GST_IS_SPACE_SCOPE
GST_IS_SPACE_SCOPE_CLASS
GST_TYPE_SPACE_SCOPE
gst_space_scope_get_type
</SECTION>
<SECTION>
<FILE>element-spectrascope</FILE>
<TITLE>spectrascope</TITLE>
GstSpectraScope
<SUBSECTION Standard>
GstSpectraScopeClass
GST_SPECTRA_SCOPE
GST_SPECTRA_SCOPE_CLASS
GST_IS_SPECTRA_SCOPE
GST_IS_SPECTRA_SCOPE_CLASS
GST_TYPE_SPECTRA_SCOPE
gst_spectra_scope_get_type
</SECTION>
<SECTION>
<FILE>element-speed</FILE>
<TITLE>speed</TITLE>
@ -1409,6 +1437,20 @@ gst_stretch_get_type
gst_stretch_plugin_init
</SECTION>
<SECTION>
<FILE>element-synaescope</FILE>
<TITLE>synaescope</TITLE>
GstSynaeScope
<SUBSECTION Standard>
GstSynaeScopeClass
GST_SYNAE_SCOPE
GST_SYNAE_SCOPE_CLASS
GST_IS_SYNAE_SCOPE
GST_IS_SYNAE_SCOPE_CLASS
GST_TYPE_SYNAE_SCOPE
gst_synae_scope_get_type
</SECTION>
<FILE>element-templatematch</FILE>
<TITLE>templatematch</TITLE>
GstTemplateMatch
@ -1570,6 +1612,20 @@ gst_water_ripple_get_type
gst_water_ripple_plugin_init
</SECTION>
<SECTION>
<FILE>element-wavescope</FILE>
<TITLE>wavescope</TITLE>
GstWaveScope
<SUBSECTION Standard>
GstWaveScopeClass
GST_WAVE_SCOPE
GST_WAVE_SCOPE_CLASS
GST_IS_WAVE_SCOPE
GST_IS_WAVE_SCOPE_CLASS
GST_TYPE_WAVE_SCOPE
gst_wave_scope_get_type
</SECTION>
<SECTION>
<FILE>element-wildmidi</FILE>
<TITLE>wildmidi</TITLE>

242
docs/plugins/gst-plugins-bad-plugins.args
View file

@ -1758,6 +1758,16 @@
<DEFAULT>100</DEFAULT>
</ARG>
<ARG>
<NAME>GstDvbSrc::timeout</NAME>
<TYPE>guint64</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Timeout</NICK>
<BLURB>Post a message after timeout microseconds (0 = disabled).</BLURB>
<DEFAULT>1000000</DEFAULT>
</ARG>
<ARG>
<NAME>GstRfbSrc::host</NAME>
<TYPE>gchar*</TYPE>
@ -21093,6 +21103,36 @@
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>ladspa-RotarySpeaker::AM-Depth</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,1]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>AM-Depth</NICK>
<BLURB>AM-Depth.</BLURB>
<DEFAULT>0.5</DEFAULT>
</ARG>
<ARG>
<NAME>ladspa-RotarySpeaker::FM-Depth</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,1]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>FM-Depth</NICK>
<BLURB>FM-Depth.</BLURB>
<DEFAULT>0.5</DEFAULT>
</ARG>
<ARG>
<NAME>ladspa-RotarySpeaker::Test</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,1]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>Test</NICK>
<BLURB>Test.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>ladspa-Phaser::Amount</NAME>
<TYPE>gfloat</TYPE>
@ -22393,6 +22433,26 @@
<DEFAULT>1</DEFAULT>
</ARG>
<ARG>
<NAME>GstApExSink::generation</NAME>
<TYPE>GstApExGeneration</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Generation</NICK>
<BLURB>AirPort device generation.</BLURB>
<DEFAULT>generation-one</DEFAULT>
</ARG>
<ARG>
<NAME>GstApExSink::transport-protocol</NAME>
<TYPE>GstApExTransportProtocol</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Transport Protocol</NICK>
<BLURB>AirPort transport protocol.</BLURB>
<DEFAULT>tcp</DEFAULT>
</ARG>
<ARG>
<NAME>GstMJ2Mux::faststart</NAME>
<TYPE>gboolean</TYPE>
@ -23223,6 +23283,16 @@
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG>
<NAME>GstCameraBin::image-formatter</NAME>
<TYPE>GstElement*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Image formatter</NICK>
<BLURB>Image formatter GStreamer element (default is jifmux).</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstDTMFSrc::interval</NAME>
<TYPE>guint</TYPE>
@ -47543,6 +47613,26 @@
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstWrapperCameraBinSrc::video-source</NAME>
<TYPE>GstElement*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Video source</NICK>
<BLURB>The video source element to be used.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstWrapperCameraBinSrc::video-source-filter</NAME>
<TYPE>GstElement*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Video source filter</NICK>
<BLURB>Optional video source filter element.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstViewfinderBin::video-sink</NAME>
<TYPE>GstElement*</TYPE>
@ -47853,6 +47943,26 @@
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstCameraBin2::audio-source</NAME>
<TYPE>GstElement*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Audio source</NICK>
<BLURB>The audio source element to be used on video recordings. It is only taken into use on the next null to ready transition.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstCameraBin2::camera-source</NAME>
<TYPE>GstElement*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Camera source</NICK>
<BLURB>The camera source element to be used. It is only taken into use on the next null to ready transition.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstZebraStripe::threshold</NAME>
<TYPE>gint</TYPE>
@ -49088,9 +49198,9 @@
<TYPE>gfloat</TYPE>
<RANGE>[0,1]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>Mod Depth</NICK>
<BLURB>Mod Depth.</BLURB>
<DEFAULT>0.1</DEFAULT>
<NICK>FM Depth</NICK>
<BLURB>FM Depth.</BLURB>
<DEFAULT>0.45</DEFAULT>
</ARG>
<ARG>
@ -49143,6 +49253,26 @@
<DEFAULT>5</DEFAULT>
</ARG>
<ARG>
<NAME>calf-sourceforge-net-plugins-RotarySpeaker::am-depth</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,1]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>AM Depth</NICK>
<BLURB>AM Depth.</BLURB>
<DEFAULT>0.45</DEFAULT>
</ARG>
<ARG>
<NAME>calf-sourceforge-net-plugins-RotarySpeaker::test</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,1]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>Test</NICK>
<BLURB>Test.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>calf-sourceforge-net-plugins-Reverb::amount</NAME>
<TYPE>gfloat</TYPE>
@ -50060,7 +50190,7 @@
<FLAGS>rwx</FLAGS>
<NICK>Foldover</NICK>
<BLURB>Foldover.</BLURB>
<DEFAULT>96</DEFAULT>
<DEFAULT>108</DEFAULT>
</ARG>
<ARG>
@ -50620,7 +50750,7 @@
<FLAGS>rwx</FLAGS>
<NICK>Vib Mod Amt</NICK>
<BLURB>Vib Mod Amt.</BLURB>
<DEFAULT>0.5</DEFAULT>
<DEFAULT>1</DEFAULT>
</ARG>
<ARG>
@ -50646,7 +50776,7 @@
<ARG>
<NAME>calf-sourceforge-net-plugins-Organ::vib-rate</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0.01,80]</RANGE>
<RANGE>[0.01,240]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>Vib Rate</NICK>
<BLURB>Vib Rate.</BLURB>
@ -50753,6 +50883,16 @@
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>calf-sourceforge-net-plugins-Organ::vib-type</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,4]</RANGE>
<FLAGS>rwx</FLAGS>
<NICK>Vib Type</NICK>
<BLURB>Vib Type.</BLURB>
<DEFAULT>3</DEFAULT>
</ARG>
<ARG>
<NAME>calf-sourceforge-net-plugins-Multibandcompressor::attack0</NAME>
<TYPE>gfloat</TYPE>
@ -57263,3 +57403,93 @@
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstMpegvParse::drop</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rwx</FLAGS>
<NICK>drop</NICK>
<BLURB>Drop data untill valid configuration data is received either in the stream or through caps.</BLURB>
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG>
<NAME>GstMpegvParse::gop-split</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rwx</FLAGS>
<NICK>gop-split</NICK>
<BLURB>Split frame when encountering GOP.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstFaceOverlay::h</NAME>
<TYPE>gfloat</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>face height percent</NICK>
<BLURB>Specify image height relative to face height.</BLURB>
<DEFAULT>1</DEFAULT>
</ARG>
<ARG>
<NAME>GstFaceOverlay::location</NAME>
<TYPE>gchar*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Location</NICK>
<BLURB>Location of SVG file to use for face overlay.</BLURB>
<DEFAULT>""</DEFAULT>
</ARG>
<ARG>
<NAME>GstFaceOverlay::w</NAME>
<TYPE>gfloat</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>face width percent</NICK>
<BLURB>Specify image width relative to face width.</BLURB>
<DEFAULT>1</DEFAULT>
</ARG>
<ARG>
<NAME>GstFaceOverlay::x</NAME>
<TYPE>gfloat</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>face x offset</NICK>
<BLURB>Specify image x relative to detected face x.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstFaceOverlay::y</NAME>
<TYPE>gfloat</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>face y offset</NICK>
<BLURB>Specify image y relative to detected face y.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstDebugSpy::checksum-type</NAME>
<TYPE>GChecksumType</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Checksum TYpe</NICK>
<BLURB>Checksum algorithm to use.</BLURB>
<DEFAULT>Use the SHA-1 hashing algorithm</DEFAULT>
</ARG>
<ARG>
<NAME>GstDebugSpy::silent</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Silent</NICK>
<BLURB>Produce verbose output ?.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>

10
docs/plugins/gst-plugins-bad-plugins.hierarchy
View file

@ -13,10 +13,17 @@ GObject
GstAsfMux
GstAsfParse
GstAssRender
GstBaseAudioVisualizer
GstSpaceScope
GstSpectraScope
GstSynaeScope
GstWaveScope
GstBaseParse
GstDiracParse
GstH263Parse
GstH264Parse
GstMpeg4VParse
GstMpegvParse
GstBaseRTPDepayload
GstRtpDTMFDepay
GstRtpVP8Depay
@ -66,6 +73,7 @@ GObject
GstCogcolorspace
GstCogdownsample
GstColorconvert
GstDebugSpy
GstDtmfDetect
GstHDVParse
GstLegacyresample
@ -137,6 +145,7 @@ GObject
GstBaseCameraSrc
GstWrapperCameraBinSrc
GstFPSDisplaySink
GstFaceOverlay
GstGSettingsSwitchSink
GstGSettingsAudioSink
GstGSettingsVideoSink
@ -188,7 +197,6 @@ GObject
GstMXFDemux
GstMXFMux
GstModPlug
GstMpeg4VParse
GstMpegPSDemux
GstMpegTSDemux
GstMplex

1
docs/plugins/gst-plugins-bad-plugins.interfaces
View file

@ -16,6 +16,7 @@ GstDfbVideoSink GstImplementsInterface GstNavigation GstColorBalance
GstDiracEnc GstPreset
GstFPSDisplaySink GstChildProxy
GstFaac GstPreset
GstFaceOverlay GstChildProxy
GstGSettingsAudioSink GstChildProxy
GstGSettingsAudioSrc GstChildProxy
GstGSettingsSwitchSink GstChildProxy

97
docs/plugins/inspect/plugin-audiovisualizers.xml Normal file
View file

@ -0,0 +1,97 @@
<plugin>
<name>audiovisualizers</name>
<description>Creates video visualizations of audio input</description>
<filename>../../gst/audiovisualizers/.libs/libgstaudiovisualizers.so</filename>
<basename>libgstaudiovisualizers.so</basename>
<version>0.10.22.1</version>
<license>GPL</license>
<source>gst-plugins-bad</source>
<package>GStreamer Bad Plug-ins git</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>spacescope</name>
<longname>Stereo visualizer</longname>
<class>Visualization</class>
<description>Simple stereo visualizer</description>
<author>Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
<element>
<name>spectrascope</name>
<longname>Frequency spectrum scope</longname>
<class>Visualization</class>
<description>Simple frequency spectrum scope</description>
<author>Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
<element>
<name>synaescope</name>
<longname>Synaescope</longname>
<class>Visualization</class>
<description>Creates video visualizations of audio input, using stereo and pitch information</description>
<author>Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
<element>
<name>wavescope</name>
<longname>Waveform oscilloscope</longname>
<class>Visualization</class>
<description>Simple waveform oscilloscope</description>
<author>Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
</elements>
</plugin>