Class Note

mingus/containers/note.py:32–352

A note object. In the mingus.core module, notes are generally represented by strings. Most of the times, this is not enough. We want to set the octave and maybe the amplitude, vibrato or other dynamics. Then we want to store the notes in bars, the bars in tracks, the tracks in compo

class Note(object):

    """A note object.

    In the mingus.core module, notes are generally represented by strings.
    Most of the times, this is not enough. We want to set the octave and
    maybe the amplitude, vibrato or other dynamics. Then we want to store
    the notes in bars, the bars in tracks, the tracks in compositions, etc.

    We could do this with a number of lists, but ultimately it is a lot
    easier to use objects. The Note class provides an easy way to deal with
    notes in an object oriented matter.

    You can use the class NoteContainer to group Notes together in intervals
    and chords.
    """

    name = _DEFAULT_NAME
    octave = _DEFAULT_OCTAVE
    channel = _DEFAULT_CHANNEL
    velocity = _DEFAULT_VELOCITY

    def __init__(self, name="C", octave=4, dynamics=None, velocity=None, channel=None):
        """
        :param name:
        :param octave:
        :param dynamics: Deprecated. Use `velocity` and `channel` directly.
        :param int velocity: Integer (0-127)
        :param int channel: Integer (0-15)
        """
        if dynamics is None:
            dynamics = {}

        if velocity is not None:
            dynamics["velocity"] = velocity
        if channel is not None:
            dynamics["channel"] = channel

        if isinstance(name, six.string_types):
            self.set_note(name, octave, dynamics)
        elif hasattr(name, "name"):
            # Hardcopy Note object
            self.set_note(name.name, name.octave, name.dynamics)
        elif isinstance(name, int):
            self.from_int(name)
        else:
            raise NoteFormatError("Don't know what to do with name object: %r" % name)

    @property
    def dynamics(self):
        """
        .. deprecated:: Provided only for compatibility with existing code.
        """
        return {
            "channel": self.channel,
            "velocity": self.velocity,
        }