libopenmpt  0.6.0-pre.8+r14600
cross-platform C++ and C library to decode tracked music files
libopenmpt.hpp
Go to the documentation of this file.
1 /*
2  * libopenmpt.hpp
3  * --------------
4  * Purpose: libopenmpt public c++ interface
5  * Notes : (currently none)
6  * Authors: OpenMPT Devs
7  * The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
8  */
9 
10 #ifndef LIBOPENMPT_HPP
11 #define LIBOPENMPT_HPP
12 
13 #include "libopenmpt_config.h"
14 
15 #include <exception>
16 #include <iosfwd>
17 #include <iostream>
18 #include <map>
19 #include <string>
20 #include <string_view>
21 #include <vector>
22 
23 #include <cstddef>
24 #include <cstdint>
25 
134 namespace openmpt {
135 
136 #if defined(_MSC_VER)
137 #pragma warning(push)
138 #pragma warning(disable:4275)
139 #endif
140 
145 class LIBOPENMPT_CXX_API exception : public std::exception {
146 private:
147  char * text;
148 public:
149  exception( const std::string & text ) noexcept;
150  exception( const exception & other ) noexcept;
151  exception( exception && other ) noexcept;
152  exception & operator = ( const exception & other ) noexcept;
153  exception & operator = ( exception && other ) noexcept;
154  virtual ~exception() noexcept;
155  const char * what() const noexcept override;
156 }; // class exception
157 #if defined(_MSC_VER)
158 #pragma warning(pop)
159 #endif
160 
162 
167 LIBOPENMPT_CXX_API std::uint32_t get_library_version();
168 
170 
174 LIBOPENMPT_CXX_API std::uint32_t get_core_version();
175 
176 namespace string {
177 
179 static const char library_version LIBOPENMPT_ATTR_DEPRECATED [] = "library_version";
181 static const char library_features LIBOPENMPT_ATTR_DEPRECATED [] = "library_features";
183 static const char core_version LIBOPENMPT_ATTR_DEPRECATED [] = "core_version";
185 static const char build LIBOPENMPT_ATTR_DEPRECATED [] = "build";
187 static const char credits LIBOPENMPT_ATTR_DEPRECATED [] = "credits";
189 static const char contact LIBOPENMPT_ATTR_DEPRECATED [] = "contact";
191 static const char license LIBOPENMPT_ATTR_DEPRECATED [] = "license";
192 
194 
222 LIBOPENMPT_CXX_API std::string get( const std::string & key );
223 
224 } // namespace string
225 
227 
230 LIBOPENMPT_CXX_API std::vector<std::string> get_supported_extensions();
231 
233 
238 LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API bool is_extension_supported( const std::string & extension );
240 
245 LIBOPENMPT_CXX_API bool is_extension_supported2( std::string_view extension );
246 
248 
260 LIBOPENMPT_CXX_API double could_open_probability( std::istream & stream, double effort = 1.0, std::ostream & log = std::clog );
261 
263 
266 LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API double could_open_propability( std::istream & stream, double effort = 1.0, std::ostream & log = std::clog );
267 
269 
273 LIBOPENMPT_CXX_API std::size_t probe_file_header_get_recommended_size();
274 
276 static const std::uint64_t probe_file_header_flags_modules = 0x1ull;
277 
279 static const std::uint64_t probe_file_header_flags_containers = 0x2ull;
280 
282 static const std::uint64_t probe_file_header_flags_default = probe_file_header_flags_modules | probe_file_header_flags_containers;
283 
285 static const std::uint64_t probe_file_header_flags_none = 0x0ull;
286 
292 };
293 
295 
309 LIBOPENMPT_CXX_API int probe_file_header( std::uint64_t flags, const std::byte * data, std::size_t size, std::uint64_t filesize );
311 
325 LIBOPENMPT_CXX_API int probe_file_header( std::uint64_t flags, const std::uint8_t * data, std::size_t size, std::uint64_t filesize );
326 
328 
342 LIBOPENMPT_CXX_API int probe_file_header( std::uint64_t flags, const std::byte * data, std::size_t size );
344 
358 LIBOPENMPT_CXX_API int probe_file_header( std::uint64_t flags, const std::uint8_t * data, std::size_t size );
359 
361 
373 LIBOPENMPT_CXX_API int probe_file_header( std::uint64_t flags, std::istream & stream );
374 
375 class module_impl;
376 
377 class module_ext;
378 
379 namespace detail {
380 
381 typedef std::map< std::string, std::string > initial_ctls_map;
382 
383 } // namespace detail
384 
385 class LIBOPENMPT_CXX_API module {
386 
387  friend class module_ext;
388 
389 public:
390 
394 
399  RENDER_MASTERGAIN_MILLIBEL = 1,
401 
406  RENDER_STEREOSEPARATION_PERCENT = 2,
408 
419  RENDER_INTERPOLATIONFILTER_LENGTH = 3,
421 
428  RENDER_VOLUMERAMPING_STRENGTH = 4
429  };
430 
433  command_note = 0,
434  command_instrument = 1,
435  command_volumeffect = 2,
436  command_effect = 3,
437  command_volume = 4,
438  command_parameter = 5
439  };
440 
441 private:
442  module_impl * impl;
443 private:
444  // non-copyable
445  module( const module & );
446  void operator = ( const module & );
447 private:
448  // for module_ext
449  module();
450  void set_impl( module_impl * i );
451 public:
453 
461  module( std::istream & stream, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
471  module( const std::vector<std::byte> & data, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
482  module( const std::byte * beg, const std::byte * end, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
493  module( const std::byte * data, std::size_t size, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
502  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() );
512  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() );
522  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() );
531  module( const std::vector<char> & data, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
541  module( const char * beg, const char * end, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
551  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() );
561  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() );
562  virtual ~module();
563 public:
564 
566 
572  void select_subsong( std::int32_t subsong );
574 
579  std::int32_t get_selected_subsong() const;
581 
588  void set_repeat_count( std::int32_t repeat_count );
590 
597  std::int32_t get_repeat_count() const;
598 
600 
604  double get_duration_seconds() const;
605 
607 
612  double set_position_seconds( double seconds );
614 
618  double get_position_seconds() const;
619 
621 
629  double set_position_order_row( std::int32_t order, std::int32_t row );
630 
632 
639  std::int32_t get_render_param( int param ) const;
641 
648  void set_render_param( int param, std::int32_t value );
649 
651 
663  std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * mono );
665 
677  std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * left, std::int16_t * right );
679 
693  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 );
695 
706  std::size_t read( std::int32_t samplerate, std::size_t count, float * mono );
708 
720  std::size_t read( std::int32_t samplerate, std::size_t count, float * left, float * right );
722 
736  std::size_t read( std::int32_t samplerate, std::size_t count, float * left, float * right, float * rear_left, float * rear_right );
738 
749  std::size_t read_interleaved_stereo( std::int32_t samplerate, std::size_t count, std::int16_t * interleaved_stereo );
751 
762  std::size_t read_interleaved_quad( std::int32_t samplerate, std::size_t count, std::int16_t * interleaved_quad );
764 
775  std::size_t read_interleaved_stereo( std::int32_t samplerate, std::size_t count, float * interleaved_stereo );
777 
788  std::size_t read_interleaved_quad( std::int32_t samplerate, std::size_t count, float * interleaved_quad );
791 
796  std::vector<std::string> get_metadata_keys() const;
798 
817  std::string get_metadata( const std::string & key ) const;
818 
820 
825  double get_current_estimated_bpm() const;
827 
830  std::int32_t get_current_speed() const;
832 
835  std::int32_t get_current_tempo() const;
837 
840  std::int32_t get_current_order() const;
842 
845  std::int32_t get_current_pattern() const;
847 
850  std::int32_t get_current_row() const;
852 
855  std::int32_t get_current_playing_channels() const;
856 
858 
863  float get_current_channel_vu_mono( std::int32_t channel ) const;
865 
870  float get_current_channel_vu_left( std::int32_t channel ) const;
872 
877  float get_current_channel_vu_right( std::int32_t channel ) const;
879 
884  float get_current_channel_vu_rear_left( std::int32_t channel ) const;
886 
891  float get_current_channel_vu_rear_right( std::int32_t channel ) const;
892 
894 
898  std::int32_t get_num_subsongs() const;
900 
904  std::int32_t get_num_channels() const;
906 
909  std::int32_t get_num_orders() const;
911 
914  std::int32_t get_num_patterns() const;
916 
919  std::int32_t get_num_instruments() const;
921 
924  std::int32_t get_num_samples() const;
925 
927 
931  std::vector<std::string> get_subsong_names() const;
933 
937  std::vector<std::string> get_channel_names() const;
939 
943  std::vector<std::string> get_order_names() const;
945 
949  std::vector<std::string> get_pattern_names() const;
951 
955  std::vector<std::string> get_instrument_names() const;
957 
961  std::vector<std::string> get_sample_names() const;
962 
964 
968  std::int32_t get_order_pattern( std::int32_t order ) const;
969 
971 
975  std::int32_t get_pattern_num_rows( std::int32_t pattern ) const;
976 
978 
985  std::uint8_t get_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel, int command ) const;
986 
988 
996  std::string format_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel, int command ) const;
997 
999 
1018  std::string highlight_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel, int command ) const;
1019 
1021 
1030  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;
1032 
1041  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;
1042 
1044 
1074  std::vector<std::string> get_ctls() const;
1075 
1077 
1083  LIBOPENMPT_ATTR_DEPRECATED std::string ctl_get( const std::string & ctl ) const;
1085 
1091  bool ctl_get_boolean( std::string_view ctl ) const;
1093 
1099  std::int64_t ctl_get_integer( std::string_view ctl ) const;
1101 
1107  double ctl_get_floatingpoint( std::string_view ctl ) const;
1109 
1115  std::string ctl_get_text( std::string_view ctl ) const;
1116 
1118 
1125  LIBOPENMPT_ATTR_DEPRECATED void ctl_set( const std::string & ctl, const std::string & value );
1127 
1134  void ctl_set_boolean( std::string_view ctl, bool value );
1136 
1143  void ctl_set_integer( std::string_view ctl, std::int64_t value );
1145 
1152  void ctl_set_floatingpoint( std::string_view ctl, double value );
1154 
1161  void ctl_set_text( std::string_view ctl, std::string_view value );
1162 
1163  // remember to add new functions to both C and C++ interfaces and to increase OPENMPT_API_VERSION_MINOR
1164 
1165 }; // class module
1166 
1167 } // namespace openmpt
1168 
1173 #endif // LIBOPENMPT_HPP
command_index
Parameter index to use with openmpt::module::get_pattern_row_channel_command, openmpt::module::format...
Definition: libopenmpt.hpp:432
static const char library_version LIBOPENMPT_ATTR_DEPRECATED[]
Return a verbose library version string from openmpt::string::get().
Definition: libopenmpt.hpp:179
static const std::uint64_t probe_file_header_flags_containers
Probe for module-specific container formats in openmpt::probe_file_header().
Definition: libopenmpt.hpp:279
libopenmpt exception base class
Definition: libopenmpt.hpp:145
LIBOPENMPT_CXX_API std::size_t probe_file_header_get_recommended_size()
Get recommended header size for successfull format probing.
LIBOPENMPT_CXX_API std::uint32_t get_core_version()
Get the core version number.
static const std::uint64_t probe_file_header_flags_default
Probe for the default set of formats in openmpt::probe_file_header().
Definition: libopenmpt.hpp:282
Definition: libopenmpt.hpp:134
LIBOPENMPT_CXX_API std::uint32_t get_library_version()
Get the libopenmpt version number.
probe_file_header_result
Possible return values for openmpt::probe_file_header().
Definition: libopenmpt.hpp:288
static const std::uint64_t probe_file_header_flags_modules
Probe for module formats in openmpt::probe_file_header().
Definition: libopenmpt.hpp:276
LIBOPENMPT_CXX_API double could_open_probability(std::istream &stream, double effort=1.0, std::ostream &log=std::clog)
Roughly scan the input stream to find out whether libopenmpt might be able to open it...
Definition: libopenmpt.hpp:289
render_param
Parameter index to use with openmpt::module::get_render_param and openmpt::module::set_render_param.
Definition: libopenmpt.hpp:392
LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API bool is_extension_supported(const std::string &extension)
Query whether a file extension is supported.
LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API double could_open_propability(std::istream &stream, double effort=1.0, std::ostream &log=std::clog)
Roughly scan the input stream to find out whether libopenmpt might be able to open it...
LIBOPENMPT_CXX_API bool is_extension_supported2(std::string_view extension)
Query whether a file extension is supported.
Definition: libopenmpt_ext.hpp:37
static const std::uint64_t probe_file_header_flags_none
Probe for no formats in openmpt::probe_file_header().
Definition: libopenmpt.hpp:285
Definition: libopenmpt.hpp:385
LIBOPENMPT_CXX_API int probe_file_header(std::uint64_t flags, const std::byte *data, std::size_t size, std::uint64_t filesize)
Probe the provided bytes from the beginning of a file for supported file format headers to find out w...
Definition: libopenmpt.hpp:290
LIBOPENMPT_CXX_API std::vector< std::string > get_supported_extensions()
Get a list of supported file extensions.