# harmony.py

"""
This module is an integeral part of the program
MMA - Musical Midi Accompaniment.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

Bob van der Poel <bob@mellowood.ca>

"""

from MMA.common import *
import MMA.debug
import random

def setHarmony(self, ln):
    """ Set the harmony. """

    ln = lnExpand(ln, '%s Harmony' % self.name)
    tmp = []

    for n in ln:
        n = n.upper()
        if n in ('-', '0', 'NONE'):
            n = None

        tmp.append(n)

    self.harmony = seqBump(tmp)

    if self.vtype in ('CHORD', 'DRUM'):
        warning("Harmony setting for %s track ignored" % self.vtype)

    if MMA.debug.debug:
        MMA.debug.trackSet(self.name, "Harmony")

        
def setHarmonyOnly(self, ln):
    """ Set the harmony only. """

    ln = lnExpand(ln, '%s HarmonyOnly' % self.name)
    tmp = []

    for n in ln:
        n = n.upper()
        if n in ('-', '0', 'NONE'):
            n = None

        tmp.append(n)

    self.harmony = seqBump(tmp)
    self.harmonyOnly = seqBump(tmp)

    if self.vtype in ('CHORD', 'DRUM'):
        warning("HarmonyOnly setting for %s track ignored" % self.vtype)

    if MMA.debug.debug:
        MMA.debug.trackSet(self.name, 'HarmonyOnly')


def setHarmonyVolume(self, ln):
    """ Set harmony volume adjustment. """

    ln = lnExpand(ln, '%s HarmonyOnly' % self.name)
    tmp = []

    for n in ln:
        v = stoi(n)

        if v < 0:
            error("HarmonyVolume adjustment must be positive integer")
        tmp.append(v/100.)

    self.harmonyVolume = seqBump(tmp)

    if self.vtype in ('PLECTRUM', 'DRUM'):
        warning("HarmonyVolume adjustment for %s track ignored" % self.vtype)

    if MMA.debug.debug:
        MMA.debug.trackSet(self.name, "HarmonyVolume")


##########################################################

def harmonize(hmode, note, chord):
    """ Get harmony note(s) for given chord. """

    if not chord:
        return
    
    hnotes = []
    chord = sorted(list(chord))

    for tp in hmode.split('+'):

        # if harmonies are concated with commas we need to
        # randomly select one of them
        if ',' in tp:
            tp = random.choice(tp.split(','))
        
        if tp in ('2', '2BELOW'):
            hnotes.append(gethnote(note, chord))

        elif tp == '28Below':
            hnotes.append(gethnote(note, chord)-12)

        elif tp == '2ABOVE':
            hnotes.append(gethnote(note, chord)+12)

        elif tp == '28ABOVE':
            hnotes.append(gethnote(note, chord)+24)

        elif tp in ('3', '3BELOW', '38BELOW'):
            a = gethnote(note, chord)
            b = gethnote(a, chord)
            if tp == '38BELOW':
                a -= 12
                b -= 12
            hnotes.extend([a, b])
            
        elif tp in ('3ABOVE', '38ABOVE'):
            a = gethnote(note, chord)
            b = gethnote(a, chord)
            if tp == '38ABOVE':
                a += 24
                b += 24
            hnotes.extend([a+12, b+12])
            
        elif tp in ('OPEN', "OPENBELOW", 'OPEN8BELOW'):
            a = gethnote(note, chord)
            if tp == 'OPEN8ABOVE':
                a -= 12
            hnotes.append(gethnote(a, chord))

        elif tp == 'OPENABOVE':
            a = gethnote(note, chord)
            hnotes.append(gethnote(a, chord) + 12)
 
        elif tp == 'OPEN8ABOVE':
            a = gethnote(note, chord)
            hnotes.append(gethnote(a, chord) + 24)

        elif tp in ('8', '8BELOW'):
            hnotes.append(note - 12)

        elif tp == '8ABOVE':
            hnotes.append(note + 12)

        elif tp in ('16', '16BELOW'):
            hnotes.append(note - (2 * 12))

        elif tp == '16ABOVE':
            hnotes.append(note + (2 * 12))

        elif tp in ('24', '24BELOW'):
            hnotes.append(note - (3 * 12))

        elif tp == '24ABOVE':
            hnotes.append(note + (3 * 12))

        elif tp == 'TOP':
            hnotes.append( chord[-1])
            
        elif tp in('TOPABOVE', 'TOP8ABOVE', 'TOP16ABOVE'):
            h = chord[-1]
            while h <= note:
                h += 12
            if tp == 'TOP8ABOVE':
                h += 12
            elif tp == 'TOP16ABOVE':
                h += 24
            hnotes.append(h)
        
        elif tp in('TOPBELOW', 'TOP8BELOW', 'TOP16BELOW'):
            h = chord[-1]
            while h >= note:
                h -= 12
            if tp == 'TOP8BELOW':
                h -= 12
            elif tp == 'TOP16BELOW':
                h -= 24
            hnotes.append(h)

        elif tp == 'ROOT':
            hnotes.append(note + chord[0])

        elif tp in ('ROOTABOVE', 'ROOT8ABOVE', 'ROOT16ABOVE'):
            h = chord[0]
            while h <= note:
                h += 12
            if tp == 'ROOT8ABOVE':
                h += 12
            elif tp == 'ROOT16ABOVE':
                h += 24
            hnotes.append(h)

        elif tp in('ROOTBELOW', 'ROOT8BELOW', 'ROOT16BELOW'):
            h = chord[0]
            while h >= note:
                h -= 12
            if tp == 'ROOT8BELOW':
                h -= 12
            elif tp == 'ROOT16BELOW':
                h -= 24
            hnotes.append(h)
            
        elif ":" in tp:
            hnotes.append(note + intervalHarmony(tp))

        elif tp == 'NONE':
            continue
        
        else:
            error("Unknown harmony type '%s'" % tp)

    # Strip out duplicate notes from harmony list.
    #  Cute trick here ... just use set().
    return list(set(hnotes))

# The following are used for the interval harmonies (2:Per4, etc)
# Whole tone to half step conversion table

halfSteps = { 'UNI':  0,
              'MIN2': 1,
              'MAJ2': 2,  'DIM3': 2,
              'MIN3': 3,  'AUG2': 3,
              'MAJ3': 4,  'DIM4': 4,
              'PER4': 5,  'AUG3': 5,
              'AUG4': 6,  'DIM5': 6,
              'PER5': 7,  'DIM6': 7,
              'MIN6': 8,  'AUG5': 8,
              'MAJ6': 9,  'DIM7': 9,
              'MIN7': 10, 'AUG6': 10, 
              'MAJ7': 11, 'DIM8': 11,
              'OCT':  12, 'AUG7': 12  }

sNames = ("MINOR", "MAJOR", "DIMINISHED", "PERFECT", "AUGMENTED", "OCTAVE", "UNISON")
dNames = (("SECOND", "2"), ("THIRD", "3"), ("FOURTH", "4"),
           ("FIFTH", "5"), ("SIXTH", "6"), ("SEVENTH", "7") )

def intervalHarmony(harmName):
    """ Return number of 1/2 steps for harmony. Syntax is:
            [octave]:interval
              octave - integer -5 to +5 (optional)
              interval - symbolic name or value
    """

    # since the caller got here due to a ':' in the string, we're
    # safe in doing the split.
    octave, name = harmName.split(':', 1)

    # set the octave
    if octave:
        octave = stoi(octave, "Harmony: octave expecting integer")
        if octave <-4 or octave>4:
            error("Harmony: Octave %s is too large. Use -4 to 4" % octave)
    else:
        octave = 0

    if name.isdigit():
        halfs = stoi(name, "Harmony: Unexpected error in number of half steps.")

    else:
        # Convert full names to our abreviations. This permits a
        # wide range of input names and fairly short lookup table.
        for a in sNames:
            name = name.replace(a, a[:3])
        for a in dNames:
            name = name.replace(a[0], a[1])

        if name not in halfSteps:
            error("Interval harmony %s is unknown." % harmName)

        halfs = halfSteps[name]
        
    return (octave * 12) + halfs


def gethnote(note, chord):
    """ Determine harmony notes for a note based on the chord.

        note - midi value of the note

        chord - list of midi values for the chord


        This routine works by creating a chord list with all
        its notes having a value less than the note (remember, this
        is all in MIDI values). We then grab notes from the end of
        the chord until one is found which is less than the original
        note.
    """

    ch = chord[:] # we're buggering the chord octave, so copy the list

   
    # Note: did a test and none of my files seem to be triggering both of the
    # the following conditions.
    # If 1st note in chord is > basenote then we know all notes in chord are
    # above the basenote. Lower the chord
    while ch[-1] > note:
        ch = [x-12 for x in ch]
    # Ensure the highest note in the chord is in octave range
    while ch[-1]+12 < note:
        ch = [x+12 for x in ch]

    # get a note from the chord which is
    # less than the current note. Just step
    # until the chord note is >= 'note' and
    # use the previous If the note is the chord's
    # root we actually return the root note. We
    # do have to return something.

    h = ch[0]
    for i in ch:
        if i >= note:
            break
        else:
            h = i

    return h