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 = dcp::Size(node->number_child<int>("VideoWidth"), node->number_child<int>("VideoHeight"));
107 _use = node->optional_bool_child("Use").get_value_or(true);
108 _length = node->number_child<Frame> ("VideoLength");
111 /* Snapshot of the VideoFrameType enum at version 34 */
112 switch (node->number_child<int> ("VideoFrameType")) {
114 _frame_type = VideoFrameType::TWO_D;
117 _frame_type = VideoFrameType::THREE_D_LEFT_RIGHT;
120 _frame_type = VideoFrameType::THREE_D_TOP_BOTTOM;
123 _frame_type = VideoFrameType::THREE_D_ALTERNATE;
126 _frame_type = VideoFrameType::THREE_D_LEFT;
129 _frame_type = VideoFrameType::THREE_D_RIGHT;
133 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
136 _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
137 _crop.left = node->number_child<int> ("LeftCrop");
138 _crop.right = node->number_child<int> ("RightCrop");
139 _crop.top = node->number_child<int> ("TopCrop");
140 _crop.bottom = node->number_child<int> ("BottomCrop");
143 auto r = node->optional_string_child ("Ratio");
145 _legacy_ratio = Ratio::from_id(r.get())->ratio();
147 } else if (version <= 37) {
148 auto ratio = node->node_child("Scale")->optional_string_child("Ratio");
150 _legacy_ratio = Ratio::from_id(ratio.get())->ratio();
152 auto scale = node->node_child("Scale")->optional_bool_child("Scale");
155 /* This is what we used to call "no stretch" */
156 DCPOMATIC_ASSERT(_size);
157 _legacy_ratio = _size->ratio();
159 /* This is what we used to call "no scale" */
160 DCPOMATIC_ASSERT(_size);
161 _custom_size = *_size;
166 _custom_ratio = node->optional_number_child<float>("CustomRatio");
167 if (node->optional_number_child<int>("CustomWidth")) {
168 _custom_size = dcp::Size (node->number_child<int>("CustomWidth"), node->number_child<int>("CustomHeight"));
172 if (node->optional_node_child ("ColourConversion")) {
173 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
176 _yuv = node->optional_bool_child("YUV").get_value_or (true);
179 /* These should be VideoFadeIn and VideoFadeOut but we'll leave them like this until 2.18.x */
180 _fade_in = node->number_child<Frame> ("FadeIn");
181 _fade_out = node->number_child<Frame> ("FadeOut");
183 _fade_in = _fade_out = 0;
186 auto video_range = node->optional_string_child("Range");
188 _range = video_range_hint;
189 } else if (*video_range == "full") {
190 _range = VideoRange::FULL;
192 _range = VideoRange::VIDEO;
195 if (auto pixel_quanta = node->optional_node_child("PixelQuanta")) {
196 _pixel_quanta = PixelQuanta(pixel_quanta);
199 auto burnt = node->optional_string_child("BurntSubtitleLanguage");
201 _burnt_subtitle_language = dcp::LanguageTag (*burnt);
207 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
208 : ContentPart (parent)
212 auto ref = c[0]->video;
213 DCPOMATIC_ASSERT (ref);
215 for (size_t i = 1; i < c.size(); ++i) {
217 if (c[i]->video->use() != ref->use()) {
218 throw JoinError (_("Content to be joined must have all its video used or not used."));
221 if (c[i]->video->size() != ref->size()) {
222 throw JoinError (_("Content to be joined must have the same picture size."));
225 if (c[i]->video->frame_type() != ref->frame_type()) {
226 throw JoinError (_("Content to be joined must have the same video frame type."));
229 if (c[i]->video->requested_crop() != ref->requested_crop()) {
230 throw JoinError (_("Content to be joined must have the same crop."));
233 if (c[i]->video->custom_ratio() != ref->custom_ratio()) {
234 throw JoinError (_("Content to be joined must have the same custom ratio setting."));
237 if (c[i]->video->custom_size() != ref->custom_size()) {
238 throw JoinError (_("Content to be joined must have the same custom size setting."));
241 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
242 throw JoinError (_("Content to be joined must have the same colour conversion."));
245 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
246 throw JoinError (_("Content to be joined must have the same fades."));
249 if (c[i]->video->burnt_subtitle_language() != ref->burnt_subtitle_language()) {
250 throw JoinError (_("Content to be joined must have the same burnt subtitle language."));
253 _length += c[i]->video->length ();
255 if (c[i]->video->yuv ()) {
259 _pixel_quanta = max(_pixel_quanta, c[i]->video->_pixel_quanta);
263 _size = ref->size ();
264 _frame_type = ref->frame_type ();
265 _crop = ref->requested_crop ();
266 _custom_ratio = ref->custom_ratio ();
267 _colour_conversion = ref->colour_conversion ();
268 _fade_in = ref->fade_in ();
269 _fade_out = ref->fade_out ();
270 _range = ref->range ();
271 _burnt_subtitle_language = ref->burnt_subtitle_language ();
276 VideoContent::as_xml(xmlpp::Element* element) const
278 boost::mutex::scoped_lock lm (_mutex);
279 cxml::add_text_child(element, "Use", _use ? "1" : "0");
281 cxml::add_text_child(element, "VideoLength", raw_convert<string>(_length));
282 cxml::add_text_child(element, "VideoWidth", raw_convert<string>(_size.width));
284 cxml::add_text_child(element, "VideoHeight", raw_convert<string>(_size.height));
285 cxml::add_text_child(element, "VideoFrameType", video_frame_type_to_string(_frame_type));
286 if (_sample_aspect_ratio) {
287 cxml::add_text_child(element, "SampleAspectRatio", raw_convert<string> (_sample_aspect_ratio.get ()));
289 _crop.as_xml(element);
291 cxml::add_text_child(element, "CustomRatio", raw_convert<string>(*_custom_ratio));
294 cxml::add_text_child(element, "CustomWidth", raw_convert<string>(_custom_size->width));
295 cxml::add_text_child(element, "CustomHeight", raw_convert<string>(_custom_size->height));
297 if (_colour_conversion) {
298 _colour_conversion.get().as_xml(cxml::add_child(element, "ColourConversion"));
300 cxml::add_text_child(element, "YUV", _yuv ? "1" : "0");
301 cxml::add_text_child(element, "FadeIn", raw_convert<string>(_fade_in));
302 cxml::add_text_child(element, "FadeOut", raw_convert<string>(_fade_out));
303 cxml::add_text_child(element, "Range", _range == VideoRange::FULL ? "full" : "video");
304 _pixel_quanta.as_xml(cxml::add_child(element, "PixelQuanta"));
305 if (_burnt_subtitle_language) {
306 cxml::add_text_child(element, "BurntSubtitleLanguage", _burnt_subtitle_language->to_string());
311 VideoContent::take_from_examiner(shared_ptr<const Film> film, shared_ptr<VideoExaminer> d)
313 /* These examiner calls could call other content methods which take a lock on the mutex */
314 auto const vs = d->video_size ();
315 auto vl = d->video_length ();
316 auto const ar = d->sample_aspect_ratio ();
317 auto const yuv = d->yuv ();
318 auto const range = d->range ();
319 auto const pixel_quanta = d->pixel_quanta ();
321 ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
322 ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
323 ContentChangeSignaller cc3 (_parent, VideoContentProperty::RANGE);
326 boost::mutex::scoped_lock lm (_mutex);
329 _sample_aspect_ratio = ar;
332 _pixel_quanta = pixel_quanta;
335 LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
337 if (d->video_frame_rate()) {
338 _parent->set_video_frame_rate(film, d->video_frame_rate().get());
342 /** @return string which includes everything about how this content looks */
344 VideoContent::identifier () const
347 auto const crop = actual_crop();
349 buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d",
355 _custom_ratio.get_value_or(0),
356 _custom_size ? _custom_size->width : 0,
357 _custom_size ? _custom_size->height : 0,
360 _range == VideoRange::FULL ? 0 : 1
365 if (colour_conversion()) {
366 s += "_" + colour_conversion().get().identifier ();
373 VideoContent::technical_summary () const
375 string const size_string = size() ? String::compose("%1x%2", size()->width, size()->height) : _("unknown");
377 string s = String::compose (
378 N_("video: length %1 frames, size %2"),
379 length_after_3d_combine(),
383 if (sample_aspect_ratio ()) {
384 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
391 VideoContent::size_after_3d_split () const
393 auto const s = size ();
398 switch (frame_type ()) {
399 case VideoFrameType::TWO_D:
400 case VideoFrameType::THREE_D:
401 case VideoFrameType::THREE_D_ALTERNATE:
402 case VideoFrameType::THREE_D_LEFT:
403 case VideoFrameType::THREE_D_RIGHT:
405 case VideoFrameType::THREE_D_LEFT_RIGHT:
406 return dcp::Size(s->width / 2, s->height);
407 case VideoFrameType::THREE_D_TOP_BOTTOM:
408 return dcp::Size(s->width, s->height / 2);
411 DCPOMATIC_ASSERT (false);
414 /** @return Video size after 3D split and crop */
416 VideoContent::size_after_crop () const
418 auto const after_3d = size_after_3d_split();
423 return actual_crop().apply(*after_3d);
427 /** @param f Frame index within the whole (untrimmed) content.
428 * @return Fade factor (between 0 and 1) or unset if there is no fade.
431 VideoContent::fade (shared_ptr<const Film> film, Frame f) const
433 DCPOMATIC_ASSERT (f >= 0);
435 double const vfr = _parent->active_video_frame_rate(film);
437 auto const ts = _parent->trim_start().frames_round(vfr);
438 if ((f - ts) < fade_in()) {
439 return double (f - ts) / fade_in();
442 auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
443 if (f >= fade_out_start) {
444 return 1 - double (f - fade_out_start) / fade_out();
447 return optional<double> ();
451 VideoContent::processing_description (shared_ptr<const Film> film)
456 if (size() && size()->width && size()->height) {
457 d += String::compose (
458 _("Content video is %1x%2"),
459 size_after_3d_split()->width,
460 size_after_3d_split()->height
464 auto ratio = size_after_3d_split()->ratio();
466 if (sample_aspect_ratio ()) {
467 snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
469 ratio *= sample_aspect_ratio().get ();
472 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
476 auto const crop = actual_crop();
478 if ((crop.left || crop.right || crop.top || crop.bottom) && size() != dcp::Size(0, 0)) {
479 auto const cropped = size_after_crop ();
481 d += String::compose (
482 _("\nCropped to %1x%2"),
483 cropped->width, cropped->height
486 snprintf(buffer, sizeof(buffer), " (%.2f:1)", cropped->ratio());
491 auto const container_size = film->frame_size ();
492 auto const scaled = scaled_size (container_size);
494 if (scaled && *scaled != size_after_crop()) {
495 d += String::compose (
496 _("\nScaled to %1x%2"),
497 scaled->width, scaled->height
500 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled->ratio());
504 if (scaled && *scaled != container_size) {
505 d += String::compose (
506 _("\nPadded with black to fit container %1 (%2x%3)"),
507 film->container()->container_nickname (),
508 container_size.width, container_size.height
511 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
515 if (_parent->video_frame_rate()) {
516 double const vfr = _parent->video_frame_rate().get ();
518 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
521 FrameRateChange frc (vfr, film->video_frame_rate ());
522 d += frc.description ();
529 VideoContent::add_properties (list<UserProperty>& p) const
531 p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
532 if (auto s = size()) {
533 p.push_back(UserProperty(UserProperty::VIDEO, _("Size"), String::compose("%1x%2", s->width, s->height)));
538 VideoContent::set_length (Frame len)
540 maybe_set (_length, len, ContentProperty::LENGTH);
544 VideoContent::set_crop (Crop c)
546 maybe_set (_crop, c, VideoContentProperty::CROP);
550 VideoContent::set_left_crop (int c)
552 maybe_set (_crop.left, c, VideoContentProperty::CROP);
556 VideoContent::set_right_crop (int c)
558 maybe_set (_crop.right, c, VideoContentProperty::CROP);
562 VideoContent::set_top_crop (int c)
564 maybe_set (_crop.top, c, VideoContentProperty::CROP);
568 VideoContent::set_bottom_crop (int c)
570 maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
575 VideoContent::set_frame_type (VideoFrameType t)
577 maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
581 VideoContent::unset_colour_conversion ()
583 maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
587 VideoContent::set_colour_conversion (ColourConversion c)
589 maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
593 VideoContent::set_fade_in (Frame t)
595 maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
599 VideoContent::set_fade_out (Frame t)
601 maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
605 VideoContent::set_range (VideoRange r)
607 maybe_set (_range, r, VideoContentProperty::RANGE);
611 VideoContent::set_use (bool u)
613 maybe_set (_use, u, VideoContentProperty::USE);
618 VideoContent::set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language)
620 maybe_set (_burnt_subtitle_language, language, VideoContentProperty::BURNT_SUBTITLE_LANGUAGE);
625 VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
627 if (c->_colour_conversion) {
628 set_colour_conversion (c->_colour_conversion.get());
630 unset_colour_conversion ();
633 set_frame_type (c->_frame_type);
634 set_left_crop (c->_crop.left);
635 set_right_crop (c->_crop.right);
636 set_top_crop (c->_crop.top);
637 set_bottom_crop (c->_crop.bottom);
638 set_custom_ratio (c->_custom_ratio);
639 set_custom_size (c->_custom_size);
640 set_fade_in (c->_fade_in);
641 set_fade_out (c->_fade_out);
642 set_burnt_subtitle_language (c->_burnt_subtitle_language);
643 set_range(c->_range);
648 VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
650 pos = pos.round (film->video_frame_rate());
654 VideoContent::modify_trim_start (ContentTime& trim) const
656 if (_parent->video_frame_rate()) {
657 trim = trim.round (_parent->video_frame_rate().get());
662 /** @param film_container The size of the container for the DCP that we are working on */
664 VideoContent::scaled_size (dcp::Size film_container)
667 return fit_ratio_within(*_custom_ratio, film_container);
671 if (_custom_size->width <= film_container.width && _custom_size->height <= film_container.height) {
672 return *_custom_size;
674 return fit_ratio_within(_custom_size->ratio(), film_container);
677 auto size = size_after_crop ();
682 size->width = std::lrint(size->width * _sample_aspect_ratio.get_value_or(1));
684 /* This is what we will return unless there is any legacy stuff to take into account */
685 auto auto_size = fit_ratio_within(size->ratio(), film_container);
688 if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) {
689 _custom_ratio = *_legacy_ratio;
691 return fit_ratio_within(*_custom_ratio, film_container);
696 return _pixel_quanta.round (auto_size);
701 VideoContent::set_custom_ratio (optional<float> ratio)
703 maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
708 VideoContent::set_custom_size (optional<dcp::Size> size)
710 maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
715 VideoContent::actual_crop () const
718 _pixel_quanta.round_x(_crop.left),
719 _pixel_quanta.round_x(_crop.right),
720 _pixel_quanta.round_y(_crop.top),
721 _pixel_quanta.round_y(_crop.bottom)