vstaudioeffect.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// Project     : VST SDK
// Version     : 3.0
//
// Category    : Helpers
// Filename    : vstaudioeffect.h
// Created by  : Steinberg, 04/2005
// Modified    : $Date: 2008/01/09 12:51:06 $
// Description : Basic Audio Effect Implementation
//
//-----------------------------------------------------------------------------
// 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 __vstaudioeffect__
#define __vstaudioeffect__

#include "vstcomponent.h"
#include "pluginterfaces/vst/ivstaudioprocessor.h"

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

//------------------------------------------------------------------------
// AudioBus
//------------------------------------------------------------------------
class AudioBus: public Bus
{
public:
//------------------------------------------------------------------------
        AudioBus (const TChar* name, BusType busType, int32 flags, SpeakerArrangement arr);

        SpeakerArrangement getArrangement () const { return speakerArr; }
        void setArrangement (const SpeakerArrangement& arr) { speakerArr = arr; }

        //---from Bus---------------------
        virtual bool getInfo (BusInfo& info);
//------------------------------------------------------------------------
protected:
        SpeakerArrangement speakerArr;
};

//------------------------------------------------------------------------
// AudioEffect
//------------------------------------------------------------------------
class AudioEffect: public Component,
                                   public IAudioProcessor
{
public:
//------------------------------------------------------------------------
        AudioEffect ();

        //---Internal Methods-----------
        AudioBus* addAudioInput (const TChar* name, SpeakerArrangement arr, 
                                                         BusType busType = kMain, int32 flags = BusInfo::kDefaultActive);

        AudioBus* addAudioOutput (const TChar* name, SpeakerArrangement arr, 
                                                          BusType busType = kMain, int32 flags = BusInfo::kDefaultActive);

        EventBus* addEventInput (const TChar* name, int32 channels = 16, 
                                                      BusType busType = kMain, int32 flags = BusInfo::kDefaultActive);

        EventBus* addEventOutput (const TChar* name, int32 channels = 16, 
                                                          BusType busType = kMain, int32 flags = BusInfo::kDefaultActive);

        //---from IAudioProcessor-------
        tresult PLUGIN_API setBusArrangements (SpeakerArrangement* inputs, int32 numIns, SpeakerArrangement* outputs, int32 numOuts);
        tresult PLUGIN_API getBusArrangement (BusDirection dir, int32 busIndex, SpeakerArrangement& arr);
        tresult PLUGIN_API canProcessSampleSize (int32 symbolicSampleSize);
        uint32 PLUGIN_API getLatencySamples () { return 0; } 
        tresult PLUGIN_API setupProcessing (ProcessSetup& setup);
        tresult PLUGIN_API setProcessing (TBool state);
        tresult PLUGIN_API process (ProcessData& data);
        uint32 PLUGIN_API getTailSamples () { return 0; }

        //---from Component--------------
        DELEGATE_REFCOUNT (Component)
        tresult PLUGIN_API queryInterface (const char* iid, void** obj);
//------------------------------------------------------------------------
protected:
        ProcessSetup processSetup;
};

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

#endif  // __vstaudioeffect__

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.