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"
29 #include "pixel_quanta.h"
31 #include "user_property.h"
32 #include <dcp/language_tag.h>
33 #include <boost/thread/mutex.hpp>
42 class VideoContentProperty
46 static int const SIZE;
47 static int const FRAME_TYPE;
48 static int const CROP;
49 static int const COLOUR_CONVERSION;
50 static int const FADE_IN;
51 static int const FADE_OUT;
52 static int const RANGE;
53 static int const CUSTOM_RATIO;
54 static int const CUSTOM_SIZE;
55 static int const BURNT_SUBTITLE_LANGUAGE;
59 class VideoContent : public ContentPart, public std::enable_shared_from_this<VideoContent>
62 explicit VideoContent (Content* parent);
63 VideoContent (Content* parent, cxml::ConstNodePtr, int);
64 VideoContent (Content* parent, std::vector<std::shared_ptr<Content>>);
66 void as_xml (xmlpp::Node *) const;
67 std::string technical_summary () const;
68 std::string identifier () const;
69 void take_settings_from (std::shared_ptr<const VideoContent> c);
71 Frame length () const {
72 boost::mutex::scoped_lock lm (_mutex);
76 Frame length_after_3d_combine () const {
77 boost::mutex::scoped_lock lm (_mutex);
78 if (_frame_type == VideoFrameType::THREE_D_ALTERNATE) {
85 dcp::Size size () const {
86 boost::mutex::scoped_lock lm (_mutex);
90 void set_frame_type (VideoFrameType);
92 void set_left_crop (int);
93 void set_right_crop (int);
94 void set_top_crop (int);
95 void set_bottom_crop (int);
97 void set_custom_ratio (boost::optional<float> ratio);
98 void set_custom_size (boost::optional<dcp::Size> size);
100 void unset_colour_conversion ();
101 void set_colour_conversion (ColourConversion);
103 void set_fade_in (Frame);
104 void set_fade_out (Frame);
106 void set_range (VideoRange);
109 void set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language);
111 VideoFrameType frame_type () const {
112 boost::mutex::scoped_lock lm (_mutex);
116 Crop actual_crop () const;
118 Crop requested_crop () const {
119 boost::mutex::scoped_lock lm (_mutex);
123 int requested_left_crop () const {
124 boost::mutex::scoped_lock lm (_mutex);
128 int requested_right_crop () const {
129 boost::mutex::scoped_lock lm (_mutex);
133 int requested_top_crop () const {
134 boost::mutex::scoped_lock lm (_mutex);
138 int requested_bottom_crop () const {
139 boost::mutex::scoped_lock lm (_mutex);
144 boost::optional<float> custom_ratio () const {
145 boost::mutex::scoped_lock lm (_mutex);
146 return _custom_ratio;
150 boost::optional<dcp::Size> custom_size () const {
151 boost::mutex::scoped_lock lm (_mutex);
156 boost::optional<ColourConversion> colour_conversion () const {
157 boost::mutex::scoped_lock lm (_mutex);
158 return _colour_conversion;
161 boost::optional<double> sample_aspect_ratio () const {
162 boost::mutex::scoped_lock lm (_mutex);
163 return _sample_aspect_ratio;
167 boost::mutex::scoped_lock lm (_mutex);
171 Frame fade_in () const {
172 boost::mutex::scoped_lock lm (_mutex);
176 Frame fade_out () const {
177 boost::mutex::scoped_lock lm (_mutex);
181 VideoRange range () const {
182 boost::mutex::scoped_lock lm (_mutex);
186 PixelQuanta pixel_quanta () const {
187 boost::mutex::scoped_lock lm (_mutex);
188 return _pixel_quanta;
192 boost::mutex::scoped_lock lm (_mutex);
196 boost::optional<dcp::LanguageTag> burnt_subtitle_language () const {
197 boost::mutex::scoped_lock lm (_mutex);
198 return _burnt_subtitle_language;
202 /* XXX: names for these? */
203 dcp::Size size_after_3d_split () const;
204 dcp::Size size_after_crop () const;
205 dcp::Size scaled_size (dcp::Size container_size);
207 boost::optional<double> fade (std::shared_ptr<const Film> film, Frame) const;
209 std::string processing_description (std::shared_ptr<const Film> film);
211 void set_length (Frame);
213 void take_from_examiner (std::shared_ptr<VideoExaminer>);
214 void add_properties (std::list<UserProperty> &) const;
216 void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
217 void modify_trim_start (dcpomatic::ContentTime& pos) const;
219 static std::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr, int);
223 friend struct ffmpeg_pts_offset_test;
224 friend struct best_dcp_frame_rate_test_single;
225 friend struct best_dcp_frame_rate_test_double;
226 friend struct audio_sampling_rate_test;
227 friend struct scaled_size_test1;
228 friend struct scaled_size_test2;
229 friend struct scaled_size_legacy_test;
231 void setup_default_colour_conversion ();
235 boost::optional<ColourConversion> _colour_conversion;
237 VideoFrameType _frame_type;
239 /** ratio to scale cropped image to (or none to guess); i.e. if set, scale to _custom_ratio:1 */
240 boost::optional<float> _custom_ratio;
241 /** size to scale cropped image to; only used if _custom_ratio is none */
242 boost::optional<dcp::Size> _custom_size;
243 /** ratio obtained from an older metadata file; will be used to set up
244 * _custom_{ratio,size} (or not, if not required) on the first call to
247 boost::optional<float> _legacy_ratio;
248 /** Sample aspect ratio obtained from the content file's header, if there is one */
249 boost::optional<double> _sample_aspect_ratio;
251 /** fade in time in content frames */
253 /** fade out time in content frames */
256 PixelQuanta _pixel_quanta;
257 boost::optional<dcp::LanguageTag> _burnt_subtitle_language;