a better fix for CUE/TOC string escaping: if the text is not Latin-1 already, reject...
[ardour.git] / libs / ardour / session_state.cc
index 76570cb64ac4219759a96e120f40ac11e38ccd4c..bcc37dde51410abb0f6eae5dac46f43632900d5a 100644 (file)
@@ -6,7 +6,7 @@
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
 
- This program is distributed in the hope that it will be useful,
 This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 #include "libardour-config.h"
 #endif
 
-#define __STDC_FORMAT_MACROS 1
 #include <stdint.h>
 
 #include <algorithm>
 #include <fstream>
 #include <string>
 #include <cerrno>
-
-
 #include <cstdio> /* snprintf(3) ... grrr */
 #include <cmath>
 #include <unistd.h>
@@ -41,7 +38,6 @@
 #include <signal.h>
 #include <sys/mman.h>
 #include <sys/time.h>
-#include <dirent.h>
 
 #ifdef HAVE_SYS_VFS_H
 #include <sys/vfs.h>
 #include <sys/mount.h>
 #endif
 
+#include <glib.h>
+
 #include <glibmm.h>
 #include <glibmm/thread.h>
 
+#include <boost/algorithm/string.hpp>
+
 #include "midi++/mmc.h"
 #include "midi++/port.h"
 #include "midi++/manager.h"
 
 #include "pbd/boost_debug.h"
+#include "pbd/basename.h"
 #include "pbd/controllable_descriptor.h"
 #include "pbd/enumwriter.h"
 #include "pbd/error.h"
 #include "pbd/search_path.h"
 #include "pbd/stacktrace.h"
 #include "pbd/convert.h"
+#include "pbd/clear_dir.h"
 
 #include "ardour/amp.h"
 #include "ardour/audio_diskstream.h"
+#include "ardour/audio_playlist_source.h"
 #include "ardour/audio_track.h"
 #include "ardour/audioengine.h"
 #include "ardour/audiofilesource.h"
 #include "ardour/audioplaylist.h"
 #include "ardour/audioregion.h"
 #include "ardour/auditioner.h"
+#include "ardour/automation_control.h"
 #include "ardour/buffer.h"
 #include "ardour/butler.h"
 #include "ardour/configuration.h"
 #include "ardour/io_processor.h"
 #include "ardour/location.h"
 #include "ardour/midi_diskstream.h"
+#include "ardour/midi_model.h"
 #include "ardour/midi_patch_manager.h"
 #include "ardour/midi_playlist.h"
 #include "ardour/midi_region.h"
 #include "ardour/midi_source.h"
 #include "ardour/midi_track.h"
 #include "ardour/named_selection.h"
+#include "ardour/pannable.h"
 #include "ardour/processor.h"
 #include "ardour/port.h"
+#include "ardour/proxy_controllable.h"
+#include "ardour/recent_sessions.h"
 #include "ardour/region_factory.h"
 #include "ardour/route_group.h"
 #include "ardour/send.h"
 #include "ardour/sndfile_helpers.h"
 #include "ardour/sndfilesource.h"
 #include "ardour/source_factory.h"
+#include "ardour/speakers.h"
 #include "ardour/template_utils.h"
 #include "ardour/tempo.h"
 #include "ardour/ticker.h"
@@ -127,6 +136,7 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+/** @param snapshot_name Snapshot name, without the .ardour prefix */
 void
 Session::first_stage_init (string fullpath, string snapshot_name)
 {
@@ -144,14 +154,8 @@ Session::first_stage_init (string fullpath, string snapshot_name)
 
        _path = string(buf);
 
-       if (_path[_path.length()-1] != '/') {
-               _path += '/';
-       }
-
-       if (Glib::file_test (_path, Glib::FILE_TEST_EXISTS) && ::access (_path.c_str(), W_OK)) {
-               _writable = false;
-       } else {
-               _writable = true;
+       if (_path[_path.length()-1] != G_DIR_SEPARATOR) {
+               _path += G_DIR_SEPARATOR;
        }
 
        /* these two are just provisional settings. set_state()
@@ -205,7 +209,8 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        _state_of_the_state = StateOfTheState(CannotSave|InitialConnecting|Loading);
        _was_seamless = Config->get_seamless_loop ();
        _slave = 0;
-       session_send_mtc = false;
+       _send_qf_mtc = false;
+       _pframes_since_last_mtc = 0;
        g_atomic_int_set (&_playback_load, 100);
        g_atomic_int_set (&_capture_load, 100);
        _play_range = false;
@@ -216,12 +221,17 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        first_file_header_format_reset = true;
        post_export_sync = false;
        midi_control_ui = 0;
+        _step_editors = 0;
+        no_questions_about_missing_files = false;
+        _speakers.reset (new Speakers);
+       _clicks_cleared = 0;
+       ignore_route_processor_changes = false;
 
        AudioDiskstream::allocate_working_buffers();
 
        /* default short fade = 15ms */
 
-       Crossfade::set_short_xfade_length ((nframes_t) floor (config.get_short_xfade_seconds() * frame_rate()));
+       Crossfade::set_short_xfade_length ((framecnt_t) floor (config.get_short_xfade_seconds() * frame_rate()));
        SndFileSource::setup_standard_crossfades (*this, frame_rate());
 
        last_mmc_step.tv_sec = 0;
@@ -245,8 +255,6 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        }
 
        last_timecode_when = 0;
-       _timecode_offset = 0;
-       _timecode_offset_negative = true;
        last_timecode_valid = false;
 
        sync_time_vars ();
@@ -254,7 +262,9 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        last_rr_session_dir = session_dirs.begin();
        refresh_disk_space ();
 
-       // set_default_fade (0.2, 5.0); /* steepness, millisecs */
+        /* default: assume simple stereo speaker configuration */
+
+        _speakers->setup_default_speakers (2);
 
        /* slave stuff */
 
@@ -263,6 +273,11 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        delta_accumulator_cnt = 0;
        _slave_state = Stopped;
 
+        _solo_cut_control.reset (new ProxyControllable (_("solo cut control (dB)"), PBD::Controllable::GainLike,
+                                                        boost::bind (&RCConfiguration::set_solo_mute_gain, Config, _1),
+                                                        boost::bind (&RCConfiguration::get_solo_mute_gain, Config)));
+        add_controllable (_solo_cut_control);
+
        _engine.GraphReordered.connect_same_thread (*this, boost::bind (&Session::graph_reordered, this));
 
        /* These are all static "per-class" signals */
@@ -277,17 +292,6 @@ Session::first_stage_init (string fullpath, string snapshot_name)
 
        Delivery::disable_panners ();
        IO::disable_connecting ();
-
-       /* Create MIDI control ports */
-
-       MIDI::Manager* m = MIDI::Manager::instance ();
-
-       _mtc_input_port = m->add_port (new MIDI::Port ("MTC", O_RDONLY, _engine.jack()));
-       _mtc_output_port = m->add_port (new MIDI::Port ("MTC", O_WRONLY, _engine.jack()));
-       _midi_input_port = m->add_port (new MIDI::Port ("MIDI control", O_RDONLY, _engine.jack()));
-       _midi_output_port = m->add_port (new MIDI::Port ("MIDI control", O_WRONLY, _engine.jack()));
-       _midi_clock_input_port = m->add_port (new MIDI::Port ("MIDI clock", O_RDONLY, _engine.jack()));
-       _midi_clock_output_port = m->add_port (new MIDI::Port ("MIDI clock", O_WRONLY, _engine.jack()));
 }
 
 int
@@ -299,7 +303,6 @@ Session::second_stage_init ()
                if (load_state (_current_snapshot_name)) {
                        return -1;
                }
-               remove_empty_sounds ();
        }
 
        if (_butler->start_thread()) {
@@ -335,8 +338,8 @@ Session::second_stage_init ()
 
        _state_of_the_state = StateOfTheState (_state_of_the_state|CannotSave|Loading);
 
-       _locations.changed.connect_same_thread (*this, boost::bind (&Session::locations_changed, this));
-       _locations.added.connect_same_thread (*this, boost::bind (&Session::locations_added, this, _1));
+       _locations->changed.connect_same_thread (*this, boost::bind (&Session::locations_changed, this));
+       _locations->added.connect_same_thread (*this, boost::bind (&Session::locations_added, this, _1));
        setup_click_sounds (0);
        setup_midi_control ();
 
@@ -365,18 +368,14 @@ Session::second_stage_init ()
        send_full_time_code (0);
        _engine.transport_locate (0);
 
-       _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdMmcReset));
-       _mmc->send (MIDI::MachineControlCommand (Timecode::Time ()));
+       MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdMmcReset));
+       MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (Timecode::Time ()));
 
        MidiClockTicker::instance().set_session (this);
        MIDI::Name::MidiPatchManager::instance().set_session (this);
 
        /* initial program change will be delivered later; see ::config_changed() */
 
-       BootMessage (_("Reset Control Protocols"));
-
-       ControlProtocolManager::instance().set_session (this);
-
        _state_of_the_state = Clean;
 
        Port::set_connecting_blocked (false);
@@ -433,10 +432,6 @@ Session::setup_raid_path (string path)
                midi_search_path += sdir.midi_path ();
        }
 
-       // set the search path for each data type
-       FileSource::set_search_path (DataType::AUDIO, sound_search_path.to_string ());
-       SMFSource::set_search_path (DataType::MIDI, midi_search_path.to_string ());
-
        // reset the round-robin soundfile path thingie
        last_rr_session_dir = session_dirs.begin();
 }
@@ -478,7 +473,7 @@ Session::ensure_subdirs ()
                return -1;
        }
 
-       dir = session_directory().dead_sound_path().to_string();
+       dir = session_directory().dead_path().to_string();
 
        if (g_mkdir_with_parents (dir.c_str(), 0755) < 0) {
                error << string_compose(_("Session: cannot create session dead sounds folder \"%1\" (%2)"), dir, strerror (errno)) << endmsg;
@@ -499,13 +494,22 @@ Session::ensure_subdirs ()
                return -1;
        }
 
+       dir = plugins_dir ();
+
+       if (g_mkdir_with_parents (dir.c_str(), 0755) < 0) {
+               error << string_compose(_("Session: cannot create session plugins folder \"%1\" (%2)"), dir, strerror (errno)) << endmsg;
+               return -1;
+       }
+
        return 0;
 }
 
+/** @param session_template directory containing session template, or empty.
+ *  Caller must not hold process lock.
+ */
 int
-Session::create (const string& mix_template, BusProfile* bus_profile)
+Session::create (const string& session_template, BusProfile* bus_profile)
 {
-
        if (g_mkdir_with_parents (_path.c_str(), 0755) < 0) {
                error << string_compose(_("Session: cannot create session folder \"%1\" (%2)"), _path, strerror (errno)) << endmsg;
                return -1;
@@ -515,31 +519,39 @@ Session::create (const string& mix_template, BusProfile* bus_profile)
                return -1;
        }
 
-       if (!mix_template.empty()) {
-               std::string in_path = mix_template;
+       _writable = exists_and_writable (sys::path (_path));
+
+       if (!session_template.empty()) {
+               std::string in_path = session_template_dir_to_file (session_template);
 
                ifstream in(in_path.c_str());
 
-               if (in){
+               if (in) {
                        string out_path = _path;
                        out_path += _name;
                        out_path += statefile_suffix;
 
                        ofstream out(out_path.c_str());
 
-                       if (out){
+                       if (out) {
                                out << in.rdbuf();
                                 _is_new = false;
+
+                               /* Copy plugin state files from template to new session */
+                               sys::path template_plugins = session_template;
+                               template_plugins /= X_("plugins");
+                               sys::copy_files (template_plugins, plugins_dir ());
+                               
                                return 0;
 
                        } else {
-                               error << string_compose (_("Could not open %1 for writing mix template"), out_path)
+                               error << string_compose (_("Could not open %1 for writing session template"), out_path)
                                        << endmsg;
                                return -1;
                        }
 
                } else {
-                       error << string_compose (_("Could not open mix template %1 for reading"), in_path)
+                       error << string_compose (_("Could not open session template %1 for reading"), in_path)
                                << endmsg;
                        return -1;
                }
@@ -553,51 +565,37 @@ Session::create (const string& mix_template, BusProfile* bus_profile)
        /* set initial start + end point */
 
        _state_of_the_state = Clean;
-        
+
         /* set up Master Out and Control Out if necessary */
 
         if (bus_profile) {
 
                RouteList rl;
-               int control_id = 1;
                 ChanCount count(DataType::AUDIO, bus_profile->master_out_channels);
 
                if (bus_profile->master_out_channels) {
-                       Route* rt = new Route (*this, _("master"), Route::MasterOut, DataType::AUDIO);
-                        if (rt->init ()) {
-                                delete rt;
+                       boost::shared_ptr<Route> r (new Route (*this, _("master"), Route::MasterOut, DataType::AUDIO));
+                        if (r->init ()) {
                                 return -1;
                         }
-                       boost_debug_shared_ptr_mark_interesting (rt, "Route");
-                       boost::shared_ptr<Route> r (rt);
-                       r->input()->ensure_io (count, false, this);
-                       r->output()->ensure_io (count, false, this);
-                       r->set_remote_control_id (control_id++);
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+                       // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
+#endif
+                       {
+                               Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
+                               r->input()->ensure_io (count, false, this);
+                               r->output()->ensure_io (count, false, this);
+                       }
 
                        rl.push_back (r);
 
-                        if (Config->get_use_monitor_bus()) {
-                                Route* rt = new Route (*this, _("monitor"), Route::MonitorOut, DataType::AUDIO);
-                                if (rt->init ()) {
-                                        delete rt;
-                                        return -1;
-                                }
-                                boost_debug_shared_ptr_mark_interesting (rt, "Route");
-                                boost::shared_ptr<Route> r (rt);
-                                r->input()->ensure_io (count, false, this);
-                                r->output()->ensure_io (count, false, this);
-                                r->set_remote_control_id (control_id);
-                                
-                                rl.push_back (r);
-                        }
-
                } else {
                        /* prohibit auto-connect to master, because there isn't one */
                        bus_profile->output_ac = AutoConnectOption (bus_profile->output_ac & ~AutoConnectMaster);
                }
 
                if (!rl.empty()) {
-                       add_routes (rl, false);
+                       add_routes (rl, false, false);
                }
 
                 /* this allows the user to override settings with an environment variable.
@@ -607,11 +605,15 @@ Session::create (const string& mix_template, BusProfile* bus_profile)
                         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);
         }
 
+       if (Config->get_use_monitor_bus() && bus_profile) {
+               add_monitor_section ();
+       }
+
        save_state ("");
 
        return 0;
@@ -644,7 +646,8 @@ Session::remove_pending_capture_state ()
 }
 
 /** Rename a state file.
- * @param snapshot_name Snapshot name.
+ *  @param old_name Old snapshot name.
+ *  @param new_name New snapshot name.
  */
 void
 Session::rename_state (string old_name, string new_name)
@@ -672,7 +675,7 @@ Session::rename_state (string old_name, string new_name)
 }
 
 /** Remove a state file.
- * @param snapshot_name Snapshot name.
+ *  @param snapshot_name Snapshot name.
  */
 void
 Session::remove_state (string snapshot_name)
@@ -711,7 +714,7 @@ Session::jack_session_event (jack_session_event_t * event)
         if (event->type == JackSessionSaveTemplate)
         {
                 if (save_template( timebuf )) {
-                        event->flags = JackSessionSaveError; 
+                        event->flags = JackSessionSaveError;
                 } else {
                         string cmd ("ardour3 -P -U ");
                         cmd += event->client_uuid;
@@ -724,7 +727,7 @@ Session::jack_session_event (jack_session_event_t * event)
         else
         {
                 if (save_state (timebuf)) {
-                        event->flags = JackSessionSaveError; 
+                        event->flags = JackSessionSaveError;
                 } else {
                         sys::path xml_path (_session_dir->root_path());
                         xml_path /= legalize_for_path (timebuf) + statefile_suffix;
@@ -742,13 +745,14 @@ Session::jack_session_event (jack_session_event_t * event)
        jack_session_reply (_engine.jack(), event);
 
        if (event->type == JackSessionSaveAndQuit) {
-                // TODO: make ardour quit.
+               Quit (); /* EMIT SIGNAL */
        }
 
        jack_session_event_free( event );
 }
 #endif
 
+/** @param snapshot_name Name to save under, without .ardour / .pending prefix */
 int
 Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot)
 {
@@ -769,7 +773,11 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
        /* 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) {
-               i->second->session_saved();
+               try {
+                       i->second->session_saved();
+               } catch (Evoral::SMF::FileError& e) {
+                       error << string_compose ("Could not write to MIDI file %1; MIDI data not saved.", e.file_name ()) << endmsg;
+               }
         }
 
        tree.set_root (&get_state());
@@ -812,7 +820,7 @@ Session::save_state (string snapshot_name, bool pending, bool switch_to_snapshot
 
        } else {
 
-               if (rename (tmp_path.to_string().c_str(), xml_path.to_string().c_str()) != 0) {
+               if (::rename (tmp_path.to_string().c_str(), xml_path.to_string().c_str()) != 0) {
                        error << string_compose (_("could not rename temporary session file %1 to %2"),
                                        tmp_path.to_string(), xml_path.to_string()) << endmsg;
                        sys::remove (tmp_path);
@@ -889,14 +897,7 @@ Session::load_state (string snapshot_name)
 
        set_dirty();
 
-       /* writable() really reflects the whole folder, but if for any
-          reason the session state file can't be written to, still
-          make us unwritable.
-       */
-
-       if (::access (xmlpath.to_string().c_str(), W_OK) != 0) {
-               _writable = false;
-       }
+       _writable = exists_and_writable (xmlpath);
 
        if (!state_tree->read (xmlpath.to_string())) {
                error << string_compose(_("Could not understand ardour file %1"), xmlpath.to_string()) << endmsg;
@@ -927,7 +928,7 @@ Session::load_state (string snapshot_name)
                sscanf (prop->value().c_str(), "%d.%d.%d", &major, &minor, &micro);
                Stateful::loading_state_version = (major * 1000) + minor;
        }
-               
+
        if (Stateful::loading_state_version < CURRENT_SESSION_FILE_VERSION) {
 
                sys::path backup_path(_session_dir->root_path());
@@ -1002,7 +1003,7 @@ Session::state(bool full_state)
        if (full_state) {
 
                node->add_property ("name", _name);
-               snprintf (buf, sizeof (buf), "%" PRId32, _nominal_frame_rate);
+               snprintf (buf, sizeof (buf), "%" PRId64, _nominal_frame_rate);
                node->add_property ("sample-rate", buf);
 
                if (session_dirs.size() > 1) {
@@ -1040,6 +1041,11 @@ Session::state(bool full_state)
        snprintf (buf, sizeof (buf), "%" PRIu64, ID::counter());
        node->add_property ("id-counter", buf);
 
+       /* save the event ID counter */
+
+       snprintf (buf, sizeof (buf), "%d", Evoral::event_id_counter());
+       node->add_property ("event-counter", buf);
+
        /* various options */
 
        node->add_child_nocopy (config.get_variables ());
@@ -1053,20 +1059,23 @@ Session::state(bool full_state)
 
                for (SourceMap::iterator siter = sources.begin(); siter != sources.end(); ++siter) {
 
-                       /* Don't save information about non-destructive file sources that are empty
-                           and unused by any regions.
+                       /* Don't save information about non-file Sources, or
+                        * about non-destructive file sources that are empty
+                        * and unused by any regions.
                         */
 
                        boost::shared_ptr<FileSource> fs;
+
                        if ((fs = boost::dynamic_pointer_cast<FileSource> (siter->second)) != 0) {
+
                                if (!fs->destructive()) {
                                        if (fs->empty() && !fs->used()) {
                                                continue;
                                        }
                                }
-                       }
 
-                       child->add_child_nocopy (siter->second->get_state());
+                               child->add_child_nocopy (siter->second->get_state());
+                       }
                }
        }
 
@@ -1079,19 +1088,35 @@ Session::state(bool full_state)
                         boost::shared_ptr<Region> r = i->second;
                         /* only store regions not attached to playlists */
                         if (r->playlist() == 0) {
-                                child->add_child_nocopy (r->state (true));
+                                child->add_child_nocopy (r->state ());
                         }
                 }
+
+               RegionFactory::CompoundAssociations& cassocs (RegionFactory::compound_associations());
+
+               if (!cassocs.empty()) {
+                       XMLNode* ca = node->add_child (X_("CompoundAssociations"));
+
+                       for (RegionFactory::CompoundAssociations::iterator i = cassocs.begin(); i != cassocs.end(); ++i) {
+                               char buf[64];
+                               XMLNode* can = new XMLNode (X_("CompoundAssociation"));
+                               i->first->id().print (buf, sizeof (buf));
+                               can->add_property (X_("copy"), buf);
+                               i->second->id().print (buf, sizeof (buf));
+                               can->add_property (X_("original"), buf);
+                               ca->add_child_nocopy (*can);
+                       }
+               }
        }
 
        if (full_state) {
-               node->add_child_nocopy (_locations.get_state());
+               node->add_child_nocopy (_locations->get_state());
        } else {
                // for a template, just create a new Locations, populate it
                // with the default start and end, and get the state for that.
-               Locations loc;
-               Location* range = new Location (0, 0, _("session"), Location::IsSessionRange);
-               range->set (max_frames, 0);
+               Locations loc (*this);
+               Location* range = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
+               range->set (max_framepos, 0);
                loc.add (range);
                node->add_child_nocopy (loc.get_state());
        }
@@ -1153,8 +1178,8 @@ Session::state(bool full_state)
                }
        }
 
+        node->add_child_nocopy (_speakers->get_state());
        node->add_child_nocopy (_tempo_map->get_state());
-
        node->add_child_nocopy (get_control_protocol_state());
 
        if (_extra_xml) {
@@ -1181,7 +1206,7 @@ Session::set_state (const XMLNode& node, int version)
 
        _state_of_the_state = StateOfTheState (_state_of_the_state|CannotSave);
 
-       if (node.name() != X_("Session")){
+       if (node.name() != X_("Session")) {
                fatal << _("programming error: Session: incorrect XML node sent to set_state()") << endmsg;
                return -1;
        }
@@ -1222,30 +1247,13 @@ 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()));
+        }
 
        IO::disable_connecting ();
 
-       /* Object loading order:
-
-       Path
-       Extra
-       Options/Config
-       MIDI Control // relies on data from Options/Config
-       Metadata
-       Locations
-       Sources
-       AudioRegions
-       Connections
-       Routes
-       RouteGroups
-       MixGroups
-       Click
-       ControlProtocols
-       */
-
-       if ((child = find_named_node (node, "Extra")) != 0) {
-               _extra_xml = new XMLNode (*child);
-       }
+       Stateful::save_extra_xml (node);
 
        if (((child = find_named_node (node, "Options")) != 0)) { /* old style */
                load_options (*child);
@@ -1263,24 +1271,42 @@ Session::set_state (const XMLNode& node, int version)
                }
        }
 
+        if ((child = find_named_node (node, X_("Speakers"))) != 0) {
+                _speakers->set_state (*child, version);
+        }
+
+       if ((child = find_named_node (node, "Sources")) == 0) {
+               error << _("Session: XML state has no sources section") << endmsg;
+               goto out;
+       } else if (load_sources (*child)) {
+               goto out;
+       }
+
+       if ((child = find_named_node (node, "TempoMap")) == 0) {
+               error << _("Session: XML state has no Tempo Map section") << endmsg;
+               goto out;
+       } else if (_tempo_map->set_state (*child, version)) {
+               goto out;
+       }
+
        if ((child = find_named_node (node, "Locations")) == 0) {
                error << _("Session: XML state has no locations section") << endmsg;
                goto out;
-       } else if (_locations.set_state (*child, version)) {
+       } else if (_locations->set_state (*child, version)) {
                goto out;
        }
 
        Location* location;
 
-       if ((location = _locations.auto_loop_location()) != 0) {
+       if ((location = _locations->auto_loop_location()) != 0) {
                set_auto_loop_location (location);
        }
 
-       if ((location = _locations.auto_punch_location()) != 0) {
+       if ((location = _locations->auto_punch_location()) != 0) {
                set_auto_punch_location (location);
        }
 
-       if ((location = _locations.session_range_location()) != 0) {
+       if ((location = _locations->session_range_location()) != 0) {
                delete _session_range_location;
                _session_range_location = location;
        }
@@ -1289,13 +1315,6 @@ Session::set_state (const XMLNode& node, int version)
                AudioFileSource::set_header_position_offset (_session_range_location->start());
        }
 
-       if ((child = find_named_node (node, "Sources")) == 0) {
-               error << _("Session: XML state has no sources section") << endmsg;
-               goto out;
-       } else if (load_sources (*child)) {
-               goto out;
-       }
-
        if ((child = find_named_node (node, "Regions")) == 0) {
                error << _("Session: XML state has no Regions section") << endmsg;
                goto out;
@@ -1315,7 +1334,13 @@ Session::set_state (const XMLNode& node, int version)
        } else if (playlists->load_unused (*this, *child)) {
                goto out;
        }
-       
+
+       if ((child = find_named_node (node, "CompoundAssociations")) != 0) {
+               if (load_compounds (*child)) {
+                       goto out;
+               }
+       }
+
        if ((child = find_named_node (node, "NamedSelections")) != 0) {
                if (load_named_selections (*child)) {
                        goto out;
@@ -1333,13 +1358,6 @@ Session::set_state (const XMLNode& node, int version)
                        _bundle_xml_node = new XMLNode (*child);
                }
        }
-       
-       if ((child = find_named_node (node, "TempoMap")) == 0) {
-               error << _("Session: XML state has no Tempo Map section") << endmsg;
-               goto out;
-       } else if (_tempo_map->set_state (*child, version)) {
-               goto out;
-       }
 
        if (version < 3000) {
                if ((child = find_named_node (node, X_("DiskStreams"))) == 0) {
@@ -1361,16 +1379,16 @@ Session::set_state (const XMLNode& node, int version)
        _diskstreams_2X.clear ();
 
        if (version >= 3000) {
-               
+
                if ((child = find_named_node (node, "RouteGroups")) == 0) {
                        error << _("Session: XML state has no route groups section") << endmsg;
                        goto out;
                } else if (load_route_groups (*child, version)) {
                        goto out;
                }
-               
+
        } else if (version < 3000) {
-               
+
                if ((child = find_named_node (node, "EditGroups")) == 0) {
                        error << _("Session: XML state has no edit groups section") << endmsg;
                        goto out;
@@ -1425,7 +1443,7 @@ Session::load_routes (const XMLNode& node, int version)
                } else {
                        route = XMLRouteFactory (**niter, version);
                }
-               
+
                if (route == 0) {
                        error << _("Session: cannot create Route from XML description.") << endmsg;
                        return -1;
@@ -1436,7 +1454,7 @@ Session::load_routes (const XMLNode& node, int version)
                new_routes.push_back (route);
        }
 
-       add_routes (new_routes, false);
+       add_routes (new_routes, false, false);
 
        return 0;
 }
@@ -1463,36 +1481,35 @@ Session::XMLRouteFactory (const XMLNode& node, int version)
 
        if (ds_child) {
 
-                Track* track;
-                
+               boost::shared_ptr<Track> track;
+
                 if (type == DataType::AUDIO) {
-                        track = new AudioTrack (*this, X_("toBeResetFroXML"));
-                        
+                        track.reset (new AudioTrack (*this, X_("toBeResetFroXML")));
                 } else {
-                        track = new MidiTrack (*this, X_("toBeResetFroXML"));
+                        track.reset (new MidiTrack (*this, X_("toBeResetFroXML")));
                 }
-                
+
                 if (track->init()) {
-                        delete track;
                         return ret;
                 }
-                
+
                 if (track->set_state (node, version)) {
-                        delete track;
                         return ret;
                 }
-                
-                boost_debug_shared_ptr_mark_interesting (track, "Track");
-                ret.reset (track);
-                
+
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+                // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
+#endif
+                ret = track;
+
        } else {
-               Route* rt = new Route (*this, X_("toBeResetFroXML"));
+               boost::shared_ptr<Route> r (new Route (*this, X_("toBeResetFroXML")));
 
-                if (rt->init () == 0 && rt->set_state (node, version) == 0) {
-                        boost_debug_shared_ptr_mark_interesting (rt, "Route");
-                        ret.reset (rt);
-                } else {
-                        delete rt;
+                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
+                        ret = r;
                 }
        }
 
@@ -1534,38 +1551,37 @@ Session::XMLRouteFactory_2X (const XMLNode& node, int version)
                        return boost::shared_ptr<Route> ();
                }
 
-                Track* track;
-                
+               boost::shared_ptr<Track> track;
+
                 if (type == DataType::AUDIO) {
-                        track = new AudioTrack (*this, X_("toBeResetFroXML"));
-                        
+                        track.reset (new AudioTrack (*this, X_("toBeResetFroXML")));
                 } else {
-                        track = new MidiTrack (*this, X_("toBeResetFroXML"));
+                        track.reset (new MidiTrack (*this, X_("toBeResetFroXML")));
                 }
-                
+
                 if (track->init()) {
-                        delete track;
                         return ret;
                 }
-                
+
                 if (track->set_state (node, version)) {
-                        delete track;
                         return ret;
                 }
 
                track->set_diskstream (*i);
-                
-                boost_debug_shared_ptr_mark_interesting (track, "Track");
-                ret.reset (track);
-                
+
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+                // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
+#endif
+                ret = track;
+
        } else {
-               Route* rt = new Route (*this, X_("toBeResetFroXML"));
+               boost::shared_ptr<Route> r (new Route (*this, X_("toBeResetFroXML")));
 
-                if (rt->init () == 0 && rt->set_state (node, version) == 0) {
-                        boost_debug_shared_ptr_mark_interesting (rt, "Route");
-                        ret.reset (rt);
-                } else {
-                        delete rt;
+                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
+                        ret = r;
                 }
        }
 
@@ -1599,6 +1615,79 @@ Session::load_regions (const XMLNode& node)
        return 0;
 }
 
+int
+Session::load_compounds (const XMLNode& node)
+{
+       XMLNodeList calist = node.children();
+       XMLNodeConstIterator caiter;
+       XMLProperty *caprop;
+
+       for (caiter = calist.begin(); caiter != calist.end(); ++caiter) {
+               XMLNode* ca = *caiter;
+               ID orig_id;
+               ID copy_id;
+
+               if ((caprop = ca->property (X_("original"))) == 0) {
+                       continue;
+               }
+               orig_id = caprop->value();
+
+               if ((caprop = ca->property (X_("copy"))) == 0) {
+                       continue;
+               }
+               copy_id = caprop->value();
+
+               boost::shared_ptr<Region> orig = RegionFactory::region_by_id (orig_id);
+               boost::shared_ptr<Region> copy = RegionFactory::region_by_id (copy_id);
+
+               if (!orig || !copy) {
+                       warning << string_compose (_("Regions in compound description not found (ID's %1 and %2): ignored"),
+                                                  orig_id, copy_id)
+                               << endmsg;
+                       continue;
+               }
+
+               RegionFactory::add_compound_association (orig, copy);
+       }
+
+       return 0;
+}
+
+void
+Session::load_nested_sources (const XMLNode& node)
+{
+       XMLNodeList nlist;
+       XMLNodeConstIterator niter;
+
+       nlist = node.children();
+
+       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+               if ((*niter)->name() == "Source") {
+
+                       /* it may already exist, so don't recreate it unnecessarily 
+                        */
+
+                       XMLProperty* prop = (*niter)->property (X_("id"));
+                       if (!prop) {
+                               error << _("Nested source has no ID info in session state file! (ignored)") << endmsg;
+                               continue;
+                       }
+
+                       ID source_id (prop->value());
+
+                       if (!source_by_id (source_id)) {
+
+                               try {
+                                       SourceFactory::create (*this, **niter, true);
+                               }
+                               catch (failed_constructor& err) {
+                                       error << string_compose (_("Cannot reconstruct nested source for region %1"), name()) << endmsg;
+                               }
+                       }
+               }
+       }
+}
+
 boost::shared_ptr<Region>
 Session::XMLRegionFactory (const XMLNode& node, bool full)
 {
@@ -1606,15 +1695,20 @@ Session::XMLRegionFactory (const XMLNode& node, bool full)
 
        try {
 
-       if ( !type || type->value() == "audio" ) {
-
-               return boost::shared_ptr<Region>(XMLAudioRegionFactory (node, full));
-
-       } else if (type->value() == "midi") {
+               const XMLNodeList& nlist = node.children();
 
-               return boost::shared_ptr<Region>(XMLMidiRegionFactory (node, full));
+               for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
+                       XMLNode *child = (*niter);
+                       if (child->name() == "NestedSource") {
+                               load_nested_sources (*child);
+                       }
+               }
 
-       }
+                if (!type || type->value() == "audio") {
+                        return boost::shared_ptr<Region>(XMLAudioRegionFactory (node, full));
+                } else if (type->value() == "midi") {
+                        return boost::shared_ptr<Region>(XMLMidiRegionFactory (node, full));
+                }
 
        } catch (failed_constructor& err) {
                return boost::shared_ptr<Region> ();
@@ -1749,24 +1843,16 @@ Session::XMLMidiRegionFactory (const XMLNode& node, bool /*full*/)
        boost::shared_ptr<Source> source;
        boost::shared_ptr<MidiSource> ms;
        SourceList sources;
-       uint32_t nchans = 1;
 
        if (node.name() != X_("Region")) {
                return boost::shared_ptr<MidiRegion>();
        }
 
-       if ((prop = node.property (X_("channels"))) != 0) {
-               nchans = atoi (prop->value().c_str());
-       }
-
        if ((prop = node.property ("name")) == 0) {
                cerr << "no name for this region\n";
                abort ();
        }
 
-       // Multiple midi channels?  that's just crazy talk
-       assert(nchans == 1);
-
        if ((prop = node.property (X_("source-0"))) == 0) {
                if ((prop = node.property ("source")) == 0) {
                        error << _("Session: XMLNode describing a MidiRegion is incomplete (no source)") << endmsg;
@@ -1833,7 +1919,7 @@ Session::path_from_region_name (DataType type, string name, string identifier)
        sys::path source_dir = ((type == DataType::AUDIO)
                ? sdir.sound_path() : sdir.midi_path());
 
-       string ext = ((type == DataType::AUDIO) ? ".wav" : ".mid");
+        string ext = native_header_format_extension (config.get_native_file_header_format(), type);
 
        for (n = 0; n < 999999; ++n) {
                if (identifier.length()) {
@@ -1871,13 +1957,47 @@ Session::load_sources (const XMLNode& node)
        set_dirty();
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+          retry:
                try {
                        if ((source = XMLSourceFactory (**niter)) == 0) {
                                error << _("Session: cannot create Source from XML description.") << endmsg;
                        }
+
                } catch (MissingSource& err) {
-                       warning << _("A sound file is missing. It will be replaced by silence.") << endmsg;
-                       source = SourceFactory::createSilent (*this, **niter, max_frames, _current_frame_rate);
+
+                        int user_choice;
+
+                        if (!no_questions_about_missing_files) {
+                                user_choice = MissingFile (this, err.path, err.type).get_value_or (-1);
+                        } else {
+                                user_choice = -2;
+                        }
+
+                        switch (user_choice) {
+                        case 0:
+                                /* user added a new search location, so try again */
+                                goto retry;
+
+
+                        case 1:
+                                /* user asked to quit the entire session load
+                                 */
+                                return -1;
+
+                        case 2:
+                                no_questions_about_missing_files = true;
+                                goto retry;
+
+                        case 3:
+                                no_questions_about_missing_files = true;
+                                /* fallthru */
+
+                        case -1:
+                        default:
+                                warning << _("A sound file is missing. It will be replaced by silence.") << endmsg;
+                                source = SourceFactory::createSilent (*this, **niter, max_framecnt, _current_frame_rate);
+                                break;
+                        }
                }
        }
 
@@ -1919,66 +2039,43 @@ Session::save_template (string template_name)
        }
        catch(sys::filesystem_error& ex)
        {
-               error << string_compose(_("Could not create mix templates directory \"%1\" (%2)"),
+               error << string_compose(_("Could not create templates directory \"%1\" (%2)"),
                                user_template_dir.to_string(), ex.what()) << endmsg;
                return -1;
        }
 
        tree.set_root (&get_template());
 
-       sys::path template_file_path(user_template_dir);
-       template_file_path /= template_name + template_suffix;
-
-       if (sys::exists (template_file_path))
+       sys::path template_dir_path(user_template_dir);
+       
+       /* directory to put the template in */
+       template_dir_path /= template_name;
+       if (sys::exists (template_dir_path))
        {
                warning << string_compose(_("Template \"%1\" already exists - new version not created"),
-                               template_file_path.to_string()) << endmsg;
+                               template_dir_path.to_string()) << endmsg;
                return -1;
        }
+       
+       sys::create_directories (template_dir_path);
 
-       if (!tree.write (template_file_path.to_string())) {
-               error << _("mix template not saved") << endmsg;
-               return -1;
-       }
-
-       return 0;
-}
-
-int
-Session::rename_template (string old_name, string new_name)
-{
-       sys::path old_path (user_template_directory());
-       old_path /= old_name + template_suffix;
-
-       sys::path new_path(user_template_directory());
-       new_path /= new_name + template_suffix;
+       /* file to write */
+       sys::path template_file_path = template_dir_path;
+       template_file_path /= template_name + template_suffix;
 
-       if (sys::exists (new_path)) {
-               warning << string_compose(_("Template \"%1\" already exists - template not renamed"),
-                                         new_path.to_string()) << endmsg;
+       if (!tree.write (template_file_path.to_string())) {
+               error << _("template not saved") << endmsg;
                return -1;
        }
 
-       try {
-               sys::rename (old_path, new_path);
-               return 0;
-       } catch (...) {
-               return -1;
-       }
-}
+       /* copy plugin state directory */
 
-int
-Session::delete_template (string name)
-{
-       sys::path path = user_template_directory();
-       path /= name + template_suffix;
+       sys::path template_plugin_state_path = template_dir_path;
+       template_plugin_state_path /= X_("plugins");
+       sys::create_directories (template_plugin_state_path);
+       sys::copy_files (plugins_dir(), template_plugin_state_path);
 
-       try {
-               sys::remove (path);
-               return 0;
-       } catch (...) {
-               return -1;
-       }
+       return 0;
 }
 
 void
@@ -2146,6 +2243,12 @@ Session::analysis_dir () const
        return Glib::build_filename (_path, "analysis");
 }
 
+string
+Session::plugins_dir () const
+{
+       return Glib::build_filename (_path, "plugins");
+}
+
 int
 Session::load_bundles (XMLNode const & node)
 {
@@ -2177,7 +2280,7 @@ Session::load_route_groups (const XMLNode& node, int version)
        set_dirty ();
 
        if (version >= 3000) {
-               
+
                for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
                        if ((*niter)->name() == "RouteGroup") {
                                RouteGroup* rg = new RouteGroup (*this, "");
@@ -2225,7 +2328,7 @@ remove_end(string* state)
        string statename(*state);
 
        string::size_type start,end;
-       if ((start = statename.find_last_of ('/')) != string::npos) {
+       if ((start = statename.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
                statename = statename.substr (start+1);
        }
 
@@ -2262,9 +2365,10 @@ Session::add_route_group (RouteGroup* g)
        _route_groups.push_back (g);
        route_group_added (g); /* EMIT SIGNAL */
 
-       g->MembershipChanged.connect_same_thread (*this, boost::bind (&Session::route_group_changed, this));
-       g->PropertyChanged.connect_same_thread (*this, boost::bind (&Session::route_group_changed, this));
-       
+       g->RouteAdded.connect_same_thread (*this, boost::bind (&Session::route_added_to_route_group, this, _1, _2));
+       g->RouteRemoved.connect_same_thread (*this, boost::bind (&Session::route_removed_from_route_group, this, _1, _2));
+       g->PropertyChanged.connect_same_thread (*this, boost::bind (&Session::route_group_property_changed, this, g));
+
        set_dirty ();
 }
 
@@ -2279,9 +2383,21 @@ Session::remove_route_group (RouteGroup& rg)
 
                route_group_removed (); /* EMIT SIGNAL */
        }
+}
 
+/** Set a new order for our route groups, without adding or removing any.
+ *  @param groups Route group list in the new order.
+ */
+void
+Session::reorder_route_groups (list<RouteGroup*> groups)
+{
+       _route_groups = groups;
+
+       route_groups_reordered (); /* EMIT SIGNAL */
+       set_dirty ();
 }
 
+
 RouteGroup *
 Session::route_group_by_name (string name)
 {
@@ -2295,67 +2411,114 @@ Session::route_group_by_name (string name)
        return 0;
 }
 
-UndoTransaction*
-Session::start_reversible_command (const string& name)
+RouteGroup&
+Session::all_route_group() const
 {
-       UndoTransaction* trans = new UndoTransaction();
-       trans->set_name(name);
-       return trans;
+        return *_all_route_group;
 }
 
 void
-Session::finish_reversible_command (UndoTransaction& ut)
+Session::add_commands (vector<Command*> const & cmds)
 {
-       struct timeval now;
-       gettimeofday(&now, 0);
-       ut.set_timestamp(now);
-       _history.add (&ut);
+       for (vector<Command*>::const_iterator i = cmds.begin(); i != cmds.end(); ++i) {
+               add_command (*i);
+       }
+}
+
+void
+Session::begin_reversible_command (const string& name)
+{
+       begin_reversible_command (g_quark_from_string (name.c_str ()));
 }
 
+/** Begin a reversible command using a GQuark to identify it.
+ *  begin_reversible_command() and commit_reversible_command() calls may be nested,
+ *  but there must be as many begin...()s as there are commit...()s.
+ */
 void
-Session::begin_reversible_command(const string& name)
+Session::begin_reversible_command (GQuark q)
 {
-       UndoTransaction* trans = new UndoTransaction();
-       trans->set_name(name);
+       /* If nested begin/commit pairs are used, we create just one UndoTransaction
+          to hold all the commands that are committed.  This keeps the order of
+          commands correct in the history.
+       */
 
-       if (!_current_trans.empty()) {
-               _current_trans.top()->add_command (trans);
-       } else {
-               _current_trans.push(trans);
+       if (_current_trans == 0) {
+               /* start a new transaction */
+               assert (_current_trans_quarks.empty ());
+               _current_trans = new UndoTransaction();
+               _current_trans->set_name (g_quark_to_string (q));
        }
+
+       _current_trans_quarks.push_front (q);
 }
 
 void
-Session::commit_reversible_command(Command *cmd)
+Session::commit_reversible_command (Command *cmd)
 {
-       assert(!_current_trans.empty());
+       assert (_current_trans);
+       assert (!_current_trans_quarks.empty ());
+
        struct timeval now;
 
        if (cmd) {
-               _current_trans.top()->add_command(cmd);
+               _current_trans->add_command (cmd);
+       }
+
+       _current_trans_quarks.pop_front ();
+
+       if (!_current_trans_quarks.empty ()) {
+               /* the transaction we're committing is not the top-level one */
+               return;
        }
 
-       if (_current_trans.top()->empty()) {
-               _current_trans.pop();
+       if (_current_trans->empty()) {
+               /* no commands were added to the transaction, so just get rid of it */
+               delete _current_trans;
+               _current_trans = 0;
                return;
        }
 
-       gettimeofday(&now, 0);
-       _current_trans.top()->set_timestamp(now);
+       gettimeofday (&now, 0);
+       _current_trans->set_timestamp (now);
 
-       _history.add(_current_trans.top());
-       _current_trans.pop();
+       _history.add (_current_trans);
+       _current_trans = 0;
 }
 
 static bool
-accept_all_non_peak_files (const string& path, void */*arg*/)
+accept_all_audio_files (const string& path, void */*arg*/)
 {
-       return (path.length() > 5 && path.find (peakfile_suffix) != (path.length() - 5));
+        if (!Glib::file_test (path, Glib::FILE_TEST_IS_REGULAR)) {
+                return false;
+        }
+
+        if (!AudioFileSource::safe_audio_file_extension (path)) {
+                return false;
+        }
+
+        return true;
+}
+
+static bool
+accept_all_midi_files (const string& path, void */*arg*/)
+{
+        if (!Glib::file_test (path, Glib::FILE_TEST_IS_REGULAR)) {
+                return false;
+        }
+
+       return ((path.length() > 4 && path.find (".mid") != (path.length() - 4)) ||
+                (path.length() > 4 && path.find (".smf") != (path.length() - 4)) ||
+                (path.length() > 5 && path.find (".midi") != (path.length() - 5)));
 }
 
 static bool
 accept_all_state_files (const string& path, void */*arg*/)
 {
+        if (!Glib::file_test (path, Glib::FILE_TEST_IS_REGULAR)) {
+                return false;
+        }
+
        return (path.length() > 7 && path.find (".ardour") == (path.length() - 7));
 }
 
@@ -2394,16 +2557,16 @@ Session::find_all_sources (string path, set<string>& result)
                        continue;
                }
 
-               if (prop->value()[0] == '/') {
+               if (Glib::path_is_absolute (prop->value())) {
                        /* external file, ignore */
                        continue;
                }
 
-               Glib::ustring found_path;
+               string found_path;
                bool is_new;
                uint16_t chan;
 
-               if (FileSource::find (type, prop->value(), true, is_new, chan, found_path)) {
+               if (FileSource::find (*this, type, prop->value(), true, is_new, chan, found_path)) {
                        result.insert (found_path);
                }
        }
@@ -2423,7 +2586,7 @@ Session::find_all_sources_across_snapshots (set<string>& result, bool exclude_th
 
        ripped = _path;
 
-       if (ripped[ripped.length()-1] == '/') {
+       if (ripped[ripped.length()-1] == G_DIR_SEPARATOR) {
                ripped = ripped.substr (0, ripped.length() - 1);
        }
 
@@ -2468,6 +2631,26 @@ Session::ask_about_playlist_deletion (boost::shared_ptr<Playlist> p)
        return r.get_value_or (1);
 }
 
+void
+Session::cleanup_regions ()
+{
+       const RegionFactory::RegionMap& regions (RegionFactory::regions());
+
+       for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
+
+               uint32_t used = playlists->region_use_count (i->second);
+
+               if (used == 0 && !i->second->automatic ()) {
+                       RegionFactory::map_remove (i->second);
+               }
+       }
+
+       /* dump the history list */
+       _history.clear ();
+
+       save_state ("");
+}
+
 int
 Session::cleanup_sources (CleanupReport& rep)
 {
@@ -2475,10 +2658,12 @@ Session::cleanup_sources (CleanupReport& rep)
 
        vector<boost::shared_ptr<Source> > dead_sources;
        PathScanner scanner;
-       string sound_path;
+       string audio_path;
+       string midi_path;
        vector<space_and_path>::iterator i;
        vector<space_and_path>::iterator nexti;
-       vector<string*>* soundfiles;
+       vector<string*>* candidates;
+       vector<string*>* candidates2;
        vector<string> unused;
        set<string> all_sources;
        bool used;
@@ -2487,14 +2672,19 @@ Session::cleanup_sources (CleanupReport& rep)
 
        _state_of_the_state = (StateOfTheState) (_state_of_the_state | InCleanup);
 
-       /* step 1: consider deleting all unused playlists */
-       
+       /* consider deleting all unused playlists */
+
        if (playlists->maybe_delete_unused (boost::bind (Session::ask_about_playlist_deletion, _1))) {
                ret = 0;
                goto out;
        }
 
-       /* step 2: find all un-used sources */
+        /* sync the "all regions" property of each playlist with its current state
+         */
+
+        playlists->sync_all_regions_with_regions ();
+
+       /* find all un-used sources */
 
        rep.paths.clear ();
        rep.space = 0;
@@ -2518,7 +2708,7 @@ Session::cleanup_sources (CleanupReport& rep)
                i = tmp;
        }
 
-       /* build a list of all the possible sound directories for the session */
+       /* build a list of all the possible audio directories for the session */
 
        for (i = session_dirs.begin(); i != session_dirs.end(); ) {
 
@@ -2526,25 +2716,49 @@ Session::cleanup_sources (CleanupReport& rep)
                ++nexti;
 
                SessionDirectory sdir ((*i).path);
-               sound_path += sdir.sound_path().to_string();
+               audio_path += sdir.sound_path().to_string();
 
                if (nexti != session_dirs.end()) {
-                       sound_path += ':';
+                       audio_path += ':';
                }
 
                i = nexti;
        }
 
-       /* now do the same thing for the files that ended up in the sounds dir(s)
-          but are not referenced as sources in any snapshot.
-       */
 
-       soundfiles = scanner (sound_path, accept_all_non_peak_files, (void *) 0, false, true);
+       /* build a list of all the possible midi directories for the session */
 
-       if (soundfiles == 0) {
-               return 0;
+       for (i = session_dirs.begin(); i != session_dirs.end(); ) {
+
+               nexti = i;
+               ++nexti;
+
+               SessionDirectory sdir ((*i).path);
+               midi_path += sdir.midi_path().to_string();
+
+               if (nexti != session_dirs.end()) {
+                       midi_path += ':';
+               }
+
+               i = nexti;
        }
 
+       candidates = scanner (audio_path, accept_all_audio_files, (void *) 0, true, true);
+       candidates2 = scanner (midi_path, accept_all_midi_files, (void *) 0, true, true);
+
+        /* merge them */
+
+        if (candidates) {
+                if (candidates2) {
+                        for (vector<string*>::iterator i = candidates2->begin(); i != candidates2->end(); ++i) {
+                                candidates->push_back (*i);
+                        }
+                        delete candidates2;
+                }
+        } else {
+                candidates = candidates2; // might still be null
+        }
+
        /* find all sources, but don't use this snapshot because the
           state file on disk still references sources we may have already
           dropped.
@@ -2555,61 +2769,78 @@ Session::cleanup_sources (CleanupReport& rep)
        /*  add our current source list
         */
 
-       for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
+       for (SourceMap::iterator i = sources.begin(); i != sources.end(); ) {
                boost::shared_ptr<FileSource> fs;
+                SourceMap::iterator tmp = i;
+                ++tmp;
 
                if ((fs = boost::dynamic_pointer_cast<FileSource> (i->second)) != 0) {
-                       all_sources.insert (fs->path());
+                        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);
+                        }
                }
+
+                i = tmp;
        }
 
        char tmppath1[PATH_MAX+1];
        char tmppath2[PATH_MAX+1];
 
-       for (vector<string*>::iterator x = soundfiles->begin(); x != soundfiles->end(); ++x) {
+        if (candidates) {
+                for (vector<string*>::iterator x = candidates->begin(); x != candidates->end(); ++x) {
+
+                        used = false;
+                        spath = **x;
+
+                        for (set<string>::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
 
-               used = false;
-               spath = **x;
+                                if (realpath(spath.c_str(), tmppath1) == 0) {
+                                        error << string_compose (_("Cannot expand path %1 (%2)"),
+                                                                 spath, strerror (errno)) << endmsg;
+                                        continue;
+                                }
 
-               for (set<string>::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
+                                if (realpath((*i).c_str(),  tmppath2) == 0) {
+                                        error << string_compose (_("Cannot expand path %1 (%2)"),
+                                                                 (*i), strerror (errno)) << endmsg;
+                                        continue;
+                                }
 
-                       if (realpath(spath.c_str(), tmppath1) == 0) {
-                                error << string_compose (_("Cannot expand path %1 (%2)"),
-                                                         spath, strerror (errno)) << endmsg;
-                                continue;
+                                if (strcmp(tmppath1, tmppath2) == 0) {
+                                        used = true;
+                                        break;
+                                }
                         }
 
-                        if (realpath((*i).c_str(),  tmppath2) == 0) {
-                                error << string_compose (_("Cannot expand path %1 (%2)"),
-                                                         (*i), strerror (errno)) << endmsg;
-                                continue;
+                        if (!used) {
+                                unused.push_back (spath);
                         }
 
-                       if (strcmp(tmppath1, tmppath2) == 0) {
-                               used = true;
-                               break;
-                       }
-               }
+                        delete *x;
+                }
 
-               if (!used) {
-                       unused.push_back (spath);
-               }
-       }
+                delete candidates;
+        }
 
-       /* now try to move all unused files into the "dead_sounds" directory(ies) */
+       /* 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;
 
-               rep.paths.push_back (*x);
-               if (stat ((*x).c_str(), &statbuf) == 0) {
-                       rep.space += statbuf.st_size;
-               }
-
                string newpath;
 
                /* don't move the file across filesystems, just
-                  stick it in the `dead_sound_dir_name' directory
+                  stick it in the `dead_dir_name' directory
                   on whichever filesystem it was already on.
                */
 
@@ -2624,24 +2855,22 @@ Session::cleanup_sources (CleanupReport& rep)
 
                        /* new school, go up 4 levels */
 
-                       newpath = Glib::path_get_dirname (*x);      // "audiofiles"
+                       newpath = Glib::path_get_dirname (*x);      // "audiofiles" or "midifiles"
                        newpath = Glib::path_get_dirname (newpath); // "session-name"
                        newpath = Glib::path_get_dirname (newpath); // "interchange"
                        newpath = Glib::path_get_dirname (newpath); // "session-dir"
                }
 
-               newpath += '/';
-               newpath += dead_sound_dir_name;
+               newpath = Glib::build_filename (newpath, dead_dir_name);
 
                if (g_mkdir_with_parents (newpath.c_str(), 0755) < 0) {
-                       error << string_compose(_("Session: cannot create session peakfile folder \"%1\" (%2)"), newpath, strerror (errno)) << endmsg;
+                       error << string_compose(_("Session: cannot create dead file folder \"%1\" (%2)"), newpath, strerror (errno)) << endmsg;
                        return -1;
                }
 
-               newpath += '/';
-               newpath += Glib::path_get_basename ((*x));
+               newpath = Glib::build_filename (newpath, Glib::path_get_basename ((*x)));
 
-               if (access (newpath.c_str(), F_OK) == 0) {
+               if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
 
                        /* the new path already exists, try versioning */
 
@@ -2652,7 +2881,7 @@ Session::cleanup_sources (CleanupReport& rep)
                        snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
                        newpath_v = buf;
 
-                       while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
+                       while (Glib::file_test (newpath_v.c_str(), Glib::FILE_TEST_EXISTS) && version < 999) {
                                snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
                                newpath_v = buf;
                        }
@@ -2671,8 +2900,10 @@ Session::cleanup_sources (CleanupReport& rep)
 
                }
 
+               stat ((*x).c_str(), &statbuf);
+
                if (::rename ((*x).c_str(), newpath.c_str()) != 0) {
-                       error << string_compose (_("cannot rename audio file source from %1 to %2 (%3)"),
+                       error << string_compose (_("cannot rename unused file source from %1 to %2 (%3)"),
                                          (*x), newpath, strerror (errno))
                              << endmsg;
                        goto out;
@@ -2681,22 +2912,27 @@ Session::cleanup_sources (CleanupReport& rep)
                /* see if there an easy to find peakfile for this file, and remove it.
                 */
 
-               string peakpath = (*x).substr (0, (*x).find_last_of ('.'));
-               peakpath += peakfile_suffix;
+                string base = basename_nosuffix (*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);
 
-               if (access (peakpath.c_str(), W_OK) == 0) {
+               if (Glib::file_test (peakpath.c_str(), Glib::FILE_TEST_EXISTS)) {
                        if (::unlink (peakpath.c_str()) != 0) {
                                error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
-                                                 peakpath, _path, strerror (errno))
+                                                         peakpath, _path, strerror (errno))
                                      << endmsg;
                                /* try to back out */
-                               rename (newpath.c_str(), _path.c_str());
+                               ::rename (newpath.c_str(), _path.c_str());
                                goto out;
                        }
                }
-       }
 
-       ret = 0;
+               rep.paths.push_back (*x);
+                rep.space += statbuf.st_size;
+        }
 
        /* dump the history list */
 
@@ -2707,6 +2943,7 @@ Session::cleanup_sources (CleanupReport& rep)
        */
 
        save_state ("");
+       ret = 0;
 
   out:
        _state_of_the_state = (StateOfTheState) (_state_of_the_state & ~InCleanup);
@@ -2720,58 +2957,16 @@ Session::cleanup_trash_sources (CleanupReport& rep)
        // FIXME: needs adaptation for MIDI
 
        vector<space_and_path>::iterator i;
-       string dead_sound_dir;
-       struct dirent* dentry;
-       struct stat statbuf;
-       DIR* dead;
+       string dead_dir;
 
        rep.paths.clear ();
        rep.space = 0;
 
        for (i = session_dirs.begin(); i != session_dirs.end(); ++i) {
 
-               dead_sound_dir = (*i).path;
-               dead_sound_dir += dead_sound_dir_name;
-
-               if ((dead = opendir (dead_sound_dir.c_str())) == 0) {
-                       continue;
-               }
-
-               while ((dentry = readdir (dead)) != 0) {
-
-                       /* avoid '.' and '..' */
-
-                       if ((dentry->d_name[0] == '.' && dentry->d_name[1] == '\0') ||
-                           (dentry->d_name[2] == '\0' && dentry->d_name[0] == '.' && dentry->d_name[1] == '.')) {
-                               continue;
-                       }
-
-                       string fullpath;
-
-                       fullpath = dead_sound_dir;
-                       fullpath += '/';
-                       fullpath += dentry->d_name;
-
-                       if (stat (fullpath.c_str(), &statbuf)) {
-                               continue;
-                       }
-
-                       if (!S_ISREG (statbuf.st_mode)) {
-                               continue;
-                       }
-
-                       if (unlink (fullpath.c_str())) {
-                               error << string_compose (_("cannot remove dead sound file %1 (%2)"),
-                                                 fullpath, strerror (errno))
-                                     << endmsg;
-                       }
-
-                       rep.paths.push_back (dentry->d_name);
-                       rep.space += statbuf.st_size;
-               }
-
-               closedir (dead);
+               dead_dir = Glib::build_filename ((*i).path, dead_dir_name);
 
+                clear_directory (dead_dir, &rep.space, &rep.paths);
        }
 
        return 0;
@@ -2885,7 +3080,7 @@ Session::controllable_by_descriptor (const ControllableDescriptor& desc)
                r = route_by_remote_id (desc.rid());
                break;
        }
-       
+
        if (!r) {
                return c;
        }
@@ -2896,7 +3091,7 @@ Session::controllable_by_descriptor (const ControllableDescriptor& desc)
                break;
 
        case ControllableDescriptor::Solo:
-               c = r->solo_control();
+                c = r->solo_control();
                break;
 
        case ControllableDescriptor::Mute:
@@ -2906,16 +3101,30 @@ Session::controllable_by_descriptor (const ControllableDescriptor& desc)
        case ControllableDescriptor::Recenable:
        {
                boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
-               
+
                if (t) {
                        c = t->rec_enable_control ();
                }
                break;
        }
 
-       case ControllableDescriptor::Pan:
-               /* XXX pan control */
+       case ControllableDescriptor::PanDirection:
+        {
+                c = r->pannable()->pan_azimuth_control;
+               break;
+        }
+
+       case ControllableDescriptor::PanWidth:
+        {
+                c = r->pannable()->pan_width_control;
                break;
+        }
+
+       case ControllableDescriptor::PanElevation:
+        {
+                c = r->pannable()->pan_elevation_control;
+               break;
+        }
 
        case ControllableDescriptor::Balance:
                /* XXX simple pan control */
@@ -2927,17 +3136,17 @@ Session::controllable_by_descriptor (const ControllableDescriptor& desc)
                uint32_t parameter_index = desc.target (1);
 
                /* revert to zero based counting */
-               
+
                if (plugin > 0) {
                        --plugin;
                }
-               
+
                if (parameter_index > 0) {
                        --parameter_index;
                }
 
                boost::shared_ptr<Processor> p = r->nth_plugin (plugin);
-               
+
                if (p) {
                        c = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
                                p->control(Evoral::Parameter(PluginAutomation, 0, parameter_index)));
@@ -2945,18 +3154,18 @@ 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();
@@ -3107,14 +3316,36 @@ Session::restore_history (string snapshot_name)
                                        ut->add_command(c);
                                }
 
-                       } else if (n->name() == "DiffCommand") {
-                               PBD::ID  id(n->property("midi-source")->value());
+                       } else if (n->name() == "NoteDiffCommand") {
+                               PBD::ID id (n->property("midi-source")->value());
+                               boost::shared_ptr<MidiSource> midi_source =
+                                       boost::dynamic_pointer_cast<MidiSource, Source>(source_by_id(id));
+                               if (midi_source) {
+                                       ut->add_command (new MidiModel::NoteDiffCommand(midi_source->model(), *n));
+                               } else {
+                                       error << _("Failed to downcast MidiSource for NoteDiffCommand") << endmsg;
+                               }
+
+                       } else if (n->name() == "SysExDiffCommand") {
+
+                               PBD::ID id (n->property("midi-source")->value());
                                boost::shared_ptr<MidiSource> midi_source =
                                        boost::dynamic_pointer_cast<MidiSource, Source>(source_by_id(id));
                                if (midi_source) {
-                                       ut->add_command(new MidiModel::DiffCommand(midi_source->model(), *n));
+                                       ut->add_command (new MidiModel::SysExDiffCommand (midi_source->model(), *n));
                                } else {
-                                       error << _("Failed to downcast MidiSource for DiffCommand") << endmsg;
+                                       error << _("Failed to downcast MidiSource for SysExDiffCommand") << endmsg;
+                               }
+
+                       } else if (n->name() == "PatchChangeDiffCommand") {
+
+                               PBD::ID id (n->property("midi-source")->value());
+                               boost::shared_ptr<MidiSource> midi_source =
+                                       boost::dynamic_pointer_cast<MidiSource, Source>(source_by_id(id));
+                               if (midi_source) {
+                                       ut->add_command (new MidiModel::PatchChangeDiffCommand (midi_source->model(), *n));
+                               } else {
+                                       error << _("Failed to downcast MidiSource for PatchChangeDiffCommand") << endmsg;
                                }
 
                        } else if (n->name() == "StatefulDiffCommand") {
@@ -3149,21 +3380,14 @@ Session::config_changed (std::string p, bool ours)
 
                if (Config->get_monitoring_model() == HardwareMonitoring && transport_rolling()) {
                        /* auto-input only makes a difference if we're rolling */
-
-                       boost::shared_ptr<RouteList> rl = routes.reader ();
-                       for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
-                               boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
-                               if (tr && tr->record_enabled ()) {
-                                       tr->monitor_input (!config.get_auto_input());
-                               }
-                       }
+                        set_track_monitor_input_status (!config.get_auto_input());
                }
 
        } else if (p == "punch-in") {
 
                Location* location;
 
-               if ((location = _locations.auto_punch_location()) != 0) {
+               if ((location = _locations->auto_punch_location()) != 0) {
 
                        if (config.get_punch_in ()) {
                                replace_event (SessionEvent::PunchIn, location->start());
@@ -3176,7 +3400,7 @@ Session::config_changed (std::string p, bool ours)
 
                Location* location;
 
-               if ((location = _locations.auto_punch_location()) != 0) {
+               if ((location = _locations->auto_punch_location()) != 0) {
 
                        if (config.get_punch_out()) {
                                replace_event (SessionEvent::PunchOut, location->end());
@@ -3201,13 +3425,13 @@ Session::config_changed (std::string p, bool ours)
 
                //poke_midi_thread ();
 
-       } else if (p == "mmc-device-id" || p == "mmc-receive-id") {
+       } else if (p == "mmc-device-id" || p == "mmc-receive-id" || p == "mmc-receive-device-id") {
 
-               _mmc->set_receive_device_id (Config->get_mmc_receive_device_id());
+               MIDI::Manager::instance()->mmc()->set_receive_device_id (Config->get_mmc_receive_device_id());
 
-       } else if (p == "mmc-send-id") {
+       } else if (p == "mmc-send-id" || p == "mmc-send-device-id") {
 
-               _mmc->set_send_device_id (Config->get_mmc_send_device_id());
+               MIDI::Manager::instance()->mmc()->set_send_device_id (Config->get_mmc_send_device_id());
 
        } else if (p == "midi-control") {
 
@@ -3257,15 +3481,14 @@ Session::config_changed (std::string p, bool ours)
 
        } else if (p == "send-mtc") {
 
-               session_send_mtc = Config->get_send_mtc();
-               if (session_send_mtc) {
+               if (Config->get_send_mtc ()) {
                        /* mark us ready to send */
                        next_quarter_frame_to_send = 0;
                }
 
        } else if (p == "send-mmc") {
 
-               _mmc->enable_send (Config->get_send_mmc ());
+               MIDI::Manager::instance()->mmc()->enable_send (Config->get_send_mmc ());
 
        } else if (p == "midi-feedback") {
 
@@ -3307,23 +3530,26 @@ Session::config_changed (std::string p, bool ours)
                sync_order_keys ("session");
        } else if (p == "initial-program-change") {
 
-               if (_mmc->output_port() && Config->get_initial_program_change() >= 0) {
+               if (MIDI::Manager::instance()->mmc()->output_port() && Config->get_initial_program_change() >= 0) {
                        MIDI::byte buf[2];
 
                        buf[0] = MIDI::program; // channel zero by default
                        buf[1] = (Config->get_initial_program_change() & 0x7f);
 
-                       _mmc->output_port()->midimsg (buf, sizeof (buf), 0);
+                       MIDI::Manager::instance()->mmc()->output_port()->midimsg (buf, sizeof (buf), 0);
                }
        } else if (p == "solo-mute-override") {
                // catch_up_on_solo_mute_override ();
-       } else if (p == "listen-position") {
+       } else if (p == "listen-position" || p == "pfl-position") {
                listen_position_changed ();
        } else if (p == "solo-control-is-listen-control") {
                solo_control_mode_changed ();
+       } else if (p == "timecode-offset" || p == "timecode-offset-negative") {
+               last_timecode_valid = false;
+       } else if (p == "playback-buffer-seconds") {
+               AudioSource::allocate_working_buffers (frame_rate());
        }
 
-
        set_dirty ();
 }
 
@@ -3362,29 +3588,211 @@ Session::load_diskstreams_2X (XMLNode const & node, int)
         return 0;
 }
 
-/** Create our MachineControl object and connect things to it */
+/** Connect things to the MMC object */
 void
 Session::setup_midi_machine_control ()
 {
-       _mmc = new MIDI::MachineControl (_engine.jack());
-       
-       _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));
-       _mmc->Stop.connect_same_thread (*this, boost::bind (&Session::mmc_stop, this, _1));
-       _mmc->FastForward.connect_same_thread (*this, boost::bind (&Session::mmc_fast_forward, this, _1));
-       _mmc->Rewind.connect_same_thread (*this, boost::bind (&Session::mmc_rewind, this, _1));
-       _mmc->Pause.connect_same_thread (*this, boost::bind (&Session::mmc_pause, this, _1));
-       _mmc->RecordPause.connect_same_thread (*this, boost::bind (&Session::mmc_record_pause, this, _1));
-       _mmc->RecordStrobe.connect_same_thread (*this, boost::bind (&Session::mmc_record_strobe, this, _1));
-       _mmc->RecordExit.connect_same_thread (*this, boost::bind (&Session::mmc_record_exit, this, _1));
-       _mmc->Locate.connect_same_thread (*this, boost::bind (&Session::mmc_locate, this, _1, _2));
-       _mmc->Step.connect_same_thread (*this, boost::bind (&Session::mmc_step, this, _1, _2));
-       _mmc->Shuttle.connect_same_thread (*this, boost::bind (&Session::mmc_shuttle, this, _1, _2, _3));
-       _mmc->TrackRecordStatusChange.connect_same_thread (*this, boost::bind (&Session::mmc_record_enable, this, _1, _2, _3));
+       MIDI::MachineControl* mmc = MIDI::Manager::instance()->mmc ();
+
+       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));
+       mmc->Stop.connect_same_thread (*this, boost::bind (&Session::mmc_stop, this, _1));
+       mmc->FastForward.connect_same_thread (*this, boost::bind (&Session::mmc_fast_forward, this, _1));
+       mmc->Rewind.connect_same_thread (*this, boost::bind (&Session::mmc_rewind, this, _1));
+       mmc->Pause.connect_same_thread (*this, boost::bind (&Session::mmc_pause, this, _1));
+       mmc->RecordPause.connect_same_thread (*this, boost::bind (&Session::mmc_record_pause, this, _1));
+       mmc->RecordStrobe.connect_same_thread (*this, boost::bind (&Session::mmc_record_strobe, this, _1));
+       mmc->RecordExit.connect_same_thread (*this, boost::bind (&Session::mmc_record_exit, this, _1));
+       mmc->Locate.connect_same_thread (*this, boost::bind (&Session::mmc_locate, this, _1, _2));
+       mmc->Step.connect_same_thread (*this, boost::bind (&Session::mmc_step, this, _1, _2));
+       mmc->Shuttle.connect_same_thread (*this, boost::bind (&Session::mmc_shuttle, this, _1, _2, _3));
+       mmc->TrackRecordStatusChange.connect_same_thread (*this, boost::bind (&Session::mmc_record_enable, this, _1, _2, _3));
 
        /* also handle MIDI SPP because its so common */
 
-       _mmc->SPPStart.connect_same_thread (*this, boost::bind (&Session::spp_start, this, _1, _2));
-       _mmc->SPPContinue.connect_same_thread (*this, boost::bind (&Session::spp_continue, this, _1, _2));
-       _mmc->SPPStop.connect_same_thread (*this, boost::bind (&Session::spp_stop, this, _1, _2));
+       mmc->SPPStart.connect_same_thread (*this, boost::bind (&Session::spp_start, this, _1, _2));
+       mmc->SPPContinue.connect_same_thread (*this, boost::bind (&Session::spp_continue, this, _1, _2));
+       mmc->SPPStop.connect_same_thread (*this, boost::bind (&Session::spp_stop, this, _1, _2));
+}
+
+boost::shared_ptr<Controllable>
+Session::solo_cut_control() const
+{
+        /* the solo cut control is a bit of an anomaly, at least as of Febrary 2011. There are no other
+           controls in Ardour that currently get presented to the user in the GUI that require
+           access as a Controllable and are also NOT owned by some SessionObject (e.g. Route, or MonitorProcessor).
+
+           its actually an RCConfiguration parameter, so we use a ProxyControllable to wrap
+           it up as a Controllable. Changes to the Controllable will just map back to the RCConfiguration
+           parameter.
+        */
+
+        return _solo_cut_control;
+}
+
+int
+Session::rename (const std::string& new_name)
+{
+       string legal_name = legalize_for_path (new_name);
+       string newpath;
+       string oldstr;
+       string newstr;
+       bool first = true;
+
+       string const old_sources_root = _session_dir->sources_root().to_string ();
+
+#define RENAME ::rename
+
+       /* Rename:
+
+        * session directory
+        * interchange subdirectory
+        * session file
+        * session history
+        
+        * Backup files are left unchanged and not renamed.
+        */
+
+       /* 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) {
+               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);
+               }
+
+               string base = Glib::path_get_dirname (oldstr);
+               string p = Glib::path_get_basename (oldstr);
+
+               newstr = Glib::build_filename (base, legal_name);
+               
+               if (Glib::file_test (newstr, Glib::FILE_TEST_EXISTS)) {
+                       return -1;
+               }
+       }
+
+       /* Session dirs */
+       
+       for (vector<space_and_path>::const_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);
+               }
+
+               string base = Glib::path_get_dirname (oldstr);
+               string p = Glib::path_get_basename (oldstr);
+
+               newstr = Glib::build_filename (base, legal_name);
+
+               cerr << "Rename " << oldstr << " => " << newstr << endl;                
+
+               if (RENAME (oldstr.c_str(), newstr.c_str()) != 0) {
+                       return 1;
+               }
+
+               if (first) {
+                       (*_session_dir) = newstr;
+                       newpath = newstr;
+                       first = 1;
+               }
+
+               /* directory below interchange */
+
+               v.push_back (newstr);
+               v.push_back (interchange_dir_name);
+               v.push_back (p);
+
+               oldstr = Glib::build_filename (v);
+
+               v.clear ();
+               v.push_back (newstr);
+               v.push_back (interchange_dir_name);
+               v.push_back (legal_name);
+
+               newstr = Glib::build_filename (v);
+               
+               cerr << "Rename " << oldstr << " => " << newstr << endl;
+               
+               if (RENAME (oldstr.c_str(), newstr.c_str()) != 0) {
+                       return 1;
+               }
+       }
+
+       /* state file */
+       
+       oldstr = Glib::build_filename (newpath, _current_snapshot_name) + statefile_suffix;
+       newstr= Glib::build_filename (newpath, legal_name) + statefile_suffix;
+       
+       cerr << "Rename " << oldstr << " => " << newstr << endl;                
+
+       if (RENAME (oldstr.c_str(), newstr.c_str()) != 0) {
+               return 1;
+       }
+
+       /* history file */
+
+       
+       oldstr = Glib::build_filename (newpath, _current_snapshot_name) + history_suffix;
+
+       if (Glib::file_test (oldstr, Glib::FILE_TEST_EXISTS))  {
+               newstr = Glib::build_filename (newpath, legal_name) + history_suffix;
+               
+               cerr << "Rename " << oldstr << " => " << newstr << endl;                
+               
+               if (RENAME (oldstr.c_str(), newstr.c_str()) != 0) {
+                       return 1;
+               }
+       }
+
+       /* 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) {
+                       string p = fs->path ();
+                       boost::replace_all (p, old_sources_root, _session_dir->sources_root().to_string ());
+                       fs->set_path (p);
+               }
+       }
+
+       /* remove old name from recent sessions */
+
+       remove_recent_sessions (_path);
+
+       _path = newpath;
+       _current_snapshot_name = new_name;
+       _name = new_name;
+
+       set_dirty ();
+
+       /* save state again to get everything just right */
+
+       save_state (_current_snapshot_name);
+
+
+       /* add to recent sessions */
+
+       store_recent_sessions (new_name, _path);
+
+       return 0;
+
+#undef RENAME
 }