ZMidi.Score.Quantise

Summary: Functions for quantising a MidiScore

Quantisation specific datatypes

data QMidiScore

QMidiScore wraps around a MidiScore and stores some additional information about the quantisation process.

Constructors

QMidiScore

Fields

qMidiScore :: MidiScore

qShortestNote :: ShortestNote

qGridUnit :: GridUnit

totDeviation :: QDev

Instances

Eq QMidiScore

Show QMidiScore

Generic QMidiScore

Binary QMidiScore

type Rep QMidiScore

data ShortestNote

The ShortestNote determines the minimal grid length of a quantised QMidiScore, when quantised with quantise.

Constructors

Eighth

Sixteenth

ThirtySecond

FourtyEighth

SixtyFourth

Instances

Eq ShortestNote

Show ShortestNote

Generic ShortestNote

Binary ShortestNote

type Rep ShortestNote

newtype GridUnit

The GridUnit describes the minimal length of a quantised event and is controlled by the number of QBins

Constructors

GridUnit

Fields

gridUnit :: Int

Instances

Enum GridUnit

Eq GridUnit

Integral GridUnit

Num GridUnit

Ord GridUnit

Real GridUnit

Show GridUnit

Binary GridUnit

newtype QBins

The QBins describes the number of quantisation bins per (annotated) beat length and is generally controlled by the ShortestNote parameter. (see also: toQBins )

Constructors

QBins

Fields

qbins :: Int

Instances

Enum QBins

Eq QBins

Integral QBins

Num QBins

Ord QBins

Real QBins

Show QBins

Binary QBins

NFData QBins

newtype QDev

Represents a quantisation deviation, i.e. the number of ticks that an event was moved to match the time grid.

Constructors

QDev

Fields

qDev :: Int

Instances

Enum QDev

Eq QDev

Integral QDev

Num QDev

Ord QDev

Real QDev

Show QDev

Binary QDev

newtype QDevPerc

Represents the average quantisation deviation per onset

Constructors

QDevPerc

Fields

qDevPerc :: Double

Instances

Enum QDevPerc

Eq QDevPerc

Floating QDevPerc

Fractional QDevPerc

Num QDevPerc

Ord QDevPerc

Real QDevPerc

RealFloat QDevPerc

RealFrac QDevPerc

Show QDevPerc

PrintfArg QDevPerc

Binary QDevPerc

Quantisation functions

quantise :: MidiScore -> QMidiScore

Quantises a MidiScore snapping all events to a ShortestNote grid.

quantiseSafe :: ShortestNote -> MidiScore -> Either String QMidiScore

Quantises a MidiScore snapping all events to a ShortestNote grid. The absolute size of the grid is based on the GridUnit, which is the ticksPerBeat divided by the number of quantization bins per beat. Besides the quantised MidiScore and the GridUnit also the cumulative deviation from the grid is returned.

quantiseQDevSafe :: MidiScore -> Either String QMidiScore

Quantises a MidiScore or returns a warning if the quantisation deviation exceeds the acceptableQuantisationDeviation.

Utilities

avgQDev :: GridUnit -> QDev -> Int -> QDevPerc

avgQDevQMS :: QMidiScore -> QDevPerc

calculating the average quantisation deviation

canBeQuantisedAt :: ShortestNote -> MidiScore -> Bool

Returns true if the number of ticks per beat can be divided by the maximal number of quantisation bins.

removeOverlap :: Voice -> Voice

Although quantise also quantises the duration of NoteEvents, it can happen that melody notes do still overlap. This function removes the overlap N.B. This function is designed only for monophonic melodies, it does not work on a polyphonic score.

getMinGridSize :: ShortestNote -> MidiScore -> TPB

Returns the minimal grid size of a MidiScore if it has been quantised. This is the ticksPerBeat divided by the number of quantisation bins. N.B. this function does not check whether a file is quantised.

qToQBins :: QMidiScore -> QBins

Applies toQBins to the ShortestNote in a QMidiScore

toQBins :: ShortestNote -> QBins

takes the quantisation granularity parameter ShortestNote and returns a the GridUnit that the beat length should be divided by. The resulting value we name GridUnit; it describes the minimal length of an event.

getNumForQBins :: QBins -> Ratio Int -> Int

Returns the numerator of a Ratio given a certain QBins as denominator. The standard Ratio implementation simplifies the Ration, e.g. 3 % 12 is converted into 1 % 4. This function reverses that process:

>>> getNumForQBins 12 (1 % 4)
>>> 3

>>> getNumForQBins 12 (1 % 1)
>>> 12