midway snapshot of work done on managing Region & Source lifetimes correctly. may...
[ardour.git] / libs / ardour / session.cc
index 4ba092dd91d724ae4b7774b5372a1ccc7efbb159..91b1e2a0f95465e1e7c2a8087b199add54fd4b11 100644 (file)
@@ -17,6 +17,9 @@
 
 */
 
+#define __STDC_LIMIT_MACROS
+#include <stdint.h>
+
 #include <algorithm>
 #include <string>
 #include <vector>
@@ -93,6 +96,7 @@
 #include "ardour/tape_file_matcher.h"
 #include "ardour/tempo.h"
 #include "ardour/utils.h"
+#include "ardour/graph.h"
 
 #include "midi++/jack.h"
 
@@ -141,6 +145,7 @@ Session::Session (AudioEngine &eng,
          _butler (new Butler (*this)),
          _post_transport_work (0),
          _send_timecode_update (false),
+         route_graph (new Graph(*this)),
          routes (new RouteList),
          _total_free_4k_blocks (0),
          _bundles (new BundleList),
@@ -169,7 +174,7 @@ Session::Session (AudioEngine &eng,
         _is_new = !Glib::file_test (_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR));
 
        if (_is_new) {
-               if (create (mix_template, compute_initial_length(), bus_profile)) {
+               if (create (mix_template, bus_profile)) {
                        destroy ();
                        throw failed_constructor ();
                }
@@ -697,13 +702,7 @@ Session::hookup_io ()
 void
 Session::playlist_length_changed ()
 {
-       /* we can't just increase session_range_location->end() if pl->get_maximum_extent()
-          if larger. if the playlist used to be the longest playlist,
-          and its now shorter, we have to decrease session_range_location->end(). hence,
-          we have to iterate over all diskstreams and check the
-          playlists currently in use.
-       */
-       find_current_end ();
+       update_session_range_location_marker ();
 }
 
 void
@@ -720,8 +719,7 @@ Session::track_playlist_changed (boost::weak_ptr<Track> wp)
                playlist->LengthChanged.connect_same_thread (*this, boost::bind (&Session::playlist_length_changed, this));
        }
 
-       /* see comment in playlist_length_changed () */
-       find_current_end ();
+       update_session_range_location_marker ();
 }
 
 bool
@@ -1328,6 +1326,8 @@ Session::resort_routes ()
                /* writer goes out of scope and forces update */
        }
 
+       //route_graph->dump(1);
+
 #ifndef NDEBUG
         boost::shared_ptr<RouteList> rl = routes.reader ();
         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
@@ -1381,10 +1381,13 @@ Session::resort_routes_using (shared_ptr<RouteList> r)
        RouteSorter cmp;
        r->sort (cmp);
 
+       route_graph->rechain( 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 signal order %2\n", (*i)->name(), (*i)->order_key ("signal")));
+               DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 signal order %2\n", 
+                                                           (*i)->name(), (*i)->order_key ("signal")));
        }
 #endif
 
@@ -1481,6 +1484,7 @@ Session::new_midi_track (TrackMode mode, RouteGroup* route_group, uint32_t how_m
                        auto_connect_route (track, existing_inputs, existing_outputs);
 
                        track->non_realtime_input_change();
+
                        if (route_group) {
                                route_group->add (track);
                        }
@@ -1538,9 +1542,6 @@ Session::auto_connect_route (boost::shared_ptr<Route> route,
                ? ChanCount::max(existing_inputs, existing_outputs)
                : existing_outputs;
 
-       static string empty_string;
-       string& port = empty_string;
-
        for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
                vector<string> physinputs;
                vector<string> physoutputs;
@@ -1551,7 +1552,7 @@ Session::auto_connect_route (boost::shared_ptr<Route> route,
                if (!physinputs.empty()) {
                        uint32_t nphysical_in = physinputs.size();
                        for (uint32_t i = 0; i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
-                               port = empty_string;
+                               string port;
 
                                if (Config->get_input_auto_connect() & AutoConnectPhysical) {
                                        port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
@@ -1567,7 +1568,7 @@ Session::auto_connect_route (boost::shared_ptr<Route> route,
                if (!physoutputs.empty()) {
                        uint32_t nphysical_out = physoutputs.size();
                        for (uint32_t i = 0; i < route->n_outputs().get(*t); ++i) {
-                               port = empty_string;
+                               string port;
 
                                if (Config->get_output_auto_connect() & AutoConnectPhysical) {
                                        port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
@@ -1824,13 +1825,19 @@ Session::new_route_from_template (uint32_t how_many, const std::string& template
                        /*NOTREACHED*/
                }
 
-               IO::set_name_in_state (*node_copy.children().front(), name);
+               /* set IO children to use the new name */
+               XMLNodeList const & children = node_copy.children ();
+               for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
+                       if ((*i)->name() == IO::state_node_name) {
+                               IO::set_name_in_state (**i, name);
+                       }
+               }
 
                Track::zero_diskstream_id_in_xml (node_copy);
 
                try {
                        shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
-           
+
                        if (route == 0) {
                                error << _("Session: cannot create track/bus from template description") << endmsg;
                                goto out;
@@ -1899,6 +1906,7 @@ Session::add_routes (RouteList& new_routes, bool save)
 
                r->listen_changed.connect_same_thread (*this, boost::bind (&Session::route_listen_changed, this, _1, wpr));
                r->solo_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2, wpr));
+               r->solo_isolated_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, _1, wpr));
                r->mute_changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this, _1));
                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));
@@ -2041,6 +2049,10 @@ Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::
 void
 Session::remove_route (shared_ptr<Route> route)
 {
+        if (((route == _master_out) || (route == _monitor_out)) && !Config->get_allow_special_bus_removal()) {
+                return;
+        }
+
        {
                RCUWriter<RouteList> writer (routes);
                shared_ptr<RouteList> rs = writer.get_copy ();
@@ -2067,14 +2079,13 @@ Session::remove_route (shared_ptr<Route> route)
                        _monitor_out.reset ();
                }
 
-               update_route_solo_state ();
-
                /* writer goes out of scope, forces route list update */
        }
+        
+        update_route_solo_state ();
+       update_session_range_location_marker ();
 
-       find_current_end ();
-
-       // We need to disconnect the routes inputs and outputs
+       // We need to disconnect the route's inputs and outputs
 
        route->input()->disconnect (0);
        route->output()->disconnect (0);
@@ -2131,12 +2142,55 @@ Session::route_listen_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
        }
 
        if (route->listening()) {
+
+                if (Config->get_exclusive_solo()) {
+                        /* new listen: disable all other listen */
+                        shared_ptr<RouteList> r = routes.reader ();
+                        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+                                if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
+                                        continue;
+                                } 
+                                (*i)->set_listen (false, this);
+                        }
+                }
+
                _listen_cnt++;
+
        } else if (_listen_cnt > 0) {
+
                _listen_cnt--;
        }
 }
+void
+Session::route_solo_isolated_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
+{
+       boost::shared_ptr<Route> route = wpr.lock ();
+
+       if (!route) {
+               /* should not happen */
+               error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_changed")) << endmsg;
+               return;
+       }
+        
+        bool send_changed = false;
 
+        if (route->solo_isolated()) {
+                if (_solo_isolated_cnt == 0) {
+                        send_changed = true;
+                }
+                _solo_isolated_cnt++;
+        } else if (_solo_isolated_cnt > 0) {
+                _solo_isolated_cnt--;
+                if (_solo_isolated_cnt == 0) {
+                        send_changed = true;
+                }
+        }
+
+        if (send_changed) {
+                IsolatedChanged (); /* EMIT SIGNAL */
+        }
+}
+            
 void
 Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_ptr<Route> wpr)
 {
@@ -2157,7 +2211,7 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_changed")) << endmsg;
                return;
        }
-
+        
        shared_ptr<RouteList> r = routes.reader ();
        int32_t delta;
 
@@ -2166,23 +2220,21 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
        } else {
                delta = -1;
        }
+        if (delta == 1 && Config->get_exclusive_solo()) {
+                /* new solo: disable all other solos */
+                for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+                        if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
+                                continue;
+                        } 
+                        (*i)->set_solo (false, this);
+                }
+        }
 
        solo_update_disabled = true;
-
-        /*
-
-           solo a route:
-              for anything in the signal path for this route, increment its soloed-by-other count
-              for anything not in the signal path for this route, increment its muted-by-other count
-
-           unsolo a route:
-              for anything in the signal path for this route, decrement its soloed-by-other count
-              for anything not in the signal path for this route, decrement its muted-by-other count
-
-        */
-
+        
         RouteList uninvolved;
-
+        
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                bool via_sends_only;
                 bool in_signal_flow;
@@ -2193,42 +2245,36 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
 
                 in_signal_flow = false;
 
-                /* feed-backwards (other route to solo change route):
-
-                        if (*i) feeds the one whose solo status changed 
-                             it should be soloed by other if the change was -> solo OR de-soloed by other if change was -> !solo
-                        else 
-                             do nothing
-                            
-                 */
-
                 if ((*i)->feeds (route, &via_sends_only)) {
                        if (!via_sends_only) {
-                               (*i)->mod_solo_by_others (delta);
+                                if (!route->soloed_by_others_upstream()) {
+                                        (*i)->mod_solo_by_others_downstream (delta);
+                                }
                                 in_signal_flow = true;
                        }
                } 
                 
-                /* feed-forward (solo change route to other routes):
-                    
-                      if the route whose solo status changed feeds (*i)
-                             do nothing
-                      else 
-                             mute if the change was -> solo OR demute if change was -> !solo
-                 */
-
                 if (route->feeds (*i, &via_sends_only)) {
-                        (*i)->mod_solo_by_others (delta);
+                        (*i)->mod_solo_by_others_upstream (delta);
                         in_signal_flow = true;
                 }
-                
+
                 if (!in_signal_flow) {
-                        (*i)->mod_muted_by_others (delta);
+                        uninvolved.push_back (*i);
                 }
        }
 
        solo_update_disabled = false;
        update_route_solo_state (r);
+
+        /* now notify that the mute state of the routes not involved in the signal
+           pathway of the just-solo-changed route may have altered.
+        */
+
+        for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
+                (*i)->mute_changed (this);
+        }
+
        SoloChanged (); /* EMIT SIGNAL */
        set_dirty();
 }
@@ -2240,6 +2286,7 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
 
        bool something_soloed = false;
         uint32_t listeners = 0;
+        uint32_t isolated = 0;
 
        if (!r) {
                r = routes.reader();
@@ -2248,7 +2295,6 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_hidden() && (*i)->self_soloed()) {
                        something_soloed = true;
-                       break;
                }
 
                 if (!(*i)->is_hidden() && (*i)->listening()) {
@@ -2258,6 +2304,10 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
                                 (*i)->set_listen (false, this);
                         }
                 }
+
+                if ((*i)->solo_isolated()) {
+                        isolated++;
+                }
        }
 
         if (something_soloed != _non_soloed_outs_muted) {
@@ -2265,8 +2315,11 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
                 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
         }
 
-        if (listeners) {
-                 _listen_cnt = listeners;
+        _listen_cnt = listeners;
+
+        if (isolated != _solo_isolated_cnt) {
+                _solo_isolated_cnt = isolated;
+                IsolatedChanged (); /* EMIT SIGNAL */
         }
 }
 
@@ -2344,43 +2397,64 @@ Session::route_by_remote_id (uint32_t id)
        return shared_ptr<Route> ((Route*) 0);
 }
 
+/** If either end of the session range location marker lies inside the current
+ *  session extent, move it to the corresponding session extent.
+ */
 void
-Session::find_current_end ()
+Session::update_session_range_location_marker ()
 {
        if (_state_of_the_state & Loading) {
                return;
        }
 
-       nframes_t max = get_maximum_extent ();
+       pair<nframes_t, nframes_t> const ext = get_extent ();
 
-       if (max > _session_range_location->end()) {
-               _session_range_location->set_end (max);
-               set_dirty();
-               DurationChanged(); /* EMIT SIGNAL */
+       if (_session_range_location == 0) {
+               /* we don't have a session range yet; use this one (provided it is valid) */
+               if (ext.first != max_frames) {
+                       add_session_range_location (ext.first, ext.second);
+               }
+       } else {
+               /* update the existing session range */
+               if (ext.first < _session_range_location->start()) {
+                       _session_range_location->set_start (ext.first);
+                       set_dirty ();
+               }
+               
+               if (ext.second > _session_range_location->end()) {
+                       _session_range_location->set_end (ext.second);
+                       set_dirty ();
+               }
+               
        }
 }
 
-nframes_t
-Session::get_maximum_extent () const
+/** @return Extent of the session's contents; if the session is empty, the first value of
+ *  the pair will equal max_frames.
+ */
+pair<nframes_t, nframes_t>
+Session::get_extent () const
 {
-       nframes_t max = 0;
-       nframes_t me;
+       pair<nframes_t, nframes_t> ext (max_frames, 0);
        
        boost::shared_ptr<RouteList> rl = routes.reader ();
        for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
                boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
                if (!tr || tr->destructive()) {
-                       //ignore tape tracks when getting max extents
+                       // ignore tape tracks when getting extents
                        continue;
                }
-               
-               boost::shared_ptr<Playlist> pl = tr->playlist();
-               if ((me = pl->get_maximum_extent()) > max) {
-                       max = me;
+
+               pair<nframes_t, nframes_t> e = tr->playlist()->get_extent ();
+               if (e.first < ext.first) {
+                       ext.first = e.first;
+               }
+               if (e.second > ext.second) {
+                       ext.second = e.second;
                }
        }
 
-       return max;
+       return ext;
 }
 
 /* Region management */
@@ -2410,46 +2484,58 @@ Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
 }
 
 int
-Session::destroy_region (boost::shared_ptr<Region> region)
+Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
 {
-       vector<boost::shared_ptr<Source> > srcs;
-
-       {
-               if (region->playlist()) {
-                       region->playlist()->destroy_region (region);
-               }
+        set<boost::shared_ptr<Region> > relevant_regions;
 
-               for (uint32_t n = 0; n < region->n_channels(); ++n) {
-                       srcs.push_back (region->source (n));
-               }
+       for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
+                RegionFactory::get_regions_using_source (*s, relevant_regions);
        }
 
-       region->drop_references ();
+        cerr << "There are " << relevant_regions.size() << " using " << srcs.size() << " sources" << endl;
+
+        for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
+                set<boost::shared_ptr<Region> >::iterator tmp;
+
+                tmp = r;
+                ++tmp;
 
-       for (vector<boost::shared_ptr<Source> >::iterator i = srcs.begin(); i != srcs.end(); ++i) {
+                cerr << "Cleanup " << (*r)->name() << " UC = " << (*r).use_count() << endl;
 
-                (*i)->mark_for_remove ();
-                (*i)->drop_references ();
+                playlists->destroy_region (*r);
+                RegionFactory::map_remove (*r);
+
+                (*r)->drop_sources ();
+                (*r)->drop_references ();
+
+                cerr << "\tdone UC = " << (*r).use_count() << endl;
+
+                relevant_regions.erase (r);
+
+                r = tmp;
+        }
+
+       for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
                 
-                cerr << "source was not used by any playlist\n";
-       }
+                {
+                        Glib::Mutex::Lock ls (source_lock);
+                        /* remove from the main source list */
+                        sources.erase ((*s)->id());
+                }
 
-       return 0;
-}
+                (*s)->mark_for_remove ();
+                (*s)->drop_references ();
+
+                s = srcs.erase (s);
+        }
 
-int
-Session::destroy_regions (list<boost::shared_ptr<Region> > regions)
-{
-       for (list<boost::shared_ptr<Region> >::iterator i = regions.begin(); i != regions.end(); ++i) {
-               destroy_region (*i);
-       }
        return 0;
 }
 
 int
 Session::remove_last_capture ()
 {
-       list<boost::shared_ptr<Region> > r;
+       list<boost::shared_ptr<Source> > srcs;
 
        boost::shared_ptr<RouteList> rl = routes.reader ();
        for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
@@ -2458,15 +2544,15 @@ Session::remove_last_capture ()
                        continue;
                }
                
-               list<boost::shared_ptr<Region> >& l = tr->last_capture_regions();
+               list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
 
                if (!l.empty()) {
-                       r.insert (r.end(), l.begin(), l.end());
+                       srcs.insert (srcs.end(), l.begin(), l.end());
                        l.clear ();
                }
        }
 
-       destroy_regions (r);
+       destroy_sources (srcs);
 
        save_state (_current_snapshot_name);
 
@@ -2490,16 +2576,19 @@ Session::add_source (boost::shared_ptr<Source> source)
        }
 
        if (result.second) {
-               set_dirty();
-       }
 
-       boost::shared_ptr<AudioFileSource> afs;
+                /* yay, new source */
 
-       if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
-               if (Config->get_auto_analyse_audio()) {
-                       Analyser::queue_source_for_analysis (source, false);
-               }
-       }
+               set_dirty();
+
+                boost::shared_ptr<AudioFileSource> afs;
+                
+                if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
+                        if (Config->get_auto_analyse_audio()) {
+                                Analyser::queue_source_for_analysis (source, false);
+                        }
+                }
+        }
 }
 
 void
@@ -3641,12 +3730,6 @@ Session::add_automation_list(AutomationList *al)
        automation_lists[al->id()] = al;
 }
 
-nframes_t
-Session::compute_initial_length ()
-{
-       return _engine.frame_rate() * 60 * 5;
-}
-
 void
 Session::sync_order_keys (std::string const & base)
 {
@@ -3786,3 +3869,62 @@ Session::get_routes_with_regions_at (nframes64_t const p) const
 
        return rl;
 }
+
+void
+Session::goto_end ()
+{
+       if (_session_range_location) {
+               request_locate (_session_range_location->end(), false);
+       } else {
+               request_locate (0, false);
+       }
+}
+
+void
+Session::goto_start ()
+{
+       if (_session_range_location) {
+               request_locate (_session_range_location->start(), false);
+       } else {
+               request_locate (0, false);
+       }
+}
+
+void
+Session::set_session_start (nframes_t start)
+{
+       if (_session_range_location) {
+               _session_range_location->set_start (start);
+       } else {
+               add_session_range_location (start, start);
+       }
+}
+             
+void
+Session::set_session_end (nframes_t end)
+{
+       if (_session_range_location) {
+               _session_range_location->set_end (end);
+       } else {
+               add_session_range_location (end, end);
+       }
+}
+
+nframes_t
+Session::current_start_frame () const
+{
+       return _session_range_location ? _session_range_location->start() : 0;
+}
+
+nframes_t
+Session::current_end_frame () const
+{
+       return _session_range_location ? _session_range_location->end() : 0;
+}
+
+void
+Session::add_session_range_location (nframes_t start, nframes_t end)
+{
+       _session_range_location = new Location (start, end, _("session"), Location::IsSessionRange);
+       _locations.add (_session_range_location);
+}