Add headless-chicken session utility.
[ardour.git] / libs / ardour / midi_region.cc
index 3e4a656ebe2006454672452470fe052a44b7c690..8868b7c6814044074f51762c442a1b0645ce923c 100644 (file)
@@ -28,7 +28,7 @@
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
-#include "evoral/types.hpp"
+#include "evoral/Beats.hpp"
 
 #include "pbd/xml++.h"
 #include "pbd/basename.h"
@@ -44,7 +44,7 @@
 #include "ardour/tempo.h"
 #include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 #include <locale.h>
 
 using namespace std;
@@ -81,7 +81,6 @@ MidiRegion::MidiRegion (const SourceList& srcs)
        , _length_beats (Properties::length_beats, midi_source(0)->length_beats())
 {
        register_properties ();
-
        midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
        model_changed ();
        assert(_name.val().find("/") == string::npos);
@@ -91,9 +90,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::Beats())
+       , _length_beats (Properties::length_beats, other->_length_beats)
 {
-       update_length_beats ();
+       //update_length_beats ();
        register_properties ();
 
        assert(_name.val().find("/") == string::npos);
@@ -102,17 +101,14 @@ 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)
+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, Evoral::Beats())
+       , _length_beats (Properties::length_beats, other->_length_beats)
 {
-       BeatsFramesConverter bfc (_session.tempo_map(), _position);
-       Evoral::Beats const offset_beats = bfc.from (offset);
-
-       _start_beats  = other->_start_beats.val() + offset_beats;
-       _length_beats = other->_length_beats.val() - offset_beats;
+       _start_beats = Evoral::Beats (_session.tempo_map().exact_qn_at_frame (other->_position + offset, sub_num) - (other->pulse() * 4.0)) + other->_start_beats;
 
+       update_length_beats (sub_num);
        register_properties ();
 
        assert(_name.val().find("/") == string::npos);
@@ -124,6 +120,37 @@ 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>
@@ -166,7 +193,11 @@ MidiRegion::clone (boost::shared_ptr<MidiSource> newsrc) const
        plist.add (Properties::length_beats, _length_beats);
        plist.add (Properties::layer, 0);
 
-       return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (newsrc, plist, true));
+       boost::shared_ptr<MidiRegion> ret (boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (newsrc, plist, true)));
+       ret->set_beat (beat());
+       ret->set_pulse (pulse());
+
+       return ret;
 }
 
 void
@@ -175,7 +206,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 ();
        }
@@ -184,48 +216,104 @@ 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 ((pulse() * 4.0) - _session.tempo_map().quarter_note_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) {
+               return;
+       }
+
+       const framepos_t old_pos = _position;
+       const framepos_t old_length = _length;
+       const framepos_t old_start = _start;
+
+       PropertyChange s_and_l;
+
+       if (position_lock_style() == AudioTime) {
+               recompute_position_from_lock_style (0);
+
+               /*
+                 set _start to new position in tempo map.
+
+                 The user probably expects the region contents to maintain audio position as the
+                 tempo changes, but AFAICT this requires modifying the src file to use
+                 SMPTE timestamps with the current disk read model (?).
+
+                 We could arguably use _start to set _start_beats here,
+                 resulting in viewport-like behaviour (the contents maintain
+                 their musical position while the region is stationary).
+
+                 For now, the musical position at the region start is retained, but subsequent events
+                 will maintain their beat distance according to the map.
+               */
+               _start = _position - _session.tempo_map().frame_at_pulse (pulse() - (_start_beats.val().to_double() / 4.0));
+
+               /* _length doesn't change for audio-locked regions. update length_beats to match. */
+               _length_beats = Evoral::Beats (_session.tempo_map().quarter_note_at_frame (_position + _length) - _session.tempo_map().quarter_note_at_frame (_position));
+
+               s_and_l.add (Properties::start);
+               s_and_l.add (Properties::length_beats);
+
+               send_change  (s_and_l);
+               return;
+       }
+
+       Region::update_after_tempo_map_change (false);
+
+       /* _start has now been updated. */
+       _length = _session.tempo_map().frame_at_pulse (pulse() + (_length_beats.val().to_double() / 4.0)) - _position;
 
-       /* _position has now been updated for the new tempo map */
-       _start = _position - _session.tempo_map().framepos_minus_beats (_position, _start_beats);
+       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 (Properties::start);
+       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_qn_at_frame (_position + _length, sub_num) - (pulse() * 4.0));
 }
 
 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.val() == Evoral::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_pulse (pulse() - (_start_beats.val().to_double() / 4.0));
+
+       /* in construction from src */
+       if (_length_beats == Evoral::Beats()) {
+               update_length_beats (sub_num);
+       }
+
+       if (position_lock_style() == AudioTime) {
+               _length_beats = Evoral::Beats (_session.tempo_map().quarter_note_at_frame (_position + _length) - _session.tempo_map().quarter_note_at_frame (_position));
+       } else {
                /* 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
+                  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_length_internal (_session.tempo_map().frame_at_pulse (pulse() + (_length_beats.val().to_double() / 4.0)) - _position, sub_num);
        }
 }
 
@@ -233,18 +321,24 @@ framecnt_t
 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out,
                      framepos_t                     position,
                      framecnt_t                     dur,
+                     Evoral::Range<framepos_t>*     loop_range,
                      uint32_t                       chan_n,
                      NoteMode                       mode,
                      MidiStateTracker*              tracker,
                      MidiChannelFilter*             filter) const
 {
-       return _read_at (_sources, out, position, dur, chan_n, mode, tracker, filter);
+       return _read_at (_sources, out, position, dur, loop_range, chan_n, mode, tracker, filter);
 }
 
 framecnt_t
-MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
+MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out,
+                            framepos_t                  position,
+                            framecnt_t                  dur,
+                            Evoral::Range<framepos_t>*  loop_range,
+                            uint32_t                    chan_n,
+                            NoteMode                    mode) const
 {
-       return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
+       return _read_at (_master_sources, out, position, dur, loop_range, chan_n, mode); /* no tracker */
 }
 
 framecnt_t
@@ -252,6 +346,7 @@ MidiRegion::_read_at (const SourceList&              /*srcs*/,
                       Evoral::EventSink<framepos_t>& dst,
                       framepos_t                     position,
                       framecnt_t                     dur,
+                      Evoral::Range<framepos_t>*     loop_range,
                       uint32_t                       chan_n,
                       NoteMode                       mode,
                       MidiStateTracker*              tracker,
@@ -291,25 +386,34 @@ MidiRegion::_read_at (const SourceList&              /*srcs*/,
 
        src->set_note_mode(lm, mode);
 
-       /*
-         cerr << "MR " << name () << " read @ " << position << " * " << to_read
-         << " _position = " << _position
-         << " _start = " << _start
-         << " intoffset = " << internal_offset
-         << endl;
-       */
+#if 0
+       cerr << "MR " << name () << " read @ " << position << " + " << to_read
+            << " dur was " << dur
+            << " len " << _length
+            << " l-io " << (_length - internal_offset)
+            << " _position = " << _position
+            << " _start = " << _start
+            << " intoffset = " << internal_offset
+            << " pulse = " << pulse()
+            << " start_pulse = " << start_pulse()
+            << " start_beat = " << _start_beats
+            << endl;
+#endif
 
        /* 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,
-                       filter,
-                       _filtered_parameters
+                   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
+                   loop_range,
+                   tracker,
+                   filter,
+                   _filtered_parameters,
+                   pulse(),
+                   _start_beats.val().to_double()
                    ) != to_read) {
                return 0; /* "read nothing" */
        }
@@ -329,7 +433,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;
@@ -393,6 +500,23 @@ MidiRegion::midi_source (uint32_t n) const
        return boost::dynamic_pointer_cast<MidiSource>(source(n));
 }
 
+/* don't use this. hopefully it will go away.
+   currently used by headless-chicken session utility.
+*/
+void
+MidiRegion::clobber_sources (boost::shared_ptr<MidiSource> s)
+{
+       drop_sources();
+
+       _sources.push_back (s);
+       s->inc_use_count ();
+       _master_sources.push_back (s);
+       s->inc_use_count ();
+
+       s->DropReferences.connect_same_thread (*this, boost::bind (&Region::source_deleted, this, boost::weak_ptr<Source>(s)));
+
+}
+
 void
 MidiRegion::model_changed ()
 {
@@ -458,17 +582,82 @@ MidiRegion::fix_negative_start ()
        _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 ();
+       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_pulse = _session.tempo_map().exact_qn_at_frame (position, sub_num) / 4.0;
+       const double pulse_delta = pos_pulse - pulse();
+
+       /* 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) {
+               /* sets _beat to new position.*/
+               set_position_internal (position, true, sub_num);
+               what_changed.add (Properties::position);
+
+               const double new_start_pulse = (_start_beats.val().to_double() / 4.0) + pulse_delta;
+               const framepos_t new_start = _position - _session.tempo_map().frame_at_pulse (pulse() - new_start_pulse);
+
+               if (!verify_start_and_length (new_start, length)) {
+                       return;
+               }
+
+               _start_beats = Evoral::Beats (new_start_pulse * 4.0);
+               what_changed.add (Properties::start_beats);
+
+               set_start_internal (new_start, sub_num);
+               what_changed.add (Properties::start);
+       }
+
+       if (_length != length) {
+
+               if (!verify_start_and_length (_start, length)) {
+                       return;
+               }
+
+               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);
+       }
 }