strict i/o: limit output channels.
[ardour.git] / libs / ardour / session.cc
index 91578c9b179f6dfdad81600549bb86a7ef46e45e..edae568645e8e92634b445eb054a7567b76952e7 100644 (file)
@@ -23,7 +23,6 @@
 #include <string>
 #include <vector>
 #include <sstream>
-#include <fstream>
 #include <cstdio> /* sprintf(3) ... grrr */
 #include <cmath>
 #include <cerrno>
 #include "ardour/engine_state_controller.h"
 #endif
 #include "ardour/filename_extensions.h"
+#include "ardour/gain_control.h"
 #include "ardour/graph.h"
+#include "ardour/luabindings.h"
 #include "ardour/midiport_manager.h"
 #include "ardour/scene_changer.h"
+#include "ardour/midi_patch_manager.h"
 #include "ardour/midi_track.h"
 #include "ardour/midi_ui.h"
 #include "ardour/operations.h"
 #include "midi++/port.h"
 #include "midi++/mmc.h"
 
+#include "LuaBridge/LuaBridge.h"
+
 #include "i18n.h"
 
 #include <glibmm/checksum.h>
@@ -180,9 +184,10 @@ Session::Session (AudioEngine &eng,
        , current_block_size (0)
        , _worst_output_latency (0)
        , _worst_input_latency (0)
-       , _worst_track_latency (0)
+       , _worst_track_latency (0)
        , _have_captured (false)
        , _non_soloed_outs_muted (false)
+       , _listening (false)
        , _listen_cnt (0)
        , _solo_isolated_cnt (0)
        , _writable (false)
@@ -199,8 +204,8 @@ Session::Session (AudioEngine &eng,
        , post_export_sync (false)
        , post_export_position (0)
        , _exporting (false)
-       , _export_started (false)
        , _export_rolling (false)
+       , _export_preroll (0)
        , _pre_export_mmc_enabled (false)
        , _name (snapshot_name)
        , _is_new (true)
@@ -211,7 +216,7 @@ Session::Session (AudioEngine &eng,
        , loop_changing (false)
        , last_loopend (0)
        , _session_dir (new SessionDirectory (fullpath))
-       , _current_snapshot_name (snapshot_name)          
+       , _current_snapshot_name (snapshot_name)
        , state_tree (0)
        , state_was_pending (false)
        , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
@@ -225,6 +230,9 @@ Session::Session (AudioEngine &eng,
        , pending_locate_flush (false)
        , pending_abort (false)
        , pending_auto_loop (false)
+       , _mempool ("Session", 1048576)
+       , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
+       , _n_lua_scripts (0)
        , _butler (new Butler (*this))
        , _post_transport_work (0)
        ,  cumulative_rf_motion (0)
@@ -264,7 +272,6 @@ Session::Session (AudioEngine &eng,
        , _route_deletion_in_progress (false)
        , destructive_index (0)
        , _track_number_decimals(1)
-       , solo_update_disabled (false)
        , default_fade_steepness (0)
        , default_fade_msecs (0)
        , _total_free_4k_blocks (0)
@@ -305,12 +312,14 @@ Session::Session (AudioEngine &eng,
        pthread_cond_init (&_rt_emit_cond, 0);
 
        pre_engine_init (fullpath);
-       
+
+       setup_lua ();
+
        if (_is_new) {
 
                Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
 
-#ifdef USE_TRACKS_CODE_FEATURES                
+#ifdef USE_TRACKS_CODE_FEATURES
                sr = EngineStateController::instance()->get_current_sample_rate();
 #endif
                if (ensure_engine (sr)) {
@@ -318,6 +327,11 @@ Session::Session (AudioEngine &eng,
                        throw SessionException (_("Cannot connect to audio/midi engine"));
                }
 
+               // set samplerate for plugins added early
+               // e.g from templates or MB channelstrip
+               set_block_size (_engine.samples_per_cycle());
+               set_frame_rate (_engine.sample_rate());
+
                if (create (mix_template, bus_profile)) {
                        destroy ();
                        throw SessionException (_("Session initialization failed"));
@@ -334,7 +348,7 @@ Session::Session (AudioEngine &eng,
                 * of a template.
                 */
 
-               if (!mix_template.empty()) { 
+               if (!mix_template.empty()) {
                        if (load_state (_current_snapshot_name)) {
                                throw SessionException (_("Failed to load template/snapshot state"));
                        }
@@ -349,7 +363,7 @@ Session::Session (AudioEngine &eng,
                if (load_state (_current_snapshot_name)) {
                        throw SessionException (_("Failed to load state"));
                }
-       
+
                /* try to get sample rate from XML state so that we
                 * can influence the SR if we set up the audio
                 * engine.
@@ -357,7 +371,7 @@ Session::Session (AudioEngine &eng,
 
                if (state_tree) {
                        const XMLProperty* prop;
-                       if ((prop = state_tree->root()->property (X_("sample-rate"))) != 0) {           
+                       if ((prop = state_tree->root()->property (X_("sample-rate"))) != 0) {
                                sr = atoi (prop->value());
                        }
                }
@@ -399,40 +413,40 @@ Session::Session (AudioEngine &eng,
        _engine.reset_timebase ();
 
 #ifdef USE_TRACKS_CODE_FEATURES
-       
+
        EngineStateController::instance()->set_session(this);
-       
+
        if (_is_new ) {
                if ( ARDOUR::Profile->get_trx () ) {
 
                        /* Waves Tracks: fill session with tracks basing on the amount of inputs.
                         * each available input must have corresponding track when session starts.
                         */
-                       
+
                        uint32_t how_many (0);
-                       
+
                        std::vector<std::string> inputs;
                        EngineStateController::instance()->get_physical_audio_inputs(inputs);
-                       
+
                        how_many = inputs.size();
-                       
+
                        list<boost::shared_ptr<AudioTrack> > tracks;
-                       
-                       // Track names after driver 
+
+                       // Track names after driver
                        if (Config->get_tracks_auto_naming() == NameAfterDriver) {
                                string track_name = "";
                                for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
                                        string track_name;
                                        track_name = inputs[i];
                                        replace_all (track_name, "system:capture", "");
-                                       
+
                                        list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
                                        tracks.insert(tracks.begin(), single_track.front());
-                               }   
+                               }
                        } else { // Default track names
                                tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
                        }
-                       
+
                        if (tracks.size() != how_many) {
                                destroy ();
                                throw failed_constructor ();
@@ -440,7 +454,7 @@ Session::Session (AudioEngine &eng,
                }
        }
 #endif
-       
+
        _is_new = false;
        session_loaded ();
 
@@ -449,9 +463,9 @@ Session::Session (AudioEngine &eng,
 
 Session::~Session ()
 {
-#ifdef PT_TIMING       
+#ifdef PT_TIMING
        ST.dump ("ST.dump");
-#endif 
+#endif
        destroy ();
 }
 
@@ -494,7 +508,7 @@ Session::immediately_post_engine ()
         * know that the engine is running, but before we either create a
         * session or set state for an existing one.
         */
-        
+
        if (how_many_dsp_threads () > 1) {
                /* For now, only create the graph if we are using >1 DSP threads, as
                   it is a bit slower than the old code with 1 thread.
@@ -545,12 +559,22 @@ Session::destroy ()
 
        remove_pending_capture_state ();
 
+       Analyser::flush ();
+
        _state_of_the_state = StateOfTheState (CannotSave|Deletion);
 
        /* disconnect from any and all signals that we are connected to */
 
        drop_connections ();
 
+       /* shutdown control surface protocols while we still have ports
+          and the engine to move data to any devices.
+       */
+
+       ControlProtocolManager::instance().drop_protocols ();
+
+       MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
+
        _engine.remove_session ();
 
 #ifdef USE_TRACKS_CODE_FEATURES
@@ -574,14 +598,25 @@ Session::destroy ()
        delete state_tree;
        state_tree = 0;
 
-       /* reset dynamic state version back to default */
+       // unregister all lua functions, drop held references (if any)
+       (*_lua_cleanup)();
+       lua.do_command ("Session = nil");
+       delete _lua_run;
+       delete _lua_add;
+       delete _lua_del;
+       delete _lua_list;
+       delete _lua_save;
+       delete _lua_load;
+       delete _lua_cleanup;
+       lua.collect_garbage ();
 
+       /* reset dynamic state version back to default */
        Stateful::loading_state_version = 0;
 
        _butler->drop_references ();
        delete _butler;
        _butler = 0;
-       
+
        delete _all_route_group;
 
        DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
@@ -670,7 +705,7 @@ Session::destroy ()
        delete _locations; _locations = 0;
 
        delete _tempo_map;
-       
+
        DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
 
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
@@ -682,10 +717,10 @@ void
 Session::setup_ltc ()
 {
        XMLNode* child = 0;
-       
+
        _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
        _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
-       
+
        if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
                _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
        } else {
@@ -695,7 +730,7 @@ Session::setup_ltc ()
                }
                reconnect_ltc_input ();
        }
-       
+
        if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
                _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
        } else {
@@ -705,11 +740,11 @@ Session::setup_ltc ()
                }
                reconnect_ltc_output ();
        }
-       
+
        /* fix up names of LTC ports because we don't want the normal
         * IO style of NAME/TYPE-{in,out}N
         */
-       
+
        _ltc_input->nth (0)->set_name (X_("LTC-in"));
        _ltc_output->nth (0)->set_name (X_("LTC-out"));
 }
@@ -718,8 +753,12 @@ void
 Session::setup_click ()
 {
        _clicking = false;
+
+       boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
+       boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
+
        _click_io.reset (new ClickIO (*this, X_("Click")));
-       _click_gain.reset (new Amp (*this));
+       _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
        _click_gain->activate ();
        if (state_tree) {
                setup_click_state (state_tree->root());
@@ -730,11 +769,11 @@ Session::setup_click ()
 
 void
 Session::setup_click_state (const XMLNode* node)
-{      
+{
        const XMLNode* child = 0;
-       
+
        if (node && (child = find_named_node (*node, "Click")) != 0) {
-               
+
                /* existing state for Click */
                int c = 0;
 
@@ -750,7 +789,7 @@ Session::setup_click_state (const XMLNode* node)
                                }
                        }
                }
-                       
+
                if (c == 0) {
                        _clicking = Config->get_clicking ();
 
@@ -924,7 +963,7 @@ Session::auto_connect_master_bus ()
        if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
                return;
        }
-       
+
        // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
        // In this case it means "Multi Out" output mode
        if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
@@ -933,21 +972,21 @@ Session::auto_connect_master_bus ()
 
        /* if requested auto-connect the outputs to the first N physical ports.
         */
-       
+
        uint32_t limit = _master_out->n_outputs().n_total();
        vector<string> outputs[DataType::num_types];
-       
+
        for (uint32_t i = 0; i < DataType::num_types; ++i) {
                _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
        }
-       
+
        for (uint32_t n = 0; n < limit; ++n) {
                boost::shared_ptr<Port> p = _master_out->output()->nth (n);
                string connect_to;
                if (outputs[p->type()].size() > n) {
                        connect_to = outputs[p->type()][n];
                }
-               
+
                if (!connect_to.empty() && p->connected_to (connect_to) == false) {
                        if (_master_out->output()->connect (p, connect_to, this)) {
                                error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
@@ -978,20 +1017,20 @@ Session::remove_monitor_section ()
                /* Hold process lock while doing this so that we don't hear bits and
                 * pieces of audio as we work on each route.
                 */
-               
+
                Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
-               
+
                /* Connect tracks to monitor section. Note that in an
                   existing session, the internal sends will already exist, but we want the
                   routes to notice that they connect to the control out specifically.
                */
-               
-               
+
+
                boost::shared_ptr<RouteList> r = routes.reader ();
                PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
-               
+
                for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
-                       
+
                        if ((*x)->is_monitor()) {
                                /* relax */
                        } else if ((*x)->is_master()) {
@@ -1008,6 +1047,7 @@ Session::remove_monitor_section ()
        if (auditioner) {
                auditioner->connect ();
        }
+       Config->ParameterChanged ("use-monitor-bus");
 }
 
 void
@@ -1028,25 +1068,28 @@ Session::add_monitor_section ()
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
        // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
 #endif
-       {
+       try {
                Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
                r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
                r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
+       } catch (...) {
+               error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
+               return;
        }
 
        rl.push_back (r);
        add_routes (rl, false, false, false);
-       
+
        assert (_monitor_out);
 
        /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
           are undefined, at best.
        */
-       
+
        uint32_t limit = _monitor_out->n_inputs().n_audio();
-       
+
        if (_master_out) {
-               
+
                /* connect the inputs to the master bus outputs. this
                 * represents a separate data feed from the internal sends from
                 * each route. as of jan 2011, it allows the monitor section to
@@ -1060,7 +1103,7 @@ Session::add_monitor_section ()
                for (uint32_t n = 0; n < limit; ++n) {
                        boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
                        boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
-                       
+
                        if (o) {
                                string connect_to = o->name();
                                if (_monitor_out->input()->connect (p, connect_to, this)) {
@@ -1071,16 +1114,16 @@ Session::add_monitor_section ()
                        }
                }
        }
-       
+
        /* if monitor section is not connected, connect it to physical outs
         */
-       
+
        if (Config->get_auto_connect_standard_busses() && !_monitor_out->output()->connected ()) {
-               
+
                if (!Config->get_monitor_bus_preferred_bundle().empty()) {
-                       
+
                        boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
-                       
+
                        if (b) {
                                _monitor_out->output()->connect_ports_to_bundle (b, true, this);
                        } else {
@@ -1088,9 +1131,9 @@ Session::add_monitor_section ()
                                                           Config->get_monitor_bus_preferred_bundle())
                                        << endmsg;
                        }
-                       
+
                } else {
-                       
+
                        /* Monitor bus is audio only */
 
                        vector<string> outputs[DataType::num_types];
@@ -1101,17 +1144,17 @@ Session::add_monitor_section ()
 
                        uint32_t mod = outputs[DataType::AUDIO].size();
                        uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
-                       
+
                        if (mod != 0) {
-                               
+
                                for (uint32_t n = 0; n < limit; ++n) {
-                                       
+
                                        boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
                                        string connect_to;
                                        if (outputs[DataType::AUDIO].size() > (n % mod)) {
                                                connect_to = outputs[DataType::AUDIO][n % mod];
                                        }
-                                       
+
                                        if (!connect_to.empty()) {
                                                if (_monitor_out->output()->connect (p, connect_to, this)) {
                                                        error << string_compose (
@@ -1129,7 +1172,7 @@ Session::add_monitor_section ()
        /* Hold process lock while doing this so that we don't hear bits and
         * pieces of audio as we work on each route.
         */
-        
+
        Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 
        /* Connect tracks to monitor section. Note that in an
@@ -1143,7 +1186,7 @@ Session::add_monitor_section ()
        PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
 
        for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
-               
+
                if ((*x)->is_monitor()) {
                        /* relax */
                } else if ((*x)->is_master()) {
@@ -1156,6 +1199,7 @@ Session::add_monitor_section ()
        if (auditioner) {
                auditioner->connect ();
        }
+       Config->ParameterChanged ("use-monitor-bus");
 }
 
 void
@@ -1474,7 +1518,7 @@ Session::auto_loop_changed (Location* location)
                }
        }
 
-       
+
        last_loopend = location->end();
        set_dirty ();
 }
@@ -1524,14 +1568,14 @@ Session::set_session_extents (framepos_t start, framepos_t end)
                //if there is no existing session, we need to make a new session location  (should never happen)
                existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
        }
-       
+
        if (end <= start) {
                error << _("Session: you can't use that location for session start/end)") << endmsg;
                return;
        }
 
        existing->set( start, end );
-       
+
        set_dirty();
 }
 
@@ -1583,7 +1627,7 @@ Session::set_auto_loop_location (Location* location)
                        }
                }
        }
-    
+
        /* take care of our stuff first */
 
        auto_loop_changed (location);
@@ -1605,7 +1649,7 @@ Session::update_skips (Location* loc, bool consolidate)
        if (_ignore_skips_updates) {
                return;
        }
-       
+
        Locations::LocationList skips;
 
         if (consolidate) {
@@ -1614,7 +1658,7 @@ Session::update_skips (Location* loc, bool consolidate)
         }
 
        sync_locations_to_skips ();
-        
+
        set_dirty ();
 }
 
@@ -1636,7 +1680,7 @@ Session::consolidate_skips (Location* loc)
                         ++l;
                         continue;
                 }
-                        
+
                 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
                 case Evoral::OverlapInternal:
                 case Evoral::OverlapExternal:
@@ -1675,9 +1719,9 @@ Session::_sync_locations_to_skips ()
        Locations::LocationList const & locs (_locations->list());
 
        for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
-               
+
                Location* location = *i;
-               
+
                if (location->is_skip() && location->is_skipping()) {
                        SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
                        queue_event (ev);
@@ -1696,7 +1740,7 @@ Session::location_added (Location *location)
         if (location->is_auto_loop()) {
                 set_auto_loop_location (location);
         }
-        
+
         if (location->is_session_range()) {
                 /* no need for any signal handling or event setting with the session range,
                    because we keep a direct reference to it and use its start/end directly.
@@ -1723,7 +1767,7 @@ Session::location_added (Location *location)
 
                 update_skips (location, true);
         }
-        
+
        set_dirty ();
 }
 
@@ -1734,7 +1778,7 @@ Session::location_removed (Location *location)
                set_auto_loop_location (0);
                set_track_loop (false);
         }
-        
+
         if (location->is_auto_punch()) {
                 set_auto_punch_location (0);
         }
@@ -1745,7 +1789,7 @@ Session::location_removed (Location *location)
         }
 
         if (location->is_skip()) {
-                
+
                 update_skips (location, false);
         }
 
@@ -1761,19 +1805,19 @@ Session::locations_changed ()
 void
 Session::_locations_changed (const Locations::LocationList& locations)
 {
-        /* There was some mass-change in the Locations object. 
+        /* There was some mass-change in the Locations object.
 
            We might be re-adding a location here but it doesn't actually matter
            for all the locations that the Session takes an interest in.
         */
-       
+
        {
                PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
                for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
                        location_added (*i);
                }
        }
-       
+
        update_skips (NULL, false);
 }
 
@@ -1791,7 +1835,7 @@ Session::enable_record ()
                if (rs == Recording) {
                        break;
                }
-               
+
                if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
 
                        _last_record_location = _transport_frame;
@@ -1807,6 +1851,19 @@ Session::enable_record ()
        }
 }
 
+void
+Session::set_all_tracks_record_enabled (bool enable )
+{
+       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->set_record_enabled (enable, Controllable::NoGroup);
+               }
+       }
+}
+
+
 void
 Session::disable_record (bool rt_context, bool force)
 {
@@ -1814,7 +1871,7 @@ Session::disable_record (bool rt_context, bool force)
 
        if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
 
-               if ((!Config->get_latched_record_enable () && !play_loop) || force) {
+               if (!Config->get_latched_record_enable () || force) {
                        g_atomic_int_set (&_record_status, Disabled);
                        send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
                } else {
@@ -1865,11 +1922,6 @@ Session::maybe_enable_record ()
 
        save_state ("", true);
 
-        if (Config->get_loop_is_mode()) {
-                /* makes no sense to use loop play as mode when recording */
-                request_play_loop (false);
-        }
-        
        if (_transport_speed) {
                if (!config.get_punch_in()) {
                        enable_record ();
@@ -1958,7 +2010,7 @@ Session::set_frame_rate (framecnt_t frames_per_second)
 
        clear_clicks ();
        reset_write_sources (false);
-       
+
        // XXX we need some equivalent to this, somehow
        // SndFileSource::setup_standard_crossfades (frames_per_second);
 
@@ -1975,7 +2027,7 @@ Session::set_block_size (pframes_t nframes)
           ::process(). It is therefore fine to do things that block
           here.
        */
-       
+
        {
                current_block_size = nframes;
 
@@ -2062,6 +2114,10 @@ Session::resort_routes ()
                return;
        }
 
+       if (_route_deletion_in_progress) {
+               return;
+       }
+
        {
                RCUWriter<RouteList> writer (routes);
                boost::shared_ptr<RouteList> r = writer.get_copy ();
@@ -2098,7 +2154,7 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
        /* We are going to build a directed graph of our routes;
           this is where the edges of that graph are put.
        */
-       
+
        GraphEdges edges;
 
        /* Go through all routes doing two things:
@@ -2111,7 +2167,7 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
         *    routes directly or indirectly feed them.  This information
         *    is used by the solo code.
         */
-          
+
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
                /* Clear out the route's list of direct or indirect feeds */
@@ -2135,7 +2191,7 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
 
        /* Attempt a topological sort of the route graph */
        boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
-       
+
        if (sorted_routes) {
                /* We got a satisfactory topological sort, so there is no feedback;
                   use this new graph.
@@ -2146,7 +2202,7 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
                if (_process_graph) {
                        _process_graph->rechain (sorted_routes, edges);
                }
-               
+
                _current_route_graph = edges;
 
                /* Complete the building of the routes' lists of what directly
@@ -2177,7 +2233,7 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
                   so the solo code will think that everything is still connected
                   as it was before.
                */
-               
+
                FeedbackDetected (); /* EMIT SIGNAL */
        }
 
@@ -2198,6 +2254,26 @@ Session::resort_routes_using (boost::shared_ptr<RouteList> r)
 bool
 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
 {
+       /* the base may conflict with ports that do not belong to existing
+          routes, but hidden objects like the click track. So check port names
+          before anything else.
+       */
+
+       for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
+               if (base == *reserved) {
+                       /* Check if this reserved name already exists, and if
+                          so, disallow it without a numeric suffix.
+                       */
+                       if (route_by_name (*reserved)) {
+                               definitely_add_number = true;
+                               if (id < 1) {
+                                       id = 1;
+                               }
+                       }
+                       break;
+               }
+       }
+
        if (!definitely_add_number && route_by_name (base) == 0) {
                /* juse use the base */
                name = base;
@@ -2212,7 +2288,7 @@ Session::find_route_name (string const & base, uint32_t& id, string& name, bool
                }
 
                ++id;
-               
+
        } while (id < (UINT_MAX-1));
 
        return false;
@@ -2260,7 +2336,7 @@ 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 (const ChanCount& input, const ChanCount& output, boost::shared_ptr<PluginInfo> instrument, 
+Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost::shared_ptr<PluginInfo> instrument,
                         TrackMode mode, RouteGroup* route_group, uint32_t how_many, string name_template)
 {
        string track_name;
@@ -2295,7 +2371,7 @@ Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost:
                        {
                                Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
                                if (track->input()->ensure_io (input, false, this)) {
-                                       error << "cannot configure " << input << " out configuration for new midi track" << endmsg;     
+                                       error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
                                        goto failed;
                                }
 
@@ -2351,14 +2427,100 @@ Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost:
                                PluginPtr plugin = instrument->load (*this);
                                boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
                                (*r)->add_processor (p, PreFader);
-                               
+
+                       }
+               }
+       }
+
+       return ret;
+}
+
+RouteList
+Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument)
+{
+       string bus_name;
+       uint32_t bus_id = 0;
+       string port;
+       RouteList ret;
+
+       bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
+
+       while (how_many) {
+               if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
+                       error << "cannot find name for new midi bus" << endmsg;
+                       goto failure;
+               }
+
+               try {
+                       boost::shared_ptr<Route> bus (new Route (*this, bus_name, Route::Flag(0), DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
+
+                       if (bus->init ()) {
+                               goto failure;
+                       }
+
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+                       // boost_debug_shared_ptr_mark_interesting (bus.get(), "Route");
+#endif
+                       {
+                               Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
+
+                               if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
+                                       error << _("cannot configure new midi bus input") << endmsg;
+                                       goto failure;
+                               }
+
+
+                               if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
+                                       error << _("cannot configure new midi bus output") << endmsg;
+                                       goto failure;
+                               }
+                       }
+
+                       if (route_group) {
+                               route_group->add (bus);
+                       }
+                       if (Config->get_remote_model() == UserOrdered) {
+                               bus->set_remote_control_id (next_control_id());
+                       }
+
+                       ret.push_back (bus);
+                       RouteAddedOrRemoved (true); /* EMIT SIGNAL */
+                       ARDOUR::GUIIdle ();
+               }
+
+               catch (failed_constructor &err) {
+                       error << _("Session: could not create new audio route.") << endmsg;
+                       goto failure;
+               }
+
+               catch (AudioEngine::PortRegistrationFailure& pfe) {
+                       error << pfe.what() << endmsg;
+                       goto failure;
+               }
+
+
+               --how_many;
+       }
+
+  failure:
+       if (!ret.empty()) {
+               StateProtector sp (this);
+               add_routes (ret, false, false, false);
+
+               if (instrument) {
+                       for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
+                               PluginPtr plugin = instrument->load (*this);
+                               boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
+                               (*r)->add_processor (p, PreFader);
                        }
                }
        }
 
        return ret;
+
 }
 
+
 void
 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
 {
@@ -2510,7 +2672,7 @@ Session::auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing
        }
 }
 
-#ifdef USE_TRACKS_CODE_FEATURES 
+#ifdef USE_TRACKS_CODE_FEATURES
 
 static bool
 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
@@ -2525,42 +2687,42 @@ Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool r
        if (!IO::connecting_legal) {
                return;
        }
-    
+
        // if we are deleting routes we will call this once at the end
        if (_route_deletion_in_progress) {
                return;
        }
-    
+
        Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
-    
+
        if (withLock) {
                lm.acquire ();
        }
-    
+
        // We need to disconnect the route's inputs and outputs first
        // basing on autoconnect configuration
        bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
        bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
-    
+
        ChanCount existing_inputs;
        ChanCount existing_outputs;
        count_existing_track_channels (existing_inputs, existing_outputs);
-    
+
        //ChanCount inputs = ChanCount::ZERO;
        //ChanCount outputs = ChanCount::ZERO;
-    
+
        RouteList existing_routes = *routes.reader ();
        existing_routes.sort (compare_routes_by_remote_id);
-    
+
        {
                PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
 
                vector<string> physinputs;
                vector<string> physoutputs;
-        
+
                EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
                EngineStateController::instance()->get_physical_audio_inputs(physinputs);
-                
+
                uint32_t input_n = 0;
                uint32_t output_n = 0;
                RouteList::iterator rIter = existing_routes.begin();
@@ -2576,52 +2738,52 @@ Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool r
                        } else if (current_output_auto_connection == AutoConnectMaster) {
                                (*rIter)->amp()->activate();
                        }
-            
+
                        if (reconnectIputs) {
                                (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
-                
+
                                for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
-                    
+
                                        if (current_input_auto_connection & AutoConnectPhysical) {
-                        
+
                                                if ( input_n == physinputs.size() ) {
                                                        break;
                                                }
-                        
+
                                                string port = physinputs[input_n];
-                    
+
                                                if (port.empty() ) {
                                                        error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
                                                }
-                        
+
                                                //GZ: check this; could be heavy
                                                (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
                                                ++input_n;
                                        }
                                }
                        }
-            
+
                        if (reconnectOutputs) {
-                
+
                                //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
                                if (current_output_auto_connection & AutoConnectPhysical) {
-                
+
                                        //GZ: check this; could be heavy
                                        (*rIter)->output()->disconnect (this);
                                        size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
-                    
+
                                        //GZ: check this; could be heavy
                                        (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
-               
+
                                } else if (current_output_auto_connection & AutoConnectMaster){
-                    
+
                                        if (!reconnect_master) {
                                                continue;
                                        }
-                    
+
                                        //GZ: check this; could be heavy
                                        (*rIter)->output()->disconnect (this);
-                    
+
                                        if (_master_out) {
                                                uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
                                                (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
@@ -2630,54 +2792,54 @@ Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool r
                                                break;
                                        }
                                }
-                
+
                                for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
                                        if (current_output_auto_connection & AutoConnectPhysical) {
-                        
+
                                                if ( output_n == physoutputs.size() ) {
                                                        break;
                                                }
-                        
+
                                                string port = physoutputs[output_n];
-                        
+
                                                if (port.empty() ) {
                                                        error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
                                                }
-                    
+
                                                //GZ: check this; could be heavy
                                                (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
                                                ++output_n;
-                        
+
                                        } else if (current_output_auto_connection & AutoConnectMaster) {
-                  
+
                                                if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
                                                        break;
                                                }
-                        
+
                                                // connect to master bus
                                                string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
-                    
+
                                                if (port.empty() ) {
                                                        error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
                                                }
-                        
-                            
+
+
                                                //GZ: check this; could be heavy
                                                (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
-                            
+
                                        }
                                }
                        }
-            
+
                        //auto_connect_route (*rIter, inputs, outputs, false, reconnectIputs);
                }
-        
+
                _master_out->output()->disconnect (this);
                auto_connect_master_bus ();
        }
-    
+
        graph_reordered ();
-    
+
        session_routes_reconnected (); /* EMIT SIGNAL */
 }
 
@@ -2685,16 +2847,16 @@ void
 Session::reconnect_midi_scene_ports(bool inputs)
 {
     if (inputs ) {
-        
+
         boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
         if (scene_in_ptr) {
             scene_in_ptr->disconnect_all ();
-            
+
             std::vector<EngineStateController::MidiPortState> midi_port_states;
             EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
-            
+
             std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
-            
+
             for (; state_iter != midi_port_states.end(); ++state_iter) {
                 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
                     scene_in_ptr->connect (state_iter->name);
@@ -2703,17 +2865,17 @@ Session::reconnect_midi_scene_ports(bool inputs)
         }
 
     } else {
-        
+
         boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
-        
+
         if (scene_out_ptr ) {
             scene_out_ptr->disconnect_all ();
 
             std::vector<EngineStateController::MidiPortState> midi_port_states;
             EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
-            
+
             std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
-            
+
             for (; state_iter != midi_port_states.end(); ++state_iter) {
                 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
                     scene_out_ptr->connect (state_iter->name);
@@ -2733,24 +2895,24 @@ Session::reconnect_mtc_ports ()
        }
 
        mtc_in_ptr->disconnect_all ();
-       
+
        std::vector<EngineStateController::MidiPortState> midi_port_states;
        EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
-       
+
        std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
-       
+
        for (; state_iter != midi_port_states.end(); ++state_iter) {
                if (state_iter->available && state_iter->mtc_in) {
                        mtc_in_ptr->connect (state_iter->name);
                }
        }
-       
+
        if (!_midi_ports->mtc_input_port ()->connected () &&
            config.get_external_sync () &&
            (Config->get_sync_source () == MTC) ) {
                config.set_external_sync (false);
        }
-       
+
        if ( ARDOUR::Profile->get_trx () ) {
                // Tracks need this signal to update timecode_source_dropdown
                MtcOrLtcInputPortChanged (); //emit signal
@@ -2761,30 +2923,30 @@ void
 Session::reconnect_mmc_ports(bool inputs)
 {
        if (inputs ) { // get all enabled midi input ports
-        
+
                boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
                if (mmc_in_ptr) {
                        mmc_in_ptr->disconnect_all ();
                        std::vector<std::string> enabled_midi_inputs;
                        EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
-            
+
                        std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
-            
+
                        for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
                                mmc_in_ptr->connect (*port_iter);
                        }
 
                }
        } else { // get all enabled midi output ports
-        
+
                boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
                if (mmc_out_ptr ) {
                        mmc_out_ptr->disconnect_all ();
                        std::vector<std::string> enabled_midi_outputs;
                        EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
-            
+
                        std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
-            
+
                        for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
                                mmc_out_ptr->connect (*port_iter);
                        }
@@ -2798,7 +2960,7 @@ Session::reconnect_mmc_ports(bool inputs)
  *  @param name_template string to use for the start of the name, or "" to use "Audio".
  */
 list< boost::shared_ptr<AudioTrack> >
-Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, RouteGroup* route_group, 
+Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, RouteGroup* route_group,
                          uint32_t how_many, string name_template)
 {
        string track_name;
@@ -2809,7 +2971,7 @@ Session::new_audio_track (int input_channels, int output_channels, TrackMode mod
 
        const string name_pattern = default_track_name_pattern (DataType::AUDIO);
        bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
-       
+
        while (how_many) {
 
                if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
@@ -2836,7 +2998,7 @@ Session::new_audio_track (int input_channels, int output_channels, TrackMode mod
                                //  0 for Stereo Out mode
                                //  0 Multi Out mode
                                if (Config->get_output_auto_connect() & AutoConnectMaster) {
-                                       track->set_gain (dB_to_coefficient (0), 0);
+                                       track->set_gain (dB_to_coefficient (0), Controllable::NoGroup);
                                }
                        }
 
@@ -2921,7 +3083,7 @@ Session::new_audio_route (int input_channels, int output_channels, RouteGroup* r
        RouteList ret;
 
        bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
-       
+
        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;
@@ -2967,7 +3129,7 @@ Session::new_audio_route (int input_channels, int output_channels, RouteGroup* r
                        bus->add_internal_return ();
 
                        ret.push_back (bus);
-                       
+
                        RouteAddedOrRemoved (true); /* EMIT SIGNAL */
 
                        ARDOUR::GUIIdle ();
@@ -3003,30 +3165,39 @@ Session::new_audio_route (int input_channels, int output_channels, RouteGroup* r
 }
 
 RouteList
-Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base)
+Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
 {
-       RouteList ret;
-       uint32_t control_id;
        XMLTree tree;
-       uint32_t number = 0;
-       const uint32_t being_added = how_many;
 
        if (!tree.read (template_path.c_str())) {
-               return ret;
+               return RouteList();
        }
 
-       XMLNode* node = tree.root();
+       return new_route_from_template (how_many, *tree.root(), name_base, pd);
+}
 
+RouteList
+Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
+{
+       RouteList ret;
+       uint32_t control_id;
+       uint32_t number = 0;
+       const uint32_t being_added = how_many;
+       /* This will prevent the use of any existing XML-provided PBD::ID
+          values by Stateful.
+       */
+       Stateful::ForceIDRegeneration force_ids;
        IO::disable_connecting ();
 
        control_id = next_control_id ();
 
        while (how_many) {
 
-               XMLNode node_copy (*node);
+               /* We're going to modify the node contents a bit so take a
+                * copy. The node may be re-used when duplicating more than once.
+                */
 
-               /* Remove IDs of everything so that new ones are used */
-               node_copy.remove_property_recursively (X_("id"));
+               XMLNode node_copy (node);
 
                try {
                        string name;
@@ -3046,7 +3217,7 @@ Session::new_route_from_template (uint32_t how_many, const std::string& template
                        } else {
 
                                string const route_name  = node_copy.property(X_("name"))->value ();
-                       
+
                                /* generate a new name by adding a number to the end of the template name */
                                if (!find_route_name (route_name.c_str(), ++number, name, true)) {
                                        fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
@@ -3055,7 +3226,18 @@ Session::new_route_from_template (uint32_t how_many, const std::string& template
                        }
 
                        /* set this name in the XML description that we are about to use */
-                       Route::set_name_in_state (node_copy, name);
+
+                       bool rename_playlist;
+                       switch (pd) {
+                       case NewPlaylist:
+                               rename_playlist = true;
+                               break;
+                       case CopyPlaylist:
+                       case SharePlaylist:
+                               rename_playlist = false;
+                       }
+
+                       Route::set_name_in_state (node_copy, name, rename_playlist);
 
                        /* trim bitslots from listen sends so that new ones are used */
                        XMLNodeList children = node_copy.children ();
@@ -3067,7 +3249,7 @@ Session::new_route_from_template (uint32_t how_many, const std::string& template
                                        }
                                }
                        }
-                       
+
                        boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
 
                        if (route == 0) {
@@ -3093,6 +3275,21 @@ Session::new_route_from_template (uint32_t how_many, const std::string& template
                        route->set_remote_control_id (control_id);
                        ++control_id;
 
+                       boost::shared_ptr<Track> track;
+
+                       if ((track = boost::dynamic_pointer_cast<Track> (route))) {
+                               switch (pd) {
+                               case NewPlaylist:
+                                       track->use_new_playlist ();
+                                       break;
+                               case CopyPlaylist:
+                                       track->use_copy_playlist ();
+                                       break;
+                               case SharePlaylist:
+                                       break;
+                               }
+                       };
+
                        ret.push_back (route);
 
                        RouteAddedOrRemoved (true); /* EMIT SIGNAL */
@@ -3140,17 +3337,17 @@ Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output
 
        update_latency (true);
        update_latency (false);
-               
+
        set_dirty();
-       
+
        if (save) {
                save_state (_current_snapshot_name);
        }
-       
+
        reassign_track_numbers();
 
        update_route_record_state ();
-    
+
        RouteAdded (new_routes); /* EMIT SIGNAL */
 }
 
@@ -3191,8 +3388,8 @@ Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool
 
                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->solo_isolated_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
+               r->mute_changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
                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));
 
@@ -3242,8 +3439,8 @@ Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool
        }
 
        if (_monitor_out && IO::connecting_legal) {
-               Glib::Threads::Mutex::Lock lm (_engine.process_lock());         
-               
+               Glib::Threads::Mutex::Lock lm (_engine.process_lock());
+
                for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
                        if ((*x)->is_monitor()) {
                                /* relax */
@@ -3264,7 +3461,7 @@ Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                if ((s = (*i)->internal_send_for (dest)) != 0) {
-                       s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO);
+                       s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
                }
        }
 }
@@ -3277,7 +3474,7 @@ Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                if ((s = (*i)->internal_send_for (dest)) != 0) {
-                       s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY);
+                       s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
                }
        }
 }
@@ -3290,7 +3487,7 @@ Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                if ((s = (*i)->internal_send_for (dest)) != 0) {
-                       s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value());
+                       s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
                }
        }
 }
@@ -3347,43 +3544,42 @@ void
 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
 {
        { // RCU Writer scope
+               PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
                RCUWriter<RouteList> writer (routes);
                boost::shared_ptr<RouteList> rs = writer.get_copy ();
-        
-        
+
+
                for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
-            
+
                        if (*iter == _master_out) {
                                continue;
                        }
-            
-                       (*iter)->set_solo (false, this);
-            
+
+                       (*iter)->set_solo (false, Controllable::NoGroup);
+
                        rs->remove (*iter);
-            
+
                        /* deleting the master out seems like a dumb
                           idea, but its more of a UI policy issue
                           than our concern.
                        */
-            
+
                        if (*iter == _master_out) {
                                _master_out = boost::shared_ptr<Route> ();
                        }
-            
+
                        if (*iter == _monitor_out) {
                                _monitor_out.reset ();
                        }
 
-                       update_route_solo_state ();
-            
                        // We need to disconnect the route's inputs and outputs
-            
+
                        (*iter)->input()->disconnect (0);
                        (*iter)->output()->disconnect (0);
-            
+
                        /* if the route had internal sends sending to it, remove them */
                        if ((*iter)->internal_return()) {
-                
+
                                boost::shared_ptr<RouteList> r = routes.reader ();
                                for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                                        boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
@@ -3392,31 +3588,31 @@ Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
                                        }
                                }
                        }
-            
+
                        /* if the monitoring section had a pointer to this route, remove it */
                        if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
                                Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
                                PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
                                (*iter)->remove_aux_or_listen (_monitor_out);
                        }
-            
+
                        boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
                        if (mt && mt->step_editing()) {
                                if (_step_editors > 0) {
                                        _step_editors--;
                                }
                        }
-
-                       RouteAddedOrRemoved (false); /* EMIT SIGNAL */
                }
-    
+
                /* writer goes out of scope, forces route list update */
 
        } // end of RCU Writer scope
-    
+
+       update_route_solo_state ();
+       RouteAddedOrRemoved (false); /* EMIT SIGNAL */
        update_latency_compensation ();
        set_dirty();
-    
+
        /* Re-sort routes to remove the graph's current references to the one that is
         * going away, then flush old references out of the graph.
         * Wave Tracks: reconnect routes
@@ -3428,29 +3624,28 @@ Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
                routes.flush (); // maybe unsafe, see below.
                resort_routes ();
 #endif
-    
+
        if (_process_graph) {
                _process_graph->clear_other_chain ();
        }
-    
+
        /* get rid of it from the dead wood collection in the route list manager */
        /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
-    
+
        routes.flush ();
-    
+
        /* try to cause everyone to drop their references
         * and unregister ports from the backend
         */
-       PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
 
        for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
                (*iter)->drop_references ();
        }
-    
+
        Route::RemoteControlIDChange(); /* EMIT SIGNAL */
-    
+
        /* save the new state of the world */
-    
+
        if (save_state (_current_snapshot_name)) {
                save_history (_current_snapshot_name);
        }
@@ -3468,30 +3663,49 @@ Session::remove_route (boost::shared_ptr<Route> route)
 }
 
 void
-Session::route_mute_changed (void* /*src*/)
+Session::route_mute_changed ()
 {
        set_dirty ();
 }
 
 void
-Session::route_listen_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
+Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
 {
        boost::shared_ptr<Route> route = wpr.lock();
        if (!route) {
-               error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_changed")) << endmsg;
+               error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_listen_changed")) << endmsg;
                return;
        }
 
        if (route->listening_via_monitor ()) {
 
                if (Config->get_exclusive_solo()) {
-                       /* new listen: disable all other listen */
+
+                       RouteGroup* rg = route->route_group ();
+                       const bool group_already_accounted_for = route->use_group (group_override, &RouteGroup::is_solo);
+
                        boost::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_auditioner()) {
+                               if ((*i) == route) {
+                                       /* already changed */
+                                       continue;
+                               }
+
+                               if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
+                                       /* route does not get solo propagated to it */
+                                       continue;
+                               }
+
+                               if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
+                                       /* this route is a part of the same solo group as the route
+                                        * that was changed. Changing that route did change or will
+                                        * change all group members appropriately, so we can ignore it
+                                        * here
+                                        */
                                        continue;
                                }
-                               (*i)->set_listen (false, this);
+                               (*i)->set_listen (false, Controllable::NoGroup);
                        }
                }
 
@@ -3505,13 +3719,13 @@ Session::route_listen_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
        update_route_solo_state ();
 }
 void
-Session::route_solo_isolated_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
+Session::route_solo_isolated_changed (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;
+               error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_isolated_changed")) << endmsg;
                return;
        }
 
@@ -3535,121 +3749,7 @@ Session::route_solo_isolated_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
 }
 
 void
-Session::routes_solo_changed (boost::shared_ptr<RouteList> solo_change_routes)
-{
-       if (solo_update_disabled) {
-               // We know already
-               DEBUG_TRACE (DEBUG::Solo, "solo update disabled - changed ignored\n");
-               return;
-       }
-
-       if (solo_change_routes->empty() ) {
-               return;
-       }
-
-       boost::shared_ptr<RouteList> non_solo_change_routes (new RouteList);
-       boost::shared_ptr<RouteList> r = routes.reader ();
-       int32_t delta;
-
-       std::set_difference (r->begin(), r->end(),
-                            solo_change_routes->begin(), solo_change_routes->end(),
-                            std::back_inserter(*non_solo_change_routes) );
-
-       DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
-
-       solo_update_disabled = true;
-       RouteList uninvolved;
-
-       for (RouteList::iterator route = solo_change_routes->begin(); route != solo_change_routes->end(); ++route) {
-
-               if ((*route)->self_soloed() ) {
-                       delta = 1;
-               } else {
-                       delta = -1;
-               }
-
-               DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", (*route)->name()));
-
-               for (RouteList::iterator i = non_solo_change_routes->begin(); i != non_solo_change_routes->end(); ++i) {
-                       bool via_sends_only;
-                       bool in_signal_flow;
-
-                       if ((*i) == *route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner() ) {
-                               continue;
-                       }
-
-                       in_signal_flow = false;
-
-                       DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
-
-                       if ((*i)->feeds (*route, &via_sends_only)) {
-                               DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
-                               if (!via_sends_only) {
-                                       if (!(*route)->soloed_by_others_upstream()) {
-                                               (*i)->mod_solo_by_others_downstream (delta);
-                                       }
-                               } else {
-                                       DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
-                               }
-                               in_signal_flow = true;
-                       } else {
-                               DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
-                       }
-
-                       DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
-
-                       if ((*route)->feeds (*i, &via_sends_only)) {
-                               /* propagate solo upstream only if routing other than
-                                  sends is involved, but do consider the other route
-                                  (*i) to be part of the signal flow even if only
-                                  sends are involved.
-                               */
-                               DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
-                                                                         (*route)->name(),
-                                                                         (*i)->name(),
-                                                                         via_sends_only,
-                                                                         (*route)->soloed_by_others_downstream(),
-                                                                         (*route)->soloed_by_others_upstream()));
-                               if (!via_sends_only) {
-                                       if (!(*route)->soloed_by_others_downstream()) {
-                                               DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
-                                               (*i)->mod_solo_by_others_upstream (delta);
-                                       } else {
-                                               DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others downstream\n");
-                                       }
-                               } else {
-                                       DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
-                               }
-                               in_signal_flow = true;
-                       } else {
-                               DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
-                       }
-
-                       if (!in_signal_flow) {
-                               uninvolved.push_back (*i);
-                       }
-               }
-       }
-       solo_update_disabled = false;
-       DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
-
-       update_route_solo_state ();
-
-       /* 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) {
-               DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1\n", (*i)->name() ));
-               (*i)->mute_changed (this);
-       }
-
-       SoloChanged (); /* EMIT SIGNAL */
-       set_dirty();
-}
-
-void
-Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_ptr<Route> wpr)
+Session::route_solo_changed (bool self_solo_change, Controllable::GroupControlDisposition group_override,  boost::weak_ptr<Route> wpr)
 {
        DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_change));
 
@@ -3658,12 +3758,6 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                return;
        }
 
-       if (solo_update_disabled) {
-               // We know already
-               DEBUG_TRACE (DEBUG::Solo, "solo update disabled - changed ignored\n");
-               return;
-       }
-
        boost::shared_ptr<Route> route = wpr.lock ();
        assert (route);
 
@@ -3676,26 +3770,56 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                delta = -1;
        }
 
+       /* the route may be a member of a group that has shared-solo
+        * semantics. If so, then all members of that group should follow the
+        * solo of the changed route. But ... this is optional, controlled by a
+        * Controllable::GroupControlDisposition.
+        *
+        * The first argument to the signal that this method is connected to is the
+        * GroupControlDisposition value that was used to change solo.
+        *
+        * If the solo change was done with group semantics (either InverseGroup
+        * (force the entire group to change even if the group shared solo is
+        * disabled) or UseGroup (use the group, which may or may not have the
+        * shared solo property enabled)) then as we propagate the change to
+        * the entire session we should IGNORE THE GROUP that the changed route
+        * belongs to.
+        */
+
        RouteGroup* rg = route->route_group ();
-       bool leave_group_alone = (rg && rg->is_active() && rg->is_solo());
+       const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
 
        if (delta == 1 && Config->get_exclusive_solo()) {
-               
+
                /* new solo: disable all other solos, but not the group if its solo-enabled */
 
                for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-                       if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner() ||
-                           (leave_group_alone && ((*i)->route_group() == rg))) {
+
+                       if ((*i) == route) {
+                               /* already changed */
                                continue;
                        }
-                       (*i)->set_solo (false, this);
+
+                       if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
+                               /* route does not get solo propagated to it */
+                               continue;
+                       }
+
+                       if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
+                               /* this route is a part of the same solo group as the route
+                                * that was changed. Changing that route did change or will
+                                * change all group members appropriately, so we can ignore it
+                                * here
+                                */
+                               continue;
+                       }
+
+                       (*i)->set_solo (false, group_override);
                }
        }
 
        DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
 
-       solo_update_disabled = true;
-
        RouteList uninvolved;
 
        DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
@@ -3704,20 +3828,36 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                bool via_sends_only;
                bool in_signal_flow;
 
-               if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner() ||
-                   (leave_group_alone && ((*i)->route_group() == rg))) {
+               if ((*i) == route) {
+                       /* already changed */
+                       continue;
+               }
+
+               if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
+                       /* route does not get solo propagated to it */
+                       continue;
+               }
+
+               if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
+                       /* this route is a part of the same solo group as the route
+                        * that was changed. Changing that route did change or will
+                        * change all group members appropriately, so we can ignore it
+                        * here
+                        */
                        continue;
                }
 
                in_signal_flow = false;
 
                DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
-               
+
                if ((*i)->feeds (route, &via_sends_only)) {
                        DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
                        if (!via_sends_only) {
                                if (!route->soloed_by_others_upstream()) {
                                        (*i)->mod_solo_by_others_downstream (delta);
+                               } else {
+                                       DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
                                }
                        } else {
                                DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
@@ -3726,7 +3866,7 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                } else {
                        DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
                }
-               
+
                DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
 
                if (route->feeds (*i, &via_sends_only)) {
@@ -3742,12 +3882,9 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                                                                  route->soloed_by_others_downstream(),
                                                                  route->soloed_by_others_upstream()));
                        if (!via_sends_only) {
-                               if (!route->soloed_by_others_downstream()) {
-                                       DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
-                                       (*i)->mod_solo_by_others_upstream (delta);
-                               } else {
-                                       DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others downstream\n");
-                               }
+                               //NB. Triggers Invert Push, which handles soloed by downstream
+                               DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
+                               (*i)->mod_solo_by_others_upstream (delta);
                        } else {
                                DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
                        }
@@ -3761,7 +3898,6 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
                }
        }
 
-       solo_update_disabled = false;
        DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
 
        update_route_solo_state (r);
@@ -3773,7 +3909,7 @@ Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_p
        for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
                DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
                (*i)->act_on_mute ();
-               (*i)->mute_changed (this);
+               (*i)->mute_changed ();
        }
 
        SoloChanged (); /* EMIT SIGNAL */
@@ -3786,6 +3922,7 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
        /* now figure out if anything that matters is soloed (or is "listening")*/
 
        bool something_soloed = false;
+       bool something_listening = false;
        uint32_t listeners = 0;
        uint32_t isolated = 0;
 
@@ -3801,8 +3938,9 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
                if (!(*i)->is_auditioner() && (*i)->listening_via_monitor()) {
                        if (Config->get_solo_control_is_listen_control()) {
                                listeners++;
+                               something_listening = true;
                        } else {
-                               (*i)->set_listen (false, this);
+                               (*i)->set_listen (false, Controllable::NoGroup);
                        }
                }
 
@@ -3816,6 +3954,11 @@ Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
                SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
        }
 
+       if (something_listening != _listening) {
+               _listening = something_listening;
+               SoloActive (_listening);
+       }
+
        _listen_cnt = listeners;
 
        if (isolated != _solo_isolated_cnt) {
@@ -3846,6 +3989,17 @@ Session::io_name_is_legal (const std::string& name)
 {
        boost::shared_ptr<RouteList> r = routes.reader ();
 
+       for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
+               if (name == *reserved) {
+                       if (!route_by_name (*reserved)) {
+                               /* first instance of a reserved name is allowed */
+                               return true;
+                       }
+                       /* all other instances of a reserved name are not allowed */
+                       return false;
+               }
+       }
+
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                if ((*i)->name() == name) {
                        return false;
@@ -3880,19 +4034,19 @@ Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff
        for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
 
                PortSet& ps ((*rt)->input()->ports());
-               
+
                for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
                        p->get_connections (connections);
                }
-               
+
                for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
                        routes_using_input_from (*s, rl2);
                }
-               
+
                /* scan all relevant routes to see if others are on or off */
-               
+
                bool others_are_already_on = false;
-               
+
                for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
 
                        boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
@@ -3910,11 +4064,11 @@ Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff
                                mt->set_input_active (onoff);
                        }
                }
-               
+
                if (flip_others) {
 
                        /* globally reverse other routes */
-                       
+
                        for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
                                if ((*r) != (*rt)) {
                                        boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
@@ -3967,6 +4121,21 @@ Session::route_by_id (PBD::ID id)
        return boost::shared_ptr<Route> ((Route*) 0);
 }
 
+boost::shared_ptr<Processor>
+Session::processor_by_id (PBD::ID id) const
+{
+       boost::shared_ptr<RouteList> r = routes.reader ();
+
+       for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+               boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
+               if (p) {
+                       return p;
+               }
+       }
+
+       return boost::shared_ptr<Processor> ();
+}
+
 boost::shared_ptr<Track>
 Session::track_by_diskstream_id (PBD::ID id)
 {
@@ -3997,6 +4166,19 @@ Session::route_by_remote_id (uint32_t id)
 }
 
 
+boost::shared_ptr<Route>
+Session::route_by_selected_count (uint32_t id)
+{
+       boost::shared_ptr<RouteList> r = routes.reader ();
+
+       for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+               /* NOT IMPLEMENTED */
+       }
+
+       return boost::shared_ptr<Route> ((Route*) 0);
+}
+
+
 void
 Session::reassign_track_numbers ()
 {
@@ -4234,13 +4416,13 @@ Session::add_source (boost::shared_ptr<Source> source)
                /* yay, new source */
 
                boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
-               
+
                if (fs) {
                        if (!fs->within_session()) {
                                ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
                        }
                }
-               
+
                set_dirty();
 
                boost::shared_ptr<AudioFileSource> afs;
@@ -4336,7 +4518,7 @@ Session::midi_source_by_path (const std::string& path) const
                        = boost::dynamic_pointer_cast<MidiSource>(s->second);
                boost::shared_ptr<FileSource> fs
                        = boost::dynamic_pointer_cast<FileSource>(s->second);
-               
+
                if (ms && fs && fs->path() == path) {
                        return ms;
                }
@@ -4384,9 +4566,9 @@ Session::construct_peak_filepath (const string& filepath, const bool in_session,
 
                string session_path;
                bool in_another_session = true;
-               
+
                if (filepath.find (interchange_dir_string) != string::npos) {
-               
+
                        session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
                        session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
                        session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
@@ -4403,7 +4585,7 @@ Session::construct_peak_filepath (const string& filepath, const bool in_session,
                } else {
                        in_another_session = false;
                }
-               
+
 
                if (in_another_session) {
                        SessionDirectory sd (session_path);
@@ -4424,27 +4606,27 @@ Session::construct_peak_filepath (const string& filepath, const bool in_session,
        if (!in_session) {
                path = Glib::path_get_dirname (filepath);
        }
-       
+
        return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
 }
 
 string
 Session::new_audio_source_path_for_embedded (const std::string& path)
 {
-       /* embedded source: 
+       /* embedded source:
         *
         * we know that the filename is already unique because it exists
-        * out in the filesystem. 
+        * out in the filesystem.
         *
         * However, when we bring it into the session, we could get a
         * collision.
         *
         * Eg. two embedded files:
-        * 
+        *
         *          /foo/bar/baz.wav
         *          /frob/nic/baz.wav
         *
-        * When merged into session, these collide. 
+        * When merged into session, these collide.
         *
         * There will not be a conflict with in-memory sources
         * because when the source was created we already picked
@@ -4458,7 +4640,7 @@ Session::new_audio_source_path_for_embedded (const std::string& path)
        SessionDirectory sdir (get_best_session_directory_for_new_audio());
        string base = Glib::path_get_basename (path);
        string newpath = Glib::build_filename (sdir.sound_path(), base);
-       
+
        if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
 
                MD5 md5;
@@ -4466,14 +4648,14 @@ Session::new_audio_source_path_for_embedded (const std::string& path)
                md5.digestString (path.c_str());
                md5.writeToString ();
                base = md5.digestChars;
-               
+
                string ext = get_suffix (path);
 
                if (!ext.empty()) {
                        base += '.';
                        base += ext;
                }
-               
+
                newpath = Glib::build_filename (sdir.sound_path(), base);
 
                /* if this collides, we're screwed */
@@ -4488,14 +4670,14 @@ Session::new_audio_source_path_for_embedded (const std::string& path)
        return newpath;
 }
 
-/** Return true if there are no audio file sources that use @param name as 
- * the filename component of their path. 
+/** Return true if there are no audio file sources that use @param name as
+ * the filename component of their path.
  *
  * Return false otherwise.
  *
- * This method MUST ONLY be used to check in-session, mono files since it 
+ * This method MUST ONLY be used to check in-session, mono files since it
  * hard-codes the channel of the audio file source we are looking for as zero.
- * 
+ *
  * If/when Ardour supports native files in non-mono formats, the logic here
  * will need to be revisited.
  */
@@ -4507,7 +4689,7 @@ Session::audio_source_name_is_unique (const string& name)
        uint32_t existing = 0;
 
        for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
-               
+
                /* note that we search *without* the extension so that
                   we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
                   in the event that this new name is required for
@@ -4515,12 +4697,12 @@ Session::audio_source_name_is_unique (const string& name)
                */
 
                const string spath = *i;
-               
+
                if (matching_unsuffixed_filename_exists_in (spath, name)) {
                        existing++;
                        break;
                }
-               
+
                /* it is possible that we have the path already
                 * assigned to a source that has not yet been written
                 * (ie. the write source for a diskstream). we have to
@@ -4529,8 +4711,8 @@ Session::audio_source_name_is_unique (const string& name)
                 * two Sources point to the same file with different
                 * notions of their removability.
                 */
-               
-               
+
+
                string possible_path = Glib::build_filename (spath, name);
 
                if (audio_source_by_path_and_channel (possible_path, 0)) {
@@ -4547,20 +4729,20 @@ Session::format_audio_source_name (const string& legalized_base, uint32_t nchan,
 {
        ostringstream sstr;
        const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
-       
+
        if (Profile->get_trx() && destructive) {
                sstr << 'T';
                sstr << setfill ('0') << setw (4) << cnt;
                sstr << legalized_base;
        } else {
                sstr << legalized_base;
-               
+
                if (take_required || related_exists) {
                        sstr << '-';
                        sstr << cnt;
                }
        }
-       
+
        if (nchan == 2) {
                if (chan == 0) {
                        sstr << "%L";
@@ -4577,7 +4759,7 @@ Session::format_audio_source_name (const string& legalized_base, uint32_t nchan,
                        sstr << chan+1;
                }
        }
-       
+
        sstr << ext;
 
        return sstr.str();
@@ -4600,11 +4782,11 @@ Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t cha
        for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
 
                possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
-               
+
                if (audio_source_name_is_unique (possible_name)) {
                        break;
                }
-               
+
                some_related_source_name_exists = true;
 
                if (cnt > limit) {
@@ -4659,14 +4841,14 @@ Session::new_midi_source_path (const string& base)
 
                vector<space_and_path>::iterator i;
                uint32_t existing = 0;
-               
+
                for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
 
                        snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
                        possible_name = buf;
 
                        possible_path = Glib::build_filename (*i, possible_name);
-                       
+
                        if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
                                existing++;
                        }
@@ -4716,7 +4898,7 @@ boost::shared_ptr<MidiSource>
 Session::create_midi_source_for_session (string const & basic_name)
 {
        const string path = new_midi_source_path (basic_name);
-       
+
        if (!path.empty()) {
                return boost::dynamic_pointer_cast<SMFSource> (
                        SourceFactory::createWritable (
@@ -4731,24 +4913,24 @@ boost::shared_ptr<MidiSource>
 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
 {
        /* the caller passes in the track the source will be used in,
-          so that we can keep the numbering sane. 
-          
+          so that we can keep the numbering sane.
+
           Rationale: a track with the name "Foo" that has had N
           captures carried out so far will ALREADY have a write source
           named "Foo-N+1.mid" waiting to be used for the next capture.
-          
+
           If we call new_midi_source_name() we will get "Foo-N+2". But
           there is no region corresponding to "Foo-N+1", so when
           "Foo-N+2" appears in the track, the gap presents the user
           with odd behaviour - why did it skip past Foo-N+1?
-          
+
           We could explain this to the user in some odd way, but
           instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
           use "Foo-N+1" here.
-          
+
           If that attempted rename fails, we get "Foo-N+2.mid" anyway.
        */
-       
+
        boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
        assert (mt);
        std::string name = track->steal_write_source_name ();
@@ -4819,6 +5001,228 @@ Session::audition_playlist ()
        queue_event (ev);
 }
 
+
+void
+Session::register_lua_function (
+               const std::string& name,
+               const std::string& script,
+               const LuaScriptParamList& args
+               )
+{
+       Glib::Threads::Mutex::Lock lm (lua_lock);
+
+       lua_State* L = lua.getState();
+
+       const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
+       luabridge::LuaRef tbl_arg (luabridge::newTable(L));
+       for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
+               if ((*i)->optional && !(*i)->is_set) { continue; }
+               tbl_arg[(*i)->name] = (*i)->value;
+       }
+       (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
+       set_dirty();
+}
+
+void
+Session::unregister_lua_function (const std::string& name)
+{
+       Glib::Threads::Mutex::Lock lm (lua_lock);
+       (*_lua_del)(name); // throws luabridge::LuaException
+       lua.collect_garbage ();
+       set_dirty();
+}
+
+std::vector<std::string>
+Session::registered_lua_functions ()
+{
+       Glib::Threads::Mutex::Lock lm (lua_lock);
+       std::vector<std::string> rv;
+
+       try {
+               luabridge::LuaRef list ((*_lua_list)());
+               for (luabridge::Iterator i (list); !i.isNil (); ++i) {
+                       if (!i.key ().isString ()) { assert(0); continue; }
+                       rv.push_back (i.key ().cast<std::string> ());
+               }
+       } catch (luabridge::LuaException const& e) { }
+       return rv;
+}
+
+#ifndef NDEBUG
+static void _lua_print (std::string s) {
+       std::cout << "SessionLua: " << s << "\n";
+}
+#endif
+
+void
+Session::try_run_lua (pframes_t nframes)
+{
+       if (_n_lua_scripts == 0) return;
+       Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
+       if (tm.locked ()) {
+               try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
+       }
+}
+
+void
+Session::setup_lua ()
+{
+#ifndef NDEBUG
+       lua.Print.connect (&_lua_print);
+#endif
+       lua.do_command (
+                       "function ArdourSession ()"
+                       "  local self = { scripts = {}, instances = {} }"
+                       ""
+                       "  local remove = function (n)"
+                       "   self.scripts[n] = nil"
+                       "   self.instances[n] = nil"
+                       "   Session:scripts_changed()" // call back
+                       "  end"
+                       ""
+                       "  local addinternal = function (n, f, a)"
+                       "   assert(type(n) == 'string', 'function-name must be string')"
+                       "   assert(type(f) == 'function', 'Given script is a not a function')"
+                       "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
+                       "   assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
+                       "   self.scripts[n] = { ['f'] = f, ['a'] = a }"
+                       "   local env = _ENV;  env.f = nil env.io = nil env.os = nil env.loadfile = nil env.require = nil env.dofile = nil env.package = nil env.debug = nil"
+                       "   local env = { print = print, Session = Session, tostring = tostring, assert = assert, ipairs = ipairs, error = error, select = select, string = string, type = type, tonumber = tonumber, collectgarbage = collectgarbage, pairs = pairs, math = math, table = table, pcall = pcall }"
+                       "   self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
+                       "   Session:scripts_changed()" // call back
+                       "  end"
+                       ""
+                       "  local add = function (n, b, a)"
+                       "   assert(type(b) == 'string', 'ByteCode must be string')"
+                       "   load (b)()" // assigns f
+                       "   assert(type(f) == 'string', 'Assigned ByteCode must be string')"
+                       "   addinternal (n, load(f), a)"
+                       "  end"
+                       ""
+                       "  local run = function (...)"
+                       "   for n, s in pairs (self.instances) do"
+                       "     local status, err = pcall (s, ...)"
+                       "     if not status then"
+                       "       print ('fn \"'.. n .. '\": ', err)"
+                       "       remove (n)"
+                       "      end"
+                       "   end"
+                       "   collectgarbage()"
+                       "  end"
+                       ""
+                       "  local cleanup = function ()"
+                       "   self.scripts = nil"
+                       "   self.instances = nil"
+                       "  end"
+                       ""
+                       "  local list = function ()"
+                       "   local rv = {}"
+                       "   for n, _ in pairs (self.scripts) do"
+                       "     rv[n] = true"
+                       "   end"
+                       "   return rv"
+                       "  end"
+                       ""
+                       "  local function basic_serialize (o)"
+                       "    if type(o) == \"number\" then"
+                       "     return tostring(o)"
+                       "    else"
+                       "     return string.format(\"%q\", o)"
+                       "    end"
+                       "  end"
+                       ""
+                       "  local function serialize (name, value)"
+                       "   local rv = name .. ' = '"
+                       "   collectgarbage()"
+                       "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
+                       "    return rv .. basic_serialize(value) .. ' '"
+                       "   elseif type(value) == \"table\" then"
+                       "    rv = rv .. '{} '"
+                       "    for k,v in pairs(value) do"
+                       "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
+                       "     rv = rv .. serialize(fieldname, v) .. ' '"
+                       "     collectgarbage()" // string concatenation allocates a new string :(
+                       "    end"
+                       "    return rv;"
+                       "   elseif type(value) == \"function\" then"
+                       "     return rv .. string.format(\"%q\", string.dump(value, true))"
+                       "   else"
+                       "    error('cannot save a ' .. type(value))"
+                       "   end"
+                       "  end"
+                       ""
+                       ""
+                       "  local save = function ()"
+                       "   return (serialize('scripts', self.scripts))"
+                       "  end"
+                       ""
+                       "  local restore = function (state)"
+                       "   self.scripts = {}"
+                       "   load (state)()"
+                       "   for n, s in pairs (scripts) do"
+                       "    addinternal (n, load(s['f']), s['a'])"
+                       "   end"
+                       "  end"
+                       ""
+                       " return { run = run, add = add, remove = remove,"
+                 "          list = list, restore = restore, save = save, cleanup = cleanup}"
+                       " end"
+                       " "
+                       " sess = ArdourSession ()"
+                       " ArdourSession = nil"
+                       " "
+                       "function ardour () end"
+                       );
+
+       lua_State* L = lua.getState();
+
+       try {
+               luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
+               lua.do_command ("sess = nil"); // hide it.
+               lua.do_command ("collectgarbage()");
+
+               _lua_run = new luabridge::LuaRef(lua_sess["run"]);
+               _lua_add = new luabridge::LuaRef(lua_sess["add"]);
+               _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
+               _lua_list = new luabridge::LuaRef(lua_sess["list"]);
+               _lua_save = new luabridge::LuaRef(lua_sess["save"]);
+               _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
+               _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
+       } catch (luabridge::LuaException const& e) {
+               fatal << string_compose (_("programming error: %1"),
+                               X_("Failed to setup Lua interpreter"))
+                       << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       LuaBindings::stddef (L);
+       LuaBindings::common (L);
+       LuaBindings::dsp (L);
+       luabridge::push <Session *> (L, this);
+       lua_setglobal (L, "Session");
+}
+
+void
+Session::scripts_changed ()
+{
+       assert (!lua_lock.trylock()); // must hold lua_lock
+
+       try {
+               luabridge::LuaRef list ((*_lua_list)());
+               int cnt = 0;
+               for (luabridge::Iterator i (list); !i.isNil (); ++i) {
+                       if (!i.key ().isString ()) { assert(0); continue; }
+                       ++cnt;
+               }
+               _n_lua_scripts = cnt;
+       } catch (luabridge::LuaException const& e) {
+               fatal << string_compose (_("programming error: %1"),
+                               X_("Indexing Lua Session Scripts failed."))
+                       << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+}
+
 void
 Session::non_realtime_set_audition ()
 {
@@ -4878,7 +5282,7 @@ Session::graph_reordered ()
           from a set_state() call or creating new tracks. Ditto for deletion.
        */
 
-       if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress) {
+       if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
                return;
        }
 
@@ -4914,7 +5318,7 @@ Session::available_capture_duration ()
        if (_total_free_4k_blocks_uncertain) {
                return boost::optional<framecnt_t> ();
        }
-       
+
        float sample_bytes_on_disk = 4.0; // keep gcc happy
 
        switch (config.get_native_file_data_format()) {
@@ -5184,6 +5588,7 @@ Session::unmark_aux_send_id (uint32_t id)
 void
 Session::unmark_return_id (uint32_t id)
 {
+       if (_state_of_the_state & Deletion) { return; }
        if (id < return_bitset.size()) {
                return_bitset[id] = false;
        }
@@ -5265,7 +5670,7 @@ Session::freeze_all (InterThreadInfo& itt)
 boost::shared_ptr<Region>
 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
                          bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
-                         InterThreadInfo& itt, 
+                         InterThreadInfo& itt,
                          boost::shared_ptr<Processor> endpoint, bool include_endpoint,
                          bool for_export, bool for_freeze)
 {
@@ -5326,7 +5731,7 @@ Session::write_one_track (Track& track, framepos_t start, framepos_t end,
                string path = ((track.data_type() == DataType::AUDIO)
                               ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
                               : new_midi_source_path (legal_playlist_name));
-               
+
                if (path.empty()) {
                        goto out;
                }
@@ -5533,6 +5938,12 @@ Session::get_scratch_buffers (ChanCount count, bool silence)
        return ProcessThread::get_scratch_buffers (count, silence);
 }
 
+BufferSet&
+Session::get_noinplace_buffers (ChanCount count)
+{
+       return ProcessThread::get_noinplace_buffers (count);
+}
+
 BufferSet&
 Session::get_route_buffers (ChanCount count, bool silence)
 {
@@ -5625,15 +6036,15 @@ Session::update_route_record_state ()
                        break;
                }
        }
-    
+
        g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
 
        bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
-    
+
        if (record_status() == Recording && record_arm_state_changed ) {
                RecordArmStateChanged ();
        }
-       
+
 }
 
 void
@@ -6147,7 +6558,7 @@ Session::update_latency_compensation (bool force_whole_graph)
                                                     (some_track_latency_changed ? "yes" : "no")));
 
        DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
-       
+
        if (some_track_latency_changed || force_whole_graph)  {
                _engine.update_latencies ();
        }
@@ -6176,7 +6587,7 @@ Session::session_name_is_legal (const string& path)
        return 0;
 }
 
-uint32_t 
+uint32_t
 Session::next_control_id () const
 {
        int subtract = 0;
@@ -6220,7 +6631,7 @@ Session::notify_remote_id_change ()
                 */
                reconnect_existing_routes(true, true);
 #endif
-               
+
 }
 
 void
@@ -6331,5 +6742,5 @@ Session::clear_object_selection ()
        _object_selection = Evoral::Range<framepos_t> (-1,-1);
 #ifdef USE_TRACKS_CODE_FEATURES
        follow_playhead_priority ();
-#endif 
+#endif
 }