juce_AudioPluginFormat.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 JUCE_API  AudioPluginFormat  : private MessageListener
{
public:
    ~AudioPluginFormat() override;
 
    //==============================================================================
    virtual String getName() const = 0;

    virtual void findAllTypesForFile (OwnedArray<PluginDescription>& results,
                                      const String& fileOrIdentifier) = 0;

    std::unique_ptr<AudioPluginInstance> createInstanceFromDescription (const PluginDescription&,
                                                                        double initialSampleRate,
                                                                        int initialBufferSize);

    std::unique_ptr<AudioPluginInstance> createInstanceFromDescription (const PluginDescription&,
                                                                        double initialSampleRate,
                                                                        int initialBufferSize,
                                                                        String& errorMessage);

    using PluginCreationCallback = std::function<void (std::unique_ptr<AudioPluginInstance>, const String&)>;

    void createPluginInstanceAsync (const PluginDescription& description,
                                    double initialSampleRate,
                                    int initialBufferSize,
                                    PluginCreationCallback);

    virtual bool fileMightContainThisPluginType (const String& fileOrIdentifier) = 0;

    virtual String getNameOfPluginFromIdentifier (const String& fileOrIdentifier) = 0;

    virtual bool pluginNeedsRescanning (const PluginDescription&) = 0;

    virtual bool doesPluginStillExist (const PluginDescription&) = 0;

    virtual bool canScanForPlugins() const = 0;

    virtual bool isTrivialToScan() const = 0;

    virtual StringArray searchPathsForPlugins (const FileSearchPath& directoriesToSearch,
                                               bool recursive,
                                               bool allowPluginsWhichRequireAsynchronousInstantiation = false) = 0;

    virtual FileSearchPath getDefaultLocationsToSearch() = 0;

    virtual bool requiresUnblockedMessageThreadDuringCreation (const PluginDescription&) const = 0;

    using ARAFactoryCreationCallback = std::function<void (ARAFactoryResult)>;

    virtual void createARAFactoryAsync (const PluginDescription&, ARAFactoryCreationCallback callback) { callback ({}); }
 
protected:
    //==============================================================================
    friend class AudioPluginFormatManager;
 
    AudioPluginFormat();

    virtual void createPluginInstance (const PluginDescription&, double initialSampleRate,
                                       int initialBufferSize, PluginCreationCallback) = 0;
 
private:
    struct AsyncCreateMessage;
    void handleMessage (const Message&) override;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioPluginFormat)
};
 
} // namespace juce