Add crossfade feature tag, update manual, fix crossfade WPS tag behavior

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@23610 a1c6a512-1295-4272-9138-f99709370657

5 files changed, 35 insertions, 11 deletions

diff --git a/apps/features.txt b/apps/features.txt
index 14204dfb6d..d3e433ad45 100644
--- a/apps/features.txt
+++ b/apps/features.txt
@@ -42,6 +42,10 @@ button_light
 buttonlight_brightness
 #endif
 
+#if defined(HAVE_CROSSFADE)
+crossfade
+#endif
+
 #if defined(HAVE_DIRCACHE)
 dircache
 #endif
diff --git a/apps/gui/skin_engine/skin_tokens.c b/apps/gui/skin_engine/skin_tokens.c
index a456bbca23..d4adfa8c85 100644
--- a/apps/gui/skin_engine/skin_tokens.c
+++ b/apps/gui/skin_engine/skin_tokens.c
@@ -770,10 +770,10 @@ const char *get_token_value(struct gui_wps *gwps,
             if (intval)
                 *intval = global_settings.crossfade + 1;
             snprintf(buf, buf_size, "%d", global_settings.crossfade);
-            return buf;
 #else
-            return NULL;
+            snprintf(buf, buf_size, "%d", 0);
 #endif
+            return buf;
 
         case WPS_TOKEN_REPLAYGAIN:
         {
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index 43f6aea203..d145014f86 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -160,7 +160,9 @@
       replaygain preamp
                     & -120 to 120       & 0.1dB\\
 %
-      crossfade     & off, shuffle, track skip, always
+      \opt{crossfade}{
+      crossfade     & off, auto track skip, man track skip, shuffle,
+                    shuffle and man track skip, always
                                         & N/A\\
       crossfade fade in delay
                     & 0 to 7            & seconds\\
@@ -172,6 +174,7 @@
                     & 0 to 15           & seconds\\
       crossfade fade out mode
                     & crossfade, mix    & N/A\\
+      }
 %
       crossfeed     & on, off           & N/A\\
       crossfeed direct gain
@@ -202,6 +205,17 @@
       eq band 4 gain & -240 to 240      & 0.1dB\\
 %
       dithering enabled & on, off       & N/A\\
+%
+      timestretch enabled & on, off     & N/A\\
+%
+      compressor threshold      & 0 to -24      & -3dB\\
+      compressor makeup gain    & off, auto     & N/A\\
+      compressor ratio          & 2:1, 4:1, 6:1, 10:1, limit
+                                                & N/A\\
+      compressor knee           & hard knee, soft knee
+                                                & N/A\\
+      compressor release time   & 100 to 1000   & 100 ms\\
+%
       beep          & off, weak, moderate, strong & N/A\\
       keyclick      & off, weak, moderate, strong & N/A\\
       keyclick repeats & on, off        & N/A\\
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 7c4fd5418a..a9eaf0f7d8 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -159,7 +159,8 @@ produce the information for the next file to be played.
   \begin{tagmap}{}{}
     \config{\%Sp} & Current playback pitch \\
   \opt{swcodec}{
-    \config{\%xf} & Crossfade setting, in the order: Off, Shuffle, Skip, Always\\
+    \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip,
+           Shuffle, Shuffle and Man Skip, Always\\
     \config{\%rg} & ReplayGain value in use (x.y dB). If used as a conditional,
            Replaygain type in use: \config{\%?rg{\textless}Off{\textbar}Track%
            {\textbar}Album{\textbar}TrackShuffle{\textbar}AlbumShuffle%
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index f9f1db01f2..0cff2b3c37 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -97,17 +97,21 @@ you to configure settings related to audio playback.
   disabled as well as skipping songs and launching plugins.
 
 \opt{swcodec}{
+  \opt{crossfade}{
   \section{Crossfade}
-    This setting enables a cross-fader. At the end of a song, the song will 
-    fade out as the next song fades in, creating a smooth transition between 
-    songs. The crossfade setting is particularly effective when the player is 
-      set on shuffle.\\
+    This section controls the behavior of the crossfader.  The crossfader, when
+    enabled, smoothly fades one track into the next.  This can occur in two
+    situations: an automatic track skip and a manual track skip.  An automatic
+    track skip occurs at the end of the track, moving to the next track in the
+    playlist without user intervention.  A manual track skip occurs immediately
+    when the appropriate button is pressed.\\
 
     Options for crossfade settings are:
     \begin{description}
-      \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled.
-            If set to \setting{Auto Track Skip Only}, crossfade occurs for
-        automatic skips, but not for manual skips.  The next setting,
+      \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled
+        and all track skips are gapless.  If set to
+        \setting{Auto Track Skip Only}, crossfade occurs for automatic skips,
+        but not for manual skips.  The next setting,
         \setting{Manual Track Skip Only}, is the opposite: tracks will only
         crossfade when manually skipped.  If set to \setting{Shuffle}, crossfade
         is enabled for all track changes when the shuffle feature is set to
@@ -147,6 +151,7 @@ you to configure settings related to audio playback.
           The graphic below illustrates how the different settings work in practice.
 
          \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
+    }%\opt{crossfade}
     
   \section{Replaygain}
     This allows you to control the replaygain function.