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
  26 namespace ARDOUR {
  27
  28 class Session;
  29 class Diskstream;
  30 class Playlist;
  31 class RouteGroup;
  32 class Region;
  33
  34 class Track : public Route
  35 {
  36   public:
  37         Track (Session&, std::string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
  38         virtual ~Track ();
  39
  40         int init ();
  41
  42         bool set_name (const std::string& str);
  43
  44         TrackMode mode () const { return _mode; }
  45         virtual int set_mode (TrackMode /*m*/) { return false; }
  46         virtual bool can_use_mode (TrackMode /*m*/, bool& /*bounce_required*/) { return false; }
  47         PBD::Signal0<void> TrackModeChanged;
  48
  49         virtual int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
  50                         bool state_changing, bool can_record, bool rec_monitors_input);
  51
  52         int silent_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
  53                         bool can_record, bool rec_monitors_input);
  54
  55         virtual int roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
  56                         int declick, bool can_record, bool rec_monitors_input) = 0;
  57
  58         void toggle_monitor_input ();
  59
  60         bool can_record();
  61
  62         boost::shared_ptr<Diskstream> diskstream() const { return _diskstream; }
  63
  64         virtual void use_new_diskstream () = 0;
  65         virtual void set_diskstream (boost::shared_ptr<Diskstream>) = 0;
  66
  67         nframes_t update_total_latency();
  68         void           set_latency_delay (nframes_t);
  69
  70         enum FreezeState {
  71                 NoFreeze,
  72                 Frozen,
  73                 UnFrozen
  74         };
  75
  76         FreezeState freeze_state() const;
  77
  78         virtual void freeze_me (InterThreadInfo&) = 0;
  79         virtual void unfreeze () = 0;
  80
  81         virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
  82         virtual boost::shared_ptr<Region> bounce_range (nframes_t start, nframes_t end, InterThreadInfo&, bool enable_processing = true) = 0;
  83
  84         XMLNode&    get_state();
  85         XMLNode&    get_template();
  86         virtual int set_state (const XMLNode&, int version) = 0;
  87         static void zero_diskstream_id_in_xml (XMLNode&);
  88
  89         boost::shared_ptr<PBD::Controllable> rec_enable_control() { return _rec_enable_control; }
  90
  91         bool record_enabled() const;
  92         void set_record_enable (bool yn, void *src);
  93
  94         PBD::Signal0<void> DiskstreamChanged;
  95         PBD::Signal0<void> FreezeChange;
  96
  97   protected:
  98         virtual XMLNode& state (bool full) = 0;
  99
 100         boost::shared_ptr<Diskstream> _diskstream;
 101         MeterPoint  _saved_meter_point;
 102         TrackMode   _mode;
 103
 104         ChanCount input_streams () const;
 105
 106         //private: (FIXME)
 107         struct FreezeRecordProcessorInfo {
 108                 FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
 109                         : state (st), processor (proc) {}
 110
 111                 XMLNode                      state;
 112                 boost::shared_ptr<Processor> processor;
 113                 PBD::ID                      id;
 114         };
 115
 116         struct FreezeRecord {
 117                 FreezeRecord()
 118                         : have_mementos(false)
 119                 {}
 120
 121                 ~FreezeRecord();
 122
 123                 boost::shared_ptr<Playlist>        playlist;
 124                 std::vector<FreezeRecordProcessorInfo*> processor_info;
 125                 bool                               have_mementos;
 126                 FreezeState                        state;
 127                 gain_t                          gain;
 128                 AutoState                       gain_automation_state;
 129                 AutoState                       pan_automation_state;
 130         };
 131
 132         struct RecEnableControllable : public PBD::Controllable {
 133                 RecEnableControllable (Track&);
 134
 135                 void set_value (float);
 136                 float get_value (void) const;
 137
 138                 Track& track;
 139         };
 140
 141         virtual void set_state_part_two () = 0;
 142
 143         FreezeRecord          _freeze_record;
 144         XMLNode*              pending_state;
 145         bool                  _destructive;
 146
 147         boost::shared_ptr<RecEnableControllable> _rec_enable_control;
 148 };
 149
 150 }; /* namespace ARDOUR*/
 151
 152 #endif /* __ardour_track_h__ */