/*
- Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2016 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 DVDOMATIC_TYPES_H
-#define DVDOMATIC_TYPES_H
+#ifndef DCPOMATIC_TYPES_H
+#define DCPOMATIC_TYPES_H
-#include <vector>
+#include "position.h"
+#include "rect.h"
+#include <dcp/util.h>
#include <boost/shared_ptr.hpp>
-#include <libdcp/util.h>
+#include <vector>
+#include <stdint.h>
class Content;
+class VideoContent;
+class AudioContent;
+class CaptionContent;
+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
+ */
+#define SERVER_LINK_VERSION (64+0)
+
+/** 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
+
+ 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<boost::shared_ptr<Content> > ContentList;
-typedef int64_t ContentAudioFrame;
-typedef int ContentVideoFrame;
+typedef std::vector<boost::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
+{
+ PART_LEFT_HALF,
+ PART_RIGHT_HALF,
+ PART_TOP_HALF,
+ PART_BOTTOM_HALF,
+ PART_WHOLE
+};
+
+enum ReelType
+{
+ REELTYPE_SINGLE,
+ REELTYPE_BY_VIDEO_CONTENT,
+ REELTYPE_BY_LENGTH
+};
+
+enum CaptionType
+{
+ CAPTION_OPEN,
+ CAPTION_CLOSED,
+ CAPTION_COUNT
+};
+
+extern std::string caption_type_to_string (CaptionType t);
+extern CaptionType string_to_caption_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;
int top;
/** Number of pixels to remove from the bottom */
int bottom;
-};
-extern bool operator== (Crop const & a, Crop const & b);
-extern bool operator!= (Crop const & a, Crop const & b);
+ dcp::Size apply (dcp::Size s, int minimum = 4) const {
+ s.width -= left + right;
+ s.height -= top + bottom;
-/** @struct Position
- * @brief A position.
- */
-struct Position
-{
- Position ()
- : x (0)
- , y (0)
- {}
+ if (s.width < minimum) {
+ s.width = minimum;
+ }
- Position (int x_, int y_)
- : x (x_)
- , y (y_)
- {}
+ if (s.height < minimum) {
+ s.height = minimum;
+ }
+
+ return s;
+ }
- /** x coordinate */
- int x;
- /** y coordinate */
- int y;
+ void as_xml (xmlpp::Node *) const;
};
-/** @struct Rect
- * @brief A rectangle.
- */
-struct Rect
+struct CPLSummary
{
- Rect ()
- : x (0)
- , y (0)
- , width (0)
- , height (0)
+ CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f)
+ : dcp_directory (d)
+ , cpl_id (i)
+ , cpl_annotation_text (a)
+ , cpl_file (f)
{}
- Rect (int x_, int y_, int w_, int h_)
- : x (x_)
- , y (y_)
- , width (w_)
- , height (h_)
- {}
+ std::string dcp_directory;
+ std::string cpl_id;
+ std::string cpl_annotation_text;
+ boost::filesystem::path cpl_file;
+};
- int x;
- int y;
- int width;
- int height;
+extern bool operator== (Crop const & a, Crop const & b);
+extern bool operator!= (Crop const & a, Crop const & b);
- Position position () const {
- return Position (x, y);
- }
+enum Resolution {
+ RESOLUTION_2K,
+ RESOLUTION_4K
+};
- libdcp::Size size () const {
- return libdcp::Size (width, height);
- }
+std::string resolution_to_string (Resolution);
+Resolution string_to_resolution (std::string);
- Rect intersection (Rect const & other) const;
+enum Protocol {
+ PROTOCOL_SCP,
+ PROTOCOL_FTP
};
#endif