processor.cc

Go to the documentation of this file.

/*
    Copyright (C) 2000 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    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,
    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.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifdef WAF_BUILD
#include "libardour-config.h"
#endif

#include <string>

#include "pbd/xml++.h"

#include "ardour/automatable.h"
#include "ardour/chan_count.h"
#include "ardour/processor.h"
#include "ardour/types.h"

#ifdef WINDOWS_VST_SUPPORT
#include "ardour/windows_vst_plugin.h"
#endif

#ifdef AUDIOUNIT_SUPPORT
#include "ardour/audio_unit.h"
#endif

#include "ardour/audioengine.h"
#include "ardour/session.h"
#include "ardour/types.h"

#include "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";

Processor::Processor(Session& session, const string& name)
        : SessionObject(session, name)
        , Automatable (session)
        , _pending_active(false)
        , _active(false)
        , _next_ab_is_active(false)
        , _configured(false)
        , _display_to_user (true)
        , _pre_fader (false)
        , _ui_pointer (0)
        , _window_proxy (0)
        , _owner (0)
{
}

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)
        , _configured(false)
        , _display_to_user (true)
        , _pre_fader (false)
        , _ui_pointer (0)
        , _window_proxy (0)
        , _owner (0)
{
}

XMLNode&
Processor::get_state (void)
{
        return state (true);
}

/* NODE STRUCTURE

    <Automation [optionally with visible="...." ]>
       <parameter-N>
         <AutomationList id=N>
           <events>
           X1 Y1
           X2 Y2
           ....
           </events>
       </parameter-N>
    <Automation>
*/

XMLNode&
Processor::state (bool full_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");

        if (_extra_xml){
                node->add_child_copy (*_extra_xml);
        }

        if (full_state) {
                XMLNode& automation = Automatable::get_automation_xml_state();
                if (!automation.children().empty() || !automation.properties().empty()) {
                        node->add_child_nocopy (automation);
                }
        }

        snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
        node->add_property("user-latency", buf);

        return *node;
}

int
Processor::set_state_2X (const XMLNode & node, int /*version*/)
{
        XMLProperty const * prop;

        XMLNodeList children = node.children ();
        
        for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {

                if ((*i)->name() == X_("IO")) {
                        
                        if ((prop = (*i)->property ("name")) != 0) {
                                set_name (prop->value ());
                        }
                        
                        set_id (**i);

                        //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) {
                                                activate ();
                                        } else {
                                                deactivate ();
                                        }
                                }
                        }*/
                        
                }
        }

        return 0;
}

int
Processor::set_state (const XMLNode& node, int version)
{
        if (version < 3000) {
                return set_state_2X (node, version);
        }

        const XMLProperty *prop;
        const XMLProperty *legacy_active = 0;
        bool leave_name_alone = (node.property ("ignore-name") != 0);

        if (!leave_name_alone) {
                // 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());
                }
                
                set_id (node);
        }

        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;

        Stateful::save_extra_xml (node);

        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 {
                                set_automation_xml_state (*(*niter), Evoral::Parameter(PluginAutomation));
                        }

                } else if ((*niter)->name() == "Redirect") {
                        if ( !(legacy_active = (*niter)->property("active"))) {
                                error << string_compose(_("No %1 property flag in element %2"), "active", (*niter)->name()) << endl;
                        }
                }
        }

        if ((prop = node.property ("active")) == 0) {
                if (legacy_active) {
                        prop = legacy_active;
                } else {
                        error << _("No child node with active property") << endmsg;
                        return -1;
                }
        }

        bool const a = string_is_affirmative (prop->value ()) && !_session.get_disable_all_loaded_plugins();
        if (_active != a) {
                if (a) {
                        activate ();
                } else {
                        deactivate ();
                }
        }

        if ((prop = node.property ("user-latency")) != 0) {
                _user_latency = atoi (prop->value ());
        }

        return 0;
}

bool
Processor::configure_io (ChanCount in, ChanCount out)
{
        /* This class assumes 1:1 input:output.static output stream count.
           Derived classes must override and set _configured_output appropriately
           if this is not the case
        */

        _configured_input = in;
        _configured_output = out;
        _configured = true;

        ConfigurationChanged (in, out); /* EMIT SIGNAL */

        return true;
}

void
Processor::set_display_to_user (bool yn)
{
        _display_to_user = yn;
}

void
Processor::set_pre_fader (bool p)
{
        _pre_fader = p;
}

void
Processor::set_ui (void* p)
{
        _ui_pointer = p;
}

void
Processor::set_window_proxy (ProcessorWindowProxy* wp)
{
        _window_proxy = wp;
}

void
Processor::set_owner (SessionObject* o)
{
        _owner = o;
}

SessionObject*
Processor::owner() const
{
        return _owner;
}