tracktion_AuxSend.cpp

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
namespace tracktion { inline namespace engine
{
 
AuxSendPlugin::AuxSendPlugin (PluginCreationInfo info) : Plugin (info)
{
    auto um = getUndoManager();
    busNumber.referTo (state, IDs::busNum, um);
    gainLevel.referTo (state, IDs::auxSendSliderPos, um, decibelsToVolumeFaderPosition (0.0f));
    invertPhase.referTo (state, IDs::phase, um, false);
    lastVolumeBeforeMute.referTo (state, IDs::lastVolumeBeforeMuteDb, um, 0.0f);
 
    gain = addParam ("send level", TRANS("Send level"), { 0.0f, 1.0f },
                     [] (float value)             { return juce::Decibels::toString (volumeFaderPositionToDB (value)); },
                     [] (const juce::String& s)   { return decibelsToVolumeFaderPosition (dbStringToDb (s)); });
 
    gain->attachToCurrentValue (gainLevel);
 
    quickParamName = "send level";
}
 
AuxSendPlugin::~AuxSendPlugin()
{
    notifyListenersOfDeletion();
    gain->detachFromCurrentValue();
}
 
bool AuxSendPlugin::shouldProcess()
{
    const juce::ScopedLock sl (ownerTrackLock);
 
    if (ownerTrack != nullptr)
    {
        // If this track gets disabled when muted,
        // we don't need to worry about this since
        // our plugin will be disabled anyway
        if (! ownerTrack->processAudioNodesWhileMuted())
            return true;
 
        return ! ownerTrack->isMuted (true);
    }
 
    return true;
}
 
const char* AuxSendPlugin::xmlTypeName = "auxsend";
 
juce::String AuxSendPlugin::getName() const
{
    juce::String nm (edit.getAuxBusName (busNumber));
 
    if (nm.isNotEmpty())
        return "S:" + nm;
 
    return TRANS("Aux Send") + " #" + juce::String (busNumber + 1);
}
 
juce::String AuxSendPlugin::getShortName (int)
{
    auto nm = edit.getAuxBusName (busNumber);
 
    if (nm.isNotEmpty())
        return "S:" + nm;
 
    return TRANS("Send") + ":" + juce::String (busNumber + 1);
}
 
void AuxSendPlugin::initialise (const PluginInitialisationInfo& info)
{
    lastGain = volumeFaderPositionToGain (gain->getCurrentValue());
 
    initialiseWithoutStopping (info);
}
 
void AuxSendPlugin::initialiseWithoutStopping (const PluginInitialisationInfo&)
{
    TRACKTION_ASSERT_MESSAGE_THREAD
    auto newOwnerTrack = getOwnerTrack();
 
    const juce::ScopedLock sl (ownerTrackLock);
    ownerTrack = newOwnerTrack;
}
 
void AuxSendPlugin::deinitialise()
{
}
 
void AuxSendPlugin::applyToBuffer (const PluginRenderContext&)
{
}
 
juce::String AuxSendPlugin::getBusName()
{
    auto busName = edit.getAuxBusName (busNumber);
 
    if (busName.isNotEmpty())
        return busName;
 
    return getDefaultBusName (busNumber);
}
 
void AuxSendPlugin::setGainDb (float newDb)
{
    float newPos = decibelsToVolumeFaderPosition (newDb);
 
    if (gain->getCurrentValue() != newPos)
    {
        gain->setParameter (newPos, juce::sendNotification);
        changed();
    }
}
 
void AuxSendPlugin::setMute (bool b)
{
    if (b)
    {
        lastVolumeBeforeMute = getGainDb();
        setGainDb (lastVolumeBeforeMute - 0.01f); // needed so that automation is recorded correctly
        setGainDb (-100.0f);
    }
    else
    {
        if (lastVolumeBeforeMute < -100.0f)
            lastVolumeBeforeMute = 0.0f;
 
        setGainDb (getGainDb() + 0.01f); // needed so that automation is recorded correctly
        setGainDb (lastVolumeBeforeMute);
    }
}
 
bool AuxSendPlugin::isMute()
{
    return getGainDb() <= -90.0f;
}
 
juce::String AuxSendPlugin::getDefaultBusName (int index)
{
    return "Bus #" + juce::String (index + 1);
}
 
juce::StringArray AuxSendPlugin::getBusNames (Edit& ed, int maxNumBusses)
{
    juce::StringArray buses;
 
    for (int i = 0; i < maxNumBusses; ++i)
    {
        auto nm = getDefaultBusName (i);
 
        if (ed.getAuxBusName (i).isNotEmpty())
            nm << " (" << ed.getAuxBusName (i) << ")";
 
        buses.add (nm);
    }
 
    return buses;
}
 
void AuxSendPlugin::restorePluginStateFromValueTree (const juce::ValueTree& v)
{
    copyPropertiesToCachedValues (v, gainLevel, busNumber, invertPhase);
 
    for (auto p : getAutomatableParameters())
        p->updateFromAttachedValue();
}
 
}} // namespace tracktion { inline namespace engine