andrewm@0: /*
andrewm@0:   TouchKeys: multi-touch musical keyboard control software
andrewm@0:   Copyright (c) 2013 Andrew McPherson
andrewm@0: 
andrewm@0:   This program is free software: you can redistribute it and/or modify
andrewm@0:   it under the terms of the GNU General Public License as published by
andrewm@0:   the Free Software Foundation, either version 3 of the License, or
andrewm@0:   (at your option) any later version.
andrewm@0:  
andrewm@0:   This program is distributed in the hope that it will be useful,
andrewm@0:   but WITHOUT ANY WARRANTY; without even the implied warranty of
andrewm@0:   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
andrewm@0:   GNU General Public License for more details.
andrewm@0: 
andrewm@0:   You should have received a copy of the GNU General Public License
andrewm@0:   along with this program.  If not, see <http://www.gnu.org/licenses/>.
andrewm@0:  
andrewm@0:   =====================================================================
andrewm@0: 
andrewm@0:   TouchkeyKeyDivisionMappingFactory.cpp: factory for the split-key mapping
andrewm@0:   which triggers different actions or pitches depending on where the key
andrewm@0:   was struck.
andrewm@0: */
andrewm@0: 
andrewm@0: #include "TouchkeyKeyDivisionMappingFactory.h"
andrewm@0: 
andrewm@0: const float TouchkeyKeyDivisionMappingFactory::kDefaultPitchWheelRangeSemitones = 2.0;
andrewm@0: 
andrewm@0: // Yarman-24 Turkish microtonal tuning:
andrewm@0: /*      1/1	RAST		C
andrewm@0:  84.360	Nim Zengule	C#/Db
andrewm@0:  145.112	Zengule		Cᵻ/Dƀ
andrewm@0:  192.180	Dik Zengule	Dd
andrewm@0:  9/8	DUGAH		D
andrewm@0:  292.180	Kurdi		D#/Eb
andrewm@0:  60/49	Dik Kurdi	Dᵻ/Eƀ
andrewm@0:  364.735	Nerm Segah	Ed
andrewm@0:  5/4	SEGAH		E
andrewm@0:  415.677	Buselik		E‡
andrewm@0:  4/3	CHARGAH		F
andrewm@0:  584.359	Nim Hijaz	F#/Gb
andrewm@0:  635.300	Hijaz/Saba	Fᵻ/Gƀ
andrewm@0:  696.090	Dik Hijaz/Saba	Gd
andrewm@0:  3/2	NEVA		G
andrewm@0:  788.270	Nim Hisar	G#/Ab
andrewm@0:  854.924	Hisar		Gᵻ/Aƀ
andrewm@0:  888.270	Dik Hisar	Ad
andrewm@0:  27/16	HUSEYNI		A	440hz
andrewm@0:  16/9	Ajem		A#/Bb
andrewm@0:  11/6	Dik Ajem	Aᵻ/Bƀ
andrewm@0:  1074.547	Nerm Evdj	Bd
andrewm@0:  15/8	EVDJ		B
andrewm@0:  1125.488	Mahur		B‡
andrewm@0:  2/1	GERDANIYE	C */
andrewm@0: /*const float TouchkeyKeyDivisionMappingFactory::kDefaultTuningsCents[24] = {
andrewm@0:     0, 84.36, 145.112, 192.18, 203.9, 292.18, 350.62, 364.74, 386.31, 415.677, 498.04, 584.359,
andrewm@0:     635.3, 696.09, 701.95, 788.27, 854.92, 888.27, 905.87, 996.1, 1049.36, 1074.55, 1088.27, 1125.488
andrewm@0: };*/
andrewm@0: 
andrewm@0: // Yarman-24c Turkish microtonal tuning:
andrewm@0: /*   0:          1/1           C    Dbb   unison, perfect prime    RAST ♥
andrewm@0:  1:         83.059 cents   C#   Db    				nim zengule
andrewm@0:  2:        143.623 cents					zengule
andrewm@0:  3:        191.771 cents   C##  Dd				dik zengule
andrewm@0:  4:          9/8           D    Ebb   major whole tone		DÜGAH ♥
andrewm@0:  5:        292.413 cents   D#   Eb				kürdi
andrewm@0:  6:        348.343 cents   D#|  Eb-				dik kürdi
andrewm@0:  7:        362.503 cents					nerm segah
andrewm@0:  8:        156/125 cents   E					SEGAH ♥
andrewm@0:  9:        415.305 cents   E| 					Buselik
andrewm@0:  10:          4/3           F    Gbb   perfect fourth		ÇARGAH ♥
andrewm@0:  11:        581.382 cents   F#   Gb				nim hicaz
andrewm@0:  12:        634.184 cents					hicaz
andrewm@0:  13:        695.885 cents   F##  Gd				dik hicaz
andrewm@0:  14:          3/2           G    Abb   perfect fifth		NEVA ♥
andrewm@0:  15:        788.736 cents   G#   Ab				nim hisar
andrewm@0:  16:        853.063 cents					hisar
andrewm@0:  17:        887.656 cents   G##  Ad				dik hisar
andrewm@0:  18:         27/16          A    Bbb   Pyth. major sixth	HÜSEYNİ ♥
andrewm@0:  19:         16/9           A#   Bb    Pyth. minor seventh	acem
andrewm@0:  20:       1043.623 cents   A#|  Bb-				dik acem
andrewm@0:  21:       1071.942 cents					nerm eviç
andrewm@0:  22:        234/125 cents   B					EVİÇ ♥
andrewm@0:  23:       1124.744 cents   B|					mahur
andrewm@0:  24:          2/1           C    Dbb   octave			GERDANİYE ♥
andrewm@0: */
andrewm@0: 
andrewm@0: /*const float TouchkeyKeyDivisionMappingFactory::kDefaultTuningsCents[24] = {
andrewm@0:     0, 83.059, 143.623, 191.771, 203.9, 292.413, 348.343, 362.503, 383.54, 415.305, 498.04, 581.382,
andrewm@0:     634.184, 695.885, 701.95, 788.736, 853.063, 887.656, 905.87, 996.1, 1043.623, 1071.942, 1085.49, 1124.744
andrewm@0: };*/
andrewm@0: 
andrewm@0: /* Yarman-24c as above but arranged for performance */
andrewm@0: const float TouchkeyKeyDivisionMappingFactory::kDefaultTuningsCents[24] = {
andrewm@0:     0, (1124.744 - 1200.0), 83.059, 143.623, 203.9, 191.771, 292.413, 348.343,
andrewm@0:     383.54, 362.503, 498.04, 415.305, 581.382, 634.184, 695.885, 648.682,
andrewm@0:     788.736, 853.063, 905.87, 887.656, 996.1, 1043.623, 1085.49, 1071.942,
andrewm@0: };
andrewm@0: 
andrewm@0: /*const float TouchkeyKeyDivisionMappingFactory::kDefaultTuningsCents[24] = {
andrewm@0:     0, 50, 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700,
andrewm@0:     750, 800, 850, 900, 950, 1000, 1050, 1100, 1150
andrewm@0: };*/
andrewm@0: 
andrewm@0: /*const float TouchkeyKeyDivisionMappingFactory::kDefaultTuningsCents[36] = {
andrewm@0:     0, 33.3, 66.6, 100, 133.3, 166.6, 200, 233.3, 266.6, 300, 333.3, 366.6,
andrewm@0:     400, 433.3, 466.6, 500, 533.3, 566.6, 600, 633.3, 666.6, 700, 733.3, 766.6,
andrewm@0:     800, 833.3, 866.6, 900, 933.3, 966.6, 1000, 1033.3, 1066.6, 1100, 1133.3, 1166.6
andrewm@0: };*/
andrewm@0: 
andrewm@0: /* As arranged:
andrewm@0:  *
andrewm@0:  *   B|  Db/  Dd  Eb/  Ed  E|  Gb/  Gd  Ab/  Ad  Bb/  Bd
andrewm@0:  *   C   C#   D   D#   E   F   F#   G   G#   A   A#   B
andrewm@0:  */
andrewm@0: 
andrewm@0: TouchkeyKeyDivisionMappingFactory::TouchkeyKeyDivisionMappingFactory(PianoKeyboard &keyboard, MidiKeyboardSegment& segment)
andrewm@0: : TouchkeyBaseMappingFactory<TouchkeyKeyDivisionMapping>(keyboard, segment),
andrewm@0:   pitchWheelRangeSemitones_(kDefaultPitchWheelRangeSemitones),
andrewm@0:   numSegmentsPerKey_(TouchkeyKeyDivisionMapping::kDefaultNumberOfSegments),
andrewm@0:   timeout_(TouchkeyKeyDivisionMapping::kDefaultDetectionTimeout),
andrewm@0:   detectionParameter_(TouchkeyKeyDivisionMapping::kDefaultDetectionParameter),
andrewm@0:   retriggerable_(false),
andrewm@0:   retriggerNumFrames_(TouchkeyKeyDivisionMapping::kDefaultRetriggerNumFrames),
andrewm@0:   retriggerKeepsVelocity_(true),
andrewm@0:   referenceNote_(0), globalOffsetCents_(0)
andrewm@0: {
andrewm@0:     //setName("/touchkeys/segmentpitch");
andrewm@0:     setBendParameters();
andrewm@0: }
andrewm@0: 
andrewm@0: void TouchkeyKeyDivisionMappingFactory::setMIDIPitchWheelRange(float maxBendSemitones) {
andrewm@0:     if(maxBendSemitones <= 0)
andrewm@0:         return;
andrewm@0:     pitchWheelRangeSemitones_ = maxBendSemitones;
andrewm@0:     
andrewm@0:     setBendParameters();
andrewm@0: }
andrewm@0: 
andrewm@0: void TouchkeyKeyDivisionMappingFactory::setName(const string& name) {
andrewm@0:     TouchkeyBaseMappingFactory<TouchkeyKeyDivisionMapping>::setName(name);
andrewm@0:     setBendParameters();
andrewm@0: }
andrewm@0: 
andrewm@0: // Set the initial parameters for a new mapping
andrewm@0: void TouchkeyKeyDivisionMappingFactory::initializeMappingParameters(int noteNumber, TouchkeyKeyDivisionMapping *mapping) {
andrewm@0:     // KLUDGE: testing Maqam tunings. Go from absolute tunings in cents to pitch bends in semitones
andrewm@0:     float tunings[2];
andrewm@0:     int index = (noteNumber + 12 - referenceNote_) % 12;
andrewm@0:     float standardTuning = (float)index * 100.0;
andrewm@0:     tunings[0] = (kDefaultTuningsCents[index*2] - standardTuning + globalOffsetCents_) * .01;
andrewm@0:     tunings[1] = (kDefaultTuningsCents[index*2 + 1] - standardTuning + globalOffsetCents_) * .01;
andrewm@0:     mapping->setSegmentPitchBends(tunings, 2);
andrewm@0:     /*float tunings[3];
andrewm@0:     int index = (noteNumber + 12 - referenceNote_) % 12;
andrewm@0:     float standardTuning = (float)index * 100.0;
andrewm@0:     tunings[0] = (kDefaultTuningsCents[index*3] - standardTuning + globalOffsetCents_) * .01;
andrewm@0:     tunings[1] = (kDefaultTuningsCents[index*3 + 1] - standardTuning + globalOffsetCents_) * .01;
andrewm@0:     tunings[2] = (kDefaultTuningsCents[index*3 + 2] - standardTuning + globalOffsetCents_) * .01;
andrewm@0:     mapping->setSegmentPitchBends(tunings, 3);*/
andrewm@0: 
andrewm@0:     
andrewm@0:     mapping->setNumberOfSegments(numSegmentsPerKey_);
andrewm@0:     mapping->setTimeout(timeout_);
andrewm@0:     mapping->setDetectionParameter(detectionParameter_);
andrewm@0:     mapping->setRetriggerable(retriggerable_, retriggerNumFrames_, retriggerKeepsVelocity_);
andrewm@0: }
andrewm@0: 
andrewm@0: void TouchkeyKeyDivisionMappingFactory::setBendParameters() {
andrewm@0:     setMidiParameters(MidiKeyboardSegment::kControlPitchWheel, -pitchWheelRangeSemitones_, pitchWheelRangeSemitones_, 0.0);
andrewm@0:     
andrewm@0:     if(midiConverter_ != 0) {
andrewm@0:         midiConverter_->setMidiPitchWheelRange(pitchWheelRangeSemitones_);
andrewm@0:         midiConverter_->listenToIncomingControl(MidiKeyboardSegment::kControlPitchWheel);
andrewm@0:     }
andrewm@0: }