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 "pbd/enum_convert.h"
26 #include "ardour/interthread_info.h"
27 #include "ardour/recordable.h"
28 #include "ardour/route.h"
40 class RecordEnableControl;
41 class RecordSafeControl;
43 /** A track is an route (bus) with a recordable diskstream and
44 * related objects relevant to recording, playback and editing.
46 * Specifically a track has a playlist object that describes material
47 * to be played from disk, and modifies that object during recording and
50 class LIBARDOUR_API Track : public Route, public Recordable
53 Track (Session&, std::string name, PresentationInfo::Flag f = PresentationInfo::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
58 bool set_name (const std::string& str);
59 void resync_track_name ();
61 TrackMode mode () const { return _mode; }
63 MeterState metering_state () const;
65 bool set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure);
67 bool needs_butler() const { return _needs_butler; }
77 FreezeState freeze_state() const;
79 virtual void freeze_me (InterThreadInfo&) = 0;
80 virtual void unfreeze () = 0;
82 /** Test if the track can be bounced with the given settings.
83 * If sends/inserts/returns are present in the signal path or the given track
84 * has no audio outputs bouncing is not possible.
86 * @param endpoint the processor to tap the signal off (or nil for the top)
87 * @param include_endpoint include the given processor in the bounced audio.
88 * @return true if the track can be bounced, or false otherwise.
90 virtual bool bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const = 0;
92 /** bounce track from session start to session end to new region
94 * @param itt asynchronous progress report and cancel
95 * @return a new audio region (or nil in case of error)
97 virtual boost::shared_ptr<Region> bounce (InterThreadInfo& itt) = 0;
99 /** Bounce the given range to a new audio region.
100 * @param start start time (in samples)
101 * @param end end time (in samples)
102 * @param itt asynchronous progress report and cancel
103 * @param endpoint the processor to tap the signal off (or nil for the top)
104 * @param include_endpoint include the given processor in the bounced audio.
105 * @return a new audio region (or nil in case of error)
107 virtual boost::shared_ptr<Region> bounce_range (samplepos_t start, samplepos_t end, InterThreadInfo& itt,
108 boost::shared_ptr<Processor> endpoint, bool include_endpoint) = 0;
109 virtual int export_stuff (BufferSet& bufs, samplepos_t start_sample, samplecnt_t nframes,
110 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) = 0;
112 virtual int set_state (const XMLNode&, int version);
113 static void zero_diskstream_id_in_xml (XMLNode&);
115 boost::shared_ptr<AutomationControl> rec_enable_control() const { return _record_enable_control; }
116 boost::shared_ptr<AutomationControl> rec_safe_control() const { return _record_safe_control; }
118 int prep_record_enabled (bool);
119 bool can_be_record_enabled ();
120 bool can_be_record_safe ();
122 void use_captured_sources (SourceList&, CaptureInfos const &);
124 void set_block_size (pframes_t);
126 boost::shared_ptr<Playlist> playlist ();
127 void request_input_monitoring (bool);
128 void ensure_input_monitoring (bool);
129 bool destructive () const;
130 std::list<boost::shared_ptr<Source> > & last_capture_sources ();
131 std::string steal_write_source_name ();
132 void reset_write_sources (bool, bool force = false);
133 float playback_buffer_load () const;
134 float capture_buffer_load () const;
136 int do_flush (RunContext, bool force = false);
137 void set_pending_overwrite (bool);
138 int seek (samplepos_t, bool complete_refill = false);
139 int can_internal_playback_seek (samplecnt_t);
140 int internal_playback_seek (samplecnt_t);
141 void non_realtime_locate (samplepos_t);
142 void realtime_handle_transport_stopped ();
143 void non_realtime_speed_change ();
144 int overwrite_existing_buffers ();
145 samplecnt_t get_captured_samples (uint32_t n = 0) const;
146 void transport_looped (samplepos_t);
147 void transport_stopped_wallclock (struct tm &, time_t, bool);
148 bool pending_overwrite () const;
149 void set_slaved (bool);
150 ChanCount n_channels ();
151 samplepos_t get_capture_start_sample (uint32_t n = 0) const;
152 AlignStyle alignment_style () const;
153 AlignChoice alignment_choice () const;
154 samplepos_t current_capture_start () const;
155 samplepos_t current_capture_end () const;
156 void set_align_style (AlignStyle, bool force=false);
157 void set_align_choice (AlignChoice, bool force=false);
158 void playlist_modified ();
159 int use_playlist (DataType, boost::shared_ptr<Playlist>);
160 int find_and_use_playlist (DataType, PBD::ID const &);
161 int use_copy_playlist ();
162 int use_new_playlist (DataType);
163 int use_default_new_playlist () {
164 return use_new_playlist (data_type());
166 void adjust_playback_buffering ();
167 void adjust_capture_buffering ();
169 PBD::Signal0<void> FreezeChange;
170 PBD::Signal0<void> PlaylistChanged;
171 PBD::Signal0<void> SpeedChanged;
172 PBD::Signal0<void> AlignmentStyleChanged;
175 XMLNode& state (bool save_template);
177 boost::shared_ptr<Playlist> _playlists[DataType::num_types];
179 MeterPoint _saved_meter_point;
184 struct FreezeRecordProcessorInfo {
185 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
186 : state (st), processor (proc) {}
189 boost::shared_ptr<Processor> processor;
193 struct FreezeRecord {
195 : have_mementos(false)
200 boost::shared_ptr<Playlist> playlist;
201 std::vector<FreezeRecordProcessorInfo*> processor_info;
206 virtual void set_state_part_two () = 0;
208 FreezeRecord _freeze_record;
209 XMLNode* pending_state;
212 void maybe_declick (BufferSet&, samplecnt_t, int);
214 boost::shared_ptr<AutomationControl> _record_enable_control;
215 boost::shared_ptr<AutomationControl> _record_safe_control;
217 virtual void record_enable_changed (bool, PBD::Controllable::GroupControlDisposition);
218 virtual void record_safe_changed (bool, PBD::Controllable::GroupControlDisposition);
220 virtual void monitoring_changed (bool, PBD::Controllable::GroupControlDisposition);
222 AlignChoice _alignment_choice;
223 void set_align_choice_from_io ();
224 void input_changed ();
226 void use_captured_audio_sources (SourceList&, CaptureInfos const &);
227 void use_captured_midi_sources (SourceList&, CaptureInfos const &);
230 void parameter_changed (std::string const & p);
232 std::string _diskstream_name;
235 }; /* namespace ARDOUR*/
238 DEFINE_ENUM_CONVERT(ARDOUR::Track::FreezeState);
241 #endif /* __ardour_track_h__ */