gstreamer/docs/libs/gst-plugins-base-libs-docs.sgml
Sebastian Dröge 9022ca9d1b Add libgstfft, a FFT library based on Kiss FFT which is
Original commit message from CVS:
Reviewed by:  Stefan Kost  <ensonic@users.sf.net>
* configure.ac:
* gst-libs/gst/Makefile.am:
* gst-libs/gst/fft/Makefile.am:
* gst-libs/gst/fft/_kiss_fft_guts_f32.h:
* gst-libs/gst/fft/_kiss_fft_guts_f64.h:
* gst-libs/gst/fft/_kiss_fft_guts_s16.h:
* gst-libs/gst/fft/_kiss_fft_guts_s32.h:
* gst-libs/gst/fft/gstfft.c: (gst_fft_next_fast_length):
* gst-libs/gst/fft/gstfft.h:
* gst-libs/gst/fft/gstfftf32.c: (gst_fft_f32_new),
(gst_fft_f32_fft), (gst_fft_f32_inverse_fft), (gst_fft_f32_free),
(gst_fft_f32_window), (gst_fft_f32_magnitude), (gst_fft_f32_phase):
* gst-libs/gst/fft/gstfftf32.h:
* gst-libs/gst/fft/gstfftf64.c: (gst_fft_f64_new),
(gst_fft_f64_fft), (gst_fft_f64_inverse_fft), (gst_fft_f64_free),
(gst_fft_f64_window), (gst_fft_f64_magnitude), (gst_fft_f64_phase):
* gst-libs/gst/fft/gstfftf64.h:
* gst-libs/gst/fft/gstffts16.c: (gst_fft_s16_new),
(gst_fft_s16_fft), (gst_fft_s16_inverse_fft), (gst_fft_s16_free),
(gst_fft_s16_window), (gst_fft_s16_magnitude), (gst_fft_s16_phase):
* gst-libs/gst/fft/gstffts16.h:
* gst-libs/gst/fft/gstffts32.c: (gst_fft_s32_new),
(gst_fft_s32_fft), (gst_fft_s32_inverse_fft), (gst_fft_s32_free),
(gst_fft_s32_window), (gst_fft_s32_magnitude), (gst_fft_s32_phase):
* gst-libs/gst/fft/gstffts32.h:
* gst-libs/gst/fft/kiss_fft_f32.c: (kf_bfly2), (kf_bfly4),
(kf_bfly3), (kf_bfly5), (kf_bfly_generic), (kf_work), (kf_factor),
(kiss_fft_f32_alloc), (kiss_fft_f32_stride), (kiss_fft_f32),
(kiss_fft_f32_cleanup), (kiss_fft_f32_next_fast_size):
* gst-libs/gst/fft/kiss_fft_f32.h:
* gst-libs/gst/fft/kiss_fft_f64.c: (kf_bfly2), (kf_bfly4),
(kf_bfly3), (kf_bfly5), (kf_bfly_generic), (kf_work), (kf_factor),
(kiss_fft_f64_alloc), (kiss_fft_f64_stride), (kiss_fft_f64),
(kiss_fft_f64_cleanup), (kiss_fft_f64_next_fast_size):
* gst-libs/gst/fft/kiss_fft_f64.h:
* gst-libs/gst/fft/kiss_fft_s16.c: (kf_bfly2), (kf_bfly4),
(kf_bfly3), (kf_bfly5), (kf_bfly_generic), (kf_work), (kf_factor),
(kiss_fft_s16_alloc), (kiss_fft_s16_stride), (kiss_fft_s16),
(kiss_fft_s16_cleanup), (kiss_fft_s16_next_fast_size):
* gst-libs/gst/fft/kiss_fft_s16.h:
* gst-libs/gst/fft/kiss_fft_s32.c: (kf_bfly2), (kf_bfly4),
(kf_bfly3), (kf_bfly5), (kf_bfly_generic), (kf_work), (kf_factor),
(kiss_fft_s32_alloc), (kiss_fft_s32_stride), (kiss_fft_s32),
(kiss_fft_s32_cleanup), (kiss_fft_s32_next_fast_size):
* gst-libs/gst/fft/kiss_fft_s32.h:
* gst-libs/gst/fft/kiss_fftr_f32.c: (kiss_fftr_f32_alloc),
(kiss_fftr_f32), (kiss_fftri_f32):
* gst-libs/gst/fft/kiss_fftr_f32.h:
* gst-libs/gst/fft/kiss_fftr_f64.c: (kiss_fftr_f64_alloc),
(kiss_fftr_f64), (kiss_fftri_f64):
* gst-libs/gst/fft/kiss_fftr_f64.h:
* gst-libs/gst/fft/kiss_fftr_s16.c: (kiss_fftr_s16_alloc),
(kiss_fftr_s16), (kiss_fftri_s16):
* gst-libs/gst/fft/kiss_fftr_s16.h:
* gst-libs/gst/fft/kiss_fftr_s32.c: (kiss_fftr_s32_alloc),
(kiss_fftr_s32), (kiss_fftri_s32):
* gst-libs/gst/fft/kiss_fftr_s32.h:
* gst-libs/gst/fft/kiss_version:
* pkgconfig/gstreamer-plugins-base-uninstalled.pc.in:
* pkgconfig/gstreamer-plugins-base.pc.in:
Add libgstfft, a FFT library based on Kiss FFT which is
BSD licensed. Supported sample formats are int16, int32,
float and double. For those formats a real FFT and IFFT
can be done, different windowing functions can be applied
and functions for extracting the magnitude and phase exist.
Fixes #468619.
* docs/libs/Makefile.am:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
Integrate libgstfft into the docs.
* tests/check/Makefile.am:
* tests/check/libs/fft.c: (GST_START_TEST), (fft_suite), (main):
Add unit tests for libgstfft, currently only testing the FFT.
Unit tests for IFFT will follow soon.
2007-09-06 07:00:36 +00:00

278 lines
10 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY GstCompiling SYSTEM "compiling.sgml">
<!-- audio -->
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstAudioClock SYSTEM "xml/gstaudioclock.xml">
<!ENTITY GstAudioFilter SYSTEM "xml/gstaudiofilter.xml">
<!ENTITY GstAudioMixerUtils SYSTEM "xml/gstaudiomixerutils.xml">
<!ENTITY GstAudioSink SYSTEM "xml/gstaudiosink.xml">
<!ENTITY GstAudioSrc SYSTEM "xml/gstaudiosrc.xml">
<!ENTITY GstBaseAudioSink SYSTEM "xml/gstbaseaudiosink.xml">
<!ENTITY GstBaseAudioSrc SYSTEM "xml/gstbaseaudiosrc.xml">
<!ENTITY GstMultiChannel SYSTEM "xml/gstmultichannel.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!-- cdda -->
<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
<!-- fft -->
<!ENTITY GstFFT SYSTEM "xml/gstfft.xml">
<!ENTITY GstFFTS16 SYSTEM "xml/gstffts16.xml">
<!ENTITY GstFFTS32 SYSTEM "xml/gstffts32.xml">
<!ENTITY GstFFTF32 SYSTEM "xml/gstfftf32.xml">
<!ENTITY GstFFTF64 SYSTEM "xml/gstfftf64.xml">
<!-- floatcast -->
<!ENTITY GstFloatCast SYSTEM "xml/gstfloatcast.xml">
<!-- interfaces -->
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstColorBalanceChannel SYSTEM "xml/gstcolorbalancechannel.xml">
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstMixerOptions SYSTEM "xml/gstmixeroptions.xml">
<!ENTITY GstMixerTrack SYSTEM "xml/gstmixertrack.xml">
<!ENTITY GstNavigation SYSTEM "xml/gstnavigation.xml">
<!ENTITY GstPropertyProbe SYSTEM "xml/gstpropertyprobe.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstTunerChannel SYSTEM "xml/gsttunerchannel.xml">
<!ENTITY GstTunerNorm SYSTEM "xml/gsttunernorm.xml">
<!ENTITY GstVideoOrientation SYSTEM "xml/gstvideoorientation.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
<!-- netbuffer -->
<!ENTITY GstNetBuffer SYSTEM "xml/gstnetbuffer.xml">
<!-- riff -->
<!ENTITY GstRiff SYSTEM "xml/gstriff.xml">
<!-- rtp -->
<!ENTITY GstBaseRtpAudioPayload SYSTEM "xml/gstbasertpaudiopayload.xml">
<!ENTITY GstBaseRtpDepayload SYSTEM "xml/gstbasertpdepayload.xml">
<!ENTITY GstBaseRtpPayload SYSTEM "xml/gstbasertppayload.xml">
<!ENTITY GstRtpBuffer SYSTEM "xml/gstrtpbuffer.xml">
<!ENTITY GstRtcpBuffer SYSTEM "xml/gstrtcpbuffer.xml">
<!-- rtsp -->
<!ENTITY GstRTSPBase64 SYSTEM "xml/gstrtspbase64.xml">
<!ENTITY GstRTSPConnection SYSTEM "xml/gstrtspconnection.xml">
<!ENTITY GstRTSPDefs SYSTEM "xml/gstrtspdefs.xml">
<!ENTITY GstRTSPMessage SYSTEM "xml/gstrtspmessage.xml">
<!ENTITY GstRTSPRange SYSTEM "xml/gstrtsprange.xml">
<!ENTITY GstRTSPTransport SYSTEM "xml/gstrtsptransport.xml">
<!ENTITY GstRTSPUrl SYSTEM "xml/gstrtspurl.xml">
<!-- sdp -->
<!ENTITY GstSDP SYSTEM "xml/gstsdp.xml">
<!ENTITY GstSDPMessage SYSTEM "xml/gstsdpmessage.xml">
<!-- tag -->
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagVorbis SYSTEM "xml/gsttagvorbis.xml">
<!ENTITY GstTagID3 SYSTEM "xml/gsttagid3.xml">
<!-- utils -->
<!ENTITY GstPBUtils SYSTEM "xml/gstpbutils.xml">
<!ENTITY GstPBUtilsDescriptions SYSTEM "xml/gstpbutilsdescriptions.xml">
<!ENTITY GstPBUtilsMissingPlugins SYSTEM "xml/gstpbutilsmissingplugins.xml">
<!ENTITY GstPBUtilsInstallPlugins SYSTEM "xml/gstpbutilsinstallplugins.xml">
<!-- video -->
<!ENTITY GstVideo SYSTEM "xml/gstvideo.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
<!-- generated by gtkdoc-mkdb -->
<!ENTITY gst-plugin-libs-tree-index SYSTEM "xml/tree_index.sgml">
]>
<book id="index">
<bookinfo>
<title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>
for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/</ulink>.
</releaseinfo>
</bookinfo>
<part id="gstreamer-plugins-base">
<title>GStreamer Base Plugins Libraries</title>
<para>
This manual describes the libraries provided by the GStreamer Base Plugins
package.
</para>
&GstCompiling;
<chapter id="gstreamer-audio">
<title>Audio Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstAudio;
&GstAudioClock;
&GstAudioFilter;
&GstAudioMixerUtils;
&GstBaseAudioSink;
&GstBaseAudioSrc;
&GstAudioSink;
&GstAudioSrc;
&GstMultiChannel;
&GstRingBuffer;
</chapter>
<chapter id="gstreamer-cdda">
<title>CDDA Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstCddaBaseSrc;
</chapter>
<chapter id="gstreamer-ffft">
<title>FFT Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstfft-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstFFT;
&GstFFTS16;
&GstFFTS32;
&GstFFTF32;
&GstFFTF64;
</chapter>
<chapter id="gstreamer-floatcast">
<title>FloatCast Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstfloatcase-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstFloatCast;
</chapter>
<chapter id="gstreamer-interfaces">
<title>Interfaces Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstColorBalance;
&GstColorBalanceChannel;
&GstMixer;
&GstMixerOptions;
&GstMixerTrack;
&GstNavigation;
&GstPropertyProbe;
&GstTuner;
&GstTunerChannel;
&GstTunerNorm;
&GstVideoOrientation;
&GstXOverlay;
</chapter>
<chapter id="gstreamer-netbuffer">
<title>Network Buffer Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstnetbuffer-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstNetBuffer;
</chapter>
<chapter id="gstreamer-riff">
<title>Riff Media Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstriff-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstRiff;
</chapter>
<chapter id="gstreamer-rtp">
<title>RTP Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstrtp-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstBaseRtpAudioPayload;
&GstBaseRtpDepayload;
&GstBaseRtpPayload;
&GstRtpBuffer;
&GstRtcpBuffer;
</chapter>
<chapter id="gstreamer-rtsp">
<title>RTSP Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstrtsp-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstRTSPBase64;
&GstRTSPConnection;
&GstRTSPDefs;
&GstRTSPMessage;
&GstRTSPRange;
&GstRTSPTransport;
&GstRTSPUrl;
</chapter>
<chapter id="gstreamer-sdp">
<title>SDP Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstsdp-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstSDPMessage;
</chapter>
<chapter id="gstreamer-tag">
<title>Tag Support Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstTag;
&GstTagVorbis;
&GstTagID3;
</chapter>
<chapter id="gstreamer-base-utils">
<title>Base Utils Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstpbutils-&GST_MAJORMINOR;</filename> to the library
flags.
</para>
&GstPBUtils;
&GstPBUtilsDescriptions;
&GstPBUtilsMissingPlugins;
&GstPBUtilsInstallPlugins;
</chapter>
<chapter id="gstreamer-video">
<title>Video Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstVideo;
&GstVideoSink;
&GstVideoFilter;
</chapter>
</part>
<part id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gst-plugin-libs-tree-index;
</part>
<index id="api-index">
<title>Index</title>
</index>
</book>