Fix black borders around the preview in some cases (#2331).
[dcpomatic.git] / src / lib / video_content.cc
index 655b8baf6aa861af5c947eaed8b2e2ce6580c2ed..1d1d010a95662193bc52ab84e5dacb2b8746fb10 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2022 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
-#include "video_content.h"
-#include "content.h"
-#include "video_examiner.h"
+
+#include "colour_conversion.h"
 #include "compose.hpp"
-#include "ratio.h"
 #include "config.h"
-#include "colour_conversion.h"
-#include "util.h"
-#include "film.h"
+#include "content.h"
+#include "dcpomatic_log.h"
 #include "exceptions.h"
+#include "film.h"
 #include "frame_rate_change.h"
 #include "log.h"
-#include "dcpomatic_log.h"
+#include "ratio.h"
+#include "util.h"
+#include "video_content.h"
+#include "video_examiner.h"
 #include <dcp/raw_convert.h>
 #include <libcxml/cxml.h>
 #include <libxml++/libxml++.h>
@@ -39,6 +40,7 @@
 
 #include "i18n.h"
 
+
 int const VideoContentProperty::USE               = 0;
 int const VideoContentProperty::SIZE              = 1;
 int const VideoContentProperty::FRAME_TYPE        = 2;
@@ -51,23 +53,25 @@ int const VideoContentProperty::CUSTOM_RATIO      = 8;
 int const VideoContentProperty::CUSTOM_SIZE       = 9;
 int const VideoContentProperty::BURNT_SUBTITLE_LANGUAGE = 10;
 
-using std::string;
-using std::setprecision;
+
 using std::cout;
-using std::vector;
-using std::min;
-using std::max;
+using std::dynamic_pointer_cast;
 using std::fixed;
-using std::setprecision;
 using std::list;
+using std::make_shared;
+using std::max;
+using std::min;
 using std::pair;
+using std::setprecision;
+using std::setprecision;
 using std::shared_ptr;
-using std::make_shared;
+using std::string;
+using std::vector;
 using boost::optional;
-using std::dynamic_pointer_cast;
 using dcp::raw_convert;
 using namespace dcpomatic;
 
+
 VideoContent::VideoContent (Content* parent)
        : ContentPart (parent)
        , _use (true)
@@ -81,17 +85,21 @@ VideoContent::VideoContent (Content* parent)
 
 }
 
+
+/** @param video_range_hint Video range to use if none is given in the XML */
 shared_ptr<VideoContent>
-VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
+VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version, VideoRange video_range_hint)
 {
        if (!node->optional_number_child<int> ("VideoWidth")) {
                return {};
        }
 
-       return make_shared<VideoContent>(parent, node, version);
+       return make_shared<VideoContent>(parent, node, version, video_range_hint);
 }
 
-VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
+
+/** @param video_range_hint Video range to use if none is given in the XML */
+VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version, VideoRange video_range_hint)
        : ContentPart (parent)
 {
        _size.width = node->number_child<int> ("VideoWidth");
@@ -173,17 +181,26 @@ VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int versio
        _yuv = node->optional_bool_child("YUV").get_value_or (true);
 
        if (version >= 32) {
+               /* These should be VideoFadeIn and VideoFadeOut but we'll leave them like this until 2.18.x */
                _fade_in = node->number_child<Frame> ("FadeIn");
                _fade_out = node->number_child<Frame> ("FadeOut");
        } else {
                _fade_in = _fade_out = 0;
        }
 
-       _range = VideoRange::FULL;
-       if (node->optional_string_child("Range").get_value_or("full") == "video") {
+       auto video_range = node->optional_string_child("Range");
+       if (!video_range) {
+               _range = video_range_hint;
+       } else if (*video_range == "full") {
+               _range = VideoRange::FULL;
+       } else {
                _range = VideoRange::VIDEO;
        }
 
+       if (auto pixel_quanta = node->optional_node_child("PixelQuanta")) {
+               _pixel_quanta = PixelQuanta(pixel_quanta);
+       }
+
        auto burnt = node->optional_string_child("BurntSubtitleLanguage");
        if (burnt) {
                _burnt_subtitle_language = dcp::LanguageTag (*burnt);
@@ -214,7 +231,7 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
                        throw JoinError (_("Content to be joined must have the same video frame type."));
                }
 
-               if (c[i]->video->crop() != ref->crop()) {
+               if (c[i]->video->requested_crop() != ref->requested_crop()) {
                        throw JoinError (_("Content to be joined must have the same crop."));
                }
 
@@ -243,12 +260,14 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
                if (c[i]->video->yuv ()) {
                        _yuv = true;
                }
+
+               _pixel_quanta = max(_pixel_quanta, c[i]->video->_pixel_quanta);
        }
 
        _use = ref->use ();
        _size = ref->size ();
        _frame_type = ref->frame_type ();
-       _crop = ref->crop ();
+       _crop = ref->requested_crop ();
        _custom_ratio = ref->custom_ratio ();
        _colour_conversion = ref->colour_conversion ();
        _fade_in = ref->fade_in ();
@@ -285,6 +304,7 @@ VideoContent::as_xml (xmlpp::Node* node) const
        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 == VideoRange::FULL ? "full" : "video");
+       _pixel_quanta.as_xml(node->add_child("PixelQuanta"));
        if (_burnt_subtitle_language) {
                node->add_child("BurntSubtitleLanguage")->add_child_text(_burnt_subtitle_language->to_string());
        }
@@ -299,6 +319,7 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
        auto const ar = d->sample_aspect_ratio ();
        auto const yuv = d->yuv ();
        auto const range = d->range ();
+       auto const pixel_quanta = d->pixel_quanta ();
 
        ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
        ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
@@ -311,6 +332,7 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
                _sample_aspect_ratio = ar;
                _yuv = yuv;
                _range = range;
+               _pixel_quanta = pixel_quanta;
        }
 
        LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
@@ -325,13 +347,14 @@ string
 VideoContent::identifier () const
 {
        char buffer[256];
+       auto const crop = actual_crop();
        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,
+               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,
@@ -390,7 +413,7 @@ VideoContent::size_after_3d_split () const
 dcp::Size
 VideoContent::size_after_crop () const
 {
-       return crop().apply (size_after_3d_split ());
+       return actual_crop().apply(size_after_3d_split());
 }
 
 
@@ -443,8 +466,10 @@ VideoContent::processing_description (shared_ptr<const Film> film)
                d += buffer;
        }
 
-       if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) {
-               dcp::Size cropped = size_after_crop ();
+       auto const crop = actual_crop();
+
+       if ((crop.left || crop.right || crop.top || crop.bottom) && size() != dcp::Size(0, 0)) {
+               auto const cropped = size_after_crop ();
                d += String::compose (
                        _("\nCropped to %1x%2"),
                        cropped.width, cropped.height
@@ -504,6 +529,12 @@ VideoContent::set_length (Frame len)
        maybe_set (_length, len, ContentProperty::LENGTH);
 }
 
+void
+VideoContent::set_crop (Crop c)
+{
+       maybe_set (_crop, c, VideoContentProperty::CROP);
+}
+
 void
 VideoContent::set_left_crop (int c)
 {
@@ -629,7 +660,7 @@ VideoContent::scaled_size (dcp::Size film_container)
        }
 
        auto size = size_after_crop ();
-       size.width *= _sample_aspect_ratio.get_value_or(1);
+       size.width = std::lrint(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);
@@ -643,7 +674,7 @@ VideoContent::scaled_size (dcp::Size film_container)
                _legacy_ratio = boost::optional<float>();
        }
 
-       return auto_size;
+       return _pixel_quanta.round (auto_size);
 }
 
 
@@ -659,3 +690,16 @@ VideoContent::set_custom_size (optional<dcp::Size> size)
 {
        maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
 }
+
+
+Crop
+VideoContent::actual_crop () const
+{
+       return Crop(
+               _pixel_quanta.round_x(_crop.left),
+               _pixel_quanta.round_x(_crop.right),
+               _pixel_quanta.round_y(_crop.top),
+               _pixel_quanta.round_y(_crop.bottom)
+       );
+}
+