Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / lib / video_content.cc
index 2b953f75bf8b60e9707ccb12a00e9a8b2b4dacc7..6853363678ff76173d6c1943038c3cb5da572359 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "exceptions.h"
 #include "frame_rate_change.h"
 #include "log.h"
+#include "dcpomatic_log.h"
 #include <dcp/raw_convert.h>
 #include <libcxml/cxml.h>
-#include <dcp/colour_matrix.h>
 #include <libxml++/libxml++.h>
 #include <iomanip>
 #include <iostream>
 
 #include "i18n.h"
 
-#define LOG_GENERAL(...) _parent->film()->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
-
-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;
 
 using std::string;
 using std::setprecision;
@@ -63,15 +63,18 @@ 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)
 {
 
 }
@@ -98,6 +101,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) {
@@ -141,7 +145,6 @@ VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int versio
                _scale = VideoContentScale (node->node_child ("Scale"));
        }
 
-
        if (node->optional_node_child ("ColourConversion")) {
                _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
        }
@@ -154,6 +157,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)
@@ -166,6 +174,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."));
                }
@@ -197,6 +209,7 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
                }
        }
 
+       _use = ref->use ();
        _size = ref->size ();
        _frame_type = ref->frame_type ();
        _crop = ref->crop ();
@@ -204,12 +217,14 @@ VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
        _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));
@@ -225,6 +240,7 @@ VideoContent::as_xml (xmlpp::Node* node) const
        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
@@ -235,6 +251,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);
@@ -242,11 +264,16 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
                _length = vl;
                _sample_aspect_ratio = ar;
                _yuv = yuv;
-
-               /* 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;
+
+               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)
+                               );
+               }
        }
 
        LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
@@ -254,10 +281,6 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
        if (d->video_frame_rate()) {
                _parent->set_video_frame_rate (d->video_frame_rate().get());
        }
-
-       _parent->signal_changed (VideoContentProperty::SIZE);
-       _parent->signal_changed (VideoContentProperty::SCALE);
-       _parent->signal_changed (ContentProperty::LENGTH);
 }
 
 /** @return string which includes everything about how this content looks */
@@ -266,14 +289,16 @@ 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_%s_%" PRId64 "_%" PRId64 "_%d",
+               (_use ? 1 : 0),
                crop().left,
                crop().right,
                crop().top,
                crop().bottom,
                scale().id().c_str(),
                _fade_in,
-               _fade_out
+               _fade_out,
+               _range == VIDEO_RANGE_FULL ? 0 : 1
                );
 
        string s (buffer);
@@ -330,10 +355,9 @@ VideoContent::size_after_crop () const
 }
 
 void
-VideoContent::scale_and_crop_to_fit_width ()
+VideoContent::scale_and_crop_to_fit_width (shared_ptr<const Film> film)
 {
-       shared_ptr<const Film> film = _parent->film ();
-       set_scale (VideoContentScale (film->container ()));
+       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);
@@ -343,10 +367,9 @@ VideoContent::scale_and_crop_to_fit_width ()
 }
 
 void
-VideoContent::scale_and_crop_to_fit_height ()
+VideoContent::scale_and_crop_to_fit_height (shared_ptr<const Film> film)
 {
-       shared_ptr<const Film> film = _parent->film ();
-       set_scale (VideoContentScale (film->container ()));
+       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);
@@ -355,15 +378,15 @@ VideoContent::scale_and_crop_to_fit_height ()
        set_bottom_crop (0);
 }
 
-/** @param f Frame index within the whole (untrimmed) content */
+/** @param f Frame index within the whole (untrimmed) content.
+ *  @return Fade factor (between 0 and 1) or unset if there is no fade.
+ */
 optional<double>
-VideoContent::fade (Frame f) const
+VideoContent::fade (shared_ptr<const Film> film, Frame f) const
 {
        DCPOMATIC_ASSERT (f >= 0);
 
-       shared_ptr<const Film> film = _parent->film ();
-
-       double const vfr = _parent->active_video_frame_rate ();
+       double const vfr = _parent->active_video_frame_rate(film);
 
        Frame const ts = _parent->trim_start().frames_round(vfr);
        if ((f - ts) < fade_in()) {
@@ -379,7 +402,7 @@ VideoContent::fade (Frame f) const
 }
 
 string
-VideoContent::processing_description () const
+VideoContent::processing_description (shared_ptr<const Film> film) const
 {
        string d;
        char buffer[256];
@@ -415,7 +438,6 @@ VideoContent::processing_description () const
                d += buffer;
        }
 
-       shared_ptr<const Film> film = _parent->film ();
        dcp::Size const container_size = film->frame_size ();
        dcp::Size const scaled = scale().size (shared_from_this(), container_size, container_size);
 
@@ -432,7 +454,7 @@ VideoContent::processing_description () const
        if (scaled != container_size) {
                d += String::compose (
                        _("\nPadded with black to fit container %1 (%2x%3)"),
-                       film->container()->nickname (),
+                       film->container()->container_nickname (),
                        container_size.width, container_size.height
                        );
 
@@ -457,7 +479,7 @@ void
 VideoContent::add_properties (list<UserProperty>& p) const
 {
        p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
-       p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), size().width + "x" + size().height));
+       p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
 }
 
 void
@@ -525,3 +547,48 @@ 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)
+{
+       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_scale (c->_scale);
+       set_fade_in (c->_fade_in);
+       set_fade_out (c->_fade_out);
+}
+
+void
+VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
+{
+       pos = pos.round (film->video_frame_rate());
+}
+
+void
+VideoContent::modify_trim_start (ContentTime& trim) const
+{
+       if (_parent->video_frame_rate()) {
+               trim = trim.round (_parent->video_frame_rate().get());
+       }
+}