diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:29:42 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:32:59 +0200 |
| commit | a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch) | |
| tree | 4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/audiofx/audiowsinclimit.c | |
| parent | 00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff) | |
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/audiofx/audiowsinclimit.c')
| -rw-r--r-- | gst/audiofx/audiowsinclimit.c | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/gst/audiofx/audiowsinclimit.c b/gst/audiofx/audiowsinclimit.c index 1f33ad2d..73bdbe50 100644 --- a/gst/audiofx/audiowsinclimit.c +++ b/gst/audiofx/audiowsinclimit.c @@ -30,28 +30,23 @@ /** * SECTION:element-audiowsinclimit - * @short_description: Windowed Sinc low pass and high pass filter * - * <refsect2> - * <para> * Attenuates all frequencies above the cutoff frequency (low-pass) or all frequencies below the * cutoff frequency (high-pass). The length parameter controls the rolloff, the window parameter * controls rolloff and stopband attenuation. The Hamming window provides a faster rolloff but a bit * worse stopband attenuation, the other way around for the Blackman window. - * </para> - * <para> + * * This element has the advantage over the Chebyshev lowpass and highpass filter that it has * a much better rolloff when using a larger kernel size and almost linear phase. The only * disadvantage is the much slower execution time with larger kernels. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch audiotestsrc freq=1500 ! audioconvert ! audiowsinclimit mode=low-pass frequency=1000 length=501 ! audioconvert ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiowsinclimit mode=high-pass frequency=15000 length=501 ! audioconvert ! alsasink * gst-launch audiotestsrc wave=white-noise ! audioconvert ! audiowsinclimit mode=low-pass frequency=1000 length=10001 window=blackman ! audioconvert ! alsasink - * </programlisting> - * </para> + * ]| * </refsect2> */ |