fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / midi_region.cc
index d52d661c1a5972b897f05e4ccd179cb6dded6611..eef2811c5b963c7b438862cb02486ba86f0c783c 100644 (file)
 
 #include <set>
 
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
+#include <glibmm/fileutils.h>
+#include <glibmm/miscutils.h>
+
+#include "evoral/Beats.hpp"
 
 #include "pbd/xml++.h"
+#include "pbd/basename.h"
 
 #include "ardour/automation_control.h"
 #include "ardour/midi_model.h"
 #include "ardour/midi_source.h"
 #include "ardour/region_factory.h"
 #include "ardour/session.h"
+#include "ardour/source_factory.h"
 #include "ardour/tempo.h"
 #include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 #include <locale.h>
 
 using namespace std;
@@ -47,17 +53,14 @@ using namespace PBD;
 
 namespace ARDOUR {
        namespace Properties {
-               PBD::PropertyDescriptor<void*>                midi_data;
-               PBD::PropertyDescriptor<Evoral::MusicalTime>  start_beats;
-               PBD::PropertyDescriptor<Evoral::MusicalTime>  length_beats;
+               PBD::PropertyDescriptor<Evoral::Beats> start_beats;
+               PBD::PropertyDescriptor<Evoral::Beats> length_beats;
        }
 }
 
 void
 MidiRegion::make_property_quarks ()
 {
-       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::start_beats.property_id = g_quark_from_static_string (X_("start-beats"));
        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for start-beats = %1\n", Properties::start_beats.property_id));
        Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
@@ -74,7 +77,7 @@ MidiRegion::register_properties ()
 /* Basic MidiRegion constructor (many channels) */
 MidiRegion::MidiRegion (const SourceList& srcs)
        : Region (srcs)
-       , _start_beats (Properties::start_beats, 0)
+       , _start_beats (Properties::start_beats, Evoral::Beats())
        , _length_beats (Properties::length_beats, midi_source(0)->length_beats())
 {
        register_properties ();
@@ -88,9 +91,9 @@ MidiRegion::MidiRegion (const SourceList& srcs)
 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
        : Region (other)
        , _start_beats (Properties::start_beats, other->_start_beats)
-       , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
+       , _length_beats (Properties::length_beats, other->_length_beats)
 {
-       update_length_beats ();
+       //update_length_beats ();
        register_properties ();
 
        assert(_name.val().find("/") == string::npos);
@@ -99,17 +102,13 @@ MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
 }
 
 /** Create a new MidiRegion that is part of an existing one */
-MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset)
-       : Region (other, offset)
-       , _start_beats (Properties::start_beats, (Evoral::MusicalTime) 0)
-       , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
+MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, const int32_t sub_num)
+       : Region (other, offset, sub_num)
+       , _start_beats (Properties::start_beats, Evoral::Beats())
+       , _length_beats (Properties::length_beats, other->_length_beats)
 {
-       BeatsFramesConverter bfc (_session.tempo_map(), _position);
-       Evoral::MusicalTime const offset_beats = bfc.from (offset);
-
-       _start_beats = other->_start_beats + offset_beats;
-       _length_beats = other->_length_beats - offset_beats;
-
+       _start_beats = Evoral::Beats (_session.tempo_map().exact_beat_at_frame ((other->_position + offset), sub_num) - other->beat()) + other->_start_beats;
+       update_length_beats (sub_num);
        register_properties ();
 
        assert(_name.val().find("/") == string::npos);
@@ -121,20 +120,72 @@ MidiRegion::~MidiRegion ()
 {
 }
 
+/** Export the MIDI data of the MidiRegion to a new MIDI file (SMF).
+ */
+bool
+MidiRegion::do_export (string path) const
+{
+       boost::shared_ptr<MidiSource> newsrc;
+
+       /* caller must check for pre-existing file */
+       assert (!path.empty());
+       assert (!Glib::file_test (path, Glib::FILE_TEST_EXISTS));
+       newsrc = boost::dynamic_pointer_cast<MidiSource>(
+               SourceFactory::createWritable(DataType::MIDI, _session,
+                                             path, false, _session.frame_rate()));
+
+       BeatsFramesConverter bfc (_session.tempo_map(), _position);
+       Evoral::Beats const bbegin = bfc.from (_start);
+       Evoral::Beats const bend = bfc.from (_start + _length);
+
+       {
+               /* Lock our source since we'll be reading from it.  write_to() will
+                  take a lock on newsrc. */
+               Source::Lock lm (midi_source(0)->mutex());
+               if (midi_source(0)->export_write_to (lm, newsrc, bbegin, bend)) {
+                       return false;
+               }
+       }
+
+       return true;
+}
+
+
 /** Create a new MidiRegion that has its own version of some/all of the Source used by another.
  */
 boost::shared_ptr<MidiRegion>
 MidiRegion::clone (string path) const
 {
-       BeatsFramesConverter bfc (_session.tempo_map(), _position);
-       Evoral::MusicalTime const bbegin = bfc.from (_start);
-       Evoral::MusicalTime const bend = bfc.from (_start + _length);
+       boost::shared_ptr<MidiSource> newsrc;
 
-       boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (path, bbegin, bend);
+       /* caller must check for pre-existing file */
+       assert (!path.empty());
+       assert (!Glib::file_test (path, Glib::FILE_TEST_EXISTS));
+       newsrc = boost::dynamic_pointer_cast<MidiSource>(
+               SourceFactory::createWritable(DataType::MIDI, _session,
+                                             path, false, _session.frame_rate()));
+       return clone (newsrc);
+}
+
+boost::shared_ptr<MidiRegion>
+MidiRegion::clone (boost::shared_ptr<MidiSource> newsrc) const
+{
+       BeatsFramesConverter bfc (_session.tempo_map(), _position);
+       Evoral::Beats const bbegin = bfc.from (_start);
+       Evoral::Beats const bend = bfc.from (_start + _length);
+
+       {
+               /* Lock our source since we'll be reading from it.  write_to() will
+                  take a lock on newsrc. */
+               Source::Lock lm (midi_source(0)->mutex());
+               if (midi_source(0)->write_to (lm, newsrc, bbegin, bend)) {
+                       return boost::shared_ptr<MidiRegion> ();
+               }
+       }
 
        PropertyList plist;
 
-       plist.add (Properties::name, ms->name());
+       plist.add (Properties::name, PBD::basename_nosuffix (newsrc->name()));
        plist.add (Properties::whole_file, true);
        plist.add (Properties::start, _start);
        plist.add (Properties::start_beats, _start_beats);
@@ -142,7 +193,10 @@ MidiRegion::clone (string path) const
        plist.add (Properties::length_beats, _length_beats);
        plist.add (Properties::layer, 0);
 
-       return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
+       boost::shared_ptr<MidiRegion> ret (boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (newsrc, plist, true)));
+       ret->set_beat (beat());
+
+       return ret;
 }
 
 void
@@ -151,7 +205,8 @@ MidiRegion::post_set (const PropertyChange& pc)
        Region::post_set (pc);
 
        if (pc.contains (Properties::length) && !pc.contains (Properties::length_beats)) {
-               update_length_beats ();
+               /* update non-musically */
+               update_length_beats (0);
        } else if (pc.contains (Properties::start) && !pc.contains (Properties::start_beats)) {
                set_start_beats_from_start_frames ();
        }
@@ -160,55 +215,83 @@ MidiRegion::post_set (const PropertyChange& pc)
 void
 MidiRegion::set_start_beats_from_start_frames ()
 {
-       BeatsFramesConverter c (_session.tempo_map(), _position - _start);
-       _start_beats = c.from (_start);
+       _start_beats = Evoral::Beats (beat() - _session.tempo_map().beat_at_frame (_position - _start));
 }
 
 void
-MidiRegion::set_length_internal (framecnt_t len)
+MidiRegion::set_length_internal (framecnt_t len, const int32_t sub_num)
 {
-       Region::set_length_internal (len);
-       update_length_beats ();
+       Region::set_length_internal (len, sub_num);
+       update_length_beats (sub_num);
 }
 
 void
-MidiRegion::update_after_tempo_map_change ()
+MidiRegion::update_after_tempo_map_change (bool /* send */)
 {
-       Region::update_after_tempo_map_change ();
+       boost::shared_ptr<Playlist> pl (playlist());
+
+       if (!pl || position_lock_style() != MusicTime) {
+               return;
+       }
+
+       const framepos_t old_pos = _position;
+       const framepos_t old_length = _length;
+       const framepos_t old_start = _start;
+
+       Region::update_after_tempo_map_change (false);
 
-       /* _position has now been updated for the new tempo map */
-       _start = _position - _session.tempo_map().framepos_minus_beats (_position, _start_beats);
+       /* _start has now been updated. */
+       _length = _session.tempo_map().frame_at_beat (beat() + _length_beats.val().to_double()) - _position;
 
-       send_change (Properties::start);
+       PropertyChange s_and_l;
+       if (old_start != _start) {
+               s_and_l.add (Properties::start);
+       }
+       if (old_length != _length) {
+               s_and_l.add (Properties::length);
+       }
+       if (old_pos != _position) {
+               s_and_l.add (Properties::position);
+       }
+
+       send_change (s_and_l);
 }
 
 void
-MidiRegion::update_length_beats ()
+MidiRegion::update_length_beats (const int32_t sub_num)
 {
-       BeatsFramesConverter converter (_session.tempo_map(), _position);
-       _length_beats = converter.from (_length);
+       _length_beats = Evoral::Beats (_session.tempo_map().exact_beat_at_frame (_position + _length, sub_num) - beat());
 }
 
 void
-MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
+MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute, const int32_t sub_num)
 {
-       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);
-               Region::set_length_internal (converter.to (_length_beats));
+       Region::set_position_internal (pos, allow_bbt_recompute, sub_num);
+
+       /* set _start to new position in tempo map */
+       _start = _position - _session.tempo_map().frame_at_beat (beat() - _start_beats.val().to_double());
+
+       /* in construction from src */
+       if (_length_beats == Evoral::Beats()) {
+               update_length_beats (sub_num);
        }
+
+       /* 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).
+       */
+       Region::set_length_internal (_session.tempo_map().frame_at_beat (beat() + _length_beats.val().to_double()) - _position, sub_num);
 }
 
 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
+MidiRegion::read_at (Evoral::EventSink<framepos_t>& out,
+                     framepos_t                     position,
+                     framecnt_t                     dur,
+                     uint32_t                       chan_n,
+                     NoteMode                       mode,
+                     MidiStateTracker*              tracker,
+                     MidiChannelFilter*             filter) const
 {
-       return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
+       return _read_at (_sources, out, position, dur, chan_n, mode, tracker, filter);
 }
 
 framecnt_t
@@ -218,11 +301,17 @@ MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position
 }
 
 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
+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,
+                      MidiChannelFilter*             filter) const
 {
        frameoffset_t internal_offset = 0;
-       framecnt_t to_read         = 0;
+       framecnt_t    to_read         = 0;
 
        /* precondition: caller has verified that we cover the desired section */
 
@@ -250,7 +339,10 @@ MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>&
        }
 
        boost::shared_ptr<MidiSource> src = midi_source(chan_n);
-       src->set_note_mode(mode);
+
+       Glib::Threads::Mutex::Lock lm(src->mutex());
+
+       src->set_note_mode(lm, mode);
 
        /*
          cerr << "MR " << name () << " read @ " << position << " * " << to_read
@@ -263,12 +355,16 @@ MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>&
        /* This call reads events from a source and writes them to `dst' timed in session frames */
 
        if (src->midi_read (
+                   lm, // source lock
                        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
+                       filter,
+                       _filtered_parameters,
+                       beat(),
+                       _start_beats.val().to_double()
                    ) != to_read) {
                return 0; /* "read nothing" */
        }
@@ -288,7 +384,10 @@ MidiRegion::set_state (const XMLNode& node, int version)
        int ret = Region::set_state (node, version);
 
        if (ret == 0) {
-               update_length_beats ();
+               /* set length beats to the frame (non-musical) */
+               if (position_lock_style() == AudioTime) {
+                       update_length_beats (0);
+               }
        }
 
        return ret;
@@ -377,15 +476,6 @@ MidiRegion::model_changed ()
        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));
-}
-
-void
-MidiRegion::model_contents_changed ()
-{
-       send_change (PropertyChange (Properties::midi_data));
 }
 
 void
@@ -394,9 +484,9 @@ 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) {
+       if (!ac || ac->alist()->automation_state() == Play) {
+               /* It should be "impossible" for ac to be NULL, but if it is, don't
+                  filter the parameter so events aren't lost. */
                _filtered_parameters.erase (p);
        } else {
                _filtered_parameters.insert (p);
@@ -406,8 +496,11 @@ MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
           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 ();
+       Glib::Threads::Mutex::Lock lm (midi_source(0)->mutex(), Glib::Threads::TRY_LOCK);
+       if (lm.locked()) {
+               /* TODO: This is too aggressive, we need more fine-grained invalidation. */
+               midi_source(0)->invalidate (lm);
+       }
 }
 
 /** This is called when a trim drag has resulted in a -ve _start time for this region.
@@ -420,20 +513,83 @@ MidiRegion::fix_negative_start ()
 
        model()->insert_silence_at_start (c.from (-_start));
        _start = 0;
-       _start_beats = 0;
+       _start_beats = Evoral::Beats();
 }
 
-/** Transpose the notes in this region by a given number of semitones */
 void
-MidiRegion::transpose (int semitones)
+MidiRegion::set_start_internal (framecnt_t s, const int32_t sub_num)
 {
-       BeatsFramesConverter c (_session.tempo_map(), _start);
-       model()->transpose (c.from (_start), c.from (_start + _length), semitones);
+       Region::set_start_internal (s, sub_num);
+
+       if (position_lock_style() == AudioTime) {
+               set_start_beats_from_start_frames ();
+               }
 }
 
 void
-MidiRegion::set_start_internal (framecnt_t s)
+MidiRegion::trim_to_internal (framepos_t position, framecnt_t length, const int32_t sub_num)
 {
-       Region::set_start_internal (s);
-       set_start_beats_from_start_frames ();
+       framepos_t new_start;
+
+       if (locked()) {
+               return;
+       }
+
+       PropertyChange what_changed;
+
+       /* beat has been set exactly by set_position_internal, but the source starts on a frame.
+          working in beats seems the correct thing to do, but reports of a missing first note
+          on playback suggest otherwise. for now, we work in exact beats.
+       */
+       const double pos_beat = _session.tempo_map().exact_beat_at_frame (position, sub_num);
+       const double beat_delta = pos_beat - beat();
+
+       /* Set position before length, otherwise for MIDI regions this bad thing happens:
+        * 1. we call set_length_internal; length in beats is computed using the region's current
+        *    (soon-to-be old) position
+        * 2. we call set_position_internal; position is set and length in frames re-computed using
+        *    length in beats from (1) but at the new position, which is wrong if the region
+        *    straddles a tempo/meter change.
+        */
+
+       if (_position != position) {
+               set_position_internal (position, true, sub_num);
+               what_changed.add (Properties::position);
+       }
+
+       const double new_start_beat = _start_beats.val().to_double() + beat_delta;
+       new_start = _position - _session.tempo_map().frame_at_beat (beat() - new_start_beat);
+
+       if (!verify_start_and_length (new_start, length)) {
+               return;
+       }
+
+       if (_start != new_start) {
+               _start_beats = Evoral::Beats (new_start_beat);
+               what_changed.add (Properties::start_beats);
+
+               set_start_internal (new_start, sub_num);
+               what_changed.add (Properties::start);
+       }
+
+       if (_length != length) {
+               set_length_internal (length, sub_num);
+               what_changed.add (Properties::length);
+               what_changed.add (Properties::length_beats);
+       }
+
+       set_whole_file (false);
+
+       PropertyChange start_and_length;
+
+       start_and_length.add (Properties::start);
+       start_and_length.add (Properties::length);
+
+       if (what_changed.contains (start_and_length)) {
+               first_edit ();
+       }
+
+       if (!what_changed.empty()) {
+               send_change (what_changed);
+       }
 }