Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2018.1.11
Classes | Namespaces | Macros | Enumerations | Functions
AkSpeakerConfig.h File Reference

Go to the source code of this file.

Classes

struct   AkChannelConfig
 

Namespaces

namespace   AK
  Audiokinetic namespace.
 

Macros

#define  AK_SPEAKER_FRONT_LEFT   0x1
  Standard speakers (channel mask): More...
 
#define  AK_SPEAKER_FRONT_RIGHT   0x2
  Front right speaker bit mask. More...
 
#define  AK_SPEAKER_FRONT_CENTER   0x4
  Front center speaker bit mask. More...
 
#define  AK_SPEAKER_LOW_FREQUENCY   0x8
  Low-frequency speaker bit mask. More...
 
#define  AK_SPEAKER_BACK_LEFT   0x10
  Rear left speaker bit mask. More...
 
#define  AK_SPEAKER_BACK_RIGHT   0x20
  Rear right speaker bit mask. More...
 
#define  AK_SPEAKER_BACK_CENTER   0x100
  Rear center speaker ("surround speaker") bit mask. More...
 
#define  AK_SPEAKER_SIDE_LEFT   0x200
  Side left speaker bit mask. More...
 
#define  AK_SPEAKER_SIDE_RIGHT   0x400
  Side right speaker bit mask. More...
 
#define  AK_SPEAKER_TOP   0x800
  "Height" speakers. More...
 
#define  AK_SPEAKER_HEIGHT_FRONT_LEFT   0x1000
  Front left speaker bit mask. More...
 
#define  AK_SPEAKER_HEIGHT_FRONT_CENTER   0x2000
  Front center speaker bit mask. More...
 
#define  AK_SPEAKER_HEIGHT_FRONT_RIGHT   0x4000
  Front right speaker bit mask. More...
 
#define  AK_SPEAKER_HEIGHT_BACK_LEFT   0x8000
  Rear left speaker bit mask. More...
 
#define  AK_SPEAKER_HEIGHT_BACK_CENTER   0x10000
  Rear center speaker bit mask. More...
 
#define  AK_SPEAKER_HEIGHT_BACK_RIGHT   0x20000
  Rear right speaker bit mask. More...
 
#define  AK_SPEAKER_SETUP_MONO   AK_SPEAKER_FRONT_CENTER
  1.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_0POINT1   AK_SPEAKER_LOW_FREQUENCY
  0.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_1POINT1   (AK_SPEAKER_FRONT_CENTER | AK_SPEAKER_LOW_FREQUENCY)
  1.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_STEREO   (AK_SPEAKER_FRONT_LEFT | AK_SPEAKER_FRONT_RIGHT)
  2.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_2POINT1   (AK_SPEAKER_SETUP_STEREO | AK_SPEAKER_LOW_FREQUENCY)
  2.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_3STEREO   (AK_SPEAKER_SETUP_STEREO | AK_SPEAKER_FRONT_CENTER)
  3.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_3POINT1   (AK_SPEAKER_SETUP_3STEREO | AK_SPEAKER_LOW_FREQUENCY)
  3.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_4   (AK_SPEAKER_SETUP_STEREO | AK_SPEAKER_SIDE_LEFT | AK_SPEAKER_SIDE_RIGHT)
  4.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_4POINT1   (AK_SPEAKER_SETUP_4 | AK_SPEAKER_LOW_FREQUENCY)
  4.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_5   (AK_SPEAKER_SETUP_4 | AK_SPEAKER_FRONT_CENTER)
  5.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_5POINT1   (AK_SPEAKER_SETUP_5 | AK_SPEAKER_LOW_FREQUENCY)
  5.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_6   (AK_SPEAKER_SETUP_4 | AK_SPEAKER_BACK_LEFT | AK_SPEAKER_BACK_RIGHT)
  6.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_6POINT1   (AK_SPEAKER_SETUP_6 | AK_SPEAKER_LOW_FREQUENCY)
  6.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_7   (AK_SPEAKER_SETUP_6 | AK_SPEAKER_FRONT_CENTER)
  7.0 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_7POINT1   (AK_SPEAKER_SETUP_7 | AK_SPEAKER_LOW_FREQUENCY)
  7.1 setup channel mask More...
 
#define  AK_SPEAKER_SETUP_SURROUND   (AK_SPEAKER_SETUP_STEREO | AK_SPEAKER_BACK_CENTER)
  Legacy surround setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DPL2   (AK_SPEAKER_SETUP_4)
  Legacy DPL2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_HEIGHT_4   (AK_SPEAKER_HEIGHT_FRONT_LEFT | AK_SPEAKER_HEIGHT_FRONT_RIGHT | AK_SPEAKER_HEIGHT_BACK_LEFT | AK_SPEAKER_HEIGHT_BACK_RIGHT)
  4 speaker height layer. More...
 
#define  AK_SPEAKER_SETUP_HEIGHT_5   (AK_SPEAKER_SETUP_HEIGHT_4 | AK_SPEAKER_HEIGHT_FRONT_CENTER)
  5 speaker height layer. More...
 
#define  AK_SPEAKER_SETUP_HEIGHT_ALL   (AK_SPEAKER_SETUP_HEIGHT_5 | AK_SPEAKER_HEIGHT_BACK_CENTER)
  All height speaker layer. More...
 
#define  AK_SPEAKER_SETUP_AURO_222   (AK_SPEAKER_SETUP_4 | AK_SPEAKER_HEIGHT_FRONT_LEFT | AK_SPEAKER_HEIGHT_FRONT_RIGHT)
  Auro-222 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_8   (AK_SPEAKER_SETUP_AURO_222 | AK_SPEAKER_HEIGHT_BACK_LEFT | AK_SPEAKER_HEIGHT_BACK_RIGHT)
  Auro-8 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_9   (AK_SPEAKER_SETUP_AURO_8 | AK_SPEAKER_FRONT_CENTER)
  Auro-9.0 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_9POINT1   (AK_SPEAKER_SETUP_AURO_9 | AK_SPEAKER_LOW_FREQUENCY)
  Auro-9.1 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_10   (AK_SPEAKER_SETUP_AURO_9 | AK_SPEAKER_TOP)
  Auro-10.0 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_10POINT1   (AK_SPEAKER_SETUP_AURO_10 | AK_SPEAKER_LOW_FREQUENCY)
  Auro-10.1 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_11   (AK_SPEAKER_SETUP_AURO_10 | AK_SPEAKER_HEIGHT_FRONT_CENTER)
  Auro-11.0 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_11POINT1   (AK_SPEAKER_SETUP_AURO_11 | AK_SPEAKER_LOW_FREQUENCY)
  Auro-11.1 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_11_740   (AK_SPEAKER_SETUP_7 | AK_SPEAKER_SETUP_HEIGHT_4)
  Auro-11.0 (7+4) setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_11POINT1_740   (AK_SPEAKER_SETUP_AURO_11_740 | AK_SPEAKER_LOW_FREQUENCY)
  Auro-11.1 (7+4) setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_13_751   (AK_SPEAKER_SETUP_7 | AK_SPEAKER_SETUP_HEIGHT_5 | AK_SPEAKER_TOP)
  Auro-13.0 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_AURO_13POINT1_751   (AK_SPEAKER_SETUP_AURO_13_751 | AK_SPEAKER_LOW_FREQUENCY)
  Auro-13.1 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_5_0_2   (AK_SPEAKER_SETUP_5 | AK_SPEAKER_HEIGHT_FRONT_LEFT | AK_SPEAKER_HEIGHT_FRONT_RIGHT )
  Dolby 5.0.2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_5_1_2   (AK_SPEAKER_SETUP_DOLBY_5_0_2 | AK_SPEAKER_LOW_FREQUENCY )
  Dolby 5.1.2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_6_0_2   (AK_SPEAKER_SETUP_6 | AK_SPEAKER_HEIGHT_FRONT_LEFT | AK_SPEAKER_HEIGHT_FRONT_RIGHT )
  Dolby 6.0.2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_6_1_2   (AK_SPEAKER_SETUP_DOLBY_6_0_2 | AK_SPEAKER_LOW_FREQUENCY )
  Dolby 6.1.2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_6_0_4   (AK_SPEAKER_SETUP_DOLBY_6_0_2 | AK_SPEAKER_HEIGHT_BACK_LEFT | AK_SPEAKER_HEIGHT_BACK_RIGHT )
  Dolby 6.0.4 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_6_1_4   (AK_SPEAKER_SETUP_DOLBY_6_0_4 | AK_SPEAKER_LOW_FREQUENCY )
  Dolby 6.1.4 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_7_0_2   (AK_SPEAKER_SETUP_7 | AK_SPEAKER_HEIGHT_FRONT_LEFT | AK_SPEAKER_HEIGHT_FRONT_RIGHT )
  Dolby 7.0.2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_7_1_2   (AK_SPEAKER_SETUP_DOLBY_7_0_2 | AK_SPEAKER_LOW_FREQUENCY )
  Dolby 7.1.2 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_7_0_4   (AK_SPEAKER_SETUP_DOLBY_7_0_2 | AK_SPEAKER_HEIGHT_BACK_LEFT | AK_SPEAKER_HEIGHT_BACK_RIGHT )
  Dolby 7.0.4 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_DOLBY_7_1_4   (AK_SPEAKER_SETUP_DOLBY_7_0_4 | AK_SPEAKER_LOW_FREQUENCY )
  Dolby 7.1.4 setup channel mask. More...
 
#define  AK_SPEAKER_SETUP_ALL_SPEAKERS   (AK_SPEAKER_SETUP_7POINT1 | AK_SPEAKER_BACK_CENTER | AK_SPEAKER_SETUP_HEIGHT_ALL | AK_SPEAKER_TOP)
  All speakers. More...
 
#define  AK_IDX_SETUP_FRONT_LEFT   (0)
  Index of front-left channel in all configurations. More...
 
#define  AK_IDX_SETUP_FRONT_RIGHT   (1)
  Index of front-right channel in all configurations. More...
 
#define  AK_IDX_SETUP_CENTER   (2)
  Index of front-center channel in all configurations. More...
 
#define  AK_IDX_SETUP_NOCENTER_BACK_LEFT   (2)
  Index of back-left channel in configurations with no front-center channel. More...
 
#define  AK_IDX_SETUP_NOCENTER_BACK_RIGHT   (3)
  Index of back-right channel in configurations with no front-center channel. More...
 
#define  AK_IDX_SETUP_NOCENTER_SIDE_LEFT   (4)
  Index of side-left channel in configurations with no front-center channel. More...
 
#define  AK_IDX_SETUP_NOCENTER_SIDE_RIGHT   (5)
  Index of side-right channel in configurations with no front-center channel. More...
 
#define  AK_IDX_SETUP_WITHCENTER_BACK_LEFT   (3)
  Index of back-left channel in configurations with a front-center channel. More...
 
#define  AK_IDX_SETUP_WITHCENTER_BACK_RIGHT   (4)
  Index of back-right channel in configurations with a front-center channel. More...
 
#define  AK_IDX_SETUP_WITHCENTER_SIDE_LEFT   (5)
  Index of side-left channel in configurations with a front-center channel. More...
 
#define  AK_IDX_SETUP_WITHCENTER_SIDE_RIGHT   (6)
  Index of side-right channel in configurations with a front-center channel. More...
 
#define  AK_IDX_SETUP_0_LFE   (0)
  Index of low-frequency channel in 0.1 setup (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_1_CENTER   (0)
  Index of center channel in 1.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_1_LFE   (1)
  Index of low-frequency channel in 1.1 setup (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_2_LEFT   (0)
  Index of left channel in 2.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_2_RIGHT   (1)
  Index of right channel in 2.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_2_LFE   (2)
  Index of low-frequency channel in 2.1 setup (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_3_LEFT   (0)
  Index of left channel in 3.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_3_RIGHT   (1)
  Index of right channel in 3.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_3_CENTER   (2)
  Index of center channel in 3.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_3_LFE   (3)
  Index of low-frequency channel in 3.1 setup (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_4_FRONTLEFT   (0)
  Index of front left channel in 4.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_4_FRONTRIGHT   (1)
  Index of front right channel in 4.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_4_REARLEFT   (2)
  Index of rear left channel in 4.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_4_REARRIGHT   (3)
  Index of rear right channel in 4.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_4_LFE   (4)
  Index of low-frequency channel in 4.1 setup (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_5_FRONTLEFT   (0)
  Index of front left channel in 5.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_5_FRONTRIGHT   (1)
  Index of front right channel in 5.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_5_CENTER   (2)
  Index of center channel in 5.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_5_REARLEFT   (3)
  Index of rear left channel in 5.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_5_REARRIGHT   (4)
  Index of rear right channel in 5.x setups (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_IDX_SETUP_5_LFE   (5)
  Index of low-frequency channel in 5.1 setup (use with AkAudioBuffer::GetChannel()) More...
 
#define  AK_SPEAKER_SETUP_0_1   ( AK_SPEAKER_LOW_FREQUENCY )
 
#define  AK_SPEAKER_SETUP_1_0_CENTER   ( AK_SPEAKER_FRONT_CENTER )
 
#define  AK_SPEAKER_SETUP_1_1_CENTER   ( AK_SPEAKER_FRONT_CENTER | AK_SPEAKER_LOW_FREQUENCY )
 
#define  AK_SPEAKER_SETUP_2_0   ( AK_SPEAKER_FRONT_LEFT | AK_SPEAKER_FRONT_RIGHT )
 
#define  AK_SPEAKER_SETUP_2_1   ( AK_SPEAKER_FRONT_LEFT | AK_SPEAKER_FRONT_RIGHT | AK_SPEAKER_LOW_FREQUENCY )
 
#define  AK_SPEAKER_SETUP_3_0   ( AK_SPEAKER_FRONT_LEFT | AK_SPEAKER_FRONT_RIGHT | AK_SPEAKER_FRONT_CENTER )
 
#define  AK_SPEAKER_SETUP_3_1   ( AK_SPEAKER_SETUP_3_0 | AK_SPEAKER_LOW_FREQUENCY )
 
#define  AK_SPEAKER_SETUP_FRONT   ( AK_SPEAKER_SETUP_3_0 )
 
#define  AK_SPEAKER_SETUP_4_0   ( AK_SPEAKER_SETUP_4 )
 
#define  AK_SPEAKER_SETUP_4_1   ( AK_SPEAKER_SETUP_4POINT1 )
 
#define  AK_SPEAKER_SETUP_5_0   ( AK_SPEAKER_SETUP_5 )
 
#define  AK_SPEAKER_SETUP_5_1   ( AK_SPEAKER_SETUP_5POINT1 )
 
#define  AK_SPEAKER_SETUP_6_0   ( AK_SPEAKER_SETUP_6 )
 
#define  AK_SPEAKER_SETUP_6_1   ( AK_SPEAKER_SETUP_6POINT1 )
 
#define  AK_SPEAKER_SETUP_7_0   ( AK_SPEAKER_SETUP_7 )
 
#define  AK_SPEAKER_SETUP_7_1   ( AK_SPEAKER_SETUP_7POINT1 )
 
#define  AK_SPEAKER_SETUP_DEFAULT_PLANE   (AK_SPEAKER_SETUP_5POINT1)
  All speakers on the plane, supported on this platform. More...
 
#define  AK_SUPPORTED_STANDARD_CHANNEL_MASK   (AK_SPEAKER_SETUP_DEFAULT_PLANE)
  Platform supports 5.1. More...
 
#define  AK_VOICE_MAX_NUM_CHANNELS   (6)
  Legacy: Platform supports up to 5.1 configuration. More...
 
#define  AK_STANDARD_MAX_NUM_CHANNELS   (AK_VOICE_MAX_NUM_CHANNELS)
  Legacy: Platform supports 5.1. More...
 
#define  AK_NUM_SAMPLED_SPHERE_POINTS   (32)
 

Enumerations

enum   AK::AkChannelOrdering { AK::ChannelOrdering_Standard, AK::ChannelOrdering_RunTime }
  Channel ordering type. More...
 
enum   AkChannelConfigType { AK_ChannelConfigType_Anonymous = 0x0, AK_ChannelConfigType_Standard = 0x1, AK_ChannelConfigType_Ambisonic = 0x2 }
  Channel configuration type. More...
 

Functions

void  AK_SPEAKER_SETUP_FIX_LEFT_TO_CENTER (AkUInt32 &io_uChannelMask)
 
void  AK_SPEAKER_SETUP_FIX_REAR_TO_SIDE (AkUInt32 &io_uChannelMask)
 
void  AK_SPEAKER_SETUP_CONVERT_TO_SUPPORTED (AkUInt32 &io_uChannelMask)
 
static AkUInt8  AK::ChannelMaskToNumChannels (AkChannelMask in_uChannelMask)
  Returns the number of channels of a given channel configuration. More...
 
static AkChannelMask  AK::ChannelMaskFromNumChannels (unsigned int in_uNumChannels)
 
static AkUInt8  AK::ChannelBitToIndex (AkChannelMask in_uChannelBit, AkChannelMask in_uChannelMask)
 
AkForceInline bool  AK::HasLFE (AkChannelMask in_uChannelMask)
 
AkForceInline bool  AK::HasCenter (AkChannelMask in_uChannelMask)
 
AkForceInline AkUInt32  AK::GetNumberOfAnglesForConfig (AkChannelMask in_uChannelMask)
 
AkForceInline bool  AK::HasSurroundChannels (AkChannelMask in_uChannelMask)
 
AkForceInline bool  AK::HasStrictlyOnePairOfSurroundChannels (AkChannelMask in_uChannelMask)
 
AkForceInline bool  AK::HasSideAndRearChannels (AkChannelMask in_uChannelMask)
 
AkForceInline bool  AK::HasHeightChannels (AkChannelMask in_uChannelMask)
  Returns true if standard configuration represented by channel mask has at least one "height" channel (above the plane). More...
 
AkForceInline AkChannelMask  AK::BackToSideChannels (AkChannelMask in_uChannelMask)
 
static unsigned int  AK::StdChannelIndexToDisplayIndex (AkChannelOrdering in_eOrdering, unsigned int in_uChannelMask, unsigned int in_uChannelIdx)