BassBooster: coding style / naming conventions improvements

plugins/BassBooster/BassBooster.cpp

@@ -1,8 +1,8 @@
 /*
- * bass_booster.cpp - bass-booster-effect-plugin
+ * BassBooster.cpp - bass booster effect plugin
+ *
+ * Copyright (c) 2006-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
  *
- * Copyright (c) 2006-2009 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  *
  * This program is free software; you can redistribute it and/or
@@ -22,8 +22,7 @@
  *
  */
 
-
-#include "bass_booster.h"
+#include "BassBooster.h"
 
 #include "embed.cpp"
 
@@ -34,9 +33,8 @@ extern "C"
 Plugin::Descriptor PLUGIN_EXPORT bassbooster_plugin_descriptor =
 {
 	STRINGIFY( PLUGIN_NAME ),
-	"BassBooster Effect",
-	QT_TRANSLATE_NOOP( "pluginBrowser",
-				"plugin for boosting bass" ),
+	"BassBooster",
+	QT_TRANSLATE_NOOP( "pluginBrowser", "Boost your bass the fast and simple way" ),
 	"Tobias Doerffel <tobydox/at/users.sf.net>",
 	0x0100,
 	Plugin::Effect,
@@ -49,9 +47,8 @@ Plugin::Descriptor PLUGIN_EXPORT bassbooster_plugin_descriptor =
 
 
 
-bassBoosterEffect::bassBoosterEffect( Model * _parent,
-			const Descriptor::SubPluginFeatures::Key * _key ) :
-	Effect( &bassbooster_plugin_descriptor, _parent, _key ),
+BassBoosterEffect::BassBoosterEffect( Model* parent, const Descriptor::SubPluginFeatures::Key* key ) :
+	Effect( &bassbooster_plugin_descriptor, parent, key ),
 	m_bbFX( effectLib::fastBassBoost( 70.0f, 1.0f, 2.8f ) ),
 	m_bbControls( this )
 {
@@ -60,38 +57,37 @@ bassBoosterEffect::bassBoosterEffect( Model * _parent,
 
 
 
-bassBoosterEffect::~bassBoosterEffect()
+BassBoosterEffect::~BassBoosterEffect()
 {
 }
 
 
 
 
-bool bassBoosterEffect::processAudioBuffer( sampleFrame * _buf,
-							const fpp_t _frames )
+bool BassBoosterEffect::processAudioBuffer( sampleFrame* buf, const fpp_t frames )
 {
 	if( !isEnabled() || !isRunning () )
 	{
 		return( false );
 	}
 
-	double out_sum = 0.0;
+	double outSum = 0.0;
 	const float d = dryLevel();
 	const float w = wetLevel();
-	for( fpp_t f = 0; f < _frames; ++f )
+	for( fpp_t f = 0; f < frames; ++f )
 	{
-		sample_t s[2] = { _buf[f][0], _buf[f][1] };
+		sample_t s[2] = { buf[f][0], buf[f][1] };
 		m_bbFX.nextSample( s[0], s[1] );
 
-		_buf[f][0] = d * _buf[f][0] + w * s[0];
-		_buf[f][1] = d * _buf[f][1] + w * s[1];
+		buf[f][0] = d * buf[f][0] + w * s[0];
+		buf[f][1] = d * buf[f][1] + w * s[1];
 
-		out_sum += _buf[f][0]*_buf[f][0] + _buf[f][1]*_buf[f][1];
+		outSum += buf[f][0]*buf[f][0] + buf[f][1]*buf[f][1];
 	}
 
-	checkGate( out_sum / _frames );
+	checkGate( outSum / frames );
 
-	return( isRunning() );
+	return isRunning();
 }
 
 
@@ -102,11 +98,9 @@ extern "C"
 {
 
 // necessary for getting instance out of shared lib
-Plugin * PLUGIN_EXPORT lmms_plugin_main( Model * _parent, void * _data )
+Plugin * PLUGIN_EXPORT lmms_plugin_main( Model* parent, void* data )
 {
-	return( new bassBoosterEffect( _parent,
-		static_cast<const Plugin::Descriptor::SubPluginFeatures::Key *>(
-								_data ) ) );
+	return new BassBoosterEffect( parent, static_cast<const Plugin::Descriptor::SubPluginFeatures::Key *>( data ) );
 }
 
 }

plugins/BassBooster/BassBooster.h

@@ -1,8 +1,8 @@
 /*
- * bass_booster.h - bass-booster-effect-plugin
+ * BassBooster.h - bass-booster-effect-plugin
+ *
+ * Copyright (c) 2006-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
  *
- * Copyright (c) 2006-2008 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  *
  * This program is free software; you can redistribute it and/or
@@ -28,36 +28,29 @@
 
 #include "Effect.h"
 #include "effect_lib.h"
-#include "bassbooster_controls.h"
+#include "BassBoosterControls.h"
 
 
-
-class bassBoosterEffect : public Effect
+class BassBoosterEffect : public Effect
 {
 public:
-	bassBoosterEffect( Model * _parent,
-			const Descriptor::SubPluginFeatures::Key * _key );
-	virtual ~bassBoosterEffect();
-	virtual bool processAudioBuffer( sampleFrame * _buf,
-							const fpp_t _frames );
+	BassBoosterEffect( Model* parent, const Descriptor::SubPluginFeatures::Key* key );
+	virtual ~BassBoosterEffect();
+	virtual bool processAudioBuffer( sampleFrame* buf, const fpp_t frames );
 
-	virtual EffectControls * controls()
+	virtual EffectControls* controls()
 	{
-		return( &m_bbControls );
+		return &m_bbControls;
 	}
 
 
 private:
 	effectLib::monoToStereoAdaptor<effectLib::fastBassBoost> m_bbFX;
 
-	bassBoosterControls m_bbControls;
+	BassBoosterControls m_bbControls;
 
-	friend class bassBoosterControls;
+	friend class BassBoosterControls;
 
 } ;
 
-
-
-
-
 #endif

plugins/BassBooster/BassBoosterControlDialog.cpp

@@ -1,8 +1,8 @@
 /*
- * bassbooster_control_dialog.cpp - control-dialog for bassbooster-effect
+ * BassBoosterControlDialog.cpp - control dialog for bassbooster effect
+ *
+ * Copyright (c) 2006-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
  *
- * Copyright (c) 2006-2008 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  *
  * This program is free software; you can redistribute it and/or
@@ -22,23 +22,20 @@
  *
  */
 
-
 #include <QtGui/QLayout>
 
-#include "bassbooster_control_dialog.h"
-#include "bassbooster_controls.h"
+#include "BassBoosterControlDialog.h"
+#include "BassBoosterControls.h"
 #include "embed.h"
 
 
 
-bassBoosterControlDialog::bassBoosterControlDialog(
-					bassBoosterControls * _controls ) :
-	EffectControlDialog( _controls )
+BassBoosterControlDialog::BassBoosterControlDialog( BassBoosterControls* controls ) :
+	EffectControlDialog( controls )
 {
 	setAutoFillBackground( true );
 	QPalette pal;
-	pal.setBrush( backgroundRole(),
-				PLUGIN_NAME::getIconPixmap( "artwork" ) );
+	pal.setBrush( backgroundRole(), PLUGIN_NAME::getIconPixmap( "artwork" ) );
 	setPalette( pal );
 	setFixedSize( 120, 104 );
 
@@ -48,17 +45,17 @@ bassBoosterControlDialog::bassBoosterControlDialog(
 	QHBoxLayout * l = new QHBoxLayout;
 
 	knob * freqKnob = new knob( knobBright_26, this);
-	freqKnob->setModel( &_controls->m_freqModel );
+	freqKnob->setModel( &controls->m_freqModel );
 	freqKnob->setLabel( tr( "FREQ" ) );
 	freqKnob->setHintText( tr( "Frequency:" ) + " ", "Hz" );
 
 	knob * gainKnob = new knob( knobBright_26, this );
-	gainKnob->setModel( &_controls->m_gainModel );
+	gainKnob->setModel( &controls->m_gainModel );
 	gainKnob->setLabel( tr( "GAIN" ) );
 	gainKnob->setHintText( tr( "Gain:" ) + " ", "" );
 
 	knob * ratioKnob = new knob( knobBright_26, this );
-	ratioKnob->setModel( &_controls->m_ratioModel );
+	ratioKnob->setModel( &controls->m_ratioModel );
 	ratioKnob->setLabel( tr( "RATIO" ) );
 	ratioKnob->setHintText( tr( "Ratio:" ) + " ", "" );
 

plugins/BassBooster/BassBoosterControlDialog.h

@@ -1,8 +1,8 @@
 /*
- * bassbooster_control_dialog.h - control-dialog for bassbooster-effect
+ * BassBoosterControlDialog.h - control dialog for bassbooster effect
+ *
+ * Copyright (c) 2006-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
  *
- * Copyright (c) 2006-2008 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  *
  * This program is free software; you can redistribute it and/or
@@ -28,14 +28,14 @@
 #include "EffectControlDialog.h"
 
 
-class bassBoosterControls;
+class BassBoosterControls;
 
 
-class bassBoosterControlDialog : public EffectControlDialog
+class BassBoosterControlDialog : public EffectControlDialog
 {
 public:
-	bassBoosterControlDialog( bassBoosterControls * _controls );
-	virtual ~bassBoosterControlDialog()
+	BassBoosterControlDialog( BassBoosterControls* controls );
+	virtual ~BassBoosterControlDialog()
 	{
 	}
 

plugins/BassBooster/BassBoosterControls.cpp

@@ -1,8 +1,8 @@
 /*
- * bassbooster_controls.cpp - controls for bassbooster-effect
+ * BassBoosterControls.cpp - controls for bassbooster effect
+ *
+ * Copyright (c) 2008-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
  *
- * Copyright (c) 2008 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  *
  * This program is free software; you can redistribute it and/or
@@ -25,29 +25,23 @@
 
 #include <QtXml/QDomElement>
 
-#include "bassbooster_controls.h"
-#include "bass_booster.h"
+#include "BassBoosterControls.h"
+#include "BassBooster.h"
 
 
 
-bassBoosterControls::bassBoosterControls( bassBoosterEffect * _eff ) :
-	EffectControls( _eff ),
-	m_effect( _eff ),
+BassBoosterControls::BassBoosterControls( BassBoosterEffect* effect ) :
+	EffectControls( effect ),
+	m_effect( effect ),
 	m_freqModel( 100.0f, 50.0f, 200.0f, 1.0f, this, tr( "Frequency" ) ),
 	m_gainModel( 1.0f, 0.1f, 5.0f, 0.05f, this, tr( "Gain" ) ),
 	m_ratioModel( 2.0f, 0.1f, 10.0f, 0.1f, this, tr( "Ratio" ) )
 {
-	connect( &m_freqModel, SIGNAL( dataChanged() ),
-			this, SLOT( changeFrequency() ) );
+	connect( &m_freqModel, SIGNAL( dataChanged() ), this, SLOT( changeFrequency() ) );
+	connect( &m_gainModel, SIGNAL( dataChanged() ), this, SLOT( changeGain() ) );
+	connect( &m_ratioModel, SIGNAL( dataChanged() ), this, SLOT( changeRatio() ) );
+	connect( engine::mixer(), SIGNAL( sampleRateChanged() ), this, SLOT( changeFrequency() ) );
 
-	connect( &m_gainModel, SIGNAL( dataChanged() ),
-			this, SLOT( changeGain() ) );
-
-	connect( &m_ratioModel, SIGNAL( dataChanged() ),
-			this, SLOT( changeRatio() ) );
-
-	connect( engine::mixer(), SIGNAL( sampleRateChanged() ),
-			this, SLOT( changeFrequency() ) );
 	changeFrequency();
 	changeGain();
 	changeRatio();
@@ -56,10 +50,10 @@ bassBoosterControls::bassBoosterControls( bassBoosterEffect * _eff ) :
 
 
 
-void bassBoosterControls::changeFrequency()
+void BassBoosterControls::changeFrequency()
 {
-	const sample_t fac = engine::mixer()->processingSampleRate() /
-								44100.0f;
+	const sample_t fac = engine::mixer()->processingSampleRate() / 44100.0f;
+
 	m_effect->m_bbFX.leftFX().setFrequency( m_freqModel.value() * fac );
 	m_effect->m_bbFX.rightFX().setFrequency( m_freqModel.value() * fac );
 }
@@ -67,7 +61,7 @@ void bassBoosterControls::changeFrequency()
 
 
 
-void bassBoosterControls::changeGain()
+void BassBoosterControls::changeGain()
 {
 	m_effect->m_bbFX.leftFX().setGain( m_gainModel.value() );
 	m_effect->m_bbFX.rightFX().setGain( m_gainModel.value() );
@@ -76,7 +70,7 @@ void bassBoosterControls::changeGain()
 
 
 
-void bassBoosterControls::changeRatio()
+void BassBoosterControls::changeRatio()
 {
 	m_effect->m_bbFX.leftFX().setRatio( m_ratioModel.value() );
 	m_effect->m_bbFX.rightFX().setRatio( m_ratioModel.value() );
@@ -85,7 +79,7 @@ void bassBoosterControls::changeRatio()
 
 
 
-void bassBoosterControls::loadSettings( const QDomElement & _this )
+void BassBoosterControls::loadSettings( const QDomElement& _this )
 {
 	m_freqModel.setValue( _this.attribute( "freq" ).toFloat() );
 	m_gainModel.setValue( _this.attribute( "gain" ).toFloat() );
@@ -95,8 +89,7 @@ void bassBoosterControls::loadSettings( const QDomElement & _this )
 
 
 
-void bassBoosterControls::saveSettings( QDomDocument & _doc, 
-							QDomElement & _this )
+void BassBoosterControls::saveSettings( QDomDocument& doc, QDomElement& _this )
 {
 	_this.setAttribute( "freq", m_freqModel.value() );
 	_this.setAttribute( "gain", m_gainModel.value() );
@@ -105,5 +98,5 @@ void bassBoosterControls::saveSettings( QDomDocument & _doc,
 
 
 
-#include "moc_bassbooster_controls.cxx"
+#include "moc_BassBoosterControls.cxx"
 

plugins/BassBooster/BassBoosterControls.h

@@ -1,8 +1,8 @@
 /*
- * bassbooster_controls.h - controls for bassbooster-effect
+ * BassBoosterControls.h - controls for bassboosterx -effect
+ *
+ * Copyright (c) 2008-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
  *
- * Copyright (c) 2008 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  *
  * This program is free software; you can redistribute it and/or
@@ -26,19 +26,19 @@
 #define _BASSBOOSTER_CONTROLS_H
 
 #include "EffectControls.h"
-#include "bassbooster_control_dialog.h"
+#include "BassBoosterControlDialog.h"
 #include "knob.h"
 
 
-class bassBoosterEffect;
+class BassBoosterEffect;
 
 
-class bassBoosterControls : public EffectControls
+class BassBoosterControls : public EffectControls
 {
 	Q_OBJECT
 public:
-	bassBoosterControls( bassBoosterEffect * _eff );
-	virtual ~bassBoosterControls()
+	BassBoosterControls( BassBoosterEffect* effect );
+	virtual ~BassBoosterControls()
 	{
 	}
 
@@ -46,17 +46,17 @@ public:
 	virtual void loadSettings( const QDomElement & _this );
 	inline virtual QString nodeName() const
 	{
-		return( "bassboostercontrols" );
+		return "bassboostercontrols";
 	}
 
 	virtual int controlCount()
 	{
-		return( 3 );
+		return 3;
 	}
 
-	virtual EffectControlDialog * createView()
+	virtual EffectControlDialog* createView()
 	{
-		return( new bassBoosterControlDialog( this ) );
+		return new BassBoosterControlDialog( this );
 	}
 
 
@@ -67,12 +67,12 @@ private slots:
 
 
 private:
-	bassBoosterEffect * m_effect;
+	BassBoosterEffect* m_effect;
 	FloatModel m_freqModel;
 	FloatModel m_gainModel;
 	FloatModel m_ratioModel;
 
-	friend class bassBoosterControlDialog;
+	friend class BassBoosterControlDialog;
 
 } ;
 

plugins/BassBooster/CMakeLists.txt

@@ -0,0 +1,3 @@
+INCLUDE(BuildPlugin)
+
+BUILD_PLUGIN(bassbooster BassBooster.cpp BassBoosterControls.cpp BassBoosterControlDialog.cpp MOCFILES BassBoosterControls.h EMBEDDED_RESOURCES "${CMAKE_CURRENT_SOURCE_DIR}/*.png")

plugins/CMakeLists.txt

@@ -1,5 +1,5 @@
 ADD_SUBDIRECTORY(audio_file_processor)
-ADD_SUBDIRECTORY(bass_booster)
+ADD_SUBDIRECTORY(BassBooster)
 ADD_SUBDIRECTORY(bit_invader)
 ADD_SUBDIRECTORY(dynamics_processor)
 ADD_SUBDIRECTORY(flp_import)

plugins/bass_booster/CMakeLists.txt

@@ -1,3 +0,0 @@
-INCLUDE(BuildPlugin)
-
-BUILD_PLUGIN(bassbooster bass_booster.cpp bassbooster_controls.cpp bassbooster_control_dialog.cpp MOCFILES bassbooster_controls.h EMBEDDED_RESOURCES "${CMAKE_CURRENT_SOURCE_DIR}/*.png")