VISR  0.11.7
Versatile Interactive Scene Renderer
visr::rcl::CAPGainCalculator Class Reference

#include <cap_gain_calculator.hpp>

Inheritance diagram for visr::rcl::CAPGainCalculator:
visr::AtomicComponent visr::Component

Public Types

using CoefficientType = visr::SampleType
 

Public Member Functions

 CAPGainCalculator (SignalFlowContext const &context, char const *name, CompositeComponent *parent, std::size_t numberOfObjects, panning::LoudspeakerArray const &arrayConfig)
 
 CAPGainCalculator (CAPGainCalculator const &)=delete
 
 ~CAPGainCalculator ()
 
void process () override
 
- Public Member Functions inherited from visr::AtomicComponent
 AtomicComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 AtomicComponent (AtomicComponent const &)=delete
 
 AtomicComponent (AtomicComponent &&)=delete
 
virtual ~AtomicComponent () override
 
- Public Member Functions inherited from visr::Component
 Component (SignalFlowContext const &context, char const *componentName, CompositeComponent *parent)
 
 Component (SignalFlowContext const &context, std::string const &componentName, CompositeComponent *parent)
 
 Component (Component const &)=delete
 
 Component (Component &&)=delete
 
Componentoperator= (Component const &)=delete
 
Componentoperator= (Component &&)=delete
 
virtual ~Component ()
 
std::string const & name () const
 
std::string fullName () const
 
void status (StatusMessage::Kind status, char const *message)
 
template<typename ... MessageArgs>
void status (StatusMessage::Kind status, MessageArgs ... args)
 
bool isComposite () const
 
AudioPortBaseaudioPort (char const *portName)
 
AudioPortBase const & audioPort (char const *portName) const
 
AudioPortBaseaudioPort (std::string const &portName)
 
AudioPortBase const & audioPort (std::string const &portName) const
 
ParameterPortBaseparameterPort (char const *portName)
 
ParameterPortBase const & parameterPort (char const *portName) const
 
ParameterPortBaseparameterPort (std::string const &portName)
 
ParameterPortBase const & parameterPort (std::string const &portName) const
 
SamplingFrequencyType samplingFrequency () const
 
std::size_t period () const
 
bool isTopLevel () const
 
impl::ComponentImplementationimplementation ()
 
impl::ComponentImplementation const & implementation () const
 

Additional Inherited Members

- Static Public Member Functions inherited from visr::Component
static const std::string & nameSeparator ()
 
- Protected Member Functions inherited from visr::Component
 Component (impl::ComponentImplementation *impl)
 

Detailed Description

Audio component for calculating the gains for a variety of panning algorithms from a set of audio object descriptions.

Member Typedef Documentation

◆ CoefficientType

Type of the gain coefficients. We use the same type as

Constructor & Destructor Documentation

◆ CAPGainCalculator() [1/2]

visr::rcl::CAPGainCalculator::CAPGainCalculator ( SignalFlowContext const &  context,
char const *  name,
CompositeComponent parent,
std::size_t  numberOfObjects,
panning::LoudspeakerArray const &  arrayConfig 
)
explicit

Constructor.

Parameters
contextSignalFlowContext object holding parameters as sampling freqequency and period (block size).
nameThe name of the component. Must be unique within the containing AudioSignalFlow.
parentA containing composite component, or nullptr in case of a top-level component.
numberOfObjectsThe number of VBAP objects to be processed.
arrayConfigThe array configuration object.

◆ CAPGainCalculator() [2/2]

visr::rcl::CAPGainCalculator::CAPGainCalculator ( CAPGainCalculator const &  )
delete

Disabled (deleted) copy constructor

◆ ~CAPGainCalculator()

visr::rcl::CAPGainCalculator::~CAPGainCalculator ( )

Destructor.

Member Function Documentation

◆ process()

void visr::rcl::CAPGainCalculator::process ( )
overridevirtual

Virtual function implementing the processing of the component.

Implements visr::AtomicComponent.


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