libs/ardour/ardour/processor.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_processor_h__
  21 #define __ardour_processor_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <exception>
  26
  27 #include "pbd/statefuldestructible.h"
  28
  29 #include <sigc++/signal.h>
  30
  31 #include "ardour/ardour.h"
  32 #include "ardour/automatable_controls.h"
  33 #include "ardour/buffer_set.h"
  34 #include "ardour/latent.h"
  35 #include "ardour/session_object.h"
  36 #include "ardour/types.h"
  37
  38 class XMLNode;
  39
  40 namespace ARDOUR {
  41
  42 class Session;
  43 class Route;
  44
  45 /* A mixer strip element - plugin, send, meter, etc.
  46  */
  47 class Processor : public SessionObject, public AutomatableControls, public Latent
  48 {
  49   public:
  50         static const std::string state_node_name;
  51
  52         Processor(Session&, const std::string& name);
  53         Processor(Session&, const XMLNode& node);
  54
  55         virtual ~Processor() { }
  56
  57         virtual bool visible() const { return true; }
  58
  59         bool active () const { return _active; }
  60
  61         /* we keep loose tabs on the "placement" of a Processor. Ultimately,
  62            they are all executed as a single list, but there are some
  63            semantics that require knowing whether a Processor is before
  64            or after the fader, or panner etc. See Route::reorder_processors()
  65            to see where this gets set.
  66         */
  67
  68         Placement placement() const { return _placement; }
  69         void set_placement (Placement p) { _placement = p; }
  70
  71         bool get_next_ab_is_active () const { return _next_ab_is_active; }
  72         void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; }
  73
  74         virtual nframes_t signal_latency() const { return 0; }
  75
  76         virtual void transport_stopped (sframes_t frame) {}
  77
  78         virtual void set_block_size (nframes_t nframes) {}
  79
  80         virtual void run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes) {}
  81         virtual void silence (nframes_t nframes) {}
  82
  83         void activate ()   { _active = true; ActiveChanged(); }
  84         void deactivate () { _active = false; ActiveChanged(); }
  85
  86         virtual bool configure_io (ChanCount in, ChanCount out);
  87
  88         /* Derived classes should override these, or processor appears as an in-place pass-through */
  89
  90         virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0;
  91         virtual ChanCount input_streams () const { return _configured_input; }
  92         virtual ChanCount output_streams() const { return _configured_output; }
  93
  94         /* note: derived classes should implement state(), NOT get_state(), to allow
  95            us to merge C++ inheritance and XML lack-of-inheritance reasonably
  96            smoothly.
  97          */
  98
  99         virtual XMLNode& state (bool full);
 100         XMLNode& get_state (void);
 101         int set_state (const XMLNode&);
 102
 103         void *get_gui () const { return _gui; }
 104         void  set_gui (void *p) { _gui = p; }
 105
 106         static sigc::signal<void,Processor*> ProcessorCreated;
 107
 108         sigc::signal<void>                     ActiveChanged;
 109         sigc::signal<void,ChanCount,ChanCount> ConfigurationChanged;
 110
 111 protected:
 112         int       _pending_active;
 113         bool      _active;
 114         bool      _next_ab_is_active;
 115         bool      _configured;
 116         ChanCount _configured_input;
 117         ChanCount _configured_output;
 118         void*     _gui;  /* generic, we don't know or care what this is */
 119         Placement _placement;
 120 };
 121
 122 } // namespace ARDOUR
 123
 124 #endif /* __ardour_processor_h__ */