Make terminate_threads() less likely to leave _threads containing invalid pointers.
[dcpomatic.git] / src / lib / types.h
index 041db1786ea6c2653eba64c97161898b530a76c7..94e101a3d682a43127eec28667c54bbe1ffb24bc 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;
 
@@ -116,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.
  */
@@ -123,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;
@@ -152,24 +203,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
@@ -178,9 +236,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