libs/ardour/ardour/track.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17 */
  18
  19 #ifndef __ardour_track_h__
  20 #define __ardour_track_h__
  21
  22 #include <boost/shared_ptr.hpp>
  23
  24 #include "pbd/enum_convert.h"
  25
  26 #include "ardour/interthread_info.h"
  27 #include "ardour/recordable.h"
  28 #include "ardour/route.h"
  29
  30 namespace ARDOUR {
  31
  32 class Session;
  33 class Playlist;
  34 class RouteGroup;
  35 class Source;
  36 class Region;
  37 class DiskReader;
  38 class DiskWriter;
  39 class IO;
  40 class Location;
  41 class MonitorControl;
  42 class RecordEnableControl;
  43 class RecordSafeControl;
  44
  45 /** A track is an route (bus) with a recordable diskstream and
  46  * related objects relevant to recording, playback and editing.
  47  *
  48  * Specifically a track has a playlist object that describes material
  49  * to be played from disk, and modifies that object during recording and
  50  * editing.
  51  */
  52 class LIBARDOUR_API Track : public Route, public Recordable
  53 {
  54   public:
  55         Track (Session&, std::string name, PresentationInfo::Flag f = PresentationInfo::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
  56         virtual ~Track ();
  57
  58         int init ();
  59
  60         bool set_name (const std::string& str);
  61         void resync_track_name ();
  62
  63         TrackMode mode () const { return _mode; }
  64
  65         boost::shared_ptr<MonitorControl> monitoring_control() const { return _monitoring_control; }
  66
  67         MonitorState monitoring_state () const;
  68         MeterState metering_state () const;
  69
  70         bool set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure);
  71
  72         virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  73                              bool state_changing);
  74
  75         int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  76                          bool& need_butler);
  77
  78         virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  79                           int declick, bool& need_butler) = 0;
  80
  81         bool needs_butler() const { return _needs_butler; }
  82
  83         bool can_record();
  84
  85         void set_latency_compensation (framecnt_t);
  86         void update_latency_information ();
  87         enum FreezeState {
  88                 NoFreeze,
  89                 Frozen,
  90                 UnFrozen
  91         };
  92
  93         FreezeState freeze_state() const;
  94
  95         virtual void freeze_me (InterThreadInfo&) = 0;
  96         virtual void unfreeze () = 0;
  97
  98         /** Test if the track can be bounced with the given settings.
  99          * If sends/inserts/returns are present in the signal path or the given track
 100          * has no audio outputs bouncing is not possible.
 101          *
 102          * @param endpoint the processor to tap the signal off (or nil for the top)
 103          * @param include_endpoint include the given processor in the bounced audio.
 104          * @return true if the track can be bounced, or false otherwise.
 105          */
 106         virtual bool bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const = 0;
 107
 108         /** bounce track from session start to session end to new region
 109          *
 110          * @param itt asynchronous progress report and cancel
 111          * @return a new audio region (or nil in case of error)
 112          */
 113         virtual boost::shared_ptr<Region> bounce (InterThreadInfo& itt) = 0;
 114
 115         /** Bounce the given range to a new audio region.
 116          * @param start start time (in samples)
 117          * @param end end time (in samples)
 118          * @param itt asynchronous progress report and cancel
 119          * @param endpoint the processor to tap the signal off (or nil for the top)
 120          * @param include_endpoint include the given processor in the bounced audio.
 121          * @return a new audio region (or nil in case of error)
 122          */
 123         virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo& itt,
 124                                                         boost::shared_ptr<Processor> endpoint, bool include_endpoint) = 0;
 125         virtual int export_stuff (BufferSet& bufs, framepos_t start_frame, framecnt_t nframes,
 126                                   boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) = 0;
 127
 128         XMLNode&    get_state();
 129         XMLNode&    get_template();
 130         virtual int set_state (const XMLNode&, int version);
 131         static void zero_diskstream_id_in_xml (XMLNode&);
 132
 133         boost::shared_ptr<AutomationControl> rec_enable_control() const { return _record_enable_control; }
 134         boost::shared_ptr<AutomationControl> rec_safe_control() const { return _record_safe_control; }
 135
 136         int prep_record_enabled (bool);
 137         bool can_be_record_enabled ();
 138         bool can_be_record_safe ();
 139
 140         void use_captured_sources (SourceList&, CaptureInfos const &);
 141
 142         void set_block_size (pframes_t);
 143
 144         boost::shared_ptr<Playlist> playlist ();
 145         void request_input_monitoring (bool);
 146         void ensure_input_monitoring (bool);
 147         bool destructive () const;
 148         std::list<boost::shared_ptr<Source> > & last_capture_sources ();
 149         std::string steal_write_source_name ();
 150         void reset_write_sources (bool, bool force = false);
 151         float playback_buffer_load () const;
 152         float capture_buffer_load () const;
 153         int do_refill ();
 154         int do_flush (RunContext, bool force = false);
 155         void set_pending_overwrite (bool);
 156         int seek (framepos_t, bool complete_refill = false);
 157         bool hidden () const;
 158         int can_internal_playback_seek (framecnt_t);
 159         int internal_playback_seek (framecnt_t);
 160         void non_realtime_locate (framepos_t);
 161         void realtime_handle_transport_stopped ();
 162         void non_realtime_speed_change ();
 163         int overwrite_existing_buffers ();
 164         framecnt_t get_captured_frames (uint32_t n = 0) const;
 165         int set_loop (ARDOUR::Location *);
 166         void transport_looped (framepos_t);
 167         bool realtime_speed_change ();
 168         void transport_stopped_wallclock (struct tm &, time_t, bool);
 169         bool pending_overwrite () const;
 170         void prepare_to_stop (framepos_t, framepos_t);
 171         void set_slaved (bool);
 172         ChanCount n_channels ();
 173         framepos_t get_capture_start_frame (uint32_t n = 0) const;
 174         AlignStyle alignment_style () const;
 175         AlignChoice alignment_choice () const;
 176         framepos_t current_capture_start () const;
 177         framepos_t current_capture_end () const;
 178         void set_align_style (AlignStyle, bool force=false);
 179         void set_align_choice (AlignChoice, bool force=false);
 180         void playlist_modified ();
 181         int use_playlist (DataType, boost::shared_ptr<Playlist>);
 182         int find_and_use_playlist (DataType, PBD::ID const &);
 183         int use_copy_playlist ();
 184         int use_new_playlist ();
 185         void adjust_playback_buffering ();
 186         void adjust_capture_buffering ();
 187
 188         void set_disk_io_position (DiskIOPoint);
 189         DiskIOPoint disk_io_point() const { return _disk_io_point; }
 190
 191         PBD::Signal0<void> FreezeChange;
 192         PBD::Signal0<void> PlaylistChanged;
 193         PBD::Signal0<void> SpeedChanged;
 194         PBD::Signal0<void> AlignmentStyleChanged;
 195
 196   protected:
 197         XMLNode& state (bool full);
 198
 199         boost::shared_ptr<DiskReader> _disk_reader;
 200         boost::shared_ptr<DiskWriter> _disk_writer;
 201         boost::shared_ptr<Playlist>   _playlists[DataType::num_types];
 202
 203         MeterPoint    _saved_meter_point;
 204         DiskIOPoint   _disk_io_point;
 205         TrackMode     _mode;
 206         bool          _needs_butler;
 207         boost::shared_ptr<MonitorControl> _monitoring_control;
 208
 209         //private: (FIXME)
 210         struct FreezeRecordProcessorInfo {
 211                 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
 212                         : state (st), processor (proc) {}
 213
 214                 XMLNode                      state;
 215                 boost::shared_ptr<Processor> processor;
 216                 PBD::ID                      id;
 217         };
 218
 219         struct FreezeRecord {
 220                 FreezeRecord()
 221                         : have_mementos(false)
 222                 {}
 223
 224                 ~FreezeRecord();
 225
 226                 boost::shared_ptr<Playlist>        playlist;
 227                 std::vector<FreezeRecordProcessorInfo*> processor_info;
 228                 bool                               have_mementos;
 229                 FreezeState                        state;
 230         };
 231
 232         virtual void set_state_part_two () = 0;
 233
 234         FreezeRecord _freeze_record;
 235         XMLNode*      pending_state;
 236         bool         _destructive;
 237
 238         void maybe_declick (BufferSet&, framecnt_t, int);
 239
 240         boost::shared_ptr<AutomationControl> _record_enable_control;
 241         boost::shared_ptr<AutomationControl> _record_safe_control;
 242
 243         virtual void record_enable_changed (bool, PBD::Controllable::GroupControlDisposition);
 244         virtual void record_safe_changed (bool, PBD::Controllable::GroupControlDisposition);
 245
 246         framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&);
 247         virtual void monitoring_changed (bool, PBD::Controllable::GroupControlDisposition);
 248
 249         AlignChoice _alignment_choice;
 250         void set_align_choice_from_io ();
 251         void input_changed ();
 252
 253         void use_captured_audio_sources (SourceList&, CaptureInfos const &);
 254         void use_captured_midi_sources (SourceList&, CaptureInfos const &);
 255
 256 private:
 257         void parameter_changed (std::string const & p);
 258         void setup_invisible_processors_oh_children_of_mine (ProcessorList&);
 259         void add_processors_oh_children_of_mine ();
 260
 261         std::string _diskstream_name;
 262 };
 263
 264 }; /* namespace ARDOUR*/
 265
 266 namespace PBD {
 267         DEFINE_ENUM_CONVERT(ARDOUR::Track::FreezeState);
 268 }
 269
 270 #endif /* __ardour_track_h__ */