Functions¶

A¶

• function audiofile_container_from_extension(std::string_view) Determines the audio container type from a file extension.

C¶

• 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_coreaudio_decoder(const coreaudio_decoding_options &) Creates a Core Audio-based audio decoder.
• 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_for_file(const std::string &, const audio_decoding_options &)
• 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_mediafoundation_decoder(const mediafoundation_decoding_options &) Creates a Media Foundation-based audio decoder.
• 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¶

• 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.
• function decode_audio_file(const std::string &, audiofile_format *, const audio_decoding_options &)

E¶

• 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.
• function 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 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).

G¶

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

I¶

• 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.

R¶

• function read_audiofile_header(const file_path &) Reads the header of an audio file.
• function read_audiofile_header(const std::string &) Creates an audio decoder from a file header.

S¶

• 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.
• function set_elements(strided_channel<T> &, const shape<1> &, const axis_params<0, N> &, const std::type_identity_t<vec<T, N>> &)