Added descriptions of translatable strings for Phonon MMF reverb effect

Reviewed-by: trustme

1 files changed, 21 insertions, 1 deletions

diff --git a/src/3rdparty/phonon/mmf/environmentalreverb.cpp b/src/3rdparty/phonon/mmf/environmentalreverb.cpp
index 89f8d60..4a6ce29 100644
--- a/src/3rdparty/phonon/mmf/environmentalreverb.cpp
+++ b/src/3rdparty/phonon/mmf/environmentalreverb.cpp
@@ -140,55 +140,75 @@ bool EnvironmentalReverb::getParameters(CMdaAudioOutputStream *stream,
         TUint32 umin, umax;
 
         // DecayHFRatio
+	// Ratio of high-frequency decay time to the value specified by
+	// DecayTime.
         effect->DecayHFRatioRange(umin, umax);
         parameters.append(createParameter(
             DecayHFRatio, tr("Decay HF ratio (%)"), effect->DecayHFRatio(),
             umin, umax));
 
         // DecayTime
+	// Time over which reverberation is diminished.
         effect->DecayTimeRange(umin, umax);
         parameters.append(createParameter(
             DecayTime, tr("Decay time (ms)"), effect->DecayTime(),
             umin, umax));
 
         // Density
+	// Delay between first and subsequent reflections.
+	// Note that the S60 platform documentation does not make clear
+	// the distinction between this value and the Diffusion value.
         parameters.append(createParameter(
             Density, tr("Density (%)"), effect->Density(), 0, 100));
 
         // Diffusion
+	// Delay between first and subsequent reflections.
+	// Note that the S60 platform documentation does not make clear
+	// the distinction between this value and the Density value.
         parameters.append(createParameter(
             Diffusion, tr("Diffusion (%)"), effect->Diffusion(), 0, 100));
 
         // ReflectionsDelay
+	// Amount of delay between the arrival the direct path from the
+	// source and the arrival of the first reflection.
         parameters.append(createParameter(
             ReflectionsDelay, tr("Reflections delay (ms)"),
             effect->ReflectionsDelay(), 0, effect->ReflectionsDelayMax()));
 
         // ReflectionsLevel
-        effect->ReflectionLevelRange(min, max);
+	// Amplitude of reflections.  This value is corrected by the RoomLevel
+        // to give the final reflection amplitude.
+	effect->ReflectionLevelRange(min, max);
         parameters.append(createParameter(
             ReflectionsLevel, tr("Reflections level (mB)"),
             effect->ReflectionsLevel(),
             min, max, EffectParameter::LogarithmicHint));
 
         // ReverbDelay
+	// Amount of time between arrival of the first reflection and start of
+	// the late reverberation.
         parameters.append(createParameter(
             ReverbDelay, tr("Reverb delay (ms)"), effect->ReverbDelay(),
             0, effect->ReverbDelayMax()));
 
         // ReverbLevel
+	// Amplitude of reverberations.  This value is corrected by the
+	// RoomLevel to give the final reverberation amplitude.
         effect->ReverbLevelRange(min, max);
         parameters.append(createParameter(
             ReverbLevel, tr("Reverb level (mB)"), effect->ReverbLevel(),
             min, max, EffectParameter::LogarithmicHint));
 
         // RoomHFLevel
+	// Amplitude of low-pass filter used to attenuate the high frequency
+	// component of reflected sound.
         effect->RoomHFLevelRange(min, max);
         parameters.append(createParameter(
             RoomHFLevel, tr("Room HF level"), effect->RoomHFLevel(),
             min, max));
 
         // RoomLevel
+	// Master volume control for all reflected sound.
         effect->RoomLevelRange(min, max);
         parameters.append(createParameter(
             RoomLevel, tr("Room level (mB)"), effect->RoomLevel(),