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