X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ftypes.h;h=607c9e275098ba840af9395bbfbe7b979afee55c;hb=92f024ea58c7279b8096e5e9f60f9cb2613e8a91;hp=105432f83508cd43be07cf7f430f8c66f76fbf4c;hpb=f9068dcbfbb09082e29e2a779ef1a7a2f6ee849e;p=dcpomatic.git

diff --git a/src/lib/types.h b/src/lib/types.h
index 105432f83..607c9e275 100644
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -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/>.
 
 */
 
@@ -30,7 +31,7 @@
 class Content;
 class VideoContent;
 class AudioContent;
-class SubtitleContent;
+class TextContent;
 class FFmpegContent;
 
 namespace cxml {
@@ -47,10 +48,42 @@ 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)
+
+/** 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 in the main DCP-o-matic listens for replies to DCPOMATIC_HELLO from servers */
+#define MAIN_SERVER_PRESENCE_PORT (Config::instance()->server_port_base()+2)
+/** Port on which EncodeServerFinder in the batch converter listens for replies to DCPOMATIC_HELLO from servers */
+#define BATCH_SERVER_PRESENCE_PORT (Config::instance()->server_port_base()+3)
+/** Port on which batch converter listens for job requests */
+#define BATCH_JOB_PORT (Config::instance()->server_port_base()+4)
+/** Port on which player listens for play requests */
+#define PLAYER_PLAY_PORT (Config::instance()->server_port_base()+5)
+
 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 Frame;
@@ -58,6 +91,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,
@@ -67,6 +102,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,
@@ -91,6 +129,44 @@ enum ReelType
 	REELTYPE_BY_LENGTH
 };
 
+enum ChangeType
+{
+	CHANGE_TYPE_PENDING,
+	CHANGE_TYPE_DONE,
+	CHANGE_TYPE_CANCELLED
+};
+
+/** Type of captions.
+ *
+ *  The generally accepted definitions seem to be:
+ *  - subtitles: text for an audience who doesn't speak the film's language
+ *  - captions:  text for a hearing-impaired audience
+ *  - open:      on-screen
+ *  - closed:    only visible by some audience members
+ *
+ *  At the moment DoM supports open subtitles and closed captions.
+ *
+ *  There is some use of the word `subtitle' in the code which may mean
+ *  caption in some contexts.
+ */
+enum TextType
+{
+	TEXT_UNKNOWN,
+	TEXT_OPEN_SUBTITLE,
+	TEXT_CLOSED_CAPTION,
+	TEXT_COUNT
+};
+
+extern std::string text_type_to_string (TextType t);
+extern std::string text_type_to_name (TextType t);
+extern TextType string_to_text_type (std::string s);
+
+enum ExportFormat
+{
+	EXPORT_FORMAT_PRORES,
+	EXPORT_FORMAT_H264
+};
+
 /** @struct Crop
  *  @brief A description of the crop of an image or video.
  */
@@ -98,7 +174,7 @@ struct Crop
 {
 	Crop () : left (0), right (0), top (0), bottom (0) {}
 	Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
-	Crop (boost::shared_ptr<cxml::Node>);
+	explicit Crop (boost::shared_ptr<cxml::Node>);
 
 	/** Number of pixels to remove from the left-hand side */
 	int left;