libopenmpt
0.3.9+release.autotools
cross-platform C++ and C library to decode tracked music files
|
Namespaces | |
ext | |
string | |
Classes | |
class | exception |
libopenmpt exception base class More... | |
class | module |
class | module_ext |
Enumerations | |
enum | probe_file_header_result { probe_file_header_result_success = 1, probe_file_header_result_failure = 0, probe_file_header_result_wantmoredata = -1 } |
Possible return values for openmpt::probe_file_header(). More... | |
Functions | |
LIBOPENMPT_CXX_API std::uint32_t | get_library_version () |
Get the libopenmpt version number. More... | |
LIBOPENMPT_CXX_API std::uint32_t | get_core_version () |
Get the core version number. More... | |
LIBOPENMPT_CXX_API std::vector< std::string > | get_supported_extensions () |
Get a list of supported file extensions. More... | |
LIBOPENMPT_CXX_API bool | is_extension_supported (const std::string &extension) |
Query whether a file extension is supported. More... | |
LIBOPENMPT_CXX_API double | could_open_probability (std::istream &stream, double effort=1.0, std::ostream &log=std::clog) |
Roughly scan the input stream to find out whether libopenmpt might be able to open it. More... | |
LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API double | could_open_propability (std::istream &stream, double effort=1.0, std::ostream &log=std::clog) |
Roughly scan the input stream to find out whether libopenmpt might be able to open it. More... | |
LIBOPENMPT_CXX_API std::size_t | probe_file_header_get_recommended_size () |
Get recommended header size for successfull format probing. More... | |
LIBOPENMPT_CXX_API int | probe_file_header (std::uint64_t flags, const std::uint8_t *data, std::size_t size, std::uint64_t filesize) |
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. More... | |
LIBOPENMPT_CXX_API int | probe_file_header (std::uint64_t flags, const std::uint8_t *data, std::size_t size) |
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. More... | |
LIBOPENMPT_CXX_API int | probe_file_header (std::uint64_t flags, std::istream &stream) |
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. More... | |
Variables | |
static const std::uint64_t | probe_file_header_flags_modules = 0x1ul |
Probe for module formats in openmpt::probe_file_header(). More... | |
static const std::uint64_t | probe_file_header_flags_containers = 0x2ul |
Probe for module-specific container formats in openmpt::probe_file_header(). More... | |
static const std::uint64_t | probe_file_header_flags_default = probe_file_header_flags_modules | probe_file_header_flags_containers |
Probe for the default set of formats in openmpt::probe_file_header(). More... | |
static const std::uint64_t | probe_file_header_flags_none = 0x0ul |
Probe for no formats in openmpt::probe_file_header(). More... | |
Possible return values for openmpt::probe_file_header().
Enumerator | |
---|---|
probe_file_header_result_success | |
probe_file_header_result_failure | |
probe_file_header_result_wantmoredata |
LIBOPENMPT_CXX_API double openmpt::could_open_probability | ( | std::istream & | stream, |
double | effort = 1.0 , |
||
std::ostream & | log = std::clog |
||
) |
Roughly scan the input stream to find out whether libopenmpt might be able to open it.
stream | Input stream to scan. |
effort | Effort to make when validating stream. Effort 0.0 does not even look at stream at all and effort 1.0 completely loads the file from stream. A lower effort requires less data to be loaded but only gives a rough estimate answer. Use an effort of 0.25 to only verify the header data of the module file. |
log | Log where warning and errors are written. |
LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API double openmpt::could_open_propability | ( | std::istream & | stream, |
double | effort = 1.0 , |
||
std::ostream & | log = std::clog |
||
) |
Roughly scan the input stream to find out whether libopenmpt might be able to open it.
LIBOPENMPT_CXX_API std::uint32_t openmpt::get_core_version | ( | ) |
Get the core version number.
Return the OpenMPT core version number.
LIBOPENMPT_CXX_API std::uint32_t openmpt::get_library_version | ( | ) |
Get the libopenmpt version number.
Returns the libopenmpt version number.
LIBOPENMPT_CXX_API std::vector<std::string> openmpt::get_supported_extensions | ( | ) |
Get a list of supported file extensions.
LIBOPENMPT_CXX_API bool openmpt::is_extension_supported | ( | const std::string & | extension | ) |
Query whether a file extension is supported.
extension | file extension to query without a leading dot. The case is ignored. |
LIBOPENMPT_CXX_API int openmpt::probe_file_header | ( | std::uint64_t | flags, |
const std::uint8_t * | data, | ||
std::size_t | size, | ||
std::uint64_t | filesize | ||
) |
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.
flags | Ored mask of openmpt::probe_file_header_flags_modules and openmpt::probe_file_header_flags_containers, or openmpt::probe_file_header_flags_default. |
data | Beginning of the file data. |
size | Size of the beginning of the file data. |
filesize | Full size of the file data on disk. |
probe_file_header_result_success | The file will most likely be supported by libopenmpt. |
probe_file_header_result_failure | The file is not supported by libopenmpt. |
probe_file_header_result_wantmoredata | An answer could not be determined with the amount of data provided. |
LIBOPENMPT_CXX_API int openmpt::probe_file_header | ( | std::uint64_t | flags, |
const std::uint8_t * | data, | ||
std::size_t | size | ||
) |
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.
flags | Ored mask of openmpt::probe_file_header_flags_modules and openmpt::probe_file_header_flags_containers, or openmpt::probe_file_header_flags_default. |
data | Beginning of the file data. |
size | Size of the beginning of the file data. |
probe_file_header_result_success | The file will most likely be supported by libopenmpt. |
probe_file_header_result_failure | The file is not supported by libopenmpt. |
probe_file_header_result_wantmoredata | An answer could not be determined with the amount of data provided. |
LIBOPENMPT_CXX_API int openmpt::probe_file_header | ( | std::uint64_t | flags, |
std::istream & | stream | ||
) |
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.
flags | Ored mask of openmpt::probe_file_header_flags_modules and openmpt::probe_file_header_flags_containers, or openmpt::probe_file_header_flags_default. |
stream | Input stream to scan. |
probe_file_header_result_success | The file will most likely be supported by libopenmpt. |
probe_file_header_result_failure | The file is not supported by libopenmpt. |
probe_file_header_result_wantmoredata | An answer could not be determined with the amount of data provided. |
LIBOPENMPT_CXX_API std::size_t openmpt::probe_file_header_get_recommended_size | ( | ) |
Get recommended header size for successfull format probing.
|
static |
Probe for module-specific container formats in openmpt::probe_file_header().
|
static |
Probe for the default set of formats in openmpt::probe_file_header().
|
static |
Probe for module formats in openmpt::probe_file_header().
|
static |
Probe for no formats in openmpt::probe_file_header().