OpenShot Audio Library | OpenShotAudio 0.4.0
Loading...
Searching...
No Matches
juce::Decibels Class Reference

#include <juce_Decibels.h>

Static Public Member Functions

template<typename Type >
static Type decibelsToGain (Type decibels, Type minusInfinityDb=Type(defaultMinusInfinitydB))
 
template<typename Type >
static Type gainToDecibels (Type gain, Type minusInfinityDb=Type(defaultMinusInfinitydB))
 
template<typename Type >
static Type gainWithLowerBound (Type gain, Type lowerBoundDb)
 
template<typename Type >
static String toString (Type decibels, int decimalPlaces=2, Type minusInfinityDb=Type(defaultMinusInfinitydB), bool shouldIncludeSuffix=true, StringRef customMinusInfinityString={})
 

Detailed Description

This class contains some helpful static methods for dealing with decibel values.

Definition at line 32 of file juce_Decibels.h.

Member Function Documentation

◆ decibelsToGain()

template<typename Type >
static Type juce::Decibels::decibelsToGain ( Type decibels,
Type minusInfinityDb = Type (defaultMinusInfinitydB) )
inlinestatic

Converts a dBFS value to its equivalent gain level.

A gain of 1.0 = 0 dB, and lower gains map onto negative decibel values. Any decibel value lower than minusInfinityDb will return a gain of 0.

Definition at line 42 of file juce_Decibels.h.

Referenced by juce::dsp::FilterDesign< FloatType >::designIIRLowpassHalfBandPolyphaseAllpassMethod(), gainWithLowerBound(), juce::dsp::Gain< FloatType >::setGainDecibels(), and juce::dsp::LogRampedValue< FloatType >::setLogParameters().

◆ gainToDecibels()

template<typename Type >
static Type juce::Decibels::gainToDecibels ( Type gain,
Type minusInfinityDb = Type (defaultMinusInfinitydB) )
inlinestatic

Converts a gain level into a dBFS value.

A gain of 1.0 = 0 dB, and lower gains map onto negative decibel values. If the gain is 0 (or negative), then the method will return the value provided as minusInfinityDb.

Definition at line 56 of file juce_Decibels.h.

Referenced by juce::dsp::Gain< FloatType >::getGainDecibels().

◆ gainWithLowerBound()

template<typename Type >
static Type juce::Decibels::gainWithLowerBound ( Type gain,
Type lowerBoundDb )
inlinestatic

◆ toString()

template<typename Type >
static String juce::Decibels::toString ( Type decibels,
int decimalPlaces = 2,
Type minusInfinityDb = Type (defaultMinusInfinitydB),
bool shouldIncludeSuffix = true,
StringRef customMinusInfinityString = {} )
inlinestatic

Converts a decibel reading to a string.

By default the returned string will have the 'dB' suffix added, but this can be removed by setting the shouldIncludeSuffix argument to false. If a customMinusInfinityString argument is provided this will be returned if the value is lower than minusInfinityDb, otherwise the return value will be "-INF".

Definition at line 86 of file juce_Decibels.h.


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