2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #ifndef DCPOMATIC_VIDEO_CONTENT_H
23 #define DCPOMATIC_VIDEO_CONTENT_H
26 #include "colour_conversion.h"
27 #include "content_part.h"
28 #include "dcpomatic_time.h"
30 #include "user_property.h"
31 #include <dcp/language_tag.h>
32 #include <boost/thread/mutex.hpp>
41 class VideoContentProperty
45 static int const SIZE;
46 static int const FRAME_TYPE;
47 static int const CROP;
48 static int const COLOUR_CONVERSION;
49 static int const FADE_IN;
50 static int const FADE_OUT;
51 static int const RANGE;
52 static int const CUSTOM_RATIO;
53 static int const CUSTOM_SIZE;
54 static int const BURNT_SUBTITLE_LANGUAGE;
58 class VideoContent : public ContentPart, public std::enable_shared_from_this<VideoContent>
61 explicit VideoContent (Content* parent);
62 VideoContent (Content* parent, cxml::ConstNodePtr, int);
63 VideoContent (Content* parent, std::vector<std::shared_ptr<Content>>);
65 void as_xml (xmlpp::Node *) const;
66 std::string technical_summary () const;
67 std::string identifier () const;
68 void take_settings_from (std::shared_ptr<const VideoContent> c);
70 Frame length () const {
71 boost::mutex::scoped_lock lm (_mutex);
75 Frame length_after_3d_combine () const {
76 boost::mutex::scoped_lock lm (_mutex);
77 if (_frame_type == VideoFrameType::THREE_D_ALTERNATE) {
84 dcp::Size size () const {
85 boost::mutex::scoped_lock lm (_mutex);
89 void set_frame_type (VideoFrameType);
91 void set_left_crop (int);
92 void set_right_crop (int);
93 void set_top_crop (int);
94 void set_bottom_crop (int);
96 void set_custom_ratio (boost::optional<float> ratio);
97 void set_custom_size (boost::optional<dcp::Size> size);
99 void unset_colour_conversion ();
100 void set_colour_conversion (ColourConversion);
102 void set_fade_in (Frame);
103 void set_fade_out (Frame);
105 void set_range (VideoRange);
108 void set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language);
110 VideoFrameType frame_type () const {
111 boost::mutex::scoped_lock lm (_mutex);
116 boost::mutex::scoped_lock lm (_mutex);
120 int left_crop () const {
121 boost::mutex::scoped_lock lm (_mutex);
125 int right_crop () const {
126 boost::mutex::scoped_lock lm (_mutex);
130 int top_crop () const {
131 boost::mutex::scoped_lock lm (_mutex);
135 int bottom_crop () const {
136 boost::mutex::scoped_lock lm (_mutex);
141 boost::optional<float> custom_ratio () const {
142 boost::mutex::scoped_lock lm (_mutex);
143 return _custom_ratio;
147 boost::optional<dcp::Size> custom_size () const {
148 boost::mutex::scoped_lock lm (_mutex);
153 boost::optional<ColourConversion> colour_conversion () const {
154 boost::mutex::scoped_lock lm (_mutex);
155 return _colour_conversion;
158 boost::optional<double> sample_aspect_ratio () const {
159 boost::mutex::scoped_lock lm (_mutex);
160 return _sample_aspect_ratio;
164 boost::mutex::scoped_lock lm (_mutex);
168 Frame fade_in () const {
169 boost::mutex::scoped_lock lm (_mutex);
173 Frame fade_out () const {
174 boost::mutex::scoped_lock lm (_mutex);
178 VideoRange range () const {
179 boost::mutex::scoped_lock lm (_mutex);
184 boost::mutex::scoped_lock lm (_mutex);
188 boost::optional<dcp::LanguageTag> burnt_subtitle_language () const {
189 boost::mutex::scoped_lock lm (_mutex);
190 return _burnt_subtitle_language;
194 /* XXX: names for these? */
195 dcp::Size size_after_3d_split () const;
196 dcp::Size size_after_crop () const;
197 dcp::Size scaled_size (dcp::Size container_size);
199 boost::optional<double> fade (std::shared_ptr<const Film> film, Frame) const;
201 std::string processing_description (std::shared_ptr<const Film> film);
203 void set_length (Frame);
205 void take_from_examiner (std::shared_ptr<VideoExaminer>);
206 void add_properties (std::list<UserProperty> &) const;
208 void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
209 void modify_trim_start (dcpomatic::ContentTime& pos) const;
211 static std::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr, int);
215 friend struct ffmpeg_pts_offset_test;
216 friend struct best_dcp_frame_rate_test_single;
217 friend struct best_dcp_frame_rate_test_double;
218 friend struct audio_sampling_rate_test;
219 friend struct scaled_size_test1;
220 friend struct scaled_size_test2;
221 friend struct scaled_size_legacy_test;
223 void setup_default_colour_conversion ();
227 boost::optional<ColourConversion> _colour_conversion;
229 VideoFrameType _frame_type;
231 /** ratio to scale cropped image to (or none to guess); i.e. if set, scale to _custom_ratio:1 */
232 boost::optional<float> _custom_ratio;
233 /** size to scale cropped image to; only used if _custom_ratio is none */
234 boost::optional<dcp::Size> _custom_size;
235 /** ratio obtained from an older metadata file; will be used to set up
236 * _custom_{ratio,size} (or not, if not required) on the first call to
239 boost::optional<float> _legacy_ratio;
240 /** Sample aspect ratio obtained from the content file's header, if there is one */
241 boost::optional<double> _sample_aspect_ratio;
243 /** fade in time in content frames */
245 /** fade out time in content frames */
248 boost::optional<dcp::LanguageTag> _burnt_subtitle_language;