X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fprocessor.h;h=85d466a169265434d859ba44da3aa4a7343d727e;hb=c96ec968c7bb4b1d7c358f522a49b0685c022920;hp=757af64c872c2cc40c2f9c9c99c9877e191a5473;hpb=3b89d9eaa03406a5e03648f47734211f09b89d62;p=ardour.git diff --git a/libs/ardour/ardour/processor.h b/libs/ardour/ardour/processor.h index 757af64c87..85d466a169 100644 --- a/libs/ardour/ardour/processor.h +++ b/libs/ardour/ardour/processor.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2000 Paul Davis + Copyright (C) 2009-2010 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 @@ -24,16 +24,15 @@ #include #include -#include "pbd/statefuldestructible.h" - -#include +#include "pbd/statefuldestructible.h" #include "ardour/ardour.h" -#include "ardour/automatable_controls.h" #include "ardour/buffer_set.h" #include "ardour/latent.h" #include "ardour/session_object.h" +#include "ardour/libardour_visibility.h" #include "ardour/types.h" +#include "ardour/automatable.h" class XMLNode; @@ -42,89 +41,95 @@ namespace ARDOUR { class Session; class Route; -/* A mixer strip element - plugin, send, meter, etc. - */ -class Processor : public SessionObject, public AutomatableControls, public Latent +/** A mixer strip element - plugin, send, meter, etc */ +class LIBARDOUR_API Processor : public SessionObject, public Automatable, public Latent { public: static const std::string state_node_name; Processor(Session&, const std::string& name); - + Processor (const Processor& other); + virtual ~Processor() { } - - /** Configuration of a processor on a bus - * (i.e. how to apply to a BufferSet) - */ - struct Mapping { - ChanCount in; - ChanCount out; - }; - - uint32_t sort_key() const { return _sort_key; } - void set_sort_key (uint32_t key); - - bool active () const { return _active; } - + + virtual std::string display_name() const { return SessionObject::name(); } + + virtual bool display_to_user() const { return _display_to_user; } + virtual void set_display_to_user (bool); + + bool active () const { return _pending_active; } + + virtual bool does_routing() const { return false; } + bool get_next_ab_is_active () const { return _next_ab_is_active; } void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; } - - virtual nframes_t signal_latency() const { return 0; } - - virtual void transport_stopped (nframes_t frame) {} - - virtual void set_block_size (nframes_t nframes) {} - - virtual void run_in_place (BufferSet& bufs, - nframes_t start_frame, nframes_t end_frame, - nframes_t nframes) { assert(is_in_place()); } - - virtual void run_out_of_place (BufferSet& input, BufferSet& output, - nframes_t start_frame, nframes_t end_frame, - nframes_t nframes) { assert(is_out_of_place()); } - - virtual void silence (nframes_t nframes) {} - - void activate () { _active = true; ActiveChanged(); } - void deactivate () { _active = false; ActiveChanged(); } - - virtual bool configure_io (ChanCount in, ChanCount out); - /* Derived classes should override these, or processor appears as an in-place pass-through */ + virtual framecnt_t signal_latency() const { return 0; } + + virtual int set_block_size (pframes_t /*nframes*/) { return 0; } + virtual bool requires_fixed_sized_buffers() const { return false; } - /** In-place processors implement run_in_place and modify thee input buffer parameter */ - virtual bool is_in_place () const { return true; } + /** @param result_required true if, on return from this method, @a bufs is required to contain valid data; + * if false, the method need not bother writing to @a bufs if it doesn't want to. + */ + virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t /*nframes*/, bool /*result_required*/) {} + virtual void silence (framecnt_t /*nframes*/) {} - /* Out-Of-Place processors implement run_out_of_place, don't modify the input parameter - * and write to their output parameter */ - virtual bool is_out_of_place () const { return false; } + virtual void activate () { _pending_active = true; ActiveChanged(); } + virtual void deactivate () { _pending_active = false; ActiveChanged(); } + virtual void flush() {} - virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0; + virtual bool configure_io (ChanCount in, ChanCount out); + + /* Derived classes should override these, or processor appears as an in-place pass-through */ + + virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0; virtual ChanCount input_streams () const { return _configured_input; } virtual ChanCount output_streams() const { return _configured_output; } + virtual void realtime_handle_transport_stopped () {} + virtual void realtime_locate () {} + + /* most processors won't care about this, but plugins that + receive MIDI or similar data from an input source that + may suddenly go "quiet" because of monitoring changes + need to know about it. + */ + virtual void monitoring_changed() {} + + /* note: derived classes should implement state(), NOT get_state(), to allow + us to merge C++ inheritance and XML lack-of-inheritance reasonably + smoothly. + */ + virtual XMLNode& state (bool full); - virtual XMLNode& get_state (void); - virtual int set_state (const XMLNode&); - - void *get_gui () const { return _gui; } - void set_gui (void *p) { _gui = p; } + XMLNode& get_state (void); + int set_state (const XMLNode&, int version); + + void set_pre_fader (bool); - static sigc::signal ProcessorCreated; + PBD::Signal0 ActiveChanged; + PBD::Signal2 ConfigurationChanged; - sigc::signal ActiveChanged; - sigc::signal ConfigurationChanged; + void set_ui (void*); + void* get_ui () const { return _ui_pointer; } + + void set_owner (SessionObject*); + SessionObject* owner() const; protected: + virtual int set_state_2X (const XMLNode&, int version); + int _pending_active; bool _active; bool _next_ab_is_active; bool _configured; ChanCount _configured_input; ChanCount _configured_output; - uint32_t _sort_key; - void* _gui; /* generic, we don't know or care what this is */ - Mapping _mapping; + bool _display_to_user; + bool _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false + void* _ui_pointer; + SessionObject* _owner; }; } // namespace ARDOUR