Input/Output¶

File I/O, audio format support, and data visualization tools.

A¶

• enum constant audiofile_error::abort Operation aborted
• class abstract_reader<T> Base class for all typed readers
• class abstract_stream<T> Base class for all typed readers and writer
• destructor abstract_stream<T>::~abstract_stream<T>()
• class abstract_writer<T> Base class for all typed writers
• enum constant audiofile_error::access_denied Access to the file was denied
• enum constant open_file_mode::append_existing
• struct audio_format
• struct audio_format_and_length
• constructor audio_format_and_length::audio_format_and_length()
• constructor audio_format_and_length::audio_format_and_length(const audio_format &)
• struct audio_reader_flac<f32>
• struct audio_reader_flac<f64>
• struct audio_reader_flac<i16>
• struct audio_reader_flac<i24>
• struct audio_reader_flac<i32>
• class audio_reader_flac<T> FLAC format reader
• destructor audio_reader_flac<T>::~audio_reader_flac<T>()
• constructor audio_reader_flac<T>::audio_reader_flac<T>(std::shared_ptr<abstract_reader<>> &&) Constructs FLAC reader
• struct audio_reader_mp3<f32>
• struct audio_reader_mp3<f64>
• struct audio_reader_mp3<i16>
• struct audio_reader_mp3<i24>
• struct audio_reader_mp3<i32>
• class audio_reader_mp3<T> MP3 format reader
• destructor audio_reader_mp3<T>::~audio_reader_mp3<T>()
• constructor audio_reader_mp3<T>::audio_reader_mp3<T>(std::shared_ptr<abstract_reader<>> &&) Constructs MP3 reader
• struct audio_reader_wav<f32>
• struct audio_reader_wav<f64>
• struct audio_reader_wav<i16>
• struct audio_reader_wav<i24>
• struct audio_reader_wav<i32>
• class audio_reader_wav<T> WAV format reader
• destructor audio_reader_wav<T>::~audio_reader_wav<T>()
• constructor audio_reader_wav<T>::audio_reader_wav<T>(std::shared_ptr<abstract_reader<>> &&) Constructs WAV reader
• class audio_reader<T>
• struct audio_writer_wav<f32>
• struct audio_writer_wav<f64>
• struct audio_writer_wav<i16>
• struct audio_writer_wav<i24>
• struct audio_writer_wav<i32>
• class audio_writer_wav<T> WAV format writer
• destructor audio_writer_wav<T>::~audio_writer_wav<T>()
• constructor audio_writer_wav<T>::audio_writer_wav<T>(std::shared_ptr<abstract_writer<>> &&, const audio_format &) Constructs WAV writer using target writer and format
• class audio_writer<T>
• enum audiofile_error Enumerates possible error codes for audio file operations.

B¶

• enum constant seek_origin::begin From the beginning
• typedef binary_reader Binary reader
• typedef binary_writer Binary writer
• typedef byte_reader Byte reader
• typedef byte_writer Byte writer

C¶

• variable audio_format::channels
• function audio_writer<T>::close() Finishes writing and closes underlying writer
• function audio_writer_wav<T>::close()
• enum constant audiofile_error::closed The audio file is closed
• function concat_args()
• function concat_args(const std::string &, const Ts &...)
• variable audio_reader_mp3<T>::config
• enum constant seek_origin::current From the current position

D¶

• function dB_to_string(const T &, double) Converts dB value to string (uses oo for infinity symbol)
• function dB_to_utf8string(const T &, double) Converts dB value to string (uses infinity symbol in utf-8 encoding)
• variable default_audio_frames_to_read The default number of audio frames to read in one operation.

E¶

• function element_size()
• function element_size<>()
• enum constant audiofile_error::empty_file The file is empty or does not contain any audio data
• enum constant seek_origin::end From the end
• enum constant audiofile_error::end_of_file End of file reached

F¶

• typedef f32_reader float reader
• typedef f32_writer float writer
• variable file_handle::file
• function file_extension(const file_path &)
• struct file_handle
• constructor file_handle::file_handle()
• destructor file_handle::~file_handle()
• constructor file_handle::file_handle(const file_handle &)
• constructor file_handle::file_handle(FILE *)
• constructor file_handle::file_handle(file_handle &&)
• typedef file_path
• class file_reader<T> Typed file reader
• destructor file_reader<T>::~file_reader<T>()
• constructor file_reader<T>::file_reader<T>(file_handle &&)
• class file_writer<T> Typed file writer
• destructor file_writer<T>::~file_writer<T>()
• constructor file_writer<T>::file_writer<T>(file_handle &&)
• typedef filepath
• function fopen_path(const file_path &, open_file_mode)
• function audio_reader<T>::format() Returns audio format description
• function audio_writer<T>::format() Returns audio format description
• function audio_writer_wav<T>::format()
• function audio_reader_wav<T>::format() Returns audio format description
• function audio_reader_flac<T>::format() Returns audio format description
• function audio_reader_mp3<T>::format() Returns audio format description
• enum constant audiofile_error::format_error The audio file format is invalid or unsupported.
• function from_error_code(std::error_code) Converts a standard error code to an audiofile_error.

G¶

• function representation<kfr::special_value>::get(const kfr::special_value &)
• function representation<kfr::cpu_t>::get(kfr::cpu_t)

H¶

• variable file_reader<T>::handle
• variable file_writer<T>::handle

I¶

• enum constant audiofile_error::internal_error An internal error occurred.
• enum constant audiofile_error::invalid_argument Invalid argument passed
• enum constant audiofile_error::io_error An input/output error occurred.

K¶

• macro KFR_FILEPATH
• macro KFR_IO_SEEK_64
• macro KFR_IO_TELL_64

L¶

• variable audio_format_and_length::length
• function library_version_io() Returns the full version string of the KFR IO module.

M¶

• class memory_reader<T>
• constructor memory_reader<T>::memory_reader<T>(std::span<const T>)
• class memory_writer<T>
• constructor memory_writer<T>::memory_writer<T>(std::span<T>)
• struct mp3_config

N¶

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

O¶

• function open_file_for_appending(const filepath &) Opens typed file for appending
• function open_file_for_reading(const filepath &) Opens typed file for reading
• function open_file_for_writing(const filepath &) Opens typed file for writing
• enum open_file_mode
• variable mp3_config::outputChannels
• variable mp3_config::outputSampleRate

P¶

• function perfplot_save(const std::string &, T1 &&, T2 &&, const std::string &)
• function perfplot_show(const std::string &, T1 &&, T2 &&, const std::string &)
• function plot_save(const std::string &, const T &, const std::string &) Plot data using python and save to file
• function plot_show(const std::string &, const char *, const std::string &)
• function plot_show(const std::string &, const std::string &, const std::string &)
• function plot_show(const std::string &, const T &, const std::string &) Plot data using python
• function python_prologue()

R¶

• function audio_reader<T>::read_channels()
• function audio_reader<T>::read_channels(size_t)
• enum constant open_file_mode::read_existing
• enum constant open_file_mode::read_write_existing
• enum constant open_file_mode::read_write_new
• variable reader_adapter<From, To>::reader
• class reader_adapter<From, To>
• constructor reader_adapter<From, To>::reader_adapter<From, To>(std::shared_ptr<abstract_reader<From>>)
• function abstract_reader<T>::read(size_t)
• function reader_adapter<From, To>::read(To *, size_t)
• function abstract_reader<T>::read(T *, size_t)
• function memory_reader<T>::read(T *, size_t)
• function file_reader<T>::read(T *, size_t)
• function audio_reader_wav<T>::read(T *, size_t) Reads and decodes audio data
• function audio_reader_flac<T>::read(T *, size_t) Reads and decodes audio data
• function audio_reader_mp3<T>::read(T *, size_t) Reads and decodes audio data
• function abstract_reader<T>::read(U &)
• struct representation<kfr::cpu_t>
• struct representation<kfr::special_value>

S¶

• variable audio_format::samplerate
• variable reader_adapter<From, To>::scale
• variable writer_adapter<From, To>::scale
• enum seek_origin Seek origin
• function audio_writer_wav<T>::seek(imax, seek_origin)
• function audio_reader_wav<T>::seek(imax, seek_origin) Seeks to specific sample
• function audio_reader_flac<T>::seek(imax, seek_origin) Seeks to specific sample
• function audio_reader_mp3<T>::seek(imax, seek_origin) Seeks to specific sample
• function abstract_stream<T>::seek(int64_t, int)
• function abstract_stream<T>::seek(int64_t, seek_origin)
• function memory_reader<T>::seek(int64_t, seek_origin)
• function memory_writer<T>::seek(int64_t, seek_origin)
• function reader_adapter<From, To>::seek(int64_t, seek_origin)
• function writer_adapter<From, To>::seek(int64_t, seek_origin)
• function file_reader<T>::seek(int64_t, seek_origin)
• function file_writer<T>::seek(int64_t, seek_origin)
• function abstract_stream<T>::size()
• function memory_reader<T>::size()
• function memory_writer<T>::size()
• function reader_adapter<From, To>::size()
• function writer_adapter<From, To>::size()
• function file_handle::swap(file_handle &)

T¶

• function abstract_stream<T>::tell()
• function memory_reader<T>::tell()
• function memory_writer<T>::tell()
• function reader_adapter<From, To>::tell()
• function writer_adapter<From, To>::tell()
• function file_reader<T>::tell()
• function file_writer<T>::tell()
• function audio_writer_wav<T>::tell()
• function audio_reader_wav<T>::tell() Returns current position
• function audio_reader_flac<T>::tell() Returns current position
• function audio_reader_mp3<T>::tell() Returns current position
• function to_string(audiofile_error) Converts an audiofile_error to its string representation.
• enum constant audiofile_error::too_large data chunk too large for standard WAV
• variable audio_format::type
• typedef representation<kfr::special_value>::type
• typedef representation<kfr::cpu_t>::type

U¶

• enum constant audiofile_error::unknown An unknown error occurred
• variable audio_format::use_w64

W¶

• function audio_writer<T>::write_channels(const univector2d<T, Tag1, Tag2> &)
• enum constant open_file_mode::write_new
• function writer_adapter<From, To>::write(const To *, size_t)
• function abstract_writer<T>::write(const T *, size_t)
• function memory_writer<T>::write(const T *, size_t)
• function file_writer<T>::write(const T *, size_t)
• function audio_writer_wav<T>::write(const T *, size_t) Write data to underlying binary writer data is PCM samples in interleaved format size is the number of samples (PCM frames * channels)
• function abstract_writer<T>::write(const U &)
• variable writer_adapter<From, To>::writer
• class writer_adapter<From, To>
• constructor writer_adapter<From, To>::writer_adapter<From, To>(std::shared_ptr<abstract_writer<From>>)