Struct babycat::DecodeArgs

#[repr(C)]
pub struct DecodeArgs {
    pub start_time_milliseconds: u64,
    pub end_time_milliseconds: u64,
    pub frame_rate_hz: u32,
    pub num_channels: u32,
    pub convert_to_mono: bool,
    pub zero_pad_ending: bool,
    pub resample_mode: u32,
}

Specifies what transformations to apply to the audio during the decoding process.

The default value for this struct will tell Babycat to decode audio as-is and not change anything.

Fields

start_time_milliseconds: u64

We discard any audio before this millisecond offset. By default, this does nothing and the audio is decoded from the beginning. Negative offsets are invalid.

end_time_milliseconds: u64

We discard any audio after this millisecond offset. By default, this does nothing and the audio is decoded all the way to the end. If start_time_milliseconds is specified, then end_time_milliseconds must be greater. The resulting

frame_rate_hz: u32

A destination frame rate to resample the audio to. Do not specify this parameter if you wish Babycat to preserve the audio’s original frame rate. This does nothing if frame_rate_hz is equal to the audio’s original frame rate.

num_channels: u32

Set this to a positive integer n to select the first n channels stored in the audio file. By default, Babycat will return all of the channels in the original audio. This will raise an exception if you specify a num_channels greater than the actual number of channels in the audio.

convert_to_mono: bool

Set to true to average all channels into a single monophonic (mono) channel. If num_channels = n is also specified, then only the first n channels will be averaged. Note that convert_to_mono cannot be set to true while also setting num_channels = 1.

zero_pad_ending: bool

If you set this to true, Babycat will zero-pad the ending of the decoded waveform to ensure that the output waveform’s duration is exactly end_time_milliseconds - start_time_milliseconds. By default, zero_pad_ending = false, in which case the output waveform will be shorter than end_time_milliseconds - start_time_milliseconds if the input audio is shorter than end_time_milliseconds.

resample_mode: u32

Sets which resampling method is used if you have set frame_rate_hz. This usually defaults to the highest-accuracy resampler compiled into Babycat.

Current valid values include:

• RESAMPLE_MODE_BABYCAT: A custom resampler maintained within Babycat. This is designed for speed and compatibility with compilation targets where libsamplerate cannot be used.

• RESAMPLE_MODE_LIBSAMPLERATE: This uses libsamplerate at the SRC_SINC_BEST_QUALITY setting. This option is only available if it is enabled at compile-time, and is disabled for targets missing a libc, such as the WebAssembly wasm32-unknown-unknown target.

Trait Implementations

impl Clone for DecodeArgs

fn clone(&self) -> DecodeArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeArgs

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

Formats the value using the given formatter.

impl Default for DecodeArgs

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DecodeArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<DecodeArgs> for DecodeArgs

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

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

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

This method tests for !=.

impl Serialize for DecodeArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for DecodeArgs

impl Eq for DecodeArgs

impl StructuralEq for DecodeArgs

impl StructuralPartialEq for DecodeArgs