/*
- Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
- 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 <http://www.gnu.org/licenses/>.
*/
#ifndef DCPOMATIC_TYPES_H
#define DCPOMATIC_TYPES_H
+#include "position.h"
+#include "rect.h"
+#include <dcp/util.h>
#include <vector>
#include <stdint.h>
-#include <boost/shared_ptr.hpp>
-#include <dcp/util.h>
-#include "dcpomatic_time.h"
-#include "position.h"
class Content;
class VideoContent;
class AudioContent;
-class SubtitleContent;
+class TextContent;
class FFmpegContent;
-class AudioBuffers;
namespace cxml {
class Node;
/** The version number of the protocol used to communicate
* with servers. Intended to be bumped when incompatibilities
- * are introduced.
+ * are introduced. v2 uses 64+n
+ *
+ * 64 - first version used
+ * 65 - v2.16.0 - checksums added to communication
*/
-#define SERVER_LINK_VERSION 2
+#define SERVER_LINK_VERSION (64+1)
-typedef std::vector<boost::shared_ptr<Content> > ContentList;
-typedef std::vector<boost::shared_ptr<VideoContent> > VideoContentList;
-typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
-typedef std::vector<boost::shared_ptr<SubtitleContent> > SubtitleContentList;
-typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
+/** 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.
-typedef int64_t VideoFrame;
-typedef int64_t AudioFrame;
+ 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
-/* XXX -> DCPAudio */
-struct TimedAudioBuffers
-{
- TimedAudioBuffers ()
- : time (0)
- {}
-
- TimedAudioBuffers (boost::shared_ptr<AudioBuffers> a, DCPTime t)
- : audio (a)
- , time (t)
- {}
-
- boost::shared_ptr<AudioBuffers> audio;
- DCPTime time;
-};
+ 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<std::shared_ptr<Content>> ContentList;
+typedef std::vector<std::shared_ptr<FFmpegContent>> FFmpegContentList;
-enum VideoFrameType
+typedef int64_t Frame;
+
+enum class VideoFrameType
{
- VIDEO_FRAME_TYPE_2D,
- VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
- VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
- VIDEO_FRAME_TYPE_3D_ALTERNATE,
+ TWO_D,
+ /** `True' 3D content, e.g. 3D DCPs */
+ 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 class Eyes
+{
+ BOTH,
+ LEFT,
+ RIGHT,
+ COUNT
+};
+
+enum class Part
+{
+ LEFT_HALF,
+ RIGHT_HALF,
+ TOP_HALF,
+ BOTTOM_HALF,
+ WHOLE
+};
+
+enum class ReelType
+{
+ 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)
};
-enum Eyes
+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 class TextType
{
- EYES_BOTH,
- EYES_LEFT,
- EYES_RIGHT,
- EYES_COUNT
+ UNKNOWN,
+ OPEN_SUBTITLE,
+ CLOSED_CAPTION,
+ COUNT
};
-enum Part
+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
{
- PART_LEFT_HALF,
- PART_RIGHT_HALF,
- PART_TOP_HALF,
- PART_BOTTOM_HALF,
- PART_WHOLE
+ PRORES,
+ H264_AAC,
+ H264_PCM,
+ SUBTITLES_DCP
};
/** @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 (std::shared_ptr<cxml::Node>);
/** Number of pixels to remove from the left-hand side */
int left;
if (s.height < minimum) {
s.height = minimum;
}
-
+
return s;
}
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 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
projects / dcpomatic.git / blobdiff