2 Copyright (C) 2008 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #ifndef __ardour_export_channel_h__
22 #define __ardour_export_channel_h__
26 #include <boost/signals2.hpp>
27 #include <boost/shared_ptr.hpp>
28 #include <boost/scoped_array.hpp>
30 #include "pbd/signals.h"
32 #include "ardour/buffer_set.h"
33 #include "ardour/export_pointers.h"
41 class CapturingProcessor;
43 /// Export channel base class interface for different source types
44 class ExportChannel : public boost::less_than_comparable<ExportChannel>
48 virtual ~ExportChannel () {}
50 virtual void set_max_buffer_size(framecnt_t) { }
52 virtual void read (Sample const *& data, framecnt_t frames) const = 0;
53 virtual bool empty () const = 0;
55 /// Adds state to node passed
56 virtual void get_state (XMLNode * node) const = 0;
58 /// Sets state from node passed
59 virtual void set_state (XMLNode * node, Session & session) = 0;
61 // Operator< must be defined for usage in e.g. std::map or std::set to disallow duplicates when necessary
62 virtual bool operator< (ExportChannel const & other) const = 0;
65 /// Basic export channel that reads from AudioPorts
66 class PortExportChannel : public ExportChannel
69 typedef std::set<AudioPort *> PortSet;
72 void set_max_buffer_size(framecnt_t frames);
74 void read (Sample const *& data, framecnt_t frames) const;
75 bool empty () const { return ports.empty(); }
77 void get_state (XMLNode * node) const;
78 void set_state (XMLNode * node, Session & session);
80 bool operator< (ExportChannel const & other) const;
82 void add_port (AudioPort * port) { ports.insert (port); }
83 PortSet const & get_ports () { return ports; }
87 boost::scoped_array<Sample> buffer;
88 framecnt_t buffer_size;
92 /// Handles RegionExportChannels and does actual reading from region
93 class RegionExportChannelFactory
102 RegionExportChannelFactory (Session * session, AudioRegion const & region, AudioTrack & track, Type type);
103 ~RegionExportChannelFactory ();
105 ExportChannelPtr create (uint32_t channel);
106 void read (uint32_t channel, Sample const *& data, framecnt_t frames_to_read);
110 int new_cycle_started (framecnt_t) { buffers_up_to_date = false; return 0; }
111 void update_buffers (framecnt_t frames);
113 AudioRegion const & region;
117 framecnt_t frames_per_cycle;
120 bool buffers_up_to_date;
121 framecnt_t region_start;
124 boost::scoped_array<Sample> mixdown_buffer;
125 boost::scoped_array<Sample> gain_buffer;
127 PBD::ScopedConnection export_connection;
130 /// Export channel that reads from region channel
131 class RegionExportChannel : public ExportChannel
133 friend class RegionExportChannelFactory;
136 void read (Sample const *& data, framecnt_t frames_to_read) const { factory.read (channel, data, frames_to_read); }
137 void get_state (XMLNode * /*node*/) const {};
138 void set_state (XMLNode * /*node*/, Session & /*session*/) {};
139 bool empty () const { return false; }
140 // Region export should never have duplicate channels, so there need not be any semantics here
141 bool operator< (ExportChannel const & other) const { return this < &other; }
145 RegionExportChannel (RegionExportChannelFactory & factory, uint32_t channel)
150 RegionExportChannelFactory & factory;
154 /// Export channel for exporting from different positions in a route
155 class RouteExportChannel : public ExportChannel
157 class ProcessorRemover; // fwd declaration
160 RouteExportChannel(boost::shared_ptr<CapturingProcessor> processor, size_t channel,
161 boost::shared_ptr<ProcessorRemover> remover);
162 ~RouteExportChannel();
164 static void create_from_route(std::list<ExportChannelPtr> & result, Route & route);
166 public: // ExportChannel interface
167 void set_max_buffer_size(framecnt_t frames);
169 void read (Sample const *& data, framecnt_t frames) const;
170 bool empty () const { return false; }
172 void get_state (XMLNode * node) const;
173 void set_state (XMLNode * node, Session & session);
175 bool operator< (ExportChannel const & other) const;
179 // Removes the processor from the track when deleted
180 class ProcessorRemover {
182 ProcessorRemover (Route & route, boost::shared_ptr<CapturingProcessor> processor)
183 : route (route), processor (processor) {}
187 boost::shared_ptr<CapturingProcessor> processor;
190 boost::shared_ptr<CapturingProcessor> processor;
192 // Each channel keeps a ref to the remover. Last one alive
193 // will cause the processor to be removed on deletion.
194 boost::shared_ptr<ProcessorRemover> remover;
197 } // namespace ARDOUR