Version

menu_open
Wwise SDK 2023.1.4
AkSpeakerVolumes.h File Reference
#include <AK/SoundEngine/Common/AkTypes.h>
#include <AK/SoundEngine/Platforms/Generic/AkSpeakerVolumes.h>
#include <AK/Tools/Common/AkAssert.h>
#include <AK/Tools/Common/AkPlatformFuncs.h>

Go to the source code of this file.

Namespaces

namespace  AK
 Audiokinetic namespace.
 
 AK::SpeakerVolumes
 Multi-channel volume definitions and services.
 
 AK::SpeakerVolumes::Vector
 Volume vector services.
 
 AK::SpeakerVolumes::Matrix
 Volume matrix (multi-in/multi-out channel configurations) services.
 

Typedefs

typedef AkReal32AK::SpeakerVolumes::VectorPtr
 Volume vector. Access each element with the standard bracket [] operator. More...
 
typedef AkReal32AK::SpeakerVolumes::MatrixPtr
 Volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel(). More...
 
typedef const AkReal32AK::SpeakerVolumes::ConstVectorPtr
 Constant volume vector. Access each element with the standard bracket [] operator. More...
 
typedef const AkReal32AK::SpeakerVolumes::ConstMatrixPtr
 Constant volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel(). More...
 

Functions

AkForceInline void AK::SpeakerVolumes::Vector::Copy (VectorPtr in_pVolumesDst, ConstVectorPtr in_pVolumesSrc, AkUInt32 in_uNumChannels)
 Copy volumes. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Copy (VectorPtr in_pVolumesDst, ConstVectorPtr in_pVolumesSrc, AkUInt32 in_uNumChannels, AkReal32 in_fGain)
 Copy volumes with gain. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Zero (VectorPtr in_pVolumes, AkUInt32 in_uNumChannels)
 Clear volumes. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Add (VectorPtr in_pVolumesDst, ConstVectorPtr in_pVolumesSrc, AkUInt32 in_uNumChannels)
 Accumulate two volume vectors. More...
 
AkForceInline AkReal32 AK::SpeakerVolumes::Vector::L1Norm (ConstVectorPtr io_pVolumes, AkUInt32 in_uNumChannels)
 Compute the sum of all components of a volume vector. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Mul (VectorPtr in_pVolumesDst, const AkReal32 in_fVol, AkUInt32 in_uNumChannels)
 Multiply volume vector with a scalar. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Mul (VectorPtr in_pVolumesDst, ConstVectorPtr in_pVolumesSrc, AkUInt32 in_uNumChannels)
 Multiply two volume vectors. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Max (AkReal32 *in_pVolumesDst, const AkReal32 *in_pVolumesSrc, AkUInt32 in_uNumChannels)
 Get max for all elements of two volume vectors, independently. More...
 
AkForceInline void AK::SpeakerVolumes::Vector::Min (AkReal32 *in_pVolumesDst, const AkReal32 *in_pVolumesSrc, AkUInt32 in_uNumChannels)
 Get min for all elements of two volume vectors, independently. More...
 
AkForceInline AkUInt32 AK::SpeakerVolumes::Matrix::GetRequiredSize (AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Compute size (in bytes) required for given channel configurations. More...
 
AkForceInline AkUInt32 AK::SpeakerVolumes::Matrix::GetNumElements (AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Compute size (in number of elements) required for given channel configurations. More...
 
AkForceInline VectorPtr AK::SpeakerVolumes::Matrix::GetChannel (MatrixPtr in_pVolumeMx, AkUInt32 in_uIdxChannelIn, AkUInt32 in_uNumChannelsOut)
 Get pointer to volume distribution for input channel in_uIdxChannelIn. More...
 
AkForceInline ConstVectorPtr AK::SpeakerVolumes::Matrix::GetChannel (ConstMatrixPtr in_pVolumeMx, AkUInt32 in_uIdxChannelIn, AkUInt32 in_uNumChannelsOut)
 Get pointer to volume distribution for input channel in_uIdxChannelIn. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::Copy (MatrixPtr in_pVolumesDst, ConstMatrixPtr in_pVolumesSrc, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Copy matrix. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::Copy (MatrixPtr in_pVolumesDst, ConstMatrixPtr in_pVolumesSrc, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut, AkReal32 in_fGain)
 Copy matrix with gain. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::Zero (MatrixPtr in_pVolumes, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Clear matrix. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::Mul (MatrixPtr in_pVolumesDst, const AkReal32 in_fVol, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Multiply a matrix with a scalar. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::Add (MatrixPtr in_pVolumesDst, ConstMatrixPtr in_pVolumesSrc, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Add all elements of two volume matrices, independently. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::MAdd (MatrixPtr in_pVolumesDst, ConstMatrixPtr in_pVolumesSrc, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut, AkReal32 in_fGain)
 Pointwise Multiply-Add of all elements of two volume matrices. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::AbsMax (MatrixPtr in_pVolumesDst, ConstMatrixPtr in_pVolumesSrc, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Get absolute max for all elements of two volume matrices, independently. More...
 
AkForceInline void AK::SpeakerVolumes::Matrix::Max (MatrixPtr in_pVolumesDst, ConstMatrixPtr in_pVolumesSrc, AkUInt32 in_uNumChannelsIn, AkUInt32 in_uNumChannelsOut)
 Get max for all elements of two volume matrices, independently. More...
 

Detailed Description

Multi-channel volume definitions and services. Always associated with an AkChannelConfig. In the case of standard configurations, the volume items ordering match the bit ordering in the channel mask, except for the LFE which is skipped and placed at the end of the volume array. Refer to Advanced Mix Customization Using the Speaker Matrix Callback for an example of how to manipulate speaker volume vectors/matrices.

Definition in file AkSpeakerVolumes.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise