juce/source/src/audio/plugin_host/juce_AudioPluginFormatManager.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_AUDIOPLUGINFORMATMANAGER_JUCEHEADER__
  27 #define __JUCE_AUDIOPLUGINFORMATMANAGER_JUCEHEADER__
  28
  29 #include "juce_AudioPluginFormat.h"
  30 #include "../../utilities/juce_DeletedAtShutdown.h"
  31 #include "../../core/juce_Singleton.h"
  32
  33
  34 //==============================================================================
  35 /**
  36     This maintains a list of known AudioPluginFormats.
  37
  38     @see AudioPluginFormat
  39 */
  40 class JUCE_API  AudioPluginFormatManager  : public DeletedAtShutdown
  41 {
  42 public:
  43     //==============================================================================
  44     AudioPluginFormatManager();
  45
  46     /** Destructor. */
  47     ~AudioPluginFormatManager();
  48
  49     juce_DeclareSingleton_SingleThreaded (AudioPluginFormatManager, false);
  50
  51     //==============================================================================
  52     /** Adds any formats that it knows about, e.g. VST.
  53     */
  54     void addDefaultFormats();
  55
  56     //==============================================================================
  57     /** Returns the number of types of format that are available.
  58
  59         Use getFormat() to get one of them.
  60     */
  61     int getNumFormats();
  62
  63     /** Returns one of the available formats.
  64
  65         @see getNumFormats
  66     */
  67     AudioPluginFormat* getFormat (int index);
  68
  69     //==============================================================================
  70     /** Adds a format to the list.
  71
  72         The object passed in will be owned and deleted by the manager.
  73     */
  74     void addFormat (AudioPluginFormat* format);
  75
  76
  77     //==============================================================================
  78     /** Tries to load the type for this description, by trying all the formats
  79         that this manager knows about.
  80
  81         The caller is responsible for deleting the object that is returned.
  82
  83         If it can't load the plugin, it returns 0 and leaves a message in the
  84         errorMessage string.
  85     */
  86     AudioPluginInstance* createPluginInstance (const PluginDescription& description,
  87                                                String& errorMessage) const;
  88
  89     /** Checks that the file or component for this plugin actually still exists.
  90
  91         (This won't try to load the plugin)
  92     */
  93     bool doesPluginStillExist (const PluginDescription& description) const;
  94
  95 private:
  96     //==============================================================================
  97     OwnedArray <AudioPluginFormat> formats;
  98
  99     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioPluginFormatManager);
 100 };
 101
 102
 103
 104 #endif   // __JUCE_AUDIOPLUGINFORMATMANAGER_JUCEHEADER__