NAME

MIDI::RtController::Filter::Tonal - Tonal RtController filters

VERSION

version 0.0401

SYNOPSIS

use curry;
use MIDI::RtController ();
use MIDI::RtController::Filter::Tonal ();

my $rtc = MIDI::RtController->new(
  input  => 'keyboard',
  output => 'usb',
);

my $filter = MIDI::RtController::Filter::Tonal->new(rtc => $rtc);

$rtc->add_filter('pedal', note_on => $filter->curry::pedal_tone);

$rtc->run;

DESCRIPTION

MIDI::RtController::Filter::Tonal is the collection of tonal MIDI::RtController filters.

ATTRIBUTES

pedal

$pedal = $filter->pedal;
$filter->pedal($note);

The note used by the pedal-tone filter.

Default: 55

Which is the MIDI-number for G below middle-C.

delay

$delay = $filter->delay;
$filter->delay($number);

The current delay time.

Default: 0.1 seconds

factor

$factor = $filter->factor;
$filter->factor($number);

This is a generic number that can be used in a calculation, like the "delay_tone" filter.

Default: undef

velocity

$velocity = $filter->velocity;
$filter->velocity($number);

The velocity (or volume) change increment (0-127).

Default: 10

feedback

$feedback = $filter->feedback;
$filter->feedback($number);

The feedback.

Default: 1

offset

$offset = $filter->offset;
$filter->offset($number);

The note offset number.

Default: -12

key

$key = $filter->key;
$filter->key($number);

The musical key (C-B).

scale

$scale = $filter->scale;
$filter->scale($name);

The name of the musical scale.

intervals

$intervals = $filter->intervals;
$filter->intervals(\@intervals);

The voice intervals used by the walk_tone filter.

arp

$arp = $filter->arp;
$filter->arp(\@notes);

A list of MIDI numbered pitches used by the arp_tone and walk_tone filters.

arp_types

$arp_types = $filter->arp_types;
$filter->arp_types(\@strings);

A list of known arpeggiation types. This is an Array::Circular instance.

Default: [up, down, random]

arp_type

$arp_type = $filter->arp_type;
$filter->arp_type($string);

The current arpeggiation type.

Default: up

METHODS

new

$filter = MIDI::RtController::Filter::CC->new(%arguments);

Return a new MIDI::RtController::Filter::CC object.

UTILITIES

add_filters

MIDI::RtController::Filter::Tonal::add_filters(\@filters, $controllers);

Add an array reference of filters to controller instances. For example:

[
  {   port => 'keyboard',
      event => [qw(note_on note_off)],
      type => 'delay_tone',
      delay => 0.15,
  },
  ...
]

In this list, port is required, and event is optional. These keys are metadata, and all others are assumed to be object attributes to set.

FILTERS

All filter methods must accept the object, a MIDI device name, a delta-time, and a MIDI event ARRAY reference, like:

sub pedal_tone ($self, $name, $delta, $event) {
  my ($event_type, $chan, $note, $value) = $event->@*;
  ...
  return $boolean;
}

A filter also must return a boolean value. This tells MIDI::RtController to continue processing other known filters or not.