Make normalization mode an enum

Realized that the ComboBoxModel entries weren't translated, and that if
they were, the entire normalization logic would break since it depended
on strings lol. Upside is that documentation for the normalization modes
is now in the code itself rather than just in the commit log.

Author: rubiefawn

plugins/BitInvader/BitInvader.cpp

@@ -80,11 +80,12 @@ BitInvader::BitInvader(InstrumentTrack* instrumentTrack)
 	, m_interpolation(false, this, tr("Interpolation"))
 	, m_normalizeMode(this, tr("Normalize"))
 {
-	m_normalizeMode.addItem("Off");
-	m_normalizeMode.addItem("Full");
-	m_normalizeMode.addItem("Length only");
-	m_normalizeMode.addItem("Legacy");
-	m_normalizeMode.setValue(m_normalizeMode.findText("Length only"));
+	// The order these items are added must correspond to the modes in BitInvader::NormalizeMode
+	m_normalizeMode.addItem(tr("Off"));         // NormalizeMode::Off
+	m_normalizeMode.addItem(tr("Full"));        // NormalizeMode::Full
+	m_normalizeMode.addItem(tr("Length only")); // NormalizeMode::LengthOnly
+	m_normalizeMode.addItem(tr("Legacy"));      // NormalizeMode::Legacy
+	m_normalizeMode.setValue(static_cast<int>(NormalizeMode::LengthOnly));
 
 	m_graph.setWaveToSine();
 	lengthChanged();
@@ -131,9 +132,9 @@ void BitInvader::loadSettings(const QDomElement& el)
 	m_interpolation.loadSettings(el, "interpolation");
 	m_normalizeMode.loadSettings(el, "normalize");
 	// If normalization was enabled on an old preset, change it to "Legacy" normalization mode
-	if (el.attribute("version") == "0.1")
+	if (el.attribute("version") == "0.1") // TODO: Make new version 1 instead, cast to int and compare < 1
 	{
-		m_normalizeMode.setValue(m_normalizeMode.value() * m_normalizeMode.findText("Legacy"));
+		m_normalizeMode.setValue(m_normalizeMode.value() * static_cast<int>(NormalizeMode::Legacy);
 	}
 }
 
@@ -151,19 +152,21 @@ void BitInvader::lengthChanged()
 
 void BitInvader::normalize()
 {
-	if (m_normalizeMode.value() == m_normalizeMode.findText("Off"))
+	if (m_normalizeMode.value() == static_cast<int>(NormalizeMode::Off))
 	{
 		m_normalizeFactor = 1.f;
 		m_normalizeOffset = 0.f;
 		return;
 	}
 
-	const auto len = m_normalizeMode.value() == m_normalizeMode.findText("Length only")
-		? static_cast<std::size_t>(m_sampleLength.value())
-		: wavetableSize;
-	const auto samples = std::span<const float>{ m_graph.samples(), len };
+	const auto samples = std::span<const float>{
+		m_graph.samples(),
+		m_normalizeMode.value() == static_cast<int>(NormalizeMode::LengthOnly)
+			? static_cast<std::size_t>(m_sampleLength.value())
+			: wavetableSize
+		};
 
-	if (m_normalizeMode.value() == m_normalizeMode.findText("Legacy"))
+	if (m_normalizeMode.value() == static_cast<int>(NormalizeMode::Legacy))
 	{
 		m_normalizeOffset = 0.f;
 		m_normalizeFactor = 1.f / std::max_element(samples.begin(), samples.end(), [](auto a, auto b){ return std::abs(a) < std::abs(b); })[0];
@@ -318,12 +321,12 @@ BitInvaderView::BitInvaderView(Instrument* instrument, QWidget* parent)
 	auto normalizeLabel = new QLabel(tr("Normalization:"), this);
 	normalizeLabel->setFont(adjustedToPixelSize(normalizeLabel->font(), DEFAULT_FONT_SIZE));
 	// FIXME: Evil awful terrible layout. This should be fine for now,
-	// since a full UI overhaul for Bit Invader is planned.
+	// since a full UI overhaul for Bit Invader is planned in #8122.
 	auto normalizeLayout = new QGridLayout(this);
 	normalizeLayout->setContentsMargins(6, 6, 6, 6);
 	normalizeLayout->setVerticalSpacing(1);
 	normalizeLayout->setAlignment(Qt::AlignBottom);
-	normalizeLayout->addItem(new QSpacerItem(250 - 131, 1), 0, 0); // Do NOT ever do this LMAO
+	normalizeLayout->addItem(new QSpacerItem(250 - 131, 1), 0, 0); // HACK: Do NOT ever do this LMAO
 	normalizeLayout->addWidget(normalizeLabel, 0, 1);
 	normalizeLayout->addWidget(m_normalizeMode, 1, 1);
 

plugins/BitInvader/BitInvader.h

@@ -65,13 +65,39 @@ class BitInvader : public Instrument
 
 protected slots:
 	void lengthChanged();
+
+	//! @brief Normalize the wavetable according to the current normalization mode.
+	//! @see NormalizeMode
+	//! @see m_graph
+	//! @see m_normalizeMode
 	void normalize();
 
 private:
+	//! @brief A kind of normalization to apply to BitInvader's wavetable.
+	enum class NormalizeMode
+	{
+		//! No normalization.
+		Off,
+
+		//! Normalization is applied and DC offset removed, such that
+		//! the entire waveform has a range of [-1, 1].
+		Full,
+
+		//! Normalization is applied and DC offset removed, such that
+		//! the waveform within domain [0, L] has a range of [-1, 1],
+		//! with L being the value of @ref m_sampleLength.
+		LengthOnly,
+
+		//! Normalization is applied, such that the absolute value of
+		//! the entire waveform has a range of [0, 1]. DC offset is
+		//! preserved.
+		Legacy
+	};
+
 	FloatModel m_sampleLength;
 	graphModel m_graph;
 	BoolModel m_interpolation;
-	ComboBoxModel m_normalizeMode;
+	ComboBoxModel m_normalizeMode; //!< Which normalization mode to use. @see NormalizeMode
 
 	float m_normalizeFactor; //!< Factor by which to amplify output such that the output is normalized
 	float m_normalizeOffset; //!< Amount by which to offset the output such that no DC offset is produced when normalized