Merge pull request #1064 from Be-ing/effect_short_names

Effect & effect parameter short names
mixxxdj · Dec 9, 2016 · 7e81c30 · 7e81c30
2 parents 5fe4c3f + 2255a2d
commit 7e81c30
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 5 deletions.
diff --git a/src/effects/effectmanifest.h b/src/effects/effectmanifest.h
@@ -45,6 +45,13 @@ class EffectManifest {
         m_name = name;
     }
 
+    virtual const QString& shortName() const {
+        return m_shortName;
+    }
+    virtual void setShortName(const QString& shortName) {
+        m_shortName = shortName;
+    }
+
     virtual const QString& author() const {
         return m_author;
     }
@@ -114,6 +121,7 @@ class EffectManifest {
 
     QString m_id;
     QString m_name;
+    QString m_shortName;
     QString m_author;
     QString m_version;
     QString m_description;

diff --git a/src/effects/effectmanifestparameter.h b/src/effects/effectmanifestparameter.h
@@ -80,6 +80,13 @@ class EffectManifestParameter {
         m_name = name;
     }
 
+    virtual const QString& shortName() const {
+        return m_shortName;
+    }
+    virtual void setShortName(const QString& shortName) {
+        m_shortName = shortName;
+    }
+
     virtual const QString& description() const {
         return m_description;
     }
@@ -193,6 +200,7 @@ class EffectManifestParameter {
 
     QString m_id;
     QString m_name;
+    QString m_shortName;
     QString m_description;
 
     ControlHint m_controlHint;

diff --git a/src/effects/effectparameter.cpp b/src/effects/effectparameter.cpp
@@ -51,6 +51,10 @@ const QString EffectParameter::name() const {
     return m_parameter.name();
 }
 
+const QString EffectParameter::shortName() const {
+    return m_parameter.shortName();
+}
+
 const QString EffectParameter::description() const {
     return m_parameter.description();
 }

diff --git a/src/effects/effectparameter.h b/src/effects/effectparameter.h
@@ -32,6 +32,7 @@ class EffectParameter : public QObject {
     const EffectManifestParameter& manifest() const;
     const QString id() const;
     const QString name() const;
+    const QString shortName() const;
     const QString description() const;
 
     ///////////////////////////////////////////////////////////////////////////

diff --git a/src/effects/effectparameterslotbase.cpp b/src/effects/effectparameterslotbase.cpp
@@ -30,6 +30,13 @@ QString EffectParameterSlotBase::name() const {
     return QString();
 }
 
+QString EffectParameterSlotBase::shortName() const {
+    if (m_pEffectParameter) {
+        return m_pEffectParameter->shortName();
+    }
+    return QString();
+}
+
 QString EffectParameterSlotBase::description() const {
     if (m_pEffectParameter) {
         return m_pEffectParameter->description();

diff --git a/src/effects/effectparameterslotbase.h b/src/effects/effectparameterslotbase.h
@@ -22,6 +22,7 @@ class EffectParameterSlotBase : public QObject {
     virtual ~EffectParameterSlotBase();
 
     QString name() const;
+    QString shortName() const;
     QString description() const;
     const EffectManifestParameter getManifest();
 

diff --git a/src/effects/native/autopaneffect.cpp b/src/effects/native/autopaneffect.cpp
@@ -72,6 +72,7 @@ EffectManifest AutoPanEffect::getManifest() {
     EffectManifestParameter* smoothing = manifest.addParameter();
     smoothing->setId("smoothing");
     smoothing->setName(QObject::tr("Smoothing"));
+    smoothing->setShortName(QObject::tr("Smooth"));
     smoothing->setDescription(
             QObject::tr("How fast the signal goes from a channel to an other"));
     smoothing->setControlHint(EffectManifestParameter::CONTROL_KNOB_LOGARITHMIC);

diff --git a/src/effects/native/bessel4lvmixeqeffect.cpp b/src/effects/native/bessel4lvmixeqeffect.cpp
@@ -11,6 +11,7 @@ EffectManifest Bessel4LVMixEQEffect::getManifest() {
     EffectManifest manifest;
     manifest.setId(getId());
     manifest.setName(QObject::tr("Bessel4 LV-Mix EQ"));
+    manifest.setShortName(QObject::tr("Bessel4 EQ"));
     manifest.setAuthor("The Mixxx Team");
     manifest.setVersion("1.0");
     manifest.setDescription(QObject::tr(

diff --git a/src/effects/native/bessel8lvmixeqeffect.cpp b/src/effects/native/bessel8lvmixeqeffect.cpp
@@ -11,6 +11,7 @@ EffectManifest Bessel8LVMixEQEffect::getManifest() {
     EffectManifest manifest;
     manifest.setId(getId());
     manifest.setName(QObject::tr("Bessel8 LV-Mix EQ"));
+    manifest.setShortName(QObject::tr("Bessel8 EQ"));
     manifest.setAuthor("The Mixxx Team");
     manifest.setVersion("1.0");
     manifest.setDescription(QObject::tr(

diff --git a/src/effects/native/bitcrushereffect.cpp b/src/effects/native/bitcrushereffect.cpp
@@ -39,6 +39,7 @@ EffectManifest BitCrusherEffect::getManifest() {
     EffectManifestParameter* frequency = manifest.addParameter();
     frequency->setId("downsample");
     frequency->setName(QObject::tr("Downsampling"));
+    frequency->setShortName(QObject::tr("Down"));
     frequency->setDescription(QObject::tr("Adjusts the sample rate, to which the signal is downsampled."));
     frequency->setControlHint(EffectManifestParameter::CONTROL_KNOB_LOGARITHMIC);
     frequency->setSemanticHint(EffectManifestParameter::SEMANTIC_UNKNOWN);

diff --git a/src/effects/native/filtereffect.cpp b/src/effects/native/filtereffect.cpp
@@ -38,7 +38,8 @@ EffectManifest FilterEffect::getManifest() {
 
     EffectManifestParameter* q = manifest.addParameter();
     q->setId("q");
-    q->setName(QObject::tr("Q"));
+    q->setName(QObject::tr("Resonance"));
+    q->setShortName(QObject::tr("Q"));
     q->setDescription(QObject::tr("Resonance of the filters, default = Flat top"));
     q->setControlHint(EffectManifestParameter::CONTROL_KNOB_LOGARITHMIC);
     q->setSemanticHint(EffectManifestParameter::SEMANTIC_UNKNOWN);

diff --git a/src/effects/native/linkwitzriley8eqeffect.cpp b/src/effects/native/linkwitzriley8eqeffect.cpp
@@ -15,6 +15,7 @@ EffectManifest LinkwitzRiley8EQEffect::getManifest() {
     EffectManifest manifest;
     manifest.setId(getId());
     manifest.setName(QObject::tr("LinkwitzRiley8 EQ"));
+    manifest.setShortName(QObject::tr("LR8 EQ"));
     manifest.setAuthor("The Mixxx Team");
     manifest.setVersion("1.0");
     manifest.setDescription(QObject::tr(

diff --git a/src/effects/native/moogladder4filtereffect.cpp b/src/effects/native/moogladder4filtereffect.cpp
@@ -16,6 +16,7 @@ EffectManifest MoogLadder4FilterEffect::getManifest() {
     EffectManifest manifest;
     manifest.setId(getId());
     manifest.setName(QObject::tr("Moog Ladder 4 Filter"));
+    manifest.setShortName(QObject::tr("Moog Filter"));
     manifest.setAuthor("The Mixxx Team");
     manifest.setVersion("1.0");
     manifest.setDescription(QObject::tr(
@@ -40,6 +41,7 @@ EffectManifest MoogLadder4FilterEffect::getManifest() {
     EffectManifestParameter* q = manifest.addParameter();
     q->setId("resonance");
     q->setName(QObject::tr("Resonance"));
+    q->setShortName(QObject::tr("Res"));
     q->setDescription(QObject::tr("Resonance of the filters. 4 = self oscillating"));
     q->setControlHint(EffectManifestParameter::CONTROL_KNOB_LOGARITHMIC);
     q->setSemanticHint(EffectManifestParameter::SEMANTIC_UNKNOWN);

diff --git a/src/effects/native/reverbeffect.cpp b/src/effects/native/reverbeffect.cpp
@@ -26,6 +26,7 @@ EffectManifest ReverbEffect::getManifest() {
     EffectManifestParameter* time = manifest.addParameter();
     time->setId("bandwidth");
     time->setName(QObject::tr("Bandwidth"));
+    time->setShortName(QObject::tr("BW"));
     time->setDescription(QObject::tr("Higher bandwidth values cause more "
             "bright (high-frequency) tones to be included"));
     time->setControlHint(EffectManifestParameter::CONTROL_KNOB_LINEAR);

diff --git a/src/widget/weffect.cpp b/src/widget/weffect.cpp
@@ -44,8 +44,14 @@ void WEffect::effectUpdated() {
         EffectPointer pEffect = m_pEffectSlot->getEffect();
         if (pEffect) {
             const EffectManifest& manifest = pEffect->getManifest();
-            name = manifest.name();
-            description = manifest.description();
+            if (!manifest.shortName().isEmpty()) {
+                name = manifest.shortName();
+                //: %1 = effect name; %2 = effect description
+                description = tr("%1: %2").arg(manifest.name(), manifest.description());
+            } else {
+                name = manifest.name();
+                description = manifest.description();
+            }
         }
     } else {
         name = tr("None");

diff --git a/src/widget/weffectparameterbase.cpp b/src/widget/weffectparameterbase.cpp
@@ -21,8 +21,16 @@ void WEffectParameterBase::setEffectParameterSlot(
 
 void WEffectParameterBase::parameterUpdated() {
     if (m_pEffectParameterSlot) {
-        setText(m_pEffectParameterSlot->name());
-        setBaseTooltip(m_pEffectParameterSlot->description());
+        if (!m_pEffectParameterSlot->shortName().isEmpty()) {
+            setText(m_pEffectParameterSlot->shortName());
+            //: %1 = effect name; %2 = effect description
+            setBaseTooltip(tr("%1: %2").arg(
+                              m_pEffectParameterSlot->name(),
+                              m_pEffectParameterSlot->description()));
+        } else {
+            setText(m_pEffectParameterSlot->name());
+            setBaseTooltip(m_pEffectParameterSlot->description());
+        }
     } else {
         setText(tr("None"));
         setBaseTooltip(tr("No effect loaded."));