2 Copyright (C) 2013-2019 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/>.
21 #ifndef DCPOMATIC_VIDEO_CONTENT_H
22 #define DCPOMATIC_VIDEO_CONTENT_H
24 #include "colour_conversion.h"
25 #include "video_content_scale.h"
26 #include "dcpomatic_time.h"
27 #include "user_property.h"
29 #include "content_part.h"
30 #include <boost/thread/mutex.hpp>
31 #include <boost/weak_ptr.hpp>
32 #include <boost/enable_shared_from_this.hpp>
39 class VideoContentProperty
42 static int const SIZE;
43 static int const FRAME_TYPE;
44 static int const CROP;
45 static int const SCALE;
46 static int const COLOUR_CONVERSION;
47 static int const FADE_IN;
48 static int const FADE_OUT;
49 static int const RANGE;
52 class VideoContent : public ContentPart, public boost::enable_shared_from_this<VideoContent>
55 explicit VideoContent (Content* parent);
56 VideoContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
58 void as_xml (xmlpp::Node *) const;
59 std::string technical_summary () const;
60 std::string identifier () const;
61 void take_settings_from (boost::shared_ptr<const VideoContent> c);
63 Frame length () const {
64 boost::mutex::scoped_lock lm (_mutex);
68 Frame length_after_3d_combine () const {
69 boost::mutex::scoped_lock lm (_mutex);
70 if (_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
77 dcp::Size size () const {
78 boost::mutex::scoped_lock lm (_mutex);
82 void set_frame_type (VideoFrameType);
84 void set_left_crop (int);
85 void set_right_crop (int);
86 void set_top_crop (int);
87 void set_bottom_crop (int);
89 void set_scale (VideoContentScale);
90 void unset_colour_conversion ();
91 void set_colour_conversion (ColourConversion);
93 void set_fade_in (Frame);
94 void set_fade_out (Frame);
96 void set_range (VideoRange);
98 VideoFrameType frame_type () const {
99 boost::mutex::scoped_lock lm (_mutex);
104 boost::mutex::scoped_lock lm (_mutex);
108 int left_crop () const {
109 boost::mutex::scoped_lock lm (_mutex);
113 int right_crop () const {
114 boost::mutex::scoped_lock lm (_mutex);
118 int top_crop () const {
119 boost::mutex::scoped_lock lm (_mutex);
123 int bottom_crop () const {
124 boost::mutex::scoped_lock lm (_mutex);
128 /** @return Description of how to scale this content (if indeed it should be scaled) */
129 VideoContentScale scale () const {
130 boost::mutex::scoped_lock lm (_mutex);
134 boost::optional<ColourConversion> colour_conversion () const {
135 boost::mutex::scoped_lock lm (_mutex);
136 return _colour_conversion;
139 boost::optional<double> sample_aspect_ratio () const {
140 boost::mutex::scoped_lock lm (_mutex);
141 return _sample_aspect_ratio;
145 boost::mutex::scoped_lock lm (_mutex);
149 Frame fade_in () const {
150 boost::mutex::scoped_lock lm (_mutex);
154 Frame fade_out () const {
155 boost::mutex::scoped_lock lm (_mutex);
159 VideoRange range () const {
160 boost::mutex::scoped_lock lm (_mutex);
164 dcp::Size size_after_3d_split () const;
165 dcp::Size size_after_crop () const;
167 boost::optional<double> fade (boost::shared_ptr<const Film> film, Frame) const;
169 void scale_and_crop_to_fit_width (boost::shared_ptr<const Film> film);
170 void scale_and_crop_to_fit_height (boost::shared_ptr<const Film> film);
172 std::string processing_description (boost::shared_ptr<const Film> film) const;
174 void set_length (Frame);
176 void take_from_examiner (boost::shared_ptr<VideoExaminer>);
177 void add_properties (std::list<UserProperty> &) const;
179 void modify_position (boost::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
180 void modify_trim_start (dcpomatic::ContentTime& pos) const;
182 static boost::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr, int);
186 friend struct ffmpeg_pts_offset_test;
187 friend struct best_dcp_frame_rate_test_single;
188 friend struct best_dcp_frame_rate_test_double;
189 friend struct audio_sampling_rate_test;
191 VideoContent (Content* parent, cxml::ConstNodePtr, int);
192 void setup_default_colour_conversion ();
195 boost::optional<ColourConversion> _colour_conversion;
197 VideoFrameType _frame_type;
199 VideoContentScale _scale;
200 /** Sample aspect ratio obtained from the content file's header, if there is one */
201 boost::optional<double> _sample_aspect_ratio;