fix BeatFramesConverter so that it at least works even if its not optimally named...
[ardour.git] / libs / ardour / midi_region.cc
index 0902337030f50837d92cce93b87e57dfe0f23ecf..e487cae2f5224426fc9a8947846de9f078e7d146 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/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_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;
+using namespace PBD;
 
-/** Basic MidiRegion constructor (one channel) */
-MidiRegion::MidiRegion (MidiSource& src, jack_nframes_t start, jack_nframes_t length, bool announce)
-       : Region (src, start, length, PBD::basename_nosuffix(src.name()), 0,  Region::Flag(Region::DefaultFlags|Region::External))
-{
-       save_state ("initial state");
-
-       if (announce) {
-                CheckNewRegion (this); /* EMIT SIGNAL */
-       }
+namespace ARDOUR {
+       namespace Properties {
+               PBD::PropertyDescriptor<void*>                midi_data;
+               PBD::PropertyDescriptor<Evoral::MusicalTime>  length_beats;
+        }
 }
 
-/* Basic MidiRegion constructor (one channel) */
-MidiRegion::MidiRegion (MidiSource& src, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t layer, Flag flags, bool announce)
-       : Region (src, start, length, name, layer, flags)
+void
+MidiRegion::make_property_quarks ()
 {
-       save_state ("initial state");
+        Properties::midi_data.property_id = g_quark_from_static_string (X_("midi-data"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for midi-data = %1\n", Properties::midi_data.property_id));
+        Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for length-beats = %1\n", Properties::length_beats.property_id));
+}
 
-       if (announce) {
-                CheckNewRegion (this); /* EMIT SIGNAL */
-       }
+void
+MidiRegion::register_properties ()
+{
+       add_property (_length_beats);
 }
 
 /* Basic MidiRegion constructor (many channels) */
-MidiRegion::MidiRegion (SourceList& srcs, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t layer, Flag flags, bool announce)
-       : Region (srcs, start, length, name, layer, flags)
+MidiRegion::MidiRegion (const SourceList& srcs)
+       : Region (srcs)
+        , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
 {
-       save_state ("initial state");
+        update_length_beats ();
+        register_properties ();
 
-       if (announce) {
-                CheckNewRegion (this); /* EMIT SIGNAL */
-       }
+       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 (const MidiRegion& other, jack_nframes_t offset, jack_nframes_t length, const string& name, layer_t layer, Flag flags, bool announce)
-       : 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)
+        , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
 {
-       save_state ("initial state");
+        update_length_beats ();
+        register_properties ();
 
-       if (announce) {
-               CheckNewRegion (this); /* EMIT SIGNAL */
-       }
+       assert(_name.val().find("/") == string::npos);
+       midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
+       model_changed ();
 }
 
-MidiRegion::MidiRegion (const MidiRegion &other)
-       : Region (other)
+MidiRegion::~MidiRegion ()
 {
-       save_state ("initial state");
-
-       /* NOTE: no CheckNewRegion signal emitted here. This is the copy constructor */
 }
 
-MidiRegion::MidiRegion (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();
-       }
-
-       save_state ("initial state");
+        BeatsFramesConverter bfc (_session.tempo_map(), _position);
+       Evoral::MusicalTime const bbegin = bfc.from (_start);
+       Evoral::MusicalTime const bend = bfc.from (_start + _length);
 
-       CheckNewRegion (this); /* EMIT SIGNAL */
-}
+        boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
 
-MidiRegion::MidiRegion (SourceList& srcs, const XMLNode& node)
-       : Region (srcs, node)
-{
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
+        PropertyList plist;
 
-       save_state ("initial state");
+        plist.add (Properties::name, ms->name());
+        plist.add (Properties::whole_file, true);
+        plist.add (Properties::start, _start);
+        plist.add (Properties::length, _length);
+        plist.add (Properties::length_beats, _length_beats);
+        plist.add (Properties::layer, 0);
 
-       CheckNewRegion (this); /* EMIT SIGNAL */
+        return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
 }
 
-MidiRegion::~MidiRegion ()
+void
+MidiRegion::set_length_internal (framecnt_t len)
 {
-       GoingAway (this);
+        Region::set_length_internal (len);
+        update_length_beats ();
 }
 
-StateManager::State*
-MidiRegion::state_factory (std::string why) const
-{
-       RegionState* state = new RegionState (why);
-
-       Region::store_state (*state);
-
-       return state;
-}      
-
-Change
-MidiRegion::restore_state (StateManager::State& sstate) 
+void
+MidiRegion::update_length_beats ()
 {
-       RegionState* state = dynamic_cast<RegionState*> (&sstate);
-       Change what_changed = Region::restore_and_return_flags (*state);
-       
-       if (_flags != Flag (state->_flags)) {
-               
-               //uint32_t old_flags = _flags;
-               
-               _flags = Flag (state->_flags);
-       }
-               
-       what_changed = Change (what_changed);
-
-       return what_changed;
+        cerr << name() << " Updating length beats, currently = " << _length_beats << " w/length = " << _length << endl;
+       BeatsFramesConverter converter (_session.tempo_map(), _position);
+        _length_beats = converter.from (_length);
+        cerr << "\tnew value: " << _length_beats << endl;
 }
 
-UndoAction
-MidiRegion::get_memento() const
+void
+MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
 {
-       return sigc::bind (mem_fun (*(const_cast<MidiRegion *> (this)), &StateManager::use_state), _current_state_id);
+       Region::set_position_internal (pos, allow_bbt_recompute);
+        /* zero length regions don't exist - so if _length_beats is zero, this object
+           is under construction.
+        */
+        if (_length_beats) {
+                /* leave _length_beats alone, and change _length to reflect the state of things
+                   at the new position (tempo map may dictate a different number of frames
+                */
+                BeatsFramesConverter converter (_session.tempo_map(), _position - _start);
+                Region::set_length_internal (converter.to (_length_beats));
+        }
 }
 
-jack_nframes_t
-MidiRegion::read_at (RawMidi *out, RawMidi* mix_buf, jack_nframes_t position, 
-                     jack_nframes_t cnt, 
-                     uint32_t chan_n, jack_nframes_t read_frames, jack_nframes_t skip_frames) const
+framecnt_t
+MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
 {
-       return _read_at (_sources, out, position, cnt, chan_n, read_frames, skip_frames);
+       return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
 }
 
-jack_nframes_t
-MidiRegion::master_read_at (RawMidi *out, RawMidi* mix_buf, jack_nframes_t position, 
-                            jack_nframes_t cnt, uint32_t chan_n) const
+framecnt_t
+MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 {
-       return _read_at (_master_sources, out, position, cnt, chan_n, 0, 0);
+       return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 }
 
-jack_nframes_t
-MidiRegion::_read_at (const SourceList& srcs, RawMidi *buf, 
-                      jack_nframes_t position, jack_nframes_t cnt, 
-                      uint32_t chan_n, jack_nframes_t read_frames, jack_nframes_t skip_frames) const
+framecnt_t
+MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n, 
+                     NoteMode mode, MidiStateTracker* tracker) const
 {
-       jack_nframes_t internal_offset;
-       jack_nframes_t buf_offset;
-       jack_nframes_t to_read;
-       
+       frameoffset_t internal_offset = 0;
+       framecnt_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) {
+               /* we are starting the read from before the start of the region */
                internal_offset = 0;
-               buf_offset = _position - position;
-               cnt -= buf_offset;
+               dur -= _position - position;
        } else {
+               /* we are starting the read from after the start of the region */
                internal_offset = position - _position;
-               buf_offset = 0;
        }
 
        if (internal_offset >= _length) {
                return 0; /* read nothing */
        }
-       
-
-       if ((to_read = min (cnt, _length - internal_offset)) == 0) {
-               return 0; /* read nothing */
-       }
-
-       // FIXME: non-opaque MIDI regions not yet supported
-       assert(opaque());
 
-       if (muted()) {
+       if ((to_read = min (dur, _length - internal_offset)) == 0) {
                return 0; /* read nothing */
        }
 
        _read_data_count = 0;
 
-       MidiSource& src = midi_source(chan_n);
-       if (src.read (buf, _start + internal_offset, to_read) != to_read) {
+       boost::shared_ptr<MidiSource> src = midi_source(chan_n);
+       src->set_note_mode(mode);
+        
+        /*
+          cerr << "MR read @ " << position << " * " << to_read
+          << " _position = " << _position
+          << " _start = " << _start
+          << " intoffset = " << internal_offset
+          << endl;
+        */
+
+       /* This call reads events from a source and writes them to `dst' timed in session frames */
+
+       if (src->midi_read (
+                       dst, // destination buffer
+                       _position - _start, // start position of the source in session frames
+                       _start + internal_offset, // where to start reading in the source
+                       to_read, // read duration in frames
+                       tracker,
+                       _filtered_parameters
+                   ) != to_read) {
                return 0; /* "read nothing" */
        }
 
-       _read_data_count += src.read_data_count();
+       _read_data_count += src->read_data_count();
 
        return to_read;
 }
-       
+
 XMLNode&
-MidiRegion::state (bool full)
+MidiRegion::state ()
 {
-       XMLNode& node (Region::state (full));
-       XMLNode *child;
-       char buf[64];
-       char buf2[64];
-       LocaleGuard lg (X_("POSIX"));
-       
-       snprintf (buf, sizeof (buf), "0x%x", (int) _flags);
-       node.add_property ("flags", buf);
-
-       for (uint32_t n=0; n < _sources.size(); ++n) {
-               snprintf (buf2, sizeof(buf2), "source-%d", n);
-               _sources[n]->id().print (buf);
-               node.add_property (buf2, buf);
-       }
-
-       snprintf (buf, sizeof (buf), "%u", (uint32_t) _sources.size());
-       node.add_property ("channels", buf);
-
-       child = node.add_child ("Envelope");
-
-       if ( ! full) {
-               child->add_property ("default", "yes");
-       }
-
-       if (full && _extra_xml) {
-               node.add_child_copy (*_extra_xml);
-       }
-
-       return node;
+       return Region::state ();
 }
 
 int
-MidiRegion::set_state (const XMLNode& node)
+MidiRegion::set_state (const XMLNode& node, int version)
 {
-       const XMLNodeList& nlist = node.children();
-       const XMLProperty *prop;
-       LocaleGuard lg (X_("POSIX"));
-
-       Region::set_state (node);
-
-       if ((prop = node.property ("flags")) != 0) {
-               _flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
-       }
+       int ret = Region::set_state (node, version);
 
-       /* Now find child items */
-       for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               
-               XMLNode *child;
-               //XMLProperty *prop;
-               
-               child = (*niter);
-               
-               /** Hello, children */
-       }
+        if (ret == 0) {
+                update_length_beats ();
+        }
 
-       return 0;
+        return ret;
 }
 
 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 ()
@@ -310,35 +269,91 @@ 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
 {
-#if 0
-       SourceList srcs;
-       string new_name;
+       // TODO
+       return -1;
+}
 
-       for (SourceList::const_iterator i = _master_sources.begin(); i != _master_sources.end(); ++i) {
+int
+MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
+{
+       return -1;
+}
 
-               srcs.clear ();
-               srcs.push_back (*i);
+boost::shared_ptr<MidiSource>
+MidiRegion::midi_source (uint32_t n) const
+{
+       // Guaranteed to succeed (use a static cast?)
+       return boost::dynamic_pointer_cast<MidiSource>(source(n));
+}
 
-               /* generate a new name */
-               
-               if (session.region_name (new_name, _name)) {
-                       return -1;
-               }
+void
+MidiRegion::model_changed ()
+{
+       if (!model()) {
+               return;
+       }
+       
+       /* build list of filtered Parameters, being those whose automation state is not `Play' */
 
-               /* create a copy with just one source */
+       _filtered_parameters.clear ();
 
-               v.push_back (new MidiRegion (srcs, _start, _length, new_name, _layer, _flags));
+       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 ());
+               }
        }
-#endif
-       return -1;
+
+       /* watch for changes to controls' AutoState */
+       midi_source()->AutomationStateChanged.connect_same_thread (
+               _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
+               );
+
+        model()->ContentsChanged.connect_same_thread (
+                _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
 }
 
-MidiSource&
-MidiRegion::midi_source (uint32_t n) const
+void
+MidiRegion::model_contents_changed ()
 {
-       // Guaranteed to succeed (use a static cast?)
-       return dynamic_cast<MidiSource&>(source(n));
+        send_change (PropertyChange (Properties::midi_data));        
+}
+
+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_parameters, 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 ();
 }
 
+/** This is called when a trim drag has resulted in a -ve _start time for this region.
+ *  Fix it up by adding some empty space to the source.
+ */
+void
+MidiRegion::fix_negative_start ()
+{
+        BeatsFramesConverter c (_session.tempo_map(), _position);
+
+       model()->insert_silence_at_start (c.from (-_start));
+       _start = 0;
+}