/*
- 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.
*/
+
#ifndef DCPOMATIC_TYPES_H
#define DCPOMATIC_TYPES_H
+
#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 TextContent;
class FFmpegContent;
-namespace cxml {
- class Node;
-}
-
-namespace xmlpp {
- class Node;
-}
/** 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
/** 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
-{
- 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,
- /** This content is all the left frames of some 3D */
- VIDEO_FRAME_TYPE_3D_LEFT,
- /** This content is all the right frames of some 3D */
- 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,
- EYES_LEFT,
- EYES_RIGHT,
- EYES_COUNT
-};
-
-enum Part
+enum class Eyes
{
- PART_LEFT_HALF,
- PART_RIGHT_HALF,
- PART_TOP_HALF,
- PART_BOTTOM_HALF,
- PART_WHOLE
+ BOTH,
+ LEFT,
+ RIGHT,
+ COUNT
};
-enum ReelType
+enum class Part
{
- REELTYPE_SINGLE,
- REELTYPE_BY_VIDEO_CONTENT,
- REELTYPE_BY_LENGTH
+ LEFT_HALF,
+ RIGHT_HALF,
+ TOP_HALF,
+ BOTTOM_HALF,
+ WHOLE
};
-/** 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
+enum class ReelType
{
- TEXT_UNKNOWN,
- TEXT_OPEN_SUBTITLE,
- TEXT_CLOSED_CAPTION,
- TEXT_COUNT
+ SINGLE,
+ BY_VIDEO_CONTENT,
+ BY_LENGTH
};
-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);
-
-/** @struct Crop
- * @brief A description of the crop of an image or video.
- */
-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>);
-
- /** Number of pixels to remove from the left-hand side */
- int left;
- /** Number of pixels to remove from the right-hand side */
- int right;
- /** Number of pixels to remove from the top */
- int top;
- /** Number of pixels to remove from the bottom */
- int bottom;
-
- dcp::Size apply (dcp::Size s, int minimum = 4) const {
- s.width -= left + right;
- s.height -= top + bottom;
-
- if (s.width < minimum) {
- s.width = minimum;
- }
-
- if (s.height < minimum) {
- s.height = minimum;
- }
-
- return s;
- }
-
- void as_xml (xmlpp::Node *) const;
-};
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 FileTransferProtocol {
+ SCP,
+ FTP
};
-std::string resolution_to_string (Resolution);
-Resolution string_to_resolution (std::string);
-
-enum Protocol {
- PROTOCOL_SCP,
- PROTOCOL_FTP
+enum class EmailProtocol {
+ AUTO,
+ PLAIN,
+ STARTTLS,
+ SSL
};
+
#endif