libopenmpt 0.5.13+release.autotools
cross-platform C++ and C library to decode tracked music files
Loading...
Searching...
No Matches
libopenmpt_ext.hpp
Go to the documentation of this file.
1/*
2 * libopenmpt_ext.hpp
3 * ------------------
4 * Purpose: libopenmpt public c++ interface for libopenmpt extensions
5 * Notes :
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_EXT_HPP
11#define LIBOPENMPT_EXT_HPP
12
13#include "libopenmpt_config.h"
14#include "libopenmpt.hpp"
15
33namespace openmpt {
34
35class module_ext_impl;
36
37class LIBOPENMPT_CXX_API module_ext : public module {
38
39private:
40 module_ext_impl * ext_impl;
41private:
42 // non-copyable
43 module_ext( const module_ext & );
44 void operator = ( const module_ext & );
45public:
46 module_ext( std::istream & stream, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
47 module_ext( const std::vector<std::byte> & data, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
48 module_ext( const std::vector<std::uint8_t> & data, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
49 module_ext( const std::vector<char> & data, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
50 module_ext( 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() );
51 module_ext( 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() );
52 module_ext( const char * data, std::size_t size, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
53 module_ext( const void * data, std::size_t size, std::ostream & log = std::clog, const std::map< std::string, std::string > & ctls = detail::initial_ctls_map() );
54 virtual ~module_ext();
55
56public:
57
59
76 void * get_interface( const std::string & interface_id );
77
78}; // class module_ext
79
80namespace ext {
81
82#define LIBOPENMPT_DECLARE_EXT_CXX_INTERFACE(name) \
83 static const char name ## _id [] = # name ; \
84 class name; \
85
86
87#define LIBOPENMPT_EXT_CXX_INTERFACE(name) \
88 protected: \
89 name () {} \
90 virtual ~ name () {} \
91 public: \
92
93
94
95#ifndef LIBOPENMPT_EXT_INTERFACE_PATTERN_VIS
96#define LIBOPENMPT_EXT_INTERFACE_PATTERN_VIS
97#endif
98
100
102
104
105
107
108 effect_unknown = 0,
109 effect_general = 1,
110 effect_global = 2,
111 effect_volume = 3,
112 effect_panning = 4,
113 effect_pitch = 5
114
115 }; // enum effect_type
116
118
125 virtual effect_type get_pattern_row_channel_volume_effect_type( std::int32_t pattern, std::int32_t row, std::int32_t channel ) const = 0;
126
128
135 virtual effect_type get_pattern_row_channel_effect_type( std::int32_t pattern, std::int32_t row, std::int32_t channel ) const = 0;
136
137}; // class pattern_vis
138
139
140#ifndef LIBOPENMPT_EXT_INTERFACE_INTERACTIVE
141#define LIBOPENMPT_EXT_INTERFACE_INTERACTIVE
142#endif
143
145
147
149
150
157 virtual void set_current_speed( std::int32_t speed ) = 0;
158
160
166 virtual void set_current_tempo( std::int32_t tempo ) = 0;
167
169
175 virtual void set_tempo_factor( double factor ) = 0;
176
178
182 virtual double get_tempo_factor( ) const = 0;
183
185
192 virtual void set_pitch_factor( double factor ) = 0;
193
195
200 virtual double get_pitch_factor( ) const = 0;
201
203
209 virtual void set_global_volume( double volume ) = 0;
210
212
216 virtual double get_global_volume( ) const = 0;
217
219
226 virtual void set_channel_volume( std::int32_t channel, double volume ) = 0;
227
229
235 virtual double get_channel_volume( std::int32_t channel ) const = 0;
236
238
244 virtual void set_channel_mute_status( std::int32_t channel, bool mute ) = 0;
245
247
253 virtual bool get_channel_mute_status( std::int32_t channel ) const = 0;
254
256
262 virtual void set_instrument_mute_status( std::int32_t instrument, bool mute ) = 0;
263
265
271 virtual bool get_instrument_mute_status( std::int32_t instrument ) const = 0;
272
274
283 virtual std::int32_t play_note( std::int32_t instrument, std::int32_t note, double volume, double panning ) = 0;
284
286
291 virtual void stop_note( std::int32_t channel ) = 0;
292
293}; // class interactive
294
295
296/* add stuff here */
297
298
299
300#undef LIBOPENMPT_DECLARE_EXT_CXX_INTERFACE
301#undef LIBOPENMPT_EXT_CXX_INTERFACE
302
303} // namespace ext
304
305} // namespace openmpt
306
311#endif // LIBOPENMPT_EXT_HPP
Definition libopenmpt_ext.hpp:146
Definition libopenmpt_ext.hpp:101
virtual effect_type get_pattern_row_channel_effect_type(std::int32_t pattern, std::int32_t row, std::int32_t channel) const =0
Get pattern command type for pattern highlighting.
effect_type
Pattern command type.
Definition libopenmpt_ext.hpp:106
virtual effect_type get_pattern_row_channel_volume_effect_type(std::int32_t pattern, std::int32_t row, std::int32_t channel) const =0
Get pattern command type for pattern highlighting.
Definition libopenmpt_ext.hpp:37
module_ext(const std::vector< char > &data, std::ostream &log=std::clog, const std::map< std::string, std::string > &ctls=detail::initial_ctls_map())
module_ext(std::istream &stream, std::ostream &log=std::clog, const std::map< std::string, std::string > &ctls=detail::initial_ctls_map())
module_ext(const std::vector< std::byte > &data, std::ostream &log=std::clog, const std::map< std::string, std::string > &ctls=detail::initial_ctls_map())
module_ext(const char *data, std::size_t size, std::ostream &log=std::clog, const std::map< std::string, std::string > &ctls=detail::initial_ctls_map())
module_ext(const std::vector< std::uint8_t > &data, std::ostream &log=std::clog, const std::map< std::string, std::string > &ctls=detail::initial_ctls_map())
void * get_interface(const std::string &interface_id)
Retrieve a libopenmpt extension.
module_ext(const void *data, std::size_t size, std::ostream &log=std::clog, const std::map< std::string, std::string > &ctls=detail::initial_ctls_map())
module_ext(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())
module_ext(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())
Definition libopenmpt.hpp:385
#define LIBOPENMPT_DECLARE_EXT_CXX_INTERFACE(name)
Definition libopenmpt_ext.hpp:82
#define LIBOPENMPT_EXT_CXX_INTERFACE(name)
Definition libopenmpt_ext.hpp:87
Definition libopenmpt.hpp:134