2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "video_content.h"
23 #include "video_examiner.h"
24 #include "compose.hpp"
27 #include "colour_conversion.h"
30 #include "exceptions.h"
31 #include "frame_rate_change.h"
33 #include "dcpomatic_log.h"
34 #include <dcp/raw_convert.h>
35 #include <libcxml/cxml.h>
36 #include <libxml++/libxml++.h>
42 int const VideoContentProperty::USE = 0;
43 int const VideoContentProperty::SIZE = 1;
44 int const VideoContentProperty::FRAME_TYPE = 2;
45 int const VideoContentProperty::CROP = 3;
46 int const VideoContentProperty::COLOUR_CONVERSION = 4;
47 int const VideoContentProperty::FADE_IN = 5;
48 int const VideoContentProperty::FADE_OUT = 6;
49 int const VideoContentProperty::RANGE = 7;
50 int const VideoContentProperty::CUSTOM_RATIO = 8;
51 int const VideoContentProperty::CUSTOM_SIZE = 9;
52 int const VideoContentProperty::BURNT_SUBTITLE_LANGUAGE = 10;
55 using std::setprecision;
61 using std::setprecision;
64 using std::shared_ptr;
65 using std::make_shared;
66 using boost::optional;
67 using std::dynamic_pointer_cast;
68 using dcp::raw_convert;
69 using namespace dcpomatic;
71 VideoContent::VideoContent (Content* parent)
72 : ContentPart (parent)
75 , _frame_type (VideoFrameType::TWO_D)
79 , _range (VideoRange::FULL)
84 shared_ptr<VideoContent>
85 VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
87 if (!node->optional_number_child<int> ("VideoWidth")) {
91 return make_shared<VideoContent>(parent, node, version);
94 VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
95 : ContentPart (parent)
97 _size.width = node->number_child<int> ("VideoWidth");
98 _size.height = node->number_child<int> ("VideoHeight");
100 /* Backwards compatibility */
101 auto r = node->optional_number_child<double>("VideoFrameRate");
103 _parent->set_video_frame_rate (r.get ());
106 _use = node->optional_bool_child("Use").get_value_or(true);
107 _length = node->number_child<Frame> ("VideoLength");
110 /* Snapshot of the VideoFrameType enum at version 34 */
111 switch (node->number_child<int> ("VideoFrameType")) {
113 _frame_type = VideoFrameType::TWO_D;
116 _frame_type = VideoFrameType::THREE_D_LEFT_RIGHT;
119 _frame_type = VideoFrameType::THREE_D_TOP_BOTTOM;
122 _frame_type = VideoFrameType::THREE_D_ALTERNATE;
125 _frame_type = VideoFrameType::THREE_D_LEFT;
128 _frame_type = VideoFrameType::THREE_D_RIGHT;
132 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
135 _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
136 _crop.left = node->number_child<int> ("LeftCrop");
137 _crop.right = node->number_child<int> ("RightCrop");
138 _crop.top = node->number_child<int> ("TopCrop");
139 _crop.bottom = node->number_child<int> ("BottomCrop");
142 auto r = node->optional_string_child ("Ratio");
144 _legacy_ratio = Ratio::from_id(r.get())->ratio();
146 } else if (version <= 37) {
147 auto ratio = node->node_child("Scale")->optional_string_child("Ratio");
149 _legacy_ratio = Ratio::from_id(ratio.get())->ratio();
151 auto scale = node->node_child("Scale")->optional_bool_child("Scale");
154 /* This is what we used to call "no stretch" */
155 _legacy_ratio = _size.ratio();
157 /* This is what we used to call "no scale" */
158 _custom_size = _size;
163 _custom_ratio = node->optional_number_child<float>("CustomRatio");
164 if (node->optional_number_child<int>("CustomWidth")) {
165 _custom_size = dcp::Size (node->number_child<int>("CustomWidth"), node->number_child<int>("CustomHeight"));
169 if (node->optional_node_child ("ColourConversion")) {
170 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
173 _yuv = node->optional_bool_child("YUV").get_value_or (true);
176 _fade_in = node->number_child<Frame> ("FadeIn");
177 _fade_out = node->number_child<Frame> ("FadeOut");
179 _fade_in = _fade_out = 0;
182 _range = VideoRange::FULL;
183 if (node->optional_string_child("Range").get_value_or("full") == "video") {
184 _range = VideoRange::VIDEO;
187 if (auto pixel_quanta = node->optional_node_child("PixelQuanta")) {
188 _pixel_quanta = PixelQuanta(pixel_quanta);
191 auto burnt = node->optional_string_child("BurntSubtitleLanguage");
193 _burnt_subtitle_language = dcp::LanguageTag (*burnt);
199 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
200 : ContentPart (parent)
204 auto ref = c[0]->video;
205 DCPOMATIC_ASSERT (ref);
207 for (size_t i = 1; i < c.size(); ++i) {
209 if (c[i]->video->use() != ref->use()) {
210 throw JoinError (_("Content to be joined must have all its video used or not used."));
213 if (c[i]->video->size() != ref->size()) {
214 throw JoinError (_("Content to be joined must have the same picture size."));
217 if (c[i]->video->frame_type() != ref->frame_type()) {
218 throw JoinError (_("Content to be joined must have the same video frame type."));
221 if (c[i]->video->requested_crop() != ref->requested_crop()) {
222 throw JoinError (_("Content to be joined must have the same crop."));
225 if (c[i]->video->custom_ratio() != ref->custom_ratio()) {
226 throw JoinError (_("Content to be joined must have the same custom ratio setting."));
229 if (c[i]->video->custom_size() != ref->custom_size()) {
230 throw JoinError (_("Content to be joined must have the same custom size setting."));
233 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
234 throw JoinError (_("Content to be joined must have the same colour conversion."));
237 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
238 throw JoinError (_("Content to be joined must have the same fades."));
241 if (c[i]->video->burnt_subtitle_language() != ref->burnt_subtitle_language()) {
242 throw JoinError (_("Content to be joined must have the same burnt subtitle language."));
245 _length += c[i]->video->length ();
247 if (c[i]->video->yuv ()) {
251 _pixel_quanta = max(_pixel_quanta, c[i]->video->_pixel_quanta);
255 _size = ref->size ();
256 _frame_type = ref->frame_type ();
257 _crop = ref->requested_crop ();
258 _custom_ratio = ref->custom_ratio ();
259 _colour_conversion = ref->colour_conversion ();
260 _fade_in = ref->fade_in ();
261 _fade_out = ref->fade_out ();
262 _range = ref->range ();
263 _burnt_subtitle_language = ref->burnt_subtitle_language ();
268 VideoContent::as_xml (xmlpp::Node* node) const
270 boost::mutex::scoped_lock lm (_mutex);
271 node->add_child("Use")->add_child_text (_use ? "1" : "0");
272 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
273 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
274 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
275 node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
276 if (_sample_aspect_ratio) {
277 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
281 node->add_child("CustomRatio")->add_child_text(raw_convert<string>(*_custom_ratio));
284 node->add_child("CustomWidth")->add_child_text(raw_convert<string>(_custom_size->width));
285 node->add_child("CustomHeight")->add_child_text(raw_convert<string>(_custom_size->height));
287 if (_colour_conversion) {
288 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
290 node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
291 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
292 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
293 node->add_child("Range")->add_child_text(_range == VideoRange::FULL ? "full" : "video");
294 _pixel_quanta.as_xml(node->add_child("PixelQuanta"));
295 if (_burnt_subtitle_language) {
296 node->add_child("BurntSubtitleLanguage")->add_child_text(_burnt_subtitle_language->to_string());
301 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
303 /* These examiner calls could call other content methods which take a lock on the mutex */
304 auto const vs = d->video_size ();
305 auto vl = d->video_length ();
306 auto const ar = d->sample_aspect_ratio ();
307 auto const yuv = d->yuv ();
308 auto const range = d->range ();
309 auto const pixel_quanta = d->pixel_quanta ();
311 ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
312 ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
313 ContentChangeSignaller cc3 (_parent, VideoContentProperty::RANGE);
316 boost::mutex::scoped_lock lm (_mutex);
319 _sample_aspect_ratio = ar;
322 _pixel_quanta = pixel_quanta;
325 LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
327 if (d->video_frame_rate()) {
328 _parent->set_video_frame_rate (d->video_frame_rate().get());
332 /** @return string which includes everything about how this content looks */
334 VideoContent::identifier () const
337 auto const crop = actual_crop();
339 buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d",
345 _custom_ratio.get_value_or(0),
346 _custom_size ? _custom_size->width : 0,
347 _custom_size ? _custom_size->height : 0,
350 _range == VideoRange::FULL ? 0 : 1
355 if (colour_conversion()) {
356 s += "_" + colour_conversion().get().identifier ();
363 VideoContent::technical_summary () const
365 string s = String::compose (
366 N_("video: length %1 frames, size %2x%3"),
367 length_after_3d_combine(),
372 if (sample_aspect_ratio ()) {
373 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
380 VideoContent::size_after_3d_split () const
382 auto const s = size ();
383 switch (frame_type ()) {
384 case VideoFrameType::TWO_D:
385 case VideoFrameType::THREE_D:
386 case VideoFrameType::THREE_D_ALTERNATE:
387 case VideoFrameType::THREE_D_LEFT:
388 case VideoFrameType::THREE_D_RIGHT:
390 case VideoFrameType::THREE_D_LEFT_RIGHT:
391 return dcp::Size (s.width / 2, s.height);
392 case VideoFrameType::THREE_D_TOP_BOTTOM:
393 return dcp::Size (s.width, s.height / 2);
396 DCPOMATIC_ASSERT (false);
399 /** @return Video size after 3D split and crop */
401 VideoContent::size_after_crop () const
403 return actual_crop().apply(size_after_3d_split());
407 /** @param f Frame index within the whole (untrimmed) content.
408 * @return Fade factor (between 0 and 1) or unset if there is no fade.
411 VideoContent::fade (shared_ptr<const Film> film, Frame f) const
413 DCPOMATIC_ASSERT (f >= 0);
415 double const vfr = _parent->active_video_frame_rate(film);
417 auto const ts = _parent->trim_start().frames_round(vfr);
418 if ((f - ts) < fade_in()) {
419 return double (f - ts) / fade_in();
422 auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
423 if (f >= fade_out_start) {
424 return 1 - double (f - fade_out_start) / fade_out();
427 return optional<double> ();
431 VideoContent::processing_description (shared_ptr<const Film> film)
436 if (size().width && size().height) {
437 d += String::compose (
438 _("Content video is %1x%2"),
439 size_after_3d_split().width,
440 size_after_3d_split().height
444 double ratio = size_after_3d_split().ratio ();
446 if (sample_aspect_ratio ()) {
447 snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
449 ratio *= sample_aspect_ratio().get ();
452 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
456 auto const crop = actual_crop();
458 if ((crop.left || crop.right || crop.top || crop.bottom) && size() != dcp::Size(0, 0)) {
459 auto const cropped = size_after_crop ();
460 d += String::compose (
461 _("\nCropped to %1x%2"),
462 cropped.width, cropped.height
465 snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio());
469 auto const container_size = film->frame_size ();
470 auto const scaled = scaled_size (container_size);
472 if (scaled != size_after_crop ()) {
473 d += String::compose (
474 _("\nScaled to %1x%2"),
475 scaled.width, scaled.height
478 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio());
482 if (scaled != container_size) {
483 d += String::compose (
484 _("\nPadded with black to fit container %1 (%2x%3)"),
485 film->container()->container_nickname (),
486 container_size.width, container_size.height
489 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
493 if (_parent->video_frame_rate()) {
494 double const vfr = _parent->video_frame_rate().get ();
496 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
499 FrameRateChange frc (vfr, film->video_frame_rate ());
500 d += frc.description ();
507 VideoContent::add_properties (list<UserProperty>& p) const
509 p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
510 p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
514 VideoContent::set_length (Frame len)
516 maybe_set (_length, len, ContentProperty::LENGTH);
520 VideoContent::set_left_crop (int c)
522 maybe_set (_crop.left, c, VideoContentProperty::CROP);
526 VideoContent::set_right_crop (int c)
528 maybe_set (_crop.right, c, VideoContentProperty::CROP);
532 VideoContent::set_top_crop (int c)
534 maybe_set (_crop.top, c, VideoContentProperty::CROP);
538 VideoContent::set_bottom_crop (int c)
540 maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
545 VideoContent::set_frame_type (VideoFrameType t)
547 maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
551 VideoContent::unset_colour_conversion ()
553 maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
557 VideoContent::set_colour_conversion (ColourConversion c)
559 maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
563 VideoContent::set_fade_in (Frame t)
565 maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
569 VideoContent::set_fade_out (Frame t)
571 maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
575 VideoContent::set_range (VideoRange r)
577 maybe_set (_range, r, VideoContentProperty::RANGE);
581 VideoContent::set_use (bool u)
583 maybe_set (_use, u, VideoContentProperty::USE);
588 VideoContent::set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language)
590 maybe_set (_burnt_subtitle_language, language, VideoContentProperty::BURNT_SUBTITLE_LANGUAGE);
595 VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
597 if (c->_colour_conversion) {
598 set_colour_conversion (c->_colour_conversion.get());
600 unset_colour_conversion ();
603 set_frame_type (c->_frame_type);
604 set_left_crop (c->_crop.left);
605 set_right_crop (c->_crop.right);
606 set_top_crop (c->_crop.top);
607 set_bottom_crop (c->_crop.bottom);
608 set_custom_ratio (c->_custom_ratio);
609 set_custom_size (c->_custom_size);
610 set_fade_in (c->_fade_in);
611 set_fade_out (c->_fade_out);
612 set_burnt_subtitle_language (c->_burnt_subtitle_language);
617 VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
619 pos = pos.round (film->video_frame_rate());
623 VideoContent::modify_trim_start (ContentTime& trim) const
625 if (_parent->video_frame_rate()) {
626 trim = trim.round (_parent->video_frame_rate().get());
631 /** @param film_container The size of the container for the DCP that we are working on */
633 VideoContent::scaled_size (dcp::Size film_container)
636 return fit_ratio_within(*_custom_ratio, film_container);
640 return *_custom_size;
643 auto size = size_after_crop ();
644 size.width *= _sample_aspect_ratio.get_value_or(1);
646 /* This is what we will return unless there is any legacy stuff to take into account */
647 auto auto_size = fit_ratio_within (size.ratio(), film_container);
650 if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) {
651 _custom_ratio = *_legacy_ratio;
652 _legacy_ratio = optional<float>();
653 return fit_ratio_within(*_custom_ratio, film_container);
655 _legacy_ratio = boost::optional<float>();
658 return _pixel_quanta.round (auto_size);
663 VideoContent::set_custom_ratio (optional<float> ratio)
665 maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
670 VideoContent::set_custom_size (optional<dcp::Size> size)
672 maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
677 VideoContent::actual_crop () const
680 _pixel_quanta.round_x(_crop.left),
681 _pixel_quanta.round_x(_crop.right),
682 _pixel_quanta.round_y(_crop.top),
683 _pixel_quanta.round_y(_crop.bottom)