Clarify stop-at-session-end behaviour; should fix #4033.
[ardour.git] / libs / ardour / midi_track.cc
index cdd4633448e7590138d83354a153b61319c88920..ff9810629fc1b591ccfb6787cf9f659f6d9f2afa 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 2006 Paul Davis
-       By Dave Robillard, 2006
+    Author: David Robillard
 
     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
@@ -16,6 +16,7 @@
     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/enumwriter.h"
@@ -55,8 +56,8 @@ MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mo
        , _step_edit_ring_buffer(64) // FIXME: size?
        , _note_mode(Sustained)
        , _step_editing (false)
-       , _default_channel (0)
        , _midi_thru (true)
+       , _input_active (true)
 {
 }
 
@@ -64,6 +65,18 @@ MidiTrack::~MidiTrack ()
 {
 }
 
+int
+MidiTrack::init ()
+{
+       if (Track::init ()) {
+               return -1;
+       }
+
+       _input->changed.connect_same_thread (*this, boost::bind (&MidiTrack::track_input_active, this, _1, _2));
+
+       return 0;
+}
+
 void
 MidiTrack::use_new_diskstream ()
 {
@@ -87,18 +100,18 @@ MidiTrack::use_new_diskstream ()
 void
 MidiTrack::set_record_enabled (bool yn, void *src)
 {
-        if (_step_editing) {
-                return;
-        }
+       if (_step_editing) {
+               return;
+       }
 
-        Track::set_record_enabled (yn, src);
+       Track::set_record_enabled (yn, src);
 }
 
 void
 MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
 {
        Track::set_diskstream (ds);
-       
+
        _diskstream->set_track (this);
        _diskstream->set_destructive (_mode == Destructive);
 
@@ -107,7 +120,9 @@ MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
 
        _diskstream_data_recorded_connection.disconnect ();
        boost::shared_ptr<MidiDiskstream> mds = boost::dynamic_pointer_cast<MidiDiskstream> (ds);
-       mds->DataRecorded.connect_same_thread (_diskstream_data_recorded_connection, boost::bind (&MidiTrack::diskstream_data_recorded, this, _1, _2));
+       mds->DataRecorded.connect_same_thread (
+               _diskstream_data_recorded_connection,
+               boost::bind (&MidiTrack::diskstream_data_recorded, this, _1));
 
        DiskstreamChanged (); /* EMIT SIGNAL */
 }
@@ -120,17 +135,10 @@ MidiTrack::midi_diskstream() const
 
 int
 MidiTrack::set_state (const XMLNode& node, int version)
-{
-       return _set_state (node, version, true);
-}
-
-int
-MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
 {
        const XMLProperty *prop;
-       XMLNodeConstIterator iter;
 
-       if (Route::_set_state (node, version, call_base)) {
+       if (Track::set_state (node, version)) {
                return -1;
        }
 
@@ -144,45 +152,18 @@ MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
        }
 
        if ((prop = node.property ("midi-thru")) != 0) {
-               set_midi_thru (prop->value() == "yes");
+               set_midi_thru (string_is_affirmative (prop->value()));
        }
 
-       if ((prop = node.property ("default-channel")) != 0) {
-               set_default_channel ((uint8_t) atoi (prop->value()));
-       }
-
-       XMLNodeList nlist;
-       XMLNodeConstIterator niter;
-       XMLNode *child;
-
-       nlist = node.children();
-
-       if (version >= 3000) {
-               if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
-                       boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *child));
-                       ds->do_refill_with_alloc ();
-                       set_diskstream (ds);
-               }
-       }
-
-        /* set rec-enable control *AFTER* setting up diskstream, because it may want to operate
-           on the diskstream as it sets its own state
-        */
-
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter){
-               child = *niter;
-
-                if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
-                        if (prop->value() == X_("recenable")) {
-                                _rec_enable_control->set_state (*child, version);
-                        }
-                }
+       if ((prop = node.property ("input-active")) != 0) {
+               set_input_active (string_is_affirmative (prop->value()));
        }
 
        pending_state = const_cast<XMLNode*> (&node);
 
        if (_session.state_of_the_state() & Session::Loading) {
-               _session.StateReady.connect_same_thread (*this, boost::bind (&MidiTrack::set_state_part_two, this));
+               _session.StateReady.connect_same_thread (
+                       *this, boost::bind (&MidiTrack::set_state_part_two, this));
        } else {
                set_state_part_two ();
        }
@@ -193,7 +174,7 @@ MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
 XMLNode&
 MidiTrack::state(bool full_state)
 {
-       XMLNode& root (Route::state(full_state));
+       XMLNode& root (Track::state(full_state));
        XMLNode* freeze_node;
        char buf[64];
 
@@ -217,14 +198,11 @@ MidiTrack::state(bool full_state)
        }
 
        root.add_property (X_("note-mode"), enum_2_string (_note_mode));
-       root.add_child_nocopy (_rec_enable_control->get_state());
-       root.add_child_nocopy (_diskstream->get_state ());
 
        root.add_property ("step-editing", (_step_editing ? "yes" : "no"));
        root.add_property ("note-mode", enum_2_string (_note_mode));
        root.add_property ("midi-thru", (_midi_thru ? "yes" : "no"));
-       snprintf (buf, sizeof (buf), "%d", (int) _default_channel);
-       root.add_property ("default-channel", buf);
+       root.add_property ("input-active", (_input_active ? "yes" : "no"));
 
        return root;
 }
@@ -287,26 +265,21 @@ MidiTrack::set_state_part_two ()
                }
        }
 
-       if ((fnode = find_named_node (*pending_state, X_("Diskstream"))) != 0) {
-               boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *fnode));
-               ds->do_refill_with_alloc ();
-               ds->set_block_size (_session.get_block_size ());
-               set_diskstream (ds);
+       if (midi_diskstream ()) {
+               midi_diskstream()->set_block_size (_session.get_block_size ());
        }
 
        return;
 }
 
 int
-MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
-                bool can_record, bool rec_monitors_input, bool& needs_butler)
+MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
 {
        Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
        if (!lm.locked()) {
                return 0;
        }
 
-       int dret;
        boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
 
        automation_snapshot (start_frame);
@@ -322,17 +295,23 @@ MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame
 
        framepos_t transport_frame = _session.transport_frame();
 
+       int dret;
+       framecnt_t playback_distance;
+
        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, can_record, rec_monitors_input, needs_butler);
+               dret = diskstream->process (transport_frame, 0, playback_distance);
+               need_butler = diskstream->commit (playback_distance);
+               return dret;
        }
 
        _silent = false;
 
-       if ((dret = diskstream->process (transport_frame, nframes, can_record, rec_monitors_input, needs_butler)) != 0) {
+       if ((dret = diskstream->process (transport_frame, nframes, playback_distance)) != 0) {
+               need_butler = diskstream->commit (playback_distance);
                silence (nframes);
                return dret;
        }
@@ -343,7 +322,7 @@ MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame
                _input->process_input (_meter, start_frame, end_frame, nframes);
        }
 
-       if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
+       if (monitoring_state() == MonitoringInput) {
 
                /* not actually recording, but we want to hear the input material anyway,
                   at least potentially (depending on monitoring options)
@@ -373,7 +352,7 @@ MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame
                c.set_midi (1);
                bufs.set_count (c);
 
-               diskstream->get_playback (mbuf, start_frame, end_frame);
+               diskstream->get_playback (mbuf, nframes);
 
                /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
 
@@ -381,21 +360,28 @@ MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame
 
                /* final argument: don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
 
-               process_output_buffers (bufs, start_frame, end_frame, nframes,
-                                       (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick,
-                                        (!diskstream->record_enabled() && !_session.transport_stopped()));
+               process_output_buffers (
+                       bufs, start_frame, end_frame, nframes,
+                       declick, (!diskstream->record_enabled() && !_session.transport_stopped())
+                       );
        }
 
-       _main_outs->flush_buffers (nframes, end_frame - start_frame - 1);
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
+               if (d) {
+                       d->flush_buffers (nframes, end_frame - start_frame - 1);
+               }
+       }
 
+       need_butler = diskstream->commit (playback_distance);
+       
        return 0;
 }
 
 int
-MidiTrack::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                   bool state_changing, bool can_record, bool rec_monitors_input)
+MidiTrack::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool state_changing)
 {
-       int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing, can_record, rec_monitors_input);
+       int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing);
 
        if (ret == 0 && _step_editing) {
                push_midi_input_to_step_edit_ringbuffer (nframes);
@@ -404,6 +390,19 @@ MidiTrack::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_fr
        return ret;
 }
 
+void
+MidiTrack::realtime_locate ()
+{
+       Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
+       if (!lm.locked ()) {
+               return;
+       }
+
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               (*i)->realtime_locate ();
+       }
+}
+
 void
 MidiTrack::realtime_handle_transport_stopped ()
 {
@@ -432,14 +431,14 @@ MidiTrack::push_midi_input_to_step_edit_ringbuffer (framecnt_t nframes)
 
                        const Evoral::MIDIEvent<framepos_t> ev(*e, false);
 
-                        /* note on, since for step edit, note length is determined
-                           elsewhere 
-                        */
-                        
-                        if (ev.is_note_on()) {
-                                /* we don't care about the time for this purpose */
-                                _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
-                        }
+                       /* note on, since for step edit, note length is determined
+                          elsewhere
+                       */
+
+                       if (ev.is_note_on()) {
+                               /* we don't care about the time for this purpose */
+                               _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
+                       }
                }
        }
 }
@@ -447,14 +446,27 @@ MidiTrack::push_midi_input_to_step_edit_ringbuffer (framecnt_t nframes)
 void
 MidiTrack::write_out_of_band_data (BufferSet& bufs, framepos_t /*start*/, framepos_t /*end*/, framecnt_t nframes)
 {
-       // Append immediate events
        MidiBuffer& buf (bufs.get_midi (0));
-        if (_immediate_events.read_space()) {
-                DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 has %2 of immediate events to deliver\n", 
-                                                            name(), _immediate_events.read_space()));
-        }
-       _immediate_events.read (buf, 0, 1, nframes-1); // all stamps = 0
-        
+
+       // Append immediate events
+
+       if (_immediate_events.read_space()) {
+
+               DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 has %2 of immediate events to deliver\n",
+                                                           name(), _immediate_events.read_space()));
+
+               /* write as many of the immediate events as we can, but give "true" as
+                * the last argument ("stop on overflow in destination") so that we'll
+                * ship the rest out next time.
+                *
+                * the (nframes-1) argument puts all these events at the last
+                * possible position of the output buffer, so that we do not
+                * violate monotonicity when writing.
+                */
+
+               _immediate_events.read (buf, 0, 1, nframes-1, true);
+       }
+
        // MIDI thru: send incoming data "through" output
        if (_midi_thru && _session.transport_speed() != 0.0f && _input->n_ports().n_midi()) {
                buf.merge_in_place (_input->midi(0)->get_midi_buffer(nframes));
@@ -467,19 +479,10 @@ MidiTrack::export_stuff (BufferSet& /*bufs*/, framecnt_t /*nframes*/, framepos_t
        return -1;
 }
 
-void
-MidiTrack::set_latency_delay (framecnt_t longest_session_latency)
-{
-       Route::set_latency_delay (longest_session_latency);
-       _diskstream->set_roll_delay (_roll_delay);
-}
-
 boost::shared_ptr<Region>
 MidiTrack::bounce (InterThreadInfo& /*itt*/)
 {
-       throw;
-       // vector<MidiSource*> srcs;
-       // return _session.write_one_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
+       std::cerr << "MIDI bounce currently unsupported" << std::endl;
        return boost::shared_ptr<Region> ();
 }
 
@@ -487,15 +490,14 @@ MidiTrack::bounce (InterThreadInfo& /*itt*/)
 boost::shared_ptr<Region>
 MidiTrack::bounce_range (framepos_t /*start*/, framepos_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
 {
-       throw;
-       //vector<MidiSource*> srcs;
-       //return _session.write_one_track (*this, start, end, false, srcs, itt);
+       std::cerr << "MIDI bounce range currently unsupported" << std::endl;
        return boost::shared_ptr<Region> ();
 }
 
 void
 MidiTrack::freeze_me (InterThreadInfo& /*itt*/)
 {
+       std::cerr << "MIDI freeze currently unsupported" << std::endl;
 }
 
 void
@@ -515,7 +517,7 @@ MidiTrack::set_note_mode (NoteMode m)
 void
 MidiTrack::midi_panic()
 {
-        DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers panic data\n", name()));
+       DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers panic data\n", name()));
        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);
@@ -600,20 +602,14 @@ MidiTrack::MidiControl::set_value(double val)
 void
 MidiTrack::set_step_editing (bool yn)
 {
-        if (_session.record_status() != Session::Disabled) {
-                return;
-        }
-
-        if (yn != _step_editing) {
-                _step_editing = yn;
-                StepEditStatusChange (yn);
-        }
-}
+       if (_session.record_status() != Session::Disabled) {
+               return;
+       }
 
-void
-MidiTrack::set_default_channel (uint8_t chn)
-{
-       _default_channel = std::min ((unsigned int) chn, 15U);
+       if (yn != _step_editing) {
+               _step_editing = yn;
+               StepEditStatusChange (yn);
+       }
 }
 
 void
@@ -653,8 +649,72 @@ MidiTrack::midi_playlist ()
 }
 
 void
-MidiTrack::diskstream_data_recorded (boost::shared_ptr<MidiBuffer> buf, boost::weak_ptr<MidiSource> src)
+MidiTrack::diskstream_data_recorded (boost::weak_ptr<MidiSource> src)
+{
+       DataRecorded (src); /* EMIT SIGNAL */
+}
+
+bool
+MidiTrack::should_monitor () const
+{
+       return true;
+}
+
+bool
+MidiTrack::send_silence () const
+{
+       return false;
+}
+
+bool
+MidiTrack::input_active () const
+{
+       return _input_active;
+}
+
+void
+MidiTrack::set_input_active (bool yn)
+{
+       if (yn != _input_active) {
+               _input_active = yn;
+               map_input_active (yn);
+               InputActiveChanged (); /* EMIT SIGNAL */
+       }
+}
+
+void
+MidiTrack::map_input_active (bool yn)
+{
+       if (!_input) {
+               return;
+       }
+
+       PortSet& ports (_input->ports());
+
+       for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
+               boost::shared_ptr<MidiPort> mp = boost::dynamic_pointer_cast<MidiPort> (*p);
+               if (yn != mp->input_active()) {
+                       mp->set_input_active (yn);
+               }
+       }
+}
+
+void
+MidiTrack::track_input_active (IOChange change, void* /* src */)
+{
+       if (change.type & IOChange::ConfigurationChanged) {
+               map_input_active (_input_active);
+       }
+}
+
+boost::shared_ptr<Diskstream>
+MidiTrack::diskstream_factory (XMLNode const & node)
+{
+       return boost::shared_ptr<Diskstream> (new MidiDiskstream (_session, node));
+}
+
+boost::shared_ptr<MidiBuffer>
+MidiTrack::get_gui_feed_buffer () const
 {
-       DataRecorded (buf, src); /* EMIT SIGNAL */
+       return midi_diskstream()->get_gui_feed_buffer ();
 }
-