|
JUCE
|
Namespaces | |
| TypeHelpers | |
| This namespace contains a few template classes for helping work out class type variations. | |
Classes | |
| class | BigInteger |
| An arbitrarily large integer class. More... | |
| class | Expression |
| A class for dynamically evaluating simple numeric expressions. More... | |
| struct | Expression::Symbol |
| Represents a symbol that is used in an Expression. More... | |
| class | Expression::Scope::Visitor |
| Used as a callback by the Scope::visitRelativeScope() method. More... | |
| class | Expression::Scope |
| When evaluating an Expression object, this class is used to resolve symbols and perform functions that the expression uses. More... | |
| struct | MathConstants< FloatType > |
| Commonly used mathematical constants. More... | |
| struct | TypeHelpers::ParameterType< Type > |
| The ParameterType struct is used to find the best type to use when passing some kind of object as a parameter. More... | |
| struct | TypeHelpers::SmallestFloatType< Type > |
| These templates are designed to take a type, and if it's a double, they return a double type; for anything else, they return a float type. More... | |
| class | NormalisableRange< ValueType > |
| Represents a mapping between an arbitrary range of values and a normalised 0->1 range. More... | |
| class | Random |
| A random number generator. More... | |
| class | Range< ValueType > |
| A general-purpose range object, that simply represents any linear range with a start and end point. More... | |
| class | StatisticsAccumulator< FloatType > |
| A class that measures various statistics about a series of floating point values that it is given. More... | |
Macros | |
| #define | JUCE_UNDENORMALISE(x) { (x) += 0.1f; (x) -= 0.1f; } |
| This macro can be applied to a float variable to check whether it contains a denormalised value, and to normalise it if necessary. More... | |
Typedefs | |
| using | int8 = signed char |
| A platform-independent 8-bit signed integer type. More... | |
| using | uint8 = unsigned char |
| A platform-independent 8-bit unsigned integer type. More... | |
| using | int16 = signed short |
| A platform-independent 16-bit signed integer type. More... | |
| using | uint16 = unsigned short |
| A platform-independent 16-bit unsigned integer type. More... | |
| using | int32 = signed int |
| A platform-independent 32-bit signed integer type. More... | |
| using | uint32 = unsigned int |
| A platform-independent 32-bit unsigned integer type. More... | |
| using | int64 = long long |
| A platform-independent 64-bit integer type. More... | |
| using | uint64 = unsigned long long |
| A platform-independent 64-bit unsigned integer type. More... | |
| using | pointer_sized_int = int |
| A signed integer type that's guaranteed to be large enough to hold a pointer without truncating it. More... | |
| using | pointer_sized_uint = unsigned int |
| An unsigned integer type that's guaranteed to be large enough to hold a pointer without truncating it. More... | |
Functions | |
| OutputStream &JUCE_CALLTYPE | operator<< (OutputStream &stream, const BigInteger &value) |
| Writes a BigInteger to an OutputStream as a UTF8 decimal string. More... | |
| template<typename Type > | |
| constexpr Type | jmax (Type a, Type b) |
| Returns the larger of two values. More... | |
| template<typename Type > | |
| constexpr Type | jmax (Type a, Type b, Type c) |
| Returns the larger of three values. More... | |
| template<typename Type > | |
| constexpr Type | jmax (Type a, Type b, Type c, Type d) |
| Returns the larger of four values. More... | |
| template<typename Type > | |
| constexpr Type | jmin (Type a, Type b) |
| Returns the smaller of two values. More... | |
| template<typename Type > | |
| constexpr Type | jmin (Type a, Type b, Type c) |
| Returns the smaller of three values. More... | |
| template<typename Type > | |
| constexpr Type | jmin (Type a, Type b, Type c, Type d) |
| Returns the smaller of four values. More... | |
| template<typename Type > | |
| constexpr Type | jmap (Type value0To1, Type targetRangeMin, Type targetRangeMax) |
| Remaps a normalised value (between 0 and 1) to a target range. More... | |
| template<typename Type > | |
| Type | jmap (Type sourceValue, Type sourceRangeMin, Type sourceRangeMax, Type targetRangeMin, Type targetRangeMax) |
| Remaps a value from a source range to a target range. More... | |
| template<typename Type > | |
| Type | findMinimum (const Type *data, int numValues) |
| Scans an array of values, returning the minimum value that it contains. More... | |
| template<typename Type > | |
| Type | findMaximum (const Type *values, int numValues) |
| Scans an array of values, returning the maximum value that it contains. More... | |
| template<typename Type > | |
| void | findMinAndMax (const Type *values, int numValues, Type &lowest, Type &highest) |
| Scans an array of values, returning the minimum and maximum values that it contains. More... | |
| template<typename Type > | |
| Type | jlimit (Type lowerLimit, Type upperLimit, Type valueToConstrain) noexcept |
| Constrains a value to keep it within a given range. More... | |
| template<typename Type1 , typename Type2 > | |
| bool | isPositiveAndBelow (Type1 valueToTest, Type2 upperLimit) noexcept |
| Returns true if a value is at least zero, and also below a specified upper limit. More... | |
| template<typename Type > | |
| bool | isPositiveAndBelow (int valueToTest, Type upperLimit) noexcept |
| template<typename Type1 , typename Type2 > | |
| bool | isPositiveAndNotGreaterThan (Type1 valueToTest, Type2 upperLimit) noexcept |
| Returns true if a value is at least zero, and also less than or equal to a specified upper limit. More... | |
| template<typename Type > | |
| bool | isPositiveAndNotGreaterThan (int valueToTest, Type upperLimit) noexcept |
| template<typename Type > | |
| bool | isWithin (Type a, Type b, Type tolerance) noexcept |
| Computes the absolute difference between two values and returns true if it is less than or equal to a given tolerance, otherwise it returns false. More... | |
| template<typename Type > | |
| bool | approximatelyEqual (Type a, Type b) noexcept |
| Returns true if the two numbers are approximately equal. More... | |
| template<typename... Types> | |
| void | ignoreUnused (Types &&...) noexcept |
| Handy function for avoiding unused variables warning. More... | |
| template<typename Type , size_t N> | |
| constexpr int | numElementsInArray (Type(&)[N]) noexcept |
| Handy function for getting the number of elements in a simple const C array. More... | |
| template<typename Type > | |
| Type | juce_hypot (Type a, Type b) noexcept |
| Using juce_hypot is easier than dealing with the different types of hypot function that are provided by the various platforms and compilers. More... | |
| template<typename FloatType > | |
| constexpr FloatType | degreesToRadians (FloatType degrees) noexcept |
| Converts an angle in degrees to radians. More... | |
| template<typename FloatType > | |
| constexpr FloatType | radiansToDegrees (FloatType radians) noexcept |
| Converts an angle in radians to degrees. More... | |
| template<typename NumericType > | |
| bool | juce_isfinite (NumericType) noexcept |
| The isfinite() method seems to vary between platforms, so this is a platform-independent function for it. More... | |
| template<> | |
| bool | juce_isfinite (float value) noexcept |
| template<> | |
| bool | juce_isfinite (double value) noexcept |
| template<typename FloatType > | |
| int | roundToInt (const FloatType value) noexcept |
| Fast floating-point-to-integer conversion. More... | |
| int | roundToInt (int value) noexcept |
| int | roundToIntAccurate (double value) noexcept |
| Fast floating-point-to-integer conversion. More... | |
| template<typename FloatType > | |
| unsigned int | truncatePositiveToUnsignedInt (FloatType value) noexcept |
| Truncates a positive floating-point number to an unsigned int. More... | |
| template<typename IntegerType > | |
| constexpr bool | isPowerOfTwo (IntegerType value) |
| Returns true if the specified integer is a power-of-two. More... | |
| int | nextPowerOfTwo (int n) noexcept |
| Returns the smallest power-of-two which is equal to or greater than the given integer. More... | |
| int | findHighestSetBit (uint32 n) noexcept |
| Returns the index of the highest set bit in a (non-zero) number. More... | |
| int | countNumberOfBits (uint32 n) noexcept |
| Returns the number of bits in a 32-bit integer. More... | |
| int | countNumberOfBits (uint64 n) noexcept |
| Returns the number of bits in a 64-bit integer. More... | |
| template<typename IntegerType > | |
| IntegerType | negativeAwareModulo (IntegerType dividend, const IntegerType divisor) noexcept |
| Performs a modulo operation, but can cope with the dividend being negative. More... | |
| template<typename NumericType > | |
| constexpr NumericType | square (NumericType n) noexcept |
| Returns the square of its argument. More... | |
| void | writeLittleEndianBitsInBuffer (void *targetBuffer, uint32 startBit, uint32 numBits, uint32 value) noexcept |
| Writes a number of bits into a memory buffer at a given bit index. More... | |
| uint32 | readLittleEndianBitsInBuffer (const void *sourceBuffer, uint32 startBit, uint32 numBits) noexcept |
| Reads a number of bits from a buffer at a given bit index. More... | |
| #define JUCE_UNDENORMALISE | ( | x | ) | { (x) += 0.1f; (x) -= 0.1f; } |
This macro can be applied to a float variable to check whether it contains a denormalised value, and to normalise it if necessary.
On CPUs that aren't vulnerable to denormalisation problems, this will have no effect.
Referenced by Reverb::processMono().
| using int8 = signed char |
A platform-independent 8-bit signed integer type.
| using uint8 = unsigned char |
A platform-independent 8-bit unsigned integer type.
| using int16 = signed short |
A platform-independent 16-bit signed integer type.
| using uint16 = unsigned short |
A platform-independent 16-bit unsigned integer type.
| using int64 = long long |
A platform-independent 64-bit integer type.
| using uint64 = unsigned long long |
A platform-independent 64-bit unsigned integer type.
| using pointer_sized_int = int |
A signed integer type that's guaranteed to be large enough to hold a pointer without truncating it.
| using pointer_sized_uint = unsigned int |
An unsigned integer type that's guaranteed to be large enough to hold a pointer without truncating it.
| OutputStream& JUCE_CALLTYPE operator<< | ( | OutputStream & | stream, |
| const BigInteger & | value | ||
| ) |
Writes a BigInteger to an OutputStream as a UTF8 decimal string.
| constexpr Type jmax | ( | Type | a, |
| Type | b | ||
| ) |
Returns the larger of two values.
Referenced by Rectangle< int >::enlargeIfAdjacent(), Rectangle< int >::expand(), Rectangle< int >::expanded(), Rectangle< int >::findAreaContainingPoints(), Decibels::gainToDecibels(), SpeakerMappings::VstSpeakerConfigurationHolder::get(), RectangleList< int >::getBounds(), Rectangle< int >::getIntersection(), Range< int64 >::getIntersectionWith(), AudioBuffer< float >::getMagnitude(), dsp::Polynomial< FloatingType >::getProductWith(), Rectangle< int >::getUnion(), Range< int64 >::getUnionWith(), Rectangle< int >::intersectRectangle(), Rectangle< int >::intersectRectangles(), jmax(), dsp::FIR::Filter< SampleType >::reset(), ResizableBorderComponent::Zone::resizeRectangleBy(), Rectangle< int >::setLeft(), Range< int64 >::setLength(), TextEditor::setLineSpacing(), Draggable3DOrientation::setRadius(), Rectangle< int >::setTop(), StandalonePluginHolder::showAudioSettingsDialog(), Rectangle< int >::transformedBy(), Rectangle< int >::withBottom(), Rectangle< int >::withHeight(), Rectangle< int >::withLeft(), Rectangle< int >::withRight(), Rectangle< int >::withSize(), Range< int64 >::withStart(), Rectangle< int >::withTop(), and Rectangle< int >::withWidth().
| constexpr Type jmax | ( | Type | a, |
| Type | b, | ||
| Type | c | ||
| ) |
Returns the larger of three values.
| constexpr Type jmax | ( | Type | a, |
| Type | b, | ||
| Type | c, | ||
| Type | d | ||
| ) |
Returns the larger of four values.
References jmax().
| constexpr Type jmin | ( | Type | a, |
| Type | b | ||
| ) |
Returns the smaller of two values.
Referenced by Rectangle< int >::constrainedWithin(), dsp::AudioBlock< const SampleType >::copyTo(), SelectedItemSet< SelectableItemType >::deselectAll(), Rectangle< int >::enlargeIfAdjacent(), Rectangle< int >::findAreaContainingPoints(), RectangleList< int >::getBounds(), Rectangle< int >::getIntersection(), Range< int64 >::getIntersectionWith(), Draggable3DOrientation::getQuaternion(), Rectangle< int >::getUnion(), Range< int64 >::getUnionWith(), Rectangle< int >::intersectRectangle(), Rectangle< int >::intersectRectangles(), jmin(), dsp::ProcessorDuplicator< MonoProcessorType, StateType >::process(), dsp::Oscillator< SampleType >::process(), dsp::AudioBlock< const SampleType >::process(), Rectangle< int >::removeFromBottom(), Rectangle< int >::removeFromLeft(), Rectangle< int >::removeFromRight(), Rectangle< int >::removeFromTop(), ResizableBorderComponent::Zone::resizeRectangleBy(), SelectedItemSet< SelectableItemType >::selectOnly(), Rectangle< int >::setBottom(), Rectangle< int >::setRight(), AudioBuffer< float >::setSize(), Rectangle< int >::transformedBy(), PixelARGB::unpremultiply(), Rectangle< int >::withBottom(), Range< int64 >::withEnd(), Rectangle< int >::withRight(), Line< ValueType >::withShortenedEnd(), Line< ValueType >::withShortenedStart(), and BlocksProtocol::Packed7BitArrayBuilder< maxPacketBytes >::writeBits().
| constexpr Type jmin | ( | Type | a, |
| Type | b, | ||
| Type | c | ||
| ) |
Returns the smaller of three values.
| constexpr Type jmin | ( | Type | a, |
| Type | b, | ||
| Type | c, | ||
| Type | d | ||
| ) |
Returns the smaller of four values.
References jmin().
| constexpr Type jmap | ( | Type | value0To1, |
| Type | targetRangeMin, | ||
| Type | targetRangeMax | ||
| ) |
Remaps a normalised value (between 0 and 1) to a target range.
This effectively returns (targetRangeMin + value0To1 * (targetRangeMax - targetRangeMin)).
Referenced by dsp::LogRampedValue< FloatType >::getNextValue(), dsp::LookupTable< Type >::getUnchecked(), dsp::LadderFilter< Type >::process(), and dsp::LogRampedValue< FloatType >::skip().
| Type jmap | ( | Type | sourceValue, |
| Type | sourceRangeMin, | ||
| Type | sourceRangeMax, | ||
| Type | targetRangeMin, | ||
| Type | targetRangeMax | ||
| ) |
Remaps a value from a source range to a target range.
References jassert.
| Type findMinimum | ( | const Type * | data, |
| int | numValues | ||
| ) |
Scans an array of values, returning the minimum value that it contains.
| Type findMaximum | ( | const Type * | values, |
| int | numValues | ||
| ) |
Scans an array of values, returning the maximum value that it contains.
| void findMinAndMax | ( | const Type * | values, |
| int | numValues, | ||
| Type & | lowest, | ||
| Type & | highest | ||
| ) |
Scans an array of values, returning the minimum and maximum values that it contains.
Referenced by AudioData::Pointer< SampleFormat, Endianness, InterleavingType, Constness >::findMinAndMax().
|
noexcept |
Constrains a value to keep it within a given range.
This will check that the specified value lies between the lower and upper bounds specified, and if not, will return the nearest value that would be in-range. Effectively, it's like calling jmax (lowerLimit, jmin (upperLimit, value)).
Note that it expects that lowerLimit <= upperLimit. If this isn't true, the results will be unpredictable.
| lowerLimit | the minimum value to return |
| upperLimit | the maximum value to return |
| valueToConstrain | the value to try to return |
References jassert.
Referenced by Range< int64 >::clipValue(), Range< int64 >::constrainRange(), Line< ValueType >::findNearestProportionalPositionTo(), BlocksProtocol::IntegerWithBitSize< 8 >::fromBipolarFloat(), BlocksProtocol::IntegerWithBitSize< 8 >::fromUnipolarFloat(), Rectangle< int >::getConstrainedPoint(), Draggable3DOrientation::getQuaternion(), dsp::LookupTableTransform< Type >::processSample(), OwnedArray< MarkerList::Marker >::removeRange(), ReferenceCountedArray< AudioProcessorGraph::Node >::removeRange(), and Array< Component *>::removeRange().
|
noexcept |
Returns true if a value is at least zero, and also below a specified upper limit.
This is basically a quicker way to write:
References jassert.
Referenced by AudioBuffer< float >::addFrom(), AudioBuffer< float >::addFromWithRamp(), dsp::AudioBlock< const SampleType >::addSample(), AudioBuffer< float >::addSample(), AudioBuffer< float >::applyGain(), AudioBuffer< float >::applyGainRamp(), AudioBuffer< float >::clear(), AudioBuffer< float >::copyFrom(), AudioBuffer< float >::copyFromWithRamp(), AudioBuffer< float >::findMinMax(), AudioBuffer< float >::getMagnitude(), AudioProcessor::BusesLayout::getNumChannels(), AudioBuffer< float >::getReadPointer(), AudioBuffer< float >::getRMSLevel(), dsp::AudioBlock< const SampleType >::getSample(), AudioBuffer< float >::getSample(), dsp::LookupTable< Type >::getUnchecked(), ArrayBase< ProgressBar *, DummyCriticalSection >::getValueWithDefault(), AudioBuffer< float >::getWritePointer(), EdgeTable::iterate(), ArrayBase< ProgressBar *, DummyCriticalSection >::move(), ArrayBase< ProgressBar *, DummyCriticalSection >::operator[](), dsp::LookupTableTransform< Type >::processSample(), OwnedArray< MarkerList::Marker >::remove(), ReferenceCountedArray< AudioProcessorGraph::Node >::remove(), Array< Component *>::remove(), OwnedArray< MarkerList::Marker >::removeAndReturn(), ReferenceCountedArray< AudioProcessorGraph::Node >::removeAndReturn(), Array< Component *>::removeAndReturn(), AudioBuffer< float >::reverse(), dsp::AudioBlock< const SampleType >::setSample(), AudioBuffer< float >::setSample(), Array< Component *>::setUnchecked(), ArrayBase< ProgressBar *, DummyCriticalSection >::swap(), and ReferenceCountedArray< AudioProcessorGraph::Node >::swap().
|
noexcept |
References jassert.
|
noexcept |
Returns true if a value is at least zero, and also less than or equal to a specified upper limit.
This is basically a quicker way to write:
References jassert.
|
noexcept |
References jassert.
|
noexcept |
Computes the absolute difference between two values and returns true if it is less than or equal to a given tolerance, otherwise it returns false.
References abs().
|
noexcept |
|
noexcept |
Handy function for avoiding unused variables warning.
Referenced by AudioProcessorValueTreeState::ParameterLayout::add(), OwnedArray< MarkerList::Marker >::addSorted(), StandalonePluginHolder::askUserToLoadState(), StandalonePluginHolder::askUserToSaveState(), AudioProcessor::canAddBus(), AudioProcessor::canRemoveBus(), UndoableAction::createCoalescedAction(), PushNotifications::Listener::deliveredNotificationsListReceived(), ContainerDeletePolicy< ObjectType >::destroy(), PushNotifications::Listener::deviceTokenRefreshed(), PushNotifications::Listener::handleNotification(), PushNotifications::Listener::handleNotificationAction(), MidiInputCallback::handlePartialSysexMessage(), VSTCallbackHandler::handleVstHostCallbackAvailable(), VSTCallbackHandler::handleVstPluginCanDo(), OwnedArray< MarkerList::Marker >::indexOfSorted(), ReferenceCountedArray< AudioProcessorGraph::Node >::indexOfSorted(), Array< Component *>::indexOfSorted(), StandalonePluginHolder::isInterAppAudioConnected(), PushNotifications::Listener::localNotificationDismissedByUser(), ArrayBase< ProgressBar *, DummyCriticalSection >::move(), MPEInstrument::Listener::noteAdded(), MPEInstrument::Listener::noteKeyStateChanged(), MPEInstrument::Listener::notePitchbendChanged(), MPEInstrument::Listener::notePressureChanged(), MPEInstrument::Listener::noteReleased(), MPEInstrument::Listener::noteTimbreChanged(), PushNotifications::Listener::notificationSettingsReceived(), PushNotifications::Listener::pendingLocalNotificationsListReceived(), dsp::FIR::Filter< SampleType >::prepare(), InAppPurchases::Listener::productDownloadFinished(), PositionableAudioSource::setLooping(), OwnedArray< MarkerList::Marker >::sort(), ReferenceCountedArray< AudioProcessorGraph::Node >::sort(), Array< Component *>::sort(), AudioPlayHead::transportPlay(), AudioPlayHead::transportRecord(), PushNotifications::Listener::upstreamMessageSendingError(), and PushNotifications::Listener::upstreamMessageSent().
|
noexcept |
Handy function for getting the number of elements in a simple const C array.
E.g.
Referenced by AudioBuffer< float >::AudioBuffer(), and AudioBuffer< float >::operator=().
|
noexcept |
Using juce_hypot is easier than dealing with the different types of hypot function that are provided by the various platforms and compilers.
Referenced by Point< int >::getDistanceFrom(), Point< int >::getDistanceFromOrigin(), and Line< ValueType >::getPointAlongLine().
|
noexcept |
Converts an angle in degrees to radians.
|
noexcept |
Converts an angle in radians to degrees.
|
noexcept |
The isfinite() method seems to vary between platforms, so this is a platform-independent function for it.
Referenced by StatisticsAccumulator< FloatType >::addValue(), Point< int >::isFinite(), and Rectangle< int >::isFinite().
|
noexcept |
|
noexcept |
|
noexcept |
Fast floating-point-to-integer conversion.
This is faster than using the normal c++ cast to convert a float to an int, and it will round the value to the nearest integer, rather than rounding it down like the normal cast does.
Note that this routine gets its speed at the expense of some accuracy, and when rounding values whose floating point component is exactly 0.5, odd numbers and even numbers will be rounded up or down differently.
Referenced by AudioParameterInt::get(), AudioParameterChoice::getIndex(), Point< int >::roundToInt(), roundToIntAccurate(), Rectangle< int >::toNearestInt(), Rectangle< int >::toNearestIntEdges(), and Decibels::toString().
|
noexcept |
Fast floating-point-to-integer conversion.
This is a slightly slower and slightly more accurate version of roundToInt(). It works fine for values above zero, but negative numbers are rounded the wrong way.
References roundToInt().
|
noexcept |
Truncates a positive floating-point number to an unsigned int.
This is generally faster than static_cast<unsigned int> (std::floor (x)) but it only works for positive numbers small enough to be represented as an unsigned int.
References jassert, and max().
Referenced by dsp::LookupTable< Type >::getUnchecked().
| constexpr bool isPowerOfTwo | ( | IntegerType | value | ) |
Returns true if the specified integer is a power-of-two.
Returns the smallest power-of-two which is equal to or greater than the given integer.
References findHighestSetBit().
Returns the index of the highest set bit in a (non-zero) number.
So for n=3 this would return 1, for n=7 it returns 2, etc. An input value of 0 is illegal!
Referenced by nextPowerOfTwo().
Returns the number of bits in a 32-bit integer.
Referenced by countNumberOfBits().
Returns the number of bits in a 64-bit integer.
References countNumberOfBits().
|
noexcept |
Performs a modulo operation, but can cope with the dividend being negative.
The divisor must be greater than zero.
References jassert.
|
noexcept |
Returns the square of its argument.
References readLittleEndianBitsInBuffer(), and writeLittleEndianBitsInBuffer().
|
noexcept |
Writes a number of bits into a memory buffer at a given bit index.
The buffer is treated as a sequence of 8-bit bytes, and the value is encoded in little-endian order, so for example if startBit = 10, and numBits = 11 then the lower 6 bits of the value would be written into bits 2-8 of targetBuffer[1], and the upper 5 bits of value into bits 0-5 of targetBuffer[2].
Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBits(), and square().
|
noexcept |
Reads a number of bits from a buffer at a given bit index.
The buffer is treated as a sequence of 8-bit bytes, and the value is encoded in little-endian order, so for example if startBit = 10, and numBits = 11 then the lower 6 bits of the result would be read from bits 2-8 of sourceBuffer[1], and the upper 5 bits of the result from bits 0-5 of sourceBuffer[2].
Referenced by littlefoot::Runner< programAndHeapSpace, stackAndGlobalsSpace >::getHeapBits(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBits(), and square().
1.8.13