JUCE  v4.2.4-0-g680d758
JUCE API
Classes | Public Types | Public Member Functions | Public Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
PluginBusUtilities Struct Reference

#include <juce_PluginBusUtilities.h>

Collaboration diagram for PluginBusUtilities:
Collaboration graph
[legend]

Classes

struct  BusLayoutDetails
 
class  ScopedBusRestorer
 

Public Types

enum  { kDefaultMaxChannels = 64 }
 
typedef Array< AudioProcessor::AudioProcessorBus > AudioBusArray
 

Public Member Functions

 PluginBusUtilities (AudioProcessor &plugin, bool markDiscreteLayoutsAsSupported, int maxProbeChannels=kDefaultMaxChannels)
 
bool busCanBeDisabled (bool inp, int bus) const noexcept
 
bool busIgnoresLayout (bool inp, int bus) const noexcept
 
bool checkBusFormatsAreNotDiscrete () const
 
void enableAllBuses ()
 
int findMaxNumberOfChannelsForBus (bool isInput, int busNr, int upperlimit=std::numeric_limits< int >::max())
 
int findTotalNumChannels (bool isInput, int busOffset=0) const noexcept
 
int getBusCount (bool inputBus) const noexcept
 
int getBusIdxForChannelIdx (bool isInput, int channelIdx, int &totalChannels, int startBusIdx)
 
int getBusIdxForChannelIdx (bool isInput, int channelIdx)
 
AudioChannelSet getChannelSet (bool inp, int bus) noexcept
 
const AudioChannelSet & getDefaultLayoutForBus (bool isInput, int busIdx) const noexcept
 
AudioChannelSet getDefaultLayoutForChannelNumAndBus (bool isInput, int busIdx, int channelNum) const noexcept
 
AudioBusArray & getFilterBus (bool inputBus) noexcept
 
const AudioBusArray & getFilterBus (bool inputBus) const noexcept
 
int getNumChannels (bool inp, int bus) const noexcept
 
int getNumEnabledBuses (bool inputBus) const noexcept
 
bool hasDynamicInBuses () const noexcept
 
bool hasDynamicOutBuses () const noexcept
 
bool hasInputs (int bus) const noexcept
 
bool hasOutputs (int bus) const noexcept
 
void init ()
 
bool isBusEnabled (bool inputBus, int bus) const noexcept
 
bool isBusEnabledByDefault (bool inp, int bus) const noexcept
 
void restoreBusArrangement (const AudioProcessor::AudioBusArrangement &original) const
 

Public Attributes

AudioProcessor & processor
 

Private Types

enum  {
  maxNumChannelsOfNonDiscreteLayouts = 8,
  pseudoChannelBitNum = 90,
  insaneNumberOfChannels = 512
}
 

Private Member Functions

void addLayoutDetails (bool isInput, int busNr)
 
bool busIgnoresLayoutForChannelNum (bool isInput, int busNr, int channelNum)
 
bool checkBusFormatsAreNotDiscrete (bool isInput) const
 
void clear (int inputCount, int outputCount)
 
bool doesPlugInHaveDynamicBuses (bool isInput) const
 
BusLayoutDetails & getBusLayoutDetails (bool isInput, int busNr) noexcept
 
const BusLayoutDetails & getBusLayoutDetails (bool isInput, int busNr) const noexcept
 
Array< BusLayoutDetails > & getLayoutDetails (bool isInput) noexcept
 
const Array< BusLayoutDetails > & getLayoutDetails (bool isInput) const noexcept
 
void populateLayoutDetails ()
 
void updateDefaultLayout (bool isInput, int busIdx)
 

Static Private Member Functions

static Array< AudioChannelSet > layoutListCompatibleWithChannelCount (const int channelCount) noexcept
 

Private Attributes

bool dynamicInBuses
 
bool dynamicOutBuses
 
Array< BusLayoutDetails > inputLayouts
 
int maxChannelsToProbe
 
Array< BusLayoutDetails > outputLayouts
 
bool plugInFormatSupportsDiscreteLayouts
 

Friends

class ScopedBusRestorer
 

Member Typedef Documentation

typedef Array<AudioProcessor::AudioProcessorBus> PluginBusUtilities::AudioBusArray

Member Enumeration Documentation

anonymous enum
Enumerator
kDefaultMaxChannels 
anonymous enum
private
Enumerator
maxNumChannelsOfNonDiscreteLayouts 
pseudoChannelBitNum 
insaneNumberOfChannels 

Constructor & Destructor Documentation

PluginBusUtilities::PluginBusUtilities ( AudioProcessor &  plugin,
bool  markDiscreteLayoutsAsSupported,
int  maxProbeChannels = kDefaultMaxChannels 
)
inline

Member Function Documentation

void PluginBusUtilities::addLayoutDetails ( bool  isInput,
int  busNr 
)
inlineprivate

References PluginBusUtilities::BusLayoutDetails::busIgnoresLayout, busIgnoresLayoutForChannelNum(), PluginBusUtilities::BusLayoutDetails::canBeDisabled, getBusLayoutDetails(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), layoutListCompatibleWithChannelCount(), maxNumChannelsOfNonDiscreteLayouts, AudioProcessor::setPreferredBusArrangement(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by populateLayoutDetails().

bool PluginBusUtilities::busCanBeDisabled ( bool  inp,
int  bus 
) const
inlinenoexcept

References PluginBusUtilities::BusLayoutDetails::canBeDisabled, getBusLayoutDetails(), getLayoutDetails(), and juce::isPositiveAndBelow().

bool PluginBusUtilities::busIgnoresLayout ( bool  inp,
int  bus 
) const
inlinenoexcept

References PluginBusUtilities::BusLayoutDetails::busIgnoresLayout, getBusLayoutDetails(), getLayoutDetails(), and juce::isPositiveAndBelow().

bool PluginBusUtilities::busIgnoresLayoutForChannelNum ( bool  isInput,
int  busNr,
int  channelNum 
)
inlineprivate

References pseudoChannelBitNum, and AudioProcessor::setPreferredBusArrangement().

Referenced by addLayoutDetails().

bool PluginBusUtilities::checkBusFormatsAreNotDiscrete ( ) const
inline
bool PluginBusUtilities::checkBusFormatsAreNotDiscrete ( bool  isInput) const
inlineprivate

References AudioProcessor::busArrangement, AudioProcessor::AudioProcessorBus::channels, getBusCount(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), AudioProcessor::AudioBusArrangement::inputBuses, AudioChannelSet::isDiscreteLayout(), and AudioProcessor::AudioBusArrangement::outputBuses.

void PluginBusUtilities::clear ( int  inputCount,
int  outputCount 
)
inlineprivate

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::clear(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::resize().

Referenced by populateLayoutDetails().

bool PluginBusUtilities::doesPlugInHaveDynamicBuses ( bool  isInput) const
inlineprivate

References PluginBusUtilities::BusLayoutDetails::canBeDisabled, getBusCount(), and getBusLayoutDetails().

Referenced by populateLayoutDetails().

void PluginBusUtilities::enableAllBuses ( )
inline

References AudioChannelSet::disabled(), getBusCount(), getChannelSet(), getDefaultLayoutForBus(), processor, and AudioProcessor::setPreferredBusArrangement().

int PluginBusUtilities::findMaxNumberOfChannelsForBus ( bool  isInput,
int  busNr,
int  upperlimit = std::numeric_limits<int>::max() 
)
inline

References AudioChannelSet::discreteChannels(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), insaneNumberOfChannels, juce::jmax(), juce::jmin(), layoutListCompatibleWithChannelCount(), maxChannelsToProbe, maxNumChannelsOfNonDiscreteLayouts, plugInFormatSupportsDiscreteLayouts, processor, AudioProcessor::setPreferredBusArrangement(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by updateDefaultLayout().

int PluginBusUtilities::findTotalNumChannels ( bool  isInput,
int  busOffset = 0 
) const
inlinenoexcept

References AudioProcessor::AudioProcessorBus::channels, getFilterBus(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), AudioChannelSet::size(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by AudioUnitHelpers::ChannelRemapper::initializeChannelMapArray().

int PluginBusUtilities::getBusCount ( bool  inputBus) const
inlinenoexcept

References getFilterBus(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by checkBusFormatsAreNotDiscrete(), doesPlugInHaveDynamicBuses(), enableAllBuses(), getBusIdxForChannelIdx(), getChannelSet(), getDefaultLayoutForChannelNumAndBus(), getNumChannels(), getNumEnabledBuses(), populateLayoutDetails(), and restoreBusArrangement().

int PluginBusUtilities::getBusIdxForChannelIdx ( bool  isInput,
int  channelIdx,
int &  totalChannels,
int  startBusIdx 
)
inline

References getBusCount(), and getNumChannels().

Referenced by getBusIdxForChannelIdx().

int PluginBusUtilities::getBusIdxForChannelIdx ( bool  isInput,
int  channelIdx 
)
inline

References getBusIdxForChannelIdx().

BusLayoutDetails& PluginBusUtilities::getBusLayoutDetails ( bool  isInput,
int  busNr 
)
inlineprivatenoexcept

References getLayoutDetails().

Referenced by addLayoutDetails(), busCanBeDisabled(), busIgnoresLayout(), doesPlugInHaveDynamicBuses(), getDefaultLayoutForBus(), getDefaultLayoutForChannelNumAndBus(), isBusEnabledByDefault(), populateLayoutDetails(), and updateDefaultLayout().

const BusLayoutDetails& PluginBusUtilities::getBusLayoutDetails ( bool  isInput,
int  busNr 
) const
inlineprivatenoexcept

References getLayoutDetails().

AudioChannelSet PluginBusUtilities::getChannelSet ( bool  inp,
int  bus 
)
inlinenoexcept

References AudioProcessor::AudioProcessorBus::channels, getBusCount(), getFilterBus(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), and juce::isPositiveAndBelow().

Referenced by enableAllBuses(), AudioUnitHelpers::ChannelRemapper::fillLayoutChannelMaps(), and populateLayoutDetails().

const AudioChannelSet& PluginBusUtilities::getDefaultLayoutForBus ( bool  isInput,
int  busIdx 
) const
inlinenoexcept

References PluginBusUtilities::BusLayoutDetails::defaultLayout, and getBusLayoutDetails().

Referenced by enableAllBuses().

AudioChannelSet PluginBusUtilities::getDefaultLayoutForChannelNumAndBus ( bool  isInput,
int  busIdx,
int  channelNum 
) const
inlinenoexcept

References PluginBusUtilities::BusLayoutDetails::defaultLayout, AudioChannelSet::disabled(), AudioChannelSet::discreteChannels(), getBusCount(), getBusLayoutDetails(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), AudioChannelSet::isDiscreteLayout(), layoutListCompatibleWithChannelCount(), plugInFormatSupportsDiscreteLayouts, processor, AudioProcessor::setPreferredBusArrangement(), AudioChannelSet::size(), and Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by AudioUnitHelpers::getAUChannelInfo(), and updateDefaultLayout().

AudioBusArray& PluginBusUtilities::getFilterBus ( bool  inputBus)
inlinenoexcept

References AudioProcessor::busArrangement, AudioProcessor::AudioBusArrangement::inputBuses, AudioProcessor::AudioBusArrangement::outputBuses, and processor.

Referenced by findTotalNumChannels(), getBusCount(), getChannelSet(), and getNumChannels().

const AudioBusArray& PluginBusUtilities::getFilterBus ( bool  inputBus) const
inlinenoexcept

References AudioProcessor::busArrangement, AudioProcessor::AudioBusArrangement::inputBuses, AudioProcessor::AudioBusArrangement::outputBuses, and processor.

Array<BusLayoutDetails>& PluginBusUtilities::getLayoutDetails ( bool  isInput)
inlineprivatenoexcept

References inputLayouts, and outputLayouts.

Referenced by busCanBeDisabled(), busIgnoresLayout(), getBusLayoutDetails(), and isBusEnabledByDefault().

const Array<BusLayoutDetails>& PluginBusUtilities::getLayoutDetails ( bool  isInput) const
inlineprivatenoexcept

References inputLayouts, and outputLayouts.

int PluginBusUtilities::getNumChannels ( bool  inp,
int  bus 
) const
inlinenoexcept

References AudioProcessor::AudioProcessorBus::channels, getBusCount(), getFilterBus(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), juce::isPositiveAndBelow(), and AudioChannelSet::size().

Referenced by AudioUnitHelpers::getAUChannelInfo(), getBusIdxForChannelIdx(), AudioUnitHelpers::ChannelRemapper::initializeChannelMapArray(), and isBusEnabled().

int PluginBusUtilities::getNumEnabledBuses ( bool  inputBus) const
inlinenoexcept

References getBusCount(), and isBusEnabled().

Referenced by AudioUnitHelpers::getAUChannelInfo().

bool PluginBusUtilities::hasDynamicInBuses ( ) const
inlinenoexcept

References dynamicInBuses.

bool PluginBusUtilities::hasDynamicOutBuses ( ) const
inlinenoexcept

References dynamicOutBuses.

bool PluginBusUtilities::hasInputs ( int  bus) const
inlinenoexcept

References isBusEnabled().

Referenced by updateDefaultLayout().

bool PluginBusUtilities::hasOutputs ( int  bus) const
inlinenoexcept

References isBusEnabled().

Referenced by updateDefaultLayout().

void PluginBusUtilities::init ( )
inline

References populateLayoutDetails().

bool PluginBusUtilities::isBusEnabled ( bool  inputBus,
int  bus 
) const
inlinenoexcept

References getNumChannels().

Referenced by getNumEnabledBuses(), hasInputs(), and hasOutputs().

bool PluginBusUtilities::isBusEnabledByDefault ( bool  inp,
int  bus 
) const
inlinenoexcept

References getBusLayoutDetails(), getLayoutDetails(), PluginBusUtilities::BusLayoutDetails::isEnabledByDefault, and juce::isPositiveAndBelow().

static Array<AudioChannelSet> PluginBusUtilities::layoutListCompatibleWithChannelCount ( const int  channelCount)
inlinestaticprivatenoexcept

References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add(), AudioChannelSet::ambisonic(), AudioChannelSet::create5point0(), AudioChannelSet::create5point1(), AudioChannelSet::create6point0(), AudioChannelSet::create6point0Music(), AudioChannelSet::create6point1(), AudioChannelSet::create7point0(), AudioChannelSet::create7point1(), AudioChannelSet::create7point1AC3(), AudioChannelSet::createFront7point1(), AudioChannelSet::createLCR(), AudioChannelSet::createLCRS(), AudioChannelSet::createLRS(), AudioChannelSet::hexagonal(), jassert, JUCE_DECLARE_NON_COPYABLE, AudioChannelSet::mono(), AudioChannelSet::octagonal(), AudioChannelSet::pentagonal(), AudioChannelSet::quadraphonic(), and AudioChannelSet::stereo().

Referenced by addLayoutDetails(), findMaxNumberOfChannelsForBus(), getDefaultLayoutForChannelNumAndBus(), and updateDefaultLayout().

void PluginBusUtilities::populateLayoutDetails ( )
inlineprivate

References addLayoutDetails(), clear(), PluginBusUtilities::BusLayoutDetails::defaultLayout, doesPlugInHaveDynamicBuses(), getBusCount(), getBusLayoutDetails(), getChannelSet(), and updateDefaultLayout().

Referenced by init().

void PluginBusUtilities::restoreBusArrangement ( const AudioProcessor::AudioBusArrangement &  original) const
inline

References getBusCount(), AudioProcessor::AudioBusArrangement::inputBuses, jassert, AudioProcessor::AudioBusArrangement::outputBuses, processor, and AudioProcessor::setPreferredBusArrangement().

Referenced by PluginBusUtilities::ScopedBusRestorer::~ScopedBusRestorer().

void PluginBusUtilities::updateDefaultLayout ( bool  isInput,
int  busIdx 
)
inlineprivate

References PluginBusUtilities::BusLayoutDetails::defaultLayout, AudioChannelSet::discreteChannels(), findMaxNumberOfChannelsForBus(), getBusLayoutDetails(), getDefaultLayoutForChannelNumAndBus(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), hasInputs(), hasOutputs(), AudioChannelSet::isDiscreteLayout(), PluginBusUtilities::BusLayoutDetails::isEnabledByDefault, jassert, jassertfalse, layoutListCompatibleWithChannelCount(), AudioProcessor::setPreferredBusArrangement(), AudioChannelSet::size(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size(), and AudioChannelSet::stereo().

Referenced by populateLayoutDetails().

Friends And Related Function Documentation

friend class ScopedBusRestorer
friend

Member Data Documentation

bool PluginBusUtilities::dynamicInBuses
private

Referenced by hasDynamicInBuses().

bool PluginBusUtilities::dynamicOutBuses
private

Referenced by hasDynamicOutBuses().

Array<BusLayoutDetails> PluginBusUtilities::inputLayouts
private

Referenced by getLayoutDetails().

int PluginBusUtilities::maxChannelsToProbe
private

Referenced by findMaxNumberOfChannelsForBus().

Array<BusLayoutDetails> PluginBusUtilities::outputLayouts
private

Referenced by getLayoutDetails().

bool PluginBusUtilities::plugInFormatSupportsDiscreteLayouts
private

Referenced by findMaxNumberOfChannelsForBus(), and getDefaultLayoutForChannelNumAndBus().

AudioProcessor& PluginBusUtilities::processor

Referenced by enableAllBuses(), findMaxNumberOfChannelsForBus(), AudioUnitHelpers::getAUChannelInfo(), getDefaultLayoutForChannelNumAndBus(), getFilterBus(), and restoreBusArrangement().

The documentation for this struct was generated from the following file: