Move ports around to allow master/server to coexist (#962).

[dcpomatic.git] / src / lib / types.h

diff --git a/src/lib/types.h b/src/lib/types.h
index 9a6a30b861d45344325507186f5c08b2b200ea42..0702c873405c07a823bb13ccbe03150052bf6fe4 100644 (file)
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -1,38 +1,38 @@
 /*
-    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/>.
 
 */
 
 #ifndef DCPOMATIC_TYPES_H
 #define DCPOMATIC_TYPES_H
 
+#include "position.h"
+#include "rect.h"
+#include <dcp/util.h>
+#include <boost/shared_ptr.hpp>
 #include <vector>
 #include <stdint.h>
-#include <boost/shared_ptr.hpp>
-#include <dcp/util.h>
-#include "dcpomatic_time.h"
-#include "position.h"
 
 class Content;
 class VideoContent;
 class AudioContent;
 class SubtitleContent;
 class FFmpegContent;
-class AudioBuffers;
 
 namespace cxml {
        class Node;
@@ -44,38 +44,51 @@ namespace xmlpp {
 
 /** The version number of the protocol used to communicate
  *  with servers.  Intended to be bumped when incompatibilities
- *  are introduced.
+ *  are introduced.  v2 uses 64+n
  */
-#define SERVER_LINK_VERSION 2
+#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)
+
+/** Port on which EncodeServer listens for frame encoding requests */
+#define ENCODE_FRAME_PORT (Config::instance()->server_port_base())
+/** Port on which EncodeServer listens for DCPOMATIC_HELLO from masters */
+#define HELLO_PORT (Config::instance()->server_port_base()+1)
+/** Port on which EncodeServerFinder listens for replies to DCPOMATIC_HELLO from servers */
+#define SERVER_PRESENCE_PORT (Config::instance()->server_port_base()+2)
+/** Port on which batch converter listens for job requests */
+#define BATCH_JOB_PORT (Config::instance()->server_port_base()+3)
 
 typedef std::vector<boost::shared_ptr<Content> > ContentList;
-typedef std::vector<boost::shared_ptr<VideoContent> > VideoContentList;
-typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
-typedef std::vector<boost::shared_ptr<SubtitleContent> > SubtitleContentList;
 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
 
-typedef int64_t VideoFrame;
-typedef int64_t AudioFrame;
-
-/* XXX -> DCPAudio */
-struct TimedAudioBuffers
-{
-       TimedAudioBuffers ()
-               : time (0)
-       {}
-       
-       TimedAudioBuffers (boost::shared_ptr<AudioBuffers> a, DCPTime t)
-               : audio (a)
-               , time (t)
-       {}
-       
-       boost::shared_ptr<AudioBuffers> audio;
-       DCPTime time;
-};
+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,
@@ -85,6 +98,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,
@@ -102,6 +118,13 @@ enum Part
        PART_WHOLE
 };
 
+enum ReelType
+{
+       REELTYPE_SINGLE,
+       REELTYPE_BY_VIDEO_CONTENT,
+       REELTYPE_BY_LENGTH
+};
+
 /** @struct Crop
  *  @brief A description of the crop of an image or video.
  */
@@ -131,7 +154,7 @@ struct Crop
                if (s.height < minimum) {
                        s.height = minimum;
                }
-               
+
                return s;
        }
 
@@ -146,7 +169,7 @@ struct CPLSummary
                , cpl_annotation_text (a)
                , cpl_file (f)
        {}
-       
+
        std::string dcp_directory;
        std::string cpl_id;
        std::string cpl_annotation_text;
@@ -164,4 +187,9 @@ enum Resolution {
 std::string resolution_to_string (Resolution);
 Resolution string_to_resolution (std::string);
 
+enum Protocol {
+       PROTOCOL_SCP,
+       PROTOCOL_FTP
+};
+
 #endif