mutwo.parameters.playing_indicators¶

Define playing indicators for simple events.

This submodules provides several classes to add specific musical playing techniques to mutwo.events.basic.SimpleEvent objects. They mostly derive from traditional Western playing techniques and their notation. Unlike indicators of the mutwo.parameters.notation_indicators module, playing indicators have an effect on the played music and aren’t merely specifications of representation. The proper way to handle playing indicators should be via a PlayingIndicatorCollection object that should be attached to the respective SimpleEvent. The collection contains all possible playing indicators which are defined in this module. mutwo.events.music.NoteLike contain by default a playing indicator collection.

There are basically two different types of playing indicators:

1, Playing indicators which can only be on or off (for instance bartok_pizzicato, prall or laissez_vibrer). They have a is_active attribute which can either be True or False.

2. Playing indicators with one or more arguments (for instance Tremolo with n_flags or Arpeggio with direction). Their is_active attribute can’t be set by the user and get automatically initialised depending on if all necessary attributes are defined (then active) or if any of the necessary attributes is set to None (then not active).

Example:

Set playing indicators of NoteLike:

>>> from mutwo.events import music
>>> my_note = music.NoteLike('c', 1 / 4, 'mf')
>>> my_note.playing_indicators.articulation.name = "."  # add staccato
>>> my_chord = music.NoteLike('c e g', 1 / 2, 'f')
>>> my_chord.playing_indicators.arpeggio.direction= "up"  # add arpeggio
>>> my_chord.playing_indicators.laissez_vibrer.is_active = True  # and laissez_vibrer

Attach PlayingIndicatorCollection to SimpleEvent:

>>> from mutwo.events import basic
>>> from mutwo.parameters import playing_indicators
>>> my_simple_event = basic.SimpleEvent()
>>> my_simple_event.playing_indicators = playing_indicators.PlayingIndicatorCollection()

Classes:

`Arpeggio`([direction])
`Articulation`([name])
`ArtificalHarmonic`([n_semitones])
`Fermata`([fermata_type])
`Hairpin`([symbol])
`Ornamentation`([direction, n_times])
`Pedal`([pedal_type, pedal_activity])
`PlayingIndicatorCollection`(args, *kwds)
`StringContactPoint`([contact_point])
`Tremolo`([n_flags])

class Arpeggio(direction: Union[str, NoneType] = None)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`direction`
`is_active`

Parameters: direction (Optional[str]) –
Return type: None

get_arguments_dict()¶

Return type: Dict[str, Any]

direction: Optional[str] = None¶

property is_active: bool¶

class Articulation(name: Union[str, NoneType] = None)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`is_active`
`name`

Parameters: name (Optional[str]) –
Return type: None

get_arguments_dict()¶

Return type: Dict[str, Any]

property is_active: bool¶

name: Optional[str] = None¶

class ArtificalHarmonic(n_semitones: Union[int, NoneType] = None)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`is_active`
`n_semitones`

Parameters: n_semitones (Optional[int]) –
Return type: None

get_arguments_dict()¶

Return type: Dict[str, Any]

property is_active: bool¶

n_semitones: Optional[int] = None¶

class Fermata(fermata_type: Union[str, NoneType] = None)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`fermata_type`
`is_active`

Parameters: fermata_type (Optional[str]) –
Return type: None

get_arguments_dict()¶

Return type: Dict[str, Any]

fermata_type: Optional[str] = None¶

property is_active: bool¶

class Hairpin(symbol: Union[str, NoneType] = None)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`is_active`
`symbol`

Parameters: symbol (Optional[str]) –
Return type: None

get_arguments_dict()¶

Return type: Dict[str, Any]

property is_active: bool¶

symbol: Optional[str] = None¶

class Ornamentation(direction: Union[str, NoneType] = None, n_times: int = 1)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`direction`
`is_active`
`n_times`

Parameters

direction (Optional[str]) –
n_times (int) –

Return type

None

get_arguments_dict()¶

Return type: Dict[str, Any]

direction: Optional[str] = None¶

property is_active: bool¶

n_times: int = 1¶

class Pedal(pedal_type: Union[str, NoneType] = None, pedal_activity: Union[bool, NoneType] = True)[source]¶

Bases: mutwo.parameters.abc.ImplicitPlayingIndicator

Methods:

get_arguments_dict()

Attributes:

`is_active`
`pedal_activity`
`pedal_type`

Parameters

pedal_type (Optional[str]) –
pedal_activity (Optional[bool]) –

Return type

None

get_arguments_dict()¶

Return type: Dict[str, Any]

property is_active: bool¶

pedal_activity: Optional[bool] = True¶

pedal_type: Optional[str] = None¶

class PlayingIndicatorCollection(*args, **kwds)[source]¶

Bases: mutwo.parameters.abc.IndicatorCollection[mutwo.parameters.abc.PlayingIndicator]

Methods:

`get_all_indicator`()
`get_indicator_dict`()

Attributes:

`arpeggio`
`articulation`
`artifical_harmonic`
`bartok_pizzicato`
`fermata`
`hairpin`
`laissez_vibrer`
`natural_harmonic`
`ornamentation`
`pedal`
`prall`
`string_contact_point`
`tie`
`tremolo`