0702c873405c07a823bb13ccbe03150052bf6fe4
[dcpomatic.git] / src / lib / types.h
1 /*
2     Copyright (C) 2013-2016 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 <boost/shared_ptr.hpp>
28 #include <vector>
29 #include <stdint.h>
30
31 class Content;
32 class VideoContent;
33 class AudioContent;
34 class SubtitleContent;
35 class FFmpegContent;
36
37 namespace cxml {
38         class Node;
39 }
40
41 namespace xmlpp {
42         class Node;
43 }
44
45 /** The version number of the protocol used to communicate
46  *  with servers.  Intended to be bumped when incompatibilities
47  *  are introduced.  v2 uses 64+n
48  */
49 #define SERVER_LINK_VERSION (64+0)
50
51 /** A film of F seconds at f FPS will be Ff frames;
52     Consider some delta FPS d, so if we run the same
53     film at (f + d) FPS it will last F(f + d) seconds.
54
55     Hence the difference in length over the length of the film will
56     be F(f + d) - Ff frames
57     = Ff + Fd - Ff frames
58     = Fd frames
59     = Fd/f seconds
60
61     So if we accept a difference of 1 frame, ie 1/f seconds, we can
62     say that
63
64     1/f = Fd/f
65     ie 1 = Fd
66     ie d = 1/F
67
68     So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
69     FPS error is 1/F ~= 0.0001 ~= 1e-4
70 */
71 #define VIDEO_FRAME_RATE_EPSILON (1e-4)
72
73 /** Port on which EncodeServer listens for frame encoding requests */
74 #define ENCODE_FRAME_PORT (Config::instance()->server_port_base())
75 /** Port on which EncodeServer listens for DCPOMATIC_HELLO from masters */
76 #define HELLO_PORT (Config::instance()->server_port_base()+1)
77 /** Port on which EncodeServerFinder listens for replies to DCPOMATIC_HELLO from servers */
78 #define SERVER_PRESENCE_PORT (Config::instance()->server_port_base()+2)
79 /** Port on which batch converter listens for job requests */
80 #define BATCH_JOB_PORT (Config::instance()->server_port_base()+3)
81
82 typedef std::vector<boost::shared_ptr<Content> > ContentList;
83 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
84
85 typedef int64_t Frame;
86
87 enum VideoFrameType
88 {
89         VIDEO_FRAME_TYPE_2D,
90         /** `True' 3D content, e.g. 3D DCPs */
91         VIDEO_FRAME_TYPE_3D,
92         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
93         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
94         VIDEO_FRAME_TYPE_3D_ALTERNATE,
95         /** This content is all the left frames of some 3D */
96         VIDEO_FRAME_TYPE_3D_LEFT,
97         /** This content is all the right frames of some 3D */
98         VIDEO_FRAME_TYPE_3D_RIGHT
99 };
100
101 std::string video_frame_type_to_string (VideoFrameType);
102 VideoFrameType string_to_video_frame_type (std::string);
103
104 enum Eyes
105 {
106         EYES_BOTH,
107         EYES_LEFT,
108         EYES_RIGHT,
109         EYES_COUNT
110 };
111
112 enum Part
113 {
114         PART_LEFT_HALF,
115         PART_RIGHT_HALF,
116         PART_TOP_HALF,
117         PART_BOTTOM_HALF,
118         PART_WHOLE
119 };
120
121 enum ReelType
122 {
123         REELTYPE_SINGLE,
124         REELTYPE_BY_VIDEO_CONTENT,
125         REELTYPE_BY_LENGTH
126 };
127
128 /** @struct Crop
129  *  @brief A description of the crop of an image or video.
130  */
131 struct Crop
132 {
133         Crop () : left (0), right (0), top (0), bottom (0) {}
134         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
135         Crop (boost::shared_ptr<cxml::Node>);
136
137         /** Number of pixels to remove from the left-hand side */
138         int left;
139         /** Number of pixels to remove from the right-hand side */
140         int right;
141         /** Number of pixels to remove from the top */
142         int top;
143         /** Number of pixels to remove from the bottom */
144         int bottom;
145
146         dcp::Size apply (dcp::Size s, int minimum = 4) const {
147                 s.width -= left + right;
148                 s.height -= top + bottom;
149
150                 if (s.width < minimum) {
151                         s.width = minimum;
152                 }
153
154                 if (s.height < minimum) {
155                         s.height = minimum;
156                 }
157
158                 return s;
159         }
160
161         void as_xml (xmlpp::Node *) const;
162 };
163
164 struct CPLSummary
165 {
166         CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f)
167                 : dcp_directory (d)
168                 , cpl_id (i)
169                 , cpl_annotation_text (a)
170                 , cpl_file (f)
171         {}
172
173         std::string dcp_directory;
174         std::string cpl_id;
175         std::string cpl_annotation_text;
176         boost::filesystem::path cpl_file;
177 };
178
179 extern bool operator== (Crop const & a, Crop const & b);
180 extern bool operator!= (Crop const & a, Crop const & b);
181
182 enum Resolution {
183         RESOLUTION_2K,
184         RESOLUTION_4K
185 };
186
187 std::string resolution_to_string (Resolution);
188 Resolution string_to_resolution (std::string);
189
190 enum Protocol {
191         PROTOCOL_SCP,
192         PROTOCOL_FTP
193 };
194
195 #endif