From: Stefan Kost <ensonic@users.sf.net>
Date: Thu, 7 Jul 2011 17:52:50 +0000 (-0700)
Subject: scaletempo: improve the docs
X-Git-Tag: 1.19.3~507^2~16045^2~115
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=266a57d77bae82b98d3f9cf50794be4be4381f1f;p=platform%2Fupstream%2Fgstreamer.git

scaletempo: improve the docs

Fix the syntax, add more explanation and xref the properties.
---

diff --git a/gst/scaletempo/gstscaletempo.c b/gst/scaletempo/gstscaletempo.c
index ba82a85..a057321 100644
--- a/gst/scaletempo/gstscaletempo.c
+++ b/gst/scaletempo/gstscaletempo.c
@@ -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>
  */