Merge branch 'master' into 2.0
[dcpomatic.git] / src / lib / types.h
1 /*
2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef DCPOMATIC_TYPES_H
21 #define DCPOMATIC_TYPES_H
22
23 #include <vector>
24 #include <stdint.h>
25 #include <boost/shared_ptr.hpp>
26 #include <dcp/util.h>
27
28 class Content;
29 class VideoContent;
30 class AudioContent;
31 class SubtitleContent;
32 class FFmpegContent;
33 class AudioBuffers;
34
35 /** The version number of the protocol used to communicate
36  *  with servers.  Intended to be bumped when incompatibilities
37  *  are introduced.
38  */
39 #define SERVER_LINK_VERSION 1
40
41 typedef int64_t DCPTime;
42 #define TIME_MAX INT64_MAX
43 #define TIME_HZ  ((DCPTime) 96000)
44 typedef int64_t ContentTime;
45 typedef int64_t AudioFrame;
46 typedef int     VideoFrame;
47 typedef std::vector<boost::shared_ptr<Content> > ContentList;
48 typedef std::vector<boost::shared_ptr<VideoContent> > VideoContentList;
49 typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
50 typedef std::vector<boost::shared_ptr<SubtitleContent> > SubtitleContentList;
51 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
52
53 template<class T>
54 struct TimedAudioBuffers
55 {
56         TimedAudioBuffers ()
57                 : time (0)
58         {}
59         
60         TimedAudioBuffers (boost::shared_ptr<AudioBuffers> a, T t)
61                 : audio (a)
62                 , time (t)
63         {}
64         
65         boost::shared_ptr<AudioBuffers> audio;
66         T time;
67 };
68
69 enum VideoFrameType
70 {
71         VIDEO_FRAME_TYPE_2D,
72         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
73         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM
74 };
75
76 enum Eyes
77 {
78         EYES_BOTH,
79         EYES_LEFT,
80         EYES_RIGHT,
81         EYES_COUNT
82 };
83
84 /** @struct Crop
85  *  @brief A description of the crop of an image or video.
86  */
87 struct Crop
88 {
89         Crop () : left (0), right (0), top (0), bottom (0) {}
90         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
91
92         /** Number of pixels to remove from the left-hand side */
93         int left;
94         /** Number of pixels to remove from the right-hand side */
95         int right;
96         /** Number of pixels to remove from the top */
97         int top;
98         /** Number of pixels to remove from the bottom */
99         int bottom;
100
101         dcp::Size apply (dcp::Size s, int minimum = 4) const {
102                 s.width -= left + right;
103                 s.height -= top + bottom;
104
105                 if (s.width < minimum) {
106                         s.width = minimum;
107                 }
108
109                 if (s.height < minimum) {
110                         s.height = minimum;
111                 }
112                 
113                 return s;
114         }
115 };
116
117 extern bool operator== (Crop const & a, Crop const & b);
118 extern bool operator!= (Crop const & a, Crop const & b);
119
120 enum Resolution {
121         RESOLUTION_2K,
122         RESOLUTION_4K
123 };
124
125 std::string resolution_to_string (Resolution);
126 Resolution string_to_resolution (std::string);
127
128 #endif