LV2FeaturesList Class Reference

#include <LV2FeaturesList.h>

Inheritance diagram for LV2FeaturesList:

Collaboration diagram for LV2FeaturesList:

Public Member Functions
	LV2FeaturesList (const LilvPlugin &plug)
	~LV2FeaturesList () override
bool	InitializeFeatures ()
FeaturePointers	GetFeaturePointers () const override
bool	SuppliesWorkerInterface () const
void	AddFeature (const char *uri, const void *data)
LV2_URID_Map *	URIDMapFeature () const
LV2_URID	URID_Map (const char *uri) const
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)

Static Public Member Functions
static ComponentInterfaceSymbol	GetPluginSymbol (const LilvPlugin &plug)
static bool	SuppliesWorkerInterface (const LilvPlugin &plug)

Public Attributes
const bool	mOk
Public Attributes inherited from LV2FeaturesListBase
const LilvPlugin &	mPlug
bool	mNoResize { false }

Protected Member Functions
const char *	URID_Unmap (LV2_URID urid)
int	LogVPrintf (LV2_URID type, const char *fmt, va_list ap)

Static Protected Member Functions
static uint32_t	uri_to_id (LV2_URI_Map_Callback_Data callback_data, const char *map, const char *uri)
static LV2_URID	urid_map (LV2_URID_Map_Handle handle, const char *uri)
static const char *	urid_unmap (LV2_URID_Unmap_Handle handle, LV2_URID urid)
static int	log_printf (LV2_Log_Handle handle, LV2_URID type, const char *fmt,...)
static int	log_vprintf (LV2_Log_Handle handle, LV2_URID type, const char *fmt, va_list ap)

Protected Attributes
const LV2_URI_Map_Feature	mUriMapFeature
const LV2_URID_Map	mURIDMapFeature { this, LV2FeaturesList::urid_map }
const LV2_URID_Unmap	mURIDUnmapFeature { this, LV2FeaturesList::urid_unmap }
const LV2_Log_Log	mLogFeature
LV2Symbols::URIDMap	mURIDMap
	Per-effect URID map allocates an ID for each URI on first lookup. More...
std::vector< LV2_Feature >	mFeatures
const bool	mSuppliesWorkerInterface

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...

Detailed Description

Definition at line 79 of file LV2FeaturesList.h.

Constructor & Destructor Documentation

LV2FeaturesList()

LV2FeaturesList::LV2FeaturesList ( const LilvPlugin &  plug )

explicit

Definition at line 71 of file LV2FeaturesList.cpp.

   : LV2FeaturesListBase{ plug }
   , mSuppliesWorkerInterface{ SuppliesWorkerInterface(plug) }
   , mOk{ InitializeFeatures() }
{
}

~LV2FeaturesList()

LV2FeaturesList::~LV2FeaturesList ( )

overridedefault

Member Function Documentation

AddFeature()

void LV2FeaturesList::AddFeature	(	const char *	uri,
		const void *	data
	)

Definition at line 111 of file LV2FeaturesList.cpp.

{
   // This casting to const is innocent
   // We pass our "virtual function tables" or array of options, which the
   // library presumably will not change
   mFeatures.emplace_back(LV2_Feature{ uri, const_cast<void*>(data) });
}

References mFeatures.

Referenced by InitializeFeatures().

Here is the caller graph for this function:

GetFeaturePointers()

auto LV2FeaturesList::GetFeaturePointers ( ) const

overridevirtual

Implements LV2FeaturesListBase.

Definition at line 119 of file LV2FeaturesList.cpp.

{
   FeaturePointers result;
   for (auto &feature : mFeatures)
      result.push_back(&feature);
   result.push_back(nullptr);
   return result;
}

References mFeatures.

GetPluginSymbol()

ComponentInterfaceSymbol LV2FeaturesList::GetPluginSymbol ( const LilvPlugin &  plug )

static

Definition at line 62 of file LV2FeaturesList.cpp.

{
   return LilvStringMove(lilv_plugin_get_name(&plug));
}

References LilvStringMove().

Referenced by LV2EffectBase::GetSymbol(), and LogVPrintf().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeFeatures()

bool LV2FeaturesList::InitializeFeatures

(

)

Returns

success

Definition at line 78 of file LV2FeaturesList.cpp.

{
   // Construct null-terminated array of "features" describing our capabilities
   // to lv2, and validate
   AddFeature(LV2_UI__noUserResize, nullptr);
   AddFeature(LV2_UI__fixedSize, nullptr);
   AddFeature(LV2_UI__idleInterface, nullptr);
   AddFeature(LV2_UI__makeResident, nullptr);
   AddFeature(LV2_BUF_SIZE__boundedBlockLength, nullptr);
   AddFeature(LV2_BUF_SIZE__fixedBlockLength, nullptr);
   AddFeature(LV2_URI_MAP_URI, &mUriMapFeature);
   AddFeature(LV2_URID__map, &mURIDMapFeature);
   AddFeature(LV2_URID__unmap, &mURIDUnmapFeature);
   AddFeature(LV2_LOG__log, &mLogFeature);
   // Some plugins specify this as a feature
   AddFeature(LV2_EXTERNAL_UI__Widget, nullptr);
   return true;
}

References AddFeature(), LV2_EXTERNAL_UI__Widget, LV2_UI__makeResident, mLogFeature, mURIDMapFeature, mURIDUnmapFeature, and mUriMapFeature.

Here is the call graph for this function:

log_printf()

int LV2FeaturesList::log_printf ( LV2_Log_Handle  handle, LV2_URID  type, const char *  fmt,   ...  )

staticprotected

Definition at line 220 of file LV2FeaturesList.cpp.

{
   va_list ap;
   int len;
 
   va_start(ap, fmt);
   len = static_cast<LV2FeaturesList *>(handle)->LogVPrintf(type, fmt, ap);
   va_end(ap);
 
   return len;
}

References LogVPrintf().

Here is the call graph for this function:

log_vprintf()

int LV2FeaturesList::log_vprintf ( LV2_Log_Handle  handle, LV2_URID  type, const char *  fmt, va_list  ap  )

staticprotected

Definition at line 234 of file LV2FeaturesList.cpp.

{
   return static_cast<LV2FeaturesList *>(handle)->LogVPrintf(type, fmt, ap);
}

References LogVPrintf().

Here is the call graph for this function:

LogVPrintf()

int LV2FeaturesList::LogVPrintf ( LV2_URID  type, const char *  fmt, va_list  ap  )

protected

Definition at line 240 of file LV2FeaturesList.cpp.

{
   using namespace LV2Symbols;
   long level = wxLOG_Error;
   if (type == urid_Error)
      level = wxLOG_Error;
   else if (type == urid_Note)
      level = wxLOG_Info;
   else if (type == urid_Trace)
      level = wxLOG_Trace;
   else if (type == urid_Warning)
      level = wxLOG_Warning;
   else
      level = wxLOG_Message;
   int len = wxCRT_VsnprintfA(nullptr, 0, fmt, ap);
   auto msg = std::make_unique<char[]>(len + 1);
   wxCRT_VsnprintfA(msg.get(), len, fmt, ap);
   wxString text(msg.get());
   wxLogGeneric(level,
      wxT("%s: %s"), GetPluginSymbol(mPlug).Msgid().Translation(), text);
   return len;
}

References GetPluginSymbol(), LV2FeaturesListBase::mPlug, and wxT().

Referenced by log_printf(), and log_vprintf().

Here is the call graph for this function:

Here is the caller graph for this function:

SuppliesWorkerInterface() [1/2]

bool LV2FeaturesList::SuppliesWorkerInterface ( ) const

inline

Returns

whether our host should reciprocally supply the LV2_Worker_Schedule interface to the plug-in

Definition at line 97 of file LV2FeaturesList.h.

{ return mSuppliesWorkerInterface; }

SuppliesWorkerInterface() [2/2]

bool LV2FeaturesList::SuppliesWorkerInterface ( const LilvPlugin &  plug )

static

Returns

whether our host should reciprocally supply the LV2_Worker_Schedule interface to the plug-in

Definition at line 97 of file LV2FeaturesList.cpp.

{
   bool result = false;
   if (LilvNodesPtr extdata{ lilv_plugin_get_extension_data(&plug) }) {
      LILV_FOREACH(nodes, i, extdata.get()) {
         const auto node = lilv_nodes_get(extdata.get(), i);
         const auto uri = lilv_node_as_string(node);
         if (strcmp(uri, LV2_WORKER__interface) == 0)
            result = true;
      }
   }
   return result;
}

uri_to_id()

uint32_t LV2FeaturesList::uri_to_id ( LV2_URI_Map_Callback_Data  callback_data, const char *  map, const char *  uri  )

staticprotected

Definition at line 172 of file LV2FeaturesList.cpp.

{
   return static_cast<LV2FeaturesList *>(callback_data)->URID_Map(uri);
}

References URID_Map().

Here is the call graph for this function:

URID_Map()

LV2_URID LV2FeaturesList::URID_Map

(

const char *

uri

)

const

Definition at line 184 of file LV2FeaturesList.cpp.

{
   using namespace LV2Symbols;
   // Map global URIs to lower indices
   auto urid = Lookup_URI(gURIDMap, uri, false);
   if (urid > 0)
      return urid;
   // Map local URIs to higher indices
   urid = Lookup_URI(mURIDMap, uri);
   if (urid > 0)
      return urid + gURIDMap.size();
   return 0;
}

References LV2Symbols::gURIDMap, LV2Symbols::Lookup_URI(), and mURIDMap.

Referenced by uri_to_id(), and urid_map().

Here is the call graph for this function:

Here is the caller graph for this function:

urid_map()

LV2_URID LV2FeaturesList::urid_map ( LV2_URID_Map_Handle  handle, const char *  uri  )

staticprotected

Definition at line 179 of file LV2FeaturesList.cpp.

{
   return static_cast<LV2FeaturesList *>(handle)->URID_Map(uri);
}

References URID_Map().

Here is the call graph for this function:

URID_Unmap()

const char * LV2FeaturesList::URID_Unmap ( LV2_URID  urid )

protected

Definition at line 204 of file LV2FeaturesList.cpp.

{
   using namespace LV2Symbols;
   if (urid > 0) {
      // Unmap lower indices to global URIs
      if (urid <= static_cast<LV2_URID>(gURIDMap.size()))
         return gURIDMap[urid - 1].get();
      // Unmap higher indices to local URIs
      urid -= gURIDMap.size();
      if (urid <= static_cast<LV2_URID>(mURIDMap.size()))
         return mURIDMap[urid - 1].get();
   }
   return nullptr;
}

References LV2Symbols::gURIDMap, and mURIDMap.

Referenced by urid_unmap().

Here is the caller graph for this function:

urid_unmap()

const char * LV2FeaturesList::urid_unmap ( LV2_URID_Unmap_Handle  handle, LV2_URID  urid  )

staticprotected

Definition at line 199 of file LV2FeaturesList.cpp.

{
   return static_cast<LV2FeaturesList *>(handle)->URID_Unmap(urid);
}

References URID_Unmap().

Here is the call graph for this function:

URIDMapFeature()

LV2_URID_Map * LV2FeaturesList::URIDMapFeature ( ) const

inline

Definition at line 103 of file LV2FeaturesList.h.

   { return const_cast<LV2_URID_Map*>(&mURIDMapFeature); }

Referenced by LV2EffectBase::LoadFactoryPreset(), and LV2Instance::LV2Instance().

Here is the caller graph for this function:

Member Data Documentation

mFeatures

std::vector<LV2_Feature> LV2FeaturesList::mFeatures

protected

Definition at line 137 of file LV2FeaturesList.h.

Referenced by AddFeature(), and GetFeaturePointers().

mLogFeature

const LV2_Log_Log LV2FeaturesList::mLogFeature

protected

Initial value:

{
      this, LV2FeaturesList::log_printf, LV2FeaturesList::log_vprintf }

Definition at line 126 of file LV2FeaturesList.h.

Referenced by InitializeFeatures().

mOk

const bool LV2FeaturesList::mOk

Definition at line 142 of file LV2FeaturesList.h.

Referenced by LV2EffectBase::InitializePlugin().

mSuppliesWorkerInterface

const bool LV2FeaturesList::mSuppliesWorkerInterface

protected

Definition at line 139 of file LV2FeaturesList.h.

mURIDMap

LV2Symbols::URIDMap LV2FeaturesList::mURIDMap

mutableprotected

Per-effect URID map allocates an ID for each URI on first lookup.

This is some state shared among all instances of an effect, but logically const as a mapping, assuming all reverse lookups of any urid (integer) are done only after at least one lookup of the related uri (string)

Definition at line 135 of file LV2FeaturesList.h.

Referenced by URID_Map(), and URID_Unmap().

mURIDMapFeature

const LV2_URID_Map LV2FeaturesList::mURIDMapFeature { this, LV2FeaturesList::urid_map }

protected

Definition at line 124 of file LV2FeaturesList.h.

Referenced by InitializeFeatures().

mURIDUnmapFeature

const LV2_URID_Unmap LV2FeaturesList::mURIDUnmapFeature { this, LV2FeaturesList::urid_unmap }

protected

Definition at line 125 of file LV2FeaturesList.h.

Referenced by InitializeFeatures().

mUriMapFeature

const LV2_URI_Map_Feature LV2FeaturesList::mUriMapFeature

protected

Initial value:

{
      this, LV2FeaturesList::uri_to_id }

Definition at line 122 of file LV2FeaturesList.h.

Referenced by InitializeFeatures().

---

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

• LV2FeaturesList.h
• LV2FeaturesList.cpp