Audio Processing¶

Audio-specific processing, codecs, and format handling.

A¶

• enum constant audiofile_container::aiff
• struct aiff_decoding_options Options for decoding AIFF audio files.
• struct aiff_encoding_options Represents options for AIFF audio encoding.
• enum constant audiofile_codec::alac
• function audio_data<IsInterleaved>::append(const audio_data<IsInterleaved> &) Appends samples from a buffer with the opposite layout.
• typedef audio_data_interleaved Alias for audio_data with interleaved storage.
• typedef audio_data_planar Alias for audio_data with planar (non-interleaved) storage format.
• class audio_data<IsInterleaved> Contiguous audio buffer with optional interleaving.
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>()
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>(audio_data<IsInterleaved> &&)
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>(const audio_data<!IsInterleaved> &) Converts between planar and interleaved layouts.
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>(fbase *, size_t, size_t) Constructs an interleaved audio_data view from an external buffer.
• 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.
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>(size_t, size_t) Constructs an audio_data buffer with the specified channel count and optional initial size.
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>(size_t, size_t, fbase) Constructs an audio buffer and initializes all samples to a constant value.
• constructor audio_data<IsInterleaved>::audio_data<IsInterleaved>(std::span<fbase *const>, size_t) Constructs a planar audio_data view from external channel pointers.
• 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.
• struct audio_decoder Abstract base class for audio decoders providing methods for opening and reading audio files.
• destructor audio_decoder::~audio_decoder()
• constructor audio_decoder::audio_decoder()
• struct audio_decoding_options Options for generic audio decoding.
• enum audio_dithering Supported audio dithering methods.
• struct audio_dithering_state Represents the state of audio dithering.
• struct audio_encoder Abstract base class for audio encoders, providing methods for opening, writing, and closing audio files.
• destructor audio_encoder::~audio_encoder() Destructor to close and finalize file encoding.
• struct audio_encoding_options Represents options for audio encoding, including dithering settings.
• struct audio_quantization Represents audio quantization parameters.
• constructor audio_quantization::audio_quantization(int, audio_dithering) Constructs quantization parameters for the given bit depth and dithering method.
• struct audio_stat Represents audio statistics such as peak and RMS values.
• variable audio_writing_software Software string to write into metadata, if supported by format
• enum audiofile_codec Supported audio file codecs.
• enum audiofile_container Supported audio file container formats.
• function audiofile_container_from_extension(std::string_view) Determines the audio container type from a file extension.
• enum audiofile_endianness Endianness of audio data.
• struct audiofile_format Represents the format of an audio file.
• typedef audiofile_header Represents a fixed-size audio file header.

B¶

• enum constant audiofile_endianness::big
• variable audiofile_format::bit_depth Bits per sample.
• enum constant audiofile_container::bw64 BW64 as per EBU Tech 3285 v2 (no metadata support yet)
• function audiofile_format::bytes_per_pcm_frame()

C¶

• enum constant audiofile_container::caf Apple CAF
• struct caff_decoding_options Options for decoding CAFF audio files.
• struct caff_encoding_options Represents options for CAFF audio encoding.
• variable audio_data<IsInterleaved>::capacity Allocated capacity per channel.
• typedef chan Determines the channel type based on interleaving.
• function audio_data<IsInterleaved>::channel_count() Retrieves the number of audio channels.
• variable audiofile_format::channels Number of channels.
• variable audio_data<IsInterleaved>::channels Number of channels.
• function audio_data<IsInterleaved>::channel(size_t) Retrieves a reference to the audio data of a specific channel.
• function audio_data<IsInterleaved>::clear() Clears all audio data, leaving the container empty (size == 0).
• function audio_decoder::close() Closes the audio file and releases resources.
• function audio_encoder::close() Closes the encoder and finalizes the file.
• variable audiofile_format::codec Audio codec.
• variable audiofile_format::container Container format.
• function create_aiff_decoder(const aiff_decoding_options &) Creates a decoder for AIFF audio files.
• function create_aiff_encoder(const aiff_encoding_options &) Creates an AIFF audio encoder with optional encoding options.
• function create_caff_decoder(const caff_decoding_options &) Creates a decoder for CAFF audio files.
• function create_caff_encoder(const caff_encoding_options &) Creates a CAFF audio encoder with optional encoding options.
• function create_decoder_for_container(audiofile_container, const audio_decoding_options &) Creates an audio decoder for a specific container type.
• function create_decoder_for_file(const file_path &, const audio_decoding_options &) Creates an audio decoder for a file.
• function create_decoder_from_header(const audiofile_header &, const audio_decoding_options &) Creates an audio decoder from a file header.
• function create_encoder_for_container(audiofile_container, const audio_encoding_options &) Creates an audio encoder for the specified container format with optional encoding options.
• function create_flac_decoder(const flac_decoding_options &) Creates a decoder for FLAC audio files.
• function create_flac_encoder(const flac_encoding_options &) Creates a FLAC audio encoder with optional encoding options.
• function create_mp3_decoder(const mp3_decoding_options &) Creates an MP3 audio decoder with the specified decoding options.
• function create_raw_decoder(const raw_decoding_options &) Creates a decoder for raw audio streams.
• function create_raw_encoder(const raw_encoding_options &) Creates a raw audio encoder with optional encoding options.
• function create_w64_decoder(const w64_decoding_options &) Creates a decoder for W64 audio files.
• function create_w64_encoder(const w64_encoding_options &) Creates a W64 audio encoder with optional encoding options.
• function create_wave_decoder(const wave_decoding_options &) Creates a decoder for WAVE audio files.
• function create_wave_encoder(const wave_encoding_options &) Creates a WAVE audio encoder with optional encoding options.

D¶

• variable strided_channel<T>::data Pointer to the first sample of the channel.
• variable audio_data<IsInterleaved>::data Pointers to channel data.
• variable audio_data<IsInterleaved>::deallocator Deallocator for the data.
• function decode_audio_file(const file_path &, audiofile_format *, const audio_decoding_options &) Decodes an audio file and returns the audio data in an interleaved format.
• variable expression_traits<strided_channel<T>>::dims
• variable audio_dithering_state::dist
• variable audio_quantization::dither Dithering state used during quantization.
• variable audio_dithering_state::dithering Active dithering method.
• variable audio_encoding_options::dithering

E¶

• function audio_data<IsInterleaved>::empty() Check whether this audio data container is empty.
• function encode_audio_file(const file_path &, const audio_data_interleaved &, const audiofile_format &, audio_decoder *, const audio_encoding_options &) Encodes interleaved audio data and writes it to a file.
• function encode_audio_file(const file_path &, const audio_data_planar &, const audiofile_format &, audio_decoder *, const audio_encoding_options &) Encodes planar audio data and writes it to a file.
• variable audiofile_format::endianness Endianness of the audio data.
• class expression_traits<strided_channel<T>>

F¶

• function audio_data<IsInterleaved>::fill(fbase) Fills the audio data with the specified value.
• function audio_data<IsInterleaved>::find_peak()
• enum constant audiofile_container::flac FLAC
• enum constant audiofile_codec::flac
• struct flac_decoding_options Options for decoding FLAC audio files.
• struct flac_encoding_options Represents options for FLAC audio encoding.
• 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.
• variable raw_decoding_options::format
• function audio_encoder::format() Retrieves the current audio file format.

G¶

• function get_elements(const strided_channel<T> &, const shape<1> &, const axis_params<0, N> &)
• 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¶

• enum constant audiofile_codec::ieee_float
• function audio_data<IsInterleaved>::interlaved() 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.
• function is_single_codec(audiofile_container) Checks if a container supports a single codec.

L¶

• function library_version_audio() Returns the full version string of the KFR audio module.
• function library_version_codecs() Returns a comma-separated list of enabled audio codecs.
• enum constant audiofile_endianness::little
• enum constant audiofile_codec::lpcm

M¶

• variable audio_decoder::m_format
• variable audio_encoder::m_format
• variable audio_decoder::m_reader
• variable audio_encoder::m_writer
• variable max_audio_channels Maximum number of channels in audio data.
• variable audiofile_format::metadata Key-value metadata pairs.
• typedef metadata_map Metadata map for storing key-value pairs.
• enum constant audiofile_container::mp3 MPEG audio
• enum constant audiofile_codec::mp3
• struct mp3_decoding_options Options for decoding MP3 audio files.
• function audio_data<IsInterleaved>::multiply(fbase) Multiplies the audio data by a specified scalar value.

N¶

• enum constant audio_dithering::none

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(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¶

• variable audio_stat::peak Peak absolute sample value across all channels.
• function audio_data<IsInterleaved>::pointers() Retrieves an array of pointers to the base type of the audio data.
• variable audio_data<IsInterleaved>::position Position of the first sample in the audio data.
• function audio_data<IsInterleaved>::prepend(const audio_data<IsInterleaved> &) Prepends samples from a buffer with the opposite layout.

R¶

• struct raw_decoding_options Options for decoding raw audio streams.
• struct raw_encoding_options Represents options for raw audio encoding.
• 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 read_audiofile_header(const file_path &) Reads the header of an audio file.
• 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.
• variable audio_decoding_options::read_metadata Whether to read metadata tags during decoding.
• 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.
• enum constant audio_dithering::rectangular
• 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_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.
• enum constant audiofile_container::rf64 RF64 by EBU
• variable audio_stat::rms Root mean square of all samples across all channels.
• variable audio_dithering_state::rnd Random number generator.

S¶

• variable audiofile_format::sample_rate Sample rate in Hz.
• function audiofile_format::sample_type()
• function audiofile_format::sample_type_lpcm()
• function samples_load(audio_sample_type, fbase *const *, const std::byte *, size_t, size_t, bool) Loads interleaved audio samples based on sample type.
• function samples_load(audio_sample_type, fbase *, const std::byte *, size_t, bool) Loads audio samples based on sample type.
• function samples_load(fbase *const *, const Tin *, size_t, size_t, bool) Loads interleaved audio samples into a planar floating-point buffer.
• function samples_load(fbase *, const Tin *, size_t, bool) Loads audio samples into a floating-point buffer.
• function samples_store(audio_sample_type, std::byte *, const fbase *const *, size_t, size_t, bool) Stores interleaved audio samples based on sample type.
• function samples_store(audio_sample_type, std::byte *, const fbase *const *, size_t, size_t, const audio_quantization &, bool) Stores interleaved audio samples based on sample type with quantization.
• function samples_store(audio_sample_type, std::byte *, const fbase *, size_t, const audio_quantization &, bool) Stores audio samples based on sample type with quantization.
• function samples_store(Tout *, const fbase *const *, size_t, size_t, bool) Stores planar floating-point samples into a interleaved buffer.
• function samples_store(Tout *, const fbase *const *, size_t, size_t, const audio_quantization &, bool) Stores planar floating-point samples into an interleaved buffer with quantization.
• function samples_store(Tout *, const fbase *, size_t, const audio_quantization &, bool) Stores floating-point samples into a buffer with quantization.
• variable audio_dithering_state::scale Amplitude scale applied to the generated noise.
• 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 set_elements(strided_channel<T> &, const shape<1> &, const axis_params<0, N> &, const std::type_identity_t<vec<T, N>> &)
• variable strided_channel<T>::size Number of samples in the channel.
• variable audio_data<IsInterleaved>::size Number of samples per channel.
• 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.
• variable audiofile_format::speakers Speaker arrangement.
• function audio_data<IsInterleaved>::stat() Retrieves the statistical information of the audio data.
• variable strided_channel<T>::stride Stride (in elements) between successive samples.
• class strided_channel<T> Represents a strided audio channel.
• 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.
• variable wave_encoding_options::switch_to_rf64_if_over_4gb

T¶

• variable audiofile_format::total_frames
• function audio_data<IsInterleaved>::total_samples() Calculates the total number of audio samples.
• enum constant audio_dithering::triangular
• function audio_data<IsInterleaved>::truncate(size_t) Truncates the audio data to the specified length.

U¶

• enum constant audiofile_container::unknown
• enum constant audiofile_codec::unknown

V¶

• function audiofile_format::valid()
• typedef expression_traits<strided_channel<T>>::value_type

W¶

• enum constant audiofile_container::w64 Sony WAVE64
• struct w64_decoding_options Options for decoding W64 audio files.
• struct w64_encoding_options Represents options for W64 audio encoding.
• enum constant audiofile_container::wave RIFF WAVE
• struct wave_decoding_options Options for decoding WAVE audio files.
• struct wave_encoding_options Represents options for WAVE audio encoding, including RF64 support for large files.
• 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.