Inrease the export "chunk size" to speed it up over 10% at least in some situations
[ardour.git] / libs / ardour / midi_track.cc
index bf1cd363dc8c25927aaeef05611259487abe0006..a8a0e218a6bb5ac04452c92c79c5abb34bcd9f73 100644 (file)
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#include "pbd/error.h"
-
 #include "pbd/enumwriter.h"
 #include "pbd/convert.h"
-#include "midi++/events.h"
 #include "evoral/midi_util.h"
 
-#include "ardour/amp.h"
 #include "ardour/buffer_set.h"
 #include "ardour/debug.h"
 #include "ardour/delivery.h"
-#include "ardour/io_processor.h"
 #include "ardour/meter.h"
 #include "ardour/midi_diskstream.h"
 #include "ardour/midi_playlist.h"
 #include "ardour/midi_port.h"
-#include "ardour/midi_region.h"
-#include "ardour/midi_source.h"
 #include "ardour/midi_track.h"
-#include "ardour/panner.h"
 #include "ardour/port.h"
 #include "ardour/processor.h"
-#include "ardour/route_group_specialized.h"
 #include "ardour/session.h"
 #include "ardour/session_playlists.h"
 #include "ardour/utils.h"
 
 #include "i18n.h"
 
+namespace ARDOUR {
+class InterThreadInfo;
+class MidiSource;
+class Region;
+class SMFSource;
+}
+
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
@@ -56,7 +54,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)
-       , _midi_thru (true)
        , _input_active (true)
 {
 }
@@ -77,8 +74,8 @@ MidiTrack::init ()
        return 0;
 }
 
-void
-MidiTrack::use_new_diskstream ()
+boost::shared_ptr<Diskstream>
+MidiTrack::create_diskstream ()
 {
        MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
 
@@ -90,13 +87,10 @@ MidiTrack::use_new_diskstream ()
 
        assert(_mode != Destructive);
 
-       boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name(), dflags));
-       ds->do_refill_with_alloc ();
-       ds->set_block_size (_session.get_block_size ());
-
-       set_diskstream (ds);
+       return boost::shared_ptr<Diskstream> (new MidiDiskstream (_session, name(), dflags));
 }
 
+
 void
 MidiTrack::set_record_enabled (bool yn, void *src)
 {
@@ -110,19 +104,24 @@ MidiTrack::set_record_enabled (bool yn, void *src)
 void
 MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
 {
+       /* We have to do this here, as Track::set_diskstream will cause a buffer refill,
+          and the diskstream must be set up to fill its buffers using the correct _note_mode.
+       */
+       boost::shared_ptr<MidiDiskstream> mds = boost::dynamic_pointer_cast<MidiDiskstream> (ds);
+       mds->set_note_mode (_note_mode);
+       
        Track::set_diskstream (ds);
 
+       mds->reset_tracker ();  
+
        _diskstream->set_track (this);
        _diskstream->set_destructive (_mode == Destructive);
-
        _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));
+               boost::bind (&MidiTrack::diskstream_data_recorded, this, _1));
 
        DiskstreamChanged (); /* EMIT SIGNAL */
 }
@@ -135,65 +134,30 @@ 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)) {
-               return -1;
-       }
-
-       // No destructive MIDI tracks (yet?)
-       _mode = Normal;
 
+       /* This must happen before Track::set_state(), as there will be a buffer
+          fill during that call, and we must fill buffers using the correct
+          _note_mode.
+       */
        if ((prop = node.property (X_("note-mode"))) != 0) {
                _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
        } else {
                _note_mode = Sustained;
        }
 
-       if ((prop = node.property ("midi-thru")) != 0) {
-               set_midi_thru (string_is_affirmative (prop->value()));
+       if (Track::set_state (node, version)) {
+               return -1;
        }
 
+       // No destructive MIDI tracks (yet?)
+       _mode = Normal;
+
        if ((prop = node.property ("input-active")) != 0) {
                set_input_active (string_is_affirmative (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);
-                       }
-               }
-       }
-
        pending_state = const_cast<XMLNode*> (&node);
 
        if (_session.state_of_the_state() & Session::Loading) {
@@ -209,7 +173,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];
 
@@ -233,12 +197,9 @@ 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"));
        root.add_property ("input-active", (_input_active ? "yes" : "no"));
 
        return root;
@@ -309,16 +270,17 @@ MidiTrack::set_state_part_two ()
        return;
 }
 
+/** @param need_butler to be set to true if this track now needs the butler, otherwise it can be left alone
+ *  or set to false.
+ */
 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);
@@ -334,17 +296,24 @@ 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;
        }
@@ -355,15 +324,24 @@ 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)
                */
 
+               /* because the playback buffer is event based and not a
+                * continuous stream, we need to make sure that we empty
+                * it of events every cycle to avoid it filling up with events
+                * read from disk, while we are actually monitoring input
+                */
+
+               diskstream->flush_playback (start_frame, end_frame);
+
                passthru (start_frame, end_frame, nframes, 0);
 
        } else {
+
                /*
                   XXX is it true that the earlier test on n_outputs()
                   means that we can avoid checking it again here? i think
@@ -375,7 +353,6 @@ MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame
 
                /* copy the diskstream data to all output buffers */
 
-               //const size_t limit = n_process_buffers().n_audio();
                BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
                MidiBuffer& mbuf (bufs.get_midi (0));
 
@@ -385,7 +362,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) */
 
@@ -393,21 +370,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);
+               }
+       }
 
+       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)
+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);
+       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);
@@ -420,6 +404,7 @@ void
 MidiTrack::realtime_locate ()
 {
        Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
+
        if (!lm.locked ()) {
                return;
        }
@@ -427,12 +412,15 @@ MidiTrack::realtime_locate ()
        for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
                (*i)->realtime_locate ();
        }
+
+       midi_diskstream()->reset_tracker ();
 }
 
 void
 MidiTrack::realtime_handle_transport_stopped ()
 {
        Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
+
        if (!lm.locked ()) {
                return;
        }
@@ -492,15 +480,11 @@ MidiTrack::write_out_of_band_data (BufferSet& bufs, framepos_t /*start*/, framep
 
                _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));
-       }
 }
 
 int
-MidiTrack::export_stuff (BufferSet& /*bufs*/, framecnt_t /*nframes*/, framepos_t /*end_frame*/)
+MidiTrack::export_stuff (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framecnt_t /*nframes*/, 
+                        boost::shared_ptr<Processor> /*endpoint*/, bool /*include_endpoint*/, bool /*forexport*/)
 {
        return -1;
 }
@@ -508,25 +492,23 @@ MidiTrack::export_stuff (BufferSet& /*bufs*/, framecnt_t /*nframes*/, framepos_t
 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> ();
 }
 
 
 boost::shared_ptr<Region>
-MidiTrack::bounce_range (framepos_t /*start*/, framepos_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
+MidiTrack::bounce_range (framepos_t /*start*/, framepos_t /*end*/, InterThreadInfo& /*itt*/,
+                        boost::shared_ptr<Processor> /*endpoint*/, bool /*include_endpoint*/)
 {
-       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
@@ -548,7 +530,7 @@ MidiTrack::midi_panic()
 {
        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 };
+               uint8_t ev[3] = { ((uint8_t) (MIDI_CMD_CONTROL | channel)), ((uint8_t) MIDI_CTL_SUSTAIN), 0 };
                write_immediate_event(3, ev);
                ev[1] = MIDI_CTL_ALL_NOTES_OFF;
                write_immediate_event(3, ev);
@@ -574,9 +556,9 @@ void
 MidiTrack::MidiControl::set_value(double val)
 {
        bool valid = false;
-       if (isinf(val)) {
+       if (std::isinf(val)) {
                cerr << "MIDIControl value is infinity" << endl;
-       } else if (isnan(val)) {
+       } else if (std::isnan(val)) {
                cerr << "MIDIControl value is NaN" << endl;
        } else if (val < _list->parameter().min()) {
                cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
@@ -593,7 +575,7 @@ MidiTrack::MidiControl::set_value(double val)
        assert(val <= _list->parameter().max());
        if ( ! automation_playback()) {
                size_t size = 3;
-               uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
+               uint8_t ev[3] = { _list->parameter().channel(), uint8_t (val), 0 };
                switch(_list->parameter().type()) {
                case MidiCCAutomation:
                        ev[0] += MIDI_CMD_CONTROL;
@@ -641,12 +623,6 @@ MidiTrack::set_step_editing (bool yn)
        }
 }
 
-void
-MidiTrack::set_midi_thru (bool yn)
-{
-       _midi_thru = yn;
-}
-
 boost::shared_ptr<SMFSource>
 MidiTrack::write_source (uint32_t)
 {
@@ -678,21 +654,9 @@ 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 (buf, src); /* EMIT SIGNAL */
-}
-
-bool
-MidiTrack::should_monitor () const
-{
-       return true;
-}
-
-bool
-MidiTrack::send_silence () const
-{
-       return false;
+       DataRecorded (src); /* EMIT SIGNAL */
 }
 
 bool
@@ -721,7 +685,7 @@ MidiTrack::map_input_active (bool yn)
        PortSet& ports (_input->ports());
 
        for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
-               MidiPort* mp = dynamic_cast<MidiPort*> (&*p);
+               boost::shared_ptr<MidiPort> mp = boost::dynamic_pointer_cast<MidiPort> (*p);
                if (yn != mp->input_active()) {
                        mp->set_input_active (yn);
                }
@@ -736,3 +700,97 @@ MidiTrack::track_input_active (IOChange change, void* /* src */)
        }
 }
 
+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
+{
+       return midi_diskstream()->get_gui_feed_buffer ();
+}
+
+void
+MidiTrack::act_on_mute ()
+{
+       /* this is called right after our mute status has changed.
+          if we are now muted, send suitable output to shutdown
+          all our notes.
+
+          XXX we should should also stop all relevant note trackers.
+       */
+
+       if (muted()) {
+               /* only send messages for channels we are using */
+
+               uint16_t mask = get_channel_mask();
+
+               for (uint8_t channel = 0; channel <= 0xF; channel++) {
+
+                       if ((1<<channel) & mask) {
+
+                               DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers mute message to channel %2\n", name(), channel+1));
+                               uint8_t ev[3] = { ((uint8_t) (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);
+                       }
+               }
+       }
+}
+       
+void
+MidiTrack::set_monitoring (MonitorChoice mc)
+{
+       if (mc != _monitoring) {
+
+               Track::set_monitoring (mc);
+               
+               /* monitoring state changed, so flush out any on notes at the
+                * port level.
+                */
+
+               PortSet& ports (_output->ports());
+               
+               for (PortSet::iterator p = ports.begin(); p != ports.end(); ++p) {
+                       boost::shared_ptr<MidiPort> mp = boost::dynamic_pointer_cast<MidiPort> (*p);
+                       if (mp) {
+                               mp->require_resolve ();
+                       }
+               }
+
+               boost::shared_ptr<MidiDiskstream> md (midi_diskstream());
+               
+               if (md) {
+                       md->reset_tracker ();
+               }
+       }
+}
+
+MonitorState
+MidiTrack::monitoring_state () const
+{
+       /* Explicit requests */
+       
+       if (_monitoring & MonitorInput) {
+               return MonitoringInput;
+       }
+               
+       if (_monitoring & MonitorDisk) {
+               return MonitoringDisk;
+       }
+
+       if (_session.transport_rolling()) {
+               return MonitoringDisk;
+       } 
+
+       /* the return value here doesn't mean that we're actually monitoring
+        * input, let alone input *audio*. but it means that we are NOT 
+        * monitoring silence. this allows us to still hear any audio generated
+        * by using internal generation techniques
+        */
+
+       return MonitoringInput;
+}