ivstcomponent.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// Project     : VST SDK
// Version     : 3.0
//
// Category    : Interfaces
// Filename    : ivstcomponent.h
// Created by  : Steinberg, 04/2005
// Modified    : $Date: 2008/01/15 11:28:20 $
// Description : Basic VST Interfaces
//
//-----------------------------------------------------------------------------
// LICENSE
// © 2008, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// This Software Development Kit may not be distributed in parts or its entirety  
// without prior written agreement by Steinberg Media Technologies GmbH. 
// This SDK must not be used to re-engineer or manipulate any technology used  
// in any Steinberg or Third-party application or software module, 
// unless permitted by law.
// Neither the name of the Steinberg Media Technologies nor the names of its
// contributors may be used to endorse or promote products derived from this 
// software without specific prior written permission.
// 
// THIS SDK IS PROVIDED BY STEINBERG MEDIA TECHNOLOGIES GMBH "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL STEINBERG MEDIA TECHNOLOGIES GMBH BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------

#ifndef __ivstcomponent__
#define __ivstcomponent__

#include "pluginterfaces/base/ipluginbase.h"
#include "vsttypes.h"

//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpush.h"
//------------------------------------------------------------------------

namespace Steinberg {
class IBStream;

//------------------------------------------------------------------------
namespace Vst {

const int32 kDefaultFactoryFlags = PFactoryInfo::kUnicode; 

#define BEGIN_FACTORY_DEF(vendor,url,email) using namespace Steinberg; \
        EXPORT_FACTORY IPluginFactory* PLUGIN_API GetPluginFactory () { \
        if (!gPluginFactory) \
        {       static PFactoryInfo factoryInfo = { vendor,url,email,Vst::kDefaultFactoryFlags }; \
                gPluginFactory = new CPluginFactory (factoryInfo);

//------------------------------------------------------------------------
//------------------------------------------------------------------------
enum MediaTypes
{
//------------------------------------------------------------------------
        kAudio = 0,             
        kEvent,                 
        kNumMediaTypes
//------------------------------------------------------------------------
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
enum BusDirections
{
//------------------------------------------------------------------------
        kInput = 0,             
        kOutput                 
//------------------------------------------------------------------------
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
enum BusTypes
{
//------------------------------------------------------------------------
        kMain = 0,              
        kAux                    
//------------------------------------------------------------------------
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
enum IoModes
{
        kSimple = 0,    
        kAdvanced               
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
struct BusInfo
{
//------------------------------------------------------------------------
        MediaType mediaType;            
        BusDirection direction;         
        int32 channelCount;                     
        String128 name;                         
        BusType busType;                        
        uint32 flags;                           
        enum BusFlags 
        {
                kDefaultActive = 1<<0   
        };              
//------------------------------------------------------------------------
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
struct RoutingInfo
{
        MediaType mediaType;    
        int32 busIndex;                 
        int32 channel;                  
};

//------------------------------------------------------------------------
// IComponent Interface
//------------------------------------------------------------------------
class IComponent: public IPluginBase
{
public:
//------------------------------------------------------------------------      
        virtual tresult PLUGIN_API getControllerClassId (TUID classId) = 0;
        
        virtual tresult PLUGIN_API setIoMode (IoMode mode) = 0;

        virtual int32 PLUGIN_API getBusCount (MediaType type, BusDirection dir) = 0;

        virtual tresult PLUGIN_API getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo& bus /*out*/) = 0;

        virtual tresult PLUGIN_API getRoutingInfo (RoutingInfo& inInfo, RoutingInfo& outInfo /*out*/) = 0;

        virtual tresult PLUGIN_API activateBus (MediaType type, BusDirection dir, int32 index, TBool state) = 0;

        virtual tresult PLUGIN_API setActive (TBool state) = 0;

        virtual tresult PLUGIN_API setState (IBStream* state) = 0;

        virtual tresult PLUGIN_API getState (IBStream* state) = 0;

//------------------------------------------------------------------------
        static const FUID iid;
};

DECLARE_CLASS_IID (IComponent, 0xE831FF31, 0xF2D54301, 0x928EBBEE, 0x25697802)

//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg

//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpop.h"
//------------------------------------------------------------------------

#endif // __ivstcomponent__

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.