#include <LV2InstanceFeaturesList.h>

Inheritance diagram for LV2InstanceFeaturesList:

Collaboration diagram for LV2InstanceFeaturesList:

Classes
struct	ValidatePlugin
	Perform extra initialization-time checks. More...

Public Member Functions
	LV2InstanceFeaturesList (const LV2FeaturesList &baseFeatures)

const LV2FeaturesList &	Base () const

bool	InitializeOptions ()

const LV2_Options_Option *	NominalBlockLengthOption () const

size_t	AddOption (LV2_URID, uint32_t size, LV2_URID, const void *value)

bool	ValidateOptions (const LilvNode *subject)

bool	CheckOptions (const LilvNode *subject, bool required)

Public Member Functions inherited from ExtendedLV2FeaturesList
	ExtendedLV2FeaturesList (WithBase_t, const LV2FeaturesListBase &baseFeatures)

virtual	~ExtendedLV2FeaturesList ()

FeaturePointers	GetFeaturePointers () const override

void	AddFeature (const char uri, const void data)

Public Member Functions inherited from LV2FeaturesListBase
	LV2FeaturesListBase (const LilvPlugin &plug)

virtual	~LV2FeaturesListBase ()

	LV2FeaturesListBase (const LV2FeaturesListBase &)=delete

LV2FeaturesListBase &	operator= (const LV2FeaturesListBase &)=delete

virtual FeaturePointers	GetFeaturePointers () const =0

bool	ValidateFeatures (const LilvNode *subject)

bool	CheckFeatures (const LilvNode *subject, bool required)

Public Attributes
std::vector< LV2_Options_Option >	mOptions

size_t	mBlockSizeOption {}

size_t	mBlockSize { LV2Preferences::DEFAULT_BLOCKSIZE }

int	mSeqSize { DEFAULT_SEQSIZE }

bool	mSupportsNominalBlockLength { false }

size_t	mMinBlockSize { 1 }

size_t	mMaxBlockSize { mBlockSize }

float	mSampleRate { 44100.0f }

const bool	mOk

Public Attributes inherited from ExtendedLV2FeaturesList
const LV2FeaturesListBase &	mBaseFeatures

Public Attributes inherited from LV2FeaturesListBase
const LilvPlugin &	mPlug

bool	mNoResize { false }

Additional Inherited Members
Public Types inherited from LV2FeaturesListBase
using	FeaturePointers = std::vector< const LV2_Feature * >
	Get vector of pointers to features, whose `.data()` can be passed to lv2. More...

Protected Attributes inherited from ExtendedLV2FeaturesList
std::vector< LV2_Feature >	mFeatures

Detailed Description

Definition at line 25 of file LV2InstanceFeaturesList.h.

Constructor & Destructor Documentation

◆ LV2InstanceFeaturesList()

LV2InstanceFeaturesList::LV2InstanceFeaturesList ( const LV2FeaturesList & baseFeatures )

explicit

Definition at line 17 of file LV2InstanceFeaturesList.cpp.

   : ExtendedLV2FeaturesList{ WithBase, baseFeatures }
   , mOk{ InitializeOptions() }
{
   AddFeature(LV2_OPTIONS__options, mOptions.data());
}

References ExtendedLV2FeaturesList::AddFeature(), and mOptions.

Here is the call graph for this function:

Member Function Documentation

◆ AddOption()

size_t LV2InstanceFeaturesList::AddOption	(	LV2_URID	key,
		uint32_t	size,
		LV2_URID	type,
		const void *	value
	)

Definition at line 68 of file LV2InstanceFeaturesList.cpp.

{
   int ndx = mOptions.size();
   if (key != 0)
      mOptions.emplace_back(LV2_Options_Option{
         LV2_OPTIONS_INSTANCE, 0, key, size, type, value });
   else
      mOptions.emplace_back(LV2_Options_Option{});
   return ndx;
}

References key, mOptions, and size.

Referenced by InitializeOptions().

Here is the caller graph for this function:

◆ Base()

const LV2FeaturesList & LV2InstanceFeaturesList::Base ( ) const

inline

Definition at line 35 of file LV2InstanceFeaturesList.h.

                                       {
      return static_cast<const LV2FeaturesList&>(mBaseFeatures);
   }

References ExtendedLV2FeaturesList::mBaseFeatures.

Referenced by LV2Instance::LV2Instance(), and LV2WrapperFeaturesList::LV2WrapperFeaturesList().

Here is the caller graph for this function:

◆ CheckOptions()

bool LV2InstanceFeaturesList::CheckOptions	(	const LilvNode *	subject,
		bool	required
	)

Parameters

subject	URI of a plugin
required	whether to check required or optional options of subject

Returns: true only if !required or else all required options are supported

Definition at line 94 of file LV2InstanceFeaturesList.cpp.

{
   using namespace LV2Symbols;
   bool supported = true;
   const auto predicate =
      required ? node_RequiredOption : node_SupportedOption;
   if (LilvNodesPtr nodes{
      lilv_world_find_nodes(gWorld, subject, predicate, nullptr) }
   ){
      LILV_FOREACH(nodes, i, nodes.get()) {
         const auto node = lilv_nodes_get(nodes.get(), i);
         const auto uri = lilv_node_as_string(node);
         // The signature of our constructor justifies this static_cast
         const auto urid = static_cast<const LV2FeaturesList&>(mBaseFeatures)
            .URID_Map(uri);
         if (urid == urid_NominalBlockLength)
            mSupportsNominalBlockLength = true;
         // else if (urid == urid_SampleRate)
            // mSupportsSampleRate = true; // supports changing sample rate
         else if (required) {
            const auto end = mOptions.end();
            supported = (end != std::find_if(mOptions.begin(), end,
               [&](const auto &option){ return option.key == urid; }));
            if (!supported) {
               wxLogError(wxT("%s requires unsupported option %s"),
                  lilv_node_as_string(lilv_plugin_get_uri(&mPlug)), uri);
               break;
            }
         }
      }
   }
   return supported;
}

References details::end(), LV2Symbols::gWorld, ExtendedLV2FeaturesList::mBaseFeatures, mOptions, LV2FeaturesListBase::mPlug, mSupportsNominalBlockLength, and wxT().

Referenced by ValidateOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializeOptions()

bool LV2InstanceFeaturesList::InitializeOptions ( )

Returns: success

Definition at line 25 of file LV2InstanceFeaturesList.cpp.

{
   using namespace LV2Symbols;
 
   // Construct the null-terminated array describing options, and validate it
   AddOption(urid_SequenceSize, sizeof(mSeqSize), urid_Int, &mSeqSize);
   AddOption(urid_MinBlockLength,
      sizeof(mMinBlockSize), urid_Int, &mMinBlockSize);
   AddOption(urid_MaxBlockLength,
      sizeof(mMaxBlockSize), urid_Int, &mMaxBlockSize);
   // Two options are reset later
   mBlockSizeOption = AddOption(urid_NominalBlockLength,
      sizeof(mBlockSize), urid_Int, &mBlockSize);
   AddOption(urid_SampleRate,
      sizeof(mSampleRate), urid_Float, &mSampleRate);
   AddOption(0, 0, 0, nullptr);
   if (!ValidateOptions(lilv_plugin_get_uri(&mPlug)))
      return false;
 
   // Adjust the values in the block size features according to the plugin
   if (LilvNodePtr minLength{ lilv_world_get(gWorld,
         lilv_plugin_get_uri(&mPlug), node_MinBlockLength, nullptr) }
      ; lilv_node_is_int(minLength.get())
   ){
      if (auto value = lilv_node_as_int(minLength.get())
         ; value >= 0
      )
         mMinBlockSize = std::max<size_t>(mMinBlockSize, value);
   }
   if (LilvNodePtr maxLength{ lilv_world_get(gWorld,
         lilv_plugin_get_uri(&mPlug), node_MaxBlockLength, nullptr) }
      ; lilv_node_is_int(maxLength.get())
   ){
      if (auto value = lilv_node_as_int(maxLength.get())
         ; value >= 1
      )
         mMaxBlockSize = std::min<size_t>(mMaxBlockSize, value);
   }
   mMaxBlockSize = std::max(mMaxBlockSize, mMinBlockSize);
 
   return true;
}

References AddOption(), LV2Symbols::gWorld, mBlockSize, mBlockSizeOption, mMaxBlockSize, mMinBlockSize, LV2FeaturesListBase::mPlug, mSampleRate, mSeqSize, and ValidateOptions().

Here is the call graph for this function:

◆ NominalBlockLengthOption()

const LV2_Options_Option * LV2InstanceFeaturesList::NominalBlockLengthOption ( ) const

Returns: may be null

Definition at line 81 of file LV2InstanceFeaturesList.cpp.

{
   if (mSupportsNominalBlockLength)
      return &mOptions[mBlockSizeOption];
   else
      return nullptr;
}

References mBlockSizeOption, mOptions, and mSupportsNominalBlockLength.

Referenced by LV2Wrapper::SendBlockSize().

Here is the caller graph for this function:

◆ ValidateOptions()

bool LV2InstanceFeaturesList::ValidateOptions ( const LilvNode * subject )

Parameters

subject URI of a plugin

Returns: whether all required options of subject are supported

Definition at line 89 of file LV2InstanceFeaturesList.cpp.

{
   return CheckOptions(subject, true) && CheckOptions(subject, false);
}

References CheckOptions().

Referenced by InitializeOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mBlockSize

size_t LV2InstanceFeaturesList::mBlockSize { LV2Preferences::DEFAULT_BLOCKSIZE }

Definition at line 63 of file LV2InstanceFeaturesList.h.

Referenced by LV2Instance::GetBlockSize(), InitializeOptions(), and LV2Instance::SetBlockSize().

◆ mBlockSizeOption

size_t LV2InstanceFeaturesList::mBlockSizeOption {}

Definition at line 61 of file LV2InstanceFeaturesList.h.

Referenced by InitializeOptions(), and NominalBlockLengthOption().

◆ mMaxBlockSize

size_t LV2InstanceFeaturesList::mMaxBlockSize { mBlockSize }

Definition at line 69 of file LV2InstanceFeaturesList.h.

Referenced by InitializeOptions().

◆ mMinBlockSize

size_t LV2InstanceFeaturesList::mMinBlockSize { 1 }

Definition at line 68 of file LV2InstanceFeaturesList.h.

Referenced by InitializeOptions(), and LV2Instance::SetBlockSize().

◆ mOk

const bool LV2InstanceFeaturesList::mOk

Definition at line 72 of file LV2InstanceFeaturesList.h.

◆ mOptions

std::vector<LV2_Options_Option> LV2InstanceFeaturesList::mOptions

Definition at line 60 of file LV2InstanceFeaturesList.h.

Referenced by AddOption(), CheckOptions(), LV2InstanceFeaturesList(), and NominalBlockLengthOption().

◆ mSampleRate

float LV2InstanceFeaturesList::mSampleRate { 44100.0f }

Definition at line 70 of file LV2InstanceFeaturesList.h.

Referenced by InitializeOptions(), LV2WrapperFeaturesList::LV2WrapperFeaturesList(), and LV2Instance::MakeMaster().

◆ mSeqSize

int LV2InstanceFeaturesList::mSeqSize { DEFAULT_SEQSIZE }

Definition at line 64 of file LV2InstanceFeaturesList.h.

Referenced by InitializeOptions().

◆ mSupportsNominalBlockLength

bool LV2InstanceFeaturesList::mSupportsNominalBlockLength { false }

Definition at line 66 of file LV2InstanceFeaturesList.h.

Referenced by CheckOptions(), and NominalBlockLengthOption().

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

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LV2InstanceFeaturesList()

Member Function Documentation

◆ AddOption()

◆ Base()

◆ CheckOptions()

◆ InitializeOptions()

◆ NominalBlockLengthOption()

◆ ValidateOptions()

Member Data Documentation

◆ mBlockSize

◆ mBlockSizeOption

◆ mMaxBlockSize

◆ mMinBlockSize

◆ mOk

◆ mOptions

◆ mSampleRate

◆ mSeqSize

◆ mSupportsNominalBlockLength