Wouldn't it be nice if plugin presets had a description/comment?
[ardour.git] / libs / ardour / processor.cc
index f7afeb99a727d00ad8e189fe36b62cef2a42c671..39c3d68ad7941d8ac35a852e057cd2f0486521f6 100644 (file)
 
 #include <string>
 
-
-#include "pbd/failed_constructor.h"
-#include "pbd/enumwriter.h"
 #include "pbd/xml++.h"
+#include "pbd/types_convert.h"
 
+#include "ardour/automatable.h"
+#include "ardour/chan_count.h"
+#include "ardour/debug.h"
 #include "ardour/processor.h"
-#include "ardour/plugin.h"
-#include "ardour/port.h"
-#include "ardour/route.h"
-#include "ardour/ladspa_plugin.h"
-#include "ardour/buffer_set.h"
-#include "ardour/send.h"
-#include "ardour/port_insert.h"
-#include "ardour/plugin_insert.h"
-
-#ifdef VST_SUPPORT
-#include "ardour/vst_plugin.h"
+#include "ardour/types.h"
+
+#ifdef WINDOWS_VST_SUPPORT
+#include "ardour/windows_vst_plugin.h"
 #endif
 
-#ifdef HAVE_AUDIOUNITS
+#ifdef AUDIOUNIT_SUPPORT
 #include "ardour/audio_unit.h"
 #endif
 
 #include "ardour/session.h"
 #include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+namespace ARDOUR { class Session; }
+
 // Always saved as Processor, but may be IOProcessor or Send in legacy sessions
 const string Processor::state_node_name = "Processor";
 
@@ -69,6 +65,14 @@ Processor::Processor(Session& session, const string& name)
        , _display_to_user (true)
        , _pre_fader (false)
        , _ui_pointer (0)
+       , _window_proxy (0)
+       , _pinmgr_proxy (0)
+       , _owner (0)
+       , _input_latency (0)
+       , _output_latency (0)
+       , _capture_offset (0)
+       , _playback_offset (0)
+       , _loop_location (0)
 {
 }
 
@@ -76,6 +80,7 @@ Processor::Processor (const Processor& other)
        : Evoral::ControlSet (other)
        , SessionObject (other.session(), other.name())
        , Automatable (other.session())
+       , Latent (other)
        , _pending_active(other._pending_active)
        , _active(other._active)
        , _next_ab_is_active(false)
@@ -83,13 +88,26 @@ Processor::Processor (const Processor& other)
        , _display_to_user (true)
        , _pre_fader (false)
        , _ui_pointer (0)
+       , _window_proxy (0)
+       , _pinmgr_proxy (0)
+       , _owner (0)
+       , _input_latency (0)
+       , _output_latency (0)
+       , _capture_offset (0)
+       , _playback_offset (0)
+       , _loop_location (other._loop_location)
 {
 }
 
+Processor::~Processor ()
+{
+       DEBUG_TRACE (DEBUG::Destruction, string_compose ("processor %1 destructor\n", _name));
+}
+
 XMLNode&
 Processor::get_state (void)
 {
-       return state (true);
+       return state ();
 }
 
 /* NODE STRUCTURE
@@ -107,29 +125,28 @@ Processor::get_state (void)
 */
 
 XMLNode&
-Processor::state (bool full_state)
+Processor::state ()
 {
        XMLNode* node = new XMLNode (state_node_name);
-       char buf[64];
 
-       id().print (buf, sizeof (buf));
-       node->add_property("id", buf);
-       node->add_property("name", _name);
-       node->add_property("active", active() ? "yes" : "no");
+       node->set_property("id", id());
+       node->set_property("name", name());
+       node->set_property("active", active());
 
        if (_extra_xml){
                node->add_child_copy (*_extra_xml);
        }
 
-       if (full_state) {
+       if (!skip_saving_automation) {
                XMLNode& automation = Automatable::get_automation_xml_state();
                if (!automation.children().empty() || !automation.properties().empty()) {
                        node->add_child_nocopy (automation);
+               } else {
+                       delete &automation;
                }
        }
 
-       snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
-       node->add_property("user-latency", buf);
+       node->set_property("user-latency", _user_latency);
 
        return *node;
 }
@@ -149,11 +166,11 @@ Processor::set_state_2X (const XMLNode & node, int /*version*/)
                                set_name (prop->value ());
                        }
 
-                       if ((prop = (*i)->property ("id")) != 0) {
-                               _id = prop->value ();
-                       }
+                       set_id (**i);
 
-                       if ((prop = (*i)->property ("active")) != 0) {
+                       //note:  in A2, active state was stored in the Redirect node, not the child IO node
+                       /*
+                        * if ((prop = (*i)->property ("active")) != 0) {
                                bool const a = string_is_affirmative (prop->value ());
                                if (_active != a) {
                                        if (a) {
@@ -162,7 +179,8 @@ Processor::set_state_2X (const XMLNode & node, int /*version*/)
                                                deactivate ();
                                        }
                                }
-                       }
+                       }*/
+
                }
        }
 
@@ -176,20 +194,19 @@ Processor::set_state (const XMLNode& node, int version)
                return set_state_2X (node, version);
        }
 
-       const XMLProperty *prop;
-       const XMLProperty *legacy_active = 0;
-
-       // may not exist for legacy 3.0 sessions
-       if ((prop = node.property ("name")) != 0) {
-               /* don't let derived classes have a crack at set_name,
-                  as some (like Send) will screw with the one we suggest.
-               */
-               Processor::set_name (prop->value());
-       }
+       bool ignore_name;
+       // Only testing for the presence of the property not value
+       if (!node.get_property("ignore-name", ignore_name)) {
+               string name;
+               // may not exist for legacy 3.0 sessions
+               if (node.get_property ("name", name)) {
+                       /* don't let derived classes have a crack at set_name,
+                          as some (like Send) will screw with the one we suggest.
+                       */
+                       Processor::set_name (name);
+               }
 
-       // may not exist for legacy 3.0 sessions
-       if ((prop = node.property ("id")) != 0) {
-               _id = prop->value();
+               set_id (node);
        }
 
        XMLNodeList nlist = node.children();
@@ -197,12 +214,13 @@ Processor::set_state (const XMLNode& node, int version)
 
        Stateful::save_extra_xml (node);
 
+       XMLProperty const * prop = 0;
+       XMLProperty const * legacy_active = 0;
+
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
                if ((*niter)->name() == X_("Automation")) {
 
-                       XMLProperty *prop;
-
                        if ((prop = (*niter)->property ("path")) != 0) {
                                old_set_automation_state (*(*niter));
                        } else {
@@ -225,7 +243,7 @@ Processor::set_state (const XMLNode& node, int version)
                }
        }
 
-       bool const a = string_is_affirmative (prop->value ());
+       bool const a = string_to<bool> (prop->value ()) && !_session.get_bypass_all_loaded_plugins();
        if (_active != a) {
                if (a) {
                        activate ();
@@ -234,9 +252,7 @@ Processor::set_state (const XMLNode& node, int version)
                }
        }
 
-       if ((prop = node.property ("user-latency")) != 0) {
-               _user_latency = atoi (prop->value ());
-       }
+       node.get_property ("user-latency", _user_latency);
 
        return 0;
 }
@@ -259,6 +275,34 @@ Processor::configure_io (ChanCount in, ChanCount out)
        return true;
 }
 
+bool
+Processor::map_loop_range (samplepos_t& start, samplepos_t& end) const
+{
+       if (!_loop_location) {
+               return false;
+       }
+       if (start >= end) {
+               /* no backwards looping */
+               return false;
+       }
+
+       const samplepos_t loop_end = _loop_location->end ();
+       if (start < loop_end) {
+               return false;
+       }
+
+       const samplepos_t loop_start   = _loop_location->start ();
+       const samplecnt_t looplen      = loop_end - loop_start;
+       const sampleoffset_t start_off = (start - loop_start) % looplen;
+       const samplepos_t start_pos    = loop_start + start_off;
+
+       assert (start >= start_pos);
+       end -= start - start_pos;
+       start = start_pos;
+       assert (end > start);
+       return true;
+}
+
 void
 Processor::set_display_to_user (bool yn)
 {
@@ -272,7 +316,13 @@ Processor::set_pre_fader (bool p)
 }
 
 void
-Processor::set_ui (void* p)
+Processor::set_owner (SessionObject* o)
+{
+       _owner = o;
+}
+
+SessionObject*
+Processor::owner() const
 {
-       _ui_pointer = p;
+       return _owner;
 }