libopenmpt  0.2.4943
cross-platform C++ and C library to decode tracked music files
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 <vector>
21 
22 #ifndef LIBOPENMPT_ANCIENT_COMPILER
23 #include <cstdint>
24 #endif
25 
64 namespace openmpt {
65 
66 class LIBOPENMPT_CXX_API exception : public std::exception {
67 private:
68  char * text;
69 public:
70  exception( const std::string & text ) throw();
71  virtual ~exception() throw();
72  virtual const char * what() const throw();
73 }; // class exception
74 
76 
80 LIBOPENMPT_CXX_API std::uint32_t get_library_version();
81 
83 
87 LIBOPENMPT_CXX_API std::uint32_t get_core_version();
88 
89 namespace string {
90 
92 static const char library_version [] = "library_version";
94 static const char library_features[] = "library_features";
96 static const char core_version [] = "core_version";
98 static const char build [] = "build";
100 static const char credits [] = "credits";
102 static const char contact [] = "contact";
104 static const char license [] = "license";
105 
107 
117 LIBOPENMPT_CXX_API std::string get( const std::string & key );
118 
119 } // namespace string
120 
122 
125 LIBOPENMPT_CXX_API std::vector<std::string> get_supported_extensions();
126 
128 
132 LIBOPENMPT_CXX_API bool is_extension_supported( const std::string & extension );
133 
135 
141 LIBOPENMPT_CXX_API double could_open_propability( std::istream & stream, double effort = 1.0, std::ostream & log = std::clog );
142 
143 class module_impl;
144 
145 class module_ext;
146 
147 namespace detail {
148 
149 typedef std::map< std::string, std::string > initial_ctls_map;
150 
151 } // namespace detail
152 
153 class LIBOPENMPT_CXX_API module {
154 
155  friend class module_ext;
156 
157 public:
158 
162 
167  RENDER_MASTERGAIN_MILLIBEL = 1,
169 
174  RENDER_STEREOSEPARATION_PERCENT = 2,
176 
187  RENDER_INTERPOLATIONFILTER_LENGTH = 3,
189 
196  RENDER_VOLUMERAMPING_STRENGTH = 4
197  };
198 
201  command_note = 0,
202  command_instrument = 1,
203  command_volumeffect = 2,
204  command_effect = 3,
205  command_volume = 4,
206  command_parameter = 5
207  };
208 
209 private:
210  module_impl * impl;
211 private:
212  // non-copyable
213  module( const module & );
214  void operator = ( const module & );
215 private:
216  // for module_ext
217  module();
218  void set_impl( module_impl * i );
219 public:
221 
228  module( std::istream & stream, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
236  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() );
245  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() );
254  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() );
262  module( const std::vector<char> & data, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
271  module( const char * beg, const char * end, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
280  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() );
289  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() );
290  virtual ~module();
291 public:
292 
294 
298  void select_subsong( std::int32_t subsong );
300 
307  void set_repeat_count( std::int32_t repeat_count );
309 
316  std::int32_t get_repeat_count() const;
317 
319 
322  double get_duration_seconds() const;
323 
325 
330  double set_position_seconds( double seconds );
332 
336  double get_position_seconds() const;
337 
339 
347  double set_position_order_row( std::int32_t order, std::int32_t row );
348 
350 
357  std::int32_t get_render_param( int param ) const;
359 
366  void set_render_param( int param, std::int32_t value );
367 
369 
370 
380  std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * mono );
382 
393  std::size_t read( std::int32_t samplerate, std::size_t count, std::int16_t * left, std::int16_t * right );
395 
408  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 );
410 
420  std::size_t read( std::int32_t samplerate, std::size_t count, float * mono );
422 
433  std::size_t read( std::int32_t samplerate, std::size_t count, float * left, float * right );
435 
448  std::size_t read( std::int32_t samplerate, std::size_t count, float * left, float * right, float * rear_left, float * rear_right );
450 
460  std::size_t read_interleaved_stereo( std::int32_t samplerate, std::size_t count, std::int16_t * interleaved_stereo );
462 
472  std::size_t read_interleaved_quad( std::int32_t samplerate, std::size_t count, std::int16_t * interleaved_quad );
474 
484  std::size_t read_interleaved_stereo( std::int32_t samplerate, std::size_t count, float * interleaved_stereo );
486 
496  std::size_t read_interleaved_quad( std::int32_t samplerate, std::size_t count, float * interleaved_quad );
499 
500 
504  std::vector<std::string> get_metadata_keys() const;
506 
511  std::string get_metadata( const std::string & key ) const;
512 
514 
517  std::int32_t get_current_speed() const;
519 
522  std::int32_t get_current_tempo() const;
524 
527  std::int32_t get_current_order() const;
529 
532  std::int32_t get_current_pattern() const;
534 
537  std::int32_t get_current_row() const;
539 
542  std::int32_t get_current_playing_channels() const;
543 
544  float get_current_channel_vu_mono( std::int32_t channel ) const;
545  float get_current_channel_vu_left( std::int32_t channel ) const;
546  float get_current_channel_vu_right( std::int32_t channel ) const;
547  float get_current_channel_vu_rear_left( std::int32_t channel ) const;
548  float get_current_channel_vu_rear_right( std::int32_t channel ) const;
549 
551 
554  std::int32_t get_num_subsongs() const;
556 
559  std::int32_t get_num_channels() const;
561 
564  std::int32_t get_num_orders() const;
566 
569  std::int32_t get_num_patterns() const;
571 
574  std::int32_t get_num_instruments() const;
576 
579  std::int32_t get_num_samples() const;
580 
581  std::vector<std::string> get_subsong_names() const;
582  std::vector<std::string> get_channel_names() const;
583  std::vector<std::string> get_order_names() const;
584  std::vector<std::string> get_pattern_names() const;
585  std::vector<std::string> get_instrument_names() const;
586  std::vector<std::string> get_sample_names() const;
587 
589 
593  std::int32_t get_order_pattern( std::int32_t order ) const;
594 
596 
600  std::int32_t get_pattern_num_rows( std::int32_t pattern ) const;
601 
603 
610  std::uint8_t get_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel, int command ) const;
611 
613 
621  std::string format_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel, int command ) const;
622 
624 
643  std::string highlight_pattern_row_channel_command( std::int32_t pattern, std::int32_t row, std::int32_t channel, int command ) const;
644 
646 
655  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;
657 
666  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;
667 
669 
686  std::vector<std::string> get_ctls() const;
687 
689 
694  std::string ctl_get( const std::string & ctl ) const;
696 
701  void ctl_set( const std::string & ctl, const std::string & value );
702 
703  // remember to add new functions to both C and C++ interfaces and to increase OPENMPT_API_VERSION_MINOR
704 
705 }; // class module
706 
707 } // namespace openmpt
708 
713 #endif // LIBOPENMPT_HPP