//
// Programmer:    Craig Stuart Sapp <craig@ccrma.stanford.edu>
// Creation Date: Mon Nov 20 17:32:36 PST 2000
// Last Modified: Mon Nov 20 17:32:39 PST 2000
// Filename:      ...sig/doc/examples/all/dissic/dissic.cpp
// Web Address:   http://sig/doc/examples/all/dissic/dissic.cpp
// Syntax:        C++ 
//
// Description:   determination of dissonance in context using rules given
//                by John Maxwell in:
//
//                "An Expert System for Harmonizing Analysis of Tonal
//                Music." pp 335-353 in: "Understanding Music with AI: 
//                Perspectives on Music Cognition." Ed. by Mira Balaban, 
//                Kemal Ebcioglu, and Otto Laske.  MIT Press; 1992.
//                [ISBN 0-262-52170-9]
//
// 

#include "humdrum.h"
#include <string.h>
#include <ctype.h>
#include <stdio.h>

// function declarations
void   checkOptions             (Options& opts, int argc, char* argv[]);
void   example                  (void);
void   generateAnalysis         (HumdrumFile& infile, 
                                      Array<int>& soncondis,
                                      Array<int>& tertian,
                                      Array<int>& terdis,
                                      Array<int>& accent,
                                      Array<int>& dissic);
int    measureAccentuation      (HumdrumFile& infile, int line);
int    measureTertian           (HumdrumFile& infile, int line);
int    measureTertianDissonance (HumdrumFile& infile, int line);
int    measureVerticalConsonance(HumdrumFile& infile, int line);
int    measureDissic            (int line, Array<int>& soncondis, 
                                      Array<int>& tertian, Array<int>& terdis, 
                                      Array<int>& accent);
void   printAnalysis            (HumdrumFile& infile, 
                                      Array<int>& soncondis,
                                      Array<int>& tertian,
                                      Array<int>& terdis,
                                      Array<int>& accent,
                                      Array<int>& dissic);
void   rotateNotes              (Array<int>& notes);
void   usage                    (const char* command);


// global variables
Options      options;            // database for command-line arguments
int          debugQ     = 0;     // used with the --debug option
int          appendQ    = 0;     // used with the -a option
int          compoundQ  = 1;     // used with the -c option


// variables for keeping track of the change in meter during the score:
int metercount = 4;
int meterbase = 4;

///////////////////////////////////////////////////////////////////////////

int main(int argc, char* argv[]) {
   HumdrumFile infile;
   Array<int>  soncondis;
   Array<int>  tertian;
   Array<int>  terdis;
   Array<int>  accent;
   Array<int>  dissic;

   // process the command-line options
   checkOptions(options, argc, argv);

   // figure out the number of input files to process
   int numinputs = options.getArgCount();

   for (int i=0; i<numinputs || i==0; i++) {
      infile.clear();

      // if no command-line arguments read data file from standard input
      if (numinputs < 1) {
         infile.read(cin);
      } else {
         infile.read(options.getArg(i+1));
      }

      generateAnalysis(infile, soncondis, tertian, terdis, accent, dissic);
      printAnalysis(infile, soncondis, tertian, terdis, accent, dissic);
   }

   return 0;
}


///////////////////////////////////////////////////////////////////////////


//////////////////////////////
//
// checkOptions -- validate and process command-line options.
//

void checkOptions(Options& opts, int argc, char* argv[]) {
   opts.define("a|append=b",    "append analysis to data in output");   
   opts.define("C|compound=b",  "don't try to use compound meters");   

   opts.define("debug=b",  "trace input parsing");   
   opts.define("author=b",  "author of the program");   
   opts.define("version=b", "compilation information"); 
   opts.define("example=b", "example usage"); 
   opts.define("h|help=b",  "short description"); 
   opts.process(argc, argv);
   
   // handle basic options:
   if (opts.getBoolean("author")) {
      cout << "Written by Craig Stuart Sapp, "
           << "craig@ccrma.stanford.edu, Nov 2000" << endl;
      exit(0);
   } else if (opts.getBoolean("version")) {
      cout << argv[0] << ", version: Nov 2000" << endl;
      cout << "compiled: " << __DATE__ << endl;
      cout << HUMDRUM_VERSION << endl;
      exit(0);
   } else if (opts.getBoolean("help")) {
      usage(opts.getCommand());
      exit(0);
   } else if (opts.getBoolean("example")) {
      example();
      exit(0);
   }

   debugQ = opts.getBoolean("debug");
   appendQ = opts.getBoolean("append");

   if (opts.getBoolean("compound")) {
      compoundQ = 0;
   } else {
      compoundQ = 0;
   }

}



//////////////////////////////
//
// example -- example usage of the maxent program
//

void example(void) {
   cout <<
   "                                                                        \n"
   << endl;
}



//////////////////////////////
//
// generateAnalysis -- 
//

void generateAnalysis(HumdrumFile& infile, Array<int>& soncondis,
      Array<int>& tertian, Array<int>& terdis, Array<int>& accent, 
      Array<int>& dissic) {
   soncondis.setSize(infile.getNumLines());
   tertian.setSize(infile.getNumLines());
   terdis.setSize(infile.getNumLines());
   accent.setSize(infile.getNumLines());
   dissic.setSize(infile.getNumLines());

   infile.analyzeRhythm();

   int i, j;
   for (i=0; i<infile.getNumLines(); i++) {
      if (debugQ) {
         cout << "processing line " << (i+1) << " of input ..." << endl;
      }

      if (infile[i].getType() != E_humrec_data) {
         soncondis[i] = -1;
         tertian[i]   = -1;
         terdis[i]    = -1;
         accent[i]    = -1;
      }

      if (infile[i].getType() == E_humrec_interpretation) {
         for (j=0; j<infile[i].getFieldCount(); j++) {
            if (infile[i].getExInterpNum(j) != E_KERN_EXINT) {
               continue;
            }
            if ((strncmp(infile[i][j], "*M", 2) == 0) && 
                  isdigit(infile[i][j][2]) && 
                  (strchr(infile[i][j], '/') != NULL)) {
               sscanf(infile[i][j], "*M%d/%d", &metercount, &meterbase);
               break;
            }
         }
      }

      if (infile[i].getType() != E_humrec_data) {
         continue;
      }

      soncondis[i] = measureVerticalConsonance(infile, i);
      tertian[i]   = measureTertian(infile, i);
      terdis[i]    = measureTertianDissonance(infile, i);
      accent[i]    = measureAccentuation(infile, i);
      dissic[i]    = measureDissic(i, soncondis, tertian, terdis, accent);
   }

}



//////////////////////////////
//
// measureVerticalConsonance -- apply the rules 1 & 2 from page 337:
//
// Rule 1 & Rule 2.  IF a sonority consists of only one note, OR it
// consists of two notes that form a consonant interval other than a
// perfect fourth, OR it consists of three of more notes forming only
// consonant intervals, THEN it is a consonant vertical, OTHERWISE,
// it is a dissonant vertical.
//

#define CONSONANT_VERTICAL 0
#define DISSONANT_VERTICAL 1
#define UNDEFINED_VERTICAL  -1

int measureVerticalConsonance(HumdrumFile& infile, int line) {
   Array<int> notes;

   if (infile[line].getType() != E_humrec_data) {
      return UNDEFINED_VERTICAL;
   }

   infile.getNoteList(notes, line, NL_FILL | NL_SORT | NL_UNIQ | NL_NORESTS);
   
   // IF a sonority consists of only one note, THEN it is a consonant vertical.
   if (notes.getSize() <= 1) {
      return CONSONANT_VERTICAL;
   }

   // IF a sonority consists of two notes that form a consonant interval
   // other than a perfect fourth, THEN it is a consonant vertical.
   if (notes.getSize() == 2) {
      int interval = notes[1] - notes[0];
      if (interval < 0) {
         cout << "Error on line " << line+1 << " of file: " 
              << "problem determing interval" << endl;
         exit(1);
      }

      interval = interval % 40;
      if (interval == E_base40_per4) {
         return DISSONANT_VERTICAL;
      } else if (interval == E_base40_per1 ||
                 interval == E_base40_maj3 ||
                 interval == E_base40_min3 ||
                 interval == E_base40_min6 ||
                 interval == E_base40_maj6 ||
                 interval == E_base40_per5) {
         return CONSONANT_VERTICAL;
      } else {
         return DISSONANT_VERTICAL;
      }
   }

   // IF a sonority consists of three or more notes forming only 
   // consonant intervals, THEN it is a consonant vertical.
   int i, j;
   int interval;
   for (i=0; i<notes.getSize()-1; i++) {
      for (j=i+1; j<notes.getSize(); j++) {
         interval = notes[j] - notes[i];
         interval = interval % 40;
         if (interval == E_base40_per1 ||
             interval == E_base40_maj3 ||
             interval == E_base40_min3 ||
             interval == E_base40_min6 ||
             interval == E_base40_maj6 ||
             interval == E_base40_per4 ||
             interval == E_base40_per5) {
            // do nothing
         } else {
            return DISSONANT_VERTICAL;
         }
      }
   }

   // the chord notes contain only consonant intervals.
   return CONSONANT_VERTICAL;
}



//////////////////////////////
//
// measureTertian -- apply the rule 5 on page 337:
//
// Rule 5: IF the pitch classes of a vertical sonority can be arranged
// so that each note is separated from its neighbor(s) by a third or fifth,
// and the pitches all lie within a single octave, THEN it is tertian.
//

#define TERTIAN_YES       0
#define TERTIAN_NO        1
#define TERTIAN_UNKNOWN  -1

int measureTertian(HumdrumFile& infile, int line) {
   Array<int> notes;

   if (infile[line].getType() != E_humrec_data) {
      return TERTIAN_UNKNOWN;
   }

   infile.getNoteList(notes, line, NL_PC | NL_FILL | NL_SORT | NL_UNIQ | 
         NL_NORESTS);
   
   // if there is one or fewer notes, then cannot be tertian
   if (notes.getSize() <= 1) {
      return TERTIAN_NO;
   }

   int i, j;
   int foundTertianQ = 0;
   int interval;
   for (i=0; i<notes.getSize(); i++) {
      foundTertianQ = 1;
      for (j=1; j<notes.getSize(); j++) {
         interval = notes[j] - notes[j-1];
         if (interval == E_base40_maj3 ||
             interval == E_base40_min3 ||
             interval == E_base40_dim3 ||
             interval == E_base40_aug3 ||
             interval == E_base40_per5 ||
             interval == E_base40_dim5 ||
             interval == E_base40_aug5) {
            // do nothing
         } else {
            // invalid interval
            foundTertianQ = 0;
            break;
         }
      }
      if (foundTertianQ == 1) {
         return TERTIAN_YES;
      }
      rotateNotes(notes);
   }

   return TERTIAN_NO;
}



//////////////////////////////
//
// measureTertianDissonance -- based on the table on page 338.
//
// Table 1: Levels of Tertian Dissonance, page 338
// 
// Dissonance Level	Chord Quality
// ==============================================
// 	   1		consonant intervals
//      		major triads
//			minor triads
//	   2 		tritone
//			diminished triad
//			minor-minor seventh
//			major-minor seventh
//	   3		augmented fifth
//	   		augmented triad
//	   4		half-diminished seventh
//			fully-diminished sevenths
//			augmented-sixth sonorities
//	   5 		verticals with major sevenths
//			anything else
// 
// 

#define TERTIAN_UNKNOWN  -1
#define TERTIAN_0         0   /* i.e., all rests or single notes */
#define TERTIAN_1         1
#define TERTIAN_2         2
#define TERTIAN_3         3
#define TERTIAN_4         4
#define TERTIAN_5         5

int measureTertianDissonance(HumdrumFile& infile, int line) {
   Array<int> notes;

   if (infile[line].getType() != E_humrec_data) {
      return TERTIAN_UNKNOWN;
   }

   infile.getNoteList(notes, line, NL_PC | NL_FILL | NL_SORT | NL_UNIQ | 
         NL_NORESTS);
   
   if (notes.getSize() == 0) {
      return TERTIAN_0;
   }

   if (notes.getSize() == 1) {
      return TERTIAN_0;
   }

   int i, j;
   int foundTertianQ = 0;
   int interval;
   for (i=0; i<notes.getSize(); i++) {
      foundTertianQ = 1;
      for (j=1; j<notes.getSize(); j++) {
         interval = notes[j] - notes[j-1];
         if (interval == E_base40_maj3 ||
             interval == E_base40_min3 ||
             interval == E_base40_dim3 ||
             interval == E_base40_aug3 ||
             interval == E_base40_per5 ||
             interval == E_base40_dim5 ||
             interval == E_base40_aug5) {
            // do nothing
         } else {
            // invalid interval
            foundTertianQ = 0;
            break;
         }
      }
      if (foundTertianQ == 1) {
         break;
      }
      rotateNotes(notes);
   }

   // filter augmented sixth chords:
   for (i=1; i<notes.getSize(); i++) {
      interval = notes[i] - notes[i-1];
      if (interval == E_base40_aug6 || interval == E_base40_dim3) {
         return TERTIAN_4;
      }
   }

   // filter out non tertian sonorities:
   if (!foundTertianQ) {
      return TERTIAN_5;
   }

   // filter tertian chords with major sevenths:
   interval = notes[notes.getSize() - 1] - notes[0];
   if (interval == E_base40_maj7) {
      return TERTIAN_5;
   }

   // filter out augmented fifth chords:
   if (notes[notes.getSize() - 1] - notes[0] < E_base40_min6) {
      for (i=0; i<notes.getSize() - 1; i++) {
         for (j=i+1; j<notes.getSize(); j++) {
            interval = notes[j] - notes[j-1];
            if (interval == E_base40_aug5) {
               return TERTIAN_3;
            }
         }
      }
   }

   if (notes.getSize() == 2) {
      if (notes[1] - notes[0] == E_base40_dim5) {
         return TERTIAN_2;
      } else {
         return TERTIAN_1;
      }
   }

   int interval1;
   int interval2;
   interval1 = notes[1] - notes[0];
   interval2 = notes[2] - notes[0];
   if (notes.getSize() == 3) {
      if (interval2 == E_base40_per5) {
         if (interval1 == E_base40_maj3 || interval1 == E_base40_min3) {
            return TERTIAN_1;
         } else {
            return TERTIAN_5;
         }
      } else if (interval2 == E_base40_dim5) {
         if (interval1 == E_base40_min3) {
            return TERTIAN_2;
         } else {
            return TERTIAN_5;
         }
      } else if (interval2 == E_base40_min7) {
         if (interval1 == E_base40_min3 ||
             interval1 == E_base40_maj3 ||
             interval1 == E_base40_per5) {
            return TERTIAN_2;
         } else {
            return TERTIAN_5;
         }
      } else if (interval2 == E_base40_dim7) {
         if (interval1 == E_base40_min3 ||
             interval1 == E_base40_dim5 ||
             interval1 == E_base40_per5) {
            return TERTIAN_4;
         } else {
            return TERTIAN_5;
         }
      } else {
         return TERTIAN_5;
      }
   }

   int interval3;
   interval1 = notes[1] - notes[0];
   interval2 = notes[2] - notes[0];
   interval3 = notes[3] - notes[0];
   if (notes.getSize() == 4) {
      if (interval3 == E_base40_maj7) {
         return TERTIAN_5;
      } else if (interval3 == E_base40_min7) {
         if (interval2 == E_base40_per5) {
            if (interval1 == E_base40_min3 || interval1 == E_base40_maj3) {
               return TERTIAN_2;
            } 
         }
      } else if (interval3 == E_base40_dim7) {
         if (interval2 == E_base40_per5) {
            if (interval1 == E_base40_min3) {
               return TERTIAN_4;
            } 
         } else if (interval2 == E_base40_dim5) {
            if (interval1 == E_base40_min3) {
               return TERTIAN_4;
            } 
         } 
      } 
   }

   // couldn't identify tertian chord
   return TERTIAN_5;
}



//////////////////////////////
//
// measureAccentuation -- apply the rule 6 on page 337:
//
// Rule 6.  IF a musical event falls on the "primary beat unit" of
//    the meter (as defined by a table relating meters to beat units)
//    THEN it is accented.
//

#define ACCENT_YES       0
#define ACCENT_NO        1
#define ACCENT_UNKNOWN  -1

int measureAccentuation(HumdrumFile& infile, int line) {
   if (infile[line].getType() != E_humrec_data) {
      return ACCENT_UNKNOWN;
   }

   double fraction;
   fraction = infile[line].getBeat();
   if (compoundQ && (metercount % 3 == 0)) {
      fraction = fraction/3;
   }
   int beat = (int)fraction;
   fraction = fraction - beat;
   if (fraction < 0.001) {
      fraction = 0;
   } else if (fraction > 0.999) {
      fraction = 0;
      beat++;
   }

   if (fraction == 0) {
      return ACCENT_YES;
   } else {
      return ACCENT_NO;
   }
}



//////////////////////////////
//
// measureDissic -- determine dissonance in context value using
//     definition by John Maxwell.
//
// Rule 7: IF [a sonority is not tertian] OR [it is accented AND dissonant AND
// the next sonority is tertian AND the next sonority has a lower 
// tertian-dissonance level] OR [it is unaccented AND dissonant AND the last 
// sonority is tertian AND the last sonority has a lower tertian-dissonance 
// level], THEN the sonority is dissonant in context.
//

#define DISSIC_UNDEFINED -1
#define DISSIC_YES        0
#define DISSIC_NO         1

int measureDissic(int line, Array<int>& soncondis, Array<int>& tertian, 
      Array<int>& terdis, Array<int>& accent) {
   int i;


   // case 1: IF a sonority is not tertian, THEN the sonority is dissonant
   // in context.
   if (tertian[line] == TERTIAN_NO) {
      return DISSIC_YES;
   }


   // case 2: IF a sonority is accented AND dissonant AND the next 
   // sonority is tertian AND the next sonority has a lower tertian-dissonance
   // level, THEN the sonority is dissonant in context.
   int nextdislevel = -1;
   int nexttertian = -1;
   for (i=line+1; i<tertian.getSize(); i++) {
      if (tertian[i] != TERTIAN_UNKNOWN) {
         nextdislevel = terdis[i];
         nexttertian  = tertian[i];
         break;
      } 
   }
   if ((accent[line] == ACCENT_YES) && 
         (soncondis[line] == DISSONANT_VERTICAL) &&
         (nexttertian == TERTIAN_YES) && (nextdislevel < terdis[line])) {
      return DISSIC_YES;
   }


   // case 3: IF a sonority is unaccented AND dissonant AND the last sonority
   // is tertian AND the last sonority has a lower tertian-dissonance level,
   // THEN the sonority is dissonant in context.
   int lasttertian = -1;
   int lastterdis = -1;
   for (i=line-1; i>0; i--) {
      if (tertian[i] != TERTIAN_UNKNOWN) {
         lastterdis = terdis[i];
         lasttertian  = tertian[i];
         break;
      } 
   }
   if ((accent[line] == ACCENT_NO) && 
       (soncondis[line] == DISSONANT_VERTICAL) &&
       (lasttertian == TERTIAN_YES) && (lastterdis < terdis[line])) {
      return DISSIC_YES;
   }

   return DISSIC_NO;
}
     


//////////////////////////////
//
// printAnalysis -- 
//

void printAnalysis(HumdrumFile& infile, Array<int>& soncondis,
      Array<int>& tertian, Array<int>& terdis, Array<int>& accent, 
      Array<int>& dissic) {
   int i;
   if (appendQ) {
      for (i=0; i<infile.getNumLines(); i++) {
         switch (infile[i].getType()) {
         case E_humrec_global_comment:
         case E_humrec_bibliography:
         case E_humrec_none:
         case E_humrec_empty:
            cout << infile[i].getLine() << "\n";
            break;
         case E_humrec_data:
            cout << infile[i].getLine() << "\t";
            if (dissic[i] == DISSIC_YES) {
               cout << "y";
            } else {
               cout << "n";
            }
            cout << "\n";
            break;
         case E_humrec_data_comment:
            if (infile[i].equalFieldsQ("**kern")) {
               cout << infile[i].getLine() << "\t"
                    << infile[i][0] << "\n";
            } else {
               cout << infile[i].getLine() << "\t!\n";
            }
            break;
         case E_humrec_data_measure:
            if (infile[i].equalFieldsQ("**kern")) {
               cout << infile[i].getLine() << "\t"
                    << infile[i][0] << "\n";
            } else {
               cout << infile[i].getLine() << "\t=\n";
            }
            break;
         case E_humrec_data_interpretation:
            if (strncmp(infile[i][0], "**", 2) == 0) {
               cout << infile[i].getLine() << "\t";
               cout << "**dissic" << "\n";
            } else if (infile[i].equalFieldsQ("**kern")) {
               cout << infile[i].getLine() << "\t"
                    << infile[i][0] << "\n";
            } else {
               cout << infile[i].getLine() << "\t*\n";
            }
            break;
         }
      }

   } else {

      for (i=0; i<infile.getNumLines(); i++) {
         switch (infile[i].getType()) {
         case E_humrec_global_comment:
         case E_humrec_bibliography:
         case E_humrec_none:
         case E_humrec_empty:
            cout << infile[i].getLine() << "\n";
            break;
         case E_humrec_data:
            if (dissic[i] == DISSIC_YES) {
               cout << "y";
            } else {
               cout << "n";
            }
            cout << "\n";
            break;
         case E_humrec_data_comment:
            if (infile[i].equalFieldsQ("**kern")) {
               cout << infile[i][0] << "\n";
            } else {
               // do nothing
            }
            break;
         case E_humrec_data_measure:
            if (infile[i].equalFieldsQ("**kern")) {
               cout << infile[i][0] << "\n";
            } else {
               cout << "\t=\n";
            }
            break;
         case E_humrec_data_interpretation:
            if (strncmp(infile[i][0], "**", 2) == 0) {
               cout << "**dissic" << "\n";
            } else if (infile[i].equalFieldsQ("**kern")) {
               cout << infile[i][0] << "\n";
            } else {
               // do nothing
            }
            break;
         }
      }
   }
}



//////////////////////////////
//
// rotateNotes -- 
// 

void rotateNotes(Array<int>& notes) {
   if (notes.getSize() < 2) {
      return;
   }

   int note = notes[0];
   int i;
   for (i=0; i<notes.getSize() - 1; i++) {
      notes[i] = notes[i+1];
   }
   notes[notes.getSize()-1] = note + 40;
}



//////////////////////////////
//
// usage -- gives the usage statement for the quality program
//

void usage(const char* command) {
   cout <<
   "                                                                        \n"
   << endl;
}