Extract common code out into kdm_for_screen()

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

diff --git a/src/lib/types.h b/src/lib/types.h
index ed3746f45ae5c99e76cbaea0461130273cccec0f..50eed9aa1033debe460be604cfb4421a480c5461 100644 (file)
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -31,7 +31,7 @@
 class Content;
 class VideoContent;
 class AudioContent;
-class SubtitleContent;
+class TextContent;
 class FFmpegContent;
 
 namespace cxml {
@@ -45,8 +45,11 @@ namespace xmlpp {
 /** The version number of the protocol used to communicate
  *  with servers.  Intended to be bumped when incompatibilities
  *  are introduced.  v2 uses 64+n
+ *
+ *  64 - first version used
+ *  65 - v2.16.0 - checksums added to communication
  */
-#define SERVER_LINK_VERSION (64+0)
+#define SERVER_LINK_VERSION (64+1)
 
 /** A film of F seconds at f FPS will be Ff frames;
     Consider some delta FPS d, so if we run the same
@@ -80,6 +83,8 @@ namespace xmlpp {
 #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;
@@ -127,6 +132,52 @@ enum ReelType
        REELTYPE_BY_LENGTH
 };
 
+enum ChangeType
+{
+       CHANGE_TYPE_PENDING,
+       CHANGE_TYPE_DONE,
+       CHANGE_TYPE_CANCELLED
+};
+
+enum VideoRange
+{
+       VIDEO_RANGE_FULL, ///< full,  or "JPEG" (0-255 for 8-bit)
+       VIDEO_RANGE_VIDEO ///< video, or "MPEG" (16-235 for 8-bit)
+};
+
+/** 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_AAC,
+       EXPORT_FORMAT_H264_PCM,
+       EXPORT_FORMAT_SUBTITLES_DCP
+};
+
 /** @struct Crop
  *  @brief A description of the crop of an image or video.
  */
@@ -163,24 +214,31 @@ struct Crop
        void as_xml (xmlpp::Node *) const;
 };
 
+extern bool operator== (Crop const & a, Crop const & b);
+extern bool operator!= (Crop const & a, Crop const & b);
+
 struct CPLSummary
 {
-       CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f)
+       CPLSummary (boost::filesystem::path p);
+
+       CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f, bool e, time_t t)
                : dcp_directory (d)
                , cpl_id (i)
                , cpl_annotation_text (a)
                , cpl_file (f)
+               , encrypted (e)
+               , last_write_time (t)
        {}
 
        std::string dcp_directory;
        std::string cpl_id;
        std::string cpl_annotation_text;
        boost::filesystem::path cpl_file;
+       /** true if this CPL has any encrypted assets */
+       bool encrypted;
+       time_t last_write_time;
 };
 
-extern bool operator== (Crop const & a, Crop const & b);
-extern bool operator!= (Crop const & a, Crop const & b);
-
 enum Resolution {
        RESOLUTION_2K,
        RESOLUTION_4K
@@ -189,9 +247,16 @@ enum Resolution {
 std::string resolution_to_string (Resolution);
 Resolution string_to_resolution (std::string);
 
-enum Protocol {
-       PROTOCOL_SCP,
-       PROTOCOL_FTP
+enum FileTransferProtocol {
+       FILE_TRANSFER_PROTOCOL_SCP,
+       FILE_TRANSFER_PROTOCOL_FTP
+};
+
+enum EmailProtocol {
+       EMAIL_PROTOCOL_AUTO,
+       EMAIL_PROTOCOL_PLAIN,
+       EMAIL_PROTOCOL_STARTTLS,
+       EMAIL_PROTOCOL_SSL
 };
 
 #endif