ivstrepresentation.h

Go to the documentation of this file.

 //------------------------------------------------------------------------
// Project     : VST SDK
//
// Category    : Interfaces
// Filename    : pluginterfaces/vst/ivstrepresentation.h
// Created by  : Steinberg, 08/2010
// Description : VST Representation Interface
//
//-----------------------------------------------------------------------------
// 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/funknown.h"
#include "pluginterfaces/vst/vsttypes.h"
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpush.h"
//------------------------------------------------------------------------
 
//------------------------------------------------------------------------
namespace Steinberg {
class IBStream;
 
namespace Vst {
 
//------------------------------------------------------------------------
struct RepresentationInfo
{
    RepresentationInfo ()
    {
        memset (vendor, 0, kNameSize);
        memset (name, 0, kNameSize);
        memset (version, 0, kNameSize);
        memset (host, 0, kNameSize); 
    }
    
    RepresentationInfo (char8* _vendor, char8* _name = nullptr, char8* _version = nullptr, char8* _host = nullptr)
    {
        memset (vendor, 0, kNameSize);
        if (_vendor)
            strcpy (vendor, _vendor);
        memset (name, 0, kNameSize);
        if (_name)
            strcpy (name, _name);
        memset (version, 0, kNameSize);
        if (_version)
            strcpy (version, _version);
        memset (host, 0, kNameSize);
        if (_host)
            strcpy (host, _host);
    }
 
    enum
    {
        kNameSize = 64
    };
    char8 vendor[kNameSize];    
    char8 name[kNameSize];      
    char8 version[kNameSize];   
    char8 host[kNameSize];      
};
 
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
class IXmlRepresentationController : public FUnknown
{
public:
    virtual tresult PLUGIN_API getXmlRepresentationStream (RepresentationInfo& info /*in*/,
                                                           IBStream* stream /*out*/) = 0;
 
//------------------------------------------------------------------------
    static const FUID iid;
};
 
DECLARE_CLASS_IID (IXmlRepresentationController, 0xA81A0471, 0x48C34DC4, 0xAC30C9E1, 0x3C8393D5)
 
//------------------------------------------------------------------------
#define ROOTXML_TAG         "vstXML"
 
#define COMMENT_TAG         "comment"
#define CELL_TAG            "cell"
#define CELLGROUP_TAG       "cellGroup"
#define CELLGROUPTEMPLATE_TAG   "cellGroupTemplate"
#define CURVE_TAG           "curve"
#define CURVETEMPLATE_TAG   "curveTemplate"
#define DATE_TAG            "date"
#define LAYER_TAG           "layer"
#define NAME_TAG            "name"
#define ORIGINATOR_TAG      "originator"
#define PAGE_TAG            "page"
#define PAGETEMPLATE_TAG    "pageTemplate"
#define PLUGIN_TAG          "plugin"
#define VALUE_TAG           "value"
#define VALUEDISPLAY_TAG    "valueDisplay"
#define VALUELIST_TAG       "valueList"
#define REPRESENTATION_TAG  "representation"
#define SEGMENT_TAG         "segment"
#define SEGMENTLIST_TAG     "segmentList"
#define TITLEDISPLAY_TAG    "titleDisplay"
 
#define ATTR_CATEGORY       "category"
#define ATTR_CLASSID        "classID"
#define ATTR_ENDPOINT       "endPoint"
#define ATTR_INDEX          "index"
#define ATTR_FLAGS          "flags"
#define ATTR_FUNCTION       "function"
#define ATTR_HOST           "host"
#define ATTR_LEDSTYLE       "ledStyle"
#define ATTR_LENGTH         "length"
#define ATTR_LINKEDTO       "linkedTo"
#define ATTR_NAME           "name"
#define ATTR_ORDER          "order"
#define ATTR_PAGE           "page"
#define ATTR_PARAMID        "parameterID"
#define ATTR_STARTPOINT     "startPoint"
#define ATTR_STYLE          "style"
#define ATTR_SWITCHSTYLE    "switchStyle"
#define ATTR_TEMPLATE       "template"
#define ATTR_TURNSPERFULLRANGE  "turnsPerFullRange"
#define ATTR_TYPE           "type"
#define ATTR_UNITID         "unitID"
#define ATTR_VARIABLES      "variables"
#define ATTR_VENDOR         "vendor"
#define ATTR_VERSION        "version"
 
//------------------------------------------------------------------------
#define GENERIC                 "Generic"
#define GENERIC_4_CELLS         "Generic 4 Cells"
#define GENERIC_8_CELLS         "Generic 8 Cells"
#define GENERIC_12_CELLS        "Generic 12 Cells"
#define GENERIC_24_CELLS        "Generic 24 Cells"
#define GENERIC_N_CELLS         "Generic %d Cells"
#define QUICK_CONTROL_8_CELLS   "Quick Controls 8 Cells"
 
//------------------------------------------------------------------------
namespace LayerType
{
    enum 
    {
        kKnob = 0,      
        kPressedKnob,   
        kSwitchKnob,    
        kSwitch,        
        kLED,           
        kLink,          
        kDisplay,       
        kFader,         
        kEndOfLayerType
    };
 
    static const FIDString layerTypeFIDString[] = {
        "knob"
        ,"pressedKnob"
        ,"switchKnob"
        ,"switch"
        ,"LED"
        ,"link"
        ,"display"
        ,"fader"
        ,nullptr
    };
};
 
//------------------------------------------------------------------------
namespace CurveType
{
    const CString kSegment      = "segment";    
    const CString kValueList    = "valueList";  
};
 
//------------------------------------------------------------------------
namespace Attributes
{
    const CString kStyle        = ATTR_STYLE;           
    const CString kLEDStyle     = ATTR_LEDSTYLE;        
    const CString kSwitchStyle  = ATTR_SWITCHSTYLE;     
    const CString kKnobTurnsPerFullRange = ATTR_TURNSPERFULLRANGE;  
    const CString kFunction     = ATTR_FUNCTION;        
    const CString kFlags        = ATTR_FLAGS;           
};
 
//------------------------------------------------------------------------
namespace AttributesFunction
{
    const CString kPanPosCenterXFunc        = "PanPosCenterX";      
    const CString kPanPosCenterYFunc        = "PanPosCenterY";      
    const CString kPanPosFrontLeftXFunc     = "PanPosFrontLeftX";   
    const CString kPanPosFrontLeftYFunc     = "PanPosFrontLeftY";   
    const CString kPanPosFrontRightXFunc    = "PanPosFrontRightX";  
    const CString kPanPosFrontRightYFunc    = "PanPosFrontRightY";  
    const CString kPanRotationFunc          = "PanRotation";        
    const CString kPanLawFunc               = "PanLaw";             
    const CString kPanMirrorModeFunc        = "PanMirrorMode";      
    const CString kPanLfeGainFunc           = "PanLfeGain";         
    const CString kGainReductionFunc        = "GainReduction";      
    const CString kSoloFunc                 = "Solo";               
    const CString kMuteFunc                 = "Mute";               
    const CString kVolumeFunc               = "Volume";             
};
 
//------------------------------------------------------------------------
namespace AttributesStyle
{
    const CString kInverseStyle         = "inverse";    
 
    const CString kLEDWrapLeftStyle     = "wrapLeft";   
    const CString kLEDWrapRightStyle    = "wrapRight";  
    const CString kLEDSpreadStyle       = "spread";     
    const CString kLEDBoostCutStyle     = "boostCut";   
    const CString kLEDSingleDotStyle    = "singleDot";  
 
    const CString kSwitchPushStyle      = "push";       
    const CString kSwitchPushIncLoopedStyle = "pushIncLooped";  
    const CString kSwitchPushDecLoopedStyle = "pushDecLooped";  
    const CString kSwitchPushIncStyle   = "pushInc";    
    const CString kSwitchPushDecStyle   = "pushDec";    
    const CString kSwitchLatchStyle     = "latch";      
};
 
//------------------------------------------------------------------------
namespace AttributesFlags
{
    const CString kHideableFlag         = "hideable";   
};
 
//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpop.h"
//------------------------------------------------------------------------