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>
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 std::stringstream;
58 using std::setprecision;
59 using boost::shared_ptr;
60 using boost::optional;
61 using boost::dynamic_pointer_cast;
63 VideoContent::VideoContent (shared_ptr<const Film> f)
66 , _video_frame_rate (0)
67 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
68 , _scale (VideoContentScale (Ratio::from_id ("178")))
72 set_default_colour_conversion ();
75 VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, Frame len)
78 , _video_frame_rate (0)
79 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
80 , _scale (VideoContentScale (Ratio::from_id ("178")))
84 set_default_colour_conversion ();
87 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
90 , _video_frame_rate (0)
91 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
92 , _scale (VideoContentScale (Ratio::from_id ("178")))
96 set_default_colour_conversion ();
99 VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
102 _video_size.width = node->number_child<int> ("VideoWidth");
103 _video_size.height = node->number_child<int> ("VideoHeight");
104 _video_frame_rate = node->number_child<float> ("VideoFrameRate");
105 _video_length = node->number_child<Frame> ("VideoLength");
106 _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
107 _sample_aspect_ratio = node->optional_number_child<float> ("SampleAspectRatio");
108 _crop.left = node->number_child<int> ("LeftCrop");
109 _crop.right = node->number_child<int> ("RightCrop");
110 _crop.top = node->number_child<int> ("TopCrop");
111 _crop.bottom = node->number_child<int> ("BottomCrop");
114 optional<string> r = node->optional_string_child ("Ratio");
116 _scale = VideoContentScale (Ratio::from_id (r.get ()));
119 _scale = VideoContentScale (node->node_child ("Scale"));
123 if (node->optional_node_child ("ColourConversion")) {
124 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
127 _fade_in = node->number_child<Frame> ("FadeIn");
128 _fade_out = node->number_child<Frame> ("FadeOut");
130 _fade_in = _fade_out = 0;
134 VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
138 shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
139 DCPOMATIC_ASSERT (ref);
141 for (size_t i = 0; i < c.size(); ++i) {
142 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
144 if (vc->video_size() != ref->video_size()) {
145 throw JoinError (_("Content to be joined must have the same picture size."));
148 if (vc->video_frame_rate() != ref->video_frame_rate()) {
149 throw JoinError (_("Content to be joined must have the same video frame rate."));
152 if (vc->video_frame_type() != ref->video_frame_type()) {
153 throw JoinError (_("Content to be joined must have the same video frame type."));
156 if (vc->crop() != ref->crop()) {
157 throw JoinError (_("Content to be joined must have the same crop."));
160 if (vc->scale() != ref->scale()) {
161 throw JoinError (_("Content to be joined must have the same scale setting."));
164 if (vc->colour_conversion() != ref->colour_conversion()) {
165 throw JoinError (_("Content to be joined must have the same colour conversion."));
168 if (vc->fade_in() != ref->fade_in() || vc->fade_out() != ref->fade_out()) {
169 throw JoinError (_("Content to be joined must have the same fades."));
172 _video_length += vc->video_length ();
175 _video_size = ref->video_size ();
176 _video_frame_rate = ref->video_frame_rate ();
177 _video_frame_type = ref->video_frame_type ();
178 _crop = ref->crop ();
179 _scale = ref->scale ();
180 _colour_conversion = ref->colour_conversion ();
181 _fade_in = ref->fade_in ();
182 _fade_out = ref->fade_out ();
186 VideoContent::as_xml (xmlpp::Node* node) const
188 boost::mutex::scoped_lock lm (_mutex);
189 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length));
190 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
191 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
192 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
193 node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
194 if (_sample_aspect_ratio) {
195 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
198 _scale.as_xml (node->add_child("Scale"));
199 if (_colour_conversion) {
200 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
202 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
203 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
207 VideoContent::set_default_colour_conversion ()
209 /* If there's no better offer we'll use Rec. 709 */
210 boost::mutex::scoped_lock lm (_mutex);
211 _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
215 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
217 /* These examiner calls could call other content methods which take a lock on the mutex */
218 dcp::Size const vs = d->video_size ();
219 optional<float> const vfr = d->video_frame_rate ();
220 Frame vl = d->video_length ();
221 optional<float> const ar = d->sample_aspect_ratio ();
224 boost::mutex::scoped_lock lm (_mutex);
226 /* Default video frame rate to 24fps if the examiner doesn't know */
227 _video_frame_rate = vfr.get_value_or (24);
229 _sample_aspect_ratio = ar;
231 /* Guess correct scale from size and sample aspect ratio */
232 _scale = VideoContentScale (
233 Ratio::nearest_from_ratio (float (_video_size.width) * ar.get_value_or (1) / _video_size.height)
237 shared_ptr<const Film> film = _film.lock ();
238 DCPOMATIC_ASSERT (film);
239 LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length);
241 set_default_colour_conversion ();
243 signal_changed (VideoContentProperty::VIDEO_SIZE);
244 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
245 signal_changed (VideoContentProperty::VIDEO_SCALE);
246 signal_changed (ContentProperty::LENGTH);
250 VideoContent::set_left_crop (int c)
253 boost::mutex::scoped_lock lm (_mutex);
255 if (_crop.left == c) {
262 signal_changed (VideoContentProperty::VIDEO_CROP);
266 VideoContent::set_right_crop (int c)
269 boost::mutex::scoped_lock lm (_mutex);
270 if (_crop.right == c) {
277 signal_changed (VideoContentProperty::VIDEO_CROP);
281 VideoContent::set_top_crop (int c)
284 boost::mutex::scoped_lock lm (_mutex);
285 if (_crop.top == c) {
292 signal_changed (VideoContentProperty::VIDEO_CROP);
296 VideoContent::set_bottom_crop (int c)
299 boost::mutex::scoped_lock lm (_mutex);
300 if (_crop.bottom == c) {
307 signal_changed (VideoContentProperty::VIDEO_CROP);
311 VideoContent::set_scale (VideoContentScale s)
314 boost::mutex::scoped_lock lm (_mutex);
322 signal_changed (VideoContentProperty::VIDEO_SCALE);
325 /** @return string which includes everything about how this content looks */
327 VideoContent::identifier () const
330 s << Content::identifier()
331 << "_" << crop().left
332 << "_" << crop().right
334 << "_" << crop().bottom
335 << "_" << scale().id();
337 if (colour_conversion()) {
338 s << "_" << colour_conversion().get().identifier ();
345 VideoContent::set_video_frame_type (VideoFrameType t)
348 boost::mutex::scoped_lock lm (_mutex);
349 _video_frame_type = t;
352 signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
356 VideoContent::technical_summary () const
358 string s = String::compose (
359 N_("video: length %1 frames, size %2x%3, rate %4"),
360 video_length_after_3d_combine(),
366 if (sample_aspect_ratio ()) {
367 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
374 VideoContent::video_size_after_3d_split () const
376 dcp::Size const s = video_size ();
377 switch (video_frame_type ()) {
378 case VIDEO_FRAME_TYPE_2D:
379 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
380 case VIDEO_FRAME_TYPE_3D_LEFT:
381 case VIDEO_FRAME_TYPE_3D_RIGHT:
383 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
384 return dcp::Size (s.width / 2, s.height);
385 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
386 return dcp::Size (s.width, s.height / 2);
389 DCPOMATIC_ASSERT (false);
393 VideoContent::unset_colour_conversion (bool signal)
396 boost::mutex::scoped_lock lm (_mutex);
397 _colour_conversion = boost::optional<ColourConversion> ();
401 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
406 VideoContent::set_colour_conversion (ColourConversion c)
409 boost::mutex::scoped_lock lm (_mutex);
410 _colour_conversion = c;
413 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
417 VideoContent::set_fade_in (Frame t)
420 boost::mutex::scoped_lock lm (_mutex);
424 signal_changed (VideoContentProperty::VIDEO_FADE_IN);
428 VideoContent::set_fade_out (Frame t)
431 boost::mutex::scoped_lock lm (_mutex);
435 signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
438 /** @return Video size after 3D split and crop */
440 VideoContent::video_size_after_crop () const
442 return crop().apply (video_size_after_3d_split ());
446 VideoContent::scale_and_crop_to_fit_width ()
448 shared_ptr<const Film> film = _film.lock ();
449 DCPOMATIC_ASSERT (film);
451 set_scale (VideoContentScale (film->container ()));
453 int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
454 set_top_crop (crop / 2);
455 set_bottom_crop (crop / 2);
459 VideoContent::scale_and_crop_to_fit_height ()
461 shared_ptr<const Film> film = _film.lock ();
462 DCPOMATIC_ASSERT (film);
464 set_scale (VideoContentScale (film->container ()));
466 int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
467 set_left_crop (crop / 2);
468 set_right_crop (crop / 2);
472 VideoContent::set_video_frame_rate (float r)
475 boost::mutex::scoped_lock lm (_mutex);
476 if (_video_frame_rate == r) {
480 _video_frame_rate = r;
483 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
487 VideoContent::fade (Frame f) const
489 DCPOMATIC_ASSERT (f >= 0);
492 return float (f) / fade_in();
495 Frame fade_out_start = video_length() - fade_out();
496 if (f >= fade_out_start) {
497 return 1 - float (f - fade_out_start) / fade_out();
500 return optional<float> ();
504 VideoContent::processing_description () const
506 /* stringstream is OK here as this string is just for presentation to the user */
509 if (video_size().width && video_size().height) {
510 d << String::compose (
511 _("Content video is %1x%2"),
512 video_size_after_3d_split().width,
513 video_size_after_3d_split().height
517 float ratio = video_size_after_3d_split().ratio ();
519 if (sample_aspect_ratio ()) {
520 d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
521 ratio *= sample_aspect_ratio().get ();
524 d << "\n" << _("Display aspect ratio") << " " << fixed << setprecision(2) << ratio << ":1\n";
527 if ((crop().left || crop().right || crop().top || crop().bottom) && video_size() != dcp::Size (0, 0)) {
528 dcp::Size cropped = video_size_after_crop ();
529 d << String::compose (
530 _("Cropped to %1x%2"),
531 cropped.width, cropped.height
534 d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
537 shared_ptr<const Film> film = _film.lock ();
538 DCPOMATIC_ASSERT (film);
540 dcp::Size const container_size = film->frame_size ();
541 dcp::Size const scaled = scale().size (dynamic_pointer_cast<const VideoContent> (shared_from_this ()), container_size, container_size);
543 if (scaled != video_size_after_crop ()) {
544 d << String::compose (
545 _("Scaled to %1x%2"),
546 scaled.width, scaled.height
549 d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
552 if (scaled != container_size) {
553 d << String::compose (
554 _("Padded with black to fit container %1 (%2x%3)"),
555 film->container()->nickname (),
556 container_size.width, container_size.height
559 d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
562 d << _("Content frame rate");
563 d << " " << fixed << setprecision(4) << video_frame_rate() << "\n";
565 FrameRateChange frc (video_frame_rate(), film->video_frame_rate ());
566 d << frc.description () << "\n";