Member Functions¶

A¶

• function audio_data<IsInterleaved>::append(const audio_data<IsInterleaved> &) Appends samples from a buffer with the opposite layout.
• function audio_data<IsInterleaved>::apply_gain_dB(fbase) Applies a gain in decibels (dB) in place.
• function audio_filter::apply(audio_data_planar &) Applies the filter in-place to planar audio data.
• function audio_filter::apply(audio_data_planar &, const audio_data_planar &) Applies the filter to planar audio data, writing the result to dest .
• function audio_data<IsInterleaved>::audio_data<IsInterleaved>(fbase *, size_t, size_t, Fn &&) Constructs an interleaved audio_data view from an external buffer with a custom deallocator.
• function audio_data<IsInterleaved>::audio_data<IsInterleaved>(std::span<fbase *const>, size_t, Fn &&) Constructs a planar audio_data view from external channel pointers with a custom deallocator.

B¶

• function audiofile_format::bytes_per_pcm_frame()

C¶

• function audio_data<IsInterleaved>::channel_count() Retrieves the number of audio channels.
• function audio_data<IsInterleaved>::channel(size_t) Retrieves a reference to the audio data of a specific channel.
• function audio_data<IsInterleaved>::clamp(fbase, fbase) Clamps all samples to the range [min_val, max_val] in place.
• function audio_data<IsInterleaved>::clear() Clears all audio data, leaving the container empty (size == 0).
• function audio_data<IsInterleaved>::clone() Creates an independent deep copy of this audio data.
• function audio_decoder::close() Closes the audio file and releases resources.
• function audio_encoder::close() Closes the encoder and finalizes the file.
• function audio_filter::convolution(size_t, const univector_ref<const fbase> &, size_t) Creates an audio filter using streaming overlap-add FFT convolution for all channels.

E¶

• function audio_data<IsInterleaved>::empty() Check whether this audio data container is empty.

F¶

• function audio_data<IsInterleaved>::fill(fbase) Fills the audio data with the specified value.
• function audio_data<IsInterleaved>::find_peak()
• function audio_filter::fir(size_t, const fir_params<fbase> &) Creates an audio filter using an FIR filter for all channels.
• function audio_data<IsInterleaved>::for_channel(Fn &&) Applies a given function to the audio data for each channel.
• function audio_decoder::format() Retrieves the format of the currently opened audio file.
• function audio_encoder::format() Retrieves the current audio file format.

G¶

• function expression_traits<strided_channel<T>>::get_shape()
• function expression_traits<strided_channel<T>>::get_shape(const strided_channel<T> &)

H¶

• function audio_decoder::has_chunk(std::span<const std::byte>) Checks if the file contains a chunk with the specified ID.

I¶

• function audio_filter::iir(size_t, const biquad_section<fbase> &) Creates an audio filter using a single IIR biquad section for all channels.
• function audio_filter::iir(size_t, const iir_params<fbase, tag_dynamic_vector> &) Creates an audio filter using IIR biquad sections for all channels.
• function audio_data<IsInterleaved>::interleaved() Returns a reference to the interleaved audio data.
• function audio_data<IsInterleaved>::is_silent(fbase) Checks whether all samples in the buffer are effectively silent within a given amplitude threshold.

M¶

• function audio_data<IsInterleaved>::multiply(fbase) Multiplies the audio data by a specified scalar value.

N¶

• function audio_data<IsInterleaved>::normalize(fbase) Normalizes the audio data to a target peak amplitude.

O¶

• function audio_decoder::open(const file_path &) Opens an audio file from a file path and retrieves its format.
• function audio_encoder::open(const file_path &, const audiofile_format &, audio_decoder *) Opens the encoder with a file path and format.
• function audio_decoder::open(const std::string &) Opens an audio file using a UTF-8 encoded string path (Windows-specific).
• function audio_encoder::open(const std::string &, const audiofile_format &, audio_decoder *) Opens the encoder with a string path and format (Windows-specific).
• function audio_decoder::open(std::shared_ptr<binary_reader>) Opens an audio file using a binary reader and retrieves its format.
• function audio_encoder::open(std::shared_ptr<binary_writer>, const audiofile_format &, audio_decoder *) Opens the encoder with a binary writer and format.
• function audio_dithering_state::operator()() Generates one dither sample according to the configured method.
• function audio_data<IsInterleaved>::operator=(audio_data<IsInterleaved> &&)
• function audio_data<IsInterleaved>::operator==(const audio_data<IsInterleaved> &)
• function audio_data<IsInterleaved>::operator=(const audio_data<IsInterleaved> &)
• function audiofile_format::operator==(const audiofile_format &)

P¶

• function audio_data<IsInterleaved>::pointers() Retrieves an array of pointers to the base type of the audio data.
• function audio_data<IsInterleaved>::prepend(const audio_data<IsInterleaved> &) Prepends samples from a buffer with the opposite layout.

R¶

• function audio_decoder::read_all() Reads the entire audio stream into an interleaved buffer.
• function audio_decoder::read_all_planar() Reads the entire audio stream into a planar buffer.
• function audio_decoder::read_buffered(const audio_data_interleaved &, const std::function<expected<audio_data_interleaved, audiofile_error> ()> &, audio_data_interleaved &) Reads audio frames into a buffer using a custom read function.
• function audio_decoder::read_chunk_bytes(std::span<const std::byte>) Reads a RIFF chunk into a byte vector.
• function audio_decoder::read_chunk(std::span<const std::byte>, const std::function<bool (std::span<const std::byte>)> &, size_t) Reads a RIFF chunk by its identifier.
• function audio_decoder::read_to(const audio_data_interleaved &) Reads audio frames into an interleaved buffer.
• function audio_decoder::reader() Retrieves the binary reader associated with the decoder.
• function audio_decoder::read(size_t) Reads up to a maximum number of audio frames into a newly allocated buffer.
• function audio_data<IsInterleaved>::reserve(size_t) Increases the allocated capacity, preserving existing samples.
• function audio_data<IsInterleaved>::reset() Resets the object to its default state.
• function audio_filter::reset() Resets the internal state of all per-channel filter instances.
• function audio_data<IsInterleaved>::resize(size_t) Resizes the container to hold exactly new_size elements.
• function audio_data<IsInterleaved>::resize(size_t, fbase) Resize to the specified length and initialize newly added samples.

S¶

• function audiofile_format::sample_type()
• function audiofile_format::sample_type_lpcm()
• function audio_decoder::seek_is_precise() Determines whether seeking is precise for this decoder.
• function audio_decoder::seek(uint64_t) Seeks to a specific sample position in the audio stream.
• function audio_data<IsInterleaved>::select_channel(size_t) Selects a single channel view, referencing the original data and retaining the deallocator.
• function audio_data<IsInterleaved>::select_channels(size_t, size_t) Selects a range of channels [min_ch, max_ch], referencing the original data and retaining the deallocator.
• function audio_data<IsInterleaved>::slice_past_end(size_t) Creates a new audio_data object representing a slice of audio data starting past the end of the current data.
• function audio_data<IsInterleaved>::slice(size_t, size_t) Creates a slice of the audio data starting at a specified position and with a specified length.
• function audio_data<IsInterleaved>::stat() Retrieves the statistical information of the audio data.
• function audio_data<IsInterleaved>::swap(audio_data<IsInterleaved> &) Exchanges the contents of this buffer with other.
• function audio_data<IsInterleaved>::swap(audio_data<IsInterleaved> &, audio_data<IsInterleaved> &) Swaps two audio_data buffers.

T¶

• function audio_data<IsInterleaved>::to_interleaved() Returns an interleaved copy of this audio data.
• function audio_data<IsInterleaved>::to_mono() Downmixes all channels to a single mono channel by averaging.
• function audio_data<IsInterleaved>::to_planar() Returns a planar copy of this audio data.
• function audio_data<IsInterleaved>::total_samples() Calculates the total number of audio samples.
• function audio_data<IsInterleaved>::truncate(size_t) Truncates the audio data to the specified length.

V¶

• function audiofile_format::valid()

W¶

• function audio_encoder::write(const audio_data_interleaved &) Writes a chunk of interleaved audio data to the encoder.
• function audio_encoder::writer() Retrieves the binary writer associated with the encoder.