view Source/TouchKeys/PianoKeyboard.cpp @ 11:c6f30c1e2bda

Fixes for OSC emulation. Also a debugging tool for generating random TouchKeys data.

/*
  TouchKeys: multi-touch musical keyboard control software
  Copyright (c) 2013 Andrew McPherson

  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 3 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, see <http://www.gnu.org/licenses/>.
 
  =====================================================================
 
  PianoKeyboard.cpp: main class that keeps track of each key (and pedal)
  on the keyboard, while also providing hooks for mapping and scheduling
  of events. One shared instance of this class is used widely throughout
  the program.
*/

#include "PianoKeyboard.h"
#include "TouchkeyDevice.h"
#include "../Mappings/Mapping.h"
#include "MidiOutputcontroller.h"
#include "../Mappings/MappingFactory.h"
#include "../Mappings/MappingScheduler.h"

// Constructor
PianoKeyboard::PianoKeyboard() 
: gui_(0), graphGui_(0), midiOutputController_(0),
  oscTransmitter_(0), touchkeyDevice_(0),
  lowestMidiNote_(0), highestMidiNote_(0), numberOfPedals_(0),
  isInitialized_(false), isRunning_(false), isCalibrated_(false), calibrationInProgress_(false)
{
	  // Start a thread by which we can schedule future events
	  futureEventScheduler_.start(0);
      
      // Build the key list
      for(int i = 0; i <= 127; i++)
          keys_.push_back(new PianoKey(*this, i, kDefaultKeyHistoryLength));
      
      mappingScheduler_ = new MappingScheduler(*this);
      mappingScheduler_->start();
}

// Reset all keys and pedals to their default state.
void PianoKeyboard::reset() {
	// Clear any history in the source buffers
	std::vector<PianoKey*>::iterator itKey;
	std::vector<PianoPedal*>::iterator itPed;
	
	for(itKey = keys_.begin(); itKey != keys_.end(); itKey++)
		(*itKey)->reset();
	for(itPed = pedals_.begin(); itPed != pedals_.end(); itPed++)
		(*itPed)->clear();
}

// Provide a pointer to the graphical display class

void PianoKeyboard::setGUI(KeyboardDisplay* gui) {
	gui_ = gui;
	if(gui_ != 0) {
		gui_->setKeyboardRange(lowestMidiNote_, highestMidiNote_);
	}
}

// Set the range of the keyboard in terms of MIDI notes.  A standard
// 88-key keyboard has a range of 21-108, but other setups may differ.

void PianoKeyboard::setKeyboardGUIRange(int lowest, int highest) {
	lowestMidiNote_ = lowest;
	highestMidiNote_ = highest;
	
	// Sanity checks: enforce 0-127 range, high >= low
	if(lowestMidiNote_ < 0)
		lowestMidiNote_ = 0;
	if(highestMidiNote_ < 0)
		highestMidiNote_ = 0;
	if(lowestMidiNote_ > 127)
		lowestMidiNote_ = 127;
	if(highestMidiNote_ > 127)
		highestMidiNote_ = 127;
	if(lowestMidiNote_ > highestMidiNote_)
		highestMidiNote_ = lowestMidiNote_;
	
    /*
	// Free the existing PianoKey objects
	for(std::vector<PianoKey*>::iterator it = keys_.begin(); it != keys_.end(); ++it)
		delete (*it);
	keys_.clear();
	
	// Rebuild the key list
	for(int i = lowestMidiNote_; i <= highestMidiNote_; i++)
		keys_.push_back(new PianoKey(*this, i, kDefaultKeyHistoryLength));
	*/
    
	if(gui_ != 0)
		gui_->setKeyboardRange(lowestMidiNote_, highestMidiNote_);
}

// Send a message by OSC (and potentially by other means depending on who's listening)

void PianoKeyboard::sendMessage(const char * path, const char * type, ...) {
	//ScopedReadLock sl(oscListenerMutex_);

    //cout << "sendMessage: " << path << endl;
    
	// Initialize variable argument list for reading
	va_list v;
	va_start(v, type);	
	
	// Make a new OSC message which we will use both internally and externally
	lo_message msg = lo_message_new();
	lo_message_add_varargs(msg, type, v);
	int argc = lo_message_get_argc(msg);
	lo_arg **argv = lo_message_get_argv(msg);
	
	// Internal handler lookup first
	// Lock the mutex so the list of listeners doesn't change midway through

    updateListeners();
    
	oscListenerMutex_.enter();
    //oscListenerMutex_.enterRead();

	// Now remove the global prefix and compare the rest of the message to the registered handlers.
	std::multimap<std::string, OscHandler*>::iterator it;
	std::pair<std::multimap<std::string, OscHandler*>::iterator,std::multimap<std::string, OscHandler*>::iterator> ret;
	ret = noteListeners_.equal_range((std::string)path);
	
    double timeInHandlers = 0;
    int numHandlers = 0; // DEBUG
	it = ret.first;
	while(it != ret.second) {
		OscHandler *object = (*it++).second;

        double before = Time::getMillisecondCounterHiRes();
		object->oscHandlerMethod(path, type, argc, argv, 0);
        timeInHandlers += Time::getMillisecondCounterHiRes() - before;
        numHandlers++; // DEBUG
	}
    //oscListenerMutex_.exitRead();
    oscListenerMutex_.exit();
	
    //if(timeInHandlers > 1.0)
    //    cout << "sendMessage(): timeInHandlers = " << timeInHandlers << " for " << numHandlers << " handlers (msg " << path << ")\n";

	// Now send this message to any external OSC sources	
	if(oscTransmitter_ != 0)
		oscTransmitter_->sendMessage(path, type, msg);
	
	lo_message_free(msg);	
	va_end(v);


}

// Change number of pedals

void PianoKeyboard::setNumberOfPedals(int number) {
	numberOfPedals_ = number;
	if(numberOfPedals_ < 0)
		numberOfPedals_ = 0;
	if(numberOfPedals_ > 127)
		numberOfPedals_ = 127;
	
	// Free the existing PianoPedal objects
	for(std::vector<PianoPedal*>::iterator it = pedals_.begin(); it != pedals_.end(); ++it)
		delete (*it);
	pedals_.clear();
	
	// Rebuild the list of pedals
	for(int i = 0; i < numberOfPedals_; i++)
		pedals_.push_back(new PianoPedal(kDefaultPedalHistoryLength));
}

// Set color of RGB LED for a given key. note indicates the MIDI
// note number of the key, and color can be specified in one of two
// formats.
void PianoKeyboard::setKeyLEDColorRGB(const int note, const float red, const float green, const float blue) {
    if(touchkeyDevice_ != 0) {
        touchkeyDevice_->rgbledSetColor(note, red, green, blue);
    }
}

void PianoKeyboard::setKeyLEDColorHSV(const int note, const float hue, const float saturation, const float value) {
    if(touchkeyDevice_ != 0) {
        touchkeyDevice_->rgbledSetColorHSV(note, hue, saturation, value);
    }
}

void PianoKeyboard::setAllKeyLEDsOff() {
    if(touchkeyDevice_ != 0) {
        touchkeyDevice_->rgbledAllOff();
    }
}

// ***** Mapping Methods *****

// Add a new mapping identified by a MIDI note and an owner
void PianoKeyboard::addMapping(int noteNumber, Mapping* mapping) {
    removeMapping(noteNumber);  // Free any mapping that's already present on this note
    mappings_[noteNumber] = mapping;
}

// Remove an existing mapping identified by owner
void PianoKeyboard::removeMapping(int noteNumber) {
    if(mappings_.count(noteNumber) == 0)
        return;
    Mapping* mapping = mappings_[noteNumber];
    delete mapping;
    mappings_.erase(noteNumber);
}

// Return a specific mapping by owner and note number
Mapping* PianoKeyboard::mapping(int noteNumber) {
    if(mappings_.count(noteNumber) == 0)
        return 0;
    return mappings_[noteNumber];
}

// Return a list of all MIDI notes with active mappings. Some may have more than
// one but we only want the list of active notes
std::vector<int> PianoKeyboard::activeMappings() {
    std::vector<int> keys;
    std::map<int, Mapping*>::iterator it = mappings_.begin();
    while(it != mappings_.end()) {
        int nextKey = (it++)->first;
        keys.push_back(nextKey);
    }
    return keys;
}

void PianoKeyboard::clearMappings() {
    std::map<int, Mapping*>::iterator it = mappings_.begin();
    
    while(it != mappings_.end()) {
        // Delete everybody in the container
        Mapping *mapping = it->second;
        delete mapping;
    }
    
    // Now clear the container
    mappings_.clear();
}

// Mapping factory methods: tell each registered factory about these events if it listens to this particular note
void PianoKeyboard::tellAllMappingFactoriesTouchBegan(int noteNumber, bool midiNoteIsOn, bool keyMotionActive,
                                                      Node<KeyTouchFrame>* touchBuffer,
                                                      Node<key_position>* positionBuffer,
                                                      KeyPositionTracker* positionTracker) {
    ScopedReadLock sl(mappingFactoriesMutex_);
    std::map<MidiKeyboardSegment*, MappingFactory*>::iterator it;
    for(it = mappingFactories_.begin(); it != mappingFactories_.end(); it++) {
        if(it->first->respondsToNote(noteNumber))
            it->second->touchBegan(noteNumber, midiNoteIsOn, keyMotionActive, touchBuffer, positionBuffer, positionTracker);
    }
}

void PianoKeyboard::tellAllMappingFactoriesTouchEnded(int noteNumber, bool midiNoteIsOn, bool keyMotionActive,
                                                      Node<KeyTouchFrame>* touchBuffer,
                                                      Node<key_position>* positionBuffer,
                                                      KeyPositionTracker* positionTracker) {
    ScopedReadLock sl(mappingFactoriesMutex_);
    std::map<MidiKeyboardSegment*, MappingFactory*>::iterator it;
    for(it = mappingFactories_.begin(); it != mappingFactories_.end(); it++) {
        if(it->first->respondsToNote(noteNumber))
            it->second->touchEnded(noteNumber, midiNoteIsOn, keyMotionActive, touchBuffer, positionBuffer, positionTracker);
    }
}

void PianoKeyboard::tellAllMappingFactoriesKeyMotionActive(int noteNumber, bool midiNoteIsOn, bool touchIsOn,
                                                           Node<KeyTouchFrame>* touchBuffer,
                                                           Node<key_position>* positionBuffer,
                                                           KeyPositionTracker* positionTracker) {
    ScopedReadLock sl(mappingFactoriesMutex_);
    std::map<MidiKeyboardSegment*, MappingFactory*>::iterator it;
    for(it = mappingFactories_.begin(); it != mappingFactories_.end(); it++) {
        if(it->first->respondsToNote(noteNumber))
            it->second->keyMotionActive(noteNumber, midiNoteIsOn, touchIsOn, touchBuffer, positionBuffer, positionTracker);
    }
}

void PianoKeyboard::tellAllMappingFactoriesKeyMotionIdle(int noteNumber, bool midiNoteIsOn, bool touchIsOn,
                                                         Node<KeyTouchFrame>* touchBuffer,
                                                         Node<key_position>* positionBuffer,
                                                         KeyPositionTracker* positionTracker) {
    ScopedReadLock sl(mappingFactoriesMutex_);
    std::map<MidiKeyboardSegment*, MappingFactory*>::iterator it;
    for(it = mappingFactories_.begin(); it != mappingFactories_.end(); it++) {
        if(it->first->respondsToNote(noteNumber))
            it->second->keyMotionIdle(noteNumber, midiNoteIsOn, touchIsOn, touchBuffer, positionBuffer, positionTracker);
    }
}

// Destructor

PianoKeyboard::~PianoKeyboard() {
    // Remove all mappings
    clearMappings();
    
	// Delete any keys and pedals we've allocated
	for(std::vector<PianoKey*>::iterator it = keys_.begin(); it != keys_.end(); ++it)
		delete (*it);
	for(std::vector<PianoPedal*>::iterator it = pedals_.begin(); it != pedals_.end(); ++it)
		delete (*it);
    mappingScheduler_->stop();
    delete mappingScheduler_;
}