Files
lmms/plugins/Eq/EqEffect.cpp
curlymorphic 1e777cf945 Remove audio artifacts when automating the Equliser parameters.
The Equliser pluging uses biquad filters, These do not like having
there parameters updating during processing, and are know to produce
clicks and DC biasing. A twin filter system has been employed with a
cross fade, to interpolate between parameters.

This has removed for the use of sample exactness, as the filter is only
updated once per frame, with interpolation provided by the crossfade.

The same filters are used as pervious, ensuring unautomated filtering
remains unchanged.
2018-03-17 22:25:12 +00:00

369 lines
11 KiB
C++

/*
* eqeffect.cpp - defination of EqEffect class.
*
* Copyright (c) 2014 David French <dave/dot/french3/at/googlemail/dot/com>
*
* This file is part of LMMS - https://lmms.io
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program (see COPYING); if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
*/
#include "EqEffect.h"
#include "embed.h"
#include "Engine.h"
#include "EqFader.h"
#include "interpolation.h"
#include "lmms_math.h"
extern "C"
{
Plugin::Descriptor PLUGIN_EXPORT eq_plugin_descriptor =
{
STRINGIFY( PLUGIN_NAME ),
"Equalizer",
QT_TRANSLATE_NOOP( "pluginBrowser", "A native eq plugin" ),
"Dave French <contact/dot/dave/dot/french3/at/googlemail/dot/com>",
0x0100,
Plugin::Effect,
new PluginPixmapLoader("logo"),
NULL,
NULL
} ;
}
EqEffect::EqEffect( Model *parent, const Plugin::Descriptor::SubPluginFeatures::Key *key) :
Effect( &eq_plugin_descriptor, parent, key ),
m_eqControls( this ),
m_inGain( 1.0 ),
m_outGain( 1.0 )
{
}
EqEffect::~EqEffect()
{
}
bool EqEffect::processAudioBuffer( sampleFrame *buf, const fpp_t frames )
{
const int sampleRate = Engine::mixer()->processingSampleRate();
//wet/dry controls
const float dry = dryLevel();
const float wet = wetLevel();
sample_t dryS[2];
// setup sample exact controls
float hpRes = m_eqControls.m_hpResModel.value();
float lowShelfRes = m_eqControls.m_lowShelfResModel.value();
float para1Bw = m_eqControls.m_para1BwModel.value();
float para2Bw = m_eqControls.m_para2BwModel.value();
float para3Bw = m_eqControls.m_para3BwModel.value();
float para4Bw = m_eqControls.m_para4BwModel.value();
float highShelfRes = m_eqControls.m_highShelfResModel.value();
float lpRes = m_eqControls.m_lpResModel.value();
float hpFreq = m_eqControls.m_hpFeqModel.value();
float lowShelfFreq = m_eqControls.m_lowShelfFreqModel.value();
float para1Freq = m_eqControls.m_para1FreqModel.value();
float para2Freq = m_eqControls.m_para2FreqModel.value();
float para3Freq = m_eqControls.m_para3FreqModel.value();
float para4Freq = m_eqControls.m_para4FreqModel.value();
float highShelfFreq = m_eqControls.m_highShelfFreqModel.value();
float lpFreq = m_eqControls.m_lpFreqModel.value();
bool hpActive = m_eqControls.m_hpActiveModel.value();
bool hp24Active = m_eqControls.m_hp24Model.value();
bool hp48Active = m_eqControls.m_hp48Model.value();
bool lowShelfActive = m_eqControls.m_lowShelfActiveModel.value();
bool para1Active = m_eqControls.m_para1ActiveModel.value();
bool para2Active = m_eqControls.m_para2ActiveModel.value();
bool para3Active = m_eqControls.m_para3ActiveModel.value();
bool para4Active = m_eqControls.m_para4ActiveModel.value();
bool highShelfActive = m_eqControls.m_highShelfActiveModel.value();
bool lpActive = m_eqControls.m_lpActiveModel.value();
bool lp24Active = m_eqControls.m_lp24Model.value();
bool lp48Active = m_eqControls.m_lp48Model.value();
float lowShelfGain = m_eqControls.m_lowShelfGainModel.value();
float para1Gain = m_eqControls.m_para1GainModel.value();
float para2Gain = m_eqControls.m_para2GainModel.value();
float para3Gain = m_eqControls.m_para3GainModel.value();
float para4Gain = m_eqControls.m_para4GainModel.value();
float highShelfGain = m_eqControls.m_highShelfGainModel.value();
//set all filter parameters once per frame, EqFilter handles
//smooth xfading, reducing pops clicks and dc bias offsets
m_hp12.setParameters( sampleRate, hpFreq, hpRes, 1 );
m_hp24.setParameters( sampleRate, hpFreq, hpRes, 1 );
m_hp480.setParameters( sampleRate, hpFreq, hpRes, 1 );
m_lp480.setParameters( sampleRate, lpFreq, lpRes, 1 );
m_hp481.setParameters( sampleRate, hpFreq, hpRes, 1 );
m_lp481.setParameters( sampleRate, hpFreq, hpRes, 1 );
m_lowShelf.setParameters( sampleRate, lowShelfFreq, lowShelfRes, lowShelfGain );
m_para1.setParameters( sampleRate, para1Freq, para1Bw, para1Gain );
m_para2.setParameters( sampleRate, para2Freq, para2Bw, para2Gain );
m_para3.setParameters( sampleRate, para3Freq, para3Bw, para3Gain );
m_para4.setParameters( sampleRate, para4Freq, para4Bw, para4Gain );
m_highShelf.setParameters( sampleRate, highShelfFreq, highShelfRes, highShelfGain );
m_lp12.setParameters( sampleRate, lpFreq, lpRes, 1 );
m_lp24.setParameters( sampleRate, lpFreq, lpRes, 1 );
m_lp480.setParameters( sampleRate, lpFreq, lpRes, 1 );
m_lp480.setParameters( sampleRate, lpFreq, lpRes, 1 );
if( !isEnabled() || !isRunning () )
{
return( false );
}
if( m_eqControls.m_outGainModel.isValueChanged() )
{
m_outGain = dbfsToAmp(m_eqControls.m_outGainModel.value());
}
if( m_eqControls.m_inGainModel.isValueChanged() )
{
m_inGain = dbfsToAmp(m_eqControls.m_inGainModel.value());
}
m_eqControls.m_inProgress = true;
double outSum = 0.0;
for( fpp_t f = 0; f < frames; ++f )
{
outSum += buf[f][0]*buf[f][0] + buf[f][1]*buf[f][1];
}
const float outGain = m_outGain;
sampleFrame m_inPeak = { 0, 0 };
if(m_eqControls.m_analyseInModel.value( true ) && outSum > 0 )
{
m_eqControls.m_inFftBands.analyze( buf, frames );
}
else
{
m_eqControls.m_inFftBands.clear();
}
gain( buf, frames, m_inGain, &m_inPeak );
m_eqControls.m_inPeakL = m_eqControls.m_inPeakL < m_inPeak[0] ? m_inPeak[0] : m_eqControls.m_inPeakL;
m_eqControls.m_inPeakR = m_eqControls.m_inPeakR < m_inPeak[1] ? m_inPeak[1] : m_eqControls.m_inPeakR;
float periodProgress = 0.0f; // percentage of period processed
for( fpp_t f = 0; f < frames; ++f)
{
periodProgress = (float)f / (float)(frames-1);
//wet dry buffer
dryS[0] = buf[f][0];
dryS[1] = buf[f][1];
if( hpActive )
{
buf[f][0] = m_hp12.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_hp12.update( buf[f][1], 1, periodProgress );
if( hp24Active || hp48Active )
{
buf[f][0] = m_hp24.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_hp24.update( buf[f][1], 1, periodProgress );
}
if( hp48Active )
{
buf[f][0] = m_hp480.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_hp480.update( buf[f][1], 1, periodProgress );
buf[f][0] = m_hp481.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_hp481.update( buf[f][1], 1, periodProgress );
}
}
if( lowShelfActive )
{
buf[f][0] = m_lowShelf.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_lowShelf.update( buf[f][1], 1, periodProgress );
}
if( para1Active )
{
buf[f][0] = m_para1.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_para1.update( buf[f][1], 1, periodProgress );
}
if( para2Active )
{
buf[f][0] = m_para2.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_para2.update( buf[f][1], 1, periodProgress );
}
if( para3Active )
{
buf[f][0] = m_para3.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_para3.update( buf[f][1], 1, periodProgress );
}
if( para4Active )
{
buf[f][0] = m_para4.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_para4.update( buf[f][1], 1, periodProgress );
}
if( highShelfActive )
{
buf[f][0] = m_highShelf.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_highShelf.update( buf[f][1], 1, periodProgress );
}
if( lpActive ){
buf[f][0] = m_lp12.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_lp12.update( buf[f][1], 1, periodProgress );
if( lp24Active || lp48Active )
{
buf[f][0] = m_lp24.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_lp24.update( buf[f][1], 1, periodProgress );
}
if( lp48Active )
{
buf[f][0] = m_lp480.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_lp480.update( buf[f][1], 1, periodProgress );
buf[f][0] = m_lp481.update( buf[f][0], 0, periodProgress );
buf[f][1] = m_lp481.update( buf[f][1], 1, periodProgress );
}
}
//apply wet / dry levels
buf[f][1] = ( dry * dryS[1] ) + ( wet * buf[f][1] );
buf[f][0] = ( dry * dryS[0] ) + ( wet * buf[f][0] );
}
sampleFrame outPeak = { 0, 0 };
gain( buf, frames, outGain, &outPeak );
m_eqControls.m_outPeakL = m_eqControls.m_outPeakL < outPeak[0] ? outPeak[0] : m_eqControls.m_outPeakL;
m_eqControls.m_outPeakR = m_eqControls.m_outPeakR < outPeak[1] ? outPeak[1] : m_eqControls.m_outPeakR;
checkGate( outSum / frames );
if(m_eqControls.m_analyseOutModel.value( true ) && outSum > 0 )
{
m_eqControls.m_outFftBands.analyze( buf, frames );
setBandPeaks( &m_eqControls.m_outFftBands , ( int )( sampleRate ) );
}
else
{
m_eqControls.m_outFftBands.clear();
}
m_eqControls.m_inProgress = false;
return isRunning();
}
float EqEffect::peakBand( float minF, float maxF, EqAnalyser *fft, int sr )
{
float peak = -60;
float *b = fft->m_bands;
float h = 0;
for( int x = 0; x < MAX_BANDS; x++, b++ )
{
if( bandToFreq( x ,sr) >= minF && bandToFreq( x,sr ) <= maxF )
{
h = 20 * ( log10( *b / fft->getEnergy() ) );
peak = h > peak ? h : peak;
}
}
return ( peak + 60 ) / 100;
}
void EqEffect::setBandPeaks( EqAnalyser *fft, int samplerate )
{
m_eqControls.m_lowShelfPeakR = m_eqControls.m_lowShelfPeakL =
peakBand( m_eqControls.m_lowShelfFreqModel.value()
* ( 1 - m_eqControls.m_lowShelfResModel.value() * 0.5 ),
m_eqControls.m_lowShelfFreqModel.value(),
fft , samplerate );
m_eqControls.m_para1PeakL = m_eqControls.m_para1PeakR =
peakBand( m_eqControls.m_para1FreqModel.value()
* ( 1 - m_eqControls.m_para1BwModel.value() * 0.5 ),
m_eqControls.m_para1FreqModel.value()
* ( 1 + m_eqControls.m_para1BwModel.value() * 0.5 ),
fft , samplerate );
m_eqControls.m_para2PeakL = m_eqControls.m_para2PeakR =
peakBand( m_eqControls.m_para2FreqModel.value()
* ( 1 - m_eqControls.m_para2BwModel.value() * 0.5 ),
m_eqControls.m_para2FreqModel.value()
* ( 1 + m_eqControls.m_para2BwModel.value() * 0.5 ),
fft , samplerate );
m_eqControls.m_para3PeakL = m_eqControls.m_para3PeakR =
peakBand( m_eqControls.m_para3FreqModel.value()
* ( 1 - m_eqControls.m_para3BwModel.value() * 0.5 ),
m_eqControls.m_para3FreqModel.value()
* ( 1 + m_eqControls.m_para3BwModel.value() * 0.5 ),
fft , samplerate );
m_eqControls.m_para4PeakL = m_eqControls.m_para4PeakR =
peakBand( m_eqControls.m_para4FreqModel.value()
* ( 1 - m_eqControls.m_para4BwModel.value() * 0.5 ),
m_eqControls.m_para4FreqModel.value()
* ( 1 + m_eqControls.m_para4BwModel.value() * 0.5 ),
fft , samplerate );
m_eqControls.m_highShelfPeakL = m_eqControls.m_highShelfPeakR =
peakBand( m_eqControls.m_highShelfFreqModel.value(),
m_eqControls.m_highShelfFreqModel.value()
* ( 1 + m_eqControls.m_highShelfResModel.value() * 0.5 ),
fft, samplerate );
}
extern "C"
{
//needed for getting plugin out of shared lib
PLUGIN_EXPORT Plugin * lmms_plugin_main( Model* parent, void* data )
{
return new EqEffect( parent , static_cast<const Plugin::Descriptor::SubPluginFeatures::Key *>( data ) );
}
}