Group: audio¶

A¶

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

B¶

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

C¶

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

D¶

• variable kfr::strided_channel<T>::data
• variable kfr::audio_data<Interleaved>::data Pointers to channel data.
• variable kfr::audio_data<Interleaved>::deallocator Deallocator for the data.
• function kfr::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.
• function kfr::decode_audio_file(const std::string &, audiofile_format *, const audio_decoding_options &)
• variable kfr::default_audio_frames_to_read The default number of audio frames to read in one operation.
• variable kfr::expression_traits<strided_channel<T>>::dims
• variable kfr::audio_dithering_state::dist
• variable kfr::audio_quantization::dither
• variable kfr::audio_dithering_state::dithering
• variable kfr::audio_encoding_options::dithering

E¶

• function kfr::audio_data<Interleaved>::empty() Check whether this audio data container is empty.
• enum constant kfr::audiofile_error::empty_file The file is empty or does not contain any audio data
• function kfr::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 kfr::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.
• function kfr::encode_audio_file(const std::string &, const audio_data_interleaved &, const audiofile_format &, audio_decoder *, const audio_encoding_options &) Encodes interleaved audio data and writes it to a file (Windows-specific overload).
• function kfr::encode_audio_file(const std::string &, const audio_data_planar &, const audiofile_format &, audio_decoder *, const audio_encoding_options &) Encodes planar audio data and writes it to a file (Windows-specific overload).
• enum constant kfr::audiofile_error::end_of_file End of file reached
• variable kfr::audiofile_format::endianness Endianness of the audio data.
• class kfr::expression_traits<strided_channel<T>>

F¶

• function kfr::audio_data<Interleaved>::fill(fbase) Fills the audio data with the specified value.
• function kfr::audio_data<Interleaved>::find_peak()
• enum constant kfr::audiofile_container::flac FLAC
• enum constant kfr::audiofile_codec::flac
• function kfr::audio_data<Interleaved>::for_channel(Fn &&) Applies a given function to the audio data for each channel.
• function kfr::audio_decoder::format() Retrieves the format of the currently opened audio file.
• variable kfr::raw_decoding_options::format
• function kfr::audio_encoder::format() Retrieves the current audio file format.
• enum constant kfr::audiofile_error::format_error The audio file format is invalid or unsupported.
• function kfr::from_error_code(std::error_code) Converts a standard error code to an audiofile_error.

G¶

• function kfr::get_elements(const strided_channel<T> &, const shape<1> &, const axis_params<0, N> &)
• function kfr::expression_traits<strided_channel<T>>::get_shape()
• function kfr::expression_traits<strided_channel<T>>::get_shape(const strided_channel<T> &)

H¶

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

I¶

• enum constant kfr::audiofile_codec::ieee_float
• function kfr::audio_data<Interleaved>::interlaved() Returns a reference to the interleaved audio data.
• enum constant kfr::audiofile_error::internal_error An internal error occurred.
• enum constant kfr::audiofile_error::invalid_argument Invalid argument passed
• enum constant kfr::audiofile_error::io_error An input/output error occurred.
• function kfr::audio_data<Interleaved>::is_silent(fbase) Checks whether all samples in the buffer are effectively silent within a given amplitude threshold.
• function kfr::is_single_codec(audiofile_container) Checks if a container supports a single codec.

L¶

• enum constant kfr::audiofile_endianness::little
• enum constant kfr::audiofile_codec::lpcm

M¶

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

N¶

• enum constant kfr::audio_dithering::none
• enum constant kfr::audiofile_error::not_found The file was not found
• enum constant kfr::audiofile_error::not_implemented Not implemented

O¶

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

P¶

• variable kfr::audio_stat::peak
• function kfr::audio_data<Interleaved>::pointers() Retrieves an array of pointers to the base type of the audio data.
• variable kfr::audio_data<Interleaved>::position Position of the first sample in the audio data.
• function kfr::audio_data<Interleaved>::prepend(const audio_data<!Interleaved> &)

R¶

• struct kfr::raw_decoding_options Options for decoding raw audio streams.
• struct kfr::raw_encoding_options Represents options for raw audio encoding.
• function kfr::audio_decoder::read_all() Reads the entire audio stream into an interleaved buffer.
• function kfr::audio_decoder::read_all_planar() Reads the entire audio stream into a planar buffer.
• function kfr::read_audiofile_header(const file_path &) Reads the header of an audio file.
• function kfr::read_audiofile_header(const std::string &) Creates an audio decoder from a file header.
• function kfr::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 kfr::audio_decoder::read_chunk_bytes(std::span<const std::byte>) Reads a RIFF chunk into a byte vector.
• function kfr::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 kfr::audio_decoding_options::read_metadata Whether to read metadata tags during decoding.
• function kfr::audio_decoder::read_to(const audio_data_interleaved &) Reads audio frames into an interleaved buffer.
• function kfr::audio_decoder::reader() Retrieves the binary reader associated with the decoder.
• function kfr::audio_decoder::read(size_t) Reads up to a maximum number of audio frames into a newly allocated buffer.
• enum constant kfr::audio_dithering::rectangular
• function kfr::audio_data<Interleaved>::reserve(size_t)
• function kfr::audio_data<Interleaved>::reset() Resets the object to its default state.
• function kfr::audio_data<Interleaved>::resize(size_t) Resizes the container to hold exactly new_size elements.
• function kfr::audio_data<Interleaved>::resize(size_t, fbase) Resize to the specified length and initialize newly added samples.
• enum constant kfr::audiofile_container::rf64 RF64 by EBU
• variable kfr::audio_stat::rms
• variable kfr::audio_dithering_state::rnd

S¶

• variable kfr::audiofile_format::sample_rate Sample rate in Hz.
• function kfr::audiofile_format::sample_type()
• function kfr::audiofile_format::sample_type_lpcm()
• function kfr::samples_load(audio_sample_type, fbase *const *, const std::byte *, size_t, size_t, bool) Loads interleaved audio samples based on sample type.
• function kfr::samples_load(audio_sample_type, fbase *, const std::byte *, size_t, bool) Loads audio samples based on sample type.
• function kfr::samples_load(fbase *const *, const Tin *, size_t, size_t, bool) Loads interleaved audio samples into a planar floating-point buffer.
• function kfr::samples_load(fbase *, const Tin *, size_t, bool) Loads audio samples into a floating-point buffer.
• function kfr::samples_store(audio_sample_type, std::byte *, const fbase *const *, size_t, size_t, bool) Stores interleaved audio samples based on sample type.
• function kfr::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 kfr::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 kfr::samples_store(Tout *, const fbase *const *, size_t, size_t, bool) Stores planar floating-point samples into a interleaved buffer.
• function kfr::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 kfr::samples_store(Tout *, const fbase *, size_t, const audio_quantization &, bool) Stores floating-point samples into a buffer with quantization.
• variable kfr::audio_dithering_state::scale
• function kfr::audio_decoder::seek_is_precise() Determines whether seeking is precise for this decoder.
• function kfr::audio_decoder::seek(uint64_t) Seeks to a specific sample position in the audio stream.
• function kfr::set_elements(strided_channel<T> &, const shape<1> &, const axis_params<0, N> &, const std::type_identity_t<vec<T, N>> &)
• variable kfr::strided_channel<T>::size
• variable kfr::audio_data<Interleaved>::size Number of samples per channel.
• function kfr::audio_data<Interleaved>::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 kfr::audio_data<Interleaved>::slice(size_t, size_t) Creates a slice of the audio data starting at a specified position and with a specified length.
• variable kfr::audiofile_format::speakers Speaker arrangement.
• function kfr::audio_data<Interleaved>::stat() Retrieves the statistical information of the audio data.
• variable kfr::strided_channel<T>::stride
• class kfr::strided_channel<T> Represents a strided audio channel.
• function kfr::audio_data<Interleaved>::swap(audio_data<Interleaved> &)
• function kfr::audio_data<Interleaved>::swap(audio_data<Interleaved> &, audio_data<Interleaved> &)
• variable kfr::wave_encoding_options::switch_to_rf64_if_over_4gb

T¶

• function kfr::to_string(audiofile_error) Converts an audiofile_error to its string representation.
• enum constant kfr::audiofile_error::too_large data chunk too large for standard WAV
• variable kfr::audiofile_format::total_frames
• function kfr::audio_data<Interleaved>::total_samples() Calculates the total number of audio samples.
• enum constant kfr::audio_dithering::triangular
• function kfr::audio_data<Interleaved>::truncate(size_t) Truncates the audio data to the specified length.

U¶

• enum constant kfr::audiofile_container::unknown
• enum constant kfr::audiofile_codec::unknown
• enum constant kfr::audiofile_error::unknown An unknown error occurred

V¶

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

W¶

• enum constant kfr::audiofile_container::w64 Sony WAVE64
• struct kfr::w64_decoding_options Options for decoding W64 audio files.
• struct kfr::w64_encoding_options Represents options for W64 audio encoding.
• enum constant kfr::audiofile_container::wave RIFF WAVE
• struct kfr::wave_decoding_options Options for decoding WAVE audio files.
• struct kfr::wave_encoding_options Represents options for WAVE audio encoding, including RF64 support for large files.
• function kfr::audio_encoder::write(const audio_data_interleaved &) Writes a chunk of interleaved audio data to the encoder.
• function kfr::audio_encoder::writer() Retrieves the binary writer associated with the encoder.