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 "ardour/route.h"
  25 #include "ardour/public_diskstream.h"
  26
  27 namespace ARDOUR {
  28
  29 class Session;
  30 class Playlist;
  31 class RouteGroup;
  32 class Source;
  33 class Region;
  34 class Diskstream;
  35
  36 class Track : public Route, public PublicDiskstream
  37 {
  38   public:
  39         Track (Session&, std::string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
  40         virtual ~Track ();
  41
  42         int init ();
  43
  44         bool set_name (const std::string& str);
  45
  46         TrackMode mode () const { return _mode; }
  47         virtual int set_mode (TrackMode /*m*/) { return false; }
  48         virtual bool can_use_mode (TrackMode /*m*/, bool& /*bounce_required*/) { return false; }
  49         PBD::Signal0<void> TrackModeChanged;
  50
  51         virtual void set_monitoring (MonitorChoice);
  52         MonitorChoice monitoring_choice() const { return _monitoring; }
  53         MonitorState monitoring_state();
  54         PBD::Signal0<void> MonitoringChanged;
  55
  56         virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  57                              bool state_changing);
  58
  59         int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  60                          bool& need_butler);
  61
  62         virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
  63                           int declick, bool& need_butler) = 0;
  64
  65         bool needs_butler() const { return _needs_butler; }
  66         void toggle_monitor_input ();
  67
  68         virtual DataType data_type () const = 0;
  69
  70         bool can_record();
  71
  72         virtual void use_new_diskstream () = 0;
  73         virtual void set_diskstream (boost::shared_ptr<Diskstream>);
  74
  75         void set_latency_compensation (framecnt_t);
  76
  77         enum FreezeState {
  78                 NoFreeze,
  79                 Frozen,
  80                 UnFrozen
  81         };
  82
  83         FreezeState freeze_state() const;
  84
  85         virtual void freeze_me (InterThreadInfo&) = 0;
  86         virtual void unfreeze () = 0;
  87
  88         virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
  89         virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo&, bool enable_processing = true) = 0;
  90
  91         XMLNode&    get_state();
  92         XMLNode&    get_template();
  93         virtual int set_state (const XMLNode&, int version);
  94         static void zero_diskstream_id_in_xml (XMLNode&);
  95
  96         boost::shared_ptr<PBD::Controllable> rec_enable_control() { return _rec_enable_control; }
  97
  98         bool record_enabled() const;
  99         void set_record_enabled (bool yn, void *src);
 100
 101         /* XXX: unfortunate that this is exposed */
 102         PBD::ID const & diskstream_id () const;
 103
 104         void set_block_size (pframes_t);
 105
 106         /** @return true if the track can be bounced, or false if it cannot because
 107          *  it has more outputs than diskstream channels.
 108          */
 109         virtual bool bounceable () const = 0;
 110
 111         /* PublicDiskstream interface */
 112         boost::shared_ptr<Playlist> playlist ();
 113         void monitor_input (bool);
 114         bool destructive () const;
 115         std::list<boost::shared_ptr<Source> > & last_capture_sources ();
 116         void set_capture_offset ();
 117         std::list<boost::shared_ptr<Source> > steal_write_sources();
 118         void reset_write_sources (bool, bool force = false);
 119         float playback_buffer_load () const;
 120         float capture_buffer_load () const;
 121         int do_refill ();
 122         int do_flush (RunContext, bool force = false);
 123         void set_pending_overwrite (bool);
 124         int seek (framepos_t, bool complete_refill = false);
 125         bool hidden () const;
 126         int can_internal_playback_seek (framepos_t);
 127         int internal_playback_seek (framepos_t);
 128         void non_realtime_input_change ();
 129         void non_realtime_locate (framepos_t);
 130         void non_realtime_set_speed ();
 131         int overwrite_existing_buffers ();
 132         framecnt_t get_captured_frames (uint32_t n = 0) const;
 133         int set_loop (Location *);
 134         void transport_looped (framepos_t);
 135         bool realtime_set_speed (double, bool);
 136         void transport_stopped_wallclock (struct tm &, time_t, bool);
 137         bool pending_overwrite () const;
 138         double speed () const;
 139         void prepare_to_stop (framepos_t);
 140         void set_slaved (bool);
 141         ChanCount n_channels ();
 142         framepos_t get_capture_start_frame (uint32_t n = 0) const;
 143         AlignStyle alignment_style () const;
 144         AlignChoice alignment_choice () const;
 145         framepos_t current_capture_start () const;
 146         framepos_t current_capture_end () const;
 147         void playlist_modified ();
 148         int use_playlist (boost::shared_ptr<Playlist>);
 149         void set_align_style (AlignStyle, bool force=false);
 150         void set_align_choice (AlignChoice, bool force=false);
 151         int use_copy_playlist ();
 152         int use_new_playlist ();
 153         void adjust_playback_buffering ();
 154         void adjust_capture_buffering ();
 155
 156         PBD::Signal0<void> DiskstreamChanged;
 157         PBD::Signal0<void> FreezeChange;
 158         PBD::Signal0<void> PlaylistChanged;
 159         PBD::Signal0<void> RecordEnableChanged;
 160         PBD::Signal0<void> SpeedChanged;
 161         PBD::Signal0<void> AlignmentStyleChanged;
 162
 163   protected:
 164         XMLNode& state (bool full);
 165
 166         boost::shared_ptr<Diskstream> _diskstream;
 167         MeterPoint    _saved_meter_point;
 168         TrackMode     _mode;
 169         bool          _needs_butler;
 170         MonitorChoice _monitoring;
 171
 172         //private: (FIXME)
 173         struct FreezeRecordProcessorInfo {
 174                 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
 175                         : state (st), processor (proc) {}
 176
 177                 XMLNode                      state;
 178                 boost::shared_ptr<Processor> processor;
 179                 PBD::ID                      id;
 180         };
 181
 182         struct FreezeRecord {
 183                 FreezeRecord()
 184                         : have_mementos(false)
 185                 {}
 186
 187                 ~FreezeRecord();
 188
 189                 boost::shared_ptr<Playlist>        playlist;
 190                 std::vector<FreezeRecordProcessorInfo*> processor_info;
 191                 bool                               have_mementos;
 192                 FreezeState                        state;
 193         };
 194
 195         struct RecEnableControllable : public PBD::Controllable {
 196                 RecEnableControllable (Track&);
 197
 198                 void set_value (double);
 199                 double get_value (void) const;
 200
 201                 Track& track;
 202         };
 203
 204         virtual void set_state_part_two () = 0;
 205
 206         FreezeRecord          _freeze_record;
 207         XMLNode*              pending_state;
 208         bool                  _destructive;
 209
 210         void maybe_declick (BufferSet&, framecnt_t, int);
 211
 212         virtual bool send_silence () const;
 213
 214         boost::shared_ptr<RecEnableControllable> _rec_enable_control;
 215
 216         framecnt_t check_initial_delay (framecnt_t nframes, framecnt_t&);
 217
 218 private:
 219
 220         virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &) = 0;
 221
 222         void diskstream_playlist_changed ();
 223         void diskstream_record_enable_changed ();
 224         void diskstream_speed_changed ();
 225         void diskstream_alignment_style_changed ();
 226 };
 227
 228 }; /* namespace ARDOUR*/
 229
 230 #endif /* __ardour_track_h__ */