/*
- 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
#include <string>
#include <exception>
-#include <pbd/statefuldestructible.h>
+#include "pbd/statefuldestructible.h"
-#include <sigc++/signal.h>
-
-#include <ardour/types.h>
-#include <ardour/ardour.h>
-#include <ardour/buffer_set.h>
-#include <ardour/automatable.h>
-#include <ardour/latent.h>
+#include "ardour/ardour.h"
+#include "ardour/buffer_set.h"
+#include "ardour/latent.h"
+#include "ardour/session_object.h"
+#include "ardour/types.h"
+#include "ardour/automatable.h"
class XMLNode;
namespace ARDOUR {
class Session;
+class Route;
/* A mixer strip element - plugin, send, meter, etc.
*/
-class Processor : public SessionObject, public AutomatableControls, public Latent
+class Processor : public SessionObject, public Automatable, public Latent
{
public:
- static const string state_node_name;
+ static const std::string state_node_name;
+
+ Processor(Session&, const std::string& name);
- Processor(Session&, const string& name, Placement p); // TODO: remove placement in favour of sort key
-
virtual ~Processor() { }
-
- static boost::shared_ptr<Processor> clone (boost::shared_ptr<const Processor>);
- uint32_t sort_key() const { return _sort_key; }
- void set_sort_key (uint32_t key);
+ 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; }
- Placement placement() const { return _placement; }
- void set_placement (Placement);
-
- bool active () const { return _active; }
- void set_active (bool yn);
-
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, nframes_t offset) { 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, nframes_t offset) { assert(is_out_of_place()); }
-
- virtual void silence (nframes_t nframes, nframes_t offset) {}
-
- virtual void activate () { _active = true; ActiveChanged.emit(); }
- virtual void deactivate () { _active = false; ActiveChanged.emit(); }
-
- virtual bool configure_io (ChanCount in, ChanCount out);
+ virtual framecnt_t signal_latency() const { return 0; }
- /* Derived classes should override these, or processor appears as an in-place pass-through */
+ virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
+ virtual bool requires_fixed_sized_buffers() const { return false; }
+
+ /** @param result_required true if, on return from this method, bufs is required to contain valid data;
+ * if false, the method need not bother writing to 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*/) {}
- /** In-place processors implement run_in_place and modify thee input buffer parameter */
- virtual bool is_in_place () const { return true; }
+ virtual void activate () { _pending_active = true; ActiveChanged(); }
+ virtual void deactivate () { _pending_active = false; ActiveChanged(); }
+ virtual void flush() {}
- /* 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 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) const = 0;
- virtual ChanCount output_streams() const { return _configured_input; }
virtual ChanCount input_streams () const { return _configured_input; }
+ virtual ChanCount output_streams() const { return _configured_output; }
+
+ /* 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&);
+ XMLNode& get_state (void);
+ int set_state (const XMLNode&, int version);
- void *get_gui () const { return _gui; }
- void set_gui (void *p) { _gui = p; }
-
- static sigc::signal<void,Processor*> ProcessorCreated;
+ void set_pre_fader (bool);
- sigc::signal<void> ActiveChanged;
- sigc::signal<void> PlacementChanged;
+ PBD::Signal0<void> ActiveChanged;
+ PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
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;
- Placement _placement;
- uint32_t _sort_key;
- void* _gui; /* generic, we don't know or care what this is */
+ ChanCount _configured_output;
+ bool _display_to_user;
+ bool _pre_fader;
};
} // namespace ARDOUR
projects / ardour.git / blobdiff