2 Copyright (C) 2013-2022 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/>.
22 #include "colour_conversion.h"
23 #include "compose.hpp"
26 #include "dcpomatic_log.h"
27 #include "exceptions.h"
29 #include "frame_rate_change.h"
33 #include "video_content.h"
34 #include "video_examiner.h"
35 #include <dcp/raw_convert.h>
36 #include <libcxml/cxml.h>
37 #include <libxml++/libxml++.h>
44 int const VideoContentProperty::USE = 0;
45 int const VideoContentProperty::SIZE = 1;
46 int const VideoContentProperty::FRAME_TYPE = 2;
47 int const VideoContentProperty::CROP = 3;
48 int const VideoContentProperty::COLOUR_CONVERSION = 4;
49 int const VideoContentProperty::FADE_IN = 5;
50 int const VideoContentProperty::FADE_OUT = 6;
51 int const VideoContentProperty::RANGE = 7;
52 int const VideoContentProperty::CUSTOM_RATIO = 8;
53 int const VideoContentProperty::CUSTOM_SIZE = 9;
54 int const VideoContentProperty::BURNT_SUBTITLE_LANGUAGE = 10;
58 using std::dynamic_pointer_cast;
61 using std::make_shared;
65 using std::setprecision;
66 using std::setprecision;
67 using std::shared_ptr;
70 using boost::optional;
71 using dcp::raw_convert;
72 using namespace dcpomatic;
75 VideoContent::VideoContent (Content* parent)
76 : ContentPart (parent)
79 , _frame_type (VideoFrameType::TWO_D)
83 , _range (VideoRange::FULL)
89 /** @param video_range_hint Video range to use if none is given in the XML */
90 shared_ptr<VideoContent>
91 VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version, VideoRange video_range_hint)
93 if (!node->optional_number_child<int> ("VideoWidth")) {
97 return make_shared<VideoContent>(parent, node, version, video_range_hint);
101 /** @param video_range_hint Video range to use if none is given in the XML */
102 VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version, VideoRange video_range_hint)
103 : ContentPart (parent)
105 _size.width = node->number_child<int> ("VideoWidth");
106 _size.height = node->number_child<int> ("VideoHeight");
108 /* Backwards compatibility */
109 auto r = node->optional_number_child<double>("VideoFrameRate");
111 _parent->set_video_frame_rate (r.get ());
114 _use = node->optional_bool_child("Use").get_value_or(true);
115 _length = node->number_child<Frame> ("VideoLength");
118 /* Snapshot of the VideoFrameType enum at version 34 */
119 switch (node->number_child<int> ("VideoFrameType")) {
121 _frame_type = VideoFrameType::TWO_D;
124 _frame_type = VideoFrameType::THREE_D_LEFT_RIGHT;
127 _frame_type = VideoFrameType::THREE_D_TOP_BOTTOM;
130 _frame_type = VideoFrameType::THREE_D_ALTERNATE;
133 _frame_type = VideoFrameType::THREE_D_LEFT;
136 _frame_type = VideoFrameType::THREE_D_RIGHT;
140 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
143 _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
144 _crop.left = node->number_child<int> ("LeftCrop");
145 _crop.right = node->number_child<int> ("RightCrop");
146 _crop.top = node->number_child<int> ("TopCrop");
147 _crop.bottom = node->number_child<int> ("BottomCrop");
150 auto r = node->optional_string_child ("Ratio");
152 _legacy_ratio = Ratio::from_id(r.get())->ratio();
154 } else if (version <= 37) {
155 auto ratio = node->node_child("Scale")->optional_string_child("Ratio");
157 _legacy_ratio = Ratio::from_id(ratio.get())->ratio();
159 auto scale = node->node_child("Scale")->optional_bool_child("Scale");
162 /* This is what we used to call "no stretch" */
163 _legacy_ratio = _size.ratio();
165 /* This is what we used to call "no scale" */
166 _custom_size = _size;
171 _custom_ratio = node->optional_number_child<float>("CustomRatio");
172 if (node->optional_number_child<int>("CustomWidth")) {
173 _custom_size = dcp::Size (node->number_child<int>("CustomWidth"), node->number_child<int>("CustomHeight"));
177 if (node->optional_node_child ("ColourConversion")) {
178 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
181 _yuv = node->optional_bool_child("YUV").get_value_or (true);
184 /* These should be VideoFadeIn and VideoFadeOut but we'll leave them like this until 2.18.x */
185 _fade_in = node->number_child<Frame> ("FadeIn");
186 _fade_out = node->number_child<Frame> ("FadeOut");
188 _fade_in = _fade_out = 0;
191 auto video_range = node->optional_string_child("Range");
193 _range = video_range_hint;
194 } else if (*video_range == "full") {
195 _range = VideoRange::FULL;
197 _range = VideoRange::VIDEO;
200 if (auto pixel_quanta = node->optional_node_child("PixelQuanta")) {
201 _pixel_quanta = PixelQuanta(pixel_quanta);
204 auto burnt = node->optional_string_child("BurntSubtitleLanguage");
206 _burnt_subtitle_language = dcp::LanguageTag (*burnt);
212 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
213 : ContentPart (parent)
217 auto ref = c[0]->video;
218 DCPOMATIC_ASSERT (ref);
220 for (size_t i = 1; i < c.size(); ++i) {
222 if (c[i]->video->use() != ref->use()) {
223 throw JoinError (_("Content to be joined must have all its video used or not used."));
226 if (c[i]->video->size() != ref->size()) {
227 throw JoinError (_("Content to be joined must have the same picture size."));
230 if (c[i]->video->frame_type() != ref->frame_type()) {
231 throw JoinError (_("Content to be joined must have the same video frame type."));
234 if (c[i]->video->requested_crop() != ref->requested_crop()) {
235 throw JoinError (_("Content to be joined must have the same crop."));
238 if (c[i]->video->custom_ratio() != ref->custom_ratio()) {
239 throw JoinError (_("Content to be joined must have the same custom ratio setting."));
242 if (c[i]->video->custom_size() != ref->custom_size()) {
243 throw JoinError (_("Content to be joined must have the same custom size setting."));
246 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
247 throw JoinError (_("Content to be joined must have the same colour conversion."));
250 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
251 throw JoinError (_("Content to be joined must have the same fades."));
254 if (c[i]->video->burnt_subtitle_language() != ref->burnt_subtitle_language()) {
255 throw JoinError (_("Content to be joined must have the same burnt subtitle language."));
258 _length += c[i]->video->length ();
260 if (c[i]->video->yuv ()) {
264 _pixel_quanta = max(_pixel_quanta, c[i]->video->_pixel_quanta);
268 _size = ref->size ();
269 _frame_type = ref->frame_type ();
270 _crop = ref->requested_crop ();
271 _custom_ratio = ref->custom_ratio ();
272 _colour_conversion = ref->colour_conversion ();
273 _fade_in = ref->fade_in ();
274 _fade_out = ref->fade_out ();
275 _range = ref->range ();
276 _burnt_subtitle_language = ref->burnt_subtitle_language ();
281 VideoContent::as_xml (xmlpp::Node* node) const
283 boost::mutex::scoped_lock lm (_mutex);
284 node->add_child("Use")->add_child_text (_use ? "1" : "0");
285 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
286 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
287 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
288 node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
289 if (_sample_aspect_ratio) {
290 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
294 node->add_child("CustomRatio")->add_child_text(raw_convert<string>(*_custom_ratio));
297 node->add_child("CustomWidth")->add_child_text(raw_convert<string>(_custom_size->width));
298 node->add_child("CustomHeight")->add_child_text(raw_convert<string>(_custom_size->height));
300 if (_colour_conversion) {
301 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
303 node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
304 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
305 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
306 node->add_child("Range")->add_child_text(_range == VideoRange::FULL ? "full" : "video");
307 _pixel_quanta.as_xml(node->add_child("PixelQuanta"));
308 if (_burnt_subtitle_language) {
309 node->add_child("BurntSubtitleLanguage")->add_child_text(_burnt_subtitle_language->to_string());
314 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
316 /* These examiner calls could call other content methods which take a lock on the mutex */
317 auto const vs = d->video_size ();
318 auto vl = d->video_length ();
319 auto const ar = d->sample_aspect_ratio ();
320 auto const yuv = d->yuv ();
321 auto const range = d->range ();
322 auto const pixel_quanta = d->pixel_quanta ();
324 ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
325 ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
326 ContentChangeSignaller cc3 (_parent, VideoContentProperty::RANGE);
329 boost::mutex::scoped_lock lm (_mutex);
332 _sample_aspect_ratio = ar;
335 _pixel_quanta = pixel_quanta;
338 LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
340 if (d->video_frame_rate()) {
341 _parent->set_video_frame_rate (d->video_frame_rate().get());
345 /** @return string which includes everything about how this content looks */
347 VideoContent::identifier () const
350 auto const crop = actual_crop();
352 buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d",
358 _custom_ratio.get_value_or(0),
359 _custom_size ? _custom_size->width : 0,
360 _custom_size ? _custom_size->height : 0,
363 _range == VideoRange::FULL ? 0 : 1
368 if (colour_conversion()) {
369 s += "_" + colour_conversion().get().identifier ();
376 VideoContent::technical_summary () const
378 string s = String::compose (
379 N_("video: length %1 frames, size %2x%3"),
380 length_after_3d_combine(),
385 if (sample_aspect_ratio ()) {
386 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
393 VideoContent::size_after_3d_split () const
395 auto const s = size ();
396 switch (frame_type ()) {
397 case VideoFrameType::TWO_D:
398 case VideoFrameType::THREE_D:
399 case VideoFrameType::THREE_D_ALTERNATE:
400 case VideoFrameType::THREE_D_LEFT:
401 case VideoFrameType::THREE_D_RIGHT:
403 case VideoFrameType::THREE_D_LEFT_RIGHT:
404 return dcp::Size (s.width / 2, s.height);
405 case VideoFrameType::THREE_D_TOP_BOTTOM:
406 return dcp::Size (s.width, s.height / 2);
409 DCPOMATIC_ASSERT (false);
412 /** @return Video size after 3D split and crop */
414 VideoContent::size_after_crop () const
416 return actual_crop().apply(size_after_3d_split());
420 /** @param f Frame index within the whole (untrimmed) content.
421 * @return Fade factor (between 0 and 1) or unset if there is no fade.
424 VideoContent::fade (shared_ptr<const Film> film, Frame f) const
426 DCPOMATIC_ASSERT (f >= 0);
428 double const vfr = _parent->active_video_frame_rate(film);
430 auto const ts = _parent->trim_start().frames_round(vfr);
431 if ((f - ts) < fade_in()) {
432 return double (f - ts) / fade_in();
435 auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
436 if (f >= fade_out_start) {
437 return 1 - double (f - fade_out_start) / fade_out();
440 return optional<double> ();
444 VideoContent::processing_description (shared_ptr<const Film> film)
449 if (size().width && size().height) {
450 d += String::compose (
451 _("Content video is %1x%2"),
452 size_after_3d_split().width,
453 size_after_3d_split().height
457 double ratio = size_after_3d_split().ratio ();
459 if (sample_aspect_ratio ()) {
460 snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
462 ratio *= sample_aspect_ratio().get ();
465 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
469 auto const crop = actual_crop();
471 if ((crop.left || crop.right || crop.top || crop.bottom) && size() != dcp::Size(0, 0)) {
472 auto const cropped = size_after_crop ();
473 d += String::compose (
474 _("\nCropped to %1x%2"),
475 cropped.width, cropped.height
478 snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio());
482 auto const container_size = film->frame_size ();
483 auto const scaled = scaled_size (container_size);
485 if (scaled != size_after_crop ()) {
486 d += String::compose (
487 _("\nScaled to %1x%2"),
488 scaled.width, scaled.height
491 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio());
495 if (scaled != container_size) {
496 d += String::compose (
497 _("\nPadded with black to fit container %1 (%2x%3)"),
498 film->container()->container_nickname (),
499 container_size.width, container_size.height
502 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
506 if (_parent->video_frame_rate()) {
507 double const vfr = _parent->video_frame_rate().get ();
509 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
512 FrameRateChange frc (vfr, film->video_frame_rate ());
513 d += frc.description ();
520 VideoContent::add_properties (list<UserProperty>& p) const
522 p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
523 p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
527 VideoContent::set_length (Frame len)
529 maybe_set (_length, len, ContentProperty::LENGTH);
533 VideoContent::set_crop (Crop c)
535 maybe_set (_crop, c, VideoContentProperty::CROP);
539 VideoContent::set_left_crop (int c)
541 maybe_set (_crop.left, c, VideoContentProperty::CROP);
545 VideoContent::set_right_crop (int c)
547 maybe_set (_crop.right, c, VideoContentProperty::CROP);
551 VideoContent::set_top_crop (int c)
553 maybe_set (_crop.top, c, VideoContentProperty::CROP);
557 VideoContent::set_bottom_crop (int c)
559 maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
564 VideoContent::set_frame_type (VideoFrameType t)
566 maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
570 VideoContent::unset_colour_conversion ()
572 maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
576 VideoContent::set_colour_conversion (ColourConversion c)
578 maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
582 VideoContent::set_fade_in (Frame t)
584 maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
588 VideoContent::set_fade_out (Frame t)
590 maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
594 VideoContent::set_range (VideoRange r)
596 maybe_set (_range, r, VideoContentProperty::RANGE);
600 VideoContent::set_use (bool u)
602 maybe_set (_use, u, VideoContentProperty::USE);
607 VideoContent::set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language)
609 maybe_set (_burnt_subtitle_language, language, VideoContentProperty::BURNT_SUBTITLE_LANGUAGE);
614 VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
616 if (c->_colour_conversion) {
617 set_colour_conversion (c->_colour_conversion.get());
619 unset_colour_conversion ();
622 set_frame_type (c->_frame_type);
623 set_left_crop (c->_crop.left);
624 set_right_crop (c->_crop.right);
625 set_top_crop (c->_crop.top);
626 set_bottom_crop (c->_crop.bottom);
627 set_custom_ratio (c->_custom_ratio);
628 set_custom_size (c->_custom_size);
629 set_fade_in (c->_fade_in);
630 set_fade_out (c->_fade_out);
631 set_burnt_subtitle_language (c->_burnt_subtitle_language);
636 VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
638 pos = pos.round (film->video_frame_rate());
642 VideoContent::modify_trim_start (ContentTime& trim) const
644 if (_parent->video_frame_rate()) {
645 trim = trim.round (_parent->video_frame_rate().get());
650 /** @param film_container The size of the container for the DCP that we are working on */
652 VideoContent::scaled_size (dcp::Size film_container)
655 return fit_ratio_within(*_custom_ratio, film_container);
659 return *_custom_size;
662 auto size = size_after_crop ();
663 size.width *= _sample_aspect_ratio.get_value_or(1);
665 /* This is what we will return unless there is any legacy stuff to take into account */
666 auto auto_size = fit_ratio_within (size.ratio(), film_container);
669 if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) {
670 _custom_ratio = *_legacy_ratio;
671 _legacy_ratio = optional<float>();
672 return fit_ratio_within(*_custom_ratio, film_container);
674 _legacy_ratio = boost::optional<float>();
677 return _pixel_quanta.round (auto_size);
682 VideoContent::set_custom_ratio (optional<float> ratio)
684 maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
689 VideoContent::set_custom_size (optional<dcp::Size> size)
691 maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
696 VideoContent::actual_crop () const
699 _pixel_quanta.round_x(_crop.left),
700 _pixel_quanta.round_x(_crop.right),
701 _pixel_quanta.round_y(_crop.top),
702 _pixel_quanta.round_y(_crop.bottom)