ardour/libs/ardour/ardour/unknown_processor.h

71 lines
2.4 KiB
C++

/*
* Copyright (C) 2010 Carl Hetherington <carl@carlh.net>
* Copyright (C) 2013-2017 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2013-2022 Robin Gareus <robin@gareus.org>
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __ardour_unknown_processor_h__
#define __ardour_unknown_processor_h__
#include "ardour/libardour_visibility.h"
#include "ardour/processor.h"
namespace ARDOUR {
class SideChain;
/** A stub Processor that can be used in place of a `real' one that cannot be
* created for some reason; usually because it requires a plugin which is not
* present. UnknownProcessors are special-cased in a few places, notably
* in route configuration and signal processing, so that on encountering them
* configuration or processing stops.
*
* When a Processor is missing from a Route, the following processors cannot
* be configured, as the missing Processor's output port configuration is
* unknown.
*
* The main utility of the UnknownProcessor is that it allows state
* to be preserved, so that, for example, loading and re-saving a
* session on a machine without a particular plugin will not corrupt
* the session.
*/
class LIBARDOUR_API UnknownProcessor : public Processor
{
public:
UnknownProcessor (Session&, XMLNode const&, SessionObject*);
virtual ~UnknownProcessor ();
bool can_support_io_configuration (const ChanCount &, ChanCount &);
void run (BufferSet& /*bufs*/, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double /*speed*/, pframes_t /*nframes*/, bool /*result_required*/);
protected:
XMLNode& state () const;
private:
XMLNode _state;
bool have_ioconfig;
ChanCount* saved_input;
ChanCount* saved_output;
void add_sidechain_from_xml (const XMLNode& node, int version);
std::shared_ptr<SideChain> _sidechain;
};
}
#endif