2 Copyright (C) 2006 Paul Davis
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.
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.
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.
19 #ifndef __ardour_track_h__
20 #define __ardour_track_h__
22 #include <boost/shared_ptr.hpp>
24 #include "ardour/interthread_info.h"
25 #include "ardour/route.h"
26 #include "ardour/public_diskstream.h"
38 class LIBARDOUR_API Track : public Route, public PublicDiskstream
41 Track (Session&, std::string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
46 bool set_name (const std::string& str);
47 void resync_track_name ();
49 TrackMode mode () const { return _mode; }
50 virtual int set_mode (TrackMode /*m*/) { return false; }
51 virtual bool can_use_mode (TrackMode /*m*/, bool& /*bounce_required*/) { return false; }
52 PBD::Signal0<void> TrackModeChanged;
54 class LIBARDOUR_API MonitoringControllable : public RouteAutomationControl {
56 MonitoringControllable (std::string name, boost::shared_ptr<Track>);
57 void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
58 /* currently no automation, so no need for set_value_unchecked() */
59 double get_value () const;
61 void _set_value (double, PBD::Controllable::GroupControlDisposition group_override);
64 void set_monitoring (MonitorChoice, PBD::Controllable::GroupControlDisposition group_override);
65 MonitorChoice monitoring_choice() const { return _monitoring; }
66 MonitorState monitoring_state () const;
67 PBD::Signal0<void> MonitoringChanged;
69 boost::shared_ptr<AutomationControl> monitoring_control() const { return _monitoring_control; }
71 MeterState metering_state () const;
73 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
76 int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
79 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
80 int declick, bool& need_butler) = 0;
82 bool needs_butler() const { return _needs_butler; }
84 virtual DataType data_type () const = 0;
88 void use_new_diskstream ();
89 virtual boost::shared_ptr<Diskstream> create_diskstream() = 0;
90 virtual void set_diskstream (boost::shared_ptr<Diskstream>);
92 void set_latency_compensation (framecnt_t);
100 FreezeState freeze_state() const;
102 virtual void freeze_me (InterThreadInfo&) = 0;
103 virtual void unfreeze () = 0;
105 /** @return true if the track can be bounced, or false otherwise.
107 virtual bool bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const = 0;
108 virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
109 virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo&,
110 boost::shared_ptr<Processor> endpoint, bool include_endpoint) = 0;
111 virtual int export_stuff (BufferSet& bufs, framepos_t start_frame, framecnt_t nframes,
112 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) = 0;
114 XMLNode& get_state();
115 XMLNode& get_template();
116 virtual int set_state (const XMLNode&, int version);
117 static void zero_diskstream_id_in_xml (XMLNode&);
119 boost::shared_ptr<AutomationControl> rec_enable_control() { return _rec_enable_control; }
121 bool record_enabled() const;
122 bool record_safe () const;
123 void set_record_enabled (bool yn, PBD::Controllable::GroupControlDisposition);
124 void set_record_safe (bool yn, PBD::Controllable::GroupControlDisposition);
125 void prep_record_enabled (bool yn, PBD::Controllable::GroupControlDisposition);
127 bool using_diskstream_id (PBD::ID) const;
129 void set_block_size (pframes_t);
131 /* PublicDiskstream interface */
132 boost::shared_ptr<Playlist> playlist ();
133 void request_input_monitoring (bool);
134 void ensure_input_monitoring (bool);
135 bool destructive () const;
136 std::list<boost::shared_ptr<Source> > & last_capture_sources ();
137 void set_capture_offset ();
138 std::string steal_write_source_name ();
139 void reset_write_sources (bool, bool force = false);
140 float playback_buffer_load () const;
141 float capture_buffer_load () const;
143 int do_flush (RunContext, bool force = false);
144 void set_pending_overwrite (bool);
145 int seek (framepos_t, bool complete_refill = false);
146 bool hidden () const;
147 int can_internal_playback_seek (framecnt_t);
148 int internal_playback_seek (framecnt_t);
149 void non_realtime_input_change ();
150 void non_realtime_locate (framepos_t);
151 void non_realtime_set_speed ();
152 int overwrite_existing_buffers ();
153 framecnt_t get_captured_frames (uint32_t n = 0) const;
154 int set_loop (Location *);
155 void transport_looped (framepos_t);
156 bool realtime_set_speed (double, bool);
157 void transport_stopped_wallclock (struct tm &, time_t, bool);
158 bool pending_overwrite () const;
159 double speed () const;
160 void prepare_to_stop (framepos_t, framepos_t);
161 void set_slaved (bool);
162 ChanCount n_channels ();
163 framepos_t get_capture_start_frame (uint32_t n = 0) const;
164 AlignStyle alignment_style () const;
165 AlignChoice alignment_choice () const;
166 framepos_t current_capture_start () const;
167 framepos_t current_capture_end () const;
168 void playlist_modified ();
169 int use_playlist (boost::shared_ptr<Playlist>);
170 void set_align_style (AlignStyle, bool force=false);
171 void set_align_choice (AlignChoice, bool force=false);
172 int use_copy_playlist ();
173 int use_new_playlist ();
174 void adjust_playback_buffering ();
175 void adjust_capture_buffering ();
177 PBD::Signal0<void> DiskstreamChanged;
178 PBD::Signal0<void> FreezeChange;
179 /* Emitted when our diskstream is set to use a different playlist */
180 PBD::Signal0<void> PlaylistChanged;
181 PBD::Signal0<void> RecordEnableChanged;
182 PBD::Signal0<void> RecordSafeChanged;
183 PBD::Signal0<void> SpeedChanged;
184 PBD::Signal0<void> AlignmentStyleChanged;
187 XMLNode& state (bool full);
189 boost::shared_ptr<Diskstream> _diskstream;
190 MeterPoint _saved_meter_point;
193 MonitorChoice _monitoring;
194 boost::shared_ptr<MonitoringControllable> _monitoring_control;
197 struct FreezeRecordProcessorInfo {
198 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
199 : state (st), processor (proc) {}
202 boost::shared_ptr<Processor> processor;
206 struct FreezeRecord {
208 : have_mementos(false)
213 boost::shared_ptr<Playlist> playlist;
214 std::vector<FreezeRecordProcessorInfo*> processor_info;
219 class RecEnableControl : public AutomationControl {
221 RecEnableControl (boost::shared_ptr<Track> t);
223 void set_value (double, PBD::Controllable::GroupControlDisposition);
224 void set_value_unchecked (double);
225 double get_value (void) const;
227 boost::weak_ptr<Track> track;
230 void _set_value (double, PBD::Controllable::GroupControlDisposition);
233 virtual void set_state_part_two () = 0;
235 FreezeRecord _freeze_record;
236 XMLNode* pending_state;
239 void maybe_declick (BufferSet&, framecnt_t, int);
241 boost::shared_ptr<RecEnableControl> _rec_enable_control;
243 framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&);
247 virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &) = 0;
249 void diskstream_playlist_changed ();
250 void diskstream_record_enable_changed ();
251 void diskstream_record_safe_changed ();
252 void diskstream_speed_changed ();
253 void diskstream_alignment_style_changed ();
254 void parameter_changed (std::string const & p);
256 std::string _diskstream_name;
259 }; /* namespace ARDOUR*/
261 #endif /* __ardour_track_h__ */