docs: add new accurip element to docs

https://bugzilla.gnome.org/show_bug.cgi?id=685163
This commit is contained in:
Tim-Philipp Müller 2012-10-28 16:41:15 +00:00
parent 8c81e39de0
commit 72353aeb71
8 changed files with 191 additions and 14 deletions

View file

@ -17,6 +17,7 @@
<chapter> <chapter>
<title>gst-plugins-bad Elements</title> <title>gst-plugins-bad Elements</title>
<xi:include href="xml/element-accurip.xml" />
<xi:include href="xml/element-assrender.xml" /> <xi:include href="xml/element-assrender.xml" />
<xi:include href="xml/element-autoconvert.xml" /> <xi:include href="xml/element-autoconvert.xml" />
<xi:include href="xml/element-bulge.xml" /> <xi:include href="xml/element-bulge.xml" />

View file

@ -1,3 +1,17 @@
<SECTION>
<FILE>element-accurip</FILE>
<TITLE>accurip</TITLE>
GstAccurip
<SUBSECTION Standard>
GST_ACCURIP
GST_ACCURIP_CLASS
GST_IS_ACCURIP
GST_IS_ACCURIP_CLASS
GST_TYPE_ACCURIP
GstAccuripClass
gst_accurip_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>element-aiffmux</FILE> <FILE>element-aiffmux</FILE>
<TITLE>aiffmux</TITLE> <TITLE>aiffmux</TITLE>

View file

@ -26900,7 +26900,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>physics</NICK> <NICK>physics</NICK>
<BLURB>water density: from 1 to 4.</BLURB> <BLURB>water density: from 1 to 4.</BLURB>
<DEFAULT>1.37974e-309</DEFAULT> <DEFAULT>5.17441e-317</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -26940,7 +26940,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>splash</NICK> <NICK>splash</NICK>
<BLURB>make a big splash in the center.</BLURB> <BLURB>make a big splash in the center.</BLURB>
<DEFAULT>1.37429e-309</DEFAULT> <DEFAULT>5.17484e-317</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -26950,7 +26950,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>splash</NICK> <NICK>splash</NICK>
<BLURB>make a big splash in the center.</BLURB> <BLURB>make a big splash in the center.</BLURB>
<DEFAULT>1.37974e-309</DEFAULT> <DEFAULT>6.79039e-313</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -26980,7 +26980,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>ratiox</NICK> <NICK>ratiox</NICK>
<BLURB>x-ratio.</BLURB> <BLURB>x-ratio.</BLURB>
<DEFAULT>1.38471e-316</DEFAULT> <DEFAULT>3.06544e-115</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -26990,7 +26990,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>ratioy</NICK> <NICK>ratioy</NICK>
<BLURB>y-ratio.</BLURB> <BLURB>y-ratio.</BLURB>
<DEFAULT>1.54342e-316</DEFAULT> <DEFAULT>1.53064e-18</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27000,7 +27000,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>DelayTime</NICK> <NICK>DelayTime</NICK>
<BLURB>the delay time.</BLURB> <BLURB>the delay time.</BLURB>
<DEFAULT>0</DEFAULT> <DEFAULT>7.06238e-304</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27030,7 +27030,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>Color</NICK> <NICK>Color</NICK>
<BLURB>the color of the image.</BLURB> <BLURB>the color of the image.</BLURB>
<DEFAULT>8.10621e-38</DEFAULT> <DEFAULT>0.011489</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27040,7 +27040,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>Color</NICK> <NICK>Color</NICK>
<BLURB>the color of the image.</BLURB> <BLURB>the color of the image.</BLURB>
<DEFAULT>0</DEFAULT> <DEFAULT>9.33458e-15</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27050,7 +27050,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>Color-R</NICK> <NICK>Color-R</NICK>
<BLURB>the color of the image.</BLURB> <BLURB>the color of the image.</BLURB>
<DEFAULT>6.30565e-38</DEFAULT> <DEFAULT>8.37068e-21</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27380,7 +27380,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>lredscale</NICK> <NICK>lredscale</NICK>
<BLURB>multiplier for downscaling non-edge brightness.</BLURB> <BLURB>multiplier for downscaling non-edge brightness.</BLURB>
<DEFAULT>5.33591e-322</DEFAULT> <DEFAULT>0</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27400,7 +27400,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>lupscale</NICK> <NICK>lupscale</NICK>
<BLURB>multiplier for upscaling edge brightness.</BLURB> <BLURB>multiplier for upscaling edge brightness.</BLURB>
<DEFAULT>0</DEFAULT> <DEFAULT>1.34037e-317</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27580,7 +27580,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>fader</NICK> <NICK>fader</NICK>
<BLURB>the fader position.</BLURB> <BLURB>the fader position.</BLURB>
<DEFAULT>1.37429e-309</DEFAULT> <DEFAULT>3.40905e-322</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -27760,7 +27760,7 @@
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>HSync</NICK> <NICK>HSync</NICK>
<BLURB>the hsync offset.</BLURB> <BLURB>the hsync offset.</BLURB>
<DEFAULT>2.36249e-310</DEFAULT> <DEFAULT>0</DEFAULT>
</ARG> </ARG>
<ARG> <ARG>
@ -59433,3 +59433,23 @@
<DEFAULT>0</DEFAULT> <DEFAULT>0</DEFAULT>
</ARG> </ARG>
<ARG>
<NAME>GstAccurip::first-track</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>First track</NICK>
<BLURB>Indicate to the CRC calculation algorithm that this is the first track of a set.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstAccurip::last-track</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Last track</NICK>
<BLURB>Indicate to the CRC calculation algorithm that this is the last track of a set.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>

View file

@ -18,12 +18,14 @@ GObject
GstFaad GstFaad
GstGSMDec GstGSMDec
GstMpg123AudioDec GstMpg123AudioDec
GstOpusDec
GstSirenDec GstSirenDec
GstAudioEncoder GstAudioEncoder
ADPCMEnc ADPCMEnc
GstCeltEnc GstCeltEnc
GstFaac GstFaac
GstGSMEnc GstGSMEnc
GstOpusEnc
GstSirenEnc GstSirenEnc
GstVoAacEnc GstVoAacEnc
GstVoAmrWbEnc GstVoAmrWbEnc
@ -39,6 +41,8 @@ GObject
GstIRTSPParse GstIRTSPParse
GstMpeg4VParse GstMpeg4VParse
GstMpegvParse GstMpegvParse
GstOpusParse
GstVC1Parse
GstBaseSink GstBaseSink
GstChecksumSink GstChecksumSink
GstCurlBaseSink GstCurlBaseSink
@ -75,6 +79,7 @@ GObject
GstRTPDTMFSrc GstRTPDTMFSrc
GstBaseTransform GstBaseTransform
GstAudioFilter GstAudioFilter
GstAccurip
GstBPMDetect GstBPMDetect
GstChromaprint GstChromaprint
GstBayer2RGB GstBayer2RGB
@ -202,6 +207,7 @@ GObject
GstJifMux GstJifMux
GstJpegParse GstJpegParse
GstLiveAdder GstLiveAdder
GstMXFDemux
GstMimDec GstMimDec
GstMimEnc GstMimEnc
GstModPlug GstModPlug
@ -216,10 +222,12 @@ GObject
GstPnmenc GstPnmenc
GstPyramidSegment GstPyramidSegment
GstRTPBaseDepayload GstRTPBaseDepayload
GstRTPOpusDepay
GstRtpDTMFDepay GstRtpDTMFDepay
GstRtpVP8Depay GstRtpVP8Depay
GstRTPBasePayload GstRTPBasePayload
GstRtpAsfPay GstRtpAsfPay
GstRtpOPUSPay
GstRtpVP8Pay GstRtpVP8Pay
GstRTPMux GstRTPMux
GstRTPDTMFMux GstRTPDTMFMux
@ -285,6 +293,78 @@ GObject
GstTask GstTask
GstTaskPool GstTaskPool
GstEncodingProfile GstEncodingProfile
MXFMetadataBase
MXFDescriptiveMetadata
MXFDMS1
MXFDMS1Address
MXFDMS1Communications
MXFDMS1ContactsList
MXFDMS1Framework
MXFDMS1ProductionClipFramework
MXFDMS1ClipFramework
MXFDMS1ProductionFramework
MXFDMS1SceneFramework
MXFDMS1NameValue
MXFDMS1PictureFormat
MXFDMS1Processing
MXFDMS1Project
MXFDMS1Publication
MXFDMS1TextLanguage
MXFDMS1Branding
MXFDMS1CueWords
MXFDMS1Shot
MXFDMS1Thesaurus
MXFDMS1Annotation
MXFDMS1Award
MXFDMS1CaptionsDescription
MXFDMS1Classification
MXFDMS1Contact
MXFDMS1Location
MXFDMS1Organisation
MXFDMS1Person
MXFDMS1Contract
MXFDMS1DeviceParameters
MXFDMS1Event
MXFDMS1GroupRelationship
MXFDMS1Identification
MXFDMS1KeyPoint
MXFDMS1Participant
MXFDMS1Rights
MXFDMS1Scripting
MXFDMS1SettingPeriod
MXFDMS1Titles
MXFMetadata
MXFMetadataContentStorage
MXFMetadataEssenceContainerData
MXFMetadataGenericDescriptor
MXFMetadataFileDescriptor
MXFMetadataGenericDataEssenceDescriptor
MXFMetadataGenericPictureEssenceDescriptor
MXFMetadataCDCIPictureEssenceDescriptor
MXFMetadataMPEGVideoDescriptor
MXFMetadataRGBAPictureEssenceDescriptor
MXFMetadataGenericSoundEssenceDescriptor
MXFMetadataWaveAudioEssenceDescriptor
MXFMetadataAES3AudioEssenceDescriptor
MXFMetadataMultipleDescriptor
MXFMetadataGenericPackage
MXFMetadataMaterialPackage
MXFMetadataSourcePackage
MXFMetadataIdentification
MXFMetadataLocator
MXFMetadataNetworkLocator
MXFMetadataTextLocator
MXFMetadataPreface
MXFMetadataSequence
MXFMetadataStructuralComponent
MXFMetadataDMSegment
MXFMetadataSourceClip
MXFMetadataDMSourceClip
MXFMetadataTimecodeComponent
MXFMetadataTrack
MXFMetadataEventTrack
MXFMetadataStaticTrack
MXFMetadataTimelineTrack
GInterface GInterface
GTypePlugin GTypePlugin
GstChildProxy GstChildProxy
@ -293,3 +373,4 @@ GInterface
GstTagSetter GstTagSetter
GstTagXmpWriter GstTagXmpWriter
GstURIHandler GstURIHandler
MXFDescriptiveMetadataFrameworkInterface

View file

@ -55,5 +55,10 @@ GstVoAacEnc GstPreset
GstVoAmrWbEnc GstPreset GstVoAmrWbEnc GstPreset
GstWrapperCameraBinSrc GstChildProxy GstWrapperCameraBinSrc GstChildProxy
GstXvidEnc GstPreset GstXvidEnc GstPreset
MXFDMS1ClipFramework MXFDescriptiveMetadataFrameworkInterface
MXFDMS1Framework MXFDescriptiveMetadataFrameworkInterface
MXFDMS1ProductionClipFramework MXFDescriptiveMetadataFrameworkInterface
MXFDMS1ProductionFramework MXFDescriptiveMetadataFrameworkInterface
MXFDMS1SceneFramework MXFDescriptiveMetadataFrameworkInterface
RsnDvdBin GstChildProxy GstURIHandler RsnDvdBin GstChildProxy GstURIHandler
VdpSink GstImplementsInterface GstNavigation GstXOverlay VdpSink GstImplementsInterface GstNavigation GstXOverlay

View file

@ -0,0 +1,34 @@
<plugin>
<name>accurip</name>
<description>Computes an AccurateRip CRC</description>
<filename>../../gst/accurip/.libs/libgstaccurip.so</filename>
<basename>libgstaccurip.so</basename>
<version>1.1.0.1</version>
<license>LGPL</license>
<source>gst-plugins-bad</source>
<package>GStreamer Bad Plug-ins git</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>accurip</name>
<longname>AccurateRip(TM) CRC element</longname>
<class>Filter/Analyzer/Audio</class>
<description>Computes an AccurateRip CRC</description>
<author>Christophe Fergeau &lt;teuf@gnome.org&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw, format=(string)S16LE, rate=(int)44100, channels=(int)2</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw, format=(string)S16LE, rate=(int)44100, channels=(int)2</details>
</caps>
</pads>
</element>
</elements>
</plugin>

View file

@ -114,5 +114,26 @@
</caps> </caps>
</pads> </pads>
</element> </element>
<element>
<name>vc1parse</name>
<longname>VC1 parser</longname>
<class>Codec/Parser/Converter/Video</class>
<description>Parses VC1 streams</description>
<author>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-wmv, wmvversion=(int)3, format=(string){ WVC1, WMV3 }</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-wmv, wmvversion=(int)3, format=(string){ WVC1, WMV3 }, stream-format=(string){ bdu, bdu-frame, sequence-layer-bdu, sequence-layer-bdu-frame, sequence-layer-raw-frame, sequence-layer-frame-layer, asf, frame-layer }, header-format=(string){ none, asf, sequence-layer }</details>
</caps>
</pads>
</element>
</elements> </elements>
</plugin> </plugin>

View file

@ -33,6 +33,7 @@
/** /**
* SECTION:element-accurip * SECTION:element-accurip
* @short_desc: Computes an AccurateRip CRC
* *
* The accurip element calculates a CRC for an audio stream which can be used * The accurip element calculates a CRC for an audio stream which can be used
* to match the audio stream to a database hosted on * to match the audio stream to a database hosted on
@ -42,7 +43,7 @@
* <refsect2> * <refsect2>
* <title>Example launch line</title> * <title>Example launch line</title>
* |[ * |[
* gst-launch -m uridecodebin uri=file:///path/to/song.flac ! audioconvert ! accurip ! fakesink * gst-launch-1.0 -m uridecodebin uri=file:///path/to/song.flac ! audioconvert ! accurip ! fakesink
* ]| * ]|
* </refsect2> * </refsect2>
*/ */