Crate openmpt_sys

Structs

openmpt_module

openmpt_module_initial_ctl

openmpt_stream_callbacks

\brief Stream callbacks

Constants

LIBOPENMPT_DEPRECATED_STRING_CONSTANT

OPENMPT_API_VERSION_IS_PREREL

OPENMPT_API_VERSION_MAJOR

OPENMPT_API_VERSION_MINOR

OPENMPT_API_VERSION_PATCH

OPENMPT_API_VERSION_PREREL

OPENMPT_ERROR_ARGUMENT_NULL_POINTER

OPENMPT_ERROR_BASE

OPENMPT_ERROR_DOMAIN

OPENMPT_ERROR_EXCEPTION

OPENMPT_ERROR_FUNC_RESULT_DEFAULT

OPENMPT_ERROR_FUNC_RESULT_LOG

OPENMPT_ERROR_FUNC_RESULT_NONE

OPENMPT_ERROR_FUNC_RESULT_STORE

OPENMPT_ERROR_GENERAL

OPENMPT_ERROR_INVALID_ARGUMENT

OPENMPT_ERROR_INVALID_MODULE_POINTER

OPENMPT_ERROR_LENGTH

OPENMPT_ERROR_LOGIC

OPENMPT_ERROR_OK

OPENMPT_ERROR_OUT_OF_MEMORY

OPENMPT_ERROR_OUT_OF_RANGE

OPENMPT_ERROR_OVERFLOW

OPENMPT_ERROR_RANGE

OPENMPT_ERROR_RUNTIME

OPENMPT_ERROR_UNDERFLOW

OPENMPT_ERROR_UNKNOWN

OPENMPT_MODULE_COMMAND_EFFECT

OPENMPT_MODULE_COMMAND_INSTRUMENT

OPENMPT_MODULE_COMMAND_NOTE

OPENMPT_MODULE_COMMAND_PARAMETER

OPENMPT_MODULE_COMMAND_VOLUME

OPENMPT_MODULE_COMMAND_VOLUMEEFFECT

OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH

OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL

OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT

OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH

OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS

OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT

OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES

OPENMPT_PROBE_FILE_HEADER_FLAGS_NONE

OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR

OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE

OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS

OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA

OPENMPT_STREAM_SEEK_CUR

OPENMPT_STREAM_SEEK_END

OPENMPT_STREAM_SEEK_SET

Functions

openmpt_could_open_probability^⚠

\brief Roughly scan the input stream to find out whether libopenmpt might be able to open it

openmpt_could_open_probability2^⚠

\brief Roughly scan the input stream to find out whether libopenmpt might be able to open it

openmpt_could_open_propability^⚠

\brief Roughly scan the input stream to find out whether libopenmpt might be able to open it

openmpt_error_func_default^⚠

\brief Default error function

openmpt_error_func_errno^⚠

\brief Errno error function

openmpt_error_func_errno_userdata^⚠

\brief User pointer for openmpt_error_func_errno

openmpt_error_func_ignore^⚠

\brief Ignore error function

openmpt_error_func_log^⚠

\brief Log error function

openmpt_error_func_store^⚠

\brief Store error function

openmpt_error_is_transient^⚠

\brief Check whether the error is transient

openmpt_error_string^⚠

\brief Convert error code to text

openmpt_free_string^⚠

\brief Free a string returned by libopenmpt

openmpt_get_core_version^⚠

\brief Get the core version number

openmpt_get_library_version^⚠

\brief Get the libopenmpt version number

openmpt_get_string^⚠

\brief Get library related metadata.

openmpt_get_supported_extensions^⚠

\brief Get a list of supported file extensions

openmpt_is_extension_supported^⚠

\brief Query whether a file extension is supported

openmpt_log_func_default^⚠

\brief Default logging function

openmpt_log_func_silent^⚠

\brief Silent logging function

openmpt_module_create^⚠

\brief Construct an openmpt_module

openmpt_module_create2^⚠

\brief Construct an openmpt_module

openmpt_module_create_from_memory^⚠

\brief Construct an openmpt_module

openmpt_module_create_from_memory2^⚠

\brief Construct an openmpt_module

openmpt_module_ctl_get^⚠

\brief Get current ctl value

openmpt_module_ctl_get_boolean^⚠

\brief Get current ctl boolean value

openmpt_module_ctl_get_floatingpoint^⚠

\brief Get current ctl floatingpoint value

openmpt_module_ctl_get_integer^⚠

\brief Get current ctl integer value

openmpt_module_ctl_get_text^⚠

\brief Get current ctl string value

openmpt_module_ctl_set^⚠

\brief Set ctl value

openmpt_module_ctl_set_boolean^⚠

\brief Set ctl boolean value

openmpt_module_ctl_set_floatingpoint^⚠

\brief Set ctl floatingpoint value

openmpt_module_ctl_set_integer^⚠

\brief Set ctl integer value

openmpt_module_ctl_set_text^⚠

\brief Set ctl string value

openmpt_module_destroy^⚠

\brief Unload a previously created openmpt_module from memory.

openmpt_module_error_clear^⚠

\brief Clear last error.

openmpt_module_error_get_last^⚠

\brief Get last error.

openmpt_module_error_get_last_message^⚠

\brief Get last error message.

openmpt_module_error_set_last^⚠

\brief Set last error.

openmpt_module_format_pattern_row_channel^⚠

\brief Get formatted (human-readable) pattern content

openmpt_module_format_pattern_row_channel_command^⚠

\brief Get formatted (human-readable) pattern content

openmpt_module_get_channel_name^⚠

\brief Get a channel name

openmpt_module_get_ctls^⚠

\brief Retrieve supported ctl keys

openmpt_module_get_current_channel_vu_left^⚠

\brief Get an approximate indication of the channel volume on the front-left speaker.

openmpt_module_get_current_channel_vu_mono^⚠

\brief Get an approximate indication of the channel volume.

openmpt_module_get_current_channel_vu_rear_left^⚠

\brief Get an approximate indication of the channel volume on the rear-left speaker.

openmpt_module_get_current_channel_vu_rear_right^⚠

\brief Get an approximate indication of the channel volume on the rear-right speaker.

openmpt_module_get_current_channel_vu_right^⚠

\brief Get an approximate indication of the channel volume on the front-right speaker.

openmpt_module_get_current_estimated_bpm^⚠

Get the current estimated beats per minute (BPM).

openmpt_module_get_current_order^⚠

\brief Get the current order

openmpt_module_get_current_pattern^⚠

\brief Get the current pattern

openmpt_module_get_current_playing_channels^⚠

\brief Get the current amount of playing channels.

openmpt_module_get_current_row^⚠

\brief Get the current row

openmpt_module_get_current_speed^⚠

\brief Get the current speed

openmpt_module_get_current_tempo^⚠

\brief Get the current tempo

openmpt_module_get_duration_seconds^⚠

\brief approximate song duration

openmpt_module_get_instrument_name^⚠

\brief Get an instrument name

openmpt_module_get_metadata^⚠

\brief Get a metadata item value

openmpt_module_get_metadata_keys^⚠

\brief Get the list of supported metadata item keys

openmpt_module_get_num_channels^⚠

\brief Get the number of pattern channels

openmpt_module_get_num_instruments^⚠

\brief Get the number of instruments

openmpt_module_get_num_orders^⚠

\brief Get the number of orders

openmpt_module_get_num_patterns^⚠

\brief Get the number of patterns

openmpt_module_get_num_samples^⚠

\brief Get the number of samples

openmpt_module_get_num_subsongs^⚠

\brief Get the number of sub-songs

openmpt_module_get_order_name^⚠

\brief Get an order name

openmpt_module_get_order_pattern^⚠

\brief Get pattern at order position

openmpt_module_get_pattern_name^⚠

\brief Get a pattern name

openmpt_module_get_pattern_num_rows^⚠

\brief Get the number of rows in a pattern

openmpt_module_get_pattern_row_channel_command^⚠

\brief Get raw pattern content

openmpt_module_get_position_seconds^⚠

\brief Get current song position

openmpt_module_get_render_param^⚠

\brief Get render parameter

openmpt_module_get_repeat_count^⚠

\brief Get Repeat Count

openmpt_module_get_sample_name^⚠

\brief Get a sample name

openmpt_module_get_selected_subsong^⚠

\brief Get currently selected sub-song from a multi-song module

openmpt_module_get_subsong_name^⚠

\brief Get a sub-song name

openmpt_module_highlight_pattern_row_channel^⚠

\brief Get highlighting information for formatted pattern content

openmpt_module_highlight_pattern_row_channel_command^⚠

\brief Get highlighting information for formatted pattern content

openmpt_module_read_float_mono^⚠

\brief Render audio data

openmpt_module_read_float_quad^⚠

\brief Render audio data

openmpt_module_read_float_stereo^⚠

\brief Render audio data

openmpt_module_read_interleaved_float_quad^⚠

\brief Render audio data

openmpt_module_read_interleaved_float_stereo^⚠

\brief Render audio data

openmpt_module_read_interleaved_quad^⚠

\brief Render audio data

openmpt_module_read_interleaved_stereo^⚠

\brief Render audio data

openmpt_module_read_mono^⚠

\brief Render audio data

openmpt_module_read_quad^⚠

\brief Render audio data

openmpt_module_read_stereo^⚠

\brief Render audio data

openmpt_module_select_subsong^⚠

\brief Select a sub-song from a multi-song module

openmpt_module_set_error_func^⚠

\brief Set error function.

openmpt_module_set_log_func^⚠

\brief Set logging function.

openmpt_module_set_position_order_row^⚠

\brief Set approximate current song position

openmpt_module_set_position_seconds^⚠

\brief Set approximate current song position

openmpt_module_set_render_param^⚠

\brief Set render parameter

openmpt_module_set_repeat_count^⚠

\brief Set Repeat Count

openmpt_probe_file_header^⚠

\brief Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it

openmpt_probe_file_header_from_stream^⚠

\brief Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it

openmpt_probe_file_header_get_recommended_size^⚠

\brief Get recommended header size for successfull format probing

openmpt_probe_file_header_without_filesize^⚠

\brief Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it

Type Aliases

openmpt_error_func

\brief Error function

openmpt_log_func

\brief Logging function

openmpt_stream_read_func

\brief Read bytes from stream

openmpt_stream_seek_func

\brief Seek stream position

openmpt_stream_tell_func

\brief Tell stream position