First stage of options rework.
[ardour.git] / libs / ardour / midi_track.cc
index 7f3287a994ba6b57f3133972c52919dcc546f8eb..6feb3253ce7cd5ae99b56cd89fa73b451a6442cd 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
-#include <pbd/error.h>
+#include "pbd/error.h"
 #include <sigc++/retype.h>
 #include <sigc++/retype_return.h>
 #include <sigc++/bind.h>
 
-#include <pbd/enumwriter.h>
-
-#include <ardour/midi_track.h>
-#include <ardour/midi_diskstream.h>
-#include <ardour/session.h>
-#include <ardour/redirect.h>
-#include <ardour/midi_region.h>
-#include <ardour/midi_source.h>
-#include <ardour/route_group_specialized.h>
-#include <ardour/insert.h>
-#include <ardour/midi_playlist.h>
-#include <ardour/panner.h>
-#include <ardour/utils.h>
-#include <ardour/buffer_set.h>
-#include <ardour/meter.h>
+#include "pbd/enumwriter.h"
+#include "midi++/events.h"
+#include "evoral/midi_util.h"
+
+#include "ardour/amp.h"
+#include "ardour/buffer_set.h"
+#include "ardour/io_processor.h"
+#include "ardour/meter.h"
+#include "ardour/midi_diskstream.h"
+#include "ardour/midi_playlist.h"
+#include "ardour/midi_region.h"
+#include "ardour/midi_source.h"
+#include "ardour/midi_track.h"
+#include "ardour/panner.h"
+#include "ardour/processor.h"
+#include "ardour/route_group_specialized.h"
+#include "ardour/session.h"
+#include "ardour/utils.h"
 
 #include "i18n.h"
 
@@ -45,22 +48,11 @@ using namespace PBD;
 
 MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
        : Track (sess, name, flag, mode, DataType::MIDI)
+       , _immediate_events(1024) // FIXME: size?
+       , _note_mode(Sustained)
 {
-       MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
-
-       if (_flags & Hidden) {
-               dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
-       } else {
-               dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
-       }
-
-       assert(mode != Destructive);
-
-       boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name, dflags));
-       _session.add_diskstream (ds);
+       use_new_diskstream ();
 
-       set_diskstream (boost::dynamic_pointer_cast<MidiDiskstream> (ds));
-       
        _declickable = true;
        _freeze_record.state = NoFreeze;
        _saved_meter_point = _meter_point;
@@ -68,25 +60,41 @@ MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mo
 
        set_input_minimum(ChanCount(DataType::MIDI, 1));
        set_input_maximum(ChanCount(DataType::MIDI, 1));
-       set_output_minimum(ChanCount(DataType::MIDI, 1));
-       set_output_maximum(ChanCount(DataType::MIDI, 1));
 }
 
 MidiTrack::MidiTrack (Session& sess, const XMLNode& node)
-       : Track (sess, node)
+       : Track (sess, node, DataType::MIDI )
+       , _immediate_events(1024) // FIXME: size?
+       , _note_mode(Sustained)
 {
        _set_state(node, false);
        
        set_input_minimum(ChanCount(DataType::MIDI, 1));
        set_input_maximum(ChanCount(DataType::MIDI, 1));
-       set_output_minimum(ChanCount(DataType::MIDI, 1));
-       set_output_maximum(ChanCount(DataType::MIDI, 1));
 }
 
 MidiTrack::~MidiTrack ()
 {
 }
 
+void
+MidiTrack::use_new_diskstream ()
+{
+       MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
+
+       if (_flags & Hidden) {
+               dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
+       } else {
+               dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
+       }
+
+       assert(_mode != Destructive);
+
+       boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name(), dflags));
+       _session.add_diskstream (ds);
+
+       set_diskstream (boost::dynamic_pointer_cast<MidiDiskstream> (ds));
+}      
 
 int
 MidiTrack::set_diskstream (boost::shared_ptr<MidiDiskstream> ds)
@@ -154,10 +162,13 @@ MidiTrack::_set_state (const XMLNode& node, bool call_base)
                return -1;
        }
        
-       if ((prop = node.property (X_("mode"))) != 0) {
-               _mode = TrackMode (string_2_enum (prop->value(), _mode));
+       // No destructive MIDI tracks (yet?)
+       _mode = Normal;
+       
+       if ((prop = node.property (X_("note-mode"))) != 0) {
+               _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
        } else {
-               _mode = Normal;
+               _note_mode = Sustained;
        }
 
        if ((prop = node.property ("diskstream-id")) == 0) {
@@ -177,13 +188,23 @@ MidiTrack::_set_state (const XMLNode& node, bool call_base)
        } else {
                
                PBD::ID id (prop->value());
+               PBD::ID zero ("0");
                
-               if (use_diskstream (id)) {
+               /* this wierd hack is used when creating tracks from a template. there isn't
+                  a particularly good time to interpose between setting the first part of
+                  the track state (notably Route::set_state() and the track mode), and the
+                  second part (diskstream stuff). So, we have a special ID for the diskstream
+                  that means "you should create a new diskstream here, not look for
+                  an old one.
+               */
+               
+               if (id == zero) {
+                       use_new_diskstream ();
+               } else if (use_diskstream (id)) {
                        return -1;
                }
        }
 
-
        XMLNodeList nlist;
        XMLNodeConstIterator niter;
        XMLNode *child;
@@ -193,14 +214,18 @@ MidiTrack::_set_state (const XMLNode& node, bool call_base)
                child = *niter;
 
                if (child->name() == X_("recenable")) {
-                       _rec_enable_control.set_state (*child);
-                       _session.add_controllable (&_rec_enable_control);
+                       _rec_enable_control->set_state (*child);
+                       _session.add_controllable (_rec_enable_control);
                }
        }
 
        pending_state = const_cast<XMLNode*> (&node);
 
-       _session.StateReady.connect (mem_fun (*this, &MidiTrack::set_state_part_two));
+       if (_session.state_of_the_state() & Session::Loading) {
+               _session.StateReady.connect (mem_fun (*this, &MidiTrack::set_state_part_two));
+       } else {
+               set_state_part_two ();
+       }
 
        return 0;
 }
@@ -219,8 +244,8 @@ MidiTrack::state(bool full_state)
                freeze_node->add_property ("playlist", _freeze_record.playlist->name());
                freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
 
-               for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
-                       inode = new XMLNode (X_("insert"));
+               for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
+                       inode = new XMLNode (X_("processor"));
                        (*i)->id.print (buf, sizeof(buf));
                        inode->add_property (X_("id"), buf);
                        inode->add_child_copy ((*i)->state);
@@ -233,12 +258,12 @@ MidiTrack::state(bool full_state)
 
        /* Alignment: act as a proxy for the diskstream */
        
-       XMLNode* align_node = new XMLNode (X_("alignment"));
+       XMLNode* align_node = new XMLNode (X_("Alignment"));
        AlignStyle as = _diskstream->alignment_style ();
        align_node->add_property (X_("style"), enum_2_string (as));
        root.add_child_nocopy (*align_node);
 
-       root.add_property (X_("mode"), enum_2_string (_mode));
+       root.add_property (X_("note-mode"), enum_2_string (_note_mode));
        
        /* we don't return diskstream state because we don't
           own the diskstream exclusively. control of the diskstream
@@ -249,7 +274,7 @@ MidiTrack::state(bool full_state)
        _diskstream->id().print (buf, sizeof(buf));
        root.add_property ("diskstream-id", buf);
        
-       root.add_child_nocopy (_rec_enable_control.get_state());
+       root.add_child_nocopy (_rec_enable_control->get_state());
 
        return root;
 }
@@ -271,14 +296,12 @@ MidiTrack::set_state_part_two ()
 
        if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
 
-               
-               _freeze_record.have_mementos = false;
                _freeze_record.state = Frozen;
                
-               for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
+               for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
                        delete *i;
                }
-               _freeze_record.insert_info.clear ();
+               _freeze_record.processor_info.clear ();
                
                if ((prop = fnode->property (X_("playlist"))) != 0) {
                        boost::shared_ptr<Playlist> pl = _session.playlist_by_name (prop->value());
@@ -299,7 +322,7 @@ MidiTrack::set_state_part_two ()
                XMLNodeList clist = fnode->children();
                
                for (citer = clist.begin(); citer != clist.end(); ++citer) {
-                       if ((*citer)->name() != X_("insert")) {
+                       if ((*citer)->name() != X_("processor")) {
                                continue;
                        }
                        
@@ -307,16 +330,16 @@ MidiTrack::set_state_part_two ()
                                continue;
                        }
                        
-                       FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo (*((*citer)->children().front()),
-                                                                                  boost::shared_ptr<Insert>());
+                       FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
+                                                                                  boost::shared_ptr<Processor>());
                        frii->id = prop->value ();
-                       _freeze_record.insert_info.push_back (frii);
+                       _freeze_record.processor_info.push_back (frii);
                }
        }
 
        /* Alignment: act as a proxy for the diskstream */
 
-       if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
+       if ((fnode = find_named_node (*pending_state, X_("Alignment"))) != 0) {
 
                if ((prop = fnode->property (X_("style"))) != 0) {
 
@@ -339,135 +362,65 @@ MidiTrack::set_state_part_two ()
        return;
 }      
 
-int 
-MidiTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, 
-                    bool session_state_changing, bool can_record, bool rec_monitors_input)
-{
-       if (n_outputs().n_midi() == 0) {
-               //return 0;
-               throw; // FIXME
-       }
-
-       if (!_active) {
-               silence (nframes, offset);
-               //return 0; // FIXME
-       }
-
-       if (session_state_changing) {
-
-               /* XXX is this safe to do against transport state changes? */
-
-               passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
-               return 0;
-       }
-
-       midi_diskstream()->check_record_status (start_frame, nframes, can_record);
-
-       bool send_silence;
-       
-       if (_have_internal_generator) {
-               /* since the instrument has no input streams,
-                  there is no reason to send any signal
-                  into the route.
-               */
-               send_silence = true;
-       } else {
-
-               if (Config->get_auto_input()) {
-                       if (Config->get_monitoring_model() == SoftwareMonitoring) {
-                               send_silence = false;
-                       } else {
-                               send_silence = true;
-                       }
-               } else {
-                       if (_diskstream->record_enabled()) {
-                               if (Config->get_monitoring_model() == SoftwareMonitoring) {
-                                       send_silence = false;
-                               } else {
-                                       send_silence = true;
-                               }
-                       } else {
-                               send_silence = true;
-                       }
-               }
-       }
-
-       apply_gain_automation = false;
-
-       if (send_silence) {
-               
-               /* if we're sending silence, but we want the meters to show levels for the signal,
-                  meter right here.
-               */
-               
-               if (_have_internal_generator) {
-                       passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
-               } else {
-                       if (_meter_point == MeterInput) {
-                               just_meter_input (start_frame, end_frame, nframes, offset);
-                       }
-                       passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
-               }
-
-       } else {
-       
-               /* we're sending signal, but we may still want to meter the input. 
-                */
-
-               passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
-       }
-
-       return 0;
-}
-
 int
-MidiTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
-                 bool can_record, bool rec_monitors_input)
+MidiTrack::roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame, int declick,
+                bool can_record, bool rec_monitors_input)
 {
        int dret;
        boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
+       
+       prepare_inputs (nframes);
+
+       {
+               Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
+               if (lm.locked()) {
+                       // automation snapshot can also be called from the non-rt context
+                       // and it uses the redirect list, so we take the lock out here
+                       automation_snapshot (start_frame);
+               }
+       }
 
-       if (n_outputs().n_total() == 0 && _redirects.empty()) {
+       if (n_outputs().n_total() == 0 && _processors.empty()) {
                return 0;
        }
 
        if (!_active) {
-               silence (nframes, offset);
+               silence (nframes);
                return 0;
        }
 
        nframes_t transport_frame = _session.transport_frame();
 
-       if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
+       
+       if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
                /* need to do this so that the diskstream sets its
                   playback distance to zero, thus causing diskstream::commit
                   to do nothing.
                   */
-               return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
+               return diskstream->process (transport_frame, 0, can_record, rec_monitors_input);
        } 
 
        _silent = false;
 
-       if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
-
-               silence (nframes, offset);
+       if ((dret = diskstream->process (transport_frame, nframes, can_record, rec_monitors_input)) != 0) {
 
+               silence (nframes);
                return dret;
        }
 
        /* special condition applies */
 
        if (_meter_point == MeterInput) {
-               just_meter_input (start_frame, end_frame, nframes, offset);
+               just_meter_input (start_frame, end_frame, nframes);
        }
 
-       if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
+       if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
 
                /* not actually recording, but we want to hear the input material anyway,
                   at least potentially (depending on monitoring options)
                   */
 
-               passthru (start_frame, end_frame, nframes, offset, 0, true);
+               passthru (start_frame, end_frame, nframes, 0);
 
        } else {
                /*
@@ -486,95 +439,28 @@ MidiTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
 
                diskstream->get_playback(bufs.get_midi(0), start_frame, end_frame);
 
-               process_output_buffers (bufs, start_frame, end_frame, nframes, offset,
-                               (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
+               process_output_buffers (bufs, start_frame, end_frame, nframes,
+                               (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick);
        
        }
 
-       return 0;
-}
-
-int
-MidiTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, 
-                        bool can_record, bool rec_monitors_input)
-{
-       if (n_outputs().n_midi() == 0 && _redirects.empty()) {
-               return 0;
-       }
-
-       if (!_active) {
-               silence (nframes, offset);
-               return 0;
-       }
-
-       _silent = true;
-       apply_gain_automation = false;
-
-       silence (nframes, offset);
+       flush_outputs (nframes);
 
-       return midi_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
+       return 0;
 }
 
 void
-MidiTrack::process_output_buffers (BufferSet& bufs,
-                              nframes_t start_frame, nframes_t end_frame, 
-                              nframes_t nframes, nframes_t offset, bool with_redirects, int declick,
-                              bool meter)
-{
-       /* There's no such thing as a MIDI bus for the time being, to avoid diverging from trunk
-        * too much until the SoC settles down.  We'll do all the MIDI route work here for now,
-        * but the long-term goal is to have Route::process_output_buffers handle everything */
-       
-       if (meter && (_meter_point == MeterInput || _meter_point == MeterPreFader)) {
-               _meter->run(bufs, nframes);
-       }
-
-       // Run all redirects
-       if (with_redirects) {
-               Glib::RWLock::ReaderLock rm (redirect_lock, Glib::TRY_LOCK);
-               if (rm.locked()) {
-                       for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
-                               (*i)->run (bufs, start_frame, end_frame, nframes, offset);
-                       }
-               } 
-       }
-       
-       if (meter && (_meter_point == MeterPostFader)) {
-               _meter->run(bufs, nframes);
-       }
-       
-       // Main output stage
-       if (muted()) {
-               IO::silence(nframes, offset);
-       } else {
-               deliver_output(bufs, start_frame, end_frame, nframes, offset);
-       }
-}
-
-int
-MidiTrack::set_name (string str, void *src)
+MidiTrack::write_controller_messages(MidiBuffer& output_buf, sframes_t start, sframes_t end, nframes_t nframes)
 {
-       int ret;
-
-       if (record_enabled() && _session.actively_recording()) {
-               /* this messes things up if done while recording */
-               return -1;
-       }
+       // Append immediate events (UI controls)
 
-       if (_diskstream->set_name (str)) {
-               return -1;
-       }
-
-       /* save state so that the statefile fully reflects any filename changes */
+       // XXX TAKE _port_offset in Port into account???
 
-       if ((ret = IO::set_name (str, src)) == 0) {
-               _session.save_state ("");
-       }
-       return ret;
+       _immediate_events.read (output_buf, 0, 0, nframes - 1); // all stamps = 0
 }
 
 int
-MidiTrack::export_stuff (BufferSet& bufs, nframes_t nframes, nframes_t end_frame)
+MidiTrack::export_stuff (BufferSet& bufs, nframes_t nframes, sframes_t end_frame)
 {
        return -1;
 }
@@ -586,21 +472,23 @@ MidiTrack::set_latency_delay (nframes_t longest_session_latency)
        _diskstream->set_roll_delay (_roll_delay);
 }
 
-void
+boost::shared_ptr<Region>
 MidiTrack::bounce (InterThreadInfo& itt)
 {
        throw;
-       //vector<MidiSource*> srcs;
-       //_session.write_one_midi_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
+       // vector<MidiSource*> srcs;
+       // return _session.write_one_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
+       return boost::shared_ptr<Region> ();
 }
 
 
-void
-MidiTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
+boost::shared_ptr<Region>
+MidiTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt, bool enable_processing)
 {
        throw;
        //vector<MidiSource*> srcs;
-       //_session.write_one_midi_track (*this, start, end, false, srcs, itt);
+       //return _session.write_one_track (*this, start, end, false, srcs, itt);
+       return boost::shared_ptr<Region> ();
 }
 
 void
@@ -615,21 +503,95 @@ MidiTrack::unfreeze ()
        FreezeChange (); /* EMIT SIGNAL */
 }
 
-int
-MidiTrack::set_mode (TrackMode m)
+void
+MidiTrack::set_note_mode (NoteMode m)
 {
-       assert(_diskstream);
+       _note_mode = m;
+       midi_diskstream()->set_note_mode(m);
+}
 
-       if (m != _mode) {
+void
+MidiTrack::midi_panic() 
+{
+       for (uint8_t channel = 0; channel <= 0xF; channel++) {
+               uint8_t ev[3] = { MIDI_CMD_CONTROL | channel, MIDI_CTL_SUSTAIN, 0 };
+               write_immediate_event(3, ev);
+               ev[1] = MIDI_CTL_ALL_NOTES_OFF;
+               write_immediate_event(3, ev);
+               ev[1] = MIDI_CTL_RESET_CONTROLLERS;
+               write_immediate_event(3, ev);
+       }
+}
 
-               if (_diskstream->set_destructive (m == Destructive)) {
-                       return -1;
-               }
+/** \return true on success, false on failure (no buffer space left)
+ */
+bool
+MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
+{
+       if (!Evoral::midi_event_is_valid(buf, size)) {
+               cerr << "WARNING: Ignoring illegal immediate MIDI event" << endl;
+               return false;
+       }
+       const uint32_t type = EventTypeMap::instance().midi_event_type(buf[0]);
+       return (_immediate_events.write(0, type, size, buf) == size);
+}
 
-               _mode = m;
-               
-               TrackModeChanged (); /* EMIT SIGNAL */
+void
+MidiTrack::MidiControl::set_value(float val)
+{
+       bool valid = false;
+       if (isinf(val)) {
+               cerr << "MIDIControl value is infinity" << endl;
+       } else if (isnan(val)) {
+               cerr << "MIDIControl value is NaN" << endl;
+       } else if (val < _list->parameter().min()) {
+               cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
+       } else if (val > _list->parameter().max()) {
+               cerr << "MIDIControl value is > " << _list->parameter().max() << endl;
+       } else {
+               valid = true;
+       }
+       
+       if (!valid) {
+               return;
        }
 
-       return 0;
-}
+       assert(val <= _list->parameter().max());
+       size_t size = 3;
+
+       if ( ! automation_playback()) {
+               uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
+               switch(_list->parameter().type()) {
+               case MidiCCAutomation:
+                       ev[0] += MIDI_CMD_CONTROL;
+                       ev[1] = _list->parameter().id();
+                       ev[2] = int(val);
+                       break;
+                       
+               case MidiPgmChangeAutomation:
+                       size = 2;
+                       ev[0] += MIDI_CMD_PGM_CHANGE;
+                       ev[1] = int(val);
+                       break;
+                       
+               case MidiChannelPressureAutomation:
+                       size = 2;
+                       ev[0] += MIDI_CMD_CHANNEL_PRESSURE;
+                       ev[1] = int(val);
+                       break;
+                       
+               case MidiPitchBenderAutomation:
+                       ev[0] += MIDI_CMD_BENDER;
+                       ev[1] = 0x7F & int(val);
+                       ev[2] = 0x7F & (int(val) >> 7);
+                       break;
+                       
+               default:
+                       assert(false);
+               }
+               _route->write_immediate_event(size,  ev);
+       }
+
+       AutomationControl::set_value(val);
+} 
+