detect buffer "overflow" when delivering immediate events and queue remainder for...
[ardour.git] / libs / ardour / midi_track.cc
index d25a70d819d03822005eb8e0bb7afea684c1baf3..07b6d2ac6d127cb2c178bbc36700d526b3b05db6 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,7 +56,6 @@ 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)
 {
 }
@@ -84,6 +84,16 @@ MidiTrack::use_new_diskstream ()
        set_diskstream (ds);
 }
 
+void
+MidiTrack::set_record_enabled (bool yn, void *src)
+{
+       if (_step_editing) {
+               return;
+       }
+
+       Track::set_record_enabled (yn, src);
+}
+
 void
 MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
 {
@@ -95,6 +105,12 @@ MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
        _diskstream->set_record_enabled (false);
        //_diskstream->monitor_input (false);
 
+       _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));
+
        DiskstreamChanged (); /* EMIT SIGNAL */
 }
 
@@ -133,23 +149,11 @@ MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
                set_midi_thru (prop->value() == "yes");
        }
 
-       if ((prop = node.property ("default-channel")) != 0) {
-               set_default_channel ((uint8_t) atoi (prop->value()));
-       }
-
        XMLNodeList nlist;
        XMLNodeConstIterator niter;
        XMLNode *child;
 
        nlist = node.children();
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter){
-               child = *niter;
-
-               if (child->name() == X_("recenable")) {
-                       _rec_enable_control->set_state (*child, version);
-                       _session.add_controllable (_rec_enable_control);
-               }
-       }
 
        if (version >= 3000) {
                if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
@@ -159,10 +163,25 @@ MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
                }
        }
 
+       /* 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);
+                       }
+               }
+       }
+
        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 ();
        }
@@ -203,8 +222,6 @@ MidiTrack::state(bool full_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);
 
        return root;
 }
@@ -267,18 +284,15 @@ 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 (nframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
+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)
 {
        Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
@@ -300,8 +314,7 @@ MidiTrack::roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame
                return 0;
        }
 
-       nframes_t transport_frame = _session.transport_frame();
-
+       framepos_t transport_frame = _session.transport_frame();
 
        if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
                /* need to do this so that the diskstream sets its
@@ -348,29 +361,37 @@ MidiTrack::roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame
                BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
                MidiBuffer& mbuf (bufs.get_midi (0));
 
+               /* we are a MIDI track, so we always start the chain with a single-channel diskstream */
+               ChanCount c;
+               c.set_audio (0);
+               c.set_midi (1);
+               bufs.set_count (c);
+
                diskstream->get_playback (mbuf, start_frame, end_frame);
 
                /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
 
                write_out_of_band_data (bufs, start_frame, end_frame, nframes);
 
-               process_output_buffers (bufs, start_frame, end_frame, nframes,
-                                       (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick);
+               /* 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()));
        }
 
-       _main_outs->flush (nframes, end_frame - start_frame - 1);
+       _main_outs->flush_buffers (nframes, end_frame - start_frame - 1);
 
        return 0;
 }
 
 int
-MidiTrack::no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
+MidiTrack::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
                    bool state_changing, bool can_record, bool rec_monitors_input)
 {
        int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing, can_record, rec_monitors_input);
 
-       if (ret == 0 && _diskstream->record_enabled() && _step_editing) {
+       if (ret == 0 && _step_editing) {
                push_midi_input_to_step_edit_ringbuffer (nframes);
        }
 
@@ -378,16 +399,20 @@ MidiTrack::no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_fram
 }
 
 void
-MidiTrack::handle_transport_stopped (bool abort, bool did_locate, bool flush_processors)
+MidiTrack::realtime_handle_transport_stopped ()
 {
+       Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
+       if (!lm.locked ()) {
+               return;
+       }
 
-       _main_outs->transport_stopped ();
-       Route::handle_transport_stopped (abort, did_locate, flush_processors);
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               (*i)->realtime_handle_transport_stopped ();
+       }
 }
 
-
 void
-MidiTrack::push_midi_input_to_step_edit_ringbuffer (nframes_t nframes)
+MidiTrack::push_midi_input_to_step_edit_ringbuffer (framecnt_t nframes)
 {
        PortSet& ports (_input->ports());
 
@@ -399,26 +424,44 @@ MidiTrack::push_midi_input_to_step_edit_ringbuffer (nframes_t nframes)
 
                for (MidiBuffer::const_iterator e = mb->begin(); e != mb->end(); ++e) {
 
-                       const Evoral::MIDIEvent<nframes_t> ev(*e, false);
+                       const Evoral::MIDIEvent<framepos_t> ev(*e, false);
 
-                       /* we don't care about the time for this purpose */
+                       /* note on, since for step edit, note length is determined
+                          elsewhere 
+                       */
 
-                       _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
+                       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());
+                       }
                }
        }
 }
 
 void
-MidiTrack::write_out_of_band_data (BufferSet& bufs, sframes_t /*start*/, sframes_t /*end*/, nframes_t nframes)
+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));
@@ -426,18 +469,11 @@ MidiTrack::write_out_of_band_data (BufferSet& bufs, sframes_t /*start*/, sframes
 }
 
 int
-MidiTrack::export_stuff (BufferSet& /*bufs*/, nframes_t /*nframes*/, sframes_t /*end_frame*/)
+MidiTrack::export_stuff (BufferSet& /*bufs*/, framecnt_t /*nframes*/, framepos_t /*end_frame*/)
 {
        return -1;
 }
 
-void
-MidiTrack::set_latency_delay (nframes_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*/)
 {
@@ -449,7 +485,7 @@ MidiTrack::bounce (InterThreadInfo& /*itt*/)
 
 
 boost::shared_ptr<Region>
-MidiTrack::bounce_range (nframes_t /*start*/, nframes_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
+MidiTrack::bounce_range (framepos_t /*start*/, framepos_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
 {
        throw;
        //vector<MidiSource*> srcs;
@@ -479,7 +515,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);
@@ -504,7 +540,7 @@ MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
 }
 
 void
-MidiTrack::MidiControl::set_value(float val)
+MidiTrack::MidiControl::set_value(double val)
 {
        bool valid = false;
        if (isinf(val)) {
@@ -564,13 +600,14 @@ MidiTrack::MidiControl::set_value(float val)
 void
 MidiTrack::set_step_editing (bool yn)
 {
-       _step_editing = 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
@@ -580,7 +617,7 @@ MidiTrack::set_midi_thru (bool yn)
 }
 
 boost::shared_ptr<SMFSource>
-MidiTrack::write_source (uint32_t n)
+MidiTrack::write_source (uint32_t)
 {
        return midi_diskstream()->write_source ();
 }
@@ -608,3 +645,21 @@ MidiTrack::midi_playlist ()
 {
        return midi_diskstream()->midi_playlist ();
 }
+
+void
+MidiTrack::diskstream_data_recorded (boost::shared_ptr<MidiBuffer> buf, boost::weak_ptr<MidiSource> src)
+{
+       DataRecorded (buf, src); /* EMIT SIGNAL */
+}
+                              
+bool
+MidiTrack::should_monitor () const
+{
+       return true;
+}
+
+bool
+MidiTrack::send_silence () const
+{
+       return false;
+}