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 virtual void set_monitoring (MonitorChoice);
55 MonitorChoice monitoring_choice() const { return _monitoring; }
56 MonitorState monitoring_state () const;
57 PBD::Signal0<void> MonitoringChanged;
59 MeterState metering_state () const;
61 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
64 int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
67 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
68 int declick, bool& need_butler) = 0;
70 bool needs_butler() const { return _needs_butler; }
72 virtual DataType data_type () const = 0;
76 void use_new_diskstream ();
77 virtual boost::shared_ptr<Diskstream> create_diskstream() = 0;
78 virtual void set_diskstream (boost::shared_ptr<Diskstream>);
80 void set_latency_compensation (framecnt_t);
88 FreezeState freeze_state() const;
90 virtual void freeze_me (InterThreadInfo&) = 0;
91 virtual void unfreeze () = 0;
93 /** @return true if the track can be bounced, or false otherwise.
95 virtual bool bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const = 0;
96 virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
97 virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo&,
98 boost::shared_ptr<Processor> endpoint, bool include_endpoint) = 0;
99 virtual int export_stuff (BufferSet& bufs, framepos_t start_frame, framecnt_t nframes,
100 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) = 0;
102 XMLNode& get_state();
103 XMLNode& get_template();
104 virtual int set_state (const XMLNode&, int version);
105 static void zero_diskstream_id_in_xml (XMLNode&);
107 boost::shared_ptr<AutomationControl> rec_enable_control() { return _rec_enable_control; }
109 bool record_enabled() const;
110 void set_record_enabled (bool yn, void *src);
111 void prep_record_enabled (bool yn, void *src);
113 bool using_diskstream_id (PBD::ID) const;
115 void set_block_size (pframes_t);
117 /* PublicDiskstream interface */
118 boost::shared_ptr<Playlist> playlist ();
119 void request_input_monitoring (bool);
120 void ensure_input_monitoring (bool);
121 bool destructive () const;
122 std::list<boost::shared_ptr<Source> > & last_capture_sources ();
123 void set_capture_offset ();
124 std::string steal_write_source_name ();
125 void reset_write_sources (bool, bool force = false);
126 float playback_buffer_load () const;
127 float capture_buffer_load () const;
129 int do_flush (RunContext, bool force = false);
130 void set_pending_overwrite (bool);
131 int seek (framepos_t, bool complete_refill = false);
132 bool hidden () const;
133 int can_internal_playback_seek (framecnt_t);
134 int internal_playback_seek (framecnt_t);
135 void non_realtime_input_change ();
136 void non_realtime_locate (framepos_t);
137 void non_realtime_set_speed ();
138 int overwrite_existing_buffers ();
139 framecnt_t get_captured_frames (uint32_t n = 0) const;
140 int set_loop (Location *);
141 void transport_looped (framepos_t);
142 bool realtime_set_speed (double, bool);
143 void transport_stopped_wallclock (struct tm &, time_t, bool);
144 bool pending_overwrite () const;
145 double speed () const;
146 void prepare_to_stop (framepos_t, framepos_t);
147 void set_slaved (bool);
148 ChanCount n_channels ();
149 framepos_t get_capture_start_frame (uint32_t n = 0) const;
150 AlignStyle alignment_style () const;
151 AlignChoice alignment_choice () const;
152 framepos_t current_capture_start () const;
153 framepos_t current_capture_end () const;
154 void playlist_modified ();
155 int use_playlist (boost::shared_ptr<Playlist>);
156 void set_align_style (AlignStyle, bool force=false);
157 void set_align_choice (AlignChoice, bool force=false);
158 int use_copy_playlist ();
159 int use_new_playlist ();
160 void adjust_playback_buffering ();
161 void adjust_capture_buffering ();
163 PBD::Signal0<void> DiskstreamChanged;
164 PBD::Signal0<void> FreezeChange;
165 /* Emitted when our diskstream is set to use a different playlist */
166 PBD::Signal0<void> PlaylistChanged;
167 PBD::Signal0<void> RecordEnableChanged;
168 PBD::Signal0<void> SpeedChanged;
169 PBD::Signal0<void> AlignmentStyleChanged;
172 XMLNode& state (bool full);
174 boost::shared_ptr<Diskstream> _diskstream;
175 MeterPoint _saved_meter_point;
178 MonitorChoice _monitoring;
181 struct FreezeRecordProcessorInfo {
182 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
183 : state (st), processor (proc) {}
186 boost::shared_ptr<Processor> processor;
190 struct FreezeRecord {
192 : have_mementos(false)
197 boost::shared_ptr<Playlist> playlist;
198 std::vector<FreezeRecordProcessorInfo*> processor_info;
203 struct RecEnableControl : public AutomationControl {
204 RecEnableControl (boost::shared_ptr<Track> t);
206 void set_value (double);
207 double get_value (void) const;
209 boost::weak_ptr<Track> track;
212 virtual void set_state_part_two () = 0;
214 FreezeRecord _freeze_record;
215 XMLNode* pending_state;
218 void maybe_declick (BufferSet&, framecnt_t, int);
220 boost::shared_ptr<RecEnableControl> _rec_enable_control;
222 framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&);
226 virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &) = 0;
228 void diskstream_playlist_changed ();
229 void diskstream_record_enable_changed ();
230 void diskstream_speed_changed ();
231 void diskstream_alignment_style_changed ();
232 void parameter_changed (std::string const & p);
234 std::string _diskstream_name;
237 }; /* namespace ARDOUR*/
239 #endif /* __ardour_track_h__ */