Represents a set of audio channel types. More...
#include <juce_AudioChannelSet.h>
Public Member Functions | |
AudioChannelSet ()=default | |
Creates an empty channel set. | |
int | getAmbisonicOrder () const |
Returns the order of the ambisonic layout represented by this AudioChannelSet. | |
void | addChannel (ChannelType newChannelType) |
Adds a channel to the set. | |
void | removeChannel (ChannelType newChannelType) |
Removes a channel from the set. | |
int | size () const noexcept |
Returns the number of channels in the set. | |
bool | isDisabled () const noexcept |
Returns true if there are no channels in the set. | |
Array< ChannelType > | getChannelTypes () const |
Returns an array of all the types in this channel set. | |
ChannelType | getTypeOfChannel (int channelIndex) const noexcept |
Returns the type of one of the channels in the set, by index. | |
int | getChannelIndexForType (ChannelType type) const noexcept |
Returns the index for a particular channel-type. | |
String | getSpeakerArrangementAsString () const |
Returns a string containing a whitespace-separated list of speaker types corresponding to each channel. | |
String | getDescription () const |
Returns the description of the current layout. | |
bool | isDiscreteLayout () const noexcept |
Returns if this is a channel layout made-up of discrete channels. | |
void | intersect (const AudioChannelSet &other) |
Intersect two channel layouts. | |
int32 | getWaveChannelMask () const noexcept |
Returns a WAVEFORMATEXTENSIBLE channelMask representation (typically used in .wav files) of the receiver. | |
bool | operator== (const AudioChannelSet &) const noexcept |
bool | operator!= (const AudioChannelSet &) const noexcept |
bool | operator< (const AudioChannelSet &) const noexcept |
Static Public Member Functions | |
static AudioChannelSet JUCE_CALLTYPE | disabled () |
Creates a zero-channel set which can be used to indicate that a bus is disabled. | |
static AudioChannelSet JUCE_CALLTYPE | mono () |
Creates a one-channel mono set (centre). | |
static AudioChannelSet JUCE_CALLTYPE | stereo () |
Creates a set containing a stereo set (left, right). | |
static AudioChannelSet JUCE_CALLTYPE | createLCR () |
Creates a set containing an LCR set (left, right, centre). | |
static AudioChannelSet JUCE_CALLTYPE | createLRS () |
Creates a set containing an LRS set (left, right, surround). | |
static AudioChannelSet JUCE_CALLTYPE | createLCRS () |
Creates a set containing an LCRS set (left, right, centre, surround). | |
static AudioChannelSet JUCE_CALLTYPE | create5point0 () |
Creates a set for a 5.0 surround setup (left, right, centre, leftSurround, rightSurround). | |
static AudioChannelSet JUCE_CALLTYPE | create5point1 () |
Creates a set for a 5.1 surround setup (left, right, centre, leftSurround, rightSurround, LFE). | |
static AudioChannelSet JUCE_CALLTYPE | create6point0 () |
Creates a set for a 6.0 Cine surround setup (left, right, centre, leftSurround, rightSurround, centreSurround). | |
static AudioChannelSet JUCE_CALLTYPE | create6point1 () |
Creates a set for a 6.1 Cine surround setup (left, right, centre, leftSurround, rightSurround, centreSurround, LFE). | |
static AudioChannelSet JUCE_CALLTYPE | create6point0Music () |
Creates a set for a 6.0 Music surround setup (left, right, leftSurround, rightSurround, leftSurroundSide, rightSurroundSide). | |
static AudioChannelSet JUCE_CALLTYPE | create6point1Music () |
Creates a set for a 6.0 Music surround setup (left, right, leftSurround, rightSurround, leftSurroundSide, rightSurroundSide, LFE). | |
static AudioChannelSet JUCE_CALLTYPE | create7point0 () |
Creates a set for a DTS 7.0 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear). | |
static AudioChannelSet JUCE_CALLTYPE | create7point0SDDS () |
Creates a set for a SDDS 7.0 surround setup (left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre). | |
static AudioChannelSet JUCE_CALLTYPE | create7point1 () |
Creates a set for a DTS 7.1 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE). | |
static AudioChannelSet JUCE_CALLTYPE | create7point1SDDS () |
Creates a set for a 7.1 surround setup (left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre, LFE). | |
static AudioChannelSet JUCE_CALLTYPE | create5point0point2 () |
Creates a set for a 5.0.2 surround setup (left, right, centre, leftSurround, rightSurround, topSideLeft, topSideRight). | |
static AudioChannelSet JUCE_CALLTYPE | create5point1point2 () |
Creates a set for a 5.1.2 surround setup (left, right, centre, LFE, leftSurround, rightSurround, topSideLeft, topSideRight). | |
static AudioChannelSet JUCE_CALLTYPE | create5point0point4 () |
Creates a set for a 5.0.4 surround setup (left, right, centre, leftSurround, rightSurround, topFrontLeft, topFrontRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create5point1point4 () |
Creates a set for a 5.1.4 surround setup (left, right, centre, LFE, leftSurround, rightSurround, topFrontLeft, topFrontRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create7point0point2 () |
Creates a set for Dolby Atmos 7.0.2 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, topSideLeft, topSideRight). | |
static AudioChannelSet JUCE_CALLTYPE | create7point1point2 () |
Creates a set for Dolby Atmos 7.1.2 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE, topSideLeft, topSideRight). | |
static AudioChannelSet JUCE_CALLTYPE | create7point0point4 () |
Creates a set for Dolby Atmos 7.0.4 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, topFrontLeft, topFrontRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create7point1point4 () |
Creates a set for Dolby Atmos 7.1.4 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE, topFrontLeft, topFrontRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create7point0point6 () |
Creates a set for 7.0.6 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create7point1point6 () |
Creates a set for Dolby Atmos 7.1.6 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create9point0point4 () |
Creates a set for a 9.0.4 Atmos surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create9point1point4 () |
Creates a set for a 9.1.4 Atmos surround setup (left, right, centre, LFE, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create9point0point6 () |
Creates a set for a 9.0.6 Atmos surround setup (left, right, centre, LFE, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create9point1point6 () |
Creates a set for a 9.1.6 Atmos surround setup (left, right, centre, LFE, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight). | |
static AudioChannelSet JUCE_CALLTYPE | create9point0point4ITU () |
Creates a set for a 9.0.4 ITU surround setup: left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre, leftSurroundSide, rightSurroundSide, topFrontLeft, topFrontRight, topRearLeft, topRearRight. | |
static AudioChannelSet JUCE_CALLTYPE | create9point1point4ITU () |
Creates a set for a 9.1.4 ITU surround setup. | |
static AudioChannelSet JUCE_CALLTYPE | create9point0point6ITU () |
Creates a set for a 9.0.6 ITU surround setup. | |
static AudioChannelSet JUCE_CALLTYPE | create9point1point6ITU () |
Creates a set for a 9.1.6 ITU surround setup. | |
static AudioChannelSet JUCE_CALLTYPE | quadraphonic () |
Creates a set for quadraphonic surround setup (left, right, leftSurround, rightSurround) | |
static AudioChannelSet JUCE_CALLTYPE | pentagonal () |
Creates a set for pentagonal surround setup (left, right, centre, leftSurroundRear, rightSurroundRear). | |
static AudioChannelSet JUCE_CALLTYPE | hexagonal () |
Creates a set for hexagonal surround setup (left, right, leftSurroundRear, rightSurroundRear, centre, surroundCentre). | |
static AudioChannelSet JUCE_CALLTYPE | octagonal () |
Creates a set for octagonal surround setup (left, right, leftSurround, rightSurround, centre, centreSurround, wideLeft, wideRight). | |
static AudioChannelSet JUCE_CALLTYPE | ambisonic (int order=1) |
Creates a set for ACN, SN3D normalised ambisonic surround setups with a given order. | |
static AudioChannelSet JUCE_CALLTYPE | discreteChannels (int numChannels) |
Creates a set of untyped discrete channels. | |
static AudioChannelSet JUCE_CALLTYPE | canonicalChannelSet (int numChannels) |
Create a canonical channel set for a given number of channels. | |
static AudioChannelSet JUCE_CALLTYPE | namedChannelSet (int numChannels) |
Create a channel set for a given number of channels which is non-discrete. | |
static Array< AudioChannelSet > JUCE_CALLTYPE | channelSetsWithNumberOfChannels (int numChannels) |
Return an array of channel sets which have a given number of channels. | |
static String JUCE_CALLTYPE | getChannelTypeName (ChannelType) |
Returns the name of a given channel type. | |
static String JUCE_CALLTYPE | getAbbreviatedChannelTypeName (ChannelType) |
Returns the abbreviated name of a channel type. | |
static ChannelType JUCE_CALLTYPE | getChannelTypeFromAbbreviation (const String &abbreviation) |
Returns the channel type from an abbreviated name. | |
static AudioChannelSet | fromAbbreviatedString (const String &set) |
Returns an AudioChannelSet from a string returned by getSpeakerArrangementAsString. | |
static AudioChannelSet JUCE_CALLTYPE | channelSetWithChannels (const Array< ChannelType > &) |
Creates a channel set for a list of channel types. | |
static AudioChannelSet JUCE_CALLTYPE | fromWaveChannelMask (int32 dwChannelMask) |
Create an AudioChannelSet from a WAVEFORMATEXTENSIBLE channelMask (typically used in .wav files). | |
static int | getAmbisonicOrderForNumChannels (int numChannels, int maxOrderToCheck=7) |
Returns the ambisonic order that includes exactly numChannels, or -1 if no supported ambisonic order contains exactly numChannels. | |
Represents a set of audio channel types.
For example, you might have a set of left + right channels, which is a stereo channel set. It is a collection of values from the AudioChannelSet::ChannelType enum, where each type may only occur once within the set.
The documentation below lists which AudioChannelSet corresponds to which native layouts used by AAX, VST2/VST3 and CoreAudio/AU. The layout tags in CoreAudio are particularly confusing. For example, the layout which is labeled as "7.1 SDDS" in Logic Pro, corresponds to CoreAudio/AU's kAudioChannelLayoutTag_DTS_7_0 tag, whereas AAX's DTS 7.1 Layout corresponds to CoreAudio/AU's kAudioChannelLayoutTag_MPEG_7_1_A format, etc. Please do not use the CoreAudio tag as an indication to the actual layout of the speakers.
Represents different audio channel types.
|
default |
Creates an empty channel set.
You can call addChannel to add channels to the set.
|
static |
Creates a zero-channel set which can be used to indicate that a bus is disabled.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a one-channel mono set (centre).
Is equivalent to: kMonoAAX (VST), AAX_eStemFormat_Mono (AAX), kAudioChannelLayoutTag_Mono (CoreAudio)
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set containing a stereo set (left, right).
Is equivalent to: kStereo (VST), AAX_eStemFormat_Stereo (AAX), kAudioChannelLayoutTag_Stereo (CoreAudio)
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set containing an LCR set (left, right, centre).
Is equivalent to: k30Cine (VST), AAX_eStemFormat_LCR (AAX), kAudioChannelLayoutTag_MPEG_3_0_A (CoreAudio)
This format is referred to as "LRC" in Cubase. This format is referred to as "LCR" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set containing an LRS set (left, right, surround).
Is equivalent to: k30Music (VST), n/a (AAX), kAudioChannelLayoutTag_ITU_2_1 (CoreAudio)
This format is referred to as "LRS" in Cubase.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set containing an LCRS set (left, right, centre, surround).
Is equivalent to: k40Cine (VST), AAX_eStemFormat_LCRS (AAX), kAudioChannelLayoutTag_MPEG_4_0_A (CoreAudio)
This format is referred to as "LCRS (Pro Logic)" in Logic Pro. This format is referred to as "LRCS" in Cubase. This format is referred to as "LCRS" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 5.0 surround setup (left, right, centre, leftSurround, rightSurround).
Is equivalent to: k50 (VST), AAX_eStemFormat_5_0 (AAX), kAudioChannelLayoutTag_MPEG_5_0_A (CoreAudio)
This format is referred to as "5.0" in Cubase. This format is referred to as "5.0" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 5.1 surround setup (left, right, centre, leftSurround, rightSurround, LFE).
Is equivalent to: k51 (VST), AAX_eStemFormat_5_1 (AAX), kAudioChannelLayoutTag_MPEG_5_1_A (CoreAudio)
This format is referred to as "5.1 (ITU 775)" in Logic Pro. This format is referred to as "5.1" in Cubase. This format is referred to as "5.1" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 6.0 Cine surround setup (left, right, centre, leftSurround, rightSurround, centreSurround).
Is equivalent to: k60Cine (VST), AAX_eStemFormat_6_0 (AAX), kAudioChannelLayoutTag_AudioUnit_6_0 (CoreAudio)
Logic Pro incorrectly uses this for the surround format labeled "6.1 (ES/EX)". This format is referred to as "6.0 Cine" in Cubase. This format is referred to as "6.0" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 6.1 Cine surround setup (left, right, centre, leftSurround, rightSurround, centreSurround, LFE).
Is equivalent to: k61Cine (VST), AAX_eStemFormat_6_1 (AAX), kAudioChannelLayoutTag_MPEG_6_1_A (CoreAudio)
This format is referred to as "6.1" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 6.0 Music surround setup (left, right, leftSurround, rightSurround, leftSurroundSide, rightSurroundSide).
Is equivalent to: k60Music (VST), n/a (AAX), kAudioChannelLayoutTag_DTS_6_0_A (CoreAudio)
This format is referred to as "6.0 Music" in Cubase.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 6.0 Music surround setup (left, right, leftSurround, rightSurround, leftSurroundSide, rightSurroundSide, LFE).
Is equivalent to: k61Music (VST), n/a (AAX), kAudioChannelLayoutTag_DTS_6_1_A (CoreAudio)
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a DTS 7.0 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear).
Is equivalent to: k70Music (VST), AAX_eStemFormat_7_0_DTS (AAX), kAudioChannelLayoutTag_AudioUnit_7_0 (CoreAudio)
This format is referred to as "7.0" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a SDDS 7.0 surround setup (left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre).
Is equivalent to: k70Cine (VST), AAX_eStemFormat_7_0_SDDS (AAX), kAudioChannelLayoutTag_AudioUnit_7_0_Front (CoreAudio)
This format is referred to as "7.0 SDDS" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a DTS 7.1 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE).
Is equivalent to: k71CineSideFill (VST), AAX_eStemFormat_7_1_DTS (AAX), kAudioChannelLayoutTag_MPEG_7_1_C/kAudioChannelLayoutTag_ITU_3_4_1 (CoreAudio)
This format is referred to as "7.1 (3/4.1)" in Logic Pro. This format is referred to as "7.1" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 7.1 surround setup (left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre, LFE).
Is equivalent to: k71Cine (VST), AAX_eStemFormat_7_1_SDDS (AAX), kAudioChannelLayoutTag_MPEG_7_1_A (CoreAudio)
This format is referred to as "7.1 (SDDS)" in Logic Pro. This format is referred to as "7.1 SDDS" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for a 5.0.2 surround setup (left, right, centre, leftSurround, rightSurround, topSideLeft, topSideRight).
Is equivalent to: AAX_eStemFormat_5_0_2 (AAX).
|
static |
Creates a set for a 5.1.2 surround setup (left, right, centre, LFE, leftSurround, rightSurround, topSideLeft, topSideRight).
Is equivalent to: kAudioChannelLayoutTag_Atmos_5_1_2 (CoreAudio).
|
static |
Creates a set for a 5.0.4 surround setup (left, right, centre, leftSurround, rightSurround, topFrontLeft, topFrontRight, topRearLeft, topRearRight).
Is equivalent to: AAX_eStemFormat_5_0_4 (AAX).
|
static |
Creates a set for a 5.1.4 surround setup (left, right, centre, LFE, leftSurround, rightSurround, topFrontLeft, topFrontRight, topRearLeft, topRearRight).
Is equivalent to: kAudioChannelLayoutTag_Atmos_5_1_4 (CoreAudio).
|
static |
Creates a set for Dolby Atmos 7.0.2 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, topSideLeft, topSideRight).
Is equivalent to: n/a (VST), AAX_eStemFormat_7_0_2 (AAX), n/a (CoreAudio)
|
static |
Creates a set for Dolby Atmos 7.1.2 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE, topSideLeft, topSideRight).
Is equivalent to: k71_2 (VST), AAX_eStemFormat_7_1_2 (AAX), kAudioChannelLayoutTag_Atmos_7_1_2 (CoreAudio)
|
static |
Creates a set for Dolby Atmos 7.0.4 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, topFrontLeft, topFrontRight, topRearLeft, topRearRight).
Is equivalent to: n/a (VST), n/a (AAX), n/a (CoreAudio)
|
static |
Creates a set for Dolby Atmos 7.1.4 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE, topFrontLeft, topFrontRight, topRearLeft, topRearRight).
Is equivalent to: k71_4 (VST), n/a (AAX), kAudioChannelLayoutTag_Atmos_7_1_4 (CoreAudio)
|
static |
Creates a set for 7.0.6 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight).
Is equivalent to: AAX_eStemFormat_7_0_6 (AAX).
|
static |
Creates a set for Dolby Atmos 7.1.6 surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, LFE, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight).
Is equivalent to: k71_6 (VST), n/a (AAX), n/a (CoreAudio)
|
static |
Creates a set for a 9.0.4 Atmos surround setup (left, right, centre, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topRearLeft, topRearRight).
Is equivalent to: k90_4_W (VST3), AAX_eStemFormat_9_0_4 (AAX).
|
static |
Creates a set for a 9.1.4 Atmos surround setup (left, right, centre, LFE, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topRearLeft, topRearRight).
Is equivalent to: k91_4_W (VST3), AAX_eStemFormat_9_1_4 (AAX).
|
static |
Creates a set for a 9.0.6 Atmos surround setup (left, right, centre, LFE, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight).
Is equivalent to: k90_6_W (VST3), AAX_eStemFormat_9_0_6 (AAX).
|
static |
Creates a set for a 9.1.6 Atmos surround setup (left, right, centre, LFE, leftSurroundSide, rightSurroundSide, leftSurroundRear, rightSurroundRear, wideLeft, wideRight, topFrontLeft, topFrontRight, topSideLeft, topSideRight, topRearLeft, topRearRight).
Older versions of the VST3 SDK only supported ITU versions of the 9.0.4, 9.1.4, 9.0.6, and 9.1.6 layouts, which have the front-channel ordering "L Lc C Rc R". To maintain the correct relative channel ordering, JUCE would perform the following mapping: L -> wideLeft, Lc -> left, Rc -> right, R -> wideRight
The version of the VST3 SDK bundled with JUCE now supports Atmos versions of the above layouts, which have the front-channel ordering "Lw L C R Rw". This order matches the JUCE ordering, so no remapping is required.
create9point0point4(), create9point1point4(), create9point0point6(), and create9point1point6() now correspond to the VST3 k90_4_W, k91_4_W, k90_6_W, and k91_6_W Atmos layouts respectively.
If you need to support the old ITU layouts, use create9point0point4ITU(), create9point1point4ITU(), create9point0point6ITU(), and create9point1point6ITU() instead.
Is equivalent to: k91_6_W (VST3), kAudioChannelLayoutTag_Atmos_9_1_6 (CoreAudio).
|
static |
Creates a set for a 9.0.4 ITU surround setup: left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre, leftSurroundSide, rightSurroundSide, topFrontLeft, topFrontRight, topRearLeft, topRearRight.
|
static |
Creates a set for a 9.1.4 ITU surround setup.
left, right, centre, LFE, leftSurround, rightSurround, leftCentre, rightCentre, leftSurroundSide, rightSurroundSide, topFrontLeft, topFrontRight, topRearLeft, topRearRight
|
static |
Creates a set for a 9.0.6 ITU surround setup.
left, right, centre, leftSurround, rightSurround, leftCentre, rightCentre, leftSurroundSide, rightSurroundSide, topFrontLeft, topFrontRight, topRearLeft, topRearRight, topSideLeft, topSideRight
|
static |
Creates a set for a 9.1.6 ITU surround setup.
left, right, centre, LFE, leftSurround, rightSurround, leftCentre, rightCentre, leftSurroundSide, rightSurroundSide, topFrontLeft, topFrontRight, topRearLeft, topRearRight, topSideLeft, topSideRight
|
static |
Creates a set for quadraphonic surround setup (left, right, leftSurround, rightSurround)
Is equivalent to: k40Music (VST), AAX_eStemFormat_Quad (AAX), kAudioChannelLayoutTag_Quadraphonic (CoreAudio)
This format is referred to as "Quadraphonic" in Logic Pro. This format is referred to as "Quadro" in Cubase. This format is referred to as "Quad" in Pro Tools.
Referenced by SpeakerMappings::channelSetToVstArrangementType(), and SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Creates a set for pentagonal surround setup (left, right, centre, leftSurroundRear, rightSurroundRear).
Is equivalent to: n/a (VST), n/a (AAX), kAudioChannelLayoutTag_Pentagonal (CoreAudio)
|
static |
Creates a set for hexagonal surround setup (left, right, leftSurroundRear, rightSurroundRear, centre, surroundCentre).
Is equivalent to: n/a (VST), n/a (AAX), kAudioChannelLayoutTag_Hexagonal (CoreAudio)
|
static |
Creates a set for octagonal surround setup (left, right, leftSurround, rightSurround, centre, centreSurround, wideLeft, wideRight).
Is equivalent to: n/a (VST), n/a (AAX), kAudioChannelLayoutTag_Octagonal (CoreAudio)
|
static |
Creates a set for ACN, SN3D normalised ambisonic surround setups with a given order.
Is equivalent to: kAmbiXXXOrderACN (VST), AAX_eStemFormat_Ambi_XXX_ACN (AAX), kAudioChannelLayoutTag_HOA_ACN_SN3D (CoreAudio)
int AudioChannelSet::getAmbisonicOrder | ( | ) | const |
Returns the order of the ambisonic layout represented by this AudioChannelSet.
If the AudioChannelSet is not an ambisonic layout, then this method will return -1.
|
static |
Creates a set of untyped discrete channels.
Referenced by SpeakerMappings::vstArrangementTypeToChannelSet().
|
static |
Create a canonical channel set for a given number of channels.
For example, numChannels = 1 will return mono, numChannels = 2 will return stereo, etc.
|
static |
Create a channel set for a given number of channels which is non-discrete.
If numChannels is larger than the number of channels of the surround format with the maximum amount of channels (currently 7.1 Surround), then this function returns an empty set.
|
static |
Return an array of channel sets which have a given number of channels.
|
static |
Returns the name of a given channel type.
For example, this method may return "Surround Left".
|
static |
Returns the abbreviated name of a channel type.
For example, this method may return "Ls".
|
static |
Returns the channel type from an abbreviated name.
void AudioChannelSet::addChannel | ( | ChannelType | newChannelType | ) |
Adds a channel to the set.
Referenced by SpeakerMappings::vstArrangementTypeToChannelSet().
void AudioChannelSet::removeChannel | ( | ChannelType | newChannelType | ) |
Removes a channel from the set.
|
noexcept |
Returns the number of channels in the set.
Referenced by SpeakerMappings::channelSetToVstArrangement(), and SpeakerMappings::VstSpeakerConfigurationHolder::VstSpeakerConfigurationHolder().
|
noexcept |
Returns true if there are no channels in the set.
Array< ChannelType > AudioChannelSet::getChannelTypes | ( | ) | const |
Returns an array of all the types in this channel set.
Referenced by SpeakerMappings::channelSetToVstArrangementType().
|
noexcept |
Returns the type of one of the channels in the set, by index.
Referenced by SpeakerMappings::channelSetToVstArrangement(), and SpeakerMappings::VstSpeakerConfigurationHolder::VstSpeakerConfigurationHolder().
|
noexcept |
Returns the index for a particular channel-type.
Will return -1 if the this set does not contain a channel of this type.
String AudioChannelSet::getSpeakerArrangementAsString | ( | ) | const |
Returns a string containing a whitespace-separated list of speaker types corresponding to each channel.
For example in a 5.1 arrangement, the string may be "L R C Lfe Ls Rs". If the speaker arrangement is unknown, the returned string will be empty.
|
static |
Returns an AudioChannelSet from a string returned by getSpeakerArrangementAsString.
String AudioChannelSet::getDescription | ( | ) | const |
Returns the description of the current layout.
For example, this method may return "Quadraphonic". Note that the returned string may not be unique.
|
noexcept |
Returns if this is a channel layout made-up of discrete channels.
void AudioChannelSet::intersect | ( | const AudioChannelSet & | other | ) |
Intersect two channel layouts.
|
static |
Creates a channel set for a list of channel types.
This function will assert if you supply a duplicate channel.
Note that this method ignores the order in which the channels are given, i.e. two arrays with the same elements but in a different order will still result in the same channel set.
|
static |
Create an AudioChannelSet from a WAVEFORMATEXTENSIBLE channelMask (typically used in .wav files).
|
noexcept |
Returns a WAVEFORMATEXTENSIBLE channelMask representation (typically used in .wav files) of the receiver.
Returns -1 if the receiver cannot be represented in a WAVEFORMATEXTENSIBLE channelMask representation.
|
static |
Returns the ambisonic order that includes exactly numChannels, or -1 if no supported ambisonic order contains exactly numChannels.
|
noexcept |
|
noexcept |
|
noexcept |