/** %% Defines a few 'standard' database entries for 12 pitches per octave..
%% */

%%
%% TODO:
%%
%% - revise specs for required PC and dissonances PC 
%%
%% - dissonance degree: incorporate some standard measurements
%%

functor
export
   Chords
   Scales
   Intervals
   PitchesPerOctave
   AccidentalOffset
   OctaveDomain
   db:DB
define

   Chords = chords(
	       %%
	       %% triads
	       %%
	       chord(pitchClasses:[0 4 7]
		     roots:[0]
		     required:[0 4]
		     dissonances:nil
			 % dissonanceDegree:2
		     comment:'major')
	       chord(pitchClasses:[0 3 7]
		     roots:[0]
		     required:[0 3]
		     dissonances:nil
			 % dissonanceDegree:3
		     comment:'minor')
	       chord(pitchClasses:[0 3 6]
		     roots:[8] 	% NOTE: ??
		     required:[0 6]
		     dissonances:[6]
		     comment:'diminished')
	       chord(pitchClasses:[0 4 8]
		     roots:[0] 	% NOTE: ?? 
		     required:[0 4 8]
		     dissonances:[8]
		     comment:'augmented')
	       %%
	       %% tetrads
	       %%
	       chord(pitchClasses:[0 4 7 11]
		     roots:[0] 
		     required:[0 4 11]
		     dissonances:[11]
		     comment:'major seventh')
	       chord(pitchClasses:[0 4 7 10]
		     roots:[0] 
		     required:[0 4 10]
		     dissonances:[10]
		     comment:'dominant seventh')
	       chord(pitchClasses:[0 3 7 10]
		     roots:[0] 
		     required:[0 3 10]
		     dissonances:[10]
		     comment:'minor seventh')
	       chord(pitchClasses:[0 3 7 11]
		     roots:[0] 
		     required:[0 3 11]
		     dissonances:[11]
		     comment:'minor major seventh')
	       chord(pitchClasses:[0 3 6 10]
		     roots:[8] 	% NOTE: ??
		     required:[0 3 6 10] % NOTE: ??
		     dissonances:[6 10]
		     comment:'half-diminished seventh')
	       chord(pitchClasses:[0 3 6 9]
		     roots:[2 5 8 11] 
		     required:[0 3 6 9] % NOTE: ??
		     dissonances:[6 9]	% NOTE: ??
		     comment:'diminished seventh')


	       %%
	       %% unfinished
	       %%

	       /*
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       chord(pitchClasses:[0]
		     roots:[0] 
		     required:[0]
		     dissonances:nil
		     comment:'')
	       */
	       
	       )
   
   Scales = scales(scale(pitchClasses:[0 2 4 5 7 9 11]
			 roots:[0]
			 comment:'major')
		   scale(pitchClasses:[0 2 3 5 7 8 10]
			 roots:[0] 
			 comment:'natural minor')
		   %% !! such extended scale def with 'alternative' scale degrees as 10 or 11 makes correct recognition of scale degree impossible -- better introduce 'alternatives' by explicit accidentals 
% 				    scale(pitchClasses:[0 2 3 5 7 8 9 10 11]
% 					  roots:[0] 
% 					  comment:minor)
		   scale(pitchClasses:[0 1 2 3 4 5 6 7 8 9 10 11]
			 roots:[0] 
			 comment:'chromatic')
		  )

   Intervals = intervals(interval(interval:0
				  dissonanceDegree:0
				  comment:'unison')
			 interval(interval:1
				  dissonanceDegree:6
				  comment:'minorSecond')
			 interval(interval:2
				  dissonanceDegree:5
				  comment:'majorSecond')
			 interval(interval:3
				  dissonanceDegree:4
				  comment:'minorThird')
			 interval(interval:4
				  dissonanceDegree:3
				  comment:'majorThird')
			 interval(interval:5
				  dissonanceDegree:2
				  comment:'fourth')
			 interval(interval:6
				  dissonanceDegree:6
				  comment:'tritone')
			 interval(interval:7
				  dissonanceDegree:1
				  comment:'fifth')
			 interval(interval:8
				  dissonanceDegree:3
				  comment:'minorSixth')
			 interval(interval:9
				  dissonanceDegree:4
				  comment:'majorSixth')
			 interval(interval:10
				  dissonanceDegree:5
				  comment:'minorSeventh')
			 interval(interval:11
				  dissonanceDegree:6
				  comment:'majorSeventh'))
   
   PitchesPerOctave=12
   AccidentalOffset=2
   %% corresponds to MIDI pitch range 12-127+ (for pitchesPerOctave=12)
   OctaveDomain=0#9

   DB = unit(chordDB:Chords
	     scaleDB:Scales
	     intervalDB:Intervals
	     pitchesPerOctave: PitchesPerOctave
	     accidentalOffset: AccidentalOffset
	     octaveDomain: OctaveDomain
	     %% dummy default so that RegularTemperamentNote objects can be created without failure (e.g., required for exporting score archive)
	     generators: [0]    
	     generatorFactors: [0#1] % dummy default
	     generatorFactorsOffset: 0
	     temperament: unit
	    )
   
end