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
  54         virtual ~Processor() { }
  55
  56         /** Configuration of a processor on a bus
  57          * (i.e. how to apply to a BufferSet)
  58          */
  59         struct Mapping {
  60             ChanCount in;
  61             ChanCount out;
  62         };
  63
  64         virtual bool visible() const { return true; }
  65
  66         uint32_t sort_key() const { return _sort_key; }
  67         void set_sort_key (uint32_t key);
  68
  69         bool active () const { return _active; }
  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 (nframes_t frame) {}
  77
  78         virtual void set_block_size (nframes_t nframes) {}
  79
  80         virtual void run_in_place (BufferSet& bufs,
  81                                    sframes_t start_frame, sframes_t end_frame,
  82                                    nframes_t nframes) { assert(is_in_place()); }
  83
  84         virtual void run_out_of_place (BufferSet& input, BufferSet& output,
  85                                        sframes_t start_frame, sframes_t end_frame,
  86                                        nframes_t nframes) { assert(is_out_of_place()); }
  87
  88         virtual void silence (nframes_t nframes) {}
  89
  90         void activate ()   { _active = true; ActiveChanged(); }
  91         void deactivate () { _active = false; ActiveChanged(); }
  92
  93         virtual bool configure_io (ChanCount in, ChanCount out);
  94
  95         /* Derived classes should override these, or processor appears as an in-place pass-through */
  96
  97         /** In-place processors implement run_in_place and modify thee input buffer parameter */
  98         virtual bool is_in_place () const { return true; }
  99
 100         /* Out-Of-Place processors implement run_out_of_place, don't modify the input parameter
 101          * and write to their output parameter */
 102         virtual bool is_out_of_place () const { return false; }
 103
 104         virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0;
 105         virtual ChanCount input_streams () const { return _configured_input; }
 106         virtual ChanCount output_streams() const { return _configured_output; }
 107
 108         /* note: derived classes should implement state(), NOT get_state(), to allow
 109            us to merge C++ inheritance and XML lack-of-inheritance reasonably
 110            smoothly.
 111          */
 112
 113         virtual XMLNode& state (bool full);
 114         XMLNode& get_state (void);
 115         int set_state (const XMLNode&);
 116
 117         void *get_gui () const { return _gui; }
 118         void  set_gui (void *p) { _gui = p; }
 119
 120         static sigc::signal<void,Processor*> ProcessorCreated;
 121
 122         sigc::signal<void>                     ActiveChanged;
 123         sigc::signal<void,ChanCount,ChanCount> ConfigurationChanged;
 124
 125 protected:
 126         int       _pending_active;
 127         bool      _active;
 128         bool      _next_ab_is_active;
 129         bool      _configured;
 130         ChanCount _configured_input;
 131         ChanCount _configured_output;
 132         uint32_t  _sort_key;
 133         void*     _gui;  /* generic, we don't know or care what this is */
 134         Mapping   _mapping;
 135 };
 136
 137 } // namespace ARDOUR
 138
 139 #endif /* __ardour_processor_h__ */