mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-27 12:11:13 +00:00
Code Issues 1 Projects Releases Wiki Activity

scaletempo: improve the docs

Browse source 
Fix the syntax, add more explanation and xref the properties.
This commit is contained in:
Stefan Kost 2011-07-07 10:52:50 -07:00
parent 3b6cd3d35c
commit 266a57d77b
1 changed files with 18 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
gst/scaletempo/gstscaletempo.c
View file

@ -21,41 +21,39 @@
/**
* SECTION:element-scaletempo
*
* <refsect2>
* <para>
* Scale tempo while maintaining pitch
* (WSOLA-like technique with cross correlation)
* Inspired by SoundTouch library by Olli Parviainen
* </para>
* <para>
*
* Use Sceletempo to apply playback rates without the chipmunk effect.
* </para>
*
* <refsect2>
* <title>Example pipelines</title>
* <para>
* <programlisting>
* |[
* filesrc location=media.ext ! decodebin name=d \
* d. ! queue ! audioconvert ! audioresample ! scaletempo ! audioconvert ! audioresample ! autoaudiosink \
* d. ! queue ! ffmpegcolorspace ! autovideosink
* </programlisting>
* ]|
* OR
* <programlisting>
* |[
* playbin uri=... audio_sink="scaletempo ! audioconvert ! audioresample ! autoaudiosink"
* </programlisting>
* ]|
* When an application sends a seek event with rate != 1.0, Scaletempo applies
* the rate change by scaling the tempo without scaling the pitch.
* </para>
* <para>
* Scaletempo works by producing audio in constant sized chunks (a "stride") but
* consuming chunks proportional to the playback rate.
* </para>
* <para>
*
* Scaletempo works by producing audio in constant sized chunks
* (#GstScaletempo:stride) but consuming chunks proportional to the playback
* rate.
*
* Scaletempo then smooths the output by blending the end of one stride with
* the next ("overlap").
* </para>
* <para>
* the next (#GstScaletempo:overlap).
*
* Scaletempo smooths the overlap further by searching within the input buffer
* for the best overlap position. Scaletempo uses a statistical cross correlation
* (roughly a dot-product). Scaletempo consumes most of its CPU cycles here.
* for the best overlap position. Scaletempo uses a statistical cross
* correlation (roughly a dot-product). Scaletempo consumes most of its CPU
* cycles here. One can use the #GstScaletempo:search propery to tune how far
* the algoritm looks.
* </para>
* </refsect2>
*/