libs/ardour/ardour/export_timespan.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __ardour_export_timespan_h__
  22 #define __ardour_export_timespan_h__
  23
  24 #include <string>
  25
  26 #include <boost/shared_ptr.hpp>
  27
  28 #include "ardour/libardour_visibility.h"
  29 #include "ardour/types.h"
  30
  31 namespace ARDOUR
  32 {
  33
  34 class ExportStatus;
  35 class ExportChannel;
  36 class ExportTempFile;
  37
  38 class LIBARDOUR_API ExportTimespan
  39 {
  40   private:
  41         typedef boost::shared_ptr<ExportStatus> ExportStatusPtr;
  42
  43   private:
  44         friend class ExportElementFactory;
  45         ExportTimespan (ExportStatusPtr status, framecnt_t frame_rate);
  46
  47   public:
  48         ~ExportTimespan ();
  49
  50         std::string name () const { return _name; }
  51         void set_name (std::string name) { _name = name; }
  52
  53         std::string range_id () const { return _range_id; }
  54         void set_range_id (std::string range_id) { _range_id = range_id; }
  55
  56         bool realtime () const { return _realtime; }
  57         void set_realtime (bool rt) { _realtime = rt; }
  58
  59         void set_range (framepos_t start, framepos_t end);
  60         framecnt_t get_length () const { return end_frame - start_frame; }
  61         framepos_t get_start () const { return start_frame; }
  62         framepos_t get_end () const { return end_frame; }
  63
  64         /// Primarily compare start time, then end time
  65         bool operator< (ExportTimespan const & other) {
  66                 if (start_frame < other.start_frame) { return true; }
  67                 if (start_frame > other.start_frame) { return false; }
  68                 return end_frame < other.end_frame;
  69         }
  70
  71   private:
  72
  73         ExportStatusPtr status;
  74
  75         framepos_t      start_frame;
  76         framepos_t      end_frame;
  77         framepos_t      position;
  78         framecnt_t      frame_rate;
  79
  80         std::string _name;
  81         std::string _range_id;
  82         bool        _realtime;
  83
  84 };
  85
  86 } // namespace ARDOUR
  87
  88 #endif /* __ardour_export_timespan_h__ */