"""
EffectParameter Module
=======================
This module defines the `EffectParameter` class, which manages effect-related parameters
for JD-Xi patch data. It provides functionality to retrieve parameter addresses, convert
values between display and MIDI formats, and categorize parameters based on effect types.
Classes
--------
.. class:: EffectParameter(address: int, min_val: int, max_val: int, display_min: Optional[int] = None, display_max: Optional[int] = None)
Represents an effect parameter with an address, value range, and optional display range.
**Methods:**
.. method:: get_display_value() -> Tuple[int, int]
Returns the display range for the parameter.
.. method:: get_address_by_name(name: str) -> Optional[int]
Looks up an effect parameter address by its name.
.. method:: get_by_address(address: int) -> Optional[EffectParameter]
Retrieves an effect parameter by its address.
.. method:: get_by_name(name: str) -> Optional[EffectParameter]
Retrieves an effect parameter by its name.
.. method:: convert_to_midi(display_value: int) -> int
Converts a display value to a corresponding MIDI value.
.. method:: get_midi_value(param_name: str, value: int) -> Optional[int]
Returns the MIDI value for an effect parameter given its name and display value.
.. method:: get_common_param_by_name(name: str) -> Optional[EffectCommonParameter]
Categorizes an effect parameter into a common effect type.
Constants
---------
This class defines various constants representing effect parameters, such as:
- **EFX1_TYPE**
- **EFX1_LEVEL**
- **DELAY_LEVEL**
- **REVERB_LEVEL**
Each parameter is defined as a tuple containing:
- Address (int)
- Minimum value (int)
- Maximum value (int)
- Display minimum value (Optional[int])
- Display maximum value (Optional[int])
Usage Example
-------------
.. code-block:: python
param = EffectParameter.get_by_name("EFX1_LEVEL")
if param:
midi_value = param.convert_to_midi(64)
print(f"MIDI Value: {midi_value}")
Function Address Value Type Description
EFX2 Type 00 00 0–5 or 0–8 Sets effect type (e.g., Thru, Distortion, Fuzz)
EFX2 Level 00 01 0–127 Overall effect output
EFX2 Delay Send Level 00 02 0–127 Send to Delay effect
EFX2 Reverb Send Level 00 03 0–127 Send to Reverb effect
EFX2 Parameter 1 00 11 Signed 4-byte int Meaning depends on EFX2 Type
EFX2 Parameter 2 00 15 Signed 4-byte int As above
... ... ... Up to Param 32 at 01 0D
Example for Distortion (EFX2_TYPE = 01)
Param # Address Meaning
Param 1 00 11 Drive
Param 2 00 15 Presence
Param 3 00 19 (possibly unused or Level)
"""
from typing import Optional, Tuple
from picomidi.constant import Midi
from picomidi.sysex.parameter.address import AddressParameter
from jdxi_editor.midi.data.parameter.effects.common import AddressParameterEffectCommon
[docs]
class Effect1Param(AddressParameter):
"""Effect parameters with address and value range"""
def __init__(
self,
address: int,
min_val: int,
max_val: int,
display_min: Optional[int] = None,
display_max: Optional[int] = None,
tooltip: Optional[str] = None,
):
super().__init__(address, min_val, max_val)
[docs]
self.display_min = display_min if display_min is not None else min_val
[docs]
self.display_max = display_max if display_max is not None else max_val
[docs]
def get_display_value(self) -> Tuple[int, int]:
"""
Get the display range for the parameter
:return: Tuple[int, int] The display range
"""
return self.display_min, self.display_max
# EFX1 Parameters
[docs]
EFX1_TYPE = (
0x00,
0,
4,
0,
4,
"Selects the type of effect to be applied:\n00: Thru\n01: Distortion\n02: Fuzz\n03: Compressor\n04: Bit Crusher ",
)
[docs]
EFX1_LEVEL = (0x01, 0, 127, 0, 127, "Sets the level of the effect.")
[docs]
EFX1_DELAY_SEND_LEVEL = (
0x02,
0,
127,
0,
127,
"Depth of delay applied to the sound from effect 1.",
)
[docs]
EFX1_REVERB_SEND_LEVEL = (
0x03,
0,
127,
0,
127,
"Depth of reverb applied to the sound from effect 1.",
)
[docs]
EFX1_OUTPUT_ASSIGN = (
0x04,
0,
1,
0,
1,
"Selects the output destination for the sound from effect 1.\nDIR: Output to the Output jacks.\nEFX2: Output to Effect 2.\nIf you want to use EFX1 and EFX2 separately for each part, set this parameter to DIR. For details, refer to the effect block diagram.",
)
[docs]
EFX1_PARAM_1 = (
0x11,
32768,
32895,
0,
127,
"Sets the first parameter of the effect.",
)
[docs]
EFX1_PARAM_1_BITCRUSHER_LEVEL = (
0x11,
32768,
32895,
0,
127,
"Sets the output volume.",
)
[docs]
EFX1_PARAM_1_FUZZ_LEVEL = (0x11, 32767, 32894, 0, 127, "Adjusts the volume.")
[docs]
EFX1_PARAM_1_DISTORTION_LEVEL = (0x11, 32768, 32895, 0, 127, "Adjusts the volume.")
[docs]
EFX1_PARAM_1_COMPRESSOR_THRESHOLD = (
0x11,
32768,
32895,
0,
127,
"Level at which compression is applied",
)
[docs]
EFX1_PARAM_2 = (
0x15,
32767,
32894,
0,
127,
"Sets the second parameter of the effect.",
)
[docs]
EFX1_PARAM_2_BITCRUSHER_RATE = (
0x15,
32767,
32894,
0,
127,
"Adjusts the sampling frequency.",
)
[docs]
EFX1_PARAM_2_FUZZ_DRIVE = (
0x15,
32767,
32894,
0,
127,
"Sets the second parameter of the effect.",
)
[docs]
EFX1_PARAM_2_DISTORTION_DRIVE = (
0x15,
32768,
32895,
0,
127,
"Adjusts the depth of distortion",
)
[docs]
EFX1_PARAM_2_COMPRESSOR_RATIO = (0x15, 32768, 32887, 0, 19, "Compression ratio")
[docs]
EFX1_PARAM_3 = (0x19, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_3_BITCRUSHER_DEPTH = (0x19, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_3_DISTORTION_TYPE = (0x19, 32822, 32827, 0, 5) # 32822 = 08 00 03 06
[docs]
EFX1_PARAM_3_FUZZ_TYPE = (0x19, 32822, 32827, 0, 5) # 32822 = 08 00 03 06
[docs]
EFX1_PARAM_3_COMPRESSOR_ATTACK = (
0x19,
32822,
32854,
0,
32,
"Attack time (ms)",
) # 32822 = 08 00 03 06
[docs]
EFX1_PARAM_4 = (0x1D, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_4_BITCRUSHER_FILTER = (
0x1D,
32768,
32895,
0,
127,
"Adjusts the filter depth",
)
[docs]
EFX1_PARAM_4_COMPRESSOR_RELEASE = (0x1D, 32822, 32854, 0, 32, "Release time (ms)")
[docs]
EFX1_PARAM_5 = (0x21, 32768, 32895, 0, 127, "")
[docs]
EFX1_PARAM_5_COMPRESSOR_LEVEL = (0x21, 32768, 32895, 0, 127, "Adjusts the volume.")
[docs]
EFX1_PARAM_6 = (0x25, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_7 = (0x29, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_7_COMPRESSOR_SIDE_LEVEL = (
0x29,
32768,
32895,
0,
127,
"Side level which to be applied",
)
[docs]
EFX1_PARAM_8 = (0x2D, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_8_COMPRESSOR_SIDE_NOTE = (
0x2D,
32768,
32895,
0,
127,
"Side note to be applied",
)
[docs]
EFX1_PARAM_9 = (0x31, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_9_COMPRESSOR_SIDE_TIME = (
0x31,
32768,
32895,
0,
127,
"Side time to be applied",
)
[docs]
EFX1_PARAM_10 = (0x35, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_10_COMPRESSOR_SIDE_RELEASE = (
0x35,
32768,
32895,
0,
127,
"Side release to be applied",
)
[docs]
EFX1_PARAM_11 = (
0x39,
32768,
32895,
0,
127,
) # for posterity 12768, 52768, @@ -20000, 20000
[docs]
EFX1_PARAM_12 = (0x3D, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_13 = (0x41, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_14 = (0x45, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_15 = (0x49, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_16 = (0x4D, 32768, 32895, 0, 127)
[docs]
EFX1_PARAM_32 = (
0x1D,
32768,
32895,
0,
127,
"Sets the third parameter of the effect.",
)
[docs]
EFX1_PARAM_32_DISTORTION_PRESENCE = (
0x1D,
32768,
32895,
0,
127,
"Adjusts the character of the ultra-high-frequency region",
)
[docs]
EFX1_PARAM_32_FUZZ_PRESENCE = (
0x1D,
32768,
32895,
0,
127,
"Adjusts the character of the ultra-high-frequency region",
)
@classmethod
[docs]
def get_address_by_name(cls, name: str) -> Optional[int]:
"""Look up an effect parameter address by its name
:param name: str The parameter name
:return: Optional[int] The address
"""
member = cls.__members__.get(name, None)
return member.value[0] if member else None
@classmethod
[docs]
def get_by_address(cls, address: int) -> Optional[object]:
"""Look up an effect parameter by its address
:param address: int The address
:return: Optional[object] The parameter
"""
for param in cls:
if isinstance(param.value, tuple) and param.value[0] == address:
return param
return None # Return None if no match is found
@classmethod
[docs]
def get_by_name(cls, name: str) -> Optional[object]:
"""Look up an effect parameter by its name
:param name: str The parameter name
:return: Optional[object] The parameter
"""
return cls.__members__.get(name, None)
[docs]
def convert_to_midi(self, display_value: int) -> int:
"""Convert from display value to MIDI value
:param display_value: int The display value
:return: int The MIDI value
"""
# Handle special cases first
if self in [
Effect1Param.EFX1_TYPE,
Effect1Param.EFX1_LEVEL,
Effect1Param.EFX1_REVERB_SEND_LEVEL,
Effect1Param.EFX1_DELAY_SEND_LEVEL,
Effect1Param.EFX1_OUTPUT_ASSIGN,
]:
return display_value # Already 0–127 or boolean-style
else:
return (
display_value + Midi.VALUE.MIN.SIGNED_SIXTEEN_BIT
) # Convert to unsigned 16 bit
[docs]
convert_from_display = convert_to_midi
@staticmethod
[docs]
def get_midi_value(param_name: str, value: int) -> Optional[int]:
"""
Get the MIDI value for address parameter by name and value.
:param param_name: str The parameter name
:param value: int The value
:return: Optional[int] The MIDI value
"""
param = Effect1Param.get_by_name(param_name)
if param:
return param.convert_to_midi(value)
return None
@classmethod
[docs]
def get_common_param_by_name(
cls, name: str
) -> Optional[AddressParameterEffectCommon]:
"""
Look up an effect parameter's category using address dictionary mapping
:param name: str The parameter name
:return: Optional[AddressParameterEffectCommon] The category
"""
param_mapping = {
AddressParameterEffectCommon.PROGRAM_EFFECT_1: {
"EFX1_TYPE",
"EFX1_LEVEL",
"EFX1_DELAY_SEND_LEVEL",
"EFX1_REVERB_SEND_LEVEL",
"EFX1_OUTPUT_ASSIGN",
"EFX1_PARAM_1",
"EFX1_PARAM_2",
"EFX1_PARAM_32",
},
}
for category, parameters in param_mapping.items():
if name in parameters:
return category
return None # Return None if no match is found
[docs]
class Effect2Param(AddressParameter):
"""Effect parameters with address and value range"""
def __init__(
self,
address: int,
min_val: int,
max_val: int,
display_min: Optional[int] = None,
display_max: Optional[int] = None,
tooltip: Optional[str] = None,
):
super().__init__(address, min_val, max_val)
[docs]
self.display_min = display_min if display_min is not None else min_val
[docs]
self.display_max = display_max if display_max is not None else max_val
[docs]
def get_display_value(self) -> Tuple[int, int]:
"""
Get the display range for the parameter
:return: Tuple[int, int] The display range
"""
return self.display_min, self.display_max
# EFX2 Parameters
[docs]
EFX2_TYPE = (0x00, 0, 8, 0, 8)
[docs]
EFX2_LEVEL = (0x01, 0, 127, 0, 127)
[docs]
EFX2_DELAY_SEND_LEVEL = (0x02, 0, 127, 0, 127)
[docs]
EFX2_REVERB_SEND_LEVEL = (0x03, 0, 127, 0, 127)
[docs]
EFX2_PARAM_1 = (0x11, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_1_FLANGER_RATE_NOTE_SWITCH = (
0x11,
32768,
32869,
0,
1,
"[Rate] / [Note] Switch",
)
[docs]
EFX2_PARAM_1_PHASER_RATE_NOTE_SWITCH = (
0x11,
32768,
32869,
0,
1,
"[Rate] / [Note] Switch",
)
[docs]
EFX2_PARAM_2 = (0x15, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_2_FLANGER_RATE = (0x15, 32768, 32895, 0, 127, "Frequency of modulation")
[docs]
EFX2_PARAM_2_PHASER_RATE = (0x15, 32768, 32895, 0, 127, "Frequency of modulation")
[docs]
EFX2_PARAM_3 = (0x19, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_3_FLANGER_NOTE = (0x19, 32768, 32895, 0, 127, "Note used for modulation")
[docs]
EFX2_PARAM_3_PHASER_NOTE = (0x19, 32768, 32895, 0, 127, "Note used for modulation")
[docs]
EFX2_PARAM_4 = (0x1D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_4_FLANGER_DEPTH = (0x1D, 32768, 32895, 0, 127, "Depth of modulation")
[docs]
EFX2_PARAM_4_PHASER_DEPTH = (0x1D, 32768, 32895, 0, 127, "Depth of modulation")
[docs]
EFX2_PARAM_5 = (0x21, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_5_FLANGER_FEEDBACK = (
0x21,
32768,
32895,
0,
127,
"Proportion of the flanger sound that is returned to the input",
)
[docs]
EFX2_PARAM_5_PHASER_CENTER_FREQ = (
0x21,
32768,
32895,
0,
127,
"Proportion of the flanger sound that is returned to the input",
)
[docs]
EFX2_PARAM_6 = (0x25, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_6_FLANGER_MANUAL = (
0x25,
32768,
32895,
0,
127,
"Adjusts the basic frequency from which the sound will be modulated.",
)
[docs]
EFX2_PARAM_7 = (0x29, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_7_FLANGER_DRY_WET = (
0x29,
32768,
32895,
0,
127,
"Volume balance between the direct sound (D) and the effect sound (W)",
)
[docs]
EFX2_PARAM_8 = (0x2D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_8_FLANGER_LEVEL = (0x2D, 32768, 32895, 0, 127, "Output volume")
[docs]
EFX2_PARAM_9 = (0x31, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_10 = (0x35, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_11 = (0x39, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_12 = (0x3D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_13 = (0x41, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_14 = (0x45, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_15 = (0x49, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_16 = (0x4D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_17 = (0x51, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_18 = (0x55, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_19 = (0x59, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_20 = (0x5D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_21 = (0x61, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_22 = (0x65, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_23 = (0x69, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_24 = (0x6D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_25 = (0x71, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_32 = (0x0D, 32768, 32895, 0, 127)
[docs]
EFX2_PARAM_32_PHASER_EFFECT_LEVEL = (0x0D, 32768, 32895, 0, 127)
@classmethod
[docs]
def get_address_by_name(cls, name: str) -> Optional[int]:
"""Look up an effect parameter address by its name
:param name: str The parameter name
:return: Optional[int] The address
"""
member = cls.__members__.get(name, None)
return member.value[0] if member else None
@classmethod
[docs]
def get_by_address(cls, address: int) -> Optional[object]:
"""Look up an effect parameter by its address
:param address: int The address
:return: Optional[object] The parameter
"""
for param in cls:
if isinstance(param.value, tuple) and param.value[0] == address:
return param
return None # Return None if no match is found
@classmethod
[docs]
def get_by_name(cls, name: str) -> Optional[object]:
"""Look up an effect parameter by its name
:param name: str The parameter name
:return: Optional[object] The parameter
"""
return cls.__members__.get(name, None)
[docs]
def convert_to_midi_old(self, display_value: int) -> int:
"""Convert from display value to MIDI value
:param display_value: int The display value
:return: int The MIDI value
"""
# Handle special bipolar cases first
if self == Effect2Param.EFX2_PARAM_1:
return display_value + 32768 #
elif self == Effect2Param.EFX2_PARAM_2:
return display_value + 32768 #
elif self == Effect2Param.EFX2_PARAM_32:
return display_value + 32768 #
else:
return display_value
[docs]
def convert_to_midi(self, display_value: int) -> int:
"""Convert from display value to MIDI value
:param display_value: int The display value
:return: int The MIDI value
"""
# Handle special bipolar cases first
if self in [
Effect2Param.EFX2_TYPE,
Effect2Param.EFX2_LEVEL,
Effect2Param.EFX2_REVERB_SEND_LEVEL,
Effect2Param.EFX2_DELAY_SEND_LEVEL,
]:
return display_value # Already 0–127 or boolean-style
else:
return (
display_value + Midi.VALUE.MIN.SIGNED_SIXTEEN_BIT
) # Convert to unsigned 16 bit
[docs]
convert_from_display = convert_to_midi
@staticmethod
[docs]
def get_midi_value(param_name: str, value: int) -> Optional[int]:
"""
Get the MIDI value for address parameter by name and value.
:param param_name: str The parameter name
:param value: int The value
:return: Optional[int] The MIDI value
"""
param = ReverbParam.get_by_name(param_name)
if param:
return param.convert_to_midi(value)
return None
@classmethod
[docs]
def get_common_param_by_name(
cls, name: str
) -> Optional[AddressParameterEffectCommon]:
"""
Look up an effect parameter's category using address dictionary mapping
:param name: str The parameter name
:return: Optional[AddressParameterEffectCommon] The category
"""
param_mapping = {
AddressParameterEffectCommon.PROGRAM_EFFECT_2: {
"EFX2_TYPE",
"EFX2_LEVEL",
"EFX2_DELAY_SEND_LEVEL",
"EFX2_REVERB_SEND_LEVEL",
"EFX2_PARAM_1",
"EFX2_PARAM_2",
},
}
for category, parameters in param_mapping.items():
if name in parameters:
return category
return None # Return None if no match is found
[docs]
class DelayParam(AddressParameter):
"""Effect parameters with address and value range"""
def __init__(
self,
address: int,
min_val: int,
max_val: int,
display_min: Optional[int] = None,
display_max: Optional[int] = None,
tooltip: Optional[str] = None,
):
super().__init__(address, min_val, max_val)
[docs]
self.display_min = display_min if display_min is not None else min_val
[docs]
self.display_max = display_max if display_max is not None else max_val
[docs]
def get_display_value(self) -> Tuple[int, int]:
"""
Get the display range for the parameter
:return: Tuple[int, int] The display range
"""
return self.display_min, self.display_max
# Delay Parameters
[docs]
DELAY_LEVEL = (0x01, 0, 127, 0, 127, "Sets the level of the delay effect.")
[docs]
DELAY_PARAM_1 = (
0x08,
32768,
32895,
0,
127,
"Sets the first parameter of the delay effect.",
)
[docs]
DELAY_PARAM_2 = (
0x0C,
32768,
32895,
0,
127,
"Sets the second parameter of the delay effect.",
)
[docs]
DELAY_PARAM_24 = (
0x60,
32768,
32895,
0,
127,
"Sets the third parameter of the delay effect.",
)
[docs]
DELAY_REVERB_SEND_LEVEL = (
0x06,
0,
127,
0,
127,
"Depth of reverb applied to the sound from delay.",
)
@classmethod
[docs]
def get_address_by_name(cls, name: str) -> Optional[int]:
"""Look up an effect parameter address by its name
:param name: str The parameter name
:return: Optional[int] The address
"""
member = cls.__members__.get(name, None)
return member.value[0] if member else None
@classmethod
[docs]
def get_by_address(cls, address: int) -> Optional[object]:
"""Look up an effect parameter by its address
:param address: int The address
:return: Optional[object] The parameter
"""
for param in cls:
if isinstance(param.value, tuple) and param.value[0] == address:
return param
return None # Return None if no match is found
@classmethod
[docs]
def get_by_name(cls, name: str) -> Optional[object]:
"""Look up an effect parameter by its name
:param name: str The parameter name
:return: Optional[object] The parameter
"""
return cls.__members__.get(name, None)
[docs]
def convert_to_midi(self, display_value: int) -> int:
"""Convert from display value to MIDI value
:param display_value: int The display value
:return: int The MIDI value
"""
# Handle special bipolar cases first
if self == DelayParam.DELAY_PARAM_1:
return display_value + 32768 #
elif self == DelayParam.DELAY_PARAM_2:
return display_value + 32768 #
elif self == DelayParam.DELAY_PARAM_24:
return display_value + 32768 #
else:
return display_value
[docs]
convert_from_display = convert_to_midi
@staticmethod
[docs]
def get_midi_value(param_name: str, value: int) -> Optional[int]:
"""
Get the MIDI value for address parameter by name and value.
:param param_name: str The parameter name
:param value: int The value
:return: Optional[int] The MIDI value
"""
param = ReverbParam.get_by_name(param_name)
if param:
return param.convert_to_midi(value)
return None
@classmethod
[docs]
def get_common_param_by_name(
cls, name: str
) -> Optional[AddressParameterEffectCommon]:
"""
Look up an effect parameter's category using address dictionary mapping
:param name: str The parameter name
:return: Optional[AddressParameterEffectCommon] The category
"""
param_mapping = {
AddressParameterEffectCommon.PROGRAM_DELAY: {
"DELAY_TYPE",
"DELAY_TIME",
"DELAY_TAP_TIME",
"DELAY_FEEDBACK",
"DELAY_HF_DAMP",
"DELAY_LEVEL",
"DELAY_REVERB_SEND_LEVEL",
"DELAY_PARAM_1",
"DELAY_PARAM_2",
"DELAY_PARAM_24",
},
}
for category, parameters in param_mapping.items():
if name in parameters:
return category
return None # Return None if no match is found
[docs]
class ReverbParam(AddressParameter):
"""Effect parameters with address and value range"""
def __init__(
self,
address: int,
min_val: int,
max_val: int,
display_min: Optional[int] = None,
display_max: Optional[int] = None,
tooltip: Optional[str] = None,
):
super().__init__(address, min_val, max_val)
[docs]
self.display_min = display_min if display_min is not None else min_val
[docs]
self.display_max = display_max if display_max is not None else max_val
[docs]
def get_display_value(self) -> Tuple[int, int]:
"""
Get the display range for the parameter
:return: Tuple[int, int] The display range
"""
return self.display_min, self.display_max
# Reverb Parameters
[docs]
REVERB_LEVEL = (0x03, 0, 127, 0, 127, "Sets the level of the reverb effect.")
[docs]
REVERB_PARAM_1 = (
0x07,
32768,
32895,
0,
127,
"Sets the first parameter of the reverb effect.",
)
[docs]
REVERB_PARAM_2 = (
0x0B,
32768,
32895,
0,
127,
"Sets the second parameter of the reverb effect.",
)
[docs]
REVERB_PARAM_24 = (
0x5F,
32768,
32895,
0,
127,
"Sets the third parameter of the reverb effect.",
)
@classmethod
[docs]
def get_address_by_name(cls, name: str) -> Optional[int]:
"""Look up an effect parameter address by its name
:param name: str The parameter name
:return: Optional[int] The address
"""
member = cls.__members__.get(name, None)
return member.value[0] if member else None
@classmethod
[docs]
def get_by_address(cls, address: int) -> Optional[object]:
"""Look up an effect parameter by its address
:param address: int The address
:return: Optional[object] The parameter
"""
for param in cls:
if isinstance(param.value, tuple) and param.value[0] == address:
return param
return None # Return None if no match is found
@classmethod
[docs]
def get_by_name(cls, name: str) -> Optional[object]:
"""Look up an effect parameter by its name
:param name: str The parameter name
:return: Optional[object] The parameter
"""
return cls.__members__.get(name, None)
[docs]
def convert_to_midi(self, display_value: int) -> int:
"""Convert from display value to MIDI value
:param display_value: int The display value
:return: int The MIDI value
"""
# Handle special bipolar cases first
if self == ReverbParam.REVERB_PARAM_1:
return display_value + 32768 #
elif self == ReverbParam.REVERB_PARAM_2:
return display_value + 32768 #
elif self == ReverbParam.REVERB_PARAM_24:
return display_value + 32768 #
else:
return display_value
[docs]
convert_from_display = convert_to_midi
@staticmethod
[docs]
def get_midi_value(param_name: str, value: int) -> Optional[int]:
"""
Get the MIDI value for address parameter by name and value.
:param param_name: str The parameter name
:param value: int The value
:return: Optional[int] The MIDI value
"""
param = ReverbParam.get_by_name(param_name)
if param:
return param.convert_to_midi(value)
return None
@classmethod
[docs]
def get_common_param_by_name(
cls, name: str
) -> Optional[AddressParameterEffectCommon]:
"""
Look up an effect parameter's category using address dictionary mapping
:param name: str The parameter name
:return: Optional[AddressParameterEffectCommon] The category
"""
param_mapping = {
AddressParameterEffectCommon.PROGRAM_REVERB: {
"REVERB_OFF_ON",
"REVERB_TYPE",
"REVERB_TIME",
"REVERB_HF_DAMP",
"REVERB_LEVEL",
"REVERB_PARAM_1",
"REVERB_PARAM_2",
"REVERB_PARAM_24",
},
}
for category, parameters in param_mapping.items():
if name in parameters:
return category
return None # Return None if no match is found