ardour/libs/ardour/automatable.cc

/*
    Copyright (C) 2001,2007 Paul Davis 

    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., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <ardour/ardour.h>
#include <fstream>
#include <inttypes.h>
#include <cstdio>
#include <errno.h>
#include <pbd/error.h>
#include <pbd/enumwriter.h>
#include <ardour/session.h>
#include <ardour/automatable.h>
#include <ardour/midi_track.h>

#include "i18n.h"

using namespace std;
using namespace ARDOUR;
using namespace PBD;

nframes_t Automatable::_automation_interval = 0;

Automatable::Automatable(Session& _session, const string& name)
	: SessionObject(_session, name)
	, _last_automation_snapshot(0)
{}

int
Automatable::old_set_automation_state (const XMLNode& node)
{
	const XMLProperty *prop;
			
	if ((prop = node.property ("path")) != 0) {
		load_automation (prop->value());
	} else {
		warning << string_compose(_("%1: Automation node has no path property"), _name) << endmsg;
	}
	
	if ((prop = node.property ("visible")) != 0) {
		uint32_t what;
		stringstream sstr;
		
		_visible_controls.clear ();
		
		sstr << prop->value();
		while (1) {
			sstr >> what;
			if (sstr.fail()) {
				break;
			}
			mark_automation_visible (Parameter(PluginAutomation, what), true);
		}
	}
	
	_last_automation_snapshot = 0;

	return 0;
}

int
Automatable::load_automation (const string& path)
{
	string fullpath;

	if (path[0] == '/') { // legacy
		fullpath = path;
	} else {
		fullpath = _session.automation_dir();
		fullpath += path;
	}
	ifstream in (fullpath.c_str());

	if (!in) {
		warning << string_compose(_("%1: cannot open %2 to load automation data (%3)"), _name, fullpath, strerror (errno)) << endmsg;
		return 1;
	}

	Glib::Mutex::Lock lm (_automation_lock);
	set<Parameter> tosave;
	_controls.clear ();
	
	_last_automation_snapshot = 0;

	while (in) {
		double when;
		double value;
		uint32_t port;

		in >> port;  if (!in) break;
		in >> when;  if (!in) goto bad;
		in >> value; if (!in) goto bad;
		
		/* FIXME: this is legacy and only used for plugin inserts?  I think? */
		boost::shared_ptr<AutomationControl> c = control (Parameter(PluginAutomation, port), true);
		c->list()->add (when, value);
		tosave.insert (Parameter(PluginAutomation, port));
	}
	
	return 0;

  bad:
	error << string_compose(_("%1: cannot load automation data from %2"), _name, fullpath) << endmsg;
	_controls.clear ();
	return -1;
}

void
Automatable::add_control(boost::shared_ptr<AutomationControl> ac)
{
	Parameter param = ac->parameter();

	_controls[param] = ac;
	
	_can_automate_list.insert(param);

	// Sync everything (derived classes) up to initial values
	auto_state_changed(param);
}

void
Automatable::what_has_automation (set<Parameter>& s) const
{
	Glib::Mutex::Lock lm (_automation_lock);
	Controls::const_iterator li;
	
	// FIXME: correct semantics?
	for (li = _controls.begin(); li != _controls.end(); ++li) {
		s.insert  ((*li).first);
	}
}

void
Automatable::what_has_visible_automation (set<Parameter>& s) const
{
	Glib::Mutex::Lock lm (_automation_lock);
	set<Parameter>::const_iterator li;
	
	for (li = _visible_controls.begin(); li != _visible_controls.end(); ++li) {
		s.insert  (*li);
	}
}

/** Returns NULL if we don't have an AutomationList for \a parameter.
 */
boost::shared_ptr<AutomationControl>
Automatable::control (Parameter parameter, bool create_if_missing)
{
	Controls::iterator i = _controls.find(parameter);

	if (i != _controls.end()) {
		return i->second;

	} else if (create_if_missing) {
		boost::shared_ptr<AutomationList> al (new AutomationList (
					parameter, FLT_MIN, FLT_MAX, default_parameter_value (parameter)));
		boost::shared_ptr<AutomationControl> ac(control_factory(al));
		add_control(ac);
		return ac;

	} else {
		//warning << "AutomationList " << parameter.to_string() << " not found for " << _name << endmsg;
		return boost::shared_ptr<AutomationControl>();
	}
}

boost::shared_ptr<const AutomationControl>
Automatable::control (Parameter parameter) const
{
	Controls::const_iterator i = _controls.find(parameter);

	if (i != _controls.end()) {
		return i->second;
	} else {
		//warning << "AutomationList " << parameter.to_string() << " not found for " << _name << endmsg;
		return boost::shared_ptr<AutomationControl>();
	}
}


string
Automatable::describe_parameter (Parameter param)
{
	/* derived classes like PluginInsert should override this */

	if (param == Parameter(GainAutomation)) {
		return _("Fader");
	} else if (param.type() == PanAutomation) {
		return (string_compose(_("Pan %1"), param.id()));
	} else if (param.type() == MidiCCAutomation) {
		string name = get_name_for_cc_number(param.id());
		if(name.length() != 0) {
			return string_compose("%1 [%2]", name, int(param.channel()) + 1);			
		} else {
			return string_compose("CC %1 [%2]", param.id(), int(param.channel()) + 1);
		}
	} else if (param.type() == MidiPgmChangeAutomation) {
		return string_compose("Program [%1]", int(param.channel()) + 1);
	} else if (param.type() == MidiPitchBenderAutomation) {
		return string_compose("Bender [%1]", int(param.channel()) + 1);
	} else if (param.type() == MidiChannelAftertouchAutomation) {
		return string_compose("Aftertouch [%1]", int(param.channel()) + 1);
	} else {
		return param.to_string();
	}
}

string
Automatable::get_name_for_cc_number (uint32_t cc_number)
{
	string name;
	
	switch (cc_number) {
		case 0:
			name = "Upper Bank";
			break;
			
		case 32:
			name = "Lower Bank";
			break;
		
		case 1:
			name = "Modulation MSB";
			break;
			
		case 2:
			name = "Breath Controller";
			break;	
			
		case 4:
			name = "Foot Controller";
			break;
			
		case 5:
			name = "Portamento Time";
			break;
			
		case 6:
			name = "RPN Controller";
			break;
			
		case 7:
			name = "Main Volume";
			break;
			
		case 8:
			name = "Balance";
			break;
			
		case 10:
			name = "Panorama";
			break;
			
		case 11:
			name = "Expression";
			break;
			
		case 12:
			name = "Effect 1";
			break;
			
		case 13:
			name = "Effect 2";
			break;
			
		case 16:
		case 17:
		case 18:
		case 19:
			name = string_compose("General Purpose %1", cc_number - 15);
			break;
			
		case 64:
			name = "Sustain Pedal";
			break;
			
		case 65:
			name = "Portamento";
			break;
			
		case 66:
			name = "Sostenuto";
			break;
			
		case 67:
			name = "Soft Pedal";
			break;
			
		case 68:
			name = "Legato Footswitch";
			break;
			
		case 69:
			name = "Hold 2";
			break;
			
		case 70:
		case 71:
		case 72:
		case 73:
		case 74:
			name = string_compose("Sound Controller %1", cc_number - 69);
			break;
			
		case 80:
		case 81:
		case 82:
		case 83:
			name = string_compose("General Purpose %1", cc_number - 75);
			break;
			
		case 84:
			name = "Portamento Control";
			break;
			
		case 91:
		case 92:
		case 93:
		case 94:
		case 95:
			name = string_compose("Effects %1 Depth", cc_number - 90);
			break;			
			
		case 96:
			name = "Data Increment RPN/NRPN";
			break;
			
		case 97:
			name = "Data Decrement RPN/NRPN";
			break;
			
		case 98:
			name = "NRPN LSB";
			break;
			
		case 99:
			name = "NRPN MSB";
			break;
						
		case 100:
			name = "RPN LSB";
			break;
			
		case 101:
			name = "RPN MSB";
			break;
			
		case 120:
			name = "all sounds off";
			break;
			
		case 121:
			name = "Controller Reset";
			break;
			
		case 122:
			name = "Local Control on/off";
			break;
			
		case 123:
			name = "all notes off";
			break;
			
		case 124:
			name = "omni off";
			break;
			
		case 125:
			name = "omni on";
			break;
			
		case 126:
			name = "mono on / poly off";
			break;
			
		case 127:
			name = "poly on / mono off";
			break;	
			
		default:
			break;
	}
	
	return name;
}

void
Automatable::can_automate (Parameter what)
{
	_can_automate_list.insert (what);
}

void
Automatable::mark_automation_visible (Parameter what, bool yn)
{
	if (yn) {
		_visible_controls.insert (what);
	} else {
		set<Parameter>::iterator i;

		if ((i = _visible_controls.find (what)) != _visible_controls.end()) {
			_visible_controls.erase (i);
		}
	}
}

bool
Automatable::find_next_event (nframes_t now, nframes_t end, ControlEvent& next_event) const
{
	Controls::const_iterator li;	

	next_event.when = max_frames;
	
  	for (li = _controls.begin(); li != _controls.end(); ++li) {
		
		AutomationList::const_iterator i;
		boost::shared_ptr<const AutomationList> alist (li->second->list());
		ControlEvent cp (now, 0.0f);
		
 		for (i = lower_bound (alist->const_begin(), alist->const_end(), &cp, AutomationList::time_comparator);
				i != alist->const_end() && (*i)->when < end; ++i) {
 			if ((*i)->when > now) {
 				break; 
 			}
 		}
 		
 		if (i != alist->const_end() && (*i)->when < end) {
			
 			if ((*i)->when < next_event.when) {
 				next_event.when = (*i)->when;
 			}
 		}
 	}

 	return next_event.when != max_frames;
}

/** \a legacy_param is used for loading legacy sessions where an object (IO, Panner)
 * had a single automation parameter, with it's type implicit.  Derived objects should
 * pass that type and it will be used for the untyped AutomationList found.
 */
int
Automatable::set_automation_state (const XMLNode& node, Parameter legacy_param)
{	
	Glib::Mutex::Lock lm (_automation_lock);

	/* Don't clear controls, since some may be special derived Controllable classes */

	_visible_controls.clear ();

	XMLNodeList nlist = node.children();
	XMLNodeIterator niter;
	
	for (niter = nlist.begin(); niter != nlist.end(); ++niter) {

		/*if (sscanf ((*niter)->name().c_str(), "parameter-%" PRIu32, &param) != 1) {
		  error << string_compose (_("%2: badly formatted node name in XML automation state, ignored"), _name) << endmsg;
		  continue;
		  }*/

		if ((*niter)->name() == "AutomationList") {

			const XMLProperty* id_prop = (*niter)->property("automation-id");

			Parameter param = (id_prop ? Parameter(id_prop->value()) : legacy_param);
			
			boost::shared_ptr<AutomationList> al (new AutomationList(**niter, param));
			
			if (!id_prop) {
				warning << "AutomationList node without automation-id property, "
					<< "using default: " << legacy_param.to_string() << endmsg;
				al->set_parameter(legacy_param);
			}

			boost::shared_ptr<AutomationControl> existing = control(param);
			if (existing)
				existing->set_list(al);
			else
				add_control(control_factory(al));

		} else {
			error << "Expected AutomationList node, got '" << (*niter)->name() << endmsg;
		}
	}

	_last_automation_snapshot = 0;

	return 0;
}

XMLNode&
Automatable::get_automation_state ()
{
	Glib::Mutex::Lock lm (_automation_lock);
	XMLNode* node = new XMLNode (X_("Automation"));
	
	if (_controls.empty()) {
		return *node;
	}

	for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li) {
		node->add_child_nocopy (li->second->list()->get_state ());
	}

	return *node;
}

void
Automatable::clear_automation ()
{
	Glib::Mutex::Lock lm (_automation_lock);

	for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
		li->second->list()->clear();
}
	
void
Automatable::set_parameter_automation_state (Parameter param, AutoState s)
{
	Glib::Mutex::Lock lm (_automation_lock);
	
	boost::shared_ptr<AutomationControl> c = control (param, true);

	if (s != c->list()->automation_state()) {
		c->list()->set_automation_state (s);
		_session.set_dirty ();
	}
}

AutoState
Automatable::get_parameter_automation_state (Parameter param, bool lock)
{
	AutoState result = Off;

	if (lock)
		_automation_lock.lock();

	boost::shared_ptr<AutomationControl> c = control(param);

	if (c)
		result = c->list()->automation_state();
	
	if (lock)
		_automation_lock.unlock();

	return result;
}

void
Automatable::set_parameter_automation_style (Parameter param, AutoStyle s)
{
	Glib::Mutex::Lock lm (_automation_lock);
	
	boost::shared_ptr<AutomationControl> c = control(param, true);

	if (s != c->list()->automation_style()) {
		c->list()->set_automation_style (s);
		_session.set_dirty ();
	}
}

AutoStyle
Automatable::get_parameter_automation_style (Parameter param)
{
	Glib::Mutex::Lock lm (_automation_lock);

	boost::shared_ptr<AutomationControl> c = control(param);

	if (c) {
		return c->list()->automation_style();
	} else {
		return Absolute; // whatever
	}
}

void
Automatable::protect_automation ()
{
	set<Parameter> automated_params;

	what_has_automation (automated_params);

	for (set<Parameter>::iterator i = automated_params.begin(); i != automated_params.end(); ++i) {

		boost::shared_ptr<AutomationControl> c = control(*i);

		switch (c->list()->automation_state()) {
		case Write:
			c->list()->set_automation_state (Off);
			break;
		case Touch:
			c->list()->set_automation_state (Play);
			break;
		default:
			break;
		}
	}
}

void
Automatable::automation_snapshot (nframes_t now, bool force)
{
	if (force || _last_automation_snapshot > now || (now - _last_automation_snapshot) > _automation_interval) {

		for (Controls::iterator i = _controls.begin(); i != _controls.end(); ++i) {
			if (i->second->list()->automation_write()) {
				i->second->list()->rt_add (now, i->second->user_value());
			}
		}
		
		_last_automation_snapshot = now;
	}
}

void
Automatable::transport_stopped (nframes_t now)
{
	for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li) {
		
		boost::shared_ptr<AutomationControl> c = li->second;
		
		c->list()->reposition_for_rt_add (now);

		if (c->list()->automation_state() != Off) {
			c->set_value(c->list()->eval(now));
		}
	}
}

/* FIXME: this probably doesn't belong here */
boost::shared_ptr<AutomationControl>
Automatable::control_factory(boost::shared_ptr<AutomationList> list)
{
	if (
			list->parameter().type() == MidiCCAutomation ||
			list->parameter().type() == MidiPgmChangeAutomation ||
			list->parameter().type() == MidiChannelAftertouchAutomation 
	   ) {
		// FIXME: this will die horribly if this is not a MidiTrack
		return boost::shared_ptr<AutomationControl>(new MidiTrack::MidiControl((MidiTrack*)this, list));
	} else {
		return boost::shared_ptr<AutomationControl>(new AutomationControl(_session, list));
	}
}