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.
21 #include <libcxml/cxml.h>
22 #include <dcp/colour_matrix.h>
23 #include <dcp/raw_convert.h>
24 #include "video_content.h"
25 #include "video_examiner.h"
26 #include "compose.hpp"
29 #include "colour_conversion.h"
32 #include "exceptions.h"
33 #include "frame_rate_change.h"
35 #include "safe_stringstream.h"
39 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
41 int const VideoContentProperty::VIDEO_SIZE = 0;
42 int const VideoContentProperty::VIDEO_FRAME_RATE = 1;
43 int const VideoContentProperty::VIDEO_FRAME_TYPE = 2;
44 int const VideoContentProperty::VIDEO_CROP = 3;
45 int const VideoContentProperty::VIDEO_SCALE = 4;
46 int const VideoContentProperty::COLOUR_CONVERSION = 5;
47 int const VideoContentProperty::VIDEO_FADE_IN = 6;
48 int const VideoContentProperty::VIDEO_FADE_OUT = 7;
51 using std::setprecision;
56 using boost::shared_ptr;
57 using boost::optional;
58 using boost::dynamic_pointer_cast;
59 using dcp::raw_convert;
61 VideoContent::VideoContent (shared_ptr<const Film> f)
64 , _video_frame_rate (0)
65 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
66 , _scale (Config::instance()->default_scale ())
68 setup_default_colour_conversion ();
71 VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, ContentTime len)
74 , _video_frame_rate (0)
75 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
76 , _scale (Config::instance()->default_scale ())
78 setup_default_colour_conversion ();
81 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
84 , _video_frame_rate (0)
85 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
86 , _scale (Config::instance()->default_scale ())
88 setup_default_colour_conversion ();
91 VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
94 _video_size.width = node->number_child<int> ("VideoWidth");
95 _video_size.height = node->number_child<int> ("VideoHeight");
96 _video_frame_rate = node->number_child<float> ("VideoFrameRate");
99 /* DCP-o-matic 1.0 branch */
100 _video_length = ContentTime::from_frames (node->number_child<int64_t> ("VideoLength"), _video_frame_rate);
102 _video_length = ContentTime (node->number_child<ContentTime::Type> ("VideoLength"));
105 _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
106 _crop.left = node->number_child<int> ("LeftCrop");
107 _crop.right = node->number_child<int> ("RightCrop");
108 _crop.top = node->number_child<int> ("TopCrop");
109 _crop.bottom = node->number_child<int> ("BottomCrop");
112 optional<string> r = node->optional_string_child ("Ratio");
114 _scale = VideoContentScale (Ratio::from_id (r.get ()));
117 _scale = VideoContentScale (node->node_child ("Scale"));
120 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
122 _fade_in = ContentTime (node->number_child<int64_t> ("FadeIn"));
123 _fade_out = ContentTime (node->number_child<int64_t> ("FadeOut"));
127 VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
131 shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
134 for (size_t i = 0; i < c.size(); ++i) {
135 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
137 if (vc->video_size() != ref->video_size()) {
138 throw JoinError (_("Content to be joined must have the same picture size."));
141 if (vc->video_frame_rate() != ref->video_frame_rate()) {
142 throw JoinError (_("Content to be joined must have the same video frame rate."));
145 if (vc->video_frame_type() != ref->video_frame_type()) {
146 throw JoinError (_("Content to be joined must have the same video frame type."));
149 if (vc->crop() != ref->crop()) {
150 throw JoinError (_("Content to be joined must have the same crop."));
153 if (vc->scale() != ref->scale()) {
154 throw JoinError (_("Content to be joined must have the same scale setting."));
157 if (vc->colour_conversion() != ref->colour_conversion()) {
158 throw JoinError (_("Content to be joined must have the same colour conversion."));
161 if (vc->fade_in() != ref->fade_in() || vc->fade_out() != ref->fade_out()) {
162 throw JoinError (_("Content to be joined must have the same fades."));
165 _video_length += vc->video_length ();
168 _video_size = ref->video_size ();
169 _video_frame_rate = ref->video_frame_rate ();
170 _video_frame_type = ref->video_frame_type ();
171 _crop = ref->crop ();
172 _scale = ref->scale ();
173 _colour_conversion = ref->colour_conversion ();
174 _fade_in = ref->fade_in ();
175 _fade_out = ref->fade_out ();
179 VideoContent::as_xml (xmlpp::Node* node) const
181 boost::mutex::scoped_lock lm (_mutex);
182 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length.get ()));
183 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
184 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
185 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
186 node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
188 _scale.as_xml (node->add_child("Scale"));
189 _colour_conversion.as_xml (node->add_child("ColourConversion"));
190 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in.get ()));
191 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out.get ()));
195 VideoContent::setup_default_colour_conversion ()
197 _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
201 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
203 /* These examiner calls could call other content methods which take a lock on the mutex */
204 dcp::Size const vs = d->video_size ();
205 float const vfr = d->video_frame_rate ();
206 ContentTime vl = d->video_length ();
209 boost::mutex::scoped_lock lm (_mutex);
211 _video_frame_rate = vfr;
215 shared_ptr<const Film> film = _film.lock ();
217 LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length.frames (_video_frame_rate));
219 signal_changed (VideoContentProperty::VIDEO_SIZE);
220 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
221 signal_changed (ContentProperty::LENGTH);
226 VideoContent::information () const
228 if (video_size().width == 0 || video_size().height == 0) {
234 s << String::compose (
235 _("%1x%2 pixels (%3:1)"),
238 setprecision (3), video_size().ratio ()
245 VideoContent::set_left_crop (int c)
248 boost::mutex::scoped_lock lm (_mutex);
250 if (_crop.left == c) {
257 signal_changed (VideoContentProperty::VIDEO_CROP);
261 VideoContent::set_right_crop (int c)
264 boost::mutex::scoped_lock lm (_mutex);
265 if (_crop.right == c) {
272 signal_changed (VideoContentProperty::VIDEO_CROP);
276 VideoContent::set_top_crop (int c)
279 boost::mutex::scoped_lock lm (_mutex);
280 if (_crop.top == c) {
287 signal_changed (VideoContentProperty::VIDEO_CROP);
291 VideoContent::set_bottom_crop (int c)
294 boost::mutex::scoped_lock lm (_mutex);
295 if (_crop.bottom == c) {
302 signal_changed (VideoContentProperty::VIDEO_CROP);
306 VideoContent::set_scale (VideoContentScale s)
309 boost::mutex::scoped_lock lm (_mutex);
317 signal_changed (VideoContentProperty::VIDEO_SCALE);
320 /** @return string which includes everything about how this content looks */
322 VideoContent::identifier () const
325 s << Content::identifier()
326 << "_" << crop().left
327 << "_" << crop().right
329 << "_" << crop().bottom
330 << "_" << scale().id()
331 << "_" << colour_conversion().identifier ();
337 VideoContent::set_video_frame_type (VideoFrameType t)
340 boost::mutex::scoped_lock lm (_mutex);
341 _video_frame_type = t;
344 signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
348 VideoContent::technical_summary () const
350 return String::compose (
351 "video: length %1, size %2x%3, rate %4",
352 video_length_after_3d_combine().seconds(),
360 VideoContent::video_size_after_3d_split () const
362 dcp::Size const s = video_size ();
363 switch (video_frame_type ()) {
364 case VIDEO_FRAME_TYPE_2D:
365 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
366 case VIDEO_FRAME_TYPE_3D_LEFT:
367 case VIDEO_FRAME_TYPE_3D_RIGHT:
369 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
370 return dcp::Size (s.width / 2, s.height);
371 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
372 return dcp::Size (s.width, s.height / 2);
379 VideoContent::set_colour_conversion (ColourConversion c)
382 boost::mutex::scoped_lock lm (_mutex);
383 _colour_conversion = c;
386 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
390 VideoContent::set_fade_in (ContentTime t)
393 boost::mutex::scoped_lock lm (_mutex);
397 signal_changed (VideoContentProperty::VIDEO_FADE_IN);
401 VideoContent::set_fade_out (ContentTime t)
404 boost::mutex::scoped_lock lm (_mutex);
408 signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
411 /** @return Video size after 3D split and crop */
413 VideoContent::video_size_after_crop () const
415 return crop().apply (video_size_after_3d_split ());
418 /** @param t A time offset from the start of this piece of content.
419 * @return Corresponding time with respect to the content.
422 VideoContent::dcp_time_to_content_time (DCPTime t) const
424 shared_ptr<const Film> film = _film.lock ();
426 return ContentTime (t, FrameRateChange (video_frame_rate(), film->video_frame_rate()));
430 VideoContent::scale_and_crop_to_fit_width ()
432 shared_ptr<const Film> film = _film.lock ();
435 set_scale (VideoContentScale (film->container ()));
437 int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
438 set_top_crop (crop / 2);
439 set_bottom_crop (crop / 2);
443 VideoContent::scale_and_crop_to_fit_height ()
445 shared_ptr<const Film> film = _film.lock ();
448 set_scale (VideoContentScale (film->container ()));
450 int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
451 set_left_crop (crop / 2);
452 set_right_crop (crop / 2);
456 VideoContent::set_video_frame_rate (float r)
459 boost::mutex::scoped_lock lm (_mutex);
460 if (_video_frame_rate == r) {
464 _video_frame_rate = r;
467 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
471 VideoContent::fade (VideoFrame f) const
475 if (f < fade_in().frames (video_frame_rate ())) {
476 return float (f) / _fade_in.frames (video_frame_rate ());
479 VideoFrame fade_out_start = ContentTime (video_length() - fade_out()).frames (video_frame_rate ());
480 if (f >= fade_out_start) {
481 return 1 - float (f - fade_out_start) / fade_out().frames (video_frame_rate ());
484 return optional<float> ();