X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fvideo_content.cc;h=a03300a6b2310b0a06bfc50153bb2ec56646b796;hb=e0255a64d22440d718e5512f34a4f21f0d37a21b;hp=076cd6ec676765556723c7231ddc8e21e514a74f;hpb=2c4023c4f8e9ed5c09a30e28cc0bf8633b7635a3;p=dcpomatic.git diff --git a/src/lib/video_content.cc b/src/lib/video_content.cc index 076cd6ec6..fed28b5e4 100644 --- a/src/lib/video_content.cc +++ b/src/lib/video_content.cc @@ -1,239 +1,636 @@ /* - Copyright (C) 2013 Carl Hetherington + Copyright (C) 2013-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ -#include -#include #include "video_content.h" +#include "content.h" #include "video_examiner.h" -#include "ratio.h" #include "compose.hpp" +#include "ratio.h" +#include "config.h" +#include "colour_conversion.h" +#include "util.h" +#include "film.h" +#include "exceptions.h" +#include "frame_rate_change.h" +#include "log.h" +#include "dcpomatic_log.h" +#include +#include +#include +#include +#include #include "i18n.h" -int const VideoContentProperty::VIDEO_SIZE = 0; -int const VideoContentProperty::VIDEO_FRAME_RATE = 1; -int const VideoContentProperty::VIDEO_FRAME_TYPE = 2; -int const VideoContentProperty::VIDEO_CROP = 3; -int const VideoContentProperty::VIDEO_RATIO = 4; +int const VideoContentProperty::USE = 0; +int const VideoContentProperty::SIZE = 1; +int const VideoContentProperty::FRAME_TYPE = 2; +int const VideoContentProperty::CROP = 3; +int const VideoContentProperty::SCALE = 4; +int const VideoContentProperty::COLOUR_CONVERSION = 5; +int const VideoContentProperty::FADE_IN = 6; +int const VideoContentProperty::FADE_OUT = 7; +int const VideoContentProperty::RANGE = 8; +int const VideoContentProperty::CUSTOM_RATIO = 9; +int const VideoContentProperty::CUSTOM_SIZE = 10; using std::string; -using std::stringstream; using std::setprecision; using std::cout; -using boost::shared_ptr; -using boost::lexical_cast; +using std::vector; +using std::min; +using std::max; +using std::fixed; +using std::setprecision; +using std::list; +using std::pair; +using std::shared_ptr; +using std::make_shared; using boost::optional; +using std::dynamic_pointer_cast; +using dcp::raw_convert; +using namespace dcpomatic; -VideoContent::VideoContent (shared_ptr f, Time s, VideoContent::Frame len) - : Content (f, s) - , _video_length (len) - , _video_frame_rate (0) - , _video_frame_type (VIDEO_FRAME_TYPE_2D) - , _ratio (Ratio::from_id ("185")) +VideoContent::VideoContent (Content* parent) + : ContentPart (parent) + , _use (true) + , _length (0) + , _frame_type (VideoFrameType::TWO_D) + , _yuv (true) + , _fade_in (0) + , _fade_out (0) + , _range (VideoRange::FULL) { } -VideoContent::VideoContent (shared_ptr f, boost::filesystem::path p) - : Content (f, p) - , _video_length (0) - , _video_frame_rate (0) - , _video_frame_type (VIDEO_FRAME_TYPE_2D) - , _ratio (Ratio::from_id ("185")) +shared_ptr +VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version) { + if (!node->optional_number_child ("VideoWidth")) { + return {}; + } + return make_shared(parent, node, version); } -VideoContent::VideoContent (shared_ptr f, shared_ptr node) - : Content (f, node) +VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version) + : ContentPart (parent) { - _video_length = node->number_child ("VideoLength"); - _video_size.width = node->number_child ("VideoWidth"); - _video_size.height = node->number_child ("VideoHeight"); - _video_frame_rate = node->number_child ("VideoFrameRate"); - _video_frame_type = static_cast (node->number_child ("VideoFrameType")); + _size.width = node->number_child ("VideoWidth"); + _size.height = node->number_child ("VideoHeight"); + + /* Backwards compatibility */ + auto r = node->optional_number_child("VideoFrameRate"); + if (r) { + _parent->set_video_frame_rate (r.get ()); + } + + _use = node->optional_bool_child("Use").get_value_or(true); + _length = node->number_child ("VideoLength"); + + if (version <= 34) { + /* Snapshot of the VideoFrameType enum at version 34 */ + switch (node->number_child ("VideoFrameType")) { + case 0: + _frame_type = VideoFrameType::TWO_D; + break; + case 1: + _frame_type = VideoFrameType::THREE_D_LEFT_RIGHT; + break; + case 2: + _frame_type = VideoFrameType::THREE_D_TOP_BOTTOM; + break; + case 3: + _frame_type = VideoFrameType::THREE_D_ALTERNATE; + break; + case 4: + _frame_type = VideoFrameType::THREE_D_LEFT; + break; + case 5: + _frame_type = VideoFrameType::THREE_D_RIGHT; + break; + } + } else { + _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType")); + } + + _sample_aspect_ratio = node->optional_number_child ("SampleAspectRatio"); _crop.left = node->number_child ("LeftCrop"); _crop.right = node->number_child ("RightCrop"); _crop.top = node->number_child ("TopCrop"); _crop.bottom = node->number_child ("BottomCrop"); - optional r = node->optional_string_child ("Ratio"); - if (r) { - _ratio = Ratio::from_id (r.get ()); + + if (version <= 7) { + auto r = node->optional_string_child ("Ratio"); + if (r) { + _legacy_ratio = Ratio::from_id(r.get())->ratio(); + } + } else if (version <= 37) { + auto ratio = node->node_child("Scale")->optional_string_child("Ratio"); + if (ratio) { + _legacy_ratio = Ratio::from_id(ratio.get())->ratio(); + } + auto scale = node->node_child("Scale")->optional_bool_child("Scale"); + if (scale) { + if (*scale) { + /* This is what we used to call "no stretch" */ + _legacy_ratio = _size.ratio(); + } else { + /* This is what we used to call "no scale" */ + _custom_size = _size; + } + } + + } else { + _custom_ratio = node->optional_number_child("CustomRatio"); + if (node->optional_number_child("CustomWidth")) { + _custom_size = dcp::Size (node->number_child("CustomWidth"), node->number_child("CustomHeight")); + } + } + + if (node->optional_node_child ("ColourConversion")) { + _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version); + } + + _yuv = node->optional_bool_child("YUV").get_value_or (true); + + if (version >= 32) { + _fade_in = node->number_child ("FadeIn"); + _fade_out = node->number_child ("FadeOut"); + } else { + _fade_in = _fade_out = 0; + } + + _range = VideoRange::FULL; + if (node->optional_string_child("Range").get_value_or("full") == "video") { + _range = VideoRange::VIDEO; } } +VideoContent::VideoContent (Content* parent, vector > c) + : ContentPart (parent) + , _length (0) + , _yuv (false) +{ + auto ref = c[0]->video; + DCPOMATIC_ASSERT (ref); + + for (size_t i = 1; i < c.size(); ++i) { + + if (c[i]->video->use() != ref->use()) { + throw JoinError (_("Content to be joined must have all its video used or not used.")); + } + + if (c[i]->video->size() != ref->size()) { + throw JoinError (_("Content to be joined must have the same picture size.")); + } + + if (c[i]->video->frame_type() != ref->frame_type()) { + throw JoinError (_("Content to be joined must have the same video frame type.")); + } + + if (c[i]->video->crop() != ref->crop()) { + throw JoinError (_("Content to be joined must have the same crop.")); + } + + if (c[i]->video->custom_ratio() != ref->custom_ratio()) { + throw JoinError (_("Content to be joined must have the same custom ratio setting.")); + } + + if (c[i]->video->custom_size() != ref->custom_size()) { + throw JoinError (_("Content to be joined must have the same custom size setting.")); + } + + if (c[i]->video->colour_conversion() != ref->colour_conversion()) { + throw JoinError (_("Content to be joined must have the same colour conversion.")); + } + + if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) { + throw JoinError (_("Content to be joined must have the same fades.")); + } + + _length += c[i]->video->length (); + + if (c[i]->video->yuv ()) { + _yuv = true; + } + } + + _use = ref->use (); + _size = ref->size (); + _frame_type = ref->frame_type (); + _crop = ref->crop (); + _custom_ratio = ref->custom_ratio (); + _colour_conversion = ref->colour_conversion (); + _fade_in = ref->fade_in (); + _fade_out = ref->fade_out (); + _range = ref->range (); +} + void VideoContent::as_xml (xmlpp::Node* node) const { boost::mutex::scoped_lock lm (_mutex); - node->add_child("VideoLength")->add_child_text (lexical_cast (_video_length)); - node->add_child("VideoWidth")->add_child_text (lexical_cast (_video_size.width)); - node->add_child("VideoHeight")->add_child_text (lexical_cast (_video_size.height)); - node->add_child("VideoFrameRate")->add_child_text (lexical_cast (_video_frame_rate)); - node->add_child("VideoFrameType")->add_child_text (lexical_cast (static_cast (_video_frame_type))); - node->add_child("LeftCrop")->add_child_text (boost::lexical_cast (_crop.left)); - node->add_child("RightCrop")->add_child_text (boost::lexical_cast (_crop.right)); - node->add_child("TopCrop")->add_child_text (boost::lexical_cast (_crop.top)); - node->add_child("BottomCrop")->add_child_text (boost::lexical_cast (_crop.bottom)); - if (_ratio) { - node->add_child("Ratio")->add_child_text (_ratio->id ()); + node->add_child("Use")->add_child_text (_use ? "1" : "0"); + node->add_child("VideoLength")->add_child_text (raw_convert (_length)); + node->add_child("VideoWidth")->add_child_text (raw_convert (_size.width)); + node->add_child("VideoHeight")->add_child_text (raw_convert (_size.height)); + node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type)); + if (_sample_aspect_ratio) { + node->add_child("SampleAspectRatio")->add_child_text (raw_convert (_sample_aspect_ratio.get ())); + } + _crop.as_xml (node); + if (_custom_ratio) { + node->add_child("CustomRatio")->add_child_text(raw_convert(*_custom_ratio)); + } + if (_custom_size) { + node->add_child("CustomWidth")->add_child_text(raw_convert(_custom_size->width)); + node->add_child("CustomHeight")->add_child_text(raw_convert(_custom_size->height)); } + if (_colour_conversion) { + _colour_conversion.get().as_xml (node->add_child("ColourConversion")); + } + node->add_child("YUV")->add_child_text (_yuv ? "1" : "0"); + node->add_child("FadeIn")->add_child_text (raw_convert (_fade_in)); + node->add_child("FadeOut")->add_child_text (raw_convert (_fade_out)); + node->add_child("Range")->add_child_text(_range == VideoRange::FULL ? "full" : "video"); } void -VideoContent::take_from_video_examiner (shared_ptr d) +VideoContent::take_from_examiner (shared_ptr d) { /* These examiner calls could call other content methods which take a lock on the mutex */ - libdcp::Size const vs = d->video_size (); - float const vfr = d->video_frame_rate (); - + auto const vs = d->video_size (); + auto vl = d->video_length (); + auto const ar = d->sample_aspect_ratio (); + auto const yuv = d->yuv (); + auto const range = d->range (); + + ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE); + ContentChangeSignaller cc2 (_parent, VideoContentProperty::SCALE); + ContentChangeSignaller cc3 (_parent, ContentProperty::LENGTH); + ContentChangeSignaller cc4 (_parent, VideoContentProperty::RANGE); + { boost::mutex::scoped_lock lm (_mutex); - _video_size = vs; - _video_frame_rate = vfr; + _size = vs; + _length = vl; + _sample_aspect_ratio = ar; + _yuv = yuv; + _range = range; } - - signal_changed (VideoContentProperty::VIDEO_SIZE); - signal_changed (VideoContentProperty::VIDEO_FRAME_RATE); -} + LOG_GENERAL ("Video length obtained from header as %1 frames", _length); + if (d->video_frame_rate()) { + _parent->set_video_frame_rate (d->video_frame_rate().get()); + } +} + +/** @return string which includes everything about how this content looks */ string -VideoContent::information () const +VideoContent::identifier () const { - if (video_size().width == 0 || video_size().height == 0) { - return ""; + char buffer[256]; + snprintf ( + buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d", + (_use ? 1 : 0), + crop().left, + crop().right, + crop().top, + crop().bottom, + _custom_ratio.get_value_or(0), + _custom_size ? _custom_size->width : 0, + _custom_size ? _custom_size->height : 0, + _fade_in, + _fade_out, + _range == VideoRange::FULL ? 0 : 1 + ); + + string s (buffer); + + if (colour_conversion()) { + s += "_" + colour_conversion().get().identifier (); } - - stringstream s; - s << String::compose ( - _("%1x%2 pixels (%3:1)"), - video_size().width, - video_size().height, - setprecision (3), float (video_size().width) / video_size().height + return s; +} + +string +VideoContent::technical_summary () const +{ + string s = String::compose ( + N_("video: length %1 frames, size %2x%3"), + length_after_3d_combine(), + size().width, + size().height ); - - return s.str (); + + if (sample_aspect_ratio ()) { + s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ())); + } + + return s; } -void -VideoContent::set_left_crop (int c) +dcp::Size +VideoContent::size_after_3d_split () const { - { - boost::mutex::scoped_lock lm (_mutex); - - if (_crop.left == c) { - return; + auto const s = size (); + switch (frame_type ()) { + case VideoFrameType::TWO_D: + case VideoFrameType::THREE_D: + case VideoFrameType::THREE_D_ALTERNATE: + case VideoFrameType::THREE_D_LEFT: + case VideoFrameType::THREE_D_RIGHT: + return s; + case VideoFrameType::THREE_D_LEFT_RIGHT: + return dcp::Size (s.width / 2, s.height); + case VideoFrameType::THREE_D_TOP_BOTTOM: + return dcp::Size (s.width, s.height / 2); + } + + DCPOMATIC_ASSERT (false); +} + +/** @return Video size after 3D split and crop */ +dcp::Size +VideoContent::size_after_crop () const +{ + return crop().apply (size_after_3d_split ()); +} + + +/** @param f Frame index within the whole (untrimmed) content. + * @return Fade factor (between 0 and 1) or unset if there is no fade. + */ +optional +VideoContent::fade (shared_ptr film, Frame f) const +{ + DCPOMATIC_ASSERT (f >= 0); + + double const vfr = _parent->active_video_frame_rate(film); + + auto const ts = _parent->trim_start().frames_round(vfr); + if ((f - ts) < fade_in()) { + return double (f - ts) / fade_in(); + } + + auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out(); + if (f >= fade_out_start) { + return 1 - double (f - fade_out_start) / fade_out(); + } + + return optional (); +} + +string +VideoContent::processing_description (shared_ptr film) +{ + string d; + char buffer[256]; + + if (size().width && size().height) { + d += String::compose ( + _("Content video is %1x%2"), + size_after_3d_split().width, + size_after_3d_split().height + ); + + + double ratio = size_after_3d_split().ratio (); + + if (sample_aspect_ratio ()) { + snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get()); + d += buffer; + ratio *= sample_aspect_ratio().get (); } - - _crop.left = c; + + snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio); + d += buffer; + } + + if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) { + dcp::Size cropped = size_after_crop (); + d += String::compose ( + _("\nCropped to %1x%2"), + cropped.width, cropped.height + ); + + snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio()); + d += buffer; } - - signal_changed (VideoContentProperty::VIDEO_CROP); + + auto const container_size = film->frame_size (); + auto const scaled = scaled_size (container_size); + + if (scaled != size_after_crop ()) { + d += String::compose ( + _("\nScaled to %1x%2"), + scaled.width, scaled.height + ); + + snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio()); + d += buffer; + } + + if (scaled != container_size) { + d += String::compose ( + _("\nPadded with black to fit container %1 (%2x%3)"), + film->container()->container_nickname (), + container_size.width, container_size.height + ); + + snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio()); + d += buffer; + } + + if (_parent->video_frame_rate()) { + double const vfr = _parent->video_frame_rate().get (); + + snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr); + d += buffer; + + FrameRateChange frc (vfr, film->video_frame_rate ()); + d += frc.description (); + } + + return d; +} + +void +VideoContent::add_properties (list& p) const +{ + p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames"))); + p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height))); +} + +void +VideoContent::set_length (Frame len) +{ + maybe_set (_length, len, ContentProperty::LENGTH); +} + +void +VideoContent::set_left_crop (int c) +{ + maybe_set (_crop.left, c, VideoContentProperty::CROP); } void VideoContent::set_right_crop (int c) { - { - boost::mutex::scoped_lock lm (_mutex); - if (_crop.right == c) { - return; - } - - _crop.right = c; - } - - signal_changed (VideoContentProperty::VIDEO_CROP); + maybe_set (_crop.right, c, VideoContentProperty::CROP); } void VideoContent::set_top_crop (int c) { - { - boost::mutex::scoped_lock lm (_mutex); - if (_crop.top == c) { - return; - } - - _crop.top = c; - } - - signal_changed (VideoContentProperty::VIDEO_CROP); + maybe_set (_crop.top, c, VideoContentProperty::CROP); } void VideoContent::set_bottom_crop (int c) { - { - boost::mutex::scoped_lock lm (_mutex); - if (_crop.bottom == c) { - return; - } - - _crop.bottom = c; - } + maybe_set (_crop.bottom, c, VideoContentProperty::CROP); +} + - signal_changed (VideoContentProperty::VIDEO_CROP); +void +VideoContent::set_frame_type (VideoFrameType t) +{ + maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE); } void -VideoContent::set_ratio (Ratio const * r) +VideoContent::unset_colour_conversion () { - { - boost::mutex::scoped_lock lm (_mutex); - if (_ratio == r) { - return; - } + maybe_set (_colour_conversion, boost::optional (), VideoContentProperty::COLOUR_CONVERSION); +} - _ratio = r; - } +void +VideoContent::set_colour_conversion (ColourConversion c) +{ + maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION); +} - signal_changed (VideoContentProperty::VIDEO_RATIO); +void +VideoContent::set_fade_in (Frame t) +{ + maybe_set (_fade_in, t, VideoContentProperty::FADE_IN); } -/** @return string which includes everything about how this content looks */ -string -VideoContent::identifier () const +void +VideoContent::set_fade_out (Frame t) { - stringstream s; - s << Content::digest() - << "_" << crop().left - << "_" << crop().right - << "_" << crop().top - << "_" << crop().bottom; + maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT); +} - if (ratio()) { - s << "_" << ratio()->id (); +void +VideoContent::set_range (VideoRange r) +{ + maybe_set (_range, r, VideoContentProperty::RANGE); +} + +void +VideoContent::set_use (bool u) +{ + maybe_set (_use, u, VideoContentProperty::USE); +} + +void +VideoContent::take_settings_from (shared_ptr c) +{ + if (c->_colour_conversion) { + set_colour_conversion (c->_colour_conversion.get()); + } else { + unset_colour_conversion (); } + set_use (c->_use); + set_frame_type (c->_frame_type); + set_left_crop (c->_crop.left); + set_right_crop (c->_crop.right); + set_top_crop (c->_crop.top); + set_bottom_crop (c->_crop.bottom); + set_custom_ratio (c->_custom_ratio); + set_custom_size (c->_custom_size); + set_fade_in (c->_fade_in); + set_fade_out (c->_fade_out); +} - return s.str (); +void +VideoContent::modify_position (shared_ptr film, DCPTime& pos) const +{ + pos = pos.round (film->video_frame_rate()); } void -VideoContent::set_video_frame_type (VideoFrameType t) +VideoContent::modify_trim_start (ContentTime& trim) const { - { - boost::mutex::scoped_lock lm (_mutex); - _video_frame_type = t; + if (_parent->video_frame_rate()) { + trim = trim.round (_parent->video_frame_rate().get()); } +} - signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE); + +/** @param film_container The size of the container for the DCP that we are working on */ +dcp::Size +VideoContent::scaled_size (dcp::Size film_container) +{ + if (_custom_ratio) { + return fit_ratio_within(*_custom_ratio, film_container); + } + + if (_custom_size) { + return *_custom_size; + } + + auto size = size_after_crop (); + size.width *= _sample_aspect_ratio.get_value_or(1); + + /* This is what we will return unless there is any legacy stuff to take into account */ + auto auto_size = fit_ratio_within (size.ratio(), film_container); + + if (_legacy_ratio) { + if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) { + _custom_ratio = *_legacy_ratio; + _legacy_ratio = optional(); + return fit_ratio_within(*_custom_ratio, film_container); + } + _legacy_ratio = boost::optional(); + } + + return auto_size; +} + + +void +VideoContent::set_custom_ratio (optional ratio) +{ + maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO); +} + + +void +VideoContent::set_custom_size (optional size) +{ + maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE); }