const correctness.
[ardour.git] / libs / ardour / midi_region.cc
index 401d67e2ef9334efdbb4d466048e5cce86415e48..c65758b01e315867b6a5bbf6ba9864f8a0637427 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2006 Paul Davis 
+    Copyright (C) 2000-2006 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
 
 #include <set>
 
-#include <sigc++/bind.h>
-#include <sigc++/class_slot.h>
-
 #include <glibmm/thread.h>
 
-#include <pbd/basename.h>
-#include <pbd/xml++.h>
-#include <pbd/enumwriter.h>
+#include "pbd/basename.h"
+#include "pbd/xml++.h"
+#include "pbd/enumwriter.h"
 
-#include <ardour/midi_region.h>
-#include <ardour/session.h>
-#include <ardour/gain.h>
-#include <ardour/dB.h>
-#include <ardour/playlist.h>
-#include <ardour/midi_source.h>
-#include <ardour/types.h>
-#include <ardour/midi_ring_buffer.h>
+#include "ardour/midi_region.h"
+#include "ardour/session.h"
+#include "ardour/gain.h"
+#include "ardour/dB.h"
+#include "ardour/playlist.h"
+#include "ardour/midi_source.h"
+#include "ardour/region_factory.h"
+#include "ardour/types.h"
+#include "ardour/midi_ring_buffer.h"
 
 #include "i18n.h"
 #include <locale.h>
 
 using namespace std;
 using namespace ARDOUR;
-
-/** Basic MidiRegion constructor (one channel) */
-MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, nframes_t start, nframes_t length)
-       : Region (src, start, length, PBD::basename_nosuffix(src->name()), DataType::MIDI, 0,  Region::Flag(Region::DefaultFlags|Region::External))
-{
-       assert(_name.find("/") == string::npos);
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
-}
-
-/* Basic MidiRegion constructor (one channel) */
-MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
-       : Region (src, start, length, name, DataType::MIDI, layer, flags)
-{
-       assert(_name.find("/") == string::npos);
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
-}
+using namespace PBD;
 
 /* Basic MidiRegion constructor (many channels) */
-MidiRegion::MidiRegion (const SourceList& srcs, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
-       : Region (srcs, start, length, name, DataType::MIDI, layer, flags)
+MidiRegion::MidiRegion (const SourceList& srcs)
+       : Region (srcs)
 {
-       assert(_name.find("/") == string::npos);
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
+       // midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
+       midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
+       model_changed ();
+       assert(_name.val().find("/") == string::npos);
+       assert(_type == DataType::MIDI);
 }
 
-
 /** Create a new MidiRegion, that is part of an existing one */
-MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, nframes_t offset, nframes_t length, const string& name, layer_t layer, Flag flags)
-       : Region (other, offset, length, name, layer, flags)
+MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, bool offset_relative)
+       : Region (other, offset, offset_relative)
 {
-       assert(_name.find("/") == string::npos);
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
+       assert(_name.val().find("/") == string::npos);
+       // midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
+       midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
+       model_changed ();
 }
 
-MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
-       : Region (other)
+MidiRegion::~MidiRegion ()
 {
-       assert(_name.find("/") == string::npos);
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
 }
 
-MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, const XMLNode& node)
-       : Region (src, node)
+/** Create a new MidiRegion that has its own version of some/all of the Source used by another. 
+ */
+boost::shared_ptr<MidiRegion>
+MidiRegion::clone ()
 {
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
+        BeatsFramesConverter bfc (_session.tempo_map(), _position);
+        double bbegin = bfc.from (_position);
+        double bend = bfc.from (last_frame() + 1);
 
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
-       assert(_name.find("/") == string::npos);
-       assert(_type == DataType::MIDI);
-}
+        boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
 
-MidiRegion::MidiRegion (const SourceList& srcs, const XMLNode& node)
-       : Region (srcs, node)
-{
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
+        PropertyList plist;
 
-       midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
-       assert(_name.find("/") == string::npos);
-       assert(_type == DataType::MIDI);
+        plist.add (Properties::name, ms->name());
+        plist.add (Properties::whole_file, true);
+        plist.add (Properties::start, 0);
+        plist.add (Properties::length, _length);
+        plist.add (Properties::layer, 0);
+
+        return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
 }
 
-MidiRegion::~MidiRegion ()
+void
+MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
 {
+       BeatsFramesConverter old_converter(_session.tempo_map(), _position - _start);
+       double length_beats = old_converter.from(_length);
+
+       Region::set_position_internal(pos, allow_bbt_recompute);
+
+       BeatsFramesConverter new_converter(_session.tempo_map(), pos - _start);
+
+       set_length(new_converter.to(length_beats), 0);
 }
 
-nframes_t
-MidiRegion::read_at (MidiRingBuffer<nframes_t>& out, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
+framecnt_t
+MidiRegion::read_at (Evoral::EventSink<nframes_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
 {
-       return _read_at (_sources, out, position, dur, chan_n, mode);
+       return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
 }
 
-nframes_t
-MidiRegion::master_read_at (MidiRingBuffer<nframes_t>& out, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
+framecnt_t
+MidiRegion::master_read_at (MidiRingBuffer<nframes_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 {
-       return _read_at (_master_sources, out, position, dur, chan_n, mode);
+       return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 }
 
-nframes_t
-MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer<nframes_t>& dst, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
+framecnt_t
+MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<nframes_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n, 
+                     NoteMode mode, MidiStateTracker* tracker) const
 {
-       /*cerr << "MidiRegion " << _name << "._read_at(" << position << ") - "
-               << position << " duration: " << dur << endl;*/
+       frameoffset_t internal_offset = 0;
+       frameoffset_t src_offset      = 0;
+       framecnt_t to_read         = 0;
 
-       nframes_t internal_offset = 0;
-       nframes_t src_offset      = 0;
-       nframes_t to_read         = 0;
-       
        /* precondition: caller has verified that we cover the desired section */
 
        assert(chan_n == 0);
-       
+
+       if (muted()) {
+               return 0; /* read nothing */
+       }
+
        if (position < _position) {
                internal_offset = 0;
                src_offset = _position - position;
@@ -154,47 +147,45 @@ MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer<nframes_t>& dst, nf
        if (internal_offset >= _length) {
                return 0; /* read nothing */
        }
-       
 
        if ((to_read = min (dur, _length - internal_offset)) == 0) {
                return 0; /* read nothing */
        }
 
-       // FIXME: non-opaque MIDI regions not yet supported
-       assert(opaque());
-
-       if (muted()) {
-               return 0; /* read nothing */
-       }
-
        _read_data_count = 0;
 
        boost::shared_ptr<MidiSource> src = midi_source(chan_n);
        src->set_note_mode(mode);
 
-       nframes_t output_buffer_position = 0;
-       nframes_t negative_output_buffer_position = 0;
+       framepos_t output_buffer_position = 0;
+       framepos_t negative_output_buffer_position = 0;
        if (_position >= _start) {
                // handle resizing of beginnings of regions correctly
                output_buffer_position = _position - _start;
        } else {
                // when _start is greater than _position, we have to subtract
                // _start from the note times in the midi source
-               negative_output_buffer_position = _start; 
+               negative_output_buffer_position = _start;
        }
-       
+
+       /*cerr << "MR read @ " << position << " * " << to_read
+               << " _position = " << _position
+           << " _start = " << _start
+           << " offset = " << output_buffer_position
+           << " negoffset = " << negative_output_buffer_position
+           << " intoffset = " << internal_offset
+           << endl;*/
+
        if (src->midi_read (
-                       // the destination buffer
-                       dst,  
-                       // where to start reading in the region
-                       _start + internal_offset, 
-                       // how many bytes
-                       to_read, 
-                       // the offset in the output buffer
-                       output_buffer_position,
-                       // what to substract from note times written in the output buffer
-                       negative_output_buffer_position
-               ) != to_read) {
+                       dst, // destination buffer
+                       _position - _start, // start position of the source in this read context
+                       _start + internal_offset, // where to start reading in the source
+                       to_read, // read duration in frames
+                       output_buffer_position, // the offset in the output buffer
+                       negative_output_buffer_position, // amount to substract from note times
+                       tracker,
+                       _filtered_parameters
+                   ) != to_read) {
                return 0; /* "read nothing" */
        }
 
@@ -202,93 +193,26 @@ MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer<nframes_t>& dst, nf
 
        return to_read;
 }
-       
+
 XMLNode&
 MidiRegion::state (bool full)
 {
-       XMLNode& node (Region::state (full));
-       char buf[64];
-       char buf2[64];
-       LocaleGuard lg (X_("POSIX"));
-       
-       node.add_property ("flags", enum_2_string (_flags));
-
-       // XXX these should move into Region
-       
-       for (uint32_t n=0; n < _sources.size(); ++n) {
-               snprintf (buf2, sizeof(buf2), "source-%d", n);
-               _sources[n]->id().print (buf, sizeof(buf));
-               node.add_property (buf2, buf);
-       }
-
-       for (uint32_t n=0; n < _master_sources.size(); ++n) {
-               snprintf (buf2, sizeof(buf2), "master-source-%d", n);
-               _master_sources[n]->id().print (buf, sizeof (buf));
-               node.add_property (buf2, buf);
-       }
-
-       if (full && _extra_xml) {
-               node.add_child_copy (*_extra_xml);
-       }
-
-       return node;
-}
-
-int
-MidiRegion::set_live_state (const XMLNode& node, Change& what_changed, bool send)
-{
-       const XMLProperty *prop;
-       LocaleGuard lg (X_("POSIX"));
-
-       Region::set_live_state (node, what_changed, false);
-
-       uint32_t old_flags = _flags;
-               
-       if ((prop = node.property ("flags")) != 0) {
-               _flags = Flag (string_2_enum (prop->value(), _flags));
-
-               //_flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
-
-               _flags = Flag (_flags & ~Region::LeftOfSplit);
-               _flags = Flag (_flags & ~Region::RightOfSplit);
-       }
-
-       if ((old_flags ^ _flags) & Muted) {
-               what_changed = Change (what_changed|MuteChanged);
-       }
-       if ((old_flags ^ _flags) & Opaque) {
-               what_changed = Change (what_changed|OpacityChanged);
-       }
-       if ((old_flags ^ _flags) & Locked) {
-               what_changed = Change (what_changed|LockChanged);
-       }
-
-       if (send) {
-               send_change (what_changed);
-       }
-
-       return 0;
+       return Region::state (full);
 }
 
 int
-MidiRegion::set_state (const XMLNode& node)
+MidiRegion::set_state (const XMLNode& node, int version)
 {
-       /* Region::set_state() calls the virtual set_live_state(),
-          which will get us back to AudioRegion::set_live_state()
-          to handle the relevant stuff.
-       */
-
-       return Region::set_state (node);
+       return Region::set_state (node, version);
 }
 
 void
 MidiRegion::recompute_at_end ()
 {
        /* our length has changed
-        * (non destructively) "chop" notes that pass the end boundary, to
-        * prevent stuck notes.
+         * so what? stuck notes are dealt with via a note state tracker
         */
-}      
+}
 
 void
 MidiRegion::recompute_at_start ()
@@ -303,33 +227,9 @@ MidiRegion::recompute_at_start ()
 }
 
 int
-MidiRegion::separate_by_channel (Session& session, vector<MidiRegion*>& v) const
+MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 {
-       // Separate by MIDI channel?  bit different from audio since this is separating based
-       // on the actual contained data and destructively modifies and creates new sources..
-       
-#if 0
-       SourceList srcs;
-       string new_name;
-
-       for (SourceList::const_iterator i = _master_sources.begin(); i != _master_sources.end(); ++i) {
-
-               srcs.clear ();
-               srcs.push_back (*i);
-
-               /* generate a new name */
-               
-               if (session.region_name (new_name, _name)) {
-                       return -1;
-               }
-
-               /* create a copy with just one source */
-
-               v.push_back (new MidiRegion (srcs, _start, _length, new_name, _layer, _flags));
-       }
-#endif
-
-       // Actually, I would prefer not if that's alright
+       // TODO
        return -1;
 }
 
@@ -350,14 +250,70 @@ MidiRegion::midi_source (uint32_t n) const
 void
 MidiRegion::switch_source(boost::shared_ptr<Source> src)
 {
+       _source_connection.disconnect ();
+       
        boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
-       if (!msrc)
+       if (!msrc) {
                return;
+       }
 
        // MIDI regions have only one source
-       _sources.clear();
-       _sources.push_back(msrc);
+        SourceList srcs;
+        srcs.push_back (msrc);
 
-       set_name(msrc->name());
+        drop_sources ();
+        use_sources (srcs);
+        
+       set_name (msrc->name());
+
+       msrc->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
 }
 
+void
+MidiRegion::model_changed ()
+{
+       if (!model()) {
+               return;
+       }
+       
+       /* build list of filtered Parameters, being those whose automation state is not `Play' */
+
+       _filtered_parameters.clear ();
+
+       Automatable::Controls const & c = model()->controls();
+
+       for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
+               boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
+               assert (ac);
+               if (ac->alist()->automation_state() != Play) {
+                       _filtered_parameters.insert (ac->parameter ());
+               }
+       }
+
+       /* watch for changes to controls' AutoState */
+       model()->AutomationStateChanged.connect_same_thread (
+               _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
+               );
+}
+
+void
+MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
+{
+       /* Update our filtered parameters list after a change to a parameter's AutoState */
+       
+       boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
+       assert (ac);
+
+       if (ac->alist()->automation_state() == Play) {
+               _filtered_parameters.erase (p);
+       } else {
+               _filtered_parameters.insert (p);
+       }
+
+       /* the source will have an iterator into the model, and that iterator will have been set up
+          for a given set of filtered_paramters, so now that we've changed that list we must invalidate
+          the iterator.
+       */
+       Glib::Mutex::Lock lm (midi_source(0)->mutex());
+       midi_source(0)->invalidate ();
+}