mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-04-16 21:14:44 +00:00
docs: add Opus to docs
This commit is contained in:
Tim-Philipp Müller
parent
f331412a37
commit
fd9e22e5e9
6 changed files with 238 additions and 2 deletions
|
|
@ -44,6 +44,8 @@
|
|||
<xi:include href="xml/element-ogmaudioparse.xml" />
|
||||
<xi:include href="xml/element-ogmtextparse.xml" />
|
||||
<xi:include href="xml/element-ogmvideoparse.xml" />
|
||||
<xi:include href="xml/element-opusdec.xml" />
|
||||
<xi:include href="xml/element-opusenc.xml" />
|
||||
<xi:include href="xml/element-playbin.xml" />
|
||||
<xi:include href="xml/element-playsink.xml" />
|
||||
<xi:include href="xml/element-socketsrc.xml" />
|
||||
|
|
@ -90,6 +92,7 @@
|
|||
<xi:include href="xml/plugin-ivorbisdec.xml" />
|
||||
<xi:include href="xml/plugin-libvisual.xml" />
|
||||
<xi:include href="xml/plugin-ogg.xml" />
|
||||
<xi:include href="xml/plugin-opus.xml" />
|
||||
<xi:include href="xml/plugin-pango.xml" />
|
||||
<xi:include href="xml/plugin-playback.xml" />
|
||||
<xi:include href="xml/plugin-subparse.xml" />
|
||||
|
|
|
|||
|
|
@ -490,6 +490,32 @@ GST_TYPE_OGM_VIDEO_PARSE
|
|||
gst_ogm_video_parse_get_type
|
||||
</SECTION>
|
||||
|
||||
<FILE>element-opusdec</FILE>
|
||||
<TITLE>opusdec</TITLE>
|
||||
GstOpusDec
|
||||
<SUBSECTION Standard>
|
||||
GstOpusDecClass
|
||||
gst_opus_dec_get_type
|
||||
GST_TYPE_OPUS_DEC
|
||||
GST_OPUS_DEC
|
||||
GST_OPUS_DEC_CLASS
|
||||
GST_IS_OPUS_DEC
|
||||
GST_IS_OPUS_DEC_CLASS
|
||||
</SECTION>
|
||||
|
||||
<FILE>element-opusenc</FILE>
|
||||
<TITLE>opusenc</TITLE>
|
||||
GstOpusEnc
|
||||
<SUBSECTION Standard>
|
||||
GstOpusEncClass
|
||||
gst_opus_enc_get_type
|
||||
GST_TYPE_OPUS_ENC
|
||||
GST_OPUS_ENC
|
||||
GST_OPUS_ENC_CLASS
|
||||
GST_IS_OPUS_ENC
|
||||
GST_IS_OPUS_ENC_CLASS
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>element-playbin</FILE>
|
||||
<TITLE>playbin</TITLE>
|
||||
|
|
|
|||
|
|
@ -2598,3 +2598,153 @@
|
|||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::audio</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Audio or voice</NICK>
|
||||
<BLURB>Audio or voice (DEPRECATED: use audio-type).</BLURB>
|
||||
<DEFAULT>TRUE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::audio-type</NAME>
|
||||
<TYPE>GstOpusEncAudioType</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>What type of audio to optimize for</NICK>
|
||||
<BLURB>What type of audio to optimize for.</BLURB>
|
||||
<DEFAULT>Generic audio</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::bandwidth</NAME>
|
||||
<TYPE>GstOpusEncBandwidth</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Band Width</NICK>
|
||||
<BLURB>Audio Band Width.</BLURB>
|
||||
<DEFAULT>Full band</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::bitrate</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<RANGE>[4000,650000]</RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Encoding Bit-rate</NICK>
|
||||
<BLURB>Specify an encoding bit-rate (in bps).</BLURB>
|
||||
<DEFAULT>64000</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::bitrate-type</NAME>
|
||||
<TYPE>GstOpusEncBitrateType</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Bitrate type</NICK>
|
||||
<BLURB>Bitrate type.</BLURB>
|
||||
<DEFAULT>CBR</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::cbr</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Constant bit rate</NICK>
|
||||
<BLURB>Constant bit rate (DEPRECATED: use bitrate-type).</BLURB>
|
||||
<DEFAULT>TRUE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::complexity</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<RANGE>[0,10]</RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Complexity</NICK>
|
||||
<BLURB>Complexity.</BLURB>
|
||||
<DEFAULT>10</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::constrained-vbr</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Constrained VBR</NICK>
|
||||
<BLURB>Constrained VBR (DEPRECATED: use bitrate-type).</BLURB>
|
||||
<DEFAULT>TRUE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::dtx</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>DTX</NICK>
|
||||
<BLURB>DTX.</BLURB>
|
||||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::frame-size</NAME>
|
||||
<TYPE>GstOpusEncFrameSize</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Frame Size</NICK>
|
||||
<BLURB>The duration of an audio frame, in ms.</BLURB>
|
||||
<DEFAULT>20</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::inband-fec</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>In-band FEC</NICK>
|
||||
<BLURB>Enable forward error correction.</BLURB>
|
||||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::max-payload-size</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<RANGE>[2,4000]</RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Max payload size</NICK>
|
||||
<BLURB>Maximum payload size in bytes.</BLURB>
|
||||
<DEFAULT>4000</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusEnc::packet-loss-percentage</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<RANGE>[0,100]</RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Loss percentage</NICK>
|
||||
<BLURB>Packet loss percentage.</BLURB>
|
||||
<DEFAULT>0</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusDec::apply-gain</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Apply gain</NICK>
|
||||
<BLURB>Apply gain if any is specified in the header.</BLURB>
|
||||
<DEFAULT>TRUE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GstOpusDec::use-inband-fec</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<RANGE></RANGE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
<NICK>Use in-band FEC</NICK>
|
||||
<BLURB>Use forward error correction if available (needs PLC enabled).</BLURB>
|
||||
<DEFAULT>FALSE</DEFAULT>
|
||||
</ARG>
|
||||
|
||||
|
|
|
|||
|
|
@ -15,11 +15,13 @@ GObject
|
|||
GstElement
|
||||
GstAdder
|
||||
GstAudioDecoder
|
||||
GstOpusDec
|
||||
GstVorbisDec
|
||||
GstAudioEncoder
|
||||
GstOpusEnc
|
||||
GstVorbisEnc
|
||||
GstAudioRate
|
||||
GstAudioVisualizer-BaseExtLibvisual
|
||||
GstAudioVisualizer
|
||||
GstVisual
|
||||
GstVisualbumpscope
|
||||
GstVisualcorona
|
||||
|
|
@ -126,7 +128,6 @@ GObject
|
|||
PangoFcFontMap
|
||||
PangoCairoFcFontMap
|
||||
GInterface
|
||||
GDatagramBased
|
||||
GFile
|
||||
GInitable
|
||||
GTypePlugin
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ GstEncodeBin GstChildProxy
|
|||
GstGioSink GstURIHandler
|
||||
GstGioSrc GstURIHandler
|
||||
GstOggMux GstPreset
|
||||
GstOpusEnc GstPreset GstTagSetter
|
||||
GstPipeline GstChildProxy
|
||||
GstPlayBin GstChildProxy GstStreamVolume GstVideoOverlay GstNavigation GstColorBalance
|
||||
GstPlaySink GstChildProxy GstStreamVolume GstVideoOverlay GstNavigation GstColorBalance
|
||||
|
|
|
|||
55
docs/plugins/inspect/plugin-opus.xml
Normal file
55
docs/plugins/inspect/plugin-opus.xml
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
<plugin>
|
||||
<name>opus</name>
|
||||
<description>OPUS plugin library</description>
|
||||
<filename>../../ext/opus/.libs/libgstopus.so</filename>
|
||||
<basename>libgstopus.so</basename>
|
||||
<version>1.7.2.1</version>
|
||||
<license>LGPL</license>
|
||||
<source>gst-plugins-base</source>
|
||||
<package>GStreamer Base Plug-ins git</package>
|
||||
<origin>Unknown package origin</origin>
|
||||
<elements>
|
||||
<element>
|
||||
<name>opusdec</name>
|
||||
<longname>Opus audio decoder</longname>
|
||||
<class>Codec/Decoder/Audio</class>
|
||||
<description>decode opus streams to audio</description>
|
||||
<author>Vincent Penquerc'h <vincent.penquerch@collabora.co.uk></author>
|
||||
<pads>
|
||||
<caps>
|
||||
<name>sink</name>
|
||||
<direction>sink</direction>
|
||||
<presence>always</presence>
|
||||
<details>audio/x-opus, channel-mapping-family=(int)0; audio/x-opus, channel-mapping-family=(int)[ 1, 255 ], channels=(int)[ 1, 255 ], stream-count=(int)[ 1, 255 ], coupled-count=(int)[ 0, 255 ]</details>
|
||||
</caps>
|
||||
<caps>
|
||||
<name>src</name>
|
||||
<direction>source</direction>
|
||||
<presence>always</presence>
|
||||
<details>audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 48000, 24000, 16000, 12000, 8000 }, channels=(int)[ 1, 8 ]</details>
|
||||
</caps>
|
||||
</pads>
|
||||
</element>
|
||||
<element>
|
||||
<name>opusenc</name>
|
||||
<longname>Opus audio encoder</longname>
|
||||
<class>Codec/Encoder/Audio</class>
|
||||
<description>Encodes audio in Opus format</description>
|
||||
<author>Vincent Penquerc'h <vincent.penquerch@collabora.co.uk></author>
|
||||
<pads>
|
||||
<caps>
|
||||
<name>sink</name>
|
||||
<direction>sink</direction>
|
||||
<presence>always</presence>
|
||||
<details>audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int)48000, channels=(int)[ 1, 8 ]; audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 12000, 16000, 24000 }, channels=(int)[ 1, 8 ]</details>
|
||||
</caps>
|
||||
<caps>
|
||||
<name>src</name>
|
||||
<direction>source</direction>
|
||||
<presence>always</presence>
|
||||
<details>audio/x-opus</details>
|
||||
</caps>
|
||||
</pads>
|
||||
</element>
|
||||
</elements>
|
||||
</plugin>
|
||||
Loading…
Reference in a new issue