Change video content scaling so that it either:
[dcpomatic.git] / src / lib / video_content.cc
index fe35b0df3e800415b097691e59d8bc90e8d315e5..b4ad30f70d1c77ad523b57ad4edc65ff00a93faa 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 #include "i18n.h"
 
-int const VideoContentProperty::SIZE     = 0;
-int const VideoContentProperty::FRAME_TYPE  = 1;
-int const VideoContentProperty::CROP     = 2;
-int const VideoContentProperty::SCALE    = 3;
-int const VideoContentProperty::COLOUR_CONVERSION = 4;
-int const VideoContentProperty::FADE_IN     = 5;
-int const VideoContentProperty::FADE_OUT    = 6;
+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::setprecision;
@@ -61,15 +65,17 @@ using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
 using dcp::raw_convert;
+using namespace dcpomatic;
 
 VideoContent::VideoContent (Content* parent)
        : ContentPart (parent)
+       , _use (true)
        , _length (0)
        , _frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (VideoContentScale (Ratio::from_id ("178")))
        , _yuv (true)
        , _fade_in (0)
        , _fade_out (0)
+       , _range (VIDEO_RANGE_FULL)
 {
 
 }
@@ -96,6 +102,7 @@ VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int versio
                _parent->set_video_frame_rate (r.get ());
        }
 
+       _use = node->optional_bool_child("Use").get_value_or(true);
        _length = node->number_child<Frame> ("VideoLength");
 
        if (version <= 34) {
@@ -133,10 +140,29 @@ VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int versio
        if (version <= 7) {
                optional<string> r = node->optional_string_child ("Ratio");
                if (r) {
-                       _scale = VideoContentScale (Ratio::from_id (r.get ()));
+                       _legacy_ratio = Ratio::from_id(r.get())->ratio();
                }
+       } else if (version <= 37) {
+               optional<string> ratio = node->node_child("Scale")->optional_string_child("Ratio");
+               if (ratio) {
+                       _legacy_ratio = Ratio::from_id(ratio.get())->ratio();
+               }
+               optional<bool> 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 {
-               _scale = VideoContentScale (node->node_child ("Scale"));
+               _custom_ratio = node->optional_number_child<float>("CustomRatio");
+               if (node->optional_number_child<int>("CustomWidth")) {
+                       _custom_size = dcp::Size (node->number_child<int>("CustomWidth"), node->number_child<int>("CustomHeight"));
+               }
        }
 
        if (node->optional_node_child ("ColourConversion")) {
@@ -151,6 +177,11 @@ VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int versio
        } else {
                _fade_in = _fade_out = 0;
        }
+
+       _range = VIDEO_RANGE_FULL;
+       if (node->optional_string_child("Range").get_value_or("full") == "video") {
+               _range = VIDEO_RANGE_VIDEO;
+       }
 }
 
 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
@@ -163,6 +194,10 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
 
        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."));
                }
@@ -175,8 +210,12 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
                        throw JoinError (_("Content to be joined must have the same crop."));
                }
 
-               if (c[i]->video->scale() != ref->scale()) {
-                       throw JoinError (_("Content to be joined must have the same scale setting."));
+               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()) {
@@ -194,19 +233,22 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
                }
        }
 
+       _use = ref->use ();
        _size = ref->size ();
        _frame_type = ref->frame_type ();
        _crop = ref->crop ();
-       _scale = ref->scale ();
+       _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("Use")->add_child_text (_use ? "1" : "0");
        node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
        node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
        node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
@@ -215,13 +257,20 @@ VideoContent::as_xml (xmlpp::Node* node) const
                node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
        }
        _crop.as_xml (node);
-       _scale.as_xml (node->add_child("Scale"));
+       if (_custom_ratio) {
+               node->add_child("CustomRatio")->add_child_text(raw_convert<string>(*_custom_ratio));
+       }
+       if (_custom_size) {
+               node->add_child("CustomWidth")->add_child_text(raw_convert<string>(_custom_size->width));
+               node->add_child("CustomHeight")->add_child_text(raw_convert<string>(_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<string> (_fade_in));
        node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
+       node->add_child("Range")->add_child_text(_range == VIDEO_RANGE_FULL ? "full" : "video");
 }
 
 void
@@ -232,10 +281,12 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
        Frame vl = d->video_length ();
        optional<double> const ar = d->sample_aspect_ratio ();
        bool const yuv = d->yuv ();
+       VideoRange const range = d->range ();
 
        ChangeSignaller<Content> cc1 (_parent, VideoContentProperty::SIZE);
        ChangeSignaller<Content> cc2 (_parent, VideoContentProperty::SCALE);
        ChangeSignaller<Content> cc3 (_parent, ContentProperty::LENGTH);
+       ChangeSignaller<Content> cc4 (_parent, VideoContentProperty::RANGE);
 
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -243,15 +294,7 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
                _length = vl;
                _sample_aspect_ratio = ar;
                _yuv = yuv;
-
-               if (Config::instance()->default_scale_to ()) {
-                       _scale = VideoContentScale (Config::instance()->default_scale_to ());
-               } else {
-                       /* Guess correct scale from size and sample aspect ratio */
-                       _scale = VideoContentScale (
-                               Ratio::nearest_from_ratio (double (_size.width) * ar.get_value_or (1) / _size.height)
-                               );
-               }
+               _range = range;
        }
 
        LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
@@ -267,14 +310,18 @@ VideoContent::identifier () const
 {
        char buffer[256];
        snprintf (
-               buffer, sizeof(buffer), "%d_%d_%d_%d_%s_%" PRId64 "_%" PRId64,
+               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,
-               scale().id().c_str(),
+               _custom_ratio.get_value_or(0),
+               _custom_size ? _custom_size->width : 0,
+               _custom_size ? _custom_size->height : 0,
                _fade_in,
-               _fade_out
+               _fade_out,
+               _range == VIDEO_RANGE_FULL ? 0 : 1
                );
 
        string s (buffer);
@@ -330,29 +377,6 @@ VideoContent::size_after_crop () const
        return crop().apply (size_after_3d_split ());
 }
 
-void
-VideoContent::scale_and_crop_to_fit_width (shared_ptr<const Film> film)
-{
-       set_scale (VideoContentScale(film->container()));
-
-       int const crop = max (0, int (size().height - double (film->frame_size().height) * size().width / film->frame_size().width));
-       set_left_crop (0);
-       set_right_crop (0);
-       set_top_crop (crop / 2);
-       set_bottom_crop (crop / 2);
-}
-
-void
-VideoContent::scale_and_crop_to_fit_height (shared_ptr<const Film> film)
-{
-       set_scale (VideoContentScale(film->container()));
-
-       int const crop = max (0, int (size().width - double (film->frame_size().width) * size().height / film->frame_size().height));
-       set_left_crop (crop / 2);
-       set_right_crop (crop / 2);
-       set_top_crop (0);
-       set_bottom_crop (0);
-}
 
 /** @param f Frame index within the whole (untrimmed) content.
  *  @return Fade factor (between 0 and 1) or unset if there is no fade.
@@ -378,7 +402,7 @@ VideoContent::fade (shared_ptr<const Film> film, Frame f) const
 }
 
 string
-VideoContent::processing_description (shared_ptr<const Film> film) const
+VideoContent::processing_description (shared_ptr<const Film> film)
 {
        string d;
        char buffer[256];
@@ -415,7 +439,7 @@ VideoContent::processing_description (shared_ptr<const Film> film) const
        }
 
        dcp::Size const container_size = film->frame_size ();
-       dcp::Size const scaled = scale().size (shared_from_this(), container_size, container_size);
+       dcp::Size const scaled = scaled_size (container_size);
 
        if (scaled != size_after_crop ()) {
                d += String::compose (
@@ -488,11 +512,6 @@ VideoContent::set_bottom_crop (int c)
        maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
 }
 
-void
-VideoContent::set_scale (VideoContentScale s)
-{
-       maybe_set (_scale, s, VideoContentProperty::SCALE);
-}
 
 void
 VideoContent::set_frame_type (VideoFrameType t)
@@ -524,6 +543,18 @@ VideoContent::set_fade_out (Frame t)
        maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
 }
 
+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<const VideoContent> c)
 {
@@ -532,12 +563,14 @@ VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
        } 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_scale (c->_scale);
+       set_custom_ratio (c->_custom_ratio);
+       set_custom_size (c->_custom_size);
        set_fade_in (c->_fade_in);
        set_fade_out (c->_fade_out);
 }
@@ -555,3 +588,48 @@ VideoContent::modify_trim_start (ContentTime& trim) const
                trim = trim.round (_parent->video_frame_rate().get());
        }
 }
+
+
+/** @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;
+       }
+
+       dcp::Size 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 */
+       dcp::Size 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<float>();
+                       return fit_ratio_within(*_custom_ratio, film_container);
+               }
+               _legacy_ratio = 0;
+       }
+
+       return auto_size;
+}
+
+
+void
+VideoContent::set_custom_ratio (optional<float> ratio)
+{
+       maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
+}
+
+
+void
+VideoContent::set_custom_size (optional<dcp::Size> size)
+{
+       maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
+}