steve
/
winamp
mirror of https://github.com/WinampDesktop/winamp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
winamp/Src/external_dependencies/openmpt-trunk/libopenmpt/libopenmpt.h

1553 lines
89 KiB
C
Raw Normal View History

Initial community commit
2024-09-24 12:54:57 +00:00
/*
* libopenmpt.h
* ------------
* Purpose: libopenmpt public c interface
* Notes : (currently none)
* Authors: OpenMPT Devs
* The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
*/
#ifndef LIBOPENMPT_H
#define LIBOPENMPT_H
#include "libopenmpt_config.h"
#include <stddef.h>
#include <stdint.h>
/*!
* \page libopenmpt_c_overview C API
*
* \section libopenmpt_c_error Error Handling
*
* - Functions with no return value in the corresponding C++ API return 0 on
* failure and 1 on success.
* - Functions that return a string in the corresponding C++ API return a
* dynamically allocated const char *. In case of failure or memory allocation
* failure, a NULL pointer is returned.
* - Functions that return integer values signal error condition by returning
* an invalid value (-1 in most cases, 0 in some cases).
* - All functions that work on an \ref openmpt_module object will call an
* \ref openmpt_error_func and depending on the value returned by this function
* log the error code and/xor/or store it inside the openmpt_module object.
* Stored error codes can be accessed with the openmpt_module_error_get_last()
* and openmpt_module_error_get_last_message(). Stored errors will not get
* cleared automatically and should be reset with openmpt_module_error_clear().
* - Some functions not directly related to an \ref openmpt_module object take
* an explicit \ref openmpt_error_func error function callback and a pointer to
* an int and behave analog to the functions working on an \ref openmpt_module
* object.
*
* \section libopenmpt_c_strings Strings
*
* - All strings returned from libopenmpt are encoded in UTF-8.
* - All strings passed to libopenmpt should also be encoded in UTF-8.
* Behaviour in case of invalid UTF-8 is unspecified.
* - libopenmpt does not enforce or expect any particular Unicode
* normalization form.
* - All strings returned from libopenmpt are dynamically allocated and must
* be freed with openmpt_free_string(). Do NOT use the C standard library
* free() for libopenmpt strings as that would make your code invalid on
* windows when dynamically linking against libopenmpt which itself statically
* links to the C runtime.
* - All strings passed to libopenmpt are copied. No ownership is assumed or
* transferred.
*
* \section libopenmpt_c_fileio File I/O
*
* libopenmpt can use 3 different strategies for file I/O.
*
* - openmpt_module_create_from_memory2() will load the module from the provided
* memory buffer, which will require loading all data upfront by the library
* caller.
* - openmpt_module_create2() with a seekable stream will load the module via
* callbacks to the stream interface. libopenmpt will not implement an
* additional buffering layer in this case which means the callbacks are assumed
* to be performant even with small i/o sizes.
* - openmpt_module_create2() with an unseekable stream will load the module via
* callbacks to the stream interface. libopempt will make an internal copy as
* it goes along, and sometimes have to pre-cache the whole file in case it
* needs to know the complete file size. This strategy is intended to be used
* if the file is located on a high latency network.
*
* | create function | speed | memory consumption |
* | ----------------------------------------------: | :----: | :----------------: |
* | openmpt_module_create_from_memory2() | <p style="background-color:green" >fast </p> | <p style="background-color:yellow">medium</p> |
* | openmpt_module_create2() with seekable stream | <p style="background-color:red" >slow </p> | <p style="background-color:green" >low </p> |
* | openmpt_module_create2() with unseekable stream | <p style="background-color:yellow">medium</p> | <p style="background-color:red" >high </p> |
*
* In all cases, the data or stream passed to the create function is no longer
* needed after the openmpt_module has been created and can be freed by the
* caller.
*
* \section libopenmpt_c_outputformat Output Format
*
* libopenmpt supports a wide range of PCM output formats:
* [8000..192000]/[mono|stereo|quad]/[f32|i16].
*
* Unless you have some very specific requirements demanding a particular aspect
* of the output format, you should always prefer 48000/stereo/f32 as the
* libopenmpt PCM format.
*
* - Please prefer 48000Hz unless the user explicitly demands something else.
* Practically all audio equipment and file formats use 48000Hz nowadays.
* - Practically all module formats are made for stereo output. Mono will not
* give you any measurable speed improvements and can trivially be obtained from
* the stereo output anyway. Quad is not expected by almost all modules and even
* if they do use surround effects, they expect the effects to be mixed to
* stereo.
* - Floating point output provides headroom instead of hard clipping if the
* module is louder than 0dBFs, will give you a better signal-to-noise ratio
* than int16 output, and avoid the need to apply an additional dithering to the
* output by libopenmpt. Unless your platform has no floating point unit at all,
* floating point will thus also be slightly faster.
*
* \section libopenmpt_c_threads libopenmpt in multi-threaded environments
*
* - libopenmpt is thread-aware.
* - Individual libopenmpt objects are not thread-safe.
* - libopenmpt itself does not spawn any user-visible threads but may spawn
* threads for internal use.
* - You must ensure to only ever access a particular libopenmpt object from a
* single thread at a time.
* - Consecutive accesses can happen from different threads.
* - Different objects can be accessed concurrently from different threads.
*
* \section libopenmpt_c_staticlinking Statically linking to libopenmpt
*
* libopenmpt is implemented in C++. This implies that linking to libopenmpt
* statically requires linking to the C++ runtime and standard library. The
* **highly preferred and recommended** way to do this is by using the C++
* compiler instead of the platform linker to do the linking. This will do all
* necessary things that are C++ specific (in particular, it will pull in the
* appropriate runtime and/or library). If for whatever reason it is not
* possible to use the C++ compiler for statically linking against libopenmpt,
* the libopenmpt build system can list the required libraries in the pkg-config
* file `libopenmpt.pc`. However, there is no reliable way to determine the name
* of the required library or libraries from within the build system. The
* libopenmpt autotools `configure` and plain `Makefile` honor the custom
* variable `CXXSTDLIB_PCLIBSPRIVATE` which serves the sole purpose of listing
* the standard library (or libraries) required for static linking. The contents
* of this variable will be put in `libopenmpt.pc` `Libs.private` and used for
* nothing else.
*
* This problem is inherent to libraries implemented in C++ that can also be used
* without a C++ compiler. Other libraries try to solve that by listing
* `-lstdc++` unconditionally in `Libs.private`. However, that will break
* platforms that use a different C++ standard library (in particular FreeBSD).
*
* See https://lists.freedesktop.org/archives/pkg-config/2016-August/001055.html .
*
* Dymically linking to libopenmpt does not require anything special and will
* work as usual (and exactly as done for libraries implemented in C).
*
* Note: This section does not apply when using Microsoft Visual Studio or
* Andriod NDK ndk-build build systems.
*
* \section libopenmpt_c_detailed Detailed documentation
*
* \ref libopenmpt_c
*
* In case a function is not documented here, you might want to look at the
* \ref libopenmpt_cpp documentation. The C and C++ APIs are kept semantically
* as close as possible.
*
* \section libopenmpt_c_examples Examples
*
* \subsection libopenmpt_c_example_unsafe Unsafe, simplified example without any error checking to get a first idea of the API
* \include libopenmpt_example_c_unsafe.c
* \subsection libopenmpt_c_example_file FILE*
* \include libopenmpt_example_c.c
* \subsection libopenmpt_c_example_inmemory in memory
* \include libopenmpt_example_c_mem.c
* \subsection libopenmpt_c_example_stdout reading FILE* and writing PCM data to STDOUT (usable without PortAudio)
* \include libopenmpt_example_c_stdout.c
*
*/
/*! \defgroup libopenmpt_c libopenmpt C */
/*! \addtogroup libopenmpt_c
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
/*! \brief Get the libopenmpt version number
*
* Returns the libopenmpt version number.
* \return The value represents (major << 24 + minor << 16 + patch << 0).
* \remarks libopenmpt < 0.3.0-pre used the following scheme: (major << 24 + minor << 16 + revision).
*/
LIBOPENMPT_API uint32_t openmpt_get_library_version(void);
/*! \brief Get the core version number
*
* Return the OpenMPT core version number.
* \return The value represents (majormajor << 24 + major << 16 + minor << 8 + minorminor).
*/
LIBOPENMPT_API uint32_t openmpt_get_core_version(void);
/*! Return a verbose library version string from openmpt_get_string(). \deprecated Please use `"library_version"` directly. */
#define OPENMPT_STRING_LIBRARY_VERSION LIBOPENMPT_DEPRECATED_STRING( "library_version" )
/*! Return a verbose library features string from openmpt_get_string(). \deprecated Please use `"library_features"` directly. */
#define OPENMPT_STRING_LIBRARY_FEATURES LIBOPENMPT_DEPRECATED_STRING( "library_features" )
/*! Return a verbose OpenMPT core version string from openmpt_get_string(). \deprecated Please use `"core_version"` directly. */
#define OPENMPT_STRING_CORE_VERSION LIBOPENMPT_DEPRECATED_STRING( "core_version" )
/*! Return information about the current build (e.g. the build date or compiler used) from openmpt_get_string(). \deprecated Please use `"build"` directly. */
#define OPENMPT_STRING_BUILD LIBOPENMPT_DEPRECATED_STRING( "build" )
/*! Return all contributors from openmpt_get_string(). \deprecated Please use `"credits"` directly. */
#define OPENMPT_STRING_CREDITS LIBOPENMPT_DEPRECATED_STRING( "credits" )
/*! Return contact information about libopenmpt from openmpt_get_string(). \deprecated Please use `"contact"` directly. */
#define OPENMPT_STRING_CONTACT LIBOPENMPT_DEPRECATED_STRING( "contact" )
/*! Return the libopenmpt license from openmpt_get_string(). \deprecated Please use `"license"` directly. */
#define OPENMPT_STRING_LICENSE LIBOPENMPT_DEPRECATED_STRING( "license" )
/*! \brief Free a string returned by libopenmpt
*
* Frees any string that got returned by libopenmpt.
*/
LIBOPENMPT_API void openmpt_free_string( const char * str );
/*! \brief Get library related metadata.
*
* \param key Key to query.
* Possible keys are:
* - "library_version": verbose library version string
* - "library_version_is_release": "1" if the version is an officially released version
* - "library_features": verbose library features string
* - "core_version": verbose OpenMPT core version string
* - "source_url": original source code URL
* - "source_date": original source code date
* - "source_revision": original source code revision
* - "source_is_modified": "1" if the original source has been modified
* - "source_has_mixed_revisions": "1" if the original source has been compiled from different various revision
* - "source_is_package": "1" if the original source has been obtained from a source pacakge instead of source code version control
* - "build": information about the current build (e.g. the build date or compiler used)
* - "build_compiler": information about the compiler used to build libopenmpt
* - "credits": all contributors
* - "contact": contact information about libopenmpt
* - "license": the libopenmpt license
* - "url": libopenmpt website URL
* - "support_forum_url": libopenmpt support and discussions forum URL
* - "bugtracker_url": libopenmpt bug and issue tracker URL
* \return A (possibly multi-line) string containing the queried information. If no information is available, the string is empty.
*/
LIBOPENMPT_API const char * openmpt_get_string( const char * key );
/*! \brief Get a list of supported file extensions
*
* \return The semicolon-separated list of extensions supported by this libopenmpt build. The extensions are returned lower-case without a leading dot.
*/
LIBOPENMPT_API const char * openmpt_get_supported_extensions(void);
/// <summary>
/// From version: 0.7.0
/// Hakan DANISIK
/// </summary>
/// <param name="extension"></param>
/// <returns></returns>
LIBOPENMPT_API const char * openmpt_get_tracker_name( const char * extension );
/*! \brief Query whether a file extension is supported
*
* \param extension file extension to query without a leading dot. The case is ignored.
* \return 1 if the extension is supported by libopenmpt, 0 otherwise.
*/
LIBOPENMPT_API int openmpt_is_extension_supported( const char * extension );
/*! Seek to the given offset relative to the beginning of the file. */
#define OPENMPT_STREAM_SEEK_SET 0
/*! Seek to the given offset relative to the current position in the file. */
#define OPENMPT_STREAM_SEEK_CUR 1
/*! Seek to the given offset relative to the end of the file. */
#define OPENMPT_STREAM_SEEK_END 2
/*! \brief Read bytes from stream
*
* Read bytes data from stream to dst.
* \param stream Stream to read data from
* \param dst Target where to copy data.
* \param bytes Number of bytes to read.
* \return Number of bytes actually read and written to dst.
* \retval 0 End of stream or error.
* \remarks Short reads are allowed as long as they return at least 1 byte if EOF is not reached.
*/
typedef size_t (*openmpt_stream_read_func)( void * stream, void * dst, size_t bytes );
/*! \brief Seek stream position
*
* Seek to stream position offset at whence.
* \param stream Stream to operate on.
* \param offset Offset to seek to.
* \param whence OPENMPT_STREAM_SEEK_SET, OPENMPT_STREAM_SEEK_CUR, OPENMPT_STREAM_SEEK_END. See C89 documentation.
* \return Returns 0 on success.
* \retval 0 Success.
* \retval -1 Failure. Position does not get updated.
* \remarks libopenmpt will not try to seek beyond the file size, thus it is not important whether you allow for virtual positioning after the file end, or return an error in that case. The position equal to the file size needs to be seekable to.
*/
typedef int (*openmpt_stream_seek_func)( void * stream, int64_t offset, int whence );
/*! \brief Tell stream position
*
* Tell position of stream.
* \param stream Stream to operate on.
* \return Current position in stream.
* \retval -1 Failure.
*/
typedef int64_t (*openmpt_stream_tell_func)( void * stream );
/*! \brief Stream callbacks
*
* Stream callbacks used by libopenmpt for stream operations.
* \sa openmpt_stream_get_file_callbacks
* \sa openmpt_stream_get_fd_callbacks
* \sa openmpt_stream_get_buffer_callbacks
*/
typedef struct openmpt_stream_callbacks {
/*! \brief Read callback.
*
* \sa openmpt_stream_read_func
*/
openmpt_stream_read_func read;
/*! \brief Seek callback.
*
* Seek callback can be NULL if seeking is not supported.
* \sa openmpt_stream_seek_func
*/
openmpt_stream_seek_func seek;
/*! \brief Tell callback.
*
* Tell callback can be NULL if seeking is not supported.
* \sa openmpt_stream_tell_func
*/
openmpt_stream_tell_func tell;
} openmpt_stream_callbacks;
/*! \brief Logging function
*
* \param message UTF-8 encoded log message.
* \param user User context that was passed to openmpt_module_create2(), openmpt_module_create_from_memory2() or openmpt_could_open_probability2().
*/
typedef void (*openmpt_log_func)( const char * message, void * user );
/*! \brief Default logging function
*
* Default logging function that logs anything to stderr.
*/
LIBOPENMPT_API void openmpt_log_func_default( const char * message, void * user );
/*! \brief Silent logging function
*
* Silent logging function that throws any log message away.
*/
LIBOPENMPT_API void openmpt_log_func_silent( const char * message, void * user );
/*! No error. \since 0.3.0 */
#define OPENMPT_ERROR_OK 0
/*! Lowest value libopenmpt will use for any of its own error codes. \since 0.3.0 */
#define OPENMPT_ERROR_BASE 256
/*! Unknown internal error. \since 0.3.0 */
#define OPENMPT_ERROR_UNKNOWN ( OPENMPT_ERROR_BASE + 1 )
/*! Unknown internal C++ exception. \since 0.3.0 */
#define OPENMPT_ERROR_EXCEPTION ( OPENMPT_ERROR_BASE + 11 )
/*! Out of memory. \since 0.3.0 */
#define OPENMPT_ERROR_OUT_OF_MEMORY ( OPENMPT_ERROR_BASE + 21 )
/*! Runtime error. \since 0.3.0 */
#define OPENMPT_ERROR_RUNTIME ( OPENMPT_ERROR_BASE + 30 )
/*! Range error. \since 0.3.0 */
#define OPENMPT_ERROR_RANGE ( OPENMPT_ERROR_BASE + 31 )
/*! Arithmetic overflow. \since 0.3.0 */
#define OPENMPT_ERROR_OVERFLOW ( OPENMPT_ERROR_BASE + 32 )
/*! Arithmetic underflow. \since 0.3.0 */
#define OPENMPT_ERROR_UNDERFLOW ( OPENMPT_ERROR_BASE + 33 )
/*! Logic error. \since 0.3.0 */
#define OPENMPT_ERROR_LOGIC ( OPENMPT_ERROR_BASE + 40 )
/*! Value domain error. \since 0.3.0 */
#define OPENMPT_ERROR_DOMAIN ( OPENMPT_ERROR_BASE + 41 )
/*! Maximum supported size exceeded. \since 0.3.0 */
#define OPENMPT_ERROR_LENGTH ( OPENMPT_ERROR_BASE + 42 )
/*! Argument out of range. \since 0.3.0 */
#define OPENMPT_ERROR_OUT_OF_RANGE ( OPENMPT_ERROR_BASE + 43 )
/*! Invalid argument. \since 0.3.0 */
#define OPENMPT_ERROR_INVALID_ARGUMENT ( OPENMPT_ERROR_BASE + 44 )
/*! General libopenmpt error. \since 0.3.0 */
#define OPENMPT_ERROR_GENERAL ( OPENMPT_ERROR_BASE + 101 )
/*! openmpt_module * is invalid. \since 0.3.0 */
#define OPENMPT_ERROR_INVALID_MODULE_POINTER ( OPENMPT_ERROR_BASE + 102 )
/*! NULL pointer argument. \since 0.3.0 */
#define OPENMPT_ERROR_ARGUMENT_NULL_POINTER ( OPENMPT_ERROR_BASE + 103 )
/*! \brief Check whether the error is transient
*
* Checks whether an error code represents a transient error which may not occur again in a later try if for example memory has been freed up after an out-of-memory error.
* \param error Error code.
* \retval 0 Error is not transient.
* \retval 1 Error is transient.
* \sa OPENMPT_ERROR_OUT_OF_MEMORY
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_error_is_transient( int error );
/*! \brief Convert error code to text
*
* Converts an error code into a text string describing the error.
* \param error Error code.
* \return Allocated string describing the error.
* \retval NULL Not enough memory to allocate the string.
* \since 0.3.0
*/
LIBOPENMPT_API const char * openmpt_error_string( int error );
/*! Do not log or store the error. \since 0.3.0 */
#define OPENMPT_ERROR_FUNC_RESULT_NONE 0
/*! Log the error. \since 0.3.0 */
#define OPENMPT_ERROR_FUNC_RESULT_LOG ( 1 << 0 )
/*! Store the error. \since 0.3.0 */
#define OPENMPT_ERROR_FUNC_RESULT_STORE ( 1 << 1 )
/*! Log and store the error. \since 0.3.0 */
#define OPENMPT_ERROR_FUNC_RESULT_DEFAULT ( OPENMPT_ERROR_FUNC_RESULT_LOG | OPENMPT_ERROR_FUNC_RESULT_STORE )
/*! \brief Error function
*
* \param error Error code.
* \param user User context that was passed to openmpt_module_create2(), openmpt_module_create_from_memory2() or openmpt_could_open_probability2().
* \return Mask of OPENMPT_ERROR_FUNC_RESULT_LOG and OPENMPT_ERROR_FUNC_RESULT_STORE.
* \retval OPENMPT_ERROR_FUNC_RESULT_NONE Do not log or store the error.
* \retval OPENMPT_ERROR_FUNC_RESULT_LOG Log the error.
* \retval OPENMPT_ERROR_FUNC_RESULT_STORE Store the error.
* \retval OPENMPT_ERROR_FUNC_RESULT_DEFAULT Log and store the error.
* \sa OPENMPT_ERROR_FUNC_RESULT_NONE
* \sa OPENMPT_ERROR_FUNC_RESULT_LOG
* \sa OPENMPT_ERROR_FUNC_RESULT_STORE
* \sa OPENMPT_ERROR_FUNC_RESULT_DEFAULT
* \sa openmpt_error_func_default
* \sa openmpt_error_func_log
* \sa openmpt_error_func_store
* \sa openmpt_error_func_ignore
* \sa openmpt_error_func_errno
* \since 0.3.0
*/
typedef int (*openmpt_error_func)( int error, void * user );
/*! \brief Default error function
*
* Causes all errors to be logged and stored.
* \param error Error code.
* \param user Ignored.
* \retval OPENMPT_ERROR_FUNC_RESULT_DEFAULT Always.
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_error_func_default( int error, void * user );
/*! \brief Log error function
*
* Causes all errors to be logged.
* \param error Error code.
* \param user Ignored.
* \retval OPENMPT_ERROR_FUNC_RESULT_LOG Always.
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_error_func_log( int error, void * user );
/*! \brief Store error function
*
* Causes all errors to be stored.
* \param error Error code.
* \param user Ignored.
* \retval OPENMPT_ERROR_FUNC_RESULT_STORE Always.
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_error_func_store( int error, void * user );
/*! \brief Ignore error function
*
* Causes all errors to be neither logged nor stored.
* \param error Error code.
* \param user Ignored.
* \retval OPENMPT_ERROR_FUNC_RESULT_NONE Always.
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_error_func_ignore( int error, void * user );
/*! \brief Errno error function
*
* Causes all errors to be stored in the pointer passed in as user.
* \param error Error code.
* \param user Pointer to an int as generated by openmpt_error_func_errno_userdata.
* \retval OPENMPT_ERROR_FUNC_RESULT_NONE user is not NULL.
* \retval OPENMPT_ERROR_FUNC_RESULT_DEFAULT user is NULL.
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_error_func_errno( int error, void * user );
/*! \brief User pointer for openmpt_error_func_errno
*
* Provides a suitable user pointer argument for openmpt_error_func_errno.
* \param error Pointer to an integer value to be used as output by openmpt_error_func_errno.
* \retval (void*)error.
* \since 0.3.0
*/
LIBOPENMPT_API void * openmpt_error_func_errno_userdata( int * error );
/*! \brief Roughly scan the input stream to find out whether libopenmpt might be able to open it
*
* \param stream_callbacks Input stream callback operations.
* \param stream Input stream to scan.
* \param 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.
* \param logfunc Logging function where warning and errors are written. May be NULL.
* \param user Logging function user context. Used to pass any user-defined data associated with this module to the logging function.
* \return Probability between 0.0 and 1.0.
* \remarks openmpt_could_open_probability() can return any value between 0.0 and 1.0. Only 0.0 and 1.0 are definitive answers, all values in between are just estimates. In general, any return value >0.0 means that you should try loading the file, and any value below 1.0 means that loading may fail. If you want a threshold above which you can be reasonably sure that libopenmpt will be able to load the file, use >=0.5. If you see the need for a threshold below which you could reasonably outright reject a file, use <0.25 (Note: Such a threshold for rejecting on the lower end is not recommended, but may be required for better integration into some other framework's probe scoring.).
* \remarks openmpt_could_open_probability() expects the complete file data to be eventually available to it, even if it is asked to just parse the header. Verification will be unreliable (both false positives and false negatives), if you pretend that the file is just some few bytes of initial data threshold in size. In order to really just access the first bytes of a file, check in your callback functions whether data or seeking is requested beyond your initial data threshold, and in that case, return an error. openmpt_could_open_probability() will treat this as any other I/O error and return 0.0. You must not expect the correct result in this case. You instead must remember that it asked for more data than you currently want to provide to it and treat this situation as if openmpt_could_open_probability() returned 0.5.
* \sa \ref libopenmpt_c_fileio
* \sa openmpt_stream_callbacks
* \deprecated Please use openmpt_could_open_probability2().
* \since 0.3.0
*/
LIBOPENMPT_API LIBOPENMPT_DEPRECATED double openmpt_could_open_probability( openmpt_stream_callbacks stream_callbacks, void * stream, double effort, openmpt_log_func logfunc, void * user );
/*! \brief Roughly scan the input stream to find out whether libopenmpt might be able to open it
*
* \param stream_callbacks Input stream callback operations.
* \param stream Input stream to scan.
* \param 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.
* \param logfunc Logging function where warning and errors are written. May be NULL.
* \param user Logging function user context. Used to pass any user-defined data associated with this module to the logging function.
* \return Probability between 0.0 and 1.0.
* \remarks openmpt_could_open_probability() can return any value between 0.0 and 1.0. Only 0.0 and 1.0 are definitive answers, all values in between are just estimates. In general, any return value >0.0 means that you should try loading the file, and any value below 1.0 means that loading may fail. If you want a threshold above which you can be reasonably sure that libopenmpt will be able to load the file, use >=0.5. If you see the need for a threshold below which you could reasonably outright reject a file, use <0.25 (Note: Such a threshold for rejecting on the lower end is not recommended, but may be required for better integration into some other framework's probe scoring.).
* \remarks openmpt_could_open_probability() expects the complete file data to be eventually available to it, even if it is asked to just parse the header. Verification will be unreliable (both false positives and false negatives), if you pretend that the file is just some few bytes of initial data threshold in size. In order to really just access the first bytes of a file, check in your callback functions whether data or seeking is requested beyond your initial data threshold, and in that case, return an error. openmpt_could_open_probability() will treat this as any other I/O error and return 0.0. You must not expect the correct result in this case. You instead must remember that it asked for more data than you currently want to provide to it and treat this situation as if openmpt_could_open_probability() returned 0.5.
* \sa \ref libopenmpt_c_fileio
* \sa openmpt_stream_callbacks
* \deprecated Please use openmpt_could_open_probability2().
*/
LIBOPENMPT_API LIBOPENMPT_DEPRECATED double openmpt_could_open_propability( openmpt_stream_callbacks stream_callbacks, void * stream, double effort, openmpt_log_func logfunc, void * user );
/*! \brief Roughly scan the input stream to find out whether libopenmpt might be able to open it
*
* \param stream_callbacks Input stream callback operations.
* \param stream Input stream to scan.
* \param 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.
* \param logfunc Logging function where warning and errors are written. May be NULL.
* \param loguser Logging function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param error Pointer to an integer where an error may get stored. May be NULL.
* \param error_message Pointer to a string pointer where an error message may get stored. May be NULL.
* \return Probability between 0.0 and 1.0.
* \remarks openmpt_probe_file_header() or openmpt_probe_file_header_without_filesize() provide a simpler and faster interface that fits almost all use cases better. It is recommended to use openmpt_probe_file_header() or openmpt_probe_file_header_without_filesize() instead of openmpt_could_open_probability().
* \remarks openmpt_could_open_probability2() can return any value between 0.0 and 1.0. Only 0.0 and 1.0 are definitive answers, all values in between are just estimates. In general, any return value >0.0 means that you should try loading the file, and any value below 1.0 means that loading may fail. If you want a threshold above which you can be reasonably sure that libopenmpt will be able to load the file, use >=0.5. If you see the need for a threshold below which you could reasonably outright reject a file, use <0.25 (Note: Such a threshold for rejecting on the lower end is not recommended, but may be required for better integration into some other framework's probe scoring.).
* \remarks openmpt_could_open_probability2() expects the complete file data to be eventually available to it, even if it is asked to just parse the header. Verification will be unreliable (both false positives and false negatives), if you pretend that the file is just some few bytes of initial data threshold in size. In order to really just access the first bytes of a file, check in your callback functions whether data or seeking is requested beyond your initial data threshold, and in that case, return an error. openmpt_could_open_probability2() will treat this as any other I/O error and return 0.0. You must not expect the correct result in this case. You instead must remember that it asked for more data than you currently want to provide to it and treat this situation as if openmpt_could_open_probability2() returned 0.5. \include libopenmpt_example_c_probe.c
* \sa \ref libopenmpt_c_fileio
* \sa openmpt_stream_callbacks
* \sa openmpt_probe_file_header
* \sa openmpt_probe_file_header_without_filesize
* \since 0.3.0
*/
LIBOPENMPT_API double openmpt_could_open_probability2( openmpt_stream_callbacks stream_callbacks, void * stream, double effort, openmpt_log_func logfunc, void * loguser, openmpt_error_func errfunc, void * erruser, int * error, const char * * error_message );
/*! \brief Get recommended header size for successfull format probing
*
* \sa openmpt_probe_file_header()
* \sa openmpt_probe_file_header_without_filesize()
* \since 0.3.0
*/
LIBOPENMPT_API size_t openmpt_probe_file_header_get_recommended_size(void);
/*! Probe for module formats in openmpt_probe_file_header() or openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES 0x1ull
/*! Probe for module-specific container formats in openmpt_probe_file_header() or openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS 0x2ull
/*! Probe for the default set of formats in openmpt_probe_file_header() or openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT ( OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES | OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS )
/*! Probe for no formats in openmpt_probe_file_header() or openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_FLAGS_NONE 0x0ull
/*! Possible return values fo openmpt_probe_file_header() and openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS 1
/*! Possible return values fo openmpt_probe_file_header() and openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE 0
/*! Possible return values fo openmpt_probe_file_header() and openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA (-1)
/*! Possible return values fo openmpt_probe_file_header() and openmpt_probe_file_header_without_filesize(). \since 0.3.0 */
#define OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR (-255)
/*! \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
*
* \param flags Bit mask of OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES and OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS, or OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT.
* \param data Beginning of the file data.
* \param size Size of the beginning of the file data.
* \param filesize Full size of the file data on disk.
* \param logfunc Logging function where warning and errors are written. May be NULL.
* \param loguser Logging function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param error Pointer to an integer where an error may get stored. May be NULL.
* \param error_message Pointer to a string pointer where an error message may get stored. May be NULL.
* \remarks It is recommended to provide openmpt_probe_file_header_get_recommended_size() bytes of data for data and size. If the file is smaller, only provide the filesize amount and set size and filesize to the file's size.
* \remarks openmpt_could_open_probability2() provides a more elaborate interface that might be required for special use cases. It is recommended to use openmpt_probe_file_header() though, if possible.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS The file will most likely be supported by libopenmpt.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE The file is not supported by libopenmpt.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA An answer could not be determined with the amount of data provided.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR An internal error occurred.
* \sa openmpt_probe_file_header_get_recommended_size()
* \sa openmpt_probe_file_header_without_filesize()
* \sa openmpt_probe_file_header_from_stream()
* \sa openmpt_could_open_probability2()
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_probe_file_header( uint64_t flags, const void * data, size_t size, uint64_t filesize, openmpt_log_func logfunc, void * loguser, openmpt_error_func errfunc, void * erruser, int * error, const char * * error_message );
/*! \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
*
* \param flags Bit mask of OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES and OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS, or OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT.
* \param data Beginning of the file data.
* \param size Size of the beginning of the file data.
* \param logfunc Logging function where warning and errors are written. May be NULL.
* \param loguser Logging function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param error Pointer to an integer where an error may get stored. May be NULL.
* \param error_message Pointer to a string pointer where an error message may get stored. May be NULL.
* \remarks It is recommended to use openmpt_probe_file_header() and provide the acutal file's size as a parameter if at all possible. libopenmpt can provide more accurate answers if the filesize is known.
* \remarks It is recommended to provide openmpt_probe_file_header_get_recommended_size() bytes of data for data and size. If the file is smaller, only provide the filesize amount and set size to the file's size.
* \remarks openmpt_could_open_probability2() provides a more elaborate interface that might be required for special use cases. It is recommended to use openmpt_probe_file_header() though, if possible.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS The file will most likely be supported by libopenmpt.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE The file is not supported by libopenmpt.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA An answer could not be determined with the amount of data provided.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR An internal error occurred.
* \sa openmpt_probe_file_header_get_recommended_size()
* \sa openmpt_probe_file_header()
* \sa openmpt_probe_file_header_from_stream()
* \sa openmpt_could_open_probability2()
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_probe_file_header_without_filesize( uint64_t flags, const void * data, size_t size, openmpt_log_func logfunc, void * loguser, openmpt_error_func errfunc, void * erruser, int * error, const char * * error_message );
/*! \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
*
* \param flags Bit mask of OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES and OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS, or OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT.
* \param stream_callbacks Input stream callback operations.
* \param stream Input stream to scan.
* \param logfunc Logging function where warning and errors are written. May be NULL.
* \param loguser Logging function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param error Pointer to an integer where an error may get stored. May be NULL.
* \param error_message Pointer to a string pointer where an error message may get stored. May be NULL.
* \remarks The stream is left in an unspecified state when this function returns.
* \remarks It is recommended to provide openmpt_probe_file_header_get_recommended_size() bytes of data for data and size. If the file is smaller, only provide the filesize amount and set size and filesize to the file's size.
* \remarks openmpt_could_open_probability2() provides a more elaborate interface that might be required for special use cases. It is recommended to use openmpt_probe_file_header() though, if possible.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS The file will most likely be supported by libopenmpt.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE The file is not supported by libopenmpt.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA An answer could not be determined with the amount of data provided.
* \retval OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR An internal error occurred.
* \sa openmpt_probe_file_header_get_recommended_size()
* \sa openmpt_probe_file_header()
* \sa openmpt_probe_file_header_without_filesize()
* \sa openmpt_could_open_probability2()
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_probe_file_header_from_stream( uint64_t flags, openmpt_stream_callbacks stream_callbacks, void * stream, openmpt_log_func logfunc, void * loguser, openmpt_error_func errfunc, void * erruser, int * error, const char * * error_message );
/*! \brief Opaque type representing a libopenmpt module
*/
typedef struct openmpt_module openmpt_module;
typedef struct openmpt_module_initial_ctl {
const char * ctl;
const char * value;
} openmpt_module_initial_ctl;
/*! \brief Construct an openmpt_module
*
* \param stream_callbacks Input stream callback operations.
* \param stream Input stream to load the module from.
* \param logfunc Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module. May be NULL.
* \param loguser User-defined data associated with this module. This value will be passed to the logging callback function (logfunc)
* \param ctls A map of initial ctl values. See openmpt_module_get_ctls()
* \return A pointer to the constructed openmpt_module, or NULL on failure.
* \remarks The input data can be discarded after an openmpt_module has been constructed successfully.
* \sa openmpt_stream_callbacks
* \sa \ref libopenmpt_c_fileio
* \deprecated Please use openmpt_module_create2().
*/
LIBOPENMPT_API LIBOPENMPT_DEPRECATED openmpt_module * openmpt_module_create( openmpt_stream_callbacks stream_callbacks, void * stream, openmpt_log_func logfunc, void * loguser, const openmpt_module_initial_ctl * ctls );
/*! \brief Construct an openmpt_module
*
* \param stream_callbacks Input stream callback operations.
* \param stream Input stream to load the module from.
* \param logfunc Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module. May be NULL.
* \param loguser User-defined data associated with this module. This value will be passed to the logging callback function (logfunc)
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param error Pointer to an integer where an error may get stored. May be NULL.
* \param error_message Pointer to a string pointer where an error message may get stored. May be NULL.
* \param ctls A map of initial ctl values. See openmpt_module_get_ctls()
* \return A pointer to the constructed openmpt_module, or NULL on failure.
* \remarks The input data can be discarded after an openmpt_module has been constructed successfully.
* \sa openmpt_stream_callbacks
* \sa \ref libopenmpt_c_fileio
* \since 0.3.0
*/
LIBOPENMPT_API openmpt_module * openmpt_module_create2( openmpt_stream_callbacks stream_callbacks, void * stream, openmpt_log_func logfunc, void * loguser, openmpt_error_func errfunc, void * erruser, int * error, const char * * error_message, const openmpt_module_initial_ctl * ctls );
/*! \brief Construct an openmpt_module
*
* \param filedata Data to load the module from.
* \param filesize Amount of data available.
* \param logfunc Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module.
* \param loguser User-defined data associated with this module. This value will be passed to the logging callback function (logfunc)
* \param ctls A map of initial ctl values. See openmpt_module_get_ctls()
* \return A pointer to the constructed openmpt_module, or NULL on failure.
* \remarks The input data can be discarded after an openmpt_module has been constructed successfully.
* \sa \ref libopenmpt_c_fileio
* \deprecated Please use openmpt_module_create_from_memory2().
*/
LIBOPENMPT_API LIBOPENMPT_DEPRECATED openmpt_module * openmpt_module_create_from_memory( const void * filedata, size_t filesize, openmpt_log_func logfunc, void * loguser, const openmpt_module_initial_ctl * ctls );
/*! \brief Construct an openmpt_module
*
* \param filedata Data to load the module from.
* \param filesize Amount of data available.
* \param logfunc Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module.
* \param loguser User-defined data associated with this module. This value will be passed to the logging callback function (logfunc)
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context. Used to pass any user-defined data associated with this module to the logging function.
* \param error Pointer to an integer where an error may get stored. May be NULL.
* \param error_message Pointer to a string pointer where an error message may get stored. May be NULL.
* \param ctls A map of initial ctl values. See openmpt_module_get_ctls()
* \return A pointer to the constructed openmpt_module, or NULL on failure.
* \remarks The input data can be discarded after an openmpt_module has been constructed successfully.
* \sa \ref libopenmpt_c_fileio
* \since 0.3.0
*/
LIBOPENMPT_API openmpt_module * openmpt_module_create_from_memory2( const void * filedata, size_t filesize, openmpt_log_func logfunc, void * loguser, openmpt_error_func errfunc, void * erruser, int * error, const char * * error_message, const openmpt_module_initial_ctl * ctls );
/*! \brief Unload a previously created openmpt_module from memory.
*
* \param mod The module to unload.
*/
LIBOPENMPT_API void openmpt_module_destroy( openmpt_module * mod );
/*! \brief Set logging function.
*
* Set the logging function of an already constructed openmpt_module.
* \param mod The module handle to work on.
* \param logfunc Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module.
* \param loguser User-defined data associated with this module. This value will be passed to the logging callback function (logfunc)
* \since 0.3.0
*/
LIBOPENMPT_API void openmpt_module_set_log_func( openmpt_module * mod, openmpt_log_func logfunc, void * loguser );
/*! \brief Set error function.
*
* Set the error function of an already constructed openmpt_module.
* \param mod The module handle to work on.
* \param errfunc Error function to define error behaviour. May be NULL.
* \param erruser Error function user context.
* \since 0.3.0
*/
LIBOPENMPT_API void openmpt_module_set_error_func( openmpt_module * mod, openmpt_error_func errfunc, void * erruser );
/*! \brief Get last error.
*
* Return the error currently stored in an openmpt_module. The stored error is not cleared.
* \param mod The module handle to work on.
* \return The error currently stored.
* \sa openmpt_module_error_get_last_message
* \sa openmpt_module_error_set_last
* \sa openmpt_module_error_clear
* \since 0.3.0
*/
LIBOPENMPT_API int openmpt_module_error_get_last( openmpt_module * mod );
/*! \brief Get last error message.
*
* Return the error message currently stored in an openmpt_module. The stored error is not cleared.
* \param mod The module handle to work on.
* \return The error message currently stored.
* \sa openmpt_module_error_set_last
* \sa openmpt_module_error_clear
* \since 0.3.0
*/
LIBOPENMPT_API const char * openmpt_module_error_get_last_message( openmpt_module * mod );
/*! \brief Set last error.
*
* Set the error currently stored in an openmpt_module.
* \param mod The module handle to work on.
* \param error Error to be stored.
* \sa openmpt_module_error_get_last
* \sa openmpt_module_error_clear
* \since 0.3.0
*/
LIBOPENMPT_API void openmpt_module_error_set_last( openmpt_module * mod, int error );
/*! \brief Clear last error.
*
* Set the error currently stored in an openmpt_module to OPPENMPT_ERROR_OK.
* \param mod The module handle to work on.
* \sa openmpt_module_error_get_last
* \sa openmpt_module_error_set_last
* \since 0.3.0
*/
LIBOPENMPT_API void openmpt_module_error_clear( openmpt_module * mod );
/**
* \defgroup openmpt_module_render_param Render param indices
*
* \brief Parameter index to use with openmpt_module_get_render_param() and openmpt_module_set_render_param()
* @{
*/
/*! \brief Master Gain
*
* The related value represents a relative gain in milliBel.\n
* The default value is 0.\n
* The supported value range is unlimited.\n
*/
#define OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL 1
/*! \brief Stereo Separation
*
* The related value represents the stereo separation generated by the libopenmpt mixer in percent.\n
* The default value is 100.\n
* The supported value range is [0,200].\n
*/
#define OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT 2
/*! \brief Interpolation Filter
*
* The related value represents the interpolation filter length used by the libopenmpt mixer.\n
* The default value is 0, which indicates a recommended default value.\n
* The supported value range is [0,inf). Values greater than the implementation limit are clamped to the maximum supported value.\n
* Currently supported values:
* - 0: internal default
* - 1: no interpolation (zero order hold)
* - 2: linear interpolation
* - 4: cubic interpolation
* - 8: windowed sinc with 8 taps
*/
#define OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH 3
/*! \brief Volume Ramping Strength
*
* The related value represents the amount of volume ramping done by the libopenmpt mixer.\n
* The default value is -1, which indicates a recommended default value.\n
* The meaningful value range is [-1..10].\n
* A value of 0 completely disables volume ramping. This might cause clicks in sound output.\n
* Higher values imply slower/softer volume ramps.
*/
#define OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH 4
/** @}*/
/**
* \defgroup openmpt_module_command_index Pattern cell indices
*
* \brief Parameter index to use with openmpt_module_get_pattern_row_channel_command(), openmpt_module_format_pattern_row_channel_command() and openmpt_module_highlight_pattern_row_channel_command()
* @{
*/
#define OPENMPT_MODULE_COMMAND_NOTE 0
#define OPENMPT_MODULE_COMMAND_INSTRUMENT 1
#define OPENMPT_MODULE_COMMAND_VOLUMEEFFECT 2
#define OPENMPT_MODULE_COMMAND_EFFECT 3
#define OPENMPT_MODULE_COMMAND_VOLUME 4
#define OPENMPT_MODULE_COMMAND_PARAMETER 5
/** @}*/
/*! \brief Select a sub-song from a multi-song module
*
* \param mod The module handle to work on.
* \param subsong Index of the sub-song. -1 plays all sub-songs consecutively.
* \return 1 on success, 0 on failure.
* \sa openmpt_module_get_num_subsongs, openmpt_module_get_selected_subsong, openmpt_module_get_subsong_name
* \remarks Whether subsong -1 (all subsongs consecutively), subsong 0 or some other subsong is selected by default, is an implementation detail and subject to change. If you do not want to care about subsongs, it is recommended to just not call openmpt_module_select_subsong() at all.
*/
LIBOPENMPT_API int openmpt_module_select_subsong( openmpt_module * mod, int32_t subsong );
/*! \brief Get currently selected sub-song from a multi-song module
*
* \param mod The module handle to work on.
* \return Currently selected sub-song. -1 for all subsongs consecutively, 0 or greater for the current sub-song index.
* \sa openmpt_module_get_num_subsongs, openmpt_module_select_subsong, openmpt_module_get_subsong_name
* \since 0.3.0
*/
LIBOPENMPT_API int32_t openmpt_module_get_selected_subsong( openmpt_module * mod );
/*! \brief Set Repeat Count
*
* \param mod The module handle to work on.
* \param repeat_count Repeat Count
* - -1: repeat forever
* - 0: play once, repeat zero times (the default)
* - n>0: play once and repeat n times after that
* \return 1 on success, 0 on failure.
* \sa openmpt_module_get_repeat_count
*/
LIBOPENMPT_API int openmpt_module_set_repeat_count( openmpt_module * mod, int32_t repeat_count );
/*! \brief Get Repeat Count
*
* \param mod The module handle to work on.
* \return Repeat Count
* - -1: repeat forever
* - 0: play once, repeat zero times (the default)
* - n>0: play once and repeat n times after that
* \sa openmpt_module_set_repeat_count
*/
LIBOPENMPT_API int32_t openmpt_module_get_repeat_count( openmpt_module * mod );
/*! \brief approximate song duration
*
* \param mod The module handle to work on.
* \return Approximate duration of current sub-song in seconds.
* \remarks The function may return infinity if the pattern data is too complex to evaluate.
*/
LIBOPENMPT_API double openmpt_module_get_duration_seconds( openmpt_module * mod );
/*! \brief Set approximate current song position
*
* \param mod The module handle to work on.
* \param seconds Seconds to seek to. If seconds is out of range, the position gets set to song start or end respectively.
* \return Approximate new song position in seconds.
* \sa openmpt_module_get_position_seconds
*/
LIBOPENMPT_API double openmpt_module_set_position_seconds( openmpt_module * mod, double seconds );
/*! \brief Get current song position
*
* \param mod The module handle to work on.
* \return Current song position in seconds.
* \sa openmpt_module_set_position_seconds
*/
LIBOPENMPT_API double openmpt_module_get_position_seconds( openmpt_module * mod );
/*! \brief Set approximate current song position
*
* If order or row are out of range, to position is not modified and the current position is returned.
* \param mod The module handle to work on.
* \param order Pattern order number to seek to.
* \param row Pattern row number to seek to.
* \return Approximate new song position in seconds.
* \sa openmpt_module_set_position_seconds
* \sa openmpt_module_get_position_seconds
*/
LIBOPENMPT_API double openmpt_module_set_position_order_row( openmpt_module * mod, int32_t order, int32_t row );
/*! \brief Get render parameter
*
* \param mod The module handle to work on.
* \param param Parameter to query. See \ref openmpt_module_render_param
* \param value Pointer to the variable that receives the current value of the parameter.
* \return 1 on success, 0 on failure (invalid param or value is NULL).
* \sa OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL
* \sa OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT
* \sa OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH
* \sa OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH
* \sa openmpt_module_set_render_param
*/
LIBOPENMPT_API int openmpt_module_get_render_param( openmpt_module * mod, int param, int32_t * value );
/*! \brief Set render parameter
*
* \param mod The module handle to work on.
* \param param Parameter to set. See \ref openmpt_module_render_param
* \param value The value to set param to.
* \return 1 on success, 0 on failure (invalid param).
* \sa OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL
* \sa OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT
* \sa OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH
* \sa OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH
* \sa openmpt_module_get_render_param
*/
LIBOPENMPT_API int openmpt_module_set_render_param( openmpt_module * mod, int param, int32_t value );
/*@{*/
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param mono Pointer to a buffer of at least count elements that receives the mono/center output.
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks It is recommended to use the floating point API because of the greater dynamic range and no implied clipping.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_mono( openmpt_module * mod, int32_t samplerate, size_t count, int16_t * mono );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param left Pointer to a buffer of at least count elements that receives the left output.
* \param right Pointer to a buffer of at least count elements that receives the right output.
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks It is recommended to use the floating point API because of the greater dynamic range and no implied clipping.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_stereo( openmpt_module * mod, int32_t samplerate, size_t count, int16_t * left, int16_t * right );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param left Pointer to a buffer of at least count elements that receives the left output.
* \param right Pointer to a buffer of at least count elements that receives the right output.
* \param rear_left Pointer to a buffer of at least count elements that receives the rear left output.
* \param rear_right Pointer to a buffer of at least count elements that receives the rear right output.
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks It is recommended to use the floating point API because of the greater dynamic range and no implied clipping.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_quad( openmpt_module * mod, int32_t samplerate, size_t count, int16_t * left, int16_t * right, int16_t * rear_left, int16_t * rear_right );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param mono Pointer to a buffer of at least count elements that receives the mono/center output.
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks Floating point samples are in the [-1.0..1.0] nominal range. They are not clipped to that range though and thus might overshoot.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_float_mono( openmpt_module * mod, int32_t samplerate, size_t count, float * mono );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param left Pointer to a buffer of at least count elements that receives the left output.
* \param right Pointer to a buffer of at least count elements that receives the right output.
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks Floating point samples are in the [-1.0..1.0] nominal range. They are not clipped to that range though and thus might overshoot.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_float_stereo( openmpt_module * mod, int32_t samplerate, size_t count, float * left, float * right );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param left Pointer to a buffer of at least count elements that receives the left output.
* \param right Pointer to a buffer of at least count elements that receives the right output.
* \param rear_left Pointer to a buffer of at least count elements that receives the rear left output.
* \param rear_right Pointer to a buffer of at least count elements that receives the rear right output.
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks Floating point samples are in the [-1.0..1.0] nominal range. They are not clipped to that range though and thus might overshoot.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_float_quad( openmpt_module * mod, int32_t samplerate, size_t count, float * left, float * right, float * rear_left, float * rear_right );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param interleaved_stereo Pointer to a buffer of at least count*2 elements that receives the interleaved stereo output in the order (L,R).
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks It is recommended to use the floating point API because of the greater dynamic range and no implied clipping.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_interleaved_stereo( openmpt_module * mod, int32_t samplerate, size_t count, int16_t * interleaved_stereo );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param interleaved_quad Pointer to a buffer of at least count*4 elements that receives the interleaved quad surround output in the order (L,R,RL,RR).
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks It is recommended to use the floating point API because of the greater dynamic range and no implied clipping.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_interleaved_quad( openmpt_module * mod, int32_t samplerate, size_t count, int16_t * interleaved_quad );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param interleaved_stereo Pointer to a buffer of at least count*2 elements that receives the interleaved stereo output in the order (L,R).
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks Floating point samples are in the [-1.0..1.0] nominal range. They are not clipped to that range though and thus might overshoot.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_interleaved_float_stereo( openmpt_module * mod, int32_t samplerate, size_t count, float * interleaved_stereo );
/*! \brief Render audio data
*
* \param mod The module handle to work on.
* \param samplerate Sample rate to render output. Should be in [8000,192000], but this is not enforced.
* \param count Number of audio frames to render per channel.
* \param interleaved_quad Pointer to a buffer of at least count*4 elements that receives the interleaved quad surround output in the order (L,R,RL,RR).
* \return The number of frames actually rendered.
* \retval 0 The end of song has been reached.
* \remarks The output buffers are only written to up to the returned number of elements.
* \remarks You can freely switch between any of the "openmpt_module_read*" variants if you see a need to do so. libopenmpt tries to introduce as little switching annoyances as possible. Normally, you would only use a single one of these functions for rendering a particular module.
* \remarks Floating point samples are in the [-1.0..1.0] nominal range. They are not clipped to that range though and thus might overshoot.
* \sa \ref libopenmpt_c_outputformat
*/
LIBOPENMPT_API size_t openmpt_module_read_interleaved_float_quad( openmpt_module * mod, int32_t samplerate, size_t count, float * interleaved_quad );
/*@}*/
/*! \brief Get the list of supported metadata item keys
*
* \param mod The module handle to work on.
* \return Metadata item keys supported by openmpt_module_get_metadata, as a semicolon-separated list.
* \sa openmpt_module_get_metadata
*/
LIBOPENMPT_API const char * openmpt_module_get_metadata_keys( openmpt_module * mod );
/*! \brief Get a metadata item value
*
* \param mod The module handle to work on.
* \param key Metadata item key to query. Use openmpt_module_get_metadata_keys to check for available keys.
* Possible keys are:
* - type: Module format extension (e.g. it) or another similar identifier for modules formats that typically do not use a file extension
* - type_long: Format name associated with the module format (e.g. Impulse Tracker)
* - originaltype: Module format extension (e.g. it) of the original module in case the actual type is a converted format (e.g. mo3 or gdm)
* - originaltype_long: Format name associated with the module format (e.g. Impulse Tracker) of the original module in case the actual type is a converted format (e.g. mo3 or gdm)
* - container: Container format the module file is embedded in, if any (e.g. umx)
* - container_long: Full container name if the module is embedded in a container (e.g. Unreal Music)
* - tracker: Tracker that was (most likely) used to save the module file, if known
* - artist: Author of the module
* - title: Module title
* - date: Date the module was last saved, in ISO-8601 format.
* - message: Song message. If the song message is empty or the module format does not support song messages, a list of instrument and sample names is returned instead.
* - message_raw: Song message. If the song message is empty or the module format does not support song messages, an empty string is returned.
* - warnings: A list of warnings that were generated while loading the module.
* \return The associated value for key.
* \sa openmpt_module_get_metadata_keys
*/
LIBOPENMPT_API const char * openmpt_module_get_metadata( openmpt_module * mod, const char * key );
/*! Get the current estimated beats per minute (BPM).
*
* \param mod The module handle to work on.
* \remarks Many module formats lack time signature metadata. It is common that this estimate is off by a factor of two, but other multipliers are also possible.
* \remarks Due to the nature of how module tempo works, the estimate may change slightly after switching libopenmpt's output to a different sample rate.
* \return The current estimated BPM.
*/
LIBOPENMPT_API double openmpt_module_get_current_estimated_bpm( openmpt_module * mod );
/*! \brief Get the current speed
*
* \param mod The module handle to work on.
* \return The current speed in ticks per row.
*/
LIBOPENMPT_API int32_t openmpt_module_get_current_speed( openmpt_module * mod );
/*! \brief Get the current tempo
*
* \param mod The module handle to work on.
* \return The current tempo in tracker units. The exact meaning of this value depends on the tempo mode being used.
*/
LIBOPENMPT_API int32_t openmpt_module_get_current_tempo( openmpt_module * mod );
/*! \brief Get the current order
*
* \param mod The module handle to work on.
* \return The current order at which the module is being played back.
*/
LIBOPENMPT_API int32_t openmpt_module_get_current_order( openmpt_module * mod );
/*! \brief Get the current pattern
*
* \param mod The module handle to work on.
* \return The current pattern that is being played.
*/
LIBOPENMPT_API int32_t openmpt_module_get_current_pattern( openmpt_module * mod );
/*! \brief Get the current row
*
* \param mod The module handle to work on.
* \return The current row at which the current pattern is being played.
*/
LIBOPENMPT_API int32_t openmpt_module_get_current_row( openmpt_module * mod );
/*! \brief Get the current amount of playing channels.
*
* \param mod The module handle to work on.
* \return The amount of sample channels that are currently being rendered.
*/
LIBOPENMPT_API int32_t openmpt_module_get_current_playing_channels( openmpt_module * mod );
/*! \brief Get an approximate indication of the channel volume.
*
* \param mod The module handle to work on.
* \param channel The channel whose volume should be retrieved.
* \return The approximate channel volume.
* \remarks The returned value is solely based on the note velocity and does not take the actual waveform of the playing sample into account.
*/
LIBOPENMPT_API float openmpt_module_get_current_channel_vu_mono( openmpt_module * mod, int32_t channel );
/*! \brief Get an approximate indication of the channel volume on the front-left speaker.
*
* \param mod The module handle to work on.
* \param channel The channel whose volume should be retrieved.
* \return The approximate channel volume.
* \remarks The returned value is solely based on the note velocity and does not take the actual waveform of the playing sample into account.
*/
LIBOPENMPT_API float openmpt_module_get_current_channel_vu_left( openmpt_module * mod, int32_t channel );
/*! \brief Get an approximate indication of the channel volume on the front-right speaker.
*
* \param mod The module handle to work on.
* \param channel The channel whose volume should be retrieved.
* \return The approximate channel volume.
* \remarks The returned value is solely based on the note velocity and does not take the actual waveform of the playing sample into account.
*/
LIBOPENMPT_API float openmpt_module_get_current_channel_vu_right( openmpt_module * mod, int32_t channel );
/*! \brief Get an approximate indication of the channel volume on the rear-left speaker.
*
* \param mod The module handle to work on.
* \param channel The channel whose volume should be retrieved.
* \return The approximate channel volume.
* \remarks The returned value is solely based on the note velocity and does not take the actual waveform of the playing sample into account.
*/
LIBOPENMPT_API float openmpt_module_get_current_channel_vu_rear_left( openmpt_module * mod, int32_t channel );
/*! \brief Get an approximate indication of the channel volume on the rear-right speaker.
*
* \param mod The module handle to work on.
* \param channel The channel whose volume should be retrieved.
* \return The approximate channel volume.
* \remarks The returned value is solely based on the note velocity and does not take the actual waveform of the playing sample into account.
*/
LIBOPENMPT_API float openmpt_module_get_current_channel_vu_rear_right( openmpt_module * mod, int32_t channel );
/*! \brief Get the number of sub-songs
*
* \param mod The module handle to work on.
* \return The number of sub-songs in the module. This includes any "hidden" songs (songs that share the same sequence, but start at different order indices) and "normal" sub-songs or "sequences" (if the format supports them).
* \sa openmpt_module_get_subsong_name, openmpt_module_select_subsong, openmpt_module_get_selected_subsong
*/
LIBOPENMPT_API int32_t openmpt_module_get_num_subsongs( openmpt_module * mod );
/*! \brief Get the number of pattern channels
*
* \param mod The module handle to work on.
* \return The number of pattern channels in the module. Not all channels do necessarily contain data.
* \remarks The number of pattern channels is completely independent of the number of output channels. libopenmpt can render modules in mono, stereo or quad surround, but the choice of which of the three modes to use must not be made based on the return value of this function, which may be any positive integer amount. Only use this function for informational purposes.
*/
LIBOPENMPT_API int32_t openmpt_module_get_num_channels( openmpt_module * mod );
/*! \brief Get the number of orders
*
* \param mod The module handle to work on.
* \return The number of orders in the current sequence of the module.
*/
LIBOPENMPT_API int32_t openmpt_module_get_num_orders( openmpt_module * mod );
/*! \brief Get the number of patterns
*
* \param mod The module handle to work on.
* \return The number of distinct patterns in the module.
*/
LIBOPENMPT_API int32_t openmpt_module_get_num_patterns( openmpt_module * mod );
/*! \brief Get the number of instruments
*
* \param mod The module handle to work on.
* \return The number of instrument slots in the module. Instruments are a layer on top of samples, and are not supported by all module formats.
*/
LIBOPENMPT_API int32_t openmpt_module_get_num_instruments( openmpt_module * mod );
/*! \brief Get the number of samples
*
* \param mod The module handle to work on.
* \return The number of sample slots in the module.
*/
LIBOPENMPT_API int32_t openmpt_module_get_num_samples( openmpt_module * mod );
/*! \brief Get a sub-song name
*
* \param mod The module handle to work on.
* \param index The sub-song whose name should be retrieved
* \return The sub-song name.
* \sa openmpt_module_get_num_subsongs, openmpt_module_select_subsong, openmpt_module_get_selected_subsong
*/
LIBOPENMPT_API const char * openmpt_module_get_subsong_name( openmpt_module * mod, int32_t index );
/*! \brief Get a channel name
*
* \param mod The module handle to work on.
* \param index The channel whose name should be retrieved
* \return The channel name.
* \sa openmpt_module_get_num_channels
*/
LIBOPENMPT_API const char * openmpt_module_get_channel_name( openmpt_module * mod, int32_t index );
/*! \brief Get an order name
*
* \param mod The module handle to work on.
* \param index The order whose name should be retrieved
* \return The order name.
* \sa openmpt_module_get_num_orders
*/
LIBOPENMPT_API const char * openmpt_module_get_order_name( openmpt_module * mod, int32_t index );
/*! \brief Get a pattern name
*
* \param mod The module handle to work on.
* \param index The pattern whose name should be retrieved
* \return The pattern name.
* \sa openmpt_module_get_num_patterns
*/
LIBOPENMPT_API const char * openmpt_module_get_pattern_name( openmpt_module * mod, int32_t index );
/*! \brief Get an instrument name
*
* \param mod The module handle to work on.
* \param index The instrument whose name should be retrieved
* \return The instrument name.
* \sa openmpt_module_get_num_instruments
*/
LIBOPENMPT_API const char * openmpt_module_get_instrument_name( openmpt_module * mod, int32_t index );
/*! \brief Get a sample name
*
* \param mod The module handle to work on.
* \param index The sample whose name should be retrieved
* \return The sample name.
* \sa openmpt_module_get_num_samples
*/
LIBOPENMPT_API const char * openmpt_module_get_sample_name( openmpt_module * mod, int32_t index );
/*! \brief Get pattern at order position
*
* \param mod The module handle to work on.
* \param order The order item whose pattern index should be retrieved.
* \return The pattern index found at the given order position of the current sequence.
*/
LIBOPENMPT_API int32_t openmpt_module_get_order_pattern( openmpt_module * mod, int32_t order );
/*! \brief Get the number of rows in a pattern
*
* \param mod The module handle to work on.
* \param pattern The pattern whose row count should be retrieved.
* \return The number of rows in the given pattern. If the pattern does not exist, 0 is returned.
*/
LIBOPENMPT_API int32_t openmpt_module_get_pattern_num_rows( openmpt_module * mod, int32_t pattern );
/*! \brief Get raw pattern content
*
* \param mod The module handle to work on.
* \param pattern The pattern whose data should be retrieved.
* \param row The row from which the data should be retrieved.
* \param channel The channel from which the data should be retrieved.
* \param command The cell index at which the data should be retrieved. See \ref openmpt_module_command_index
* \return The internal, raw pattern data at the given pattern position.
*/
LIBOPENMPT_API uint8_t openmpt_module_get_pattern_row_channel_command( openmpt_module * mod, int32_t pattern, int32_t row, int32_t channel, int command );
/*! \brief Get formatted (human-readable) pattern content
*
* \param mod The module handle to work on.
* \param pattern The pattern whose data should be retrieved.
* \param row The row from which the data should be retrieved.
* \param channel The channel from which the data should be retrieved.
* \param command The cell index at which the data should be retrieved.
* \return The formatted pattern data at the given pattern position. See \ref openmpt_module_command_index
* \sa openmpt_module_highlight_pattern_row_channel_command
*/
LIBOPENMPT_API const char * openmpt_module_format_pattern_row_channel_command( openmpt_module * mod, int32_t pattern, int32_t row, int32_t channel, int command );
/*! \brief Get highlighting information for formatted pattern content
*
* \param mod The module handle to work on.
* \param pattern The pattern whose data should be retrieved.
* \param row The row from which the data should be retrieved.
* \param channel The channel from which the data should be retrieved.
* \param command The cell index at which the data should be retrieved. See \ref openmpt_module_command_index
* \return The highlighting string for the formatted pattern data as retrieved by openmpt_module_get_pattern_row_channel_command at the given pattern position.
* \remarks The returned string will map each character position of the string returned by openmpt_module_get_pattern_row_channel_command to a highlighting instruction.
* Possible highlighting characters are:
* - " " : empty/space
* - "." : empty/dot
* - "n" : generic note
* - "m" : special note
* - "i" : generic instrument
* - "u" : generic volume column effect
* - "v" : generic volume column parameter
* - "e" : generic effect column effect
* - "f" : generic effect column parameter
* \sa openmpt_module_get_pattern_row_channel_command
*/
LIBOPENMPT_API const char * openmpt_module_highlight_pattern_row_channel_command( openmpt_module * mod, int32_t pattern, int32_t row, int32_t channel, int command );
/*! \brief Get formatted (human-readable) pattern content
*
* \param mod The module handle to work on.
* \param pattern The pattern whose data should be retrieved.
* \param row The row from which the data should be retrieved.
* \param channel The channel from which the data should be retrieved.
* \param width The maximum number of characters the string should contain. 0 means no limit.
* \param pad If true, the string will be resized to the exact length provided in the width parameter.
* \return The formatted pattern data at the given pattern position.
* \sa openmpt_module_highlight_pattern_row_channel
*/
LIBOPENMPT_API const char * openmpt_module_format_pattern_row_channel( openmpt_module * mod, int32_t pattern, int32_t row, int32_t channel, size_t width, int pad );
/*! \brief Get highlighting information for formatted pattern content
*
* \param mod The module handle to work on.
* \param pattern The pattern whose data should be retrieved.
* \param row The row from which the data should be retrieved.
* \param channel The channel from which the data should be retrieved.
* \param width The maximum number of characters the string should contain. 0 means no limit.
* \param pad If true, the string will be resized to the exact length provided in the width parameter.
* \return The highlighting string for the formatted pattern data as retrieved by openmpt_module_format_pattern_row_channel at the given pattern position.
* \sa openmpt_module_format_pattern_row_channel
*/
LIBOPENMPT_API const char * openmpt_module_highlight_pattern_row_channel( openmpt_module * mod, int32_t pattern, int32_t row, int32_t channel, size_t width, int pad );
/*! \brief Retrieve supported ctl keys
*
* \param mod The module handle to work on.
* \return A semicolon-separated list containing all supported ctl keys.
* \remarks Currently supported ctl values are:
* - load.skip_samples (boolean): Set to "1" to avoid loading samples into memory
* - load.skip_patterns (boolean): Set to "1" to avoid loading patterns into memory
* - load.skip_plugins (boolean): Set to "1" to avoid loading plugins
* - load.skip_subsongs_init (boolean): Set to "1" to avoid pre-initializing sub-songs. Skipping results in faster module loading but slower seeking.
* - seek.sync_samples (boolean): Set to "1" to sync sample playback when using openmpt_module_set_position_seconds or openmpt_module_set_position_order_row.
* - subsong (integer): The current subsong. Setting it has identical semantics as openmpt_module_select_subsong(), getting it returns the currently selected subsong.
* - play.at_end (text): Chooses the behaviour when the end of song is reached:
* - "fadeout": Fades the module out for a short while. Subsequent reads after the fadeout will return 0 rendered frames.
* - "continue": Returns 0 rendered frames when the song end is reached. Subsequent reads will continue playing from the song start or loop start.
* - "stop": Returns 0 rendered frames when the song end is reached. Subsequent reads will return 0 rendered frames.
* - play.tempo_factor (floatingpoint): Set a floating point tempo factor. "1.0" is the default tempo.
* - play.pitch_factor (floatingpoint): Set a floating point pitch factor. "1.0" is the default pitch.
* - render.resampler.emulate_amiga (boolean): Set to "1" to enable the Amiga resampler for Amiga modules. This emulates the sound characteristics of the Paula chip and overrides the selected interpolation filter. Non-Amiga module formats are not affected by this setting.
* - render.resampler.emulate_amiga_type (string): Configures the filter type to use for the Amiga resampler. Supported values are:
* - "auto": Filter type is chosen by the library and might change. This is the default.
* - "a500": Amiga A500 filter.
* - "a1200": Amiga A1200 filter.
* - "unfiltered": BLEP synthesis without model-specific filters. The LED filter is ignored by this setting. This filter mode is considered to be experimental and might change in the future.
* - render.opl.volume_factor (floatingpoint): Set volume factor applied to synthesized OPL sounds, relative to the default OPL volume.
* - dither (integer): Set the dither algorithm that is used for the 16 bit versions of openmpt_module_read. Supported values are:
* - 0: No dithering.
* - 1: Default mode. Chosen by OpenMPT code, might change.
* - 2: Rectangular, 0.5 bit depth, no noise shaping (original ModPlug Tracker).
* - 3: Rectangular, 1 bit depth, simple 1st order noise shaping
*/
LIBOPENMPT_API const char * openmpt_module_get_ctls( openmpt_module * mod );
/*! \brief Get current ctl value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be retrieved.
* \return The associated ctl value, or NULL on failure.
* \sa openmpt_module_get_ctls
* \deprecated Please use openmpt_module_ctl_get_boolean(), openmpt_module_ctl_get_integer(), openmpt_module_ctl_get_floatingpoint(), or openmpt_module_ctl_get_text().
*/
LIBOPENMPT_API LIBOPENMPT_DEPRECATED const char * openmpt_module_ctl_get( openmpt_module * mod, const char * ctl );
/*! \brief Get current ctl boolean value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be retrieved.
* \return The associated ctl value, or NULL on failure.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API int openmpt_module_ctl_get_boolean( openmpt_module * mod, const char * ctl );
/*! \brief Get current ctl integer value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be retrieved.
* \return The associated ctl value, or NULL on failure.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API int64_t openmpt_module_ctl_get_integer( openmpt_module * mod, const char * ctl );
/*! \brief Get current ctl floatingpoint value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be retrieved.
* \return The associated ctl value, or NULL on failure.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API double openmpt_module_ctl_get_floatingpoint( openmpt_module * mod, const char * ctl );
/*! \brief Get current ctl string value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be retrieved.
* \return The associated ctl value, or NULL on failure.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API const char * openmpt_module_ctl_get_text( openmpt_module * mod, const char * ctl );
/*! \brief Set ctl value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be set.
* \param value The value that should be set.
* \return 1 if successful, 0 in case the value is not sensible (e.g. negative tempo factor) or the ctl is not recognized.
* \sa openmpt_module_get_ctls
* \deprecated Please use openmpt_module_ctl_set_boolean(), openmpt_module_ctl_set_integer(), openmpt_module_ctl_set_floatingpoint(), or openmpt_module_ctl_set_text().
*/
LIBOPENMPT_API LIBOPENMPT_DEPRECATED int openmpt_module_ctl_set( openmpt_module * mod, const char * ctl, const char * value );
/*! \brief Set ctl boolean value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be set.
* \param value The value that should be set.
* \return 1 if successful, 0 in case the value is not sensible (e.g. negative tempo factor) or the ctl is not recognized.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API int openmpt_module_ctl_set_boolean( openmpt_module * mod, const char * ctl, int value );
/*! \brief Set ctl integer value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be set.
* \param value The value that should be set.
* \return 1 if successful, 0 in case the value is not sensible (e.g. negative tempo factor) or the ctl is not recognized.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API int openmpt_module_ctl_set_integer( openmpt_module * mod, const char * ctl, int64_t value );
/*! \brief Set ctl floatingpoint value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be set.
* \param value The value that should be set.
* \return 1 if successful, 0 in case the value is not sensible (e.g. negative tempo factor) or the ctl is not recognized.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API int openmpt_module_ctl_set_floatingpoint( openmpt_module * mod, const char * ctl, double value );
/*! \brief Set ctl string value
*
* \param mod The module handle to work on.
* \param ctl The ctl key whose value should be set.
* \param value The value that should be set.
* \return 1 if successful, 0 in case the value is not sensible (e.g. negative tempo factor) or the ctl is not recognized.
* \sa openmpt_module_get_ctls
* \since 0.5.0
*/
LIBOPENMPT_API int openmpt_module_ctl_set_text( openmpt_module * mod, const char * ctl, const char * value );
/* remember to add new functions to both C and C++ interfaces and to increase OPENMPT_API_VERSION_MINOR */
#ifdef __cplusplus
}
#endif
/*!
* @}
*/
#endif /* LIBOPENMPT_H */