src/lib/types.h

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_TYPES_H
  22 #define DCPOMATIC_TYPES_H
  23
  24 #include "position.h"
  25 #include "rect.h"
  26 #include <dcp/util.h>
  27 #include <vector>
  28 #include <stdint.h>
  29
  30 class Content;
  31 class VideoContent;
  32 class AudioContent;
  33 class TextContent;
  34 class FFmpegContent;
  35
  36 namespace cxml {
  37         class Node;
  38 }
  39
  40 namespace xmlpp {
  41         class Node;
  42 }
  43
  44 /** The version number of the protocol used to communicate
  45  *  with servers.  Intended to be bumped when incompatibilities
  46  *  are introduced.  v2 uses 64+n
  47  *
  48  *  64 - first version used
  49  *  65 - v2.16.0 - checksums added to communication
  50  */
  51 #define SERVER_LINK_VERSION (64+1)
  52
  53 /** A film of F seconds at f FPS will be Ff frames;
  54     Consider some delta FPS d, so if we run the same
  55     film at (f + d) FPS it will last F(f + d) seconds.
  56
  57     Hence the difference in length over the length of the film will
  58     be F(f + d) - Ff frames
  59     = Ff + Fd - Ff frames
  60     = Fd frames
  61     = Fd/f seconds
  62
  63     So if we accept a difference of 1 frame, ie 1/f seconds, we can
  64     say that
  65
  66     1/f = Fd/f
  67     ie 1 = Fd
  68     ie d = 1/F
  69
  70     So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
  71     FPS error is 1/F ~= 0.0001 ~= 1e-4
  72 */
  73 #define VIDEO_FRAME_RATE_EPSILON (1e-4)
  74
  75 /** Port on which EncodeServer listens for frame encoding requests */
  76 #define ENCODE_FRAME_PORT (Config::instance()->server_port_base())
  77 /** Port on which EncodeServer listens for DCPOMATIC_HELLO from masters */
  78 #define HELLO_PORT (Config::instance()->server_port_base()+1)
  79 /** Port on which EncodeServerFinder in the main DCP-o-matic listens for replies to DCPOMATIC_HELLO from servers */
  80 #define MAIN_SERVER_PRESENCE_PORT (Config::instance()->server_port_base()+2)
  81 /** Port on which EncodeServerFinder in the batch converter listens for replies to DCPOMATIC_HELLO from servers */
  82 #define BATCH_SERVER_PRESENCE_PORT (Config::instance()->server_port_base()+3)
  83 /** Port on which batch converter listens for job requests */
  84 #define BATCH_JOB_PORT (Config::instance()->server_port_base()+4)
  85 /** Port on which player listens for play requests */
  86 #define PLAYER_PLAY_PORT (Config::instance()->server_port_base()+5)
  87
  88 typedef std::vector<std::shared_ptr<Content>> ContentList;
  89 typedef std::vector<std::shared_ptr<FFmpegContent>> FFmpegContentList;
  90
  91 typedef int64_t Frame;
  92
  93 enum class VideoFrameType
  94 {
  95         TWO_D,
  96         /** `True' 3D content, e.g. 3D DCPs */
  97         THREE_D,
  98         THREE_D_LEFT_RIGHT,
  99         THREE_D_TOP_BOTTOM,
 100         THREE_D_ALTERNATE,
 101         /** This content is all the left frames of some 3D */
 102         THREE_D_LEFT,
 103         /** This content is all the right frames of some 3D */
 104         THREE_D_RIGHT
 105 };
 106
 107 std::string video_frame_type_to_string (VideoFrameType);
 108 VideoFrameType string_to_video_frame_type (std::string);
 109
 110 enum class Eyes
 111 {
 112         BOTH,
 113         LEFT,
 114         RIGHT,
 115         COUNT
 116 };
 117
 118 enum class Part
 119 {
 120         LEFT_HALF,
 121         RIGHT_HALF,
 122         TOP_HALF,
 123         BOTTOM_HALF,
 124         WHOLE
 125 };
 126
 127 enum class ReelType
 128 {
 129         SINGLE,
 130         BY_VIDEO_CONTENT,
 131         BY_LENGTH
 132 };
 133
 134
 135 enum class VideoRange
 136 {
 137         FULL, ///< full,  or "JPEG" (0-255 for 8-bit)
 138         VIDEO ///< video, or "MPEG" (16-235 for 8-bit)
 139 };
 140
 141 extern std::string video_range_to_string (VideoRange r);
 142 extern VideoRange string_to_video_range (std::string s);
 143
 144
 145 /** Type of captions.
 146  *
 147  *  The generally accepted definitions seem to be:
 148  *  - subtitles: text for an audience who doesn't speak the film's language
 149  *  - captions:  text for a hearing-impaired audience
 150  *  - open:      on-screen
 151  *  - closed:    only visible by some audience members
 152  *
 153  *  At the moment DoM supports open subtitles and closed captions.
 154  *
 155  *  There is some use of the word `subtitle' in the code which may mean
 156  *  caption in some contexts.
 157  */
 158 enum class TextType
 159 {
 160         UNKNOWN,
 161         OPEN_SUBTITLE,
 162         CLOSED_CAPTION,
 163         COUNT
 164 };
 165
 166 extern std::string text_type_to_string (TextType t);
 167 extern std::string text_type_to_name (TextType t);
 168 extern TextType string_to_text_type (std::string s);
 169
 170 enum class ExportFormat
 171 {
 172         PRORES,
 173         H264_AAC,
 174         H264_PCM,
 175         SUBTITLES_DCP
 176 };
 177
 178 /** @struct Crop
 179  *  @brief A description of the crop of an image or video.
 180  */
 181 struct Crop
 182 {
 183         Crop () : left (0), right (0), top (0), bottom (0) {}
 184         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
 185         explicit Crop (std::shared_ptr<cxml::Node>);
 186
 187         /** Number of pixels to remove from the left-hand side */
 188         int left;
 189         /** Number of pixels to remove from the right-hand side */
 190         int right;
 191         /** Number of pixels to remove from the top */
 192         int top;
 193         /** Number of pixels to remove from the bottom */
 194         int bottom;
 195
 196         dcp::Size apply (dcp::Size s, int minimum = 4) const {
 197                 s.width -= left + right;
 198                 s.height -= top + bottom;
 199
 200                 if (s.width < minimum) {
 201                         s.width = minimum;
 202                 }
 203
 204                 if (s.height < minimum) {
 205                         s.height = minimum;
 206                 }
 207
 208                 return s;
 209         }
 210
 211         void as_xml (xmlpp::Node *) const;
 212 };
 213
 214 extern bool operator== (Crop const & a, Crop const & b);
 215 extern bool operator!= (Crop const & a, Crop const & b);
 216
 217 struct CPLSummary
 218 {
 219         CPLSummary (boost::filesystem::path p);
 220
 221         CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f, bool e, time_t t)
 222                 : dcp_directory (d)
 223                 , cpl_id (i)
 224                 , cpl_annotation_text (a)
 225                 , cpl_file (f)
 226                 , encrypted (e)
 227                 , last_write_time (t)
 228         {}
 229
 230         std::string dcp_directory;
 231         std::string cpl_id;
 232         boost::optional<std::string> cpl_annotation_text;
 233         boost::filesystem::path cpl_file;
 234         /** true if this CPL has any encrypted assets */
 235         bool encrypted;
 236         time_t last_write_time;
 237 };
 238
 239 enum class Resolution {
 240         TWO_K,
 241         FOUR_K
 242 };
 243
 244 std::string resolution_to_string (Resolution);
 245 Resolution string_to_resolution (std::string);
 246
 247 enum class FileTransferProtocol {
 248         SCP,
 249         FTP
 250 };
 251
 252 enum class EmailProtocol {
 253         AUTO,
 254         PLAIN,
 255         STARTTLS,
 256         SSL
 257 };
 258
 259
 260 class NamedChannel
 261 {
 262 public:
 263         NamedChannel (std::string name_, int index_)
 264                 : name(name_)
 265                 , index(index_)
 266         {}
 267
 268         std::string name;
 269         int index;
 270 };
 271
 272
 273 bool operator== (NamedChannel const& a, NamedChannel const& b);
 274
 275 #endif