C++11 tidying.
[dcpomatic.git] / src / lib / types.h
index b2bff78fa67f23a6e4c70e05ffe6315cacb02321..6fbad21883084da078dcc7ed09d7c78d51921922 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "position.h"
 #include "rect.h"
 #include <dcp/util.h>
-#include <boost/shared_ptr.hpp>
 #include <vector>
 #include <stdint.h>
 
 class Content;
 class VideoContent;
 class AudioContent;
-class CaptionContent;
+class TextContent;
 class FFmpegContent;
 
 namespace cxml {
@@ -45,8 +44,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
@@ -83,71 +85,95 @@ namespace xmlpp {
 /** 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;
+typedef std::vector<std::shared_ptr<Content>> ContentList;
+typedef std::vector<std::shared_ptr<FFmpegContent>> FFmpegContentList;
 
 typedef int64_t Frame;
 
-enum VideoFrameType
+enum class VideoFrameType
 {
-       VIDEO_FRAME_TYPE_2D,
+       TWO_D,
        /** `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,
+       THREE_D,
+       THREE_D_LEFT_RIGHT,
+       THREE_D_TOP_BOTTOM,
+       THREE_D_ALTERNATE,
        /** This content is all the left frames of some 3D */
-       VIDEO_FRAME_TYPE_3D_LEFT,
+       THREE_D_LEFT,
        /** This content is all the right frames of some 3D */
-       VIDEO_FRAME_TYPE_3D_RIGHT
+       THREE_D_RIGHT
 };
 
 std::string video_frame_type_to_string (VideoFrameType);
 VideoFrameType string_to_video_frame_type (std::string);
 
-enum Eyes
+enum class Eyes
 {
-       EYES_BOTH,
-       EYES_LEFT,
-       EYES_RIGHT,
-       EYES_COUNT
+       BOTH,
+       LEFT,
+       RIGHT,
+       COUNT
 };
 
-enum Part
+enum class Part
 {
-       PART_LEFT_HALF,
-       PART_RIGHT_HALF,
-       PART_TOP_HALF,
-       PART_BOTTOM_HALF,
-       PART_WHOLE
+       LEFT_HALF,
+       RIGHT_HALF,
+       TOP_HALF,
+       BOTTOM_HALF,
+       WHOLE
 };
 
-enum ReelType
+enum class ReelType
 {
-       REELTYPE_SINGLE,
-       REELTYPE_BY_VIDEO_CONTENT,
-       REELTYPE_BY_LENGTH
+       SINGLE,
+       BY_VIDEO_CONTENT,
+       BY_LENGTH
 };
 
+
+enum class VideoRange
+{
+       FULL, ///< full,  or "JPEG" (0-255 for 8-bit)
+       VIDEO ///< video, or "MPEG" (16-235 for 8-bit)
+};
+
+extern std::string video_range_to_string (VideoRange r);
+extern VideoRange string_to_video_range (std::string s);
+
+
 /** Type of captions.
- *  For better or worse DoM has uses two names for text that appears
- *  with the DCP:
  *
- *  open captions:   text that is shown to everybody on-screen (aka subtitles).
- *  closed captions: text that is shown to some viewers using some other method.
+ *  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
  *
- *  There is also still use of the word `subtitle' in the code; these are the
- *  same as open captions in DoM.
+ *  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 CaptionType
+enum class TextType
 {
-       CAPTION_OPEN,
-       CAPTION_CLOSED,
-       CAPTION_COUNT
+       UNKNOWN,
+       OPEN_SUBTITLE,
+       CLOSED_CAPTION,
+       COUNT
 };
 
-extern std::string caption_type_to_string (CaptionType t);
-extern CaptionType string_to_caption_type (std::string s);
+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 class ExportFormat
+{
+       PRORES,
+       H264_AAC,
+       H264_PCM,
+       SUBTITLES_DCP
+};
 
 /** @struct Crop
  *  @brief A description of the crop of an image or video.
@@ -156,7 +182,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) {}
-       explicit Crop (boost::shared_ptr<cxml::Node>);
+       explicit Crop (std::shared_ptr<cxml::Node>);
 
        /** Number of pixels to remove from the left-hand side */
        int left;
@@ -185,35 +211,65 @@ 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::optional<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
+enum class Resolution {
+       TWO_K,
+       FOUR_K
 };
 
 std::string resolution_to_string (Resolution);
 Resolution string_to_resolution (std::string);
 
-enum Protocol {
-       PROTOCOL_SCP,
-       PROTOCOL_FTP
+enum class FileTransferProtocol {
+       SCP,
+       FTP
+};
+
+enum class EmailProtocol {
+       AUTO,
+       PLAIN,
+       STARTTLS,
+       SSL
+};
+
+
+class NamedChannel
+{
+public:
+       NamedChannel (std::string name_, int index_)
+               : name(name_)
+               , index(index_)
+       {}
+
+       std::string name;
+       int index;
 };
 
+
+bool operator== (NamedChannel const& a, NamedChannel const& b);
+
 #endif