Another missing include.
[dcpomatic.git] / src / lib / types.h
index 2bc6fa3a42894821042ca2109eda9e0165cfb5c1..041db1786ea6c2653eba64c97161898b530a76c7 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic 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,
+    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -47,8 +48,29 @@ namespace xmlpp {
  */
 #define SERVER_LINK_VERSION (64+0)
 
+/** A film of F seconds at f FPS will be Ff frames;
+    Consider some delta FPS d, so if we run the same
+    film at (f + d) FPS it will last F(f + d) seconds.
+
+    Hence the difference in length over the length of the film will
+    be F(f + d) - Ff frames
+    = Ff + Fd - Ff frames
+    = Fd frames
+    = Fd/f seconds
+
+    So if we accept a difference of 1 frame, ie 1/f seconds, we can
+    say that
+
+    1/f = Fd/f
+    ie 1 = Fd
+    ie d = 1/F
+
+    So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
+    FPS error is 1/F ~= 0.0001 ~= 1e-4
+*/
+#define VIDEO_FRAME_RATE_EPSILON (1e-4)
+
 typedef std::vector<boost::shared_ptr<Content> > ContentList;
-typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
 
 typedef int64_t Frame;
@@ -56,6 +78,8 @@ typedef int64_t Frame;
 enum VideoFrameType
 {
        VIDEO_FRAME_TYPE_2D,
+       /** `True' 3D content, e.g. 3D DCPs */
+       VIDEO_FRAME_TYPE_3D,
        VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
        VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
        VIDEO_FRAME_TYPE_3D_ALTERNATE,
@@ -65,6 +89,9 @@ enum VideoFrameType
        VIDEO_FRAME_TYPE_3D_RIGHT
 };
 
+std::string video_frame_type_to_string (VideoFrameType);
+VideoFrameType string_to_video_frame_type (std::string);
+
 enum Eyes
 {
        EYES_BOTH,