juce_PluginHostType.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class PluginHostType
{
public:
    //==============================================================================
    PluginHostType()  : type (getHostType()) {}
    PluginHostType (const PluginHostType& other) = default;
    PluginHostType& operator= (const PluginHostType& other) = default;
 
    //==============================================================================
    enum HostType
    {
        UnknownHost,                
        AbletonLive6,               
        AbletonLive7,               
        AbletonLive8,               
        AbletonLive9,               
        AbletonLive10,              
        AbletonLive11,              
        AbletonLiveGeneric,         
        AdobeAudition,              
        AdobePremierePro,           
        AppleGarageBand,            
        AppleLogic,                 
        AppleMainStage,             
        Ardour,                     
        AULab,                      
        AvidProTools,               
        BitwigStudio,               
        CakewalkSonar8,             
        CakewalkSonarGeneric,       
        CakewalkByBandlab,          
        DaVinciResolve,             
        DigitalPerformer,           
        FinalCut,                   
        FruityLoops,                
        JUCEPluginHost,             
        MagixSamplitude,            
        MagixSequoia,               
        MergingPyramix,             
        MuseReceptorGeneric,        
        pluginval,                  
        Reaper,                     
        Reason,                     
        Renoise,                    
        SADiE,                      
        SteinbergCubase4,           
        SteinbergCubase5,           
        SteinbergCubase5Bridged,    
        SteinbergCubase6,           
        SteinbergCubase7,           
        SteinbergCubase8,           
        SteinbergCubase8_5,         
        SteinbergCubase9,           
        SteinbergCubase9_5,         
        SteinbergCubase10,          
        SteinbergCubase10_5,        
        SteinbergCubaseGeneric,     
        SteinbergNuendo3,           
        SteinbergNuendo4,           
        SteinbergNuendo5,           
        SteinbergNuendoGeneric,     
        SteinbergWavelab5,          
        SteinbergWavelab6,          
        SteinbergWavelab7,          
        SteinbergWavelab8,          
        SteinbergWavelabGeneric,    
        SteinbergTestHost,          
        StudioOne,                  
        Tracktion3,                 
        TracktionGeneric,           
        TracktionWaveform,          
        VBVSTScanner,               
        ViennaEnsemblePro,          
        WaveBurner                  
    };
 
    HostType type;
 
    //==============================================================================
    bool isAbletonLive() const noexcept       { return type == AbletonLive6 || type == AbletonLive7 || type == AbletonLive8
                                                      || type == AbletonLive9 || type == AbletonLive10 || type == AbletonLive11
                                                      || type == AbletonLiveGeneric; }

    bool isAdobeAudition() const noexcept     { return type == AdobeAudition; }
    bool isArdour() const noexcept            { return type == Ardour; }
    bool isAULab() const noexcept             { return type == AULab; }
    bool isBitwigStudio() const noexcept      { return type == BitwigStudio; }
    bool isCubase() const noexcept            { return type == SteinbergCubase4 || type == SteinbergCubase5 || type == SteinbergCubase5Bridged || type == SteinbergCubase6
                                                      || type == SteinbergCubase7 || type == SteinbergCubase8 || type == SteinbergCubase8_5 || type == SteinbergCubase9
                                                      || type == SteinbergCubase9_5 || type == SteinbergCubase10 || type == SteinbergCubase10_5 || type == SteinbergCubaseGeneric; }

    bool isCubase7orLater() const noexcept    { return isCubase() && ! (type == SteinbergCubase4 || type == SteinbergCubase5 || type == SteinbergCubase6); }
    bool isCubaseBridged() const noexcept     { return type == SteinbergCubase5Bridged; }
    bool isDaVinciResolve() const noexcept    { return type == DaVinciResolve; }
    bool isDigitalPerformer() const noexcept  { return type == DigitalPerformer; }
    bool isFinalCut() const noexcept          { return type == FinalCut; }
    bool isFruityLoops() const noexcept       { return type == FruityLoops; }
    bool isGarageBand() const noexcept        { return type == AppleGarageBand; }
    bool isJUCEPluginHost() const noexcept    { return type == JUCEPluginHost; }
    bool isLogic() const noexcept             { return type == AppleLogic; }
    bool isMainStage() const noexcept         { return type == AppleMainStage; }
    bool isNuendo() const noexcept            { return type == SteinbergNuendo3 || type == SteinbergNuendo4  || type == SteinbergNuendo5 ||  type == SteinbergNuendoGeneric; }
    bool isPluginval() const noexcept         { return type == pluginval; }
    bool isPremiere() const noexcept          { return type == AdobePremierePro; }
    bool isProTools() const noexcept          { return type == AvidProTools; }
    bool isPyramix() const noexcept           { return type == MergingPyramix; }
    bool isReceptor() const noexcept          { return type == MuseReceptorGeneric; }
    bool isReaper() const noexcept            { return type == Reaper; }
    bool isReason() const noexcept            { return type == Reason; }
    bool isRenoise() const noexcept           { return type == Renoise; }
    bool isSADiE() const noexcept             { return type == SADiE; }
    bool isSamplitude() const noexcept        { return type == MagixSamplitude; }
    bool isSequoia() const noexcept           { return type == MagixSequoia; }
    bool isSonar() const noexcept             { return type == CakewalkSonar8 || type == CakewalkSonarGeneric || type == CakewalkByBandlab; }
    bool isSteinbergTestHost() const noexcept { return type == SteinbergTestHost; }
    bool isSteinberg() const noexcept         { return isCubase() || isNuendo() || isWavelab() || isSteinbergTestHost(); }
    bool isStudioOne() const noexcept         { return type == StudioOne; }
    bool isTracktion() const noexcept         { return type == Tracktion3 || type == TracktionGeneric || isTracktionWaveform(); }
    bool isTracktionWaveform() const noexcept { return type == TracktionWaveform; }
    bool isVBVSTScanner() const noexcept      { return type == VBVSTScanner; }
    bool isViennaEnsemblePro() const noexcept { return type == ViennaEnsemblePro; }
    bool isWaveBurner() const noexcept        { return type == WaveBurner; }
    bool isWavelab() const noexcept           { return isWavelabLegacy() || type == SteinbergWavelab7 || type == SteinbergWavelab8 || type == SteinbergWavelabGeneric; }
    bool isWavelabLegacy() const noexcept     { return type == SteinbergWavelab5 || type == SteinbergWavelab6; }
 
    //==============================================================================
    const char* getHostDescription() const noexcept;
 
    //==============================================================================
    bool isInterAppAudioConnected() const;
    void switchToHostApplication() const;
   #if ! JUCE_AUDIOPROCESSOR_NO_GUI
    Image getHostIcon (int size) const;
   #endif
 
    //==============================================================================
    static String getHostPath()
    {
        return File::getSpecialLocation (File::hostApplicationPath).getFullPathName();
    }
 
    //==============================================================================
    static AudioProcessor::WrapperType getPluginLoadedAs() noexcept    { return jucePlugInClientCurrentWrapperType; }

    static bool isInAAXAudioSuite (AudioProcessor&);
 
    //==============================================================================
 
  #ifndef DOXYGEN
    // @internal
    static AudioProcessor::WrapperType jucePlugInClientCurrentWrapperType;
    static std::function<bool (AudioProcessor&)> jucePlugInIsRunningInAudioSuiteFn;
    static String hostIdReportedByWrapper;
  #endif
 
private:
    static HostType getHostType();
};
 
} // namespace juce