2 Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 #ifndef DCPOMATIC_VIDEO_CONTENT_H
21 #define DCPOMATIC_VIDEO_CONTENT_H
24 #include "colour_conversion.h"
25 #include "video_content_scale.h"
30 class VideoContentProperty
33 static int const VIDEO_SIZE;
34 static int const VIDEO_FRAME_RATE;
35 static int const VIDEO_FRAME_TYPE;
36 static int const VIDEO_CROP;
37 static int const VIDEO_SCALE;
38 static int const COLOUR_CONVERSION;
39 static int const VIDEO_FADE_IN;
40 static int const VIDEO_FADE_OUT;
43 class VideoContent : public virtual Content
46 VideoContent (boost::shared_ptr<const Film>);
47 VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
48 VideoContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int);
49 VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
51 void as_xml (xmlpp::Node *) const;
52 std::string technical_summary () const;
53 virtual std::string identifier () const;
55 virtual void set_default_colour_conversion ();
57 Frame video_length () const {
58 boost::mutex::scoped_lock lm (_mutex);
62 Frame video_length_after_3d_combine () const {
63 boost::mutex::scoped_lock lm (_mutex);
64 if (_video_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
65 return _video_length / 2;
71 dcp::Size video_size () const {
72 boost::mutex::scoped_lock lm (_mutex);
76 double video_frame_rate () const;
78 /** @return true if this content has a specific video frame rate, false
79 * if it should use the DCP's rate.
81 bool has_own_video_frame_rate () const {
82 boost::mutex::scoped_lock lm (_mutex);
83 return static_cast<bool>(_video_frame_rate);
86 void set_video_frame_type (VideoFrameType);
87 void set_video_frame_rate (double);
89 void set_left_crop (int);
90 void set_right_crop (int);
91 void set_top_crop (int);
92 void set_bottom_crop (int);
94 void set_scale (VideoContentScale);
95 void unset_colour_conversion ();
96 void set_colour_conversion (ColourConversion);
98 void set_fade_in (Frame);
99 void set_fade_out (Frame);
101 VideoFrameType video_frame_type () const {
102 boost::mutex::scoped_lock lm (_mutex);
103 return _video_frame_type;
107 boost::mutex::scoped_lock lm (_mutex);
111 int left_crop () const {
112 boost::mutex::scoped_lock lm (_mutex);
116 int right_crop () const {
117 boost::mutex::scoped_lock lm (_mutex);
121 int top_crop () const {
122 boost::mutex::scoped_lock lm (_mutex);
126 int bottom_crop () const {
127 boost::mutex::scoped_lock lm (_mutex);
131 /** @return Description of how to scale this content (if indeed it should be scaled) */
132 VideoContentScale scale () const {
133 boost::mutex::scoped_lock lm (_mutex);
137 boost::optional<ColourConversion> colour_conversion () const {
138 boost::mutex::scoped_lock lm (_mutex);
139 return _colour_conversion;
142 boost::optional<double> sample_aspect_ratio () const {
143 boost::mutex::scoped_lock lm (_mutex);
144 return _sample_aspect_ratio;
148 boost::mutex::scoped_lock lm (_mutex);
152 Frame fade_in () const {
153 boost::mutex::scoped_lock lm (_mutex);
157 Frame fade_out () const {
158 boost::mutex::scoped_lock lm (_mutex);
162 dcp::Size video_size_after_3d_split () const;
163 dcp::Size video_size_after_crop () const;
165 ContentTime dcp_time_to_content_time (DCPTime) const;
167 boost::optional<double> fade (Frame) const;
169 void scale_and_crop_to_fit_width ();
170 void scale_and_crop_to_fit_height ();
172 std::string processing_description () const;
175 void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
176 void add_properties (std::list<UserProperty> &) const;
179 /** Video frame rate, or not set if this content should use the DCP's frame rate */
180 boost::optional<double> _video_frame_rate;
181 boost::optional<ColourConversion> _colour_conversion;
184 friend struct ffmpeg_pts_offset_test;
185 friend struct best_dcp_frame_rate_test_single;
186 friend struct best_dcp_frame_rate_test_double;
187 friend struct audio_sampling_rate_test;
189 void setup_default_colour_conversion ();
191 dcp::Size _video_size;
192 VideoFrameType _video_frame_type;
194 VideoContentScale _scale;
195 /** Sample aspect ratio obtained from the content file's header,
198 boost::optional<double> _sample_aspect_ratio;