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 auto burnt = node->optional_string_child("BurntSubtitleLanguage");
189 _burnt_subtitle_language = dcp::LanguageTag (*burnt);
195 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
196 : ContentPart (parent)
200 auto ref = c[0]->video;
201 DCPOMATIC_ASSERT (ref);
203 for (size_t i = 1; i < c.size(); ++i) {
205 if (c[i]->video->use() != ref->use()) {
206 throw JoinError (_("Content to be joined must have all its video used or not used."));
209 if (c[i]->video->size() != ref->size()) {
210 throw JoinError (_("Content to be joined must have the same picture size."));
213 if (c[i]->video->frame_type() != ref->frame_type()) {
214 throw JoinError (_("Content to be joined must have the same video frame type."));
217 if (c[i]->video->crop() != ref->crop()) {
218 throw JoinError (_("Content to be joined must have the same crop."));
221 if (c[i]->video->custom_ratio() != ref->custom_ratio()) {
222 throw JoinError (_("Content to be joined must have the same custom ratio setting."));
225 if (c[i]->video->custom_size() != ref->custom_size()) {
226 throw JoinError (_("Content to be joined must have the same custom size setting."));
229 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
230 throw JoinError (_("Content to be joined must have the same colour conversion."));
233 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
234 throw JoinError (_("Content to be joined must have the same fades."));
237 if (c[i]->video->burnt_subtitle_language() != ref->burnt_subtitle_language()) {
238 throw JoinError (_("Content to be joined must have the same burnt subtitle language."));
241 _length += c[i]->video->length ();
243 if (c[i]->video->yuv ()) {
249 _size = ref->size ();
250 _frame_type = ref->frame_type ();
251 _crop = ref->crop ();
252 _custom_ratio = ref->custom_ratio ();
253 _colour_conversion = ref->colour_conversion ();
254 _fade_in = ref->fade_in ();
255 _fade_out = ref->fade_out ();
256 _range = ref->range ();
257 _burnt_subtitle_language = ref->burnt_subtitle_language ();
262 VideoContent::as_xml (xmlpp::Node* node) const
264 boost::mutex::scoped_lock lm (_mutex);
265 node->add_child("Use")->add_child_text (_use ? "1" : "0");
266 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
267 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
268 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
269 node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
270 if (_sample_aspect_ratio) {
271 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
275 node->add_child("CustomRatio")->add_child_text(raw_convert<string>(*_custom_ratio));
278 node->add_child("CustomWidth")->add_child_text(raw_convert<string>(_custom_size->width));
279 node->add_child("CustomHeight")->add_child_text(raw_convert<string>(_custom_size->height));
281 if (_colour_conversion) {
282 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
284 node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
285 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
286 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
287 node->add_child("Range")->add_child_text(_range == VideoRange::FULL ? "full" : "video");
288 if (_burnt_subtitle_language) {
289 node->add_child("BurntSubtitleLanguage")->add_child_text(_burnt_subtitle_language->to_string());
294 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
296 /* These examiner calls could call other content methods which take a lock on the mutex */
297 auto const vs = d->video_size ();
298 auto vl = d->video_length ();
299 auto const ar = d->sample_aspect_ratio ();
300 auto const yuv = d->yuv ();
301 auto const range = d->range ();
303 ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
304 ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
305 ContentChangeSignaller cc3 (_parent, VideoContentProperty::RANGE);
308 boost::mutex::scoped_lock lm (_mutex);
311 _sample_aspect_ratio = ar;
316 LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
318 if (d->video_frame_rate()) {
319 _parent->set_video_frame_rate (d->video_frame_rate().get());
323 /** @return string which includes everything about how this content looks */
325 VideoContent::identifier () const
329 buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d",
335 _custom_ratio.get_value_or(0),
336 _custom_size ? _custom_size->width : 0,
337 _custom_size ? _custom_size->height : 0,
340 _range == VideoRange::FULL ? 0 : 1
345 if (colour_conversion()) {
346 s += "_" + colour_conversion().get().identifier ();
353 VideoContent::technical_summary () const
355 string s = String::compose (
356 N_("video: length %1 frames, size %2x%3"),
357 length_after_3d_combine(),
362 if (sample_aspect_ratio ()) {
363 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
370 VideoContent::size_after_3d_split () const
372 auto const s = size ();
373 switch (frame_type ()) {
374 case VideoFrameType::TWO_D:
375 case VideoFrameType::THREE_D:
376 case VideoFrameType::THREE_D_ALTERNATE:
377 case VideoFrameType::THREE_D_LEFT:
378 case VideoFrameType::THREE_D_RIGHT:
380 case VideoFrameType::THREE_D_LEFT_RIGHT:
381 return dcp::Size (s.width / 2, s.height);
382 case VideoFrameType::THREE_D_TOP_BOTTOM:
383 return dcp::Size (s.width, s.height / 2);
386 DCPOMATIC_ASSERT (false);
389 /** @return Video size after 3D split and crop */
391 VideoContent::size_after_crop () const
393 return crop().apply (size_after_3d_split ());
397 /** @param f Frame index within the whole (untrimmed) content.
398 * @return Fade factor (between 0 and 1) or unset if there is no fade.
401 VideoContent::fade (shared_ptr<const Film> film, Frame f) const
403 DCPOMATIC_ASSERT (f >= 0);
405 double const vfr = _parent->active_video_frame_rate(film);
407 auto const ts = _parent->trim_start().frames_round(vfr);
408 if ((f - ts) < fade_in()) {
409 return double (f - ts) / fade_in();
412 auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
413 if (f >= fade_out_start) {
414 return 1 - double (f - fade_out_start) / fade_out();
417 return optional<double> ();
421 VideoContent::processing_description (shared_ptr<const Film> film)
426 if (size().width && size().height) {
427 d += String::compose (
428 _("Content video is %1x%2"),
429 size_after_3d_split().width,
430 size_after_3d_split().height
434 double ratio = size_after_3d_split().ratio ();
436 if (sample_aspect_ratio ()) {
437 snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
439 ratio *= sample_aspect_ratio().get ();
442 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
446 if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) {
447 dcp::Size cropped = size_after_crop ();
448 d += String::compose (
449 _("\nCropped to %1x%2"),
450 cropped.width, cropped.height
453 snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio());
457 auto const container_size = film->frame_size ();
458 auto const scaled = scaled_size (container_size);
460 if (scaled != size_after_crop ()) {
461 d += String::compose (
462 _("\nScaled to %1x%2"),
463 scaled.width, scaled.height
466 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio());
470 if (scaled != container_size) {
471 d += String::compose (
472 _("\nPadded with black to fit container %1 (%2x%3)"),
473 film->container()->container_nickname (),
474 container_size.width, container_size.height
477 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
481 if (_parent->video_frame_rate()) {
482 double const vfr = _parent->video_frame_rate().get ();
484 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
487 FrameRateChange frc (vfr, film->video_frame_rate ());
488 d += frc.description ();
495 VideoContent::add_properties (list<UserProperty>& p) const
497 p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
498 p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
502 VideoContent::set_length (Frame len)
504 maybe_set (_length, len, ContentProperty::LENGTH);
508 VideoContent::set_left_crop (int c)
510 maybe_set (_crop.left, c, VideoContentProperty::CROP);
514 VideoContent::set_right_crop (int c)
516 maybe_set (_crop.right, c, VideoContentProperty::CROP);
520 VideoContent::set_top_crop (int c)
522 maybe_set (_crop.top, c, VideoContentProperty::CROP);
526 VideoContent::set_bottom_crop (int c)
528 maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
533 VideoContent::set_frame_type (VideoFrameType t)
535 maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
539 VideoContent::unset_colour_conversion ()
541 maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
545 VideoContent::set_colour_conversion (ColourConversion c)
547 maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
551 VideoContent::set_fade_in (Frame t)
553 maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
557 VideoContent::set_fade_out (Frame t)
559 maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
563 VideoContent::set_range (VideoRange r)
565 maybe_set (_range, r, VideoContentProperty::RANGE);
569 VideoContent::set_use (bool u)
571 maybe_set (_use, u, VideoContentProperty::USE);
576 VideoContent::set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language)
578 maybe_set (_burnt_subtitle_language, language, VideoContentProperty::BURNT_SUBTITLE_LANGUAGE);
583 VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
585 if (c->_colour_conversion) {
586 set_colour_conversion (c->_colour_conversion.get());
588 unset_colour_conversion ();
591 set_frame_type (c->_frame_type);
592 set_left_crop (c->_crop.left);
593 set_right_crop (c->_crop.right);
594 set_top_crop (c->_crop.top);
595 set_bottom_crop (c->_crop.bottom);
596 set_custom_ratio (c->_custom_ratio);
597 set_custom_size (c->_custom_size);
598 set_fade_in (c->_fade_in);
599 set_fade_out (c->_fade_out);
600 set_burnt_subtitle_language (c->_burnt_subtitle_language);
605 VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
607 pos = pos.round (film->video_frame_rate());
611 VideoContent::modify_trim_start (ContentTime& trim) const
613 if (_parent->video_frame_rate()) {
614 trim = trim.round (_parent->video_frame_rate().get());
619 /** @param film_container The size of the container for the DCP that we are working on */
621 VideoContent::scaled_size (dcp::Size film_container)
624 return fit_ratio_within(*_custom_ratio, film_container);
628 return *_custom_size;
631 auto size = size_after_crop ();
632 size.width *= _sample_aspect_ratio.get_value_or(1);
634 /* This is what we will return unless there is any legacy stuff to take into account */
635 auto auto_size = fit_ratio_within (size.ratio(), film_container);
638 if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) {
639 _custom_ratio = *_legacy_ratio;
640 _legacy_ratio = optional<float>();
641 return fit_ratio_within(*_custom_ratio, film_container);
643 _legacy_ratio = boost::optional<float>();
651 VideoContent::set_custom_ratio (optional<float> ratio)
653 maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
658 VideoContent::set_custom_size (optional<dcp::Size> size)
660 maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);