Rename write_to_cpl_base -> write_to_cpl_asset.
[libdcp.git] / src / dcp_time.h
index 270177dd653edb65ad94f63222391ce216575afa..9320d8bab2d7bf2b938a2043019471c18f98fe12 100644 (file)
@@ -1,20 +1,34 @@
 /*
     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
 /** @file  src/dcp_time.h
 #define LIBDCP_TIME_H
 
 #include "types.h"
+#include <boost/optional.hpp>
 #include <stdint.h>
 #include <string>
 #include <iostream>
 
 namespace dcp {
 
+class Time;
+
+extern bool operator== (Time const & a, Time const & b);
+extern bool operator!= (Time const & a, Time const & b);
+extern bool operator<= (Time const & a, Time const & b);
+extern bool operator< (Time const & a, Time const & b);
+extern bool operator> (Time const & a, Time const & b);
+extern bool operator>= (Time const & a, Time const & b);
+extern std::ostream & operator<< (std::ostream & s, Time const & t);
+extern Time operator+ (Time a, Time b);
+extern Time operator- (Time a, Time b);
+extern float operator/ (Time a, Time const & b);
+
 /** @class Time
  *  @brief A representation of time within a DCP.
  */
@@ -41,11 +69,11 @@ public:
        Time () : h (0), m (0), s (0), e (0), tcr (1) {}
 
        /** Construct a Time.
-        *  @param Frame index (starting from 0).
+        *  @param frame Frame index (starting from 0).
         *  @param frames_per_second Frames per second.
         *  @param tcr Timecode rate.
         */
-       Time (int frame, int frames_per_second, int tcr);
+       Time (int frame, double frames_per_second, int tcr);
 
        /** Construct a Time from hours, minutes, seconds, editable units and a timecode rate.
         *  @param h_ Hours.
@@ -62,9 +90,9 @@ public:
                , tcr (tcr_)
        {}
 
-       Time (double seconds);
+       Time (double seconds, int tcr);
 
-       Time (std::string time, int tcr);
+       Time (std::string time, boost::optional<int> tcr);
 
        int h; ///<   hours
        int m; ///<   minutes
@@ -77,21 +105,15 @@ public:
        int64_t as_editable_units (int tcr_) const;
        Time rebase (int tcr_) const;
 
+       Time& operator+= (Time const & o) {
+               *this = *this + o;
+               return *this;
+       }
+
 private:
        void set (double seconds, int tcr);
 };
 
-extern bool operator== (Time const & a, Time const & b);
-extern bool operator!= (Time const & a, Time const & b);
-extern bool operator<= (Time const & a, Time const & b);
-extern bool operator< (Time const & a, Time const & b);
-extern bool operator> (Time const & a, Time const & b);
-extern bool operator>= (Time const & a, Time const & b);
-extern std::ostream & operator<< (std::ostream & s, Time const & t);
-extern Time operator+ (Time a, Time b);
-extern Time operator- (Time a, Time b);
-extern float operator/ (Time a, Time const & b);
-
 }
 
 #endif