fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / session.cc
index 8856d9d3233503957bfccc32ce00865d677b0ca5..61bfce14b6bfc995f0203b44e42bdf17652e60d8 100644 (file)
@@ -90,6 +90,7 @@
 #include "ardour/recent_sessions.h"
 #include "ardour/region.h"
 #include "ardour/region_factory.h"
+#include "ardour/revision.h"
 #include "ardour/route_graph.h"
 #include "ardour/route_group.h"
 #include "ardour/send.h"
 
 #include "LuaBridge/LuaBridge.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #include <glibmm/checksum.h>
 
@@ -177,6 +178,7 @@ Session::Session (AudioEngine &eng,
        , _record_status (Disabled)
        , _transport_frame (0)
        , _session_range_location (0)
+       , _session_range_end_is_free (true)
        , _slave (0)
        , _silent (false)
        , _transport_speed (0)
@@ -211,7 +213,9 @@ Session::Session (AudioEngine &eng,
        , post_export_position (0)
        , _exporting (false)
        , _export_rolling (false)
+       , _realtime_export (false)
        , _export_preroll (0)
+       , _export_latency (0)
        , _pre_export_mmc_enabled (false)
        , _name (snapshot_name)
        , _is_new (true)
@@ -236,7 +240,7 @@ Session::Session (AudioEngine &eng,
        , pending_locate_flush (false)
        , pending_abort (false)
        , pending_auto_loop (false)
-       , _mempool ("Session", 1048576)
+       , _mempool ("Session", 2097152)
        , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
        , _n_lua_scripts (0)
        , _butler (new Butler (*this))
@@ -248,6 +252,7 @@ Session::Session (AudioEngine &eng,
        , _rt_thread_active (false)
        , _rt_emit_pending (false)
        , _ac_thread_active (false)
+       , _latency_recompute_pending (0)
        , step_speed (0)
        , outbound_mtc_timecode_frame (0)
        , next_quarter_frame_to_send (-1)
@@ -316,6 +321,8 @@ Session::Session (AudioEngine &eng,
 {
        uint32_t sr = 0;
 
+       created_with = string_compose ("%1 %2", PROGRAM_NAME, revision);
+
        pthread_mutex_init (&_rt_emit_mutex, 0);
        pthread_cond_init (&_rt_emit_cond, 0);
 
@@ -1311,8 +1318,12 @@ Session::reset_monitor_section ()
        _master_out->output()->disconnect (this);
        _monitor_out->output()->disconnect (this);
 
-       _monitor_out->input()->ensure_io (_master_out->output()->n_ports(), false, this);
-       _monitor_out->output()->ensure_io (_master_out->output()->n_ports(), false, this);
+       // monitor section follow master bus - except midi
+       ChanCount mon_chn (_master_out->output()->n_ports());
+       mon_chn.set_midi (0);
+
+       _monitor_out->input()->ensure_io (mon_chn, false, this);
+       _monitor_out->output()->ensure_io (mon_chn, false, this);
 
        for (uint32_t n = 0; n < limit; ++n) {
                boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
@@ -1942,7 +1953,7 @@ void
 Session::set_all_tracks_record_enabled (bool enable )
 {
        boost::shared_ptr<RouteList> rl = routes.reader();
-       set_controls (route_list_to_control_list (rl, &Track::rec_enable_control), enable, Controllable::NoGroup);
+       set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), enable, Controllable::NoGroup);
 }
 
 void
@@ -2019,59 +2030,55 @@ framepos_t
 Session::audible_frame () const
 {
        framepos_t ret;
-       framepos_t tf;
-       framecnt_t offset;
 
-       offset = worst_playback_latency ();
+       frameoffset_t offset = worst_playback_latency (); // - _engine.samples_since_cycle_start ();
+       offset *= transport_speed ();
 
        if (synced_to_engine()) {
                /* Note: this is basically just sync-to-JACK */
-               tf = _engine.transport_frame();
+               ret = _engine.transport_frame();
        } else {
-               tf = _transport_frame;
+               ret = _transport_frame;
        }
 
-       ret = tf;
-
-       if (!non_realtime_work_pending()) {
-
-               /* MOVING */
+       if (transport_rolling()) {
+               ret -= offset;
 
                /* Check to see if we have passed the first guaranteed
-                  audible frame past our last start position. if not,
-                  return that last start point because in terms
-                  of audible frames, we have not moved yet.
-
-                  `Start position' in this context means the time we last
-                  either started, located, or changed transport direction.
-               */
+                * audible frame past our last start position. if not,
+                * return that last start point because in terms
+                * of audible frames, we have not moved yet.
+                *
+                * `Start position' in this context means the time we last
+                * either started, located, or changed transport direction.
+                */
 
                if (_transport_speed > 0.0f) {
 
                        if (!play_loop || !have_looped) {
-                               if (tf < _last_roll_or_reversal_location + offset) {
+                               if (ret < _last_roll_or_reversal_location) {
                                        return _last_roll_or_reversal_location;
                                }
+                       } else {
+                               // latent loops
+                               Location *location = _locations->auto_loop_location();
+                               frameoffset_t lo = location->start() - ret;
+                               if (lo > 0) {
+                                       ret = location->end () - lo;
+                               }
                        }
 
-
-                       /* forwards */
-                       ret -= offset;
-
                } else if (_transport_speed < 0.0f) {
 
                        /* XXX wot? no backward looping? */
 
-                       if (tf > _last_roll_or_reversal_location - offset) {
+                       if (ret > _last_roll_or_reversal_location) {
                                return _last_roll_or_reversal_location;
-                       } else {
-                               /* backwards */
-                               ret += offset;
                        }
                }
        }
 
-       return ret;
+       return std::max ((framepos_t)0, ret);
 }
 
 void
@@ -2305,7 +2312,7 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
 #ifndef NDEBUG
                DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
                for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-                       DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().global_order()));
+                       DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().order()));
                }
 #endif
 
@@ -2423,8 +2430,9 @@ Session::default_track_name_pattern (DataType t)
  *  @param instrument plugin info for the instrument to insert pre-fader, if any
  */
 list<boost::shared_ptr<MidiTrack> >
-Session::new_midi_track (boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
-                         RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order, 
+Session::new_midi_track (const ChanCount& input, const ChanCount& output,
+                         boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
+                         RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
                          TrackMode mode)
 {
        string track_name;
@@ -2539,7 +2547,7 @@ Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name
                        error << "cannot find name for new midi bus" << endmsg;
                        goto failure;
                }
-               
+
                try {
                        boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
 
@@ -2572,6 +2580,7 @@ Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name
                                route_group->add (bus);
                        }
 
+                       bus->add_internal_return ();
                        ret.push_back (bus);
                }
 
@@ -2920,24 +2929,28 @@ Session::reconnect_mmc_ports(bool inputs)
 #endif
 
 void
-Session::ensure_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
+Session::ensure_route_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
 {
        if (first_new_order == PresentationInfo::max_order) {
                /* adding at end, no worries */
                return;
        }
 
-       /* create a gap in the existing route order keys to accomodate new routes.*/
-       boost::shared_ptr <RouteList> rd = routes.reader();
-       for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
-               boost::shared_ptr<Route> rt (*ri);
+       /* create a gap in the presentation info to accomodate @param how_many
+        * new objects.
+        */
+       StripableList sl;
+       get_stripables (sl);
+
+       for (StripableList::iterator si = sl.begin(); si != sl.end(); ++si) {
+               boost::shared_ptr<Stripable> s (*si);
 
-               if (rt->presentation_info().special()) {
+               if (s->is_monitor() || s->is_auditioner()) {
                        continue;
                }
 
-               if (rt->presentation_info().group_order () >= first_new_order) {
-                       rt->set_presentation_group_order (rt->presentation_info().group_order () + how_many);
+               if (s->presentation_info().order () >= first_new_order) {
+                       s->set_presentation_order (s->presentation_info().order () + how_many);
                }
        }
 }
@@ -3070,8 +3083,6 @@ Session::new_audio_route (int input_channels, int output_channels, RouteGroup* r
 
        bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
 
-       ensure_presentation_info_gap (order, how_many);
-
        while (how_many) {
                if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
                        error << "cannot find name for new audio bus" << endmsg;
@@ -3256,6 +3267,10 @@ Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::s
                                                (*i)->add_property ("bitslot", buf);
                                                (*i)->add_property ("name", name);
                                        }
+                                       else if (type && type->value() == X_("intreturn")) {
+                                               (*i)->remove_property (X_("bitslot"));
+                                               (*i)->add_property ("ignore-bitslot", "1");
+                                       }
                                        else if (type && type->value() == X_("return")) {
                                                // Return::set_state() generates a new one
                                                (*i)->remove_property (X_("bitslot"));
@@ -3390,7 +3405,7 @@ Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool
        }
 
        DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
-       ensure_presentation_info_gap (order, new_routes.size());
+       ensure_route_presentation_info_gap (order, new_routes.size());
 
        for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
 
@@ -3403,6 +3418,7 @@ Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool
 
                r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
                r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
+               r->processor_latency_changed.connect_same_thread (*this, boost::bind (&Session::queue_latency_recompute, this));
 
                if (r->is_master()) {
                        _master_out = r;
@@ -3431,27 +3447,31 @@ Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool
 
                        /* presentation info order may already have been set from XML */
 
-                       if (r->presentation_info().unordered()) {
+                       if (!r->presentation_info().order_set()) {
 
                                if (order == PresentationInfo::max_order) {
                                        /* just add to the end */
-                                       r->set_presentation_group_order_explicit (n_routes + added);
+                                       r->set_presentation_order (n_routes + added, false);
                                        DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
                                } else {
-                                       r->set_presentation_group_order_explicit (order + added);
+                                       r->set_presentation_order (order + added);
                                        DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
                                }
                        } else {
-                               DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().group_order()));
+                               DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().order()));
                        }
                }
 
-               DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 global order %3 type %4 (summary: %5)\n",
+#if !defined(__APPLE__) && !defined(__FreeBSD__)
+               /* clang complains: 'operator<<' should be declared prior to the call site or in an associated namespace of one of its
+                * arguments std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid)"
+                */
+               DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 type %3 (summary: %4)\n",
                                                               r->name(),
-                                                              r->presentation_info().group_order(),
-                                                              r->presentation_info().global_order(),
+                                                              r->presentation_info().order(),
                                                               enum_2_string (r->presentation_info().flags()),
-                                                              r->presentation_info().to_string()));
+                                                              r->presentation_info()));
+#endif
 
 
                if (input_auto_connect || output_auto_connect) {
@@ -3476,6 +3496,8 @@ Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool
                        }
                }
        }
+
+       reassign_track_numbers ();
 }
 
 void
@@ -3669,7 +3691,7 @@ Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
                return;
        }
 
-       Stripable::PresentationInfoChange(); /* EMIT SIGNAL */
+       PresentationInfo::Change(); /* EMIT SIGNAL */
 
        /* save the new state of the world */
 
@@ -3877,6 +3899,8 @@ Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlD
 
                if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
                        /* route does not get solo propagated to it */
+                       DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 excluded from solo because iso = %2 can_solo = %3\n", (*i)->name(), (*i)->solo_isolate_control()->solo_isolated(),
+                                                                 (*i)->can_solo()));
                        continue;
                }
 
@@ -4013,6 +4037,16 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
                                                  something_soloed, listeners, isolated));
 }
 
+void
+Session::get_stripables (StripableList& sl) const
+{
+       boost::shared_ptr<RouteList> r = routes.reader ();
+       sl.insert (sl.end(), r->begin(), r->end());
+
+       VCAList v = _vca_manager->vcas ();
+       sl.insert (sl.end(), v.begin(), v.end());
+}
+
 boost::shared_ptr<RouteList>
 Session::get_routes_with_internal_returns() const
 {
@@ -4195,30 +4229,48 @@ Session::track_by_diskstream_id (PBD::ID id) const
 }
 
 boost::shared_ptr<Route>
-Session::get_remote_nth_route (uint16_t n) const
+Session::get_remote_nth_route (PresentationInfo::order_t n) const
 {
        return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
 }
 
 boost::shared_ptr<Stripable>
-Session::get_remote_nth_stripable (uint16_t n, PresentationInfo::Flag flags) const
+Session::get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag flags) const
 {
-       boost::shared_ptr<RouteList> r = routes.reader ();
-       vector<boost::shared_ptr<Route> > v;
+       StripableList sl;
+       PresentationInfo::order_t match_cnt = 0;
 
-       if (n > r->size()) {
-               return boost::shared_ptr<Route> ();
-       }
+       get_stripables (sl);
+       sl.sort (Stripable::PresentationOrderSorter());
 
-       v.assign (r->size(), boost::shared_ptr<Route>());
+       for (StripableList::const_iterator s = sl.begin(); s != sl.end(); ++s) {
 
-       for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-               if ((*i)->presentation_info().flag_match (flags)) {
-                       v[(*i)->presentation_info().group_order()] = (*i);
+               if ((*s)->presentation_info().hidden()) {
+                       /* if the caller didn't explicitly ask for hidden
+                          stripables, ignore hidden ones. This matches
+                          the semantics of the pre-PresentationOrder
+                          "get by RID" logic of Ardour 4.x and earlier.
+
+                          XXX at some point we should likely reverse
+                          the logic of the flags, because asking for "the
+                          hidden stripables" is not going to be common,
+                          whereas asking for visible ones is normal.
+                       */
+
+                       if (! (flags & PresentationInfo::Hidden)) {
+                               continue;
+                       }
+               }
+
+               if ((*s)->presentation_info().flag_match (flags)) {
+                       if (match_cnt++ == n) {
+                               return *s;
+                       }
                }
        }
 
-       return v[n];
+       /* there is no nth stripable that matches the given flags */
+       return boost::shared_ptr<Stripable>();
 }
 
 boost::shared_ptr<Route>
@@ -4238,11 +4290,11 @@ struct PresentationOrderSorter {
                if (a->presentation_info().special() && !b->presentation_info().special()) {
                        /* a is not ordered, b is; b comes before a */
                        return false;
-               } else if (b->presentation_info().unordered() && !a->presentation_info().unordered()) {
+               } else if (!b->presentation_info().order_set() && a->presentation_info().order_set()) {
                        /* b is not ordered, a is; a comes before b */
                        return true;
                } else {
-                       return a->presentation_info().global_order() < b->presentation_info().global_order();
+                       return a->presentation_info().order() < b->presentation_info().order();
                }
        }
 };
@@ -4280,6 +4332,16 @@ Session::reassign_track_numbers ()
                // trigger GUI re-layout
                config.ParameterChanged("track-name-number");
        }
+
+#ifndef NDEBUG
+       if (DEBUG_ENABLED(DEBUG::OrderKeys)) {
+               boost::shared_ptr<RouteList> rl = routes.reader ();
+               for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
+                       DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 numbered %2\n", (*i)->name(), (*i)->track_number()));
+               }
+       }
+#endif /* NDEBUG */
+
 }
 
 void
@@ -4345,12 +4407,18 @@ Session::maybe_update_session_range (framepos_t a, framepos_t b)
                        _session_range_location->set_start (a);
                }
 
-               if (b > _session_range_location->end()) {
+               if (_session_range_end_is_free && (b > _session_range_location->end())) {
                        _session_range_location->set_end (b);
                }
        }
 }
 
+void
+Session::set_end_is_free (bool yn)
+{
+       _session_range_end_is_free = yn;
+}
+
 void
 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
 {
@@ -5129,6 +5197,7 @@ Session::try_run_lua (pframes_t nframes)
        Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
        if (tm.locked ()) {
                try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
+               lua.collect_garbage_step ();
        }
 }
 
@@ -5138,6 +5207,7 @@ Session::setup_lua ()
 #ifndef NDEBUG
        lua.Print.connect (&_lua_print);
 #endif
+       lua.tweak_rt_gc ();
        lua.do_command (
                        "function ArdourSession ()"
                        "  local self = { scripts = {}, instances = {} }"
@@ -5329,7 +5399,7 @@ Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::
        if (b->is_monitor()) {
                return false;
        }
-       return a->presentation_info() < b->presentation_info();
+       return a->presentation_info().order() < b->presentation_info().order();
 }
 
 bool
@@ -6146,7 +6216,7 @@ Session::solo_control_mode_changed ()
                   the session's saved solo state). So just explicitly turn
                   them all off.
                */
-               set_controls (route_list_to_control_list (get_routes(), &Route::solo_control), 0.0, Controllable::NoGroup);
+               set_controls (route_list_to_control_list (get_routes(), &Stripable::solo_control), 0.0, Controllable::NoGroup);
        }
 }
 
@@ -6676,14 +6746,7 @@ Session::notify_presentation_info_change ()
                return;
        }
 
-       switch (Config->get_remote_model()) {
-       case MixerOrdered:
-               Stripable::PresentationInfoChange (); /* EMIT SIGNAL */
-               break;
-       default:
-               break;
-       }
-
+       PresentationInfo::Change (); /* EMIT SIGNAL */
        reassign_track_numbers();
 
 #ifdef USE_TRACKS_CODE_FEATURES
@@ -6802,6 +6865,16 @@ Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs
        }
 }
 
+void
+Session::queue_latency_recompute ()
+{
+       g_atomic_int_inc (&_latency_recompute_pending);
+       if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
+               pthread_cond_signal (&_auto_connect_cond);
+               pthread_mutex_unlock (&_auto_connect_mutex);
+       }
+}
+
 void
 Session::auto_connect (const AutoConnectRequest& ar)
 {
@@ -6967,7 +7040,32 @@ Session::auto_connect_thread_run ()
                        }
                }
 
+               if (!actively_recording ()) { // might not be needed,
+                       /* this is only used for updating plugin latencies, the
+                        * graph does not change. so it's safe in general.
+                        * BUT..
+                        * .. update_latency_compensation () entails set_capture_offset()
+                        * which calls Diskstream::set_capture_offset () which
+                        * modifies the capture offset... which can be a proplem
+                        * in "prepare_to_stop"
+                        */
+                       while (g_atomic_int_and (&_latency_recompute_pending, 0)) {
+                               update_latency_compensation ();
+                       }
+               }
+
                pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
        }
        pthread_mutex_unlock (&_auto_connect_mutex);
 }
+
+void
+Session::cancel_all_solo ()
+{
+       StripableList sl;
+
+       get_stripables (sl);
+
+       set_controls (stripable_list_to_control_list (sl, &Stripable::solo_control), 0.0, Controllable::NoGroup);
+       clear_all_solo_state (routes.reader());
+}