Instrument release time in milliseconds (#7217)

Make instruments report their release time in milliseconds so that it becomes independent of the sample rate and sounds the same at any sample rate.

Technically this is done by removing the virtual keyword from `desiredReleaseFrames` so that it cannot be overridden anymore. The method now only serves to compute the number of frames from the given release time in milliseconds.

A new virtual method `desiredReleaseTimeMs` is added which instruments can override. The default returns 0 ms just like the default implementation previously returned 0 frames.

The method `computeReleaseTimeMsByFrameCount` is added for instruments that still use a hard coded release in frames. As of now this is only `SidInstrument`.

Add the helper method `getSampleRate` to `Instrument`.

Adjust several instruments to report their release times in milliseconds. The times are computed by taking the release in frames and assuming a sample rate of 44.1 kHz. In most cases the times are rounded to a "nice" next value, e.g.:
*  64 frames -> 1.5 ms (66 frames)
* 128 frames -> 3.0 ms (132 frames)
* 512 frames -> 12. ms (529 frames)
* 1000 frames -> 23 ms (1014 samples)

In parentheses the number of frames are shown which result from the rounded number of milliseconds when converted back assuming a sample rate of 44.1 kHz. The difference should not be noticeable in existing projects.

Remove the overrides for instruments that return the same value as the base class `Instrument` anyway. These are:
* GigPlayer
* Lb302
* Sf2Player

For `MonstroInstrument` the implementation is adjusted to behave in a very similar way. First the maximum of the envelope release times is computed. These are already available in milliseconds. Then the maximum of that value and 1.5 ms is taken and returned as the result.
This commit is contained in:
Michael Gregorius
2024-04-24 20:23:36 +02:00
committed by GitHub
parent 62e2a39a7e
commit 71dd300f43
18 changed files with 57 additions and 66 deletions

View File

@@ -56,9 +56,9 @@ public:
auto beatLen(NotePlayHandle* note) const -> int override;
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return 128;
return 3.f;
}
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -85,9 +85,9 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return( 64 );
return 1.5f;
}
gui::PluginView * instantiateView( QWidget * _parent ) override;

View File

@@ -220,22 +220,10 @@ QString FreeBoyInstrument::nodeName() const
/*f_cnt_t FreeBoyInstrument::desiredReleaseFrames() const
float FreeBoyInstrument::desiredReleaseTimeMs() const
{
const float samplerate = Engine::audioEngine()->processingSampleRate();
int maxrel = 0;
for( int i = 0 ; i < 3 ; ++i )
{
if( maxrel < m_voice[i]->m_releaseModel.value() )
maxrel = m_voice[i]->m_releaseModel.value();
}
return f_cnt_t( float(relTime[maxrel])*samplerate/1000.0 );
}*/
f_cnt_t FreeBoyInstrument::desiredReleaseFrames() const
{
return f_cnt_t( 1000 );
// Previous implementation was 1000 samples. At 44.1 kHz this is somewhat shy of 23. ms.
return 23.f;
}

View File

@@ -62,7 +62,7 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override;
float desiredReleaseTimeMs() const override;
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -259,11 +259,6 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
{
return 0;
}
Flags flags() const override
{
return Flag::IsSingleStreamed | Flag::IsNotBendable;

View File

@@ -69,9 +69,9 @@ public:
return Flag::IsNotBendable;
}
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return( 512 );
return 12.f;
}
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -168,11 +168,6 @@ public:
return Flag::IsSingleStreamed;
}
f_cnt_t desiredReleaseFrames() const override
{
return 0; //4048;
}
gui::PluginView* instantiateView( QWidget * _parent ) override;
private:

View File

@@ -1326,13 +1326,12 @@ QString MonstroInstrument::nodeName() const
return monstro_plugin_descriptor.name;
}
f_cnt_t MonstroInstrument::desiredReleaseFrames() const
float MonstroInstrument::desiredReleaseTimeMs() const
{
return qMax( 64, qMax( m_env1_relF, m_env2_relF ) );
const auto maxEnvelope = std::max(m_env1_rel, m_env2_rel);
return std::max(1.5f, maxEnvelope);
}
gui::PluginView* MonstroInstrument::instantiateView( QWidget * _parent )
{
return( new gui::MonstroView( this, _parent ) );

View File

@@ -366,7 +366,7 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override;
float desiredReleaseTimeMs() const override;
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -222,9 +222,9 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return( 8 );
return 0.2f;
}
gui::PluginView* instantiateView( QWidget * parent ) override;

View File

@@ -71,9 +71,9 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return( 128 );
return 3.f;
}
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -80,11 +80,6 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
{
return 0;
}
Flags flags() const override
{
return Flag::IsSingleStreamed;

View File

@@ -221,24 +221,18 @@ QString SidInstrument::nodeName() const
}
f_cnt_t SidInstrument::desiredReleaseFrames() const
float SidInstrument::desiredReleaseTimeMs() const
{
const float samplerate = Engine::audioEngine()->processingSampleRate();
int maxrel = 0;
for (const auto& voice : m_voice)
{
if( maxrel < voice->m_releaseModel.value() )
maxrel = (int)voice->m_releaseModel.value();
maxrel = std::max(maxrel, static_cast<int>(voice->m_releaseModel.value()));
}
return f_cnt_t( float(relTime[maxrel])*samplerate/1000.0 );
return computeReleaseTimeMsByFrameCount(relTime[maxrel]);
}
static int sid_fillbuffer(unsigned char* sidreg, reSID::SID *sid, int tdelta, short *ptr, int samples)
{
int total = 0;

View File

@@ -111,7 +111,7 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override;
float desiredReleaseTimeMs() const override;
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -121,9 +121,9 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return( 128 );
return 3.f;
}
gui::PluginView* instantiateView( QWidget * _parent ) override;

View File

@@ -150,9 +150,9 @@ public:
QString nodeName() const override;
f_cnt_t desiredReleaseFrames() const override
float desiredReleaseTimeMs() const override
{
return( 64 );
return 1.5f;
}
gui::PluginView* instantiateView( QWidget * _parent ) override;