From: Simon A. Eugster <simon.eu@gmail.com>
Date: Sat, 25 Dec 2010 14:18:10 +0000 (+0000)
Subject: Effect comments added
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=33190ca3920db3fee3ded2f606649ff9c88eb239;p=kdenlive

Effect comments added

svn path=/trunk/kdenlive/; revision=5198
---

diff --git a/effects/frei0r_lightgraffiti.xml b/effects/frei0r_lightgraffiti.xml
index 12eaf7d3..f836de22 100644
--- a/effects/frei0r_lightgraffiti.xml
+++ b/effects/frei0r_lightgraffiti.xml
@@ -4,9 +4,11 @@
         <description>Light Graffiti effect.</description>
         <author>Simon A. Eugster (Granjow)</author>
         <parameter type="constant" name="longAlpha" default="2" min="0" max="256" factor="256">
-                <name>α for moving average</name>
+                <name>α</name>
+                <comment>Determines how the effect tries to adapt to background changes. If the background does not change, then try to use 0.</comment>
         </parameter>
 	<parameter type="constant" name="lightOpacity" default="40" min="0" max="100" factor="100">
-	  <name>Basic opacity for a light source. Added to sum in each frame.</name>
+          <name>Opacity</name>
+          <comment><![CDATA[Basic opacity for a light source.]]></comment>
 	</parameter>
 </effect>
diff --git a/effects/frei0r_sopsat.xml b/effects/frei0r_sopsat.xml
index 92e03999..c4e63215 100644
--- a/effects/frei0r_sopsat.xml
+++ b/effects/frei0r_sopsat.xml
@@ -5,6 +5,7 @@
         <author>Simon A. Eugster (Granjow)</author>
         <parameter type="simplekeyframe" name="rSlope" default="100" min="0" max="1000" factor="100">
                 <name>Slope Red</name>
+                <comment>Changing the slope means multiplying the pixel value with a constant value.</comment>
         </parameter>
         <parameter type="simplekeyframe" name="gSlope" default="100" min="0" max="1000" factor="100">
                 <name>Slope Green</name>
@@ -18,6 +19,7 @@
 
         <parameter type="simplekeyframe" name="rOffset" default="0" min="-1024" max="1024" factor="256">
                 <name>Offset Red</name>
+                <comment>Changing the offset lifts (or lowers) the brightness of each pixel by the makes the given value.</comment>
         </parameter>
         <parameter type="simplekeyframe" name="gOffset" default="0" min="-1024" max="1024" factor="256">
                 <name>Offset Green</name>
@@ -30,20 +32,23 @@
         </parameter>
 
         <parameter type="simplekeyframe" name="rPower" default="100" min="1" max="1000" factor="100">
-                <name>Power (Gamma) Red</name>
+                <name>Power Red</name>
+                <comment><![CDATA[Changes the Gamma value for the selected channel. Black and white pixel values will not be affected, but everything between.<br/>
+                Mathematically, what happens is an exponentiation of the pixel brightness on <code>[0,1]</code> by the gamma value.]]></comment>
         </parameter>
         <parameter type="simplekeyframe" name="gPower" default="100" min="1" max="1000" factor="100">
-                <name>Power (Gamma) Green</name>
+                <name>Power Green</name>
         </parameter>
         <parameter type="simplekeyframe" name="bPower" default="100" min="1" max="1000" factor="100">
-                <name>Power (Gamma) Blue</name>
+                <name>Power Blue</name>
         </parameter>
         <parameter type="simplekeyframe" name="aPower" default="100" min="1" max="1000" factor="100">
-                <name>Power (Gamma) Alpha</name>
+                <name>Power Alpha</name>
         </parameter>
 
         <parameter type="simplekeyframe" name="saturation" default="100" min="0" max="500" factor="100" intimeline="1">
                 <name>Overall Saturation</name>
+                <comment>The overall saturation will be changed after all previous effects have been applied.</comment>
         </parameter>
 
 </effect>
diff --git a/src/audioscopes/ffttools.h b/src/audioscopes/ffttools.h
index 65a4b2ca..f71d04aa 100644
--- a/src/audioscopes/ffttools.h
+++ b/src/audioscopes/ffttools.h
@@ -58,7 +58,8 @@ public:
 
 
     /** This is linear interpolation with the special property that it preserves peaks, which is required
-        for e.g. showing correct Decibel values (where the peak values are of interest).
+        for e.g. showing correct Decibel values (where the peak values are of interest because of clipping which
+        may occur for too strong frequencies; The lower values are smeared by the window function anyway).
         Consider f = {0, 100, 0}
                  x = {0.5,  1.5}: With default linear interpolation x0 and x1 would both be mapped to 50.
         This function maps x1 (the first position after the peak) to 100.
diff --git a/src/audioscopes/spectrogram.cpp b/src/audioscopes/spectrogram.cpp
index c1d87c20..a8457b28 100644
--- a/src/audioscopes/spectrogram.cpp
+++ b/src/audioscopes/spectrogram.cpp
@@ -295,6 +295,8 @@ QImage Spectrogram::renderAudioScope(uint, const QVector<int16_t> audioFrame, co
         }
         bool newDataAvailable = newData > 0;
 
+        //TODO highlight data above certain limit (-6 dB)
+
 #ifdef DEBUG_SPECTROGRAM
         qDebug() << "New data for " << widgetName() << ": " << newDataAvailable << " (" << newData << " units)";
 #endif