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"
37 class Track : public Route, public PublicDiskstream
40 Track (Session&, std::string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
45 bool set_name (const std::string& str);
47 TrackMode mode () const { return _mode; }
48 virtual int set_mode (TrackMode /*m*/) { return false; }
49 virtual bool can_use_mode (TrackMode /*m*/, bool& /*bounce_required*/) { return false; }
50 PBD::Signal0<void> TrackModeChanged;
52 virtual void set_monitoring (MonitorChoice);
53 MonitorChoice monitoring_choice() const { return _monitoring; }
54 MonitorState monitoring_state () const;
55 PBD::Signal0<void> MonitoringChanged;
57 MeterState metering_state () const;
59 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
62 int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
65 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
66 int declick, bool& need_butler) = 0;
68 bool needs_butler() const { return _needs_butler; }
70 virtual DataType data_type () const = 0;
74 void use_new_diskstream ();
75 virtual boost::shared_ptr<Diskstream> create_diskstream() = 0;
76 virtual void set_diskstream (boost::shared_ptr<Diskstream>);
78 void set_latency_compensation (framecnt_t);
86 FreezeState freeze_state() const;
88 virtual void freeze_me (InterThreadInfo&) = 0;
89 virtual void unfreeze () = 0;
91 /** @return true if the track can be bounced, or false otherwise.
93 virtual bool bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const = 0;
94 virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
95 virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo&,
96 boost::shared_ptr<Processor> endpoint, bool include_endpoint) = 0;
97 virtual int export_stuff (BufferSet& bufs, framepos_t start_frame, framecnt_t nframes,
98 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export) = 0;
100 XMLNode& get_state();
101 XMLNode& get_template();
102 virtual int set_state (const XMLNode&, int version);
103 static void zero_diskstream_id_in_xml (XMLNode&);
105 boost::shared_ptr<AutomationControl> rec_enable_control() { return _rec_enable_control; }
107 bool record_enabled() const;
108 void set_record_enabled (bool yn, void *src);
109 void prep_record_enabled (bool yn, void *src);
111 bool using_diskstream_id (PBD::ID) const;
113 void set_block_size (pframes_t);
115 /* PublicDiskstream interface */
116 boost::shared_ptr<Playlist> playlist ();
117 void request_jack_monitors_input (bool);
118 void ensure_jack_monitors_input (bool);
119 bool destructive () const;
120 std::list<boost::shared_ptr<Source> > & last_capture_sources ();
121 void set_capture_offset ();
122 std::list<boost::shared_ptr<Source> > steal_write_sources();
123 void reset_write_sources (bool, bool force = false);
124 float playback_buffer_load () const;
125 float capture_buffer_load () const;
127 int do_flush (RunContext, bool force = false);
128 void set_pending_overwrite (bool);
129 int seek (framepos_t, bool complete_refill = false);
130 bool hidden () const;
131 int can_internal_playback_seek (framecnt_t);
132 int internal_playback_seek (framecnt_t);
133 void non_realtime_input_change ();
134 void non_realtime_locate (framepos_t);
135 void non_realtime_set_speed ();
136 int overwrite_existing_buffers ();
137 framecnt_t get_captured_frames (uint32_t n = 0) const;
138 int set_loop (Location *);
139 void transport_looped (framepos_t);
140 bool realtime_set_speed (double, bool);
141 void transport_stopped_wallclock (struct tm &, time_t, bool);
142 bool pending_overwrite () const;
143 double speed () const;
144 void prepare_to_stop (framepos_t);
145 void set_slaved (bool);
146 ChanCount n_channels ();
147 framepos_t get_capture_start_frame (uint32_t n = 0) const;
148 AlignStyle alignment_style () const;
149 AlignChoice alignment_choice () const;
150 framepos_t current_capture_start () const;
151 framepos_t current_capture_end () const;
152 void playlist_modified ();
153 int use_playlist (boost::shared_ptr<Playlist>);
154 void set_align_style (AlignStyle, bool force=false);
155 void set_align_choice (AlignChoice, bool force=false);
156 int use_copy_playlist ();
157 int use_new_playlist ();
158 void adjust_playback_buffering ();
159 void adjust_capture_buffering ();
161 PBD::Signal0<void> DiskstreamChanged;
162 PBD::Signal0<void> FreezeChange;
163 /* Emitted when our diskstream is set to use a different playlist */
164 PBD::Signal0<void> PlaylistChanged;
165 PBD::Signal0<void> RecordEnableChanged;
166 PBD::Signal0<void> SpeedChanged;
167 PBD::Signal0<void> AlignmentStyleChanged;
170 XMLNode& state (bool full);
172 boost::shared_ptr<Diskstream> _diskstream;
173 MeterPoint _saved_meter_point;
176 MonitorChoice _monitoring;
179 struct FreezeRecordProcessorInfo {
180 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
181 : state (st), processor (proc) {}
184 boost::shared_ptr<Processor> processor;
188 struct FreezeRecord {
190 : have_mementos(false)
195 boost::shared_ptr<Playlist> playlist;
196 std::vector<FreezeRecordProcessorInfo*> processor_info;
201 struct RecEnableControl : public AutomationControl {
202 RecEnableControl (boost::shared_ptr<Track> t);
204 void set_value (double);
205 double get_value (void) const;
207 boost::weak_ptr<Track> track;
210 virtual void set_state_part_two () = 0;
212 FreezeRecord _freeze_record;
213 XMLNode* pending_state;
216 void maybe_declick (BufferSet&, framecnt_t, int);
218 boost::shared_ptr<RecEnableControl> _rec_enable_control;
220 framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&);
224 virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &) = 0;
226 void diskstream_playlist_changed ();
227 void diskstream_record_enable_changed ();
228 void diskstream_speed_changed ();
229 void diskstream_alignment_style_changed ();
232 }; /* namespace ARDOUR*/
234 #endif /* __ardour_track_h__ */