HOA Library  beta 3.0
High Order Ambisonics Library
Public Member Functions | List of all members
Decoder< Hoa3d, T > Class Template Referenceabstract

The decoder class decodes a sound field in the harmonics domain through the planewaves domain. More...

#include <Hoa_Decoder.hpp>

Inheritance diagram for Decoder< Hoa3d, T >:
ProcessorHarmonics< Hoa3d, T > ProcessorPlanewaves< Hoa3d, T > Processor< D, T > Processor< D, T > DecoderBinaural< Hoa3d, T >

Public Member Functions

 Decoder (const size_t order, const size_t numberOfPlanewaves) hoa_noexcept
 The decoder constructor. More...
 
virtual ~Decoder ()
 The destructor. More...
 
virtual Mode getMode () const hoa_noexcept
 This method retrieves the mode of the decoder. More...
 
virtual void process (const T *inputs, T *outputs) hoa_noexcept=0
 This method performs the decoding. More...
 
virtual void prepare (const size_t vectorsize=64)=0
 This method computes the decoding matrix. More...
 
- Public Member Functions inherited from ProcessorHarmonics< Hoa3d, T >
 ProcessorHarmonics (const size_t order) hoa_noexcept
 The harmonics constructor. More...
 
virtual ~ProcessorHarmonics () hoa_noexcept
 The harmonics destructor.
 
size_t getDecompositionOrder () const hoa_noexcept
 Returns the order of decomposition.
 
size_t getNumberOfHarmonics () const hoa_noexcept
 Returns the number of harmonics.
 
size_t getHarmonicDegree (const size_t index) const hoa_noexcept
 Returns the degree of an harmonic. More...
 
long getHarmonicOrder (const size_t index) const hoa_noexcept
 Returns the azimuthal order of an harmonic. More...
 
size_t getHarmonicIndex (const size_t degree, const long order) const hoa_noexcept
 Returns the index of an harmonic given the degree and the azimuthal order. More...
 
std::string getHarmonicName (const size_t index) const hoa_noexcept
 Returns the name of an harmonic. More...
 
getHarmonicNormalization (const size_t index) const hoa_noexcept
 Returns the normalization of an harmonic. More...
 
getHarmonicSemiNormalization (const size_t index) const hoa_noexcept
 Returns the semi-normalization of an harmonic. More...
 
- Public Member Functions inherited from Processor< D, T >
virtual ~Processor () hoa_noexcept
 The destructor.
 
- Public Member Functions inherited from ProcessorPlanewaves< Hoa3d, T >
 ProcessorPlanewaves (const size_t nplws) hoa_noexcept
 The planewaves constructor. More...
 
virtual ~ProcessorPlanewaves () hoa_noexcept
 The planewaves destructor.
 
size_t getNumberOfPlanewaves () const hoa_noexcept
 Returns the number of planewaves.
 
void setPlanewavesRotation (const T x_axe, const T y_axe, const T z_axe) hoa_noexcept
 Sets the global rotation of the planewaves. More...
 
getPlanewavesRotationX () const hoa_noexcept
 Returns the angle of rotation around the x axis in radian of the planewaves.
 
getPlanewavesRotationY () const hoa_noexcept
 Returns the angle of rotation around the y axis in radian of the planewaves.
 
getPlanewavesRotationZ () const hoa_noexcept
 Returns the angle of rotation around the z axis in radian of the planewaves.
 
size_t getPlanewaveIndex (const size_t index) hoa_noexcept
 Returns the index of a planewave.
 
void setPlanewaveAzimuth (const size_t index, const T azimuth) hoa_noexcept
 Sets the azimuth of a planewave in radian. More...
 
void setPlanewaveElevation (const size_t index, const T elevation) hoa_noexcept
 Sets the azimuth of a planewave in radian. More...
 
getPlanewaveAzimuth (const size_t index, const bool rotation=true) const hoa_noexcept
 Returns the azimuth of a planewave. More...
 
getPlanewaveElevation (const size_t index, const bool rotation=true) const hoa_noexcept
 Returns the elevation of a planewave. More...
 
getPlanewaveAbscissa (const size_t index, const bool rotation=true) const hoa_noexcept
 Returns the abscissa of a planewave. More...
 
getPlanewaveOrdinate (const size_t index, const bool rotation=true) const hoa_noexcept
 Returns the ordinate of a planewave. More...
 
getPlanewaveHeight (const size_t index, const bool rotation=true) const hoa_noexcept
 Returns the height of a planewave. More...
 
std::string getPlanewaveName (const size_t index) const hoa_noexcept
 Retruns the name for a planewave. More...
 

Detailed Description

template<typename T>
class hoa::Decoder< Hoa3d, T >

The decoder class decodes a sound field in the harmonics domain through the planewaves domain.

The decoder should be used to decode a set the harmonics domain to a set of planewaves for loudspeakers. There are three types of decoder. Regular for a perfect circle or sphere of loudspeakers. Irregular when the loudspeakers are not equally spaced on the circle or the sphere. Binaural for headphone restitution.

Definition at line 638 of file Hoa_Decoder.hpp.

Constructor & Destructor Documentation

Decoder ( const size_t  order,
const size_t  numberOfPlanewaves 
)
inline

The decoder constructor.

The decoder constructor allocates and initialize the base classes.

Parameters
orderThe order
numberOfPlanewavesThe number of channels.

Definition at line 653 of file Hoa_Decoder.hpp.

virtual ~Decoder ( )
inlinevirtual

The destructor.

The destructor free the memory.

Definition at line 663 of file Hoa_Decoder.hpp.

Member Function Documentation

virtual Mode getMode ( ) const
inlinevirtual

This method retrieves the mode of the decoder.

This method retrieves the mode of the decoder.

Returns
The mode of the decoder.

Reimplemented in DecoderBinaural< Hoa3d, T >.

Definition at line 669 of file Hoa_Decoder.hpp.

virtual void process ( const T *  inputs,
T *  outputs 
)
pure virtual

This method performs the decoding.

You should use this method for in-place or not-in-place processing and sample by sample. The inputs array contains the spherical harmonics samples and the minimum size must be the number of harmonics and the outputs array contains the channels samples and the minimum size must be the number of channels.

Parameters
inputsThe input array that contains the samples of the harmonics.
outputsThe output array that contains samples destinated to the channels.

Reimplemented from Processor< D, T >.

Implemented in DecoderBinaural< Hoa3d, T >.

virtual void prepare ( const size_t  vectorsize = 64)
pure virtual

This method computes the decoding matrix.

You should use this method after changing the position of the loudspeakers.

Parameters
vectorsizeThe vector size for binaural decoding.

Implemented in DecoderBinaural< Hoa3d, T >.