libopenmpt  0.4.5+release.autotools
cross-platform C++ and C library to decode tracked music files
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
libopenmpt C++

Namespaces

 openmpt
 
 openmpt::string
 

Classes

class  openmpt::exception
 libopenmpt exception base class More...
 
class  openmpt::module
 

Enumerations

enum  openmpt::probe_file_header_result { openmpt::probe_file_header_result_success = 1, openmpt::probe_file_header_result_failure = 0, openmpt::probe_file_header_result_wantmoredata = -1 }
 Possible return values for openmpt::probe_file_header(). More...
 
enum  openmpt::module::render_param { openmpt::module::RENDER_MASTERGAIN_MILLIBEL = 1, openmpt::module::RENDER_STEREOSEPARATION_PERCENT = 2, openmpt::module::RENDER_INTERPOLATIONFILTER_LENGTH = 3, openmpt::module::RENDER_VOLUMERAMPING_STRENGTH = 4 }
 Parameter index to use with openmpt::module::get_render_param and openmpt::module::set_render_param. More...
 
enum  openmpt::module::command_index {
  openmpt::module::command_note = 0, openmpt::module::command_instrument = 1, openmpt::module::command_volumeffect = 2, openmpt::module::command_effect = 3,
  openmpt::module::command_volume = 4, openmpt::module::command_parameter = 5
}
 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. More...
 

Detailed Description

Enumeration Type Documentation

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.

Enumerator
command_note 
command_instrument 
command_volumeffect 
command_effect 
command_volume 
command_parameter 

Possible return values for openmpt::probe_file_header().

Since
0.3.0
Enumerator
probe_file_header_result_success 
probe_file_header_result_failure 
probe_file_header_result_wantmoredata 

Parameter index to use with openmpt::module::get_render_param and openmpt::module::set_render_param.

Enumerator
RENDER_MASTERGAIN_MILLIBEL 

Master Gain.

The related value represents a relative gain in milliBel.
The default value is 0.
The supported value range is unlimited.

RENDER_STEREOSEPARATION_PERCENT 

Stereo Separation.

The related value represents the stereo separation generated by the libopenmpt mixer in percent.
The default value is 100.
The supported value range is [0,200].

RENDER_INTERPOLATIONFILTER_LENGTH 

Interpolation Filter.

The related value represents the interpolation filter length used by the libopenmpt mixer.
The default value is 0, which indicates a recommended default value.
The supported value range is [0,inf). Values greater than the implementation limit are clamped to the maximum supported value.
Currently supported values:

  • 0: internal default
  • 1: no interpolation (zero order hold)
  • 2: linear interpolation
  • 4: cubic interpolation
  • 8: windowed sinc with 8 taps
RENDER_VOLUMERAMPING_STRENGTH 

Volume Ramping Strength.

The related value represents the amount of volume ramping done by the libopenmpt mixer.
The default value is -1, which indicates a recommended default value.
The meaningful value range is [-1..10].
A value of 0 completely disables volume ramping. This might cause clicks in sound output.
Higher values imply slower/softer volume ramps.