#[non_exhaustive]
pub struct AudioNormalizationSettings { pub algorithm: Option<AudioNormalizationAlgorithm>, pub algorithm_control: Option<AudioNormalizationAlgorithmControl>, pub correction_gate_level: Option<i32>, pub loudness_logging: Option<AudioNormalizationLoudnessLogging>, pub peak_calculation: Option<AudioNormalizationPeakCalculation>, pub target_lkfs: Option<f64>, pub true_peak_limiter_threshold: Option<f64>, }
Expand description

Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§algorithm: Option<AudioNormalizationAlgorithm>

Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.

§algorithm_control: Option<AudioNormalizationAlgorithmControl>

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

§correction_gate_level: Option<i32>

Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.

§loudness_logging: Option<AudioNormalizationLoudnessLogging>

If set to LOG, log each output’s audio track loudness to a CSV file.

§peak_calculation: Option<AudioNormalizationPeakCalculation>

If set to TRUE_PEAK, calculate and log the TruePeak for each output’s audio track loudness.

§target_lkfs: Option<f64>

When you use Audio normalization, optionally use this setting to specify a target loudness. If you don’t specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.

§true_peak_limiter_threshold: Option<f64>

Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0.

Implementations§

source§

impl AudioNormalizationSettings

source

pub fn algorithm(&self) -> Option<&AudioNormalizationAlgorithm>

Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.

source

pub fn algorithm_control(&self) -> Option<&AudioNormalizationAlgorithmControl>

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

source

pub fn correction_gate_level(&self) -> Option<i32>

Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.

source

pub fn loudness_logging(&self) -> Option<&AudioNormalizationLoudnessLogging>

If set to LOG, log each output’s audio track loudness to a CSV file.

source

pub fn peak_calculation(&self) -> Option<&AudioNormalizationPeakCalculation>

If set to TRUE_PEAK, calculate and log the TruePeak for each output’s audio track loudness.

source

pub fn target_lkfs(&self) -> Option<f64>

When you use Audio normalization, optionally use this setting to specify a target loudness. If you don’t specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.

source

pub fn true_peak_limiter_threshold(&self) -> Option<f64>

Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0.

source§

impl AudioNormalizationSettings

source

pub fn builder() -> AudioNormalizationSettingsBuilder

Creates a new builder-style object to manufacture AudioNormalizationSettings.

Trait Implementations§

source§

impl Clone for AudioNormalizationSettings

source§

fn clone(&self) -> AudioNormalizationSettings

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for AudioNormalizationSettings

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq for AudioNormalizationSettings

source§

fn eq(&self, other: &AudioNormalizationSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for AudioNormalizationSettings

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more