swaroop: Disable play/stop/pause and slider during ad content.
[dcpomatic.git] / src / lib / types.h
index ab51e38a9d7a1f8dabd3f749847928b36450bdf9..607c9e275098ba840af9395bbfbe7b979afee55c 100644 (file)
@@ -31,7 +31,7 @@
 class Content;
 class VideoContent;
 class AudioContent;
-class SubtitleContent;
+class TextContent;
 class FFmpegContent;
 
 namespace cxml {
@@ -70,6 +70,19 @@ namespace xmlpp {
 */
 #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<FFmpegContent> > FFmpegContentList;
 
@@ -78,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,
@@ -87,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,
@@ -111,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.
  */
@@ -118,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;