2 Copyright (C) 2013-2015 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 #include "video_content.h"
21 #include "video_examiner.h"
22 #include "compose.hpp"
25 #include "colour_conversion.h"
28 #include "exceptions.h"
29 #include "frame_rate_change.h"
31 #include "safe_stringstream.h"
32 #include "raw_convert.h"
33 #include <libcxml/cxml.h>
34 #include <dcp/colour_matrix.h>
35 #include <libxml++/libxml++.h>
40 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
42 int const VideoContentProperty::VIDEO_SIZE = 0;
43 int const VideoContentProperty::VIDEO_FRAME_RATE = 1;
44 int const VideoContentProperty::VIDEO_FRAME_TYPE = 2;
45 int const VideoContentProperty::VIDEO_CROP = 3;
46 int const VideoContentProperty::VIDEO_SCALE = 4;
47 int const VideoContentProperty::COLOUR_CONVERSION = 5;
48 int const VideoContentProperty::VIDEO_FADE_IN = 6;
49 int const VideoContentProperty::VIDEO_FADE_OUT = 7;
52 using std::setprecision;
57 using std::stringstream;
59 using std::setprecision;
62 using boost::shared_ptr;
63 using boost::optional;
64 using boost::dynamic_pointer_cast;
66 VideoContent::VideoContent (shared_ptr<const Film> film)
69 , _video_frame_rate (0)
70 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
71 , _scale (VideoContentScale (Ratio::from_id ("178")))
75 set_default_colour_conversion ();
78 VideoContent::VideoContent (shared_ptr<const Film> film, DCPTime s, Frame len)
81 , _video_frame_rate (0)
82 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
83 , _scale (VideoContentScale (Ratio::from_id ("178")))
87 set_default_colour_conversion ();
90 VideoContent::VideoContent (shared_ptr<const Film> film, boost::filesystem::path p)
93 , _video_frame_rate (0)
94 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
95 , _scale (VideoContentScale (Ratio::from_id ("178")))
99 set_default_colour_conversion ();
102 VideoContent::VideoContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
103 : Content (film, node)
105 _video_size.width = node->number_child<int> ("VideoWidth");
106 _video_size.height = node->number_child<int> ("VideoHeight");
107 _video_frame_rate = node->number_child<double> ("VideoFrameRate");
108 _video_length = node->number_child<Frame> ("VideoLength");
109 _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
110 _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
111 _crop.left = node->number_child<int> ("LeftCrop");
112 _crop.right = node->number_child<int> ("RightCrop");
113 _crop.top = node->number_child<int> ("TopCrop");
114 _crop.bottom = node->number_child<int> ("BottomCrop");
117 optional<string> r = node->optional_string_child ("Ratio");
119 _scale = VideoContentScale (Ratio::from_id (r.get ()));
122 _scale = VideoContentScale (node->node_child ("Scale"));
126 if (node->optional_node_child ("ColourConversion")) {
127 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
130 _fade_in = node->number_child<Frame> ("FadeIn");
131 _fade_out = node->number_child<Frame> ("FadeOut");
133 _fade_in = _fade_out = 0;
137 VideoContent::VideoContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
141 shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
142 DCPOMATIC_ASSERT (ref);
144 for (size_t i = 0; i < c.size(); ++i) {
145 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
147 if (vc->video_size() != ref->video_size()) {
148 throw JoinError (_("Content to be joined must have the same picture size."));
151 if (vc->video_frame_rate() != ref->video_frame_rate()) {
152 throw JoinError (_("Content to be joined must have the same video frame rate."));
155 if (vc->video_frame_type() != ref->video_frame_type()) {
156 throw JoinError (_("Content to be joined must have the same video frame type."));
159 if (vc->crop() != ref->crop()) {
160 throw JoinError (_("Content to be joined must have the same crop."));
163 if (vc->scale() != ref->scale()) {
164 throw JoinError (_("Content to be joined must have the same scale setting."));
167 if (vc->colour_conversion() != ref->colour_conversion()) {
168 throw JoinError (_("Content to be joined must have the same colour conversion."));
171 if (vc->fade_in() != ref->fade_in() || vc->fade_out() != ref->fade_out()) {
172 throw JoinError (_("Content to be joined must have the same fades."));
175 _video_length += vc->video_length ();
178 _video_size = ref->video_size ();
179 _video_frame_rate = ref->video_frame_rate ();
180 _video_frame_type = ref->video_frame_type ();
181 _crop = ref->crop ();
182 _scale = ref->scale ();
183 _colour_conversion = ref->colour_conversion ();
184 _fade_in = ref->fade_in ();
185 _fade_out = ref->fade_out ();
189 VideoContent::as_xml (xmlpp::Node* node) const
191 boost::mutex::scoped_lock lm (_mutex);
192 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length));
193 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
194 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
195 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
196 node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
197 if (_sample_aspect_ratio) {
198 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
201 _scale.as_xml (node->add_child("Scale"));
202 if (_colour_conversion) {
203 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
205 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
206 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
210 VideoContent::set_default_colour_conversion ()
212 /* If there's no better offer we'll use Rec. 709 */
213 boost::mutex::scoped_lock lm (_mutex);
214 _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
218 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
220 /* These examiner calls could call other content methods which take a lock on the mutex */
221 dcp::Size const vs = d->video_size ();
222 optional<double> const vfr = d->video_frame_rate ();
223 Frame vl = d->video_length ();
224 optional<double> const ar = d->sample_aspect_ratio ();
227 boost::mutex::scoped_lock lm (_mutex);
229 /* Default video frame rate to 24fps if the examiner doesn't know */
230 _video_frame_rate = vfr.get_value_or (24);
232 _sample_aspect_ratio = ar;
234 /* Guess correct scale from size and sample aspect ratio */
235 _scale = VideoContentScale (
236 Ratio::nearest_from_ratio (double (_video_size.width) * ar.get_value_or (1) / _video_size.height)
240 shared_ptr<const Film> film = _film.lock ();
241 DCPOMATIC_ASSERT (film);
242 LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length);
244 set_default_colour_conversion ();
246 signal_changed (VideoContentProperty::VIDEO_SIZE);
247 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
248 signal_changed (VideoContentProperty::VIDEO_SCALE);
249 signal_changed (ContentProperty::LENGTH);
253 VideoContent::set_left_crop (int c)
256 boost::mutex::scoped_lock lm (_mutex);
258 if (_crop.left == c) {
265 signal_changed (VideoContentProperty::VIDEO_CROP);
269 VideoContent::set_right_crop (int c)
272 boost::mutex::scoped_lock lm (_mutex);
273 if (_crop.right == c) {
280 signal_changed (VideoContentProperty::VIDEO_CROP);
284 VideoContent::set_top_crop (int c)
287 boost::mutex::scoped_lock lm (_mutex);
288 if (_crop.top == c) {
295 signal_changed (VideoContentProperty::VIDEO_CROP);
299 VideoContent::set_bottom_crop (int c)
302 boost::mutex::scoped_lock lm (_mutex);
303 if (_crop.bottom == c) {
310 signal_changed (VideoContentProperty::VIDEO_CROP);
314 VideoContent::set_scale (VideoContentScale s)
317 boost::mutex::scoped_lock lm (_mutex);
325 signal_changed (VideoContentProperty::VIDEO_SCALE);
328 /** @return string which includes everything about how this content looks */
330 VideoContent::identifier () const
333 s << Content::identifier()
334 << "_" << crop().left
335 << "_" << crop().right
337 << "_" << crop().bottom
338 << "_" << scale().id()
342 if (colour_conversion()) {
343 s << "_" << colour_conversion().get().identifier ();
350 VideoContent::set_video_frame_type (VideoFrameType t)
353 boost::mutex::scoped_lock lm (_mutex);
354 _video_frame_type = t;
357 signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
361 VideoContent::technical_summary () const
363 string s = String::compose (
364 N_("video: length %1 frames, size %2x%3, rate %4"),
365 video_length_after_3d_combine(),
371 if (sample_aspect_ratio ()) {
372 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
379 VideoContent::video_size_after_3d_split () const
381 dcp::Size const s = video_size ();
382 switch (video_frame_type ()) {
383 case VIDEO_FRAME_TYPE_2D:
384 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
385 case VIDEO_FRAME_TYPE_3D_LEFT:
386 case VIDEO_FRAME_TYPE_3D_RIGHT:
388 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
389 return dcp::Size (s.width / 2, s.height);
390 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
391 return dcp::Size (s.width, s.height / 2);
394 DCPOMATIC_ASSERT (false);
398 VideoContent::unset_colour_conversion (bool signal)
401 boost::mutex::scoped_lock lm (_mutex);
402 _colour_conversion = boost::optional<ColourConversion> ();
406 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
411 VideoContent::set_colour_conversion (ColourConversion c)
414 boost::mutex::scoped_lock lm (_mutex);
415 _colour_conversion = c;
418 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
422 VideoContent::set_fade_in (Frame t)
425 boost::mutex::scoped_lock lm (_mutex);
429 signal_changed (VideoContentProperty::VIDEO_FADE_IN);
433 VideoContent::set_fade_out (Frame t)
436 boost::mutex::scoped_lock lm (_mutex);
440 signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
443 /** @return Video size after 3D split and crop */
445 VideoContent::video_size_after_crop () const
447 return crop().apply (video_size_after_3d_split ());
451 VideoContent::scale_and_crop_to_fit_width ()
453 shared_ptr<const Film> film = _film.lock ();
454 DCPOMATIC_ASSERT (film);
456 set_scale (VideoContentScale (film->container ()));
458 int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
459 set_top_crop (crop / 2);
460 set_bottom_crop (crop / 2);
464 VideoContent::scale_and_crop_to_fit_height ()
466 shared_ptr<const Film> film = _film.lock ();
467 DCPOMATIC_ASSERT (film);
469 set_scale (VideoContentScale (film->container ()));
471 int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
472 set_left_crop (crop / 2);
473 set_right_crop (crop / 2);
477 VideoContent::set_video_frame_rate (double r)
480 boost::mutex::scoped_lock lm (_mutex);
481 if (_video_frame_rate == r) {
485 _video_frame_rate = r;
488 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
492 VideoContent::fade (Frame f) const
494 DCPOMATIC_ASSERT (f >= 0);
497 return double (f) / fade_in();
500 Frame fade_out_start = video_length() - fade_out();
501 if (f >= fade_out_start) {
502 return 1 - double (f - fade_out_start) / fade_out();
505 return optional<double> ();
509 VideoContent::processing_description () const
511 /* stringstream is OK here as this string is just for presentation to the user */
514 if (video_size().width && video_size().height) {
515 d << String::compose (
516 _("Content video is %1x%2"),
517 video_size_after_3d_split().width,
518 video_size_after_3d_split().height
522 double ratio = video_size_after_3d_split().ratio ();
524 if (sample_aspect_ratio ()) {
525 d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
526 ratio *= sample_aspect_ratio().get ();
529 d << "\n" << _("Display aspect ratio") << " " << fixed << setprecision(2) << ratio << ":1\n";
532 if ((crop().left || crop().right || crop().top || crop().bottom) && video_size() != dcp::Size (0, 0)) {
533 dcp::Size cropped = video_size_after_crop ();
534 d << String::compose (
535 _("Cropped to %1x%2"),
536 cropped.width, cropped.height
539 d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
542 shared_ptr<const Film> film = _film.lock ();
543 DCPOMATIC_ASSERT (film);
545 dcp::Size const container_size = film->frame_size ();
546 dcp::Size const scaled = scale().size (dynamic_pointer_cast<const VideoContent> (shared_from_this ()), container_size, container_size);
548 if (scaled != video_size_after_crop ()) {
549 d << String::compose (
550 _("Scaled to %1x%2"),
551 scaled.width, scaled.height
554 d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
557 if (scaled != container_size) {
558 d << String::compose (
559 _("Padded with black to fit container %1 (%2x%3)"),
560 film->container()->nickname (),
561 container_size.width, container_size.height
564 d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
567 d << _("Content frame rate");
568 d << " " << fixed << setprecision(4) << video_frame_rate() << "\n";
570 FrameRateChange frc (video_frame_rate(), film->video_frame_rate ());
571 d << frc.description () << "\n";
577 VideoContent::add_properties (list<pair<string, string> >& p) const
579 p.push_back (make_pair (_("Video length"), raw_convert<string> (video_length ()) + " " + _("video frames")));
580 p.push_back (make_pair (_("Video size"), raw_convert<string> (video_size().width) + "x" + raw_convert<string> (video_size().height)));
581 p.push_back (make_pair (_("Video frame rate"), raw_convert<string> (video_frame_rate()) + " " + _("frames per second")));