LMMS
Loading...
Searching...
No Matches
CMT_Descriptor Struct Reference

#include <cmt.h>

Inheritance diagram for CMT_Descriptor:
_LADSPA_Descriptor

Public Member Functions

 ~CMT_Descriptor ()
 CMT_Descriptor (unsigned long lUniqueID, const char *pcLabel, LADSPA_Properties iProperties, const char *pcName, const char *pcMaker, const char *pcCopyright, CMT_ImplementationData *poImplementationData, LADSPA_Instantiate_Function fInstantiate, LADSPA_Activate_Function fActivate, LADSPA_Run_Function fRun, LADSPA_Run_Adding_Function fRunAdding, LADSPA_Set_Run_Adding_Gain_Function fSetRunAddingGain, LADSPA_Deactivate_Function fDeactivate)
void addPort (LADSPA_PortDescriptor iPortDescriptor, const char *pcPortName, LADSPA_PortRangeHintDescriptor iHintDescriptor=0, LADSPA_Data fLowerBound=0, LADSPA_Data fUpperBound=0)

Private Member Functions

CMT_Descriptoroperator= (const CMT_Descriptor &)
 CMT_Descriptor (const CMT_Descriptor &)

Additional Inherited Members

Public Attributes inherited from _LADSPA_Descriptor
unsigned long UniqueID
const char * Label
LADSPA_Properties Properties
const char * Name
const char * Maker
const char * Copyright
unsigned long PortCount
const LADSPA_PortDescriptorPortDescriptors
const char *constPortNames
const LADSPA_PortRangeHintPortRangeHints
voidImplementationData
LADSPA_Handle(* instantiate )(const struct _LADSPA_Descriptor *Descriptor, unsigned long SampleRate)
void(* connect_port )(LADSPA_Handle Instance, unsigned long Port, LADSPA_Data *DataLocation)
void(* activate )(LADSPA_Handle Instance)
void(* run )(LADSPA_Handle Instance, unsigned long SampleCount)
void(* run_adding )(LADSPA_Handle Instance, unsigned long SampleCount)
void(* set_run_adding_gain )(LADSPA_Handle Instance, LADSPA_Data Gain)
void(* deactivate )(LADSPA_Handle Instance)
void(* cleanup )(LADSPA_Handle Instance)

Detailed Description

This structure describes a CMT LADSPA Plugin. It is a direct ancestor of the _LADSPA_Descriptor structure which allows direct casting. A rich constructor function is provided make it easier to write LADSPA_Descriptor objects. (Less code is required and the compiler will tell you when you have missed an entry.) An addPort() function makes configuration of ports more straightforward than using the _LADSPA_Descriptor structure directly.

Constructor & Destructor Documentation

◆ CMT_Descriptor() [1/2]

CMT_Descriptor::CMT_Descriptor ( const CMT_Descriptor & )
inlineprivate

◆ ~CMT_Descriptor()

CMT_Descriptor::~CMT_Descriptor ( )

◆ CMT_Descriptor() [2/2]

CMT_Descriptor::CMT_Descriptor ( unsigned long lUniqueID,
const char * pcLabel,
LADSPA_Properties iProperties,
const char * pcName,
const char * pcMaker,
const char * pcCopyright,
CMT_ImplementationData * poImplementationData,
LADSPA_Instantiate_Function fInstantiate,
LADSPA_Activate_Function fActivate,
LADSPA_Run_Function fRun,
LADSPA_Run_Adding_Function fRunAdding,
LADSPA_Set_Run_Adding_Gain_Function fSetRunAddingGain,
LADSPA_Deactivate_Function fDeactivate )

The basic constructor for a CMT_Descriptor object. If you do not know what the parameters mean, please see the fields in the LADSPA_Descriptor structure, described in ladspa.h. Note that some parameters may be NULL. Note also that a template is provided to generate instantiate functions automatically (see CMT_Instantiate<>() below). Implementation data must be NULL if not allocated.

Member Function Documentation

◆ addPort()

void CMT_Descriptor::addPort ( LADSPA_PortDescriptor iPortDescriptor,
const char * pcPortName,
LADSPA_PortRangeHintDescriptor iHintDescriptor = 0,
LADSPA_Data fLowerBound = 0,
LADSPA_Data fUpperBound = 0 )

This method adds a new port to the descriptor. If you do not know what the parameters mean, please see the fields in the LADSPA_Descriptor structure, described in ladspa.h.

◆ operator=()

CMT_Descriptor & CMT_Descriptor::operator= ( const CMT_Descriptor & )
inlineprivate

The documentation for this struct was generated from the following files: