10 #ifndef LIBOPENMPT_HPP
11 #define LIBOPENMPT_HPP
22 #ifndef LIBOPENMPT_QUIRK_NO_CSTDINT
28 typedef ::int8_t int8_t;
29 typedef ::int16_t int16_t;
30 typedef ::int32_t int32_t;
31 typedef ::int64_t int64_t;
32 typedef ::uint8_t uint8_t;
33 typedef ::uint16_t uint16_t;
34 typedef ::uint32_t uint32_t;
35 typedef ::uint64_t uint64_t;
36 using namespace ::
std;
144 class LIBOPENMPT_CXX_API
exception :
public std::exception {
148 exception(
const std::string & text ) LIBOPENMPT_NOEXCEPT;
149 virtual ~
exception() LIBOPENMPT_NOEXCEPT;
150 virtual const char * what()
const LIBOPENMPT_NOEXCEPT;
172 LIBOPENMPT_DEPRECATED static const char library_features LIBOPENMPT_ATTR_DEPRECATED [] =
"library_features";
204 LIBOPENMPT_CXX_API std::string
get(
const std::string & key );
231 LIBOPENMPT_CXX_API
double could_open_propability( std::istream & stream,
double effort = 1.0, std::ostream & log = std::clog );
239 typedef std::map< std::string, std::string > initial_ctls_map;
257 RENDER_MASTERGAIN_MILLIBEL = 1,
264 RENDER_STEREOSEPARATION_PERCENT = 2,
277 RENDER_INTERPOLATIONFILTER_LENGTH = 3,
286 RENDER_VOLUMERAMPING_STRENGTH = 4
292 command_instrument = 1,
293 command_volumeffect = 2,
296 command_parameter = 5
304 void operator = (
const module & );
308 void set_impl( module_impl * i );
319 module( std::istream & stream, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
328 module(
const std::vector<std::uint8_t> & data, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
338 module(
const std::uint8_t * beg,
const std::uint8_t * end, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
348 module(
const std::uint8_t * data, std::size_t size, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
357 module(
const std::vector<char> & data, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
367 module(
const char * beg,
const char * end, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
377 module(
const char * data, std::size_t size, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
387 module(
const void * data, std::size_t size, std::ostream & log = std::clog,
const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
398 void select_subsong( std::int32_t subsong );
407 void set_repeat_count( std::int32_t repeat_count );
416 std::int32_t get_repeat_count()
const;
422 double get_duration_seconds()
const;
430 double set_position_seconds(
double seconds );
436 double get_position_seconds()
const;
447 double set_position_order_row( std::int32_t order, std::int32_t row );
457 std::int32_t get_render_param(
int param )
const;
466 void set_render_param(
int param, std::int32_t value );
481 std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * mono );
495 std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * left, std::int16_t * right );
511 std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * left, std::int16_t * right, std::int16_t * rear_left, std::int16_t * rear_right );
524 std::size_t read( std::int32_t samplerate, std::size_t count,
float * mono );
538 std::size_t read( std::int32_t samplerate, std::size_t count,
float * left,
float * right );
554 std::size_t read( std::int32_t samplerate, std::size_t count,
float * left,
float * right,
float * rear_left,
float * rear_right );
567 std::size_t read_interleaved_stereo( std::int32_t samplerate, std::size_t count, std::int16_t * interleaved_stereo );
580 std::size_t read_interleaved_quad( std::int32_t samplerate, std::size_t count, std::int16_t * interleaved_quad );
593 std::size_t read_interleaved_stereo( std::int32_t samplerate, std::size_t count,
float * interleaved_stereo );
606 std::size_t read_interleaved_quad( std::int32_t samplerate, std::size_t count,
float * interleaved_quad );
614 std::vector<std::string> get_metadata_keys()
const;
633 std::string get_metadata(
const std::string & key )
const;
639 std::int32_t get_current_speed()
const;
644 std::int32_t get_current_tempo()
const;
649 std::int32_t get_current_order()
const;
654 std::int32_t get_current_pattern()
const;
659 std::int32_t get_current_row()
const;
664 std::int32_t get_current_playing_channels()
const;
672 float get_current_channel_vu_mono( std::int32_t channel )
const;
679 float get_current_channel_vu_left( std::int32_t channel )
const;
686 float get_current_channel_vu_right( std::int32_t channel )
const;
693 float get_current_channel_vu_rear_left( std::int32_t channel )
const;
700 float get_current_channel_vu_rear_right( std::int32_t channel )
const;
707 std::int32_t get_num_subsongs()
const;
713 std::int32_t get_num_channels()
const;
718 std::int32_t get_num_orders()
const;
723 std::int32_t get_num_patterns()
const;
728 std::int32_t get_num_instruments()
const;
733 std::int32_t get_num_samples()
const;
740 std::vector<std::string> get_subsong_names()
const;
746 std::vector<std::string> get_channel_names()
const;
752 std::vector<std::string> get_order_names()
const;
758 std::vector<std::string> get_pattern_names()
const;
764 std::vector<std::string> get_instrument_names()
const;
770 std::vector<std::string> get_sample_names()
const;
777 std::int32_t get_order_pattern( std::int32_t order )
const;
784 std::int32_t get_pattern_num_rows( std::int32_t pattern )
const;
794 std::uint8_t get_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel,
int command )
const;
805 std::string format_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel,
int command )
const;
827 std::string highlight_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel,
int command )
const;
839 std::string format_pattern_row_channel( std::int32_t pattern, std::int32_t row, std::int32_t channel, std::size_t width = 0,
bool pad =
true )
const;
850 std::string highlight_pattern_row_channel( std::int32_t pattern, std::int32_t row, std::int32_t channel, std::size_t width = 0,
bool pad =
true )
const;
872 std::vector<std::string> get_ctls()
const;
880 std::string ctl_get(
const std::string & ctl )
const;
887 void ctl_set(
const std::string & ctl,
const std::string & value );
899 #endif // LIBOPENMPT_HPP
#define LIBOPENMPT_DEPRECATED
Definition: libopenmpt_config.h:120
static const char library_version LIBOPENMPT_ATTR_DEPRECATED[]
Return a verbose library version string from openmpt::string::get().
Definition: libopenmpt.hpp:170
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...
render_param
Parameter index to use with openmpt::module::get_render_param and openmpt::module::set_render_param.
Definition: libopenmpt.hpp:250
Definition: libopenmpt.hpp:144
LIBOPENMPT_CXX_API std::uint32_t get_core_version()
Get the core version number.
Definition: libopenmpt.hpp:142
LIBOPENMPT_CXX_API std::uint32_t get_library_version()
Get the libopenmpt version number.
LIBOPENMPT_CXX_API bool is_extension_supported(const std::string &extension)
Query whether a file extension is supported.
command_index
Parameter index to use with openmpt::module::get_pattern_row_channel_command, openmpt::module::format...
Definition: libopenmpt.hpp:290
Definition: libopenmpt_ext.hpp:59
Definition: libopenmpt.hpp:243
LIBOPENMPT_CXX_API std::vector< std::string > get_supported_extensions()
Get a list of supported file extensions.