187 lines
7.6 KiB
C++
187 lines
7.6 KiB
C++
//-----------------------------------------------------------------------------
|
|
// Project : VST SDK
|
|
//
|
|
// Category : Interfaces
|
|
// Filename : pluginterfaces/vst/ivstcomponent.h
|
|
// Created by : Steinberg, 04/2005
|
|
// Description : Basic VST Interfaces
|
|
//
|
|
//-----------------------------------------------------------------------------
|
|
// This file is part of a Steinberg SDK. It is subject to the license terms
|
|
// in the LICENSE file found in the top-level directory of this distribution
|
|
// and at www.steinberg.net/sdklicenses.
|
|
// No part of the SDK, including this file, may be copied, modified, propagated,
|
|
// or distributed except according to the terms contained in the LICENSE file.
|
|
//-----------------------------------------------------------------------------
|
|
|
|
#pragma once
|
|
|
|
#include "pluginterfaces/base/ipluginbase.h"
|
|
#include "vsttypes.h"
|
|
|
|
//------------------------------------------------------------------------
|
|
#include "pluginterfaces/base/falignpush.h"
|
|
//------------------------------------------------------------------------
|
|
|
|
namespace Steinberg {
|
|
class IBStream;
|
|
|
|
//------------------------------------------------------------------------
|
|
/** All VST specific interfaces are located in Vst namespace */
|
|
//------------------------------------------------------------------------
|
|
namespace Vst {
|
|
const int32 kDefaultFactoryFlags = PFactoryInfo::kUnicode; ///< Standard value for PFactoryInfo::flags
|
|
|
|
#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);
|
|
|
|
//------------------------------------------------------------------------
|
|
/** \defgroup vstBus VST Buses
|
|
Bus Description
|
|
|
|
A bus can be understood as a "collection of data channels" belonging together.
|
|
It describes a data input or a data output of the Plug-in.
|
|
A VST component can define any desired number of buses, but this number must \b never change.
|
|
Dynamic usage of buses is handled in the host by activating and deactivating buses.
|
|
The component has to define the maximum number of supported buses and it has to
|
|
define which of them are active by default. A host that can handle multiple buses,
|
|
allows the user to activate buses that were initially inactive.
|
|
|
|
See also: IComponent::getBusInfo, IComponent::activateBus
|
|
|
|
@{*/
|
|
|
|
//------------------------------------------------------------------------
|
|
/** Bus media types */
|
|
enum MediaTypes
|
|
{
|
|
kAudio = 0, ///< audio
|
|
kEvent, ///< events
|
|
kNumMediaTypes
|
|
};
|
|
|
|
//------------------------------------------------------------------------
|
|
/** Bus directions */
|
|
enum BusDirections
|
|
{
|
|
kInput = 0, ///< input bus
|
|
kOutput ///< output bus
|
|
};
|
|
|
|
//------------------------------------------------------------------------
|
|
/** Bus types */
|
|
enum BusTypes
|
|
{
|
|
kMain = 0, ///< main bus
|
|
kAux ///< auxiliary bus (sidechain)
|
|
};
|
|
|
|
//------------------------------------------------------------------------
|
|
/** BusInfo:
|
|
This is the structure used with getBusInfo, informing the host about what is a specific given bus.
|
|
\n See also: IComponent::getBusInfo */
|
|
struct BusInfo
|
|
{
|
|
MediaType mediaType; ///< Media type - has to be a value of \ref MediaTypes
|
|
BusDirection direction; ///< input or output \ref BusDirections
|
|
int32 channelCount; ///< number of channels (if used then need to be recheck after \ref
|
|
/// IAudioProcessor::setBusArrangements is called).
|
|
/// For a bus of type MediaTypes::kEvent the channelCount corresponds
|
|
/// to the number of supported MIDI channels by this bus
|
|
String128 name; ///< name of the bus
|
|
BusType busType; ///< main or aux - has to be a value of \ref BusTypes
|
|
uint32 flags; ///< flags - a combination of \ref BusFlags
|
|
enum BusFlags
|
|
{
|
|
kDefaultActive = 1 << 0 ///< bus active per default
|
|
};
|
|
};
|
|
|
|
/*@}*/
|
|
|
|
//------------------------------------------------------------------------
|
|
/** I/O modes */
|
|
enum IoModes
|
|
{
|
|
kSimple = 0, ///< 1:1 Input / Output. Only used for Instruments. See \ref vst3IoMode
|
|
kAdvanced, ///< n:m Input / Output. Only used for Instruments.
|
|
kOfflineProcessing ///< Plug-in used in an offline processing context
|
|
};
|
|
|
|
//------------------------------------------------------------------------
|
|
/** Routing Information:
|
|
When the Plug-in supports multiple I/O buses, a host may want to know how the buses are related. The
|
|
relation of an event-input-channel to an audio-output-bus in particular is of interest to the host
|
|
(in order to relate MIDI-tracks to audio-channels)
|
|
\n See also: IComponent::getRoutingInfo, \ref vst3Routing */
|
|
struct RoutingInfo
|
|
{
|
|
MediaType mediaType; ///< media type see \ref MediaTypes
|
|
int32 busIndex; ///< bus index
|
|
int32 channel; ///< channel (-1 for all channels)
|
|
};
|
|
|
|
//------------------------------------------------------------------------
|
|
// IComponent Interface
|
|
//------------------------------------------------------------------------
|
|
/** Component Base Interface
|
|
\ingroup vstIPlug vst300
|
|
- [plug imp]
|
|
- [released: 3.0.0]
|
|
- [mandatory]
|
|
|
|
This is the basic interface for a VST component and must always be supported.
|
|
It contains the common parts of any kind of processing class. The parts that
|
|
are specific to a media type are defined in a separate interface. An implementation
|
|
component must provide both the specific interface and IComponent.
|
|
*/
|
|
class IComponent: public IPluginBase
|
|
{
|
|
public:
|
|
//------------------------------------------------------------------------
|
|
/** Called before initializing the component to get information about the controller class. */
|
|
virtual tresult PLUGIN_API getControllerClassId (TUID classId) = 0;
|
|
|
|
/** Called before 'initialize' to set the component usage (optional). See \ref IoModes */
|
|
virtual tresult PLUGIN_API setIoMode (IoMode mode) = 0;
|
|
|
|
/** Called after the Plug-in is initialized. See \ref MediaTypes, BusDirections */
|
|
virtual int32 PLUGIN_API getBusCount (MediaType type, BusDirection dir) = 0;
|
|
|
|
/** Called after the Plug-in is initialized. See \ref MediaTypes, BusDirections */
|
|
virtual tresult PLUGIN_API getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo& bus /*out*/) = 0;
|
|
|
|
/** Retrieves routing information (to be implemented when more than one regular input or output bus exists).
|
|
The inInfo always refers to an input bus while the returned outInfo must refer to an output bus! */
|
|
virtual tresult PLUGIN_API getRoutingInfo (RoutingInfo& inInfo, RoutingInfo& outInfo /*out*/) = 0;
|
|
|
|
/** Called upon (de-)activating a bus in the host application. The Plug-in should only processed an activated bus,
|
|
the host could provide less see \ref AudioBusBuffers in the process call (see \ref IAudioProcessor::process) if last buses are not activated */
|
|
virtual tresult PLUGIN_API activateBus (MediaType type, BusDirection dir, int32 index, TBool state) = 0;
|
|
|
|
/** Activates / deactivates the component. */
|
|
virtual tresult PLUGIN_API setActive (TBool state) = 0;
|
|
|
|
/** Sets complete state of component. */
|
|
virtual tresult PLUGIN_API setState (IBStream* state) = 0;
|
|
|
|
/** Retrieves complete state of component. */
|
|
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"
|
|
//------------------------------------------------------------------------
|