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>, DCPTime, Frame);
48 VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
49 VideoContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int);
50 VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
52 void as_xml (xmlpp::Node *) const;
53 std::string technical_summary () const;
54 virtual std::string identifier () const;
56 virtual void set_default_colour_conversion ();
58 /** @return points at which to split this content when
59 * REELTYPE_BY_VIDEO_CONTENT is in use.
61 virtual std::list<DCPTime> reel_split_points () const;
63 Frame video_length () const {
64 boost::mutex::scoped_lock lm (_mutex);
68 Frame video_length_after_3d_combine () const {
69 boost::mutex::scoped_lock lm (_mutex);
70 if (_video_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
71 return _video_length / 2;
77 dcp::Size video_size () const {
78 boost::mutex::scoped_lock lm (_mutex);
82 double video_frame_rate () const;
84 /** @return true if this content has a specific video frame rate, false
85 * if it should use the DCP's rate.
87 bool has_own_video_frame_rate () const {
88 boost::mutex::scoped_lock lm (_mutex);
89 return static_cast<bool>(_video_frame_rate);
92 void set_video_frame_type (VideoFrameType);
93 void set_video_frame_rate (double);
95 void set_left_crop (int);
96 void set_right_crop (int);
97 void set_top_crop (int);
98 void set_bottom_crop (int);
100 void set_scale (VideoContentScale);
101 void unset_colour_conversion ();
102 void set_colour_conversion (ColourConversion);
104 void set_fade_in (Frame);
105 void set_fade_out (Frame);
107 VideoFrameType video_frame_type () const {
108 boost::mutex::scoped_lock lm (_mutex);
109 return _video_frame_type;
113 boost::mutex::scoped_lock lm (_mutex);
117 int left_crop () const {
118 boost::mutex::scoped_lock lm (_mutex);
122 int right_crop () const {
123 boost::mutex::scoped_lock lm (_mutex);
127 int top_crop () const {
128 boost::mutex::scoped_lock lm (_mutex);
132 int bottom_crop () const {
133 boost::mutex::scoped_lock lm (_mutex);
137 /** @return Description of how to scale this content (if indeed it should be scaled) */
138 VideoContentScale scale () const {
139 boost::mutex::scoped_lock lm (_mutex);
143 boost::optional<ColourConversion> colour_conversion () const {
144 boost::mutex::scoped_lock lm (_mutex);
145 return _colour_conversion;
148 boost::optional<double> sample_aspect_ratio () const {
149 boost::mutex::scoped_lock lm (_mutex);
150 return _sample_aspect_ratio;
153 Frame fade_in () const {
154 boost::mutex::scoped_lock lm (_mutex);
158 Frame fade_out () const {
159 boost::mutex::scoped_lock lm (_mutex);
163 dcp::Size video_size_after_3d_split () const;
164 dcp::Size video_size_after_crop () const;
166 ContentTime dcp_time_to_content_time (DCPTime) const;
168 boost::optional<double> fade (Frame) const;
170 void scale_and_crop_to_fit_width ();
171 void scale_and_crop_to_fit_height ();
173 std::string processing_description () const;
176 void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
177 void add_properties (std::list<std::pair<std::string, std::string> > &) const;
180 /** Video frame rate, or not set if this content should use the DCP's frame rate */
181 boost::optional<double> _video_frame_rate;
182 boost::optional<ColourConversion> _colour_conversion;
185 friend struct ffmpeg_pts_offset_test;
186 friend struct best_dcp_frame_rate_test_single;
187 friend struct best_dcp_frame_rate_test_double;
188 friend struct audio_sampling_rate_test;
190 void setup_default_colour_conversion ();
192 dcp::Size _video_size;
193 VideoFrameType _video_frame_type;
195 VideoContentScale _scale;
196 /** Sample aspect ratio obtained from the content file's header,
199 boost::optional<double> _sample_aspect_ratio;