fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / session_state.cc
index b51d7a7d694b7f1c30477c232076a09ebfc34d03..76cf2d375599dfda5a8b2bddcfe9ab6a155b5370 100644 (file)
 #include <stdint.h>
 
 #include <algorithm>
-#include <fstream>
 #include <string>
 #include <cerrno>
 #include <cstdio> /* snprintf(3) ... grrr */
 #include <cmath>
+
 #include <unistd.h>
-#include <sys/stat.h>
 #include <climits>
 #include <signal.h>
 #include <sys/time.h>
@@ -40,7 +39,7 @@
 #include <sys/vfs.h>
 #endif
 
-#ifdef __APPLE__
+#if defined(__APPLE__) || defined(__FreeBSD__)
 #include <sys/param.h>
 #include <sys/mount.h>
 #endif
@@ -50,7 +49,7 @@
 #endif
 
 #include <glib.h>
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 
 #include <glibmm.h>
 #include <glibmm/threads.h>
@@ -63,9 +62,8 @@
 
 #include "evoral/SMF.hpp"
 
-#include "pbd/boost_debug.h"
 #include "pbd/basename.h"
-#include "pbd/controllable_descriptor.h"
+#include "pbd/debug.h"
 #include "pbd/enumwriter.h"
 #include "pbd/error.h"
 #include "pbd/file_utils.h"
@@ -74,6 +72,7 @@
 #include "pbd/stacktrace.h"
 #include "pbd/convert.h"
 #include "pbd/localtime_r.h"
+#include "pbd/unwind.h"
 
 #include "ardour/amp.h"
 #include "ardour/async_midi_port.h"
 #include "ardour/audioengine.h"
 #include "ardour/audiofilesource.h"
 #include "ardour/audioregion.h"
+#include "ardour/auditioner.h"
 #include "ardour/automation_control.h"
+#include "ardour/boost_debug.h"
 #include "ardour/butler.h"
+#include "ardour/controllable_descriptor.h"
 #include "ardour/control_protocol_manager.h"
 #include "ardour/directory_names.h"
 #include "ardour/filename_extensions.h"
 #include "ardour/proxy_controllable.h"
 #include "ardour/recent_sessions.h"
 #include "ardour/region_factory.h"
+#include "ardour/revision.h"
 #include "ardour/route_group.h"
 #include "ardour/send.h"
 #include "ardour/session.h"
 #include "ardour/tempo.h"
 #include "ardour/ticker.h"
 #include "ardour/user_bundle.h"
+#include "ardour/vca.h"
+#include "ardour/vca_manager.h"
 
 #include "control_protocol/control_protocol.h"
 
-#include "i18n.h"
+#include "LuaBridge/LuaBridge.h"
+
+#include "pbd/i18n.h"
 #include <locale.h>
 
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+#define DEBUG_UNDO_HISTORY(msg) DEBUG_TRACE (PBD::DEBUG::UndoHistory, string_compose ("%1: %2\n", __LINE__, msg));
+
 void
 Session::pre_engine_init (string fullpath)
 {
@@ -142,8 +151,18 @@ Session::pre_engine_init (string fullpath)
        _path = canonical_path(fullpath);
 
        /* is it new ? */
+       if (Profile->get_trx() ) {
+               // Waves TracksLive has a usecase of session replacement with a new one.
+               // We should check session state file (<session_name>.ardour) existance
+               // to determine if the session is new or not
 
-       _is_new = !Glib::file_test (_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR));
+               string full_session_name = Glib::build_filename( fullpath, _name );
+               full_session_name += statefile_suffix;
+
+               _is_new = !Glib::file_test (full_session_name, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR));
+       } else {
+               _is_new = !Glib::file_test (_path, Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR));
+       }
 
        /* finish initialization that can't be done in a normal C++ constructor
           definition.
@@ -167,7 +186,7 @@ Session::pre_engine_init (string fullpath)
        last_rr_session_dir = session_dirs.begin();
 
        set_history_depth (Config->get_history_depth());
-       
+
         /* default: assume simple stereo speaker configuration */
 
         _speakers->setup_default_speakers (2);
@@ -189,8 +208,6 @@ Session::pre_engine_init (string fullpath)
 
        Delivery::disable_panners ();
        IO::disable_connecting ();
-
-       AudioFileSource::set_peak_dir (_session_dir->peak_path());
 }
 
 int
@@ -204,26 +221,26 @@ Session::post_engine_init ()
        BootMessage (_("Using configuration"));
 
        _midi_ports = new MidiPortManager;
-       
+
        MIDISceneChanger* msc;
 
        _scene_changer = msc = new MIDISceneChanger (*this);
-       msc->set_input_port (scene_input_port());
-       msc->set_output_port (scene_out());
+       msc->set_input_port (boost::dynamic_pointer_cast<MidiPort>(scene_input_port()));
+       msc->set_output_port (boost::dynamic_pointer_cast<MidiPort>(scene_output_port()));
 
        boost::function<framecnt_t(void)> timer_func (boost::bind (&Session::audible_frame, this));
-       boost::dynamic_pointer_cast<AsyncMIDIPort>(scene_in())->set_timer (timer_func);
+       boost::dynamic_pointer_cast<AsyncMIDIPort>(scene_input_port())->set_timer (timer_func);
 
        setup_midi_machine_control ();
-       
+
        if (_butler->start_thread()) {
                return -1;
        }
-       
+
        if (start_midi_thread ()) {
                return -1;
        }
-       
+
        setup_click_sounds (0);
        setup_midi_control ();
 
@@ -236,9 +253,11 @@ Session::post_engine_init ()
                delete _tempo_map;
                _tempo_map = new TempoMap (_current_frame_rate);
                _tempo_map->PropertyChanged.connect_same_thread (*this, boost::bind (&Session::tempo_map_changed, this, _1));
-               
+               _tempo_map->MetricPositionChanged.connect_same_thread (*this, boost::bind (&Session::gui_tempo_map_changed, this));
+
                /* MidiClock requires a tempo map */
 
+               delete midi_clock;
                midi_clock = new MidiClockTicker ();
                midi_clock->set_session (this);
 
@@ -246,14 +265,14 @@ Session::post_engine_init ()
 
                SndFileSource::setup_standard_crossfades (*this, frame_rate());
                _engine.GraphReordered.connect_same_thread (*this, boost::bind (&Session::graph_reordered, this));
-               
+
                AudioDiskstream::allocate_working_buffers();
                refresh_disk_space ();
-               
+
                /* we're finally ready to call set_state() ... all objects have
                 * been created, the engine is running.
                 */
-               
+
                if (state_tree) {
                        if (set_state (*state_tree->root(), Stateful::loading_state_version)) {
                                return -1;
@@ -268,56 +287,56 @@ Session::post_engine_init ()
 
                boost::function<void (std::string)> ff (boost::bind (&Session::config_changed, this, _1, false));
                boost::function<void (std::string)> ft (boost::bind (&Session::config_changed, this, _1, true));
-               
+
                Config->map_parameters (ff);
                config.map_parameters (ft);
                 _butler->map_parameters ();
 
                /* Reset all panners */
-               
+
                Delivery::reset_panners ();
-               
+
                /* this will cause the CPM to instantiate any protocols that are in use
                 * (or mandatory), which will pass it this Session, and then call
                 * set_state() on each instantiated protocol to match stored state.
                 */
-               
+
                ControlProtocolManager::instance().set_session (this);
-               
+
                /* This must be done after the ControlProtocolManager set_session above,
                   as it will set states for ports which the ControlProtocolManager creates.
                */
-               
+
                // XXX set state of MIDI::Port's
                // MidiPortManager::instance()->set_port_states (Config->midi_port_states ());
-               
+
                /* And this must be done after the MIDI::Manager::set_port_states as
                 * it will try to make connections whose details are loaded by set_port_states.
                 */
-               
+
                hookup_io ();
-               
+
                /* Let control protocols know that we are now all connected, so they
                 * could start talking to surfaces if they want to.
                 */
-               
+
                ControlProtocolManager::instance().midi_connectivity_established ();
-               
+
                if (_is_new && !no_auto_connect()) {
                        Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
                        auto_connect_master_bus ();
                }
-               
+
                _state_of_the_state = StateOfTheState (_state_of_the_state & ~(CannotSave|Dirty));
-               
+
                /* update latencies */
-               
+
                initialize_latencies ();
-               
+
                _locations->added.connect_same_thread (*this, boost::bind (&Session::location_added, this, _1));
                _locations->removed.connect_same_thread (*this, boost::bind (&Session::location_removed, this, _1));
                _locations->changed.connect_same_thread (*this, boost::bind (&Session::locations_changed, this));
-               
+
        } catch (AudioEngine::PortRegistrationFailure& err) {
                /* handle this one in a different way than all others, so that its clear what happened */
                error << err.what() << endmsg;
@@ -334,7 +353,7 @@ Session::post_engine_init ()
        send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdMmcReset));
        send_immediate_mmc (MIDI::MachineControlCommand (Timecode::Time ()));
 
-       MIDI::Name::MidiPatchManager::instance().set_session (this);
+       MIDI::Name::MidiPatchManager::instance().add_search_path (session_directory().midi_patch_path() );
 
        ltc_tx_initialize();
        /* initial program change will be delivered later; see ::config_changed() */
@@ -354,9 +373,9 @@ Session::post_engine_init ()
        }
 
        /* Now, finally, we can fill the playback buffers */
-    
+
        BootMessage (_("Filling playback buffers"));
-    
+
        boost::shared_ptr<RouteList> rl = routes.reader();
        for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
                boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
@@ -372,11 +391,11 @@ void
 Session::session_loaded ()
 {
        SessionLoaded();
-       
+
        _state_of_the_state = Clean;
-       
+
        DirtyChanged (); /* EMIT SIGNAL */
-       
+
        if (_is_new) {
                save_state ("");
        } else if (state_was_pending) {
@@ -384,18 +403,11 @@ Session::session_loaded ()
                remove_pending_capture_state ();
                state_was_pending = false;
        }
-       
+
        /* Now, finally, we can fill the playback buffers */
-       
+
        BootMessage (_("Filling playback buffers"));
-       
-       boost::shared_ptr<RouteList> rl = routes.reader();
-       for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
-               boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (*r);
-               if (trk && !trk->hidden()) {
-                       trk->seek (_transport_frame, true);
-               }
-       }
+       force_locate (_transport_frame, false);
 }
 
 string
@@ -534,9 +546,9 @@ Session::create (const string& session_template, BusProfile* bus_profile)
        _writable = exists_and_writable (_path);
 
        if (!session_template.empty()) {
-               std::string in_path = (ARDOUR::Profile->get_trx () ? session_template : session_template_dir_to_file (session_template));
+               string in_path = (ARDOUR::Profile->get_trx () ? session_template : session_template_dir_to_file (session_template));
 
-               ifstream in(in_path.c_str());
+               FILE* in = g_fopen (in_path.c_str(), "rb");
 
                if (in) {
                        /* no need to call legalize_for_path() since the string
@@ -544,23 +556,51 @@ Session::create (const string& session_template, BusProfile* bus_profile)
                         */
                        string out_path = Glib::build_filename (_session_dir->root_path(), _name + statefile_suffix);
 
-                       ofstream out(out_path.c_str());
+                       FILE* out = g_fopen (out_path.c_str(), "wb");
 
                        if (out) {
-                               out << in.rdbuf();
-                                _is_new = false;
-
-                                if (!ARDOUR::Profile->get_trx()) {
-                                       /* Copy plugin state files from template to new session */
-                                       std::string template_plugins = Glib::build_filename (session_template, X_("plugins"));
-                                       copy_recurse (template_plugins, plugins_dir ());
-                                }
-                                
+                               char buf[1024];
+                               stringstream new_session;
+
+                               while (!feof (in)) {
+                                       size_t charsRead = fread (buf, sizeof(char), 1024, in);
+
+                                       if (ferror (in)) {
+                                               error << string_compose (_("Error reading session template file %1 (%2)"), in_path, strerror (errno)) << endmsg;
+                                               fclose (in);
+                                               fclose (out);
+                                               return -1;
+                                       }
+                                       if (charsRead == 0) {
+                                               break;
+                                       }
+                                       new_session.write (buf, charsRead);
+                               }
+                               fclose (in);
+
+                               string file_contents = new_session.str();
+                               size_t writeSize = file_contents.length();
+                               if (fwrite (file_contents.c_str(), sizeof(char), writeSize, out) != writeSize) {
+                                       error << string_compose (_("Error writing session template file %1 (%2)"), out_path, strerror (errno)) << endmsg;
+                                       fclose (out);
+                                       return -1;
+                               }
+                               fclose (out);
+
+                               _is_new = false;
+
+                               if (!ARDOUR::Profile->get_trx()) {
+                                       /* Copy plugin state files from template to new session */
+                                       std::string template_plugins = Glib::build_filename (session_template, X_("plugins"));
+                                       copy_recurse (template_plugins, plugins_dir ());
+                               }
+
                                return 0;
 
                        } else {
                                error << string_compose (_("Could not open %1 for writing session template"), out_path)
                                        << endmsg;
+                               fclose(in);
                                return -1;
                        }
 
@@ -572,11 +612,25 @@ Session::create (const string& session_template, BusProfile* bus_profile)
 
        }
 
-       /* set initial start + end point */
+       if (Profile->get_trx()) {
+
+               /* set initial start + end point : ARDOUR::Session::session_end_shift long.
+                  Remember that this is a brand new session. Sessions
+                  loaded from saved state will get this range from the saved state.
+               */
+
+               set_session_range_location (0, 0);
+
+               /* Initial loop location, from absolute zero, length 10 seconds  */
+
+               Location* loc = new Location (*this, 0, 10.0 * _engine.sample_rate(), _("Loop"),  Location::IsAutoLoop);
+               _locations->add (loc, true);
+               set_auto_loop_location (loc);
+       }
 
        _state_of_the_state = Clean;
 
-        /* set up Master Out and Control Out if necessary */
+        /* set up Master Out and Monitor Out if necessary */
 
         if (bus_profile) {
 
@@ -585,14 +639,14 @@ Session::create (const string& session_template, BusProfile* bus_profile)
 
                 // Waves Tracks: always create master bus for Tracks
                 if (ARDOUR::Profile->get_trx() || bus_profile->master_out_channels) {
-                       boost::shared_ptr<Route> r (new Route (*this, _("Master"), Route::MasterOut, DataType::AUDIO));
+                       boost::shared_ptr<Route> r (new Route (*this, _("Master"), PresentationInfo::MasterOut, DataType::AUDIO));
                         if (r->init ()) {
                                 return -1;
                         }
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-                       // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
-#endif
-                       {
+
+                        BOOST_MARK_ROUTE(r);
+
+                        {
                                Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
                                r->input()->ensure_io (count, false, this);
                                r->output()->ensure_io (count, false, this);
@@ -606,20 +660,20 @@ Session::create (const string& session_template, BusProfile* bus_profile)
                }
 
                if (!rl.empty()) {
-                       add_routes (rl, false, false, false);
+                       add_routes (rl, false, false, false, PresentationInfo::max_order);
                }
 
                // Waves Tracks: Skip this. Always use autoconnection for Tracks
                if (!ARDOUR::Profile->get_trx()) {
-                       
+
                        /* this allows the user to override settings with an environment variable.
                         */
-                       
+
                        if (no_auto_connect()) {
                                bus_profile->input_ac = AutoConnectOption (0);
                                bus_profile->output_ac = AutoConnectOption (0);
                        }
-                       
+
                        Config->set_input_auto_connect (bus_profile->input_ac);
                        Config->set_output_auto_connect (bus_profile->output_ac);
                }
@@ -711,6 +765,8 @@ Session::remove_state (string snapshot_name)
 int
 Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot, bool template_only)
 {
+       DEBUG_TRACE (DEBUG::Locale, string_compose ("Session::save_state locale '%1'\n", setlocale (LC_NUMERIC, NULL)));
+
        XMLTree tree;
        std::string xml_path(_session_dir->root_path());
 
@@ -735,6 +791,10 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
                return 1;
        }
 
+#ifndef NDEBUG
+       const int64_t save_start_time = g_get_monotonic_time();
+#endif
+
        /* tell sources we're saving first, in case they write out to a new file
         * which should be saved with the state rather than the old one */
        for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
@@ -747,7 +807,14 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
 
        SessionSaveUnderway (); /* EMIT SIGNAL */
 
+       bool mark_as_clean = true;
+
+       if (!snapshot_name.empty() && !switch_to_snapshot) {
+               mark_as_clean = false;
+       }
+
        if (template_only) {
+               mark_as_clean = false;
                tree.set_root (&get_template());
        } else {
                tree.set_root (&get_state());
@@ -756,8 +823,10 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
        if (snapshot_name.empty()) {
                snapshot_name = _current_snapshot_name;
        } else if (switch_to_snapshot) {
-                _current_snapshot_name = snapshot_name;
-        }
+               set_snapshot_name (snapshot_name);
+       }
+
+       assert (!snapshot_name.empty());
 
        if (!pending) {
 
@@ -782,7 +851,7 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
        tmp_path = Glib::build_filename (tmp_path, legalize_for_path (snapshot_name) + temp_suffix);
 
        cerr << "actually writing state to " << tmp_path << endl;
-       
+
        if (!tree.write (tmp_path)) {
                error << string_compose (_("state could not be saved to %1"), tmp_path) << endmsg;
                if (g_remove (tmp_path.c_str()) != 0) {
@@ -794,7 +863,7 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
        } else {
 
                cerr << "renaming state to " << xml_path << endl;
-               
+
                if (::g_rename (tmp_path.c_str(), xml_path.c_str()) != 0) {
                        error << string_compose (_("could not rename temporary session file %1 to %2 (%3)"),
                                        tmp_path, xml_path, g_strerror(errno)) << endmsg;
@@ -810,17 +879,23 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
 
                save_history (snapshot_name);
 
-               bool was_dirty = dirty();
+               if (mark_as_clean) {
+                       bool was_dirty = dirty();
 
-               _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
+                       _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
 
-               if (was_dirty) {
-                       DirtyChanged (); /* EMIT SIGNAL */
+                       if (was_dirty) {
+                               DirtyChanged (); /* EMIT SIGNAL */
+                       }
                }
 
                StateSaved (snapshot_name); /* EMIT SIGNAL */
        }
 
+#ifndef NDEBUG
+       const int64_t elapsed_time_us = g_get_monotonic_time() - save_start_time;
+       cerr << "saved state in " << fixed << setprecision (1) << elapsed_time_us / 1000. << " ms\n";
+#endif
        return 0;
 }
 
@@ -882,7 +957,7 @@ Session::load_state (string snapshot_name)
                return -1;
        }
 
-       XMLNode& root (*state_tree->root());
+       XMLNode const & root (*state_tree->root());
 
        if (root.name() != X_("Session")) {
                error << string_compose (_("Session file %1 is not a session"), xmlpath) << endmsg;
@@ -891,7 +966,7 @@ Session::load_state (string snapshot_name)
                return -1;
        }
 
-       const XMLProperty* prop;
+       XMLProperty const * prop;
 
        if ((prop = root.property ("version")) == 0) {
                /* no version implies very old version of Ardour */
@@ -918,22 +993,24 @@ Session::load_state (string snapshot_name)
                // only create a backup for a given statefile version once
 
                if (!Glib::file_test (backup_path, Glib::FILE_TEST_EXISTS)) {
-                       
+
                        VersionMismatch (xmlpath, backup_path);
-                       
+
                        if (!copy_file (xmlpath, backup_path)) {;
                                return -1;
                        }
                }
        }
 
+       save_snapshot_name (snapshot_name);
+
        return 0;
 }
 
 int
 Session::load_options (const XMLNode& node)
 {
-       LocaleGuard lg (X_("C"));
+       LocaleGuard lg;
        config.set_variables (node);
        return 0;
 }
@@ -966,6 +1043,7 @@ Session::get_template()
 XMLNode&
 Session::state (bool full_state)
 {
+       LocaleGuard lg;
        XMLNode* node = new XMLNode("Session");
        XMLNode* child;
 
@@ -973,12 +1051,18 @@ Session::state (bool full_state)
        snprintf(buf, sizeof(buf), "%d", CURRENT_SESSION_FILE_VERSION);
        node->add_property("version", buf);
 
+       child = node->add_child ("ProgramVersion");
+       child->add_property("created-with", created_with);
+
+       std::string modified_with = string_compose ("%1 %2", PROGRAM_NAME, revision);
+       child->add_property("modified-with", modified_with);
+
        /* store configuration settings */
 
        if (full_state) {
 
                node->add_property ("name", _name);
-               snprintf (buf, sizeof (buf), "%" PRId64, _nominal_frame_rate);
+               snprintf (buf, sizeof (buf), "%" PRId64, _base_frame_rate);
                node->add_property ("sample-rate", buf);
 
                if (session_dirs.size() > 1) {
@@ -1011,16 +1095,26 @@ Session::state (bool full_state)
                }
        }
 
+       node->add_property ("end-is-free", _session_range_end_is_free ? X_("yes") : X_("no"));
+
        /* save the ID counter */
 
        snprintf (buf, sizeof (buf), "%" PRIu64, ID::counter());
        node->add_property ("id-counter", buf);
 
+       snprintf (buf, sizeof (buf), "%u", name_id_counter ());
+       node->add_property ("name-counter", buf);
+
        /* save the event ID counter */
 
        snprintf (buf, sizeof (buf), "%d", Evoral::event_id_counter());
        node->add_property ("event-counter", buf);
 
+       /* save the VCA counter */
+
+       snprintf (buf, sizeof (buf), "%" PRIu32, VCA::get_next_vca_number());
+       node->add_property ("vca-counter", buf);
+
        /* various options */
 
        list<XMLNode*> midi_port_nodes = _midi_ports->get_midi_port_states();
@@ -1096,13 +1190,13 @@ Session::state (bool full_state)
                        }
                }
        }
-       
-       
+
+
 
        if (full_state) {
-               
+
                if (_locations) {
-                       node->add_child_nocopy (_locations->get_state());       
+                       node->add_child_nocopy (_locations->get_state());
                }
        } else {
                Locations loc (*this);
@@ -1112,7 +1206,7 @@ Session::state (bool full_state)
                range->set (max_framepos, 0);
                loc.add (range);
                XMLNode& locations_state = loc.get_state();
-               
+
                if (ARDOUR::Profile->get_trx() && _locations) {
                        // For tracks we need stored the Auto Loop Range and all MIDI markers.
                        for (Locations::LocationList::const_iterator i = _locations->list ().begin (); i != _locations->list ().end (); ++i) {
@@ -1135,6 +1229,8 @@ Session::state (bool full_state)
                }
        }
 
+       node->add_child_nocopy (_vca_manager->get_state());
+
        child = node->add_child ("Routes");
        {
                boost::shared_ptr<RouteList> r = routes.reader ();
@@ -1142,9 +1238,9 @@ Session::state (bool full_state)
                RoutePublicOrderSorter cmp;
                RouteList public_order (*r);
                public_order.sort (cmp);
-               
-               /* the sort should have put control outs first */
-               
+
+               /* the sort should have put the monitor out first */
+
                if (_monitor_out) {
                        assert (_monitor_out == public_order.front());
                }
@@ -1191,6 +1287,26 @@ Session::state (bool full_state)
                node->add_child_copy (*_extra_xml);
        }
 
+       {
+               Glib::Threads::Mutex::Lock lm (lua_lock);
+               std::string saved;
+               {
+                       luabridge::LuaRef savedstate ((*_lua_save)());
+                       saved = savedstate.cast<std::string>();
+               }
+               lua.collect_garbage ();
+               lm.release ();
+
+               gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
+               std::string b64s (b64);
+               g_free (b64);
+
+               XMLNode* script_node = new XMLNode (X_("Script"));
+               script_node->add_property (X_("lua"), LUA_VERSION);
+               script_node->add_content (b64s);
+               node->add_child_nocopy (*script_node);
+       }
+
        return *node;
 }
 
@@ -1204,9 +1320,10 @@ Session::get_control_protocol_state ()
 int
 Session::set_state (const XMLNode& node, int version)
 {
+       LocaleGuard lg;
        XMLNodeList nlist;
        XMLNode* child;
-       const XMLProperty* prop;
+       XMLProperty const * prop;
        int ret = -1;
 
        _state_of_the_state = StateOfTheState (_state_of_the_state|CannotSave);
@@ -1222,18 +1339,31 @@ Session::set_state (const XMLNode& node, int version)
 
        if ((prop = node.property (X_("sample-rate"))) != 0) {
 
-               _nominal_frame_rate = atoi (prop->value());
+               _base_frame_rate = atoi (prop->value());
+               _nominal_frame_rate = _base_frame_rate;
 
-               if (_nominal_frame_rate != _current_frame_rate) {
-                        boost::optional<int> r = AskAboutSampleRateMismatch (_nominal_frame_rate, _current_frame_rate);
+               assert (AudioEngine::instance()->running ());
+               if (_base_frame_rate != AudioEngine::instance()->sample_rate ()) {
+                       boost::optional<int> r = AskAboutSampleRateMismatch (_base_frame_rate, _current_frame_rate);
                        if (r.get_value_or (0)) {
                                goto out;
                        }
                }
        }
 
+       created_with = "unknown";
+       if ((child = find_named_node (node, "ProgramVersion")) != 0) {
+               if ((prop = child->property (X_("created-with"))) != 0) {
+                       created_with = prop->value ();
+               }
+       }
+
        setup_raid_path(_session_dir->root_path());
 
+       if ((prop = node.property (X_("end-is-free"))) != 0) {
+               _session_range_end_is_free = string_is_affirmative (prop->value());
+       }
+
        if ((prop = node.property (X_("id-counter"))) != 0) {
                uint64_t x;
                sscanf (prop->value().c_str(), "%" PRIu64, &x);
@@ -1248,10 +1378,21 @@ Session::set_state (const XMLNode& node, int version)
                ID::init_counter (now);
        }
 
-        if ((prop = node.property (X_("event-counter"))) != 0) {
-                Evoral::init_event_id_counter (atoi (prop->value()));
-        }
+       if ((prop = node.property (X_("name-counter"))) != 0) {
+               init_name_id_counter (atoi (prop->value()));
+       }
 
+       if ((prop = node.property (X_("event-counter"))) != 0) {
+               Evoral::init_event_id_counter (atoi (prop->value()));
+       }
+
+       if ((prop = node.property (X_("vca-counter"))) != 0) {
+               uint32_t x;
+               sscanf (prop->value().c_str(), "%" PRIu32, &x);
+               VCA::set_next_vca_number (x);
+       } else {
+               VCA::set_next_vca_number (1);
+       }
 
        if ((child = find_named_node (node, "MIDIPorts")) != 0) {
                _midi_ports->set_midi_port_states (child->children());
@@ -1355,6 +1496,10 @@ Session::set_state (const XMLNode& node, int version)
                }
        }
 
+       if ((child = find_named_node (node, VCAManager::xml_node_name)) != 0) {
+               _vca_manager->set_state (*child, version);
+       }
+
        if ((child = find_named_node (node, "Routes")) == 0) {
                error << _("Session: XML state has no routes section") << endmsg;
                goto out;
@@ -1362,6 +1507,10 @@ Session::set_state (const XMLNode& node, int version)
                goto out;
        }
 
+       /* Now that we have Routes and masters loaded, connect them if appropriate */
+
+       Slavable::Assign (_vca_manager); /* EMIT SIGNAL */
+
        /* our diskstreams list is no longer needed as they are now all owned by their Route */
        _diskstreams_2X.clear ();
 
@@ -1401,9 +1550,25 @@ Session::set_state (const XMLNode& node, int version)
                ControlProtocolManager::instance().set_state (*child, version);
        }
 
+       if ((child = find_named_node (node, "Script"))) {
+               for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
+                       if (!(*n)->is_content ()) { continue; }
+                       gsize size;
+                       guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
+                       try {
+                               Glib::Threads::Mutex::Lock lm (lua_lock);
+                               (*_lua_load)(std::string ((const char*)buf, size));
+                       } catch (luabridge::LuaException const& e) {
+                               cerr << "LuaException:" << e.what () << endl;
+                       }
+                       g_free (buf);
+               }
+       }
+
        update_route_record_state ();
 
        /* here beginneth the second phase ... */
+       set_snapshot_name (_current_snapshot_name);
 
        StateReady (); /* EMIT SIGNAL */
 
@@ -1449,7 +1614,7 @@ Session::load_routes (const XMLNode& node, int version)
 
        BootMessage (_("Tracks/busses loaded;  Adding to Session"));
 
-       add_routes (new_routes, false, false, false);
+       add_routes (new_routes, false, false, false, PresentationInfo::max_order);
 
        BootMessage (_("Finished adding tracks/busses"));
 
@@ -1468,7 +1633,7 @@ Session::XMLRouteFactory (const XMLNode& node, int version)
        XMLNode* ds_child = find_named_node (node, X_("Diskstream"));
 
        DataType type = DataType::AUDIO;
-       const XMLProperty* prop = node.property("default-type");
+       XMLProperty const * prop = node.property("default-type");
 
        if (prop) {
                type = DataType (prop->value());
@@ -1494,24 +1659,15 @@ Session::XMLRouteFactory (const XMLNode& node, int version)
                         return ret;
                 }
 
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-                // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
-#endif
+                BOOST_MARK_TRACK (track);
                 ret = track;
 
        } else {
-               enum Route::Flag flags = Route::Flag(0);
-               const XMLProperty* prop = node.property("flags");
-               if (prop) {
-                       flags = Route::Flag (string_2_enum (prop->value(), flags));
-               }
-
+               PresentationInfo::Flag flags = PresentationInfo::get_flags (node);
                boost::shared_ptr<Route> r (new Route (*this, X_("toBeResetFroXML"), flags));
 
                 if (r->init () == 0 && r->set_state (node, version) == 0) {
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-                        // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
-#endif
+                       BOOST_MARK_ROUTE (r);
                         ret = r;
                 }
        }
@@ -1534,7 +1690,7 @@ Session::XMLRouteFactory_2X (const XMLNode& node, int version)
        }
 
        DataType type = DataType::AUDIO;
-       const XMLProperty* prop = node.property("default-type");
+       XMLProperty const * prop = node.property("default-type");
 
        if (prop) {
                type = DataType (prop->value());
@@ -1572,24 +1728,15 @@ Session::XMLRouteFactory_2X (const XMLNode& node, int version)
 
                track->set_diskstream (*i);
 
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-                // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
-#endif
+               BOOST_MARK_TRACK (track);
                 ret = track;
 
        } else {
-               enum Route::Flag flags = Route::Flag(0);
-               const XMLProperty* prop = node.property("flags");
-               if (prop) {
-                       flags = Route::Flag (string_2_enum (prop->value(), flags));
-               }
-
+               PresentationInfo::Flag flags = PresentationInfo::get_flags (node);
                boost::shared_ptr<Route> r (new Route (*this, X_("toBeResetFroXML"), flags));
 
                 if (r->init () == 0 && r->set_state (node, version) == 0) {
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-                        // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
-#endif
+                       BOOST_MARK_ROUTE (r);
                         ret = r;
                 }
        }
@@ -1611,7 +1758,7 @@ Session::load_regions (const XMLNode& node)
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
                if ((region = XMLRegionFactory (**niter, false)) == 0) {
                        error << _("Session: cannot create Region from XML description.");
-                       const XMLProperty *name = (**niter).property("name");
+                       XMLProperty const * name = (**niter).property("name");
 
                        if (name) {
                                error << " " << string_compose (_("Can not load state for region '%1'"), name->value());
@@ -1629,7 +1776,7 @@ Session::load_compounds (const XMLNode& node)
 {
        XMLNodeList calist = node.children();
        XMLNodeConstIterator caiter;
-       XMLProperty *caprop;
+       XMLProperty const * caprop;
 
        for (caiter = calist.begin(); caiter != calist.end(); ++caiter) {
                XMLNode* ca = *caiter;
@@ -1673,10 +1820,10 @@ Session::load_nested_sources (const XMLNode& node)
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
                if ((*niter)->name() == "Source") {
 
-                       /* it may already exist, so don't recreate it unnecessarily 
+                       /* it may already exist, so don't recreate it unnecessarily
                         */
 
-                       XMLProperty* prop = (*niter)->property (X_("id"));
+                       XMLProperty const * prop = (*niter)->property (X_("id"));
                        if (!prop) {
                                error << _("Nested source has no ID info in session file! (ignored)") << endmsg;
                                continue;
@@ -1700,7 +1847,7 @@ Session::load_nested_sources (const XMLNode& node)
 boost::shared_ptr<Region>
 Session::XMLRegionFactory (const XMLNode& node, bool full)
 {
-       const XMLProperty* type = node.property("type");
+       XMLProperty const * type = node.property("type");
 
        try {
 
@@ -1729,7 +1876,7 @@ Session::XMLRegionFactory (const XMLNode& node, bool full)
 boost::shared_ptr<AudioRegion>
 Session::XMLAudioRegionFactory (const XMLNode& node, bool /*full*/)
 {
-       const XMLProperty* prop;
+       XMLProperty const * prop;
        boost::shared_ptr<Source> source;
        boost::shared_ptr<AudioSource> as;
        SourceList sources;
@@ -1848,7 +1995,7 @@ Session::XMLAudioRegionFactory (const XMLNode& node, bool /*full*/)
 boost::shared_ptr<MidiRegion>
 Session::XMLMidiRegionFactory (const XMLNode& node, bool /*full*/)
 {
-       const XMLProperty* prop;
+       XMLProperty const * prop;
        boost::shared_ptr<Source> source;
        boost::shared_ptr<MidiSource> ms;
        SourceList sources;
@@ -2047,7 +2194,7 @@ Session::XMLSourceFactory (const XMLNode& node)
 }
 
 int
-Session::save_template (string template_name)
+Session::save_template (string template_name, bool replace_existing)
 {
        if ((_state_of_the_state & CannotSave) || template_name.empty ()) {
                return -1;
@@ -2073,12 +2220,12 @@ Session::save_template (string template_name)
        }
 
        if (!ARDOUR::Profile->get_trx()) {
-               if (Glib::file_test (template_dir_path, Glib::FILE_TEST_EXISTS)) {
+               if (!replace_existing && Glib::file_test (template_dir_path, Glib::FILE_TEST_EXISTS)) {
                        warning << string_compose(_("Template \"%1\" already exists - new version not created"),
                                                                          template_dir_path) << endmsg;
-                       return -1;
+                       return -2;
                }
-               
+
                if (g_mkdir_with_parents (template_dir_path.c_str(), 0755) != 0) {
                        error << string_compose(_("Could not create directory for Session template\"%1\" (%2)"),
                                                                        template_dir_path, g_strerror (errno)) << endmsg;
@@ -2088,7 +2235,7 @@ Session::save_template (string template_name)
 
        /* file to write */
        std::string template_file_path;
-       
+
        if (ARDOUR::Profile->get_trx()) {
                template_file_path = template_name;
        } else {
@@ -2100,28 +2247,19 @@ Session::save_template (string template_name)
        }
 
        SessionSaveUnderway (); /* EMIT SIGNAL */
-       
+
        XMLTree tree;
 
-       tree.set_root (&get_template());
+       {
+               PBD::Unwinder<std::string> uw (_template_state_dir, template_dir_path);
+               tree.set_root (&get_template());
+       }
+
        if (!tree.write (template_file_path)) {
                error << _("template not saved") << endmsg;
                return -1;
        }
 
-       if (!ARDOUR::Profile->get_trx()) {
-               /* copy plugin state directory */
-
-               std::string template_plugin_state_path (Glib::build_filename (template_dir_path, X_("plugins")));
-
-               if (g_mkdir_with_parents (template_plugin_state_path.c_str(), 0755) != 0) {
-                       error << string_compose(_("Could not create directory for Session template plugin state\"%1\" (%2)"),
-                                                                       template_plugin_state_path, g_strerror (errno)) << endmsg;
-                       return -1;
-               }
-               copy_files (plugins_dir(), template_plugin_state_path);
-       }
-
        store_recent_templates (template_file_path);
 
        return 0;
@@ -2130,8 +2268,8 @@ Session::save_template (string template_name)
 void
 Session::refresh_disk_space ()
 {
-#if __APPLE__ || (HAVE_SYS_VFS_H && HAVE_SYS_STATVFS_H)
-       
+#if __APPLE__ || __FreeBSD__ || (HAVE_SYS_VFS_H && HAVE_SYS_STATVFS_H)
+
        Glib::Threads::Mutex::Lock lm (space_lock);
 
        /* get freespace on every FS that is part of the session path */
@@ -2325,25 +2463,25 @@ Session::get_best_session_directory_for_new_audio ()
 string
 Session::automation_dir () const
 {
-       return Glib::build_filename (_path, "automation");
+       return Glib::build_filename (_path, automation_dir_name);
 }
 
 string
 Session::analysis_dir () const
 {
-       return Glib::build_filename (_path, "analysis");
+       return Glib::build_filename (_path, analysis_dir_name);
 }
 
 string
 Session::plugins_dir () const
 {
-       return Glib::build_filename (_path, "plugins");
+       return Glib::build_filename (_path, plugins_dir_name);
 }
 
 string
 Session::externals_dir () const
 {
-       return Glib::build_filename (_path, "externals");
+       return Glib::build_filename (_path, externals_dir_name);
 }
 
 int
@@ -2509,6 +2647,25 @@ Session::add_commands (vector<Command*> const & cmds)
        }
 }
 
+void
+Session::add_command (Command* const cmd)
+{
+       assert (_current_trans);
+       DEBUG_UNDO_HISTORY (
+           string_compose ("Current Undo Transaction %1, adding command: %2",
+                           _current_trans->name (),
+                           cmd->name ()));
+       _current_trans->add_command (cmd);
+}
+
+PBD::StatefulDiffCommand*
+Session::add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd)
+{
+       PBD::StatefulDiffCommand* cmd = new PBD::StatefulDiffCommand (sfd);
+       add_command (cmd);
+       return cmd;
+}
+
 void
 Session::begin_reversible_command (const string& name)
 {
@@ -2528,10 +2685,17 @@ Session::begin_reversible_command (GQuark q)
        */
 
        if (_current_trans == 0) {
+               DEBUG_UNDO_HISTORY (string_compose (
+                   "Begin Reversible Command, new transaction: %1", g_quark_to_string (q)));
+
                /* start a new transaction */
                assert (_current_trans_quarks.empty ());
                _current_trans = new UndoTransaction();
                _current_trans->set_name (g_quark_to_string (q));
+       } else {
+               DEBUG_UNDO_HISTORY (
+                   string_compose ("Begin Reversible Command, current transaction: %1",
+                                   _current_trans->name ()));
        }
 
        _current_trans_quarks.push_front (q);
@@ -2541,6 +2705,8 @@ void
 Session::abort_reversible_command ()
 {
        if (_current_trans != 0) {
+               DEBUG_UNDO_HISTORY (
+                   string_compose ("Abort Reversible Command: %1", _current_trans->name ()));
                _current_trans->clear();
                delete _current_trans;
                _current_trans = 0;
@@ -2557,18 +2723,34 @@ Session::commit_reversible_command (Command *cmd)
        struct timeval now;
 
        if (cmd) {
+               DEBUG_UNDO_HISTORY (
+                   string_compose ("Current Undo Transaction %1, adding command: %2",
+                                   _current_trans->name (),
+                                   cmd->name ()));
                _current_trans->add_command (cmd);
        }
 
+       DEBUG_UNDO_HISTORY (
+           string_compose ("Commit Reversible Command, current transaction: %1",
+                           _current_trans->name ()));
+
        _current_trans_quarks.pop_front ();
 
        if (!_current_trans_quarks.empty ()) {
+               DEBUG_UNDO_HISTORY (
+                   string_compose ("Commit Reversible Command, transaction is not "
+                                   "top-level, current transaction: %1",
+                                   _current_trans->name ()));
                /* the transaction we're committing is not the top-level one */
                return;
        }
 
        if (_current_trans->empty()) {
                /* no commands were added to the transaction, so just get rid of it */
+               DEBUG_UNDO_HISTORY (
+                   string_compose ("Commit Reversible Command, No commands were "
+                                   "added to current transaction: %1",
+                                   _current_trans->name ()));
                delete _current_trans;
                _current_trans = 0;
                return;
@@ -2645,7 +2827,7 @@ Session::find_all_sources (string path, set<string>& result)
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
-               XMLProperty* prop;
+               XMLProperty const * prop;
 
                if ((prop = (*niter)->property (X_("type"))) == 0) {
                        continue;
@@ -2696,14 +2878,17 @@ Session::find_all_sources_across_snapshots (set<string>& result, bool exclude_th
                return 0;
        }
 
-       this_snapshot_path = _path;
-       this_snapshot_path += legalize_for_path (_current_snapshot_name);
+       this_snapshot_path = Glib::build_filename (_path, legalize_for_path (_current_snapshot_name));
        this_snapshot_path += statefile_suffix;
 
        for (vector<string>::iterator i = state_files.begin(); i != state_files.end(); ++i) {
 
+               cerr << "Looking at snapshot " << (*i) << " ( with this = [" << this_snapshot_path << "])\n";
+
                if (exclude_this_snapshot && *i == this_snapshot_path) {
+                       cerr << "\texcluded\n";
                        continue;
+
                }
 
                if (find_all_sources (*i, result) < 0) {
@@ -2736,25 +2921,34 @@ Session::cleanup_regions ()
        bool removed = false;
        const RegionFactory::RegionMap& regions (RegionFactory::regions());
 
-       for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
+       for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end();) {
 
                uint32_t used = playlists->region_use_count (i->second);
 
                if (used == 0 && !i->second->automatic ()) {
+                       boost::weak_ptr<Region> w = i->second;
+                       ++i;
                        removed = true;
-                       RegionFactory::map_remove (i->second);
+                       RegionFactory::map_remove (w);
+               } else {
+                       ++i;
                }
        }
 
        if (removed) {
                // re-check to remove parent references of compound regions
-               for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
+               for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end();) {
                        if (!(i->second->whole_file() && i->second->max_source_level() > 0)) {
+                               ++i;
                                continue;
                        }
                        assert(boost::dynamic_pointer_cast<PlaylistSource>(i->second->source (0)) != 0);
                        if (0 == playlists->region_use_count (i->second)) {
-                               RegionFactory::map_remove (i->second);
+                               boost::weak_ptr<Region> w = i->second;
+                               ++i;
+                               RegionFactory::map_remove (w);
+                       } else {
+                               ++i;
                        }
                }
        }
@@ -2765,6 +2959,72 @@ Session::cleanup_regions ()
        save_state ("");
 }
 
+bool
+Session::can_cleanup_peakfiles () const
+{
+       if (deletion_in_progress()) {
+               return false;
+       }
+       if (!_writable || (_state_of_the_state & CannotSave)) {
+               warning << _("Cannot cleanup peak-files for read-only session.") << endmsg;
+               return false;
+       }
+        if (record_status() == Recording) {
+               error << _("Cannot cleanup peak-files while recording") << endmsg;
+               return false;
+       }
+       return true;
+}
+
+int
+Session::cleanup_peakfiles ()
+{
+       Glib::Threads::Mutex::Lock lm (peak_cleanup_lock, Glib::Threads::TRY_LOCK);
+       if (!lm.locked()) {
+               return -1;
+       }
+
+       assert (can_cleanup_peakfiles ());
+       assert (!peaks_cleanup_in_progres());
+
+       _state_of_the_state = StateOfTheState (_state_of_the_state | PeakCleanup);
+
+       int timeout = 5000; // 5 seconds
+       while (!SourceFactory::files_with_peaks.empty()) {
+               Glib::usleep (1000);
+               if (--timeout < 0) {
+                       warning << _("Timeout waiting for peak-file creation to terminate before cleanup, please try again later.") << endmsg;
+                       _state_of_the_state = StateOfTheState (_state_of_the_state & (~PeakCleanup));
+                       return -1;
+               }
+       }
+
+       for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
+               boost::shared_ptr<AudioSource> as;
+               if ((as = boost::dynamic_pointer_cast<AudioSource> (i->second)) != 0) {
+                       as->close_peakfile();
+               }
+       }
+
+       PBD::clear_directory (session_directory().peak_path());
+
+       _state_of_the_state = StateOfTheState (_state_of_the_state & (~PeakCleanup));
+
+       for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
+               boost::shared_ptr<AudioSource> as;
+               if ((as = boost::dynamic_pointer_cast<AudioSource> (i->second)) != 0) {
+                       SourceFactory::setup_peakfile(as, true);
+               }
+       }
+       return 0;
+}
+
+static void
+merge_all_sources (boost::shared_ptr<const Playlist> pl, std::set<boost::shared_ptr<Source> >* all_sources)
+{
+       pl->deep_sources (*all_sources);
+}
+
 int
 Session::cleanup_sources (CleanupReport& rep)
 {
@@ -2775,17 +3035,28 @@ Session::cleanup_sources (CleanupReport& rep)
        string midi_path;
        vector<string> candidates;
        vector<string> unused;
-       set<string> all_sources;
-       bool used;
+       set<string> sources_used_by_all_snapshots;
        string spath;
        int ret = -1;
        string tmppath1;
        string tmppath2;
        Searchpath asp;
        Searchpath msp;
+       set<boost::shared_ptr<Source> > sources_used_by_this_snapshot;
 
        _state_of_the_state = (StateOfTheState) (_state_of_the_state | InCleanup);
 
+       /* this is mostly for windows which doesn't allow file
+        * renaming if the file is in use. But we don't special
+        * case it because we need to know if this causes
+        * problems, and the easiest way to notice that is to
+        * keep it in place for all platforms.
+        */
+
+       request_stop (false);
+       _butler->summon ();
+       _butler->wait_until_finished ();
+
        /* consider deleting all unused playlists */
 
        if (playlists->maybe_delete_unused (boost::bind (Session::ask_about_playlist_deletion, _1))) {
@@ -2842,12 +3113,21 @@ Session::cleanup_sources (CleanupReport& rep)
        find_files_matching_filter (candidates, audio_path, accept_all_audio_files, (void *) 0, true, true);
        find_files_matching_filter (candidates, midi_path, accept_all_midi_files, (void *) 0, true, true);
 
-       /* find all sources, but don't use this snapshot because the
-          state file on disk still references sources we may have already
-          dropped.
+       /* add sources from all other snapshots as "used", but don't use this
+          snapshot because the state file on disk still references sources we
+          may have already dropped.
        */
 
-       find_all_sources_across_snapshots (all_sources, true);
+       find_all_sources_across_snapshots (sources_used_by_all_snapshots, true);
+
+       /* Although the region factory has a list of all regions ever created
+        * for this session, we're only interested in regions actually in
+        * playlists right now. So merge all playlist regions lists together.
+        *
+        * This will include the playlists used within compound regions.
+        */
+
+       playlists->foreach (boost::bind (merge_all_sources, _1, &sources_used_by_this_snapshot));
 
        /*  add our current source list
         */
@@ -2857,49 +3137,76 @@ Session::cleanup_sources (CleanupReport& rep)
                 SourceMap::iterator tmp = i;
                 ++tmp;
 
-               if ((fs = boost::dynamic_pointer_cast<FileSource> (i->second)) != 0) {
+               if ((fs = boost::dynamic_pointer_cast<FileSource> (i->second)) == 0) {
+                       /* not a file */
+                       i = tmp;
+                       continue;
+               }
 
-                       if (!fs->is_stub()) {
+               /* this is mostly for windows which doesn't allow file
+                * renaming if the file is in use. But we do not special
+                * case it because we need to know if this causes
+                * problems, and the easiest way to notice that is to
+                * keep it in place for all platforms.
+                */
 
-                               if (playlists->source_use_count (fs) != 0) {
-                                       all_sources.insert (fs->path());
-                               } else {
-                                       
-                                       /* we might not remove this source from disk, because it may be used
-                                          by other snapshots, but its not being used in this version
-                                          so lets get rid of it now, along with any representative regions
-                                          in the region list.
-                                       */
-                                       
-                                       RegionFactory::remove_regions_using_source (i->second);
-                                       sources.erase (i);
-                                       
-                                       // also remove source from all_sources
-                                       
-                                       for (set<string>::iterator j = all_sources.begin(); j != all_sources.end(); ++j) {
-                                               spath = Glib::path_get_basename (*j);
-                                               if ( spath == i->second->name () ) {
-                                                       all_sources.erase (j);
-                                                       break;
-                                               }
-                                       }
-                               }
+               fs->close ();
+
+               if (!fs->is_stub()) {
+
+                       /* Note that we're checking a list of all
+                        * sources across all snapshots with the list
+                        * of sources used by this snapshot.
+                        */
+
+                       if (sources_used_by_this_snapshot.find (i->second) != sources_used_by_this_snapshot.end()) {
+                               /* this source is in use by this snapshot */
+                               sources_used_by_all_snapshots.insert (fs->path());
+                               cerr << "Source from source list found in used_by_this_snapshot (" << fs->path() << ")\n";
+                       } else {
+                               cerr << "Source from source list NOT found in used_by_this_snapshot (" << fs->path() << ")\n";
+                               /* this source is NOT in use by this snapshot
+                                */
+
+                               /* remove all related regions from RegionFactory master list
+                                */
+
+                               RegionFactory::remove_regions_using_source (i->second);
+
+                               /* remove from our current source list
+                                * also. We may not remove it from
+                                * disk, because it may be used by
+                                * other snapshots, but it isn't used inside this
+                                * snapshot anymore, so we don't need a
+                                * reference to it.
+                                */
+
+                               sources.erase (i);
                        }
                }
 
                 i = tmp;
        }
 
+       /* now check each candidate source to see if it exists in the list of
+          sources_used_by_all_snapshots. If it doesn't, put it into "unused".
+       */
+
+       cerr << "Candidates: " << candidates.size() << endl;
+       cerr << "Used by others: " << sources_used_by_all_snapshots.size() << endl;
+
        for (vector<string>::iterator x = candidates.begin(); x != candidates.end(); ++x) {
 
-               used = false;
+               bool used = false;
                spath = *x;
 
-               for (set<string>::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
+               for (set<string>::iterator i = sources_used_by_all_snapshots.begin(); i != sources_used_by_all_snapshots.end(); ++i) {
 
                        tmppath1 = canonical_path (spath);
                        tmppath2 = canonical_path ((*i));
 
+                       cerr << "\t => " << tmppath2 << endl;
+
                        if (tmppath1 == tmppath2) {
                                used = true;
                                break;
@@ -2911,10 +3218,18 @@ Session::cleanup_sources (CleanupReport& rep)
                }
        }
 
+       cerr << "Actually unused: " << unused.size() << endl;
+
+       if (unused.empty()) {
+               /* Nothing to do */
+               ret = 0;
+               goto out;
+       }
+
        /* now try to move all unused files into the "dead" directory(ies) */
 
        for (vector<string>::iterator x = unused.begin(); x != unused.end(); ++x) {
-               struct stat statbuf;
+               GStatBuf statbuf;
 
                string newpath;
 
@@ -2973,30 +3288,24 @@ Session::cleanup_sources (CleanupReport& rep)
                                newpath = newpath_v;
                        }
 
-               } else {
-
-                       /* it doesn't exist, or we can't read it or something */
-
                }
 
-               stat ((*x).c_str(), &statbuf);
+               g_stat ((*x).c_str(), &statbuf);
 
                if (::rename ((*x).c_str(), newpath.c_str()) != 0) {
-                       error << string_compose (_("cannot rename unused file source from %1 to %2 (%3)"),
-                                         (*x), newpath, strerror (errno))
-                             << endmsg;
-                       goto out;
+                       error << string_compose (_("cannot rename unused file source from %1 to %2 (%3)"), (*x), newpath, strerror (errno)) << endmsg;
+                       continue;
                }
 
                /* see if there an easy to find peakfile for this file, and remove it.
                 */
 
-                string base = basename_nosuffix (*x);
+                string base = Glib::path_get_basename (*x);
                 base += "%A"; /* this is what we add for the channel suffix of all native files,
                                  or for the first channel of embedded files. it will miss
                                  some peakfiles for other channels
                               */
-               string peakpath = peak_path (base);
+               string peakpath = construct_peak_filepath (base);
 
                if (Glib::file_test (peakpath.c_str(), Glib::FILE_TEST_EXISTS)) {
                        if (::g_unlink (peakpath.c_str()) != 0) {
@@ -3010,8 +3319,8 @@ Session::cleanup_sources (CleanupReport& rep)
                }
 
                rep.paths.push_back (*x);
-                rep.space += statbuf.st_size;
-        }
+               rep.space += statbuf.st_size;
+       }
 
        /* dump the history list */
 
@@ -3145,75 +3454,86 @@ boost::shared_ptr<Controllable>
 Session::controllable_by_descriptor (const ControllableDescriptor& desc)
 {
        boost::shared_ptr<Controllable> c;
+       boost::shared_ptr<Stripable> s;
        boost::shared_ptr<Route> r;
 
        switch (desc.top_level_type()) {
        case ControllableDescriptor::NamedRoute:
        {
                std::string str = desc.top_level_name();
+
                if (str == "Master" || str == "master") {
-                       r = _master_out;
-               } else if (str == "control" || str == "listen") {
-                       r = _monitor_out;
+                       s = _master_out;
+               } else if (str == "control" || str == "listen" || str == "monitor" || str == "Monitor") {
+                       s = _monitor_out;
+               } else if (str == "auditioner") {
+                       s = auditioner;
                } else {
-                       r = route_by_name (desc.top_level_name());
+                       s = route_by_name (desc.top_level_name());
                }
+
                break;
        }
 
-       case ControllableDescriptor::RemoteControlID:
-               r = route_by_remote_id (desc.rid());
+       case ControllableDescriptor::PresentationOrderRoute:
+               s = get_remote_nth_stripable (desc.presentation_order(), PresentationInfo::Route);
+               break;
+
+       case ControllableDescriptor::PresentationOrderTrack:
+               s = get_remote_nth_stripable (desc.presentation_order(), PresentationInfo::Track);
+               break;
+
+       case ControllableDescriptor::PresentationOrderBus:
+               s = get_remote_nth_stripable (desc.presentation_order(), PresentationInfo::Bus);
+               break;
+
+       case ControllableDescriptor::PresentationOrderVCA:
+               s = get_remote_nth_stripable (desc.presentation_order(), PresentationInfo::VCA);
+               break;
+
+       case ControllableDescriptor::SelectionCount:
+               s = route_by_selected_count (desc.selection_id());
                break;
        }
 
-       if (!r) {
+       if (!s) {
                return c;
        }
 
+       r = boost::dynamic_pointer_cast<Route> (s);
+
        switch (desc.subtype()) {
        case ControllableDescriptor::Gain:
-               c = r->gain_control ();
+               c = s->gain_control ();
                break;
 
        case ControllableDescriptor::Trim:
-               c = r->trim()->gain_control ();
+               c = s->trim_control ();
                break;
 
        case ControllableDescriptor::Solo:
-                c = r->solo_control();
+                c = s->solo_control();
                break;
 
        case ControllableDescriptor::Mute:
-               c = r->mute_control();
+               c = s->mute_control();
                break;
 
        case ControllableDescriptor::Recenable:
-       {
-               boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
-
-               if (t) {
-                       c = t->rec_enable_control ();
-               }
+               c = s->rec_enable_control ();
                break;
-       }
 
        case ControllableDescriptor::PanDirection:
-        {
-                c = r->pannable()->pan_azimuth_control;
+               c = s->pan_azimuth_control();
                break;
-        }
 
        case ControllableDescriptor::PanWidth:
-        {
-                c = r->pannable()->pan_width_control;
+               c = s->pan_width_control();
                break;
-        }
 
        case ControllableDescriptor::PanElevation:
-        {
-                c = r->pannable()->pan_elevation_control;
+               c = s->pan_elevation_control();
                break;
-        }
 
        case ControllableDescriptor::Balance:
                /* XXX simple pan control */
@@ -3234,6 +3554,10 @@ Session::controllable_by_descriptor (const ControllableDescriptor& desc)
                        --parameter_index;
                }
 
+               if (!r) {
+                       return c;
+               }
+
                boost::shared_ptr<Processor> p = r->nth_plugin (plugin);
 
                if (p) {
@@ -3243,26 +3567,15 @@ Session::controllable_by_descriptor (const ControllableDescriptor& desc)
                break;
        }
 
-       case ControllableDescriptor::SendGain:
-       {
+       case ControllableDescriptor::SendGain: {
                uint32_t send = desc.target (0);
-
-               /* revert to zero-based counting */
-
                if (send > 0) {
                        --send;
                }
-
-               boost::shared_ptr<Processor> p = r->nth_send (send);
-
-               if (p) {
-                       boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
-                       boost::shared_ptr<Amp> a = s->amp();
-                       
-                       if (a) {
-                               c = s->amp()->gain_control();
-                       }
+               if (!r) {
+                       return c;
                }
+               c = r->send_level_controllable (send);
                break;
        }
 
@@ -3301,7 +3614,7 @@ Session::save_history (string snapshot_name)
                return 0;
        }
 
-       if (!Config->get_save_history() || Config->get_saved_history_depth() < 0 || 
+       if (!Config->get_save_history() || Config->get_saved_history_depth() < 0 ||
            (_history.undo_depth() == 0 && _history.redo_depth() == 0)) {
                return 0;
        }
@@ -3563,9 +3876,9 @@ Session::config_changed (std::string p, bool ours)
                }
 
        } else if (p == "click-gain") {
-               
+
                if (_click_gain) {
-                       _click_gain->set_gain (Config->get_click_gain(), this);
+                       _click_gain->gain_control()->set_value (Config->get_click_gain(), Controllable::NoGroup);
                }
 
        } else if (p == "send-mtc") {
@@ -3634,7 +3947,7 @@ Session::config_changed (std::string p, bool ours)
        } else if (p == "solo-control-is-listen-control") {
                solo_control_mode_changed ();
        } else if (p == "solo-mute-gain") {
-               _solo_cut_control->Changed();
+               _solo_cut_control->Changed (true, Controllable::NoGroup);
        } else if (p == "timecode-offset" || p == "timecode-offset-negative") {
                last_timecode_valid = false;
        } else if (p == "playback-buffer-seconds") {
@@ -3692,7 +4005,20 @@ void
 Session::setup_midi_machine_control ()
 {
        _mmc = new MIDI::MachineControl;
-       _mmc->set_ports (_midi_ports->mmc_input_port(), _midi_ports->mmc_output_port());
+
+       boost::shared_ptr<AsyncMIDIPort> async_in = boost::dynamic_pointer_cast<AsyncMIDIPort> (_midi_ports->mmc_input_port());
+       boost::shared_ptr<AsyncMIDIPort> async_out = boost::dynamic_pointer_cast<AsyncMIDIPort> (_midi_ports->mmc_output_port());
+
+       if (!async_out || !async_out) {
+               return;
+       }
+
+       /* XXXX argh, passing raw pointers back into libmidi++ */
+
+       MIDI::Port* mmc_in = async_in.get();
+       MIDI::Port* mmc_out = async_out.get();
+
+       _mmc->set_ports (mmc_in, mmc_out);
 
        _mmc->Play.connect_same_thread (*this, boost::bind (&Session::mmc_deferred_play, this, _1));
        _mmc->DeferredPlay.connect_same_thread (*this, boost::bind (&Session::mmc_deferred_play, this, _1));
@@ -3730,6 +4056,27 @@ Session::solo_cut_control() const
         return _solo_cut_control;
 }
 
+void
+Session::save_snapshot_name (const std::string & n)
+{
+       /* assure Stateful::_instant_xml is loaded
+        * add_instant_xml() only adds to existing data and defaults
+        * to use an empty Tree otherwise
+        */
+       instant_xml ("LastUsedSnapshot");
+
+       XMLNode* last_used_snapshot = new XMLNode ("LastUsedSnapshot");
+       last_used_snapshot->add_property ("name", string(n));
+       add_instant_xml (*last_used_snapshot, false);
+}
+
+void
+Session::set_snapshot_name (const std::string & n)
+{
+       _current_snapshot_name = n;
+       save_snapshot_name (n);
+}
+
 int
 Session::rename (const std::string& new_name)
 {
@@ -3758,7 +4105,7 @@ Session::rename (const std::string& new_name)
         * interchange subdirectory
         * session file
         * session history
-        
+
         * Backup files are left unchanged and not renamed.
         */
 
@@ -3775,30 +4122,30 @@ Session::rename (const std::string& new_name)
                        fs->close ();
                }
        }
-       
+
        /* pass one: not 100% safe check that the new directory names don't
         * already exist ...
         */
 
        for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
-               
+
                oldstr = (*i).path;
-               
+
                /* this is a stupid hack because Glib::path_get_dirname() is
                 * lexical-only, and so passing it /a/b/c/ gives a different
                 * result than passing it /a/b/c ...
                 */
-               
+
                if (oldstr[oldstr.length()-1] == G_DIR_SEPARATOR) {
                        oldstr = oldstr.substr (0, oldstr.length() - 1);
                }
-               
+
                string base = Glib::path_get_dirname (oldstr);
-               
+
                newstr = Glib::build_filename (base, legal_name);
-               
+
                cerr << "Looking for " << newstr << endl;
-               
+
                if (Glib::file_test (newstr, Glib::FILE_TEST_EXISTS)) {
                        cerr << " exists\n";
                        return -1;
@@ -3808,18 +4155,18 @@ Session::rename (const std::string& new_name)
        /* Session dirs */
 
        first = true;
-       
+
        for (vector<space_and_path>::iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
 
                vector<string> v;
 
                oldstr = (*i).path;
-               
+
                /* this is a stupid hack because Glib::path_get_dirname() is
                 * lexical-only, and so passing it /a/b/c/ gives a different
                 * result than passing it /a/b/c ...
                 */
-               
+
                if (oldstr[oldstr.length()-1] == G_DIR_SEPARATOR) {
                        oldstr = oldstr.substr (0, oldstr.length() - 1);
                }
@@ -3828,8 +4175,8 @@ Session::rename (const std::string& new_name)
                newstr = Glib::build_filename (base, legal_name);
 
                cerr << "for " << oldstr << " new dir = " << newstr << endl;
-               
-               cerr << "Rename " << oldstr << " => " << newstr << endl;                
+
+               cerr << "Rename " << oldstr << " => " << newstr << endl;
                if (::g_rename (oldstr.c_str(), newstr.c_str()) != 0) {
                        cerr << string_compose (_("renaming %s as %2 failed (%3)"), oldstr, newstr, g_strerror (errno)) << endl;
                        error << string_compose (_("renaming %s as %2 failed (%3)"), oldstr, newstr, g_strerror (errno)) << endmsg;
@@ -3837,12 +4184,12 @@ Session::rename (const std::string& new_name)
                }
 
                /* Reset path in "session dirs" */
-               
+
                (*i).path = newstr;
                (*i).blocks = 0;
-               
+
                /* reset primary SessionDirectory object */
-               
+
                if (first) {
                        (*_session_dir) = newstr;
                        new_path = newstr;
@@ -3855,10 +4202,10 @@ Session::rename (const std::string& new_name)
                string new_interchange_dir;
 
                /* use newstr here because we renamed the path
-                * (folder/directory) that used to be oldstr to newstr above 
-                */     
-               
-               v.push_back (newstr); 
+                * (folder/directory) that used to be oldstr to newstr above
+                */
+
+               v.push_back (newstr);
                v.push_back (interchange_dir_name);
                v.push_back (Glib::path_get_basename (oldstr));
 
@@ -3868,11 +4215,11 @@ Session::rename (const std::string& new_name)
                v.push_back (newstr);
                v.push_back (interchange_dir_name);
                v.push_back (legal_name);
-               
+
                new_interchange_dir = Glib::build_filename (v);
-               
+
                cerr << "Rename " << old_interchange_dir << " => " << new_interchange_dir << endl;
-               
+
                if (::g_rename (old_interchange_dir.c_str(), new_interchange_dir.c_str()) != 0) {
                        cerr << string_compose (_("renaming %s as %2 failed (%3)"),
                                                 old_interchange_dir, new_interchange_dir,
@@ -3887,11 +4234,11 @@ Session::rename (const std::string& new_name)
        }
 
        /* state file */
-       
+
        oldstr = Glib::build_filename (new_path, _current_snapshot_name + statefile_suffix);
        newstr= Glib::build_filename (new_path, legal_name + statefile_suffix);
-       
-       cerr << "Rename " << oldstr << " => " << newstr << endl;                
+
+       cerr << "Rename " << oldstr << " => " << newstr << endl;
 
        if (::g_rename (oldstr.c_str(), newstr.c_str()) != 0) {
                cerr << string_compose (_("renaming %1 as %2 failed (%3)"), oldstr, newstr, g_strerror (errno)) << endl;
@@ -3900,14 +4247,14 @@ Session::rename (const std::string& new_name)
        }
 
        /* history file */
-       
+
        oldstr = Glib::build_filename (new_path, _current_snapshot_name) + history_suffix;
 
        if (Glib::file_test (oldstr, Glib::FILE_TEST_EXISTS))  {
                newstr = Glib::build_filename (new_path, legal_name) + history_suffix;
-               
-               cerr << "Rename " << oldstr << " => " << newstr << endl;                
-               
+
+               cerr << "Rename " << oldstr << " => " << newstr << endl;
+
                if (::g_rename (oldstr.c_str(), newstr.c_str()) != 0) {
                        cerr << string_compose (_("renaming %1 as %2 failed (%3)"), oldstr, newstr, g_strerror (errno)) << endl;
                        error << string_compose (_("renaming %1 as %2 failed (%3)"), oldstr, newstr, g_strerror (errno)) << endmsg;
@@ -3918,9 +4265,9 @@ Session::rename (const std::string& new_name)
        /* remove old name from recent sessions */
        remove_recent_sessions (_path);
        _path = new_path;
-       
+
        /* update file source paths */
-       
+
        for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
                boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (i->second);
                if (fs) {
@@ -3931,9 +4278,9 @@ Session::rename (const std::string& new_name)
                }
        }
 
-       _current_snapshot_name = new_name;
+       set_snapshot_name (new_name);
        _name = new_name;
-       
+
        set_dirty ();
 
        /* save state again to get everything just right */
@@ -3974,27 +4321,29 @@ Session::get_info_from_path (const string& xmlpath, float& sample_rate, SampleFo
 
        /* sample rate */
 
-       const XMLProperty* prop;
-       if ((prop = tree.root()->property (X_("sample-rate"))) != 0) {          
+       XMLProperty const * prop;
+       XMLNode const * root (tree.root());
+
+       if ((prop = root->property (X_("sample-rate"))) != 0) {
                sample_rate = atoi (prop->value());
                found_sr = true;
        }
 
-       const XMLNodeList& children (tree.root()->children());
+       const XMLNodeList& children (root->children());
        for (XMLNodeList::const_iterator c = children.begin(); c != children.end(); ++c) {
                const XMLNode* child = *c;
                if (child->name() == "Config") {
                        const XMLNodeList& options (child->children());
                        for (XMLNodeList::const_iterator oc = options.begin(); oc != options.end(); ++oc) {
-                               const XMLNode* option = *oc;
-                               const XMLProperty* name = option->property("name");
+                               XMLNode const * option = *oc;
+                               XMLProperty const * name = option->property("name");
 
                                if (!name) {
                                        continue;
                                }
 
                                if (name->value() == "native-file-data-format") {
-                                       const XMLProperty* value = option->property ("value");
+                                       XMLProperty const * value = option->property ("value");
                                        if (value) {
                                                SampleFormat fmt = (SampleFormat) string_2_enum (option->property ("value")->value(), fmt);
                                                data_format = fmt;
@@ -4012,6 +4361,29 @@ Session::get_info_from_path (const string& xmlpath, float& sample_rate, SampleFo
        return !(found_sr && found_data_format); // zero if they are both found
 }
 
+std::string
+Session::get_snapshot_from_instant (const std::string& session_dir)
+{
+       std::string instant_xml_path = Glib::build_filename (session_dir, "instant.xml");
+
+       if (!Glib::file_test (instant_xml_path, Glib::FILE_TEST_EXISTS)) {
+               return "";
+       }
+
+       XMLTree tree;
+       if (!tree.read (instant_xml_path)) {
+               return "";
+       }
+
+       XMLProperty const * prop;
+       XMLNode *last_used_snapshot = tree.root()->child("LastUsedSnapshot");
+       if (last_used_snapshot && (prop = last_used_snapshot->property ("name")) != 0) {
+               return prop->value();
+       }
+
+       return "";
+}
+
 typedef std::vector<boost::shared_ptr<FileSource> > SeveralFileSources;
 typedef std::map<std::string,SeveralFileSources> SourcePathMap;
 
@@ -4028,20 +4400,20 @@ Session::bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,
        {
 
                Glib::Threads::Mutex::Lock lm (source_lock);
-               
+
                cerr << " total sources = " << sources.size();
-               
+
                for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
                        boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (i->second);
-                       
+
                        if (!fs) {
                                continue;
                        }
-                       
+
                        if (fs->within_session()) {
                                continue;
                        }
-                       
+
                        if (source_path_map.find (fs->path()) != source_path_map.end()) {
                                source_path_map[fs->path()].push_back (fs);
                        } else {
@@ -4049,45 +4421,45 @@ Session::bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,
                                v.push_back (fs);
                                source_path_map.insert (make_pair (fs->path(), v));
                        }
-                       
+
                        total++;
                }
-               
+
                cerr << " fsources = " << total << endl;
-               
+
                for (SourcePathMap::iterator i = source_path_map.begin(); i != source_path_map.end(); ++i) {
-                       
+
                        /* tell caller where we are */
-                       
+
                        string old_path = i->first;
-                       
+
                        callback (n, total, old_path);
-                       
+
                        cerr << old_path << endl;
-                       
+
                        new_path.clear ();
-                       
+
                        switch (i->second.front()->type()) {
                        case DataType::AUDIO:
                                new_path = new_audio_source_path_for_embedded (old_path);
                                break;
-                               
+
                        case DataType::MIDI:
                                /* XXX not implemented yet */
                                break;
                        }
-                       
+
                        if (new_path.empty()) {
                                continue;
                        }
-                       
+
                        cerr << "Move " << old_path << " => " << new_path << endl;
-                       
+
                        if (!copy_file (old_path, new_path)) {
                                cerr << "failed !\n";
                                ret = -1;
                        }
-                       
+
                        /* make sure we stop looking in the external
                           dir/folder. Remember, this is an all-or-nothing
                           operations, it doesn't merge just some files.
@@ -4130,7 +4502,7 @@ make_new_media_path (string old_path, string new_session_folder, string new_sess
        v.push_back (new_session_path);   /* just one directory/folder */
        v.push_back (typedir);
        v.push_back (Glib::path_get_basename (old_path));
-       
+
        return Glib::build_filename (v);
 }
 
@@ -4157,15 +4529,15 @@ Session::save_as (SaveAs& saveas)
        /* get total size */
 
        for (vector<space_and_path>::const_iterator sd = session_dirs.begin(); sd != session_dirs.end(); ++sd) {
-               
+
                /* need to clear this because
                 * find_files_matching_filter() is cumulative
                 */
-               
+
                files.clear ();
-               
+
                find_files_matching_filter (files, (*sd).path, accept_all_files, 0, false, true, true);
-               
+
                all += files.size();
 
                for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
@@ -4176,7 +4548,7 @@ Session::save_as (SaveAs& saveas)
        }
 
        /* save old values so we can switch back if we are not switching to the new session */
-       
+
        string old_path = _path;
        string old_name = _name;
        string old_snapshot = _current_snapshot_name;
@@ -4186,15 +4558,15 @@ Session::save_as (SaveAs& saveas)
 
        old_search_path[DataType::AUDIO] = source_search_path (DataType::AUDIO);
        old_search_path[DataType::MIDI] = source_search_path (DataType::MIDI);
-       old_config_search_path[DataType::AUDIO]  = config.get_audio_search_path ();     
-       old_config_search_path[DataType::MIDI]  = config.get_midi_search_path ();       
+       old_config_search_path[DataType::AUDIO]  = config.get_audio_search_path ();
+       old_config_search_path[DataType::MIDI]  = config.get_midi_search_path ();
 
        /* switch session directory */
-       
+
        (*_session_dir) = to_dir;
 
        /* create new tree */
-       
+
        if (!_session_dir->create()) {
                saveas.failure_message = string_compose (_("Cannot create new session folder %1"), to_dir);
                return -1;
@@ -4204,21 +4576,21 @@ Session::save_as (SaveAs& saveas)
                /* copy all relevant files. Find each location in session_dirs,
                 * and copy files from there to target.
                 */
-               
+
                for (vector<space_and_path>::const_iterator sd = session_dirs.begin(); sd != session_dirs.end(); ++sd) {
-                       
+
                        /* need to clear this because
                         * find_files_matching_filter() is cumulative
                         */
-                       
+
                        files.clear ();
-                       
+
                        const size_t prefix_len = (*sd).path.size();
-                       
+
                        /* Work just on the files within this session dir */
-                       
+
                        find_files_matching_filter (files, (*sd).path, accept_all_files, 0, false, true, true);
-                       
+
                        /* add dir separator to protect against collisions with
                         * track names (e.g. track named "audiofiles" or
                         * "analysis".
@@ -4233,7 +4605,7 @@ Session::save_as (SaveAs& saveas)
                           folder. That really was a bad idea, but I'm not fixing it as part of
                           implementing ::save_as().
                        */
-                       
+
                        for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
 
                                std::string from = *i;
@@ -4245,25 +4617,25 @@ Session::save_as (SaveAs& saveas)
                                        continue;
                                }
 #endif
-                               
+
                                if (from.find (audiofile_dir_string) != string::npos) {
-                                       
+
                                        /* audio file: only copy if asked */
 
                                        if (saveas.include_media && saveas.copy_media) {
-                                               
+
                                                string to = make_new_media_path (*i, to_dir, new_folder);
 
                                                info << "media file copying from " << from << " to " << to << endmsg;
-                                               
+
                                                if (!copy_file (from, to)) {
                                                        throw Glib::FileError (Glib::FileError::IO_ERROR,
                                                                                                   string_compose(_("\ncopying \"%1\" failed !"), from));
                                                }
                                        }
-                                       
+
                                        /* we found media files inside the session folder */
-                                       
+
                                        internal_file_cnt++;
 
                                } else if (from.find (midifile_dir_string) != string::npos) {
@@ -4273,44 +4645,44 @@ Session::save_as (SaveAs& saveas)
                                         */
 
                                        if (saveas.include_media) {
-                                       
+
                                                string to = make_new_media_path (*i, to_dir, new_folder);
-                                               
+
                                                info << "media file copying from " << from << " to " << to << endmsg;
-                                               
+
                                                if (!copy_file (from, to)) {
                                                        throw Glib::FileError (Glib::FileError::IO_ERROR, "copy failed");
                                                }
                                        }
 
                                        /* we found media files inside the session folder */
-                                               
+
                                        internal_file_cnt++;
-                                       
+
                                } else if (from.find (analysis_dir_string) != string::npos) {
 
                                        /*  make sure analysis dir exists in
                                         *  new session folder, but we're not
                                         *  copying analysis files here, see
-                                        *  below 
+                                        *  below
                                         */
-                                       
+
                                        (void) g_mkdir_with_parents (analysis_dir().c_str(), 775);
                                        continue;
-                                       
+
                                } else {
-                                       
+
                                        /* normal non-media file. Don't copy state, history, etc.
                                         */
-                                       
+
                                        bool do_copy = true;
-                                       
+
                                        for (vector<string>::iterator v = do_not_copy_extensions.begin(); v != do_not_copy_extensions.end(); ++v) {
                                                if ((from.length() > (*v).length()) && (from.find (*v) == from.length() - (*v).length())) {
                                                        /* end of filename matches extension, do not copy file */
                                                        do_copy = false;
                                                        break;
-                                               } 
+                                               }
                                        }
 
                                        if (!saveas.copy_media && from.find (peakfile_suffix) != string::npos) {
@@ -4319,10 +4691,10 @@ Session::save_as (SaveAs& saveas)
                                                 */
                                                do_copy = false;
                                        }
-                                       
+
                                        if (do_copy) {
                                                string to = Glib::build_filename (to_dir, from.substr (prefix_len));
-                                               
+
                                                info << "attempting to make directory/folder " << to << endmsg;
 
                                                if (g_mkdir_with_parents (Glib::path_get_dirname (to).c_str(), 0755)) {
@@ -4330,26 +4702,26 @@ Session::save_as (SaveAs& saveas)
                                                }
 
                                                info << "attempting to copy " << from << " to " << to << endmsg;
-                                               
+
                                                if (!copy_file (from, to)) {
                                                        throw Glib::FileError (Glib::FileError::IO_ERROR,
                                                                                                   string_compose(_("\ncopying \"%1\" failed !"), from));
                                                }
                                        }
                                }
-                               
+
                                /* measure file size even if we're not going to copy so that our Progress
                                   signals are correct, since we included these do-not-copy files
                                   in the computation of the total size and file count.
                                */
-                               
+
                                GStatBuf gsb;
                                g_stat (from.c_str(), &gsb);
                                copied += gsb.st_size;
                                cnt++;
-                               
+
                                double fraction = (double) copied / total_bytes;
-                               
+
                                bool keep_going = true;
 
                                if (saveas.copy_media) {
@@ -4358,11 +4730,11 @@ Session::save_as (SaveAs& saveas)
                                         * media is not being copied, because
                                         * it will be fast(ish).
                                         */
-                                       
+
                                        /* tell someone "X percent, file M of N"; M is one-based */
-                                       
+
                                        boost::optional<bool> res = saveas.Progress (fraction, cnt, all);
-                                       
+
                                        if (res) {
                                                keep_going = *res;
                                        }
@@ -4396,7 +4768,7 @@ Session::save_as (SaveAs& saveas)
                }
 
                if (saveas.include_media) {
-               
+
                        if (saveas.copy_media) {
 #ifndef PLATFORM_WINDOWS
                                /* There are problems with analysis files on
@@ -4406,7 +4778,7 @@ Session::save_as (SaveAs& saveas)
                                 *
                                 * This is a tricky problem to solve so for
                                 * just don't copy these files. They will be
-                                * regenerated as-needed anyway, subject to the 
+                                * regenerated as-needed anyway, subject to the
                                 * existing issue that the filenames will be
                                 * rejected by Windows, which is a separate
                                 * problem (though related).
@@ -4415,19 +4787,19 @@ Session::save_as (SaveAs& saveas)
                                /* only needed if we are copying media, since the
                                 * analysis data refers to media data
                                 */
-                               
+
                                old = analysis_dir ();
                                if (Glib::file_test (old, Glib::FILE_TEST_EXISTS)) {
                                        string newdir = Glib::build_filename (to_dir, "analysis");
                                        copy_files (old, newdir);
                                }
-#endif /* PLATFORM_WINDOWS */                          
+#endif /* PLATFORM_WINDOWS */
                        }
                }
-                       
-               
+
+
                _path = to_dir;
-               _current_snapshot_name = saveas.new_name;
+               set_snapshot_name (saveas.new_name);
                _name = saveas.new_name;
 
                if (saveas.include_media && !saveas.copy_media) {
@@ -4439,6 +4811,7 @@ Session::save_as (SaveAs& saveas)
                        if (internal_file_cnt) {
                                for (vector<string>::iterator s = old_search_path[DataType::AUDIO].begin(); s != old_search_path[DataType::AUDIO].end(); ++s) {
                                        ensure_search_path_includes (*s, DataType::AUDIO);
+                                       cerr << "be sure to include " << *s << "  for audio" << endl;
                                }
 
                                /* we do not do this for MIDI because we copy
@@ -4447,12 +4820,12 @@ Session::save_as (SaveAs& saveas)
                                */
                        }
                }
-               
+
                bool was_dirty = dirty ();
 
                save_state ("", false, false, !saveas.include_media);
                save_default_options ();
-               
+
                if (saveas.copy_media && saveas.copy_external) {
                        if (bring_all_sources_into_session (boost::bind (&Session::save_as_bring_callback, this, _1, _2, _3))) {
                                throw Glib::FileError (Glib::FileError::NO_SPACE_LEFT, "consolidate failed");
@@ -4462,14 +4835,14 @@ Session::save_as (SaveAs& saveas)
                saveas.final_session_folder_name = _path;
 
                store_recent_sessions (_name, _path);
-               
+
                if (!saveas.switch_to) {
 
                        /* switch back to the way things were */
 
                        _path = old_path;
                        _name = old_name;
-                       _current_snapshot_name = old_snapshot;
+                       set_snapshot_name (old_snapshot);
 
                        (*_session_dir) = old_sd;
 
@@ -4482,7 +4855,7 @@ Session::save_as (SaveAs& saveas)
                                config.set_audio_search_path (old_config_search_path[DataType::AUDIO]);
                                config.set_midi_search_path (old_config_search_path[DataType::MIDI]);
                        }
-                       
+
                } else {
 
                        /* prune session dirs, and update disk space statistics
@@ -4494,7 +4867,7 @@ Session::save_as (SaveAs& saveas)
                        session_dirs.push_back (sp);
                        refresh_disk_space ();
 
-                       /* ensure that all existing tracks reset their current capture source paths 
+                       /* ensure that all existing tracks reset their current capture source paths
                         */
                        reset_write_sources (true, true);
 
@@ -4519,27 +4892,27 @@ Session::save_as (SaveAs& saveas)
        } catch (Glib::FileError& e) {
 
                saveas.failure_message = e.what();
-               
+
                /* recursively remove all the directories */
-               
+
                remove_directory (to_dir);
-               
+
                /* return error */
-               
+
                return -1;
 
        } catch (...) {
 
                saveas.failure_message = _("unknown reason");
-               
+
                /* recursively remove all the directories */
-               
+
                remove_directory (to_dir);
-               
+
                /* return error */
-               
+
                return -1;
        }
-       
+
        return 0;
 }