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/route.h"
25 #include "ardour/public_diskstream.h"
36 class Track : public Route, public PublicDiskstream
39 Track (Session&, std::string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
44 bool set_name (const std::string& str);
46 TrackMode mode () const { return _mode; }
47 virtual int set_mode (TrackMode /*m*/) { return false; }
48 virtual bool can_use_mode (TrackMode /*m*/, bool& /*bounce_required*/) { return false; }
49 PBD::Signal0<void> TrackModeChanged;
51 virtual void set_monitoring (MonitorChoice);
52 MonitorChoice monitoring_choice() const { return _monitoring; }
53 MonitorState monitoring_state();
54 PBD::Signal0<void> MonitoringChanged;
56 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
59 int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
62 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
63 int declick, bool& need_butler) = 0;
65 bool needs_butler() const { return _needs_butler; }
66 void toggle_monitor_input ();
68 virtual DataType data_type () const = 0;
72 virtual void use_new_diskstream () = 0;
73 virtual void set_diskstream (boost::shared_ptr<Diskstream>);
75 void set_latency_compensation (framecnt_t);
83 FreezeState freeze_state() const;
85 virtual void freeze_me (InterThreadInfo&) = 0;
86 virtual void unfreeze () = 0;
88 virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
89 virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo&, bool enable_processing = true) = 0;
92 XMLNode& get_template();
93 virtual int set_state (const XMLNode&, int version);
94 static void zero_diskstream_id_in_xml (XMLNode&);
96 boost::shared_ptr<PBD::Controllable> rec_enable_control() { return _rec_enable_control; }
98 bool record_enabled() const;
99 void set_record_enabled (bool yn, void *src);
101 bool using_diskstream_id (PBD::ID) const;
103 void set_block_size (pframes_t);
105 /** @return true if the track can be bounced, or false if it cannot because
106 * it has more outputs than diskstream channels.
108 virtual bool bounceable () const = 0;
110 /* PublicDiskstream interface */
111 boost::shared_ptr<Playlist> playlist ();
112 void monitor_input (bool);
113 bool destructive () const;
114 std::list<boost::shared_ptr<Source> > & last_capture_sources ();
115 void set_capture_offset ();
116 std::list<boost::shared_ptr<Source> > steal_write_sources();
117 void reset_write_sources (bool, bool force = false);
118 float playback_buffer_load () const;
119 float capture_buffer_load () const;
121 int do_flush (RunContext, bool force = false);
122 void set_pending_overwrite (bool);
123 int seek (framepos_t, bool complete_refill = false);
124 bool hidden () const;
125 int can_internal_playback_seek (framepos_t);
126 int internal_playback_seek (framepos_t);
127 void non_realtime_input_change ();
128 void non_realtime_locate (framepos_t);
129 void non_realtime_set_speed ();
130 int overwrite_existing_buffers ();
131 framecnt_t get_captured_frames (uint32_t n = 0) const;
132 int set_loop (Location *);
133 void transport_looped (framepos_t);
134 bool realtime_set_speed (double, bool);
135 void transport_stopped_wallclock (struct tm &, time_t, bool);
136 bool pending_overwrite () const;
137 double speed () const;
138 void prepare_to_stop (framepos_t);
139 void set_slaved (bool);
140 ChanCount n_channels ();
141 framepos_t get_capture_start_frame (uint32_t n = 0) const;
142 AlignStyle alignment_style () const;
143 AlignChoice alignment_choice () const;
144 framepos_t current_capture_start () const;
145 framepos_t current_capture_end () const;
146 void playlist_modified ();
147 int use_playlist (boost::shared_ptr<Playlist>);
148 void set_align_style (AlignStyle, bool force=false);
149 void set_align_choice (AlignChoice, bool force=false);
150 int use_copy_playlist ();
151 int use_new_playlist ();
152 void adjust_playback_buffering ();
153 void adjust_capture_buffering ();
155 PBD::Signal0<void> DiskstreamChanged;
156 PBD::Signal0<void> FreezeChange;
157 PBD::Signal0<void> PlaylistChanged;
158 PBD::Signal0<void> RecordEnableChanged;
159 PBD::Signal0<void> SpeedChanged;
160 PBD::Signal0<void> AlignmentStyleChanged;
163 XMLNode& state (bool full);
165 boost::shared_ptr<Diskstream> _diskstream;
166 MeterPoint _saved_meter_point;
167 /** used to keep track of processors that we are deactivating during record,
168 if `do-not-record-plugins' is enabled.
170 std::list<boost::weak_ptr<Processor> > _deactivated_processors;
173 MonitorChoice _monitoring;
176 struct FreezeRecordProcessorInfo {
177 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
178 : state (st), processor (proc) {}
181 boost::shared_ptr<Processor> processor;
185 struct FreezeRecord {
187 : have_mementos(false)
192 boost::shared_ptr<Playlist> playlist;
193 std::vector<FreezeRecordProcessorInfo*> processor_info;
198 struct RecEnableControllable : public PBD::Controllable {
199 RecEnableControllable (Track&);
201 void set_value (double);
202 double get_value (void) const;
207 virtual void set_state_part_two () = 0;
209 FreezeRecord _freeze_record;
210 XMLNode* pending_state;
213 void maybe_declick (BufferSet&, framecnt_t, int);
215 virtual bool send_silence () const;
217 boost::shared_ptr<RecEnableControllable> _rec_enable_control;
219 framecnt_t check_initial_delay (framecnt_t nframes, framecnt_t&);
223 virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &) = 0;
225 void diskstream_playlist_changed ();
226 void diskstream_record_enable_changed ();
227 void diskstream_speed_changed ();
228 void diskstream_alignment_style_changed ();
230 void parameter_changed (std::string);
231 void deactivate_visible_processors ();
232 void activate_deactivated_processors ();
235 }; /* namespace ARDOUR*/
237 #endif /* __ardour_track_h__ */