#include <unknown_processor.h>

Inheritance diagram for ARDOUR::UnknownProcessor:

Public Member Functions
	UnknownProcessor (Session &, XMLNode const &)

bool	display_to_user () const

bool	can_support_io_configuration (const ChanCount &, ChanCount &)

XMLNode &	state (bool)

Public Member Functions inherited from ARDOUR::Processor
	Processor (Session &, const std::string &name)

	Processor (const Processor &other)

virtual	~Processor ()

virtual std::string	display_name () const

virtual void	set_display_to_user (bool)

bool	active () const

virtual bool	does_routing () const

bool	get_next_ab_is_active () const

void	set_next_ab_is_active (bool yn)

virtual framecnt_t	signal_latency () const

virtual int	set_block_size (pframes_t)

virtual bool	requires_fixed_sized_buffers () const

virtual void	run (BufferSet &, framepos_t, framepos_t, pframes_t, bool)

virtual void	silence (framecnt_t)

virtual void	activate ()

virtual void	deactivate ()

virtual void	flush ()

virtual bool	configure_io (ChanCount in, ChanCount out)

virtual ChanCount	input_streams () const

virtual ChanCount	output_streams () const

virtual void	realtime_handle_transport_stopped ()

virtual void	realtime_locate ()

virtual void	monitoring_changed ()

XMLNode &	get_state (void)

int	set_state (const XMLNode &, int version)

void	set_pre_fader (bool)

void	set_ui (void *)

void *	get_ui () const

ProcessorWindowProxy *	window_proxy () const

void	set_window_proxy (ProcessorWindowProxy *wp)

void	set_owner (SessionObject *)

SessionObject *	owner () const

Public Member Functions inherited from ARDOUR::SessionObject
	SessionObject (Session &session, const std::string &name)

Session &	session () const

std::string	name () const

virtual bool	set_name (const std::string &str)

Public Member Functions inherited from ARDOUR::SessionHandleRef
	SessionHandleRef (ARDOUR::Session &s)

virtual	~SessionHandleRef ()

Public Member Functions inherited from PBD::ScopedConnectionList
	ScopedConnectionList ()

virtual	~ScopedConnectionList ()

void	add_connection (const UnscopedConnection &c)

void	drop_connections ()

Public Member Functions inherited from PBD::Stateful
	Stateful ()

virtual	~Stateful ()

virtual bool	apply_changes (PropertyBase const &)

PropertyChange	apply_changes (PropertyList const &)

const OwnedPropertyList &	properties () const

void	add_property (PropertyBase &s)

void	add_extra_xml (XMLNode &)

XMLNode *	extra_xml (const std::string &str, bool add_if_missing=false)

void	save_extra_xml (const XMLNode &)

const PBD::ID &	id () const

bool	set_id (const XMLNode &)

void	set_id (const std::string &)

void	reset_id ()

void	clear_changes ()

virtual void	clear_owned_changes ()

PropertyList *	get_changes_as_properties (Command *) const

virtual void	rdiff (std::vector< Command * > &) const

bool	changed () const

virtual PropertyList *	property_factory (const XMLNode &) const

virtual void	suspend_property_changes ()

virtual void	resume_property_changes ()

bool	property_changes_suspended () const

Public Member Functions inherited from PBD::Destructible
	Destructible ()

virtual	~Destructible ()

void	drop_references ()

Public Member Functions inherited from ARDOUR::Automatable
	Automatable (Session &)

	Automatable (const Automatable &other)

virtual	~Automatable ()

boost::shared_ptr < Evoral::Control >	control_factory (const Evoral::Parameter &id)

boost::shared_ptr < AutomationControl >	automation_control (const Evoral::Parameter &id, bool create_if_missing=false)

boost::shared_ptr< const AutomationControl >	automation_control (const Evoral::Parameter &id) const

virtual void	add_control (boost::shared_ptr< Evoral::Control >)

void	clear_controls ()

virtual void	transport_located (framepos_t now)

virtual void	transport_stopped (framepos_t now)

virtual std::string	describe_parameter (Evoral::Parameter param)

virtual std::string	value_as_string (boost::shared_ptr< AutomationControl >) const

AutoState	get_parameter_automation_state (Evoral::Parameter param)

virtual void	set_parameter_automation_state (Evoral::Parameter param, AutoState)

AutoStyle	get_parameter_automation_style (Evoral::Parameter param)

void	set_parameter_automation_style (Evoral::Parameter param, AutoStyle)

void	protect_automation ()

const std::set < Evoral::Parameter > &	what_can_be_automated () const

void	what_has_existing_automation (std::set< Evoral::Parameter > &) const

int	set_automation_xml_state (const XMLNode &, Evoral::Parameter default_param)

XMLNode &	get_automation_xml_state ()

Public Member Functions inherited from Evoral::ControlSet
	ControlSet ()

	ControlSet (const ControlSet &)

virtual	~ControlSet ()

boost::shared_ptr< Control >	control (const Parameter &id, bool create_if_missing=false)

boost::shared_ptr< const Control >	control (const Parameter &id) const

Controls &	controls ()

const Controls &	controls () const

bool	find_next_event (double start, double end, ControlEvent &ev) const

virtual bool	controls_empty () const

void	what_has_data (std::set< Parameter > &) const

Glib::Threads::Mutex &	control_lock () const

Public Member Functions inherited from ARDOUR::Latent
	Latent ()

virtual	~Latent ()

framecnt_t	user_latency () const

framecnt_t	effective_latency () const

virtual void	set_user_latency (framecnt_t val)

Private Attributes
XMLNode	_state

Additional Inherited Members
Public Types inherited from Evoral::ControlSet
typedef std::map< Parameter, boost::shared_ptr< Control > >	Controls

Static Public Member Functions inherited from ARDOUR::SessionObject
static void	make_property_quarks ()

Public Attributes inherited from ARDOUR::Processor
PBD::Signal0< void >	ActiveChanged

PBD::Signal2< void, ChanCount, ChanCount >	ConfigurationChanged

Public Attributes inherited from PBD::Stateful
PBD::Signal1< void, const PropertyChange & >	PropertyChanged

Public Attributes inherited from PBD::Destructible
PBD::Signal0< void >	Destroyed

PBD::Signal0< void >	DropReferences

Public Attributes inherited from ARDOUR::Automatable
PBD::Signal0< void >	AutomationStateChanged

Static Public Attributes inherited from ARDOUR::Processor
static const std::string	state_node_name = "Processor"

Static Public Attributes inherited from PBD::Stateful
static int	current_state_version = 0

static int	loading_state_version = 0

Static Public Attributes inherited from ARDOUR::Automatable
static const std::string	xml_node_name = X_("Automation")

Protected Member Functions inherited from ARDOUR::Processor
virtual int	set_state_2X (const XMLNode &, int version)

Protected Member Functions inherited from ARDOUR::SessionHandleRef
virtual void	session_going_away ()

virtual void	insanity_check ()

Protected Member Functions inherited from PBD::Stateful
void	add_instant_xml (XMLNode &, const std::string &directory_path)

XMLNode *	instant_xml (const std::string &str, const std::string &directory_path)

void	add_properties (XMLNode &)

PropertyChange	set_values (XMLNode const &)

virtual void	post_set (const PropertyChange &)

virtual void	send_change (const PropertyChange &)

virtual void	mid_thaw (const PropertyChange &)

Protected Member Functions inherited from ARDOUR::Automatable
void	can_automate (Evoral::Parameter)

virtual void	automation_list_automation_state_changed (Evoral::Parameter, AutoState)

int	load_automation (const std::string &path)

int	old_set_automation_state (const XMLNode &)

Protected Member Functions inherited from Evoral::ControlSet
virtual void	control_list_marked_dirty ()

virtual void	control_list_interpolation_changed (Parameter, ControlList::InterpolationStyle)

Protected Attributes inherited from ARDOUR::Processor
int	_pending_active

bool	_active

bool	_next_ab_is_active

bool	_configured

ChanCount	_configured_input

ChanCount	_configured_output

bool	_display_to_user

bool	_pre_fader
	true if this processor is currently placed before the Amp, otherwise false More...

void *	_ui_pointer

ProcessorWindowProxy *	_window_proxy

SessionObject *	_owner

Protected Attributes inherited from ARDOUR::SessionObject
PBD::Property< std::string >	_name

Protected Attributes inherited from ARDOUR::SessionHandleRef
ARDOUR::Session &	_session

Protected Attributes inherited from PBD::Stateful
XMLNode *	_extra_xml

XMLNode *	_instant_xml

PBD::PropertyChange	_pending_changed

Glib::Threads::Mutex	_lock

std::string	_xml_node_name
	name of node to use for this object in XML More...

OwnedPropertyList *	_properties

Protected Attributes inherited from ARDOUR::Automatable
Session &	_a_session

std::set< Evoral::Parameter >	_can_automate_list

framepos_t	_last_automation_snapshot

Protected Attributes inherited from Evoral::ControlSet
Glib::Threads::Mutex	_control_lock

Controls	_controls

PBD::ScopedConnectionList	_list_connections

Protected Attributes inherited from ARDOUR::Latent
framecnt_t	_user_latency

Detailed Description

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.

Definition at line 42 of file unknown_processor.h.

Constructor & Destructor Documentation

UnknownProcessor::UnknownProcessor	(	Session &	s,
		XMLNode const &	state
	)

Definition at line 27 of file unknown_processor.cc.

Member Function Documentation

bool ARDOUR::UnknownProcessor::can_support_io_configuration	(	const ChanCount &	,
		ChanCount &
	)

inlinevirtual

Implements ARDOUR::Processor.

Definition at line 52 of file unknown_processor.h.

bool ARDOUR::UnknownProcessor::display_to_user ( ) const

inlinevirtual

Reimplemented from ARDOUR::Processor.

Definition at line 48 of file unknown_processor.h.

XMLNode & UnknownProcessor::state ( bool )

virtual

Reimplemented from ARDOUR::Processor.

Definition at line 38 of file unknown_processor.cc.

Member Data Documentation

XMLNode ARDOUR::UnknownProcessor::_state

private

Definition at line 59 of file unknown_processor.h.

The documentation for this class was generated from the following files:

/usr/local/music/src/ardour/4.0/libs/ardour/ardour/unknown_processor.h
/usr/local/music/src/ardour/4.0/libs/ardour/unknown_processor.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation