← Back to branch summary

~ubuntu-branches/ubuntu/utopic/ardour3/utopic

« back to all changes in this revision

Viewing changes to libs/ardour/ardour/plugin_insert.h

  • Committer: Package Import Robot
  • Author(s): Felipe Sateler
  • Date: 2013-09-21 19:05:02 UTC
  • Revision ID: package-import@ubuntu.com-20130921190502-8gsftrku6jnzhd7v
Tags: upstream-3.4~dfsg
Import upstream version 3.4~dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
libs/ardour/ardour/plugin_insert.h
 
1
/*
 
2
    Copyright (C) 2000,2007 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_plugin_insert_h__
 
21
#define __ardour_plugin_insert_h__
 
22
 
 
23
#include <vector>
 
24
#include <string>
 
25
 
 
26
#include <boost/weak_ptr.hpp>
 
27
 
 
28
#include "ardour/ardour.h"
 
29
#include "ardour/types.h"
 
30
#include "ardour/processor.h"
 
31
#include "ardour/automation_control.h"
 
32
 
 
33
class XMLNode;
 
34
 
 
35
namespace ARDOUR {
 
36
 
 
37
class Session;
 
38
class Route;
 
39
class Plugin;
 
40
 
 
41
/** Plugin inserts: send data through a plugin
 
42
 */
 
43
class PluginInsert : public Processor
 
44
{
 
45
  public:
 
46
        PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
 
47
        ~PluginInsert ();
 
48
 
 
49
        static const std::string port_automation_node_name;
 
50
 
 
51
        XMLNode& state(bool);
 
52
        XMLNode& get_state(void);
 
53
        int set_state(const XMLNode&, int version);
 
54
 
 
55
        void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
 
56
        void silence (framecnt_t nframes);
 
57
 
 
58
        void activate ();
 
59
        void deactivate ();
 
60
        void flush ();
 
61
 
 
62
        int set_block_size (pframes_t nframes);
 
63
 
 
64
        ChanCount output_streams() const;
 
65
        ChanCount input_streams() const;
 
66
        ChanCount natural_output_streams() const;
 
67
        ChanCount natural_input_streams() const;
 
68
 
 
69
        bool     set_count (uint32_t num);
 
70
        uint32_t get_count () const { return _plugins.size(); }
 
71
 
 
72
        bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
 
73
        bool configure_io (ChanCount in, ChanCount out);
 
74
 
 
75
        bool has_no_inputs() const;
 
76
        bool has_no_audio_inputs() const;
 
77
        bool is_midi_instrument() const;
 
78
 
 
79
        void realtime_handle_transport_stopped ();
 
80
        void realtime_locate ();
 
81
        void monitoring_changed ();
 
82
 
 
83
        struct PluginControl : public AutomationControl
 
84
        {
 
85
                PluginControl (PluginInsert* p, const Evoral::Parameter &param,
 
86
                                boost::shared_ptr<AutomationList> list = boost::shared_ptr<AutomationList>());
 
87
 
 
88
                void set_value (double val);
 
89
                double get_value (void) const;
 
90
                XMLNode& get_state();
 
91
 
 
92
                double internal_to_interface (double) const;
 
93
                double interface_to_internal (double) const;
 
94
 
 
95
        private:
 
96
                PluginInsert* _plugin;
 
97
                bool _logarithmic;
 
98
                bool _sr_dependent;
 
99
                bool _toggled;
 
100
        };
 
101
 
 
102
        boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 
103
                if (num < _plugins.size()) {
 
104
                        return _plugins[num];
 
105
                } else {
 
106
                        return _plugins[0]; // we always have one
 
107
                }
 
108
        }
 
109
 
 
110
        PluginType type ();
 
111
 
 
112
        std::string describe_parameter (Evoral::Parameter param);
 
113
 
 
114
        framecnt_t signal_latency () const;
 
115
 
 
116
        boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 
117
 
 
118
        void collect_signal_for_analysis (framecnt_t nframes);
 
119
 
 
120
        bool splitting () const {
 
121
                return _match.method == Split;
 
122
        }
 
123
 
 
124
        PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 
125
        /** Emitted when the return value of splitting () has changed */
 
126
        PBD::Signal0<void> SplittingChanged;
 
127
 
 
128
        /** Enumeration of the ways in which we can match our insert's
 
129
         *  IO to that of the plugin(s).
 
130
         */
 
131
        enum MatchingMethod {
 
132
                Impossible,  ///< we can't
 
133
                Delegate,    ///< we are delegating to the plugin, and it can handle it
 
134
                NoInputs,    ///< plugin has no inputs, so anything goes
 
135
                ExactMatch,  ///< our insert's inputs are the same as the plugin's
 
136
                Replicate,   ///< we have multiple instances of the plugin
 
137
                Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
 
138
                Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
 
139
        };
 
140
 
 
141
  private:
 
142
        /* disallow copy construction */
 
143
        PluginInsert (const PluginInsert&);
 
144
 
 
145
        void parameter_changed (uint32_t, float);
 
146
 
 
147
        void  set_parameter (Evoral::Parameter param, float val);
 
148
        float get_parameter (Evoral::Parameter param);
 
149
 
 
150
        float default_parameter_value (const Evoral::Parameter& param);
 
151
 
 
152
        typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 
153
        Plugins _plugins;
 
154
 
 
155
        boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 
156
 
 
157
        framecnt_t _signal_analysis_collected_nframes;
 
158
        framecnt_t _signal_analysis_collect_nframes_max;
 
159
 
 
160
        BufferSet _signal_analysis_inputs;
 
161
        BufferSet _signal_analysis_outputs;
 
162
 
 
163
        ChanCount midi_bypass;
 
164
 
 
165
        /** Description of how we can match our plugin's IO to our own insert IO */
 
166
        struct Match {
 
167
                Match () : method (Impossible), plugins (0) {}
 
168
                Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
 
169
                
 
170
                MatchingMethod method; ///< method to employ
 
171
                int32_t plugins;       ///< number of copies of the plugin that we need
 
172
                ChanCount hide;        ///< number of channels to hide
 
173
        };
 
174
 
 
175
        Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
 
176
 
 
177
        /** details of the match currently being used */
 
178
        Match _match;
 
179
 
 
180
        void automation_run (BufferSet& bufs, pframes_t nframes);
 
181
        void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 
182
 
 
183
        void create_automatable_parameters ();
 
184
        void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 
185
        void set_parameter_state_2X (const XMLNode& node, int version);
 
186
        void set_control_ids (const XMLNode&, int version);
 
187
 
 
188
        boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 
189
        void add_plugin (boost::shared_ptr<Plugin>);
 
190
 
 
191
        void start_touch (uint32_t param_id);
 
192
        void end_touch (uint32_t param_id);
 
193
};
 
194
 
 
195
} // namespace ARDOUR
 
196
 
 
197
#endif /* __ardour_plugin_insert_h__ */