X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ftypes.h;h=87b3fc753b36fcc19e3a05fbdadd218184afc56f;hp=8eabdbf27e74e46fc6ec07a80c307fe022685171;hb=dd9be86db6cde0afa5da0d1d1ac43b42e05dca26;hpb=65b331d32c383f3a9049f29bf03ab3fe3193b31a diff --git a/src/lib/types.h b/src/lib/types.h index 8eabdbf27..87b3fc753 100644 --- a/src/lib/types.h +++ b/src/lib/types.h @@ -1,19 +1,20 @@ /* Copyright (C) 2013-2016 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ @@ -23,14 +24,13 @@ #include "position.h" #include "rect.h" #include -#include #include #include class Content; class VideoContent; class AudioContent; -class SubtitleContent; +class TextContent; class FFmpegContent; namespace cxml { @@ -44,17 +44,57 @@ 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 + film at (f + d) FPS it will last F(f + d) seconds. + + Hence the difference in length over the length of the film will + be F(f + d) - Ff frames + = Ff + Fd - Ff frames + = Fd frames + = Fd/f seconds -typedef std::vector > ContentList; -typedef std::vector > FFmpegContentList; + So if we accept a difference of 1 frame, ie 1/f seconds, we can + say that + + 1/f = Fd/f + ie 1 = Fd + ie d = 1/F + + So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable + FPS error is 1/F ~= 0.0001 ~= 1e-4 +*/ +#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 > ContentList; +typedef std::vector > FFmpegContentList; 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, @@ -64,6 +104,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, @@ -88,6 +131,57 @@ 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) +}; + +extern std::string video_range_to_string (VideoRange r); +extern VideoRange string_to_video_range (std::string s); + + +/** 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. */ @@ -95,7 +189,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); + explicit Crop (std::shared_ptr); /** Number of pixels to remove from the left-hand side */ int left; @@ -124,24 +218,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 @@ -150,9 +251,32 @@ 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 +}; + + +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