(FULL) not-yet-complete JACK session management patch (TODO: get program name, vary...
[ardour.git] / libs / ardour / session_state.cc
index 9394cd7bec54d16d0ba4f41feaca18174ebd493a..22a9100b319e602d65e27010bf02d51ea7fcad30 100644 (file)
 #include "midi++/port.h"
 
 #include "pbd/boost_debug.h"
+#include "pbd/controllable_descriptor.h"
 #include "pbd/enumwriter.h"
 #include "pbd/error.h"
 #include "pbd/pathscanner.h"
 #include "pbd/pthread_utils.h"
 #include "pbd/search_path.h"
 #include "pbd/stacktrace.h"
+#include "pbd/convert.h"
 
+#include "ardour/amp.h"
 #include "ardour/audio_diskstream.h"
 #include "ardour/audio_track.h"
 #include "ardour/audioengine.h"
@@ -144,10 +147,8 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        }
 
        if (Glib::file_test (_path, Glib::FILE_TEST_EXISTS) && ::access (_path.c_str(), W_OK)) {
-               cerr << "Session non-writable based on " << _path << endl;
                _writable = false;
        } else {
-               cerr << "Session writable based on " << _path << endl;
                _writable = true;
        }
 
@@ -164,7 +165,7 @@ Session::first_stage_init (string fullpath, string snapshot_name)
        _base_frame_rate = _current_frame_rate;
 
        _tempo_map = new TempoMap (_current_frame_rate);
-       _tempo_map->StateChanged.connect_same_thread (*this, boost::bind (&Session::tempo_map_changed, this, _1));
+       _tempo_map->PropertyChanged.connect_same_thread (*this, boost::bind (&Session::tempo_map_changed, this, _1));
 
 
        _non_soloed_outs_muted = false;
@@ -269,10 +270,8 @@ Session::first_stage_init (string fullpath, string snapshot_name)
 
        /* These are all static "per-class" signals */
 
-       RegionFactory::CheckNewRegion.connect_same_thread (*this, boost::bind (&Session::add_region, this, _1));
        SourceFactory::SourceCreated.connect_same_thread (*this, boost::bind (&Session::add_source, this, _1));
        PlaylistFactory::PlaylistCreated.connect_same_thread (*this, boost::bind (&Session::add_playlist, this, _1, _2));
-       Processor::ProcessorCreated.connect_same_thread (*this, boost::bind (&Session::add_processor, this, _1));
        AutomationList::AutomationListCreated.connect_same_thread (*this, boost::bind (&Session::add_automation_list, this, _1));
        Controllable::Destroyed.connect_same_thread (*this, boost::bind (&Session::remove_controllable, this, _1));
        IO::PortCountChanged.connect_same_thread (*this, boost::bind (&Session::ensure_buffers, this, _1));
@@ -284,11 +283,11 @@ Session::first_stage_init (string fullpath, string snapshot_name)
 }
 
 int
-Session::second_stage_init (bool new_session)
+Session::second_stage_init ()
 {
        AudioFileSource::set_peak_dir (_session_dir->peak_path().to_string());
 
-       if (!new_session) {
+       if (!_is_new) {
                if (load_state (_current_snapshot_name)) {
                        return -1;
                }
@@ -338,7 +337,7 @@ Session::second_stage_init (bool new_session)
        _engine.Xrun.connect_same_thread (*this, boost::bind (&Session::xrun_recovery, this));
 
        try {
-               when_engine_running();
+               when_engine_running ();
        }
 
        /* handle this one in a different way than all others, so that its clear what happened */
@@ -368,7 +367,7 @@ Session::second_stage_init (bool new_session)
 
        ControlProtocolManager::instance().set_session (this);
 
-       config.set_end_marker_is_free (new_session);
+       config.set_end_marker_is_free (_is_new);
 
        _state_of_the_state = Clean;
 
@@ -494,7 +493,7 @@ Session::ensure_subdirs ()
 }
 
 int
-Session::create (bool& new_session, const string& mix_template, nframes_t initial_length)
+Session::create (const string& mix_template, nframes_t initial_length, BusProfile* bus_profile)
 {
 
        if (g_mkdir_with_parents (_path.c_str(), 0755) < 0) {
@@ -506,8 +505,6 @@ Session::create (bool& new_session, const string& mix_template, nframes_t initia
                return -1;
        }
 
-       /* check new_session so we don't overwrite an existing one */
-
        if (!mix_template.empty()) {
                std::string in_path = mix_template;
 
@@ -522,11 +519,6 @@ Session::create (bool& new_session, const string& mix_template, nframes_t initia
 
                        if (out){
                                out << in.rdbuf();
-
-                               // okay, session is set up.  Treat like normal saved
-                               // session from now on.
-
-                               new_session = false;
                                return 0;
 
                        } else {
@@ -556,6 +548,64 @@ Session::create (bool& new_session, const string& mix_template, nframes_t initia
        _locations.add (end_location);
 
        _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;
+                                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);
+
+                        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);
+               }
+
+                /* 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);
+        }
 
        save_state ("");
 
@@ -675,6 +725,35 @@ Session::remove_state (string snapshot_name)
        sys::remove (xml_path);
 }
 
+#ifdef HAVE_JACK_SESSION
+void
+Session::jack_session_event( jack_session_event_t * event )
+{
+       if (save_state ("jacksession_snap")) {
+                event->flags = JackSessionSaveError; 
+       } else {
+                sys::path xml_path (_session_dir->root_path());
+                xml_path /= legalize_for_path ("jacksession_snap") + statefile_suffix;
+                
+                string cmd ("PROG_NAME -U ");
+                cmd += event->client_uuid;
+                cmd += ' \"';
+                cmd += xml_path.to_string();
+                cmd += '\"';
+                
+                event->command_line = strdup (cmd.c_str());
+       }
+
+       jack_session_reply (_engine.jack(), event);
+
+       if (event->type == JackSessionSaveAndQuit) {
+                // TODO: make ardour quit.
+       }
+
+       jack_session_event_free( event );
+}
+#endif
+
 int
 Session::save_state (string snapshot_name, bool pending)
 {
@@ -686,7 +765,8 @@ Session::save_state (string snapshot_name, bool pending)
        }
 
        if (!_engine.connected ()) {
-               error << _("Ardour's audio engine is not connected and state saving would lose all I/O connections. Session not saved")
+               error << string_compose (_("the %1 audio engine is not connected and state saving would lose all I/O connections. Session not saved"),
+                                         PROGRAM_NAME)
                      << endmsg;
                return 1;
        }
@@ -825,7 +905,7 @@ Session::load_state (string snapshot_name)
        XMLNode& root (*state_tree->root());
 
        if (root.name() != X_("Session")) {
-               error << string_compose (_("Session file %1 is not an Ardour session"), xmlpath.to_string()) << endmsg;
+               error << string_compose (_("Session file %1 is not a session"), xmlpath.to_string()) << endmsg;
                delete state_tree;
                state_tree = 0;
                return -1;
@@ -856,8 +936,8 @@ Session::load_state (string snapshot_name)
                        return 0;
                }
 
-               info << string_compose (_("Copying old session file %1 to %2\nUse %2 with Ardour versions before 2.0 from now on"),
-                                       xmlpath.to_string(), backup_path.to_string())
+               info << string_compose (_("Copying old session file %1 to %2\nUse %2 with %3 versions before 2.0 from now on"),
+                                       xmlpath.to_string(), backup_path.to_string(), PROGRAM_NAME)
                     << endmsg;
 
                try
@@ -990,15 +1070,14 @@ Session::state(bool full_state)
 
        if (full_state) {
                Glib::Mutex::Lock rl (region_lock);
-
-               for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
-
-                       /* only store regions not attached to playlists */
-
-                       if (i->second->playlist() == 0) {
-                               child->add_child_nocopy (i->second->state (true));
-                       }
-               }
+                const RegionFactory::RegionMap& region_map (RegionFactory::all_regions());
+                for (RegionFactory::RegionMap::const_iterator i = region_map.begin(); i != region_map.end(); ++i) {
+                        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 = node->add_child ("DiskStreams");
@@ -1046,6 +1125,12 @@ Session::state(bool full_state)
                RouteList public_order (*r);
                public_order.sort (cmp);
 
+                /* the sort should have put control outs first */
+
+                if (_monitor_out) {
+                        assert (_monitor_out == public_order.front());
+                }
+
                for (RouteList::iterator i = public_order.begin(); i != public_order.end(); ++i) {
                        if (!(*i)->is_hidden()) {
                                if (full_state) {
@@ -1369,35 +1454,87 @@ Session::load_routes (const XMLNode& node, int version)
 boost::shared_ptr<Route>
 Session::XMLRouteFactory (const XMLNode& node, int version)
 {
+       boost::shared_ptr<Route> ret;
+
        if (node.name() != "Route") {
-               return boost::shared_ptr<Route> ((Route*) 0);
+               return ret;
        }
 
-       bool has_diskstream = (node.property ("diskstream") != 0 || node.property ("diskstream-id") != 0);
+        const XMLProperty* dsprop;
 
+        if ((dsprop = node.property (X_("diskstream-id"))) == 0) {
+                dsprop = node.property (X_("diskstream"));
+        }
+        
        DataType type = DataType::AUDIO;
        const XMLProperty* prop = node.property("default-type");
-       boost::shared_ptr<Route> ret;
 
        if (prop) {
-               type = DataType(prop->value());
+               type = DataType (prop->value());
        }
 
-       assert(type != DataType::NIL);
+       assert (type != DataType::NIL);
 
-       if (has_diskstream) {
-               if (type == DataType::AUDIO) {
-                       AudioTrack* at = new AudioTrack (*this, node, version);
-                       boost_debug_shared_ptr_mark_interesting (at, "Track");
-                       ret.reset (at);
-                       
-               } else {
-                       ret.reset (new MidiTrack (*this, node, version));
-               }
+       if (dsprop) {
+
+                boost::shared_ptr<Diskstream> ds;
+                PBD::ID diskstream_id (dsprop->value());
+               PBD::ID zero ("0");
+
+               /* this wierd hack is used when creating
+                  tracks from a template. We have a special
+                  ID for the diskstream that means "you
+                  should create a new diskstream here, not
+                  look for an old one."
+               */
+                
+               if (diskstream_id != zero) {
+
+                        ds = diskstream_by_id (diskstream_id);
+
+                        if (!ds) {
+                                error << string_compose (_("cannot find diskstream ID %1"), diskstream_id.to_s()) << endmsg;
+                                return ret;
+                        }
+               } 
+
+                Track* track;
+                
+                if (type == DataType::AUDIO) {
+                        track = new AudioTrack (*this, X_("toBeResetFroXML"));
+                        
+                } else {
+                        track = new MidiTrack (*this, X_("toBeResetFroXML"));
+                }
+                
+                if (track->init()) {
+                        delete track;
+                        return ret;
+                }
+                
+                if (ds) {
+                        track->set_diskstream (ds);
+                } else {
+                        track->use_new_diskstream ();
+                }
+                
+                if (track->set_state (node, version)) {
+                        delete track;
+                        return ret;
+                }
+                
+                boost_debug_shared_ptr_mark_interesting (track, "Track");
+                ret.reset (track);
+                
        } else {
-               Route* rt = new Route (*this, node);
-               boost_debug_shared_ptr_mark_interesting (rt, "Route");
-               ret.reset (rt);
+               Route* rt = 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;
+                }
        }
 
        return ret;
@@ -1728,7 +1865,7 @@ Session::XMLSourceFactory (const XMLNode& node)
        }
 
        catch (failed_constructor& err) {
-               error << _("Found a sound file that cannot be used by Ardour. Talk to the progammers.") << endmsg;
+               error << string_compose (_("Found a sound file that cannot be used by %1. Talk to the progammers."), PROGRAM_NAME) << endmsg;
                return boost::shared_ptr<Source>();
        }
 }
@@ -2678,6 +2815,121 @@ Session::controllable_by_id (const PBD::ID& id)
        return boost::shared_ptr<Controllable>();
 }
 
+boost::shared_ptr<Controllable>
+Session::controllable_by_descriptor (const ControllableDescriptor& desc)
+{
+       boost::shared_ptr<Controllable> c;
+       boost::shared_ptr<Route> r;
+
+       switch (desc.top_level_type()) {
+       case ControllableDescriptor::NamedRoute:
+       {
+               std::string str = desc.top_level_name();
+               if (str == "master") {
+                       r = _master_out;
+               } else if (str == "control" || str == "listen") {
+                       r = _monitor_out;
+               } else {
+                       r = route_by_name (desc.top_level_name());
+               }
+               break;
+       }
+
+       case ControllableDescriptor::RemoteControlID:
+               r = route_by_remote_id (desc.rid());
+               break;
+       }
+       
+       if (!r) {
+               return c;
+       }
+
+       switch (desc.subtype()) {
+       case ControllableDescriptor::Gain:
+               c = r->gain_control ();
+               break;
+
+       case ControllableDescriptor::Solo:
+               c = r->solo_control();
+               break;
+
+       case ControllableDescriptor::Mute:
+               c = r->mute_control();
+               break;
+
+       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 */
+               break;
+
+       case ControllableDescriptor::Balance:
+               /* XXX simple pan control */
+               break;
+
+       case ControllableDescriptor::PluginParameter:
+       {
+               uint32_t plugin = desc.target (0);
+               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)));
+               }
+               break;
+       }
+
+       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();
+                       }
+               }
+               break;
+       }
+
+       default:
+               /* relax and return a null pointer */
+               break;
+       }
+
+       return c;
+}
+
 void
 Session::add_instant_xml (XMLNode& node, bool write_to_config)
 {
@@ -2829,6 +3081,10 @@ Session::restore_history (string snapshot_name)
                                        error << _("Failed to downcast MidiSource for DeltaCommand") << endmsg;
                                }
 
+                       } else if (n->name() == "StatefulDiffCommand") {
+                               if ((c = stateful_diff_command_factory (n))) {
+                                       ut->add_command (c);
+                               }
                        } else {
                                error << string_compose(_("Couldn't figure out how to make a Command out of a %1 XMLNode."), n->name()) << endmsg;
                        }