Reasonably straightforward stuff; main things are adding
[dcpomatic.git] / src / lib / video_content.cc
index a8355ffd67aa0b78ef6c97c5c59d324cbc5c2cc4..708edee76a031e4ea8fe90624388564b173d77a0 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -18,6 +18,7 @@
 */
 
 #include "video_content.h"
+#include "content.h"
 #include "video_examiner.h"
 #include "compose.hpp"
 #include "ratio.h"
 #include "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(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
+#define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
 
 int const VideoContentProperty::VIDEO_SIZE       = 0;
 int const VideoContentProperty::VIDEO_FRAME_RATE  = 1;
@@ -53,58 +56,37 @@ using std::cout;
 using std::vector;
 using std::min;
 using std::max;
-using std::stringstream;
 using std::fixed;
 using std::setprecision;
+using std::list;
+using std::pair;
 using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
 
-VideoContent::VideoContent (shared_ptr<const Film> f)
-       : Content (f)
+VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film)
+       : _parent (parent)
+       , _film (film)
        , _video_length (0)
-       , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
        , _scale (VideoContentScale (Ratio::from_id ("178")))
+       , _yuv (true)
        , _fade_in (0)
        , _fade_out (0)
 {
-       set_default_colour_conversion ();
-}
-
-VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, Frame len)
-       : Content (f, s)
-       , _video_length (len)
-       , _video_frame_rate (0)
-       , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (VideoContentScale (Ratio::from_id ("178")))
-       , _fade_in (0)
-       , _fade_out (0)
-{
-       set_default_colour_conversion ();
-}
 
-VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
-       : Content (f, p)
-       , _video_length (0)
-       , _video_frame_rate (0)
-       , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (VideoContentScale (Ratio::from_id ("178")))
-       , _fade_in (0)
-       , _fade_out (0)
-{
-       set_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
-       : Content (f, node)
+VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
+       : _parent (parent)
+       , _film (film)
 {
        _video_size.width = node->number_child<int> ("VideoWidth");
        _video_size.height = node->number_child<int> ("VideoHeight");
-       _video_frame_rate = node->number_child<float> ("VideoFrameRate");
+       _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
        _video_length = node->number_child<Frame> ("VideoLength");
        _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
-       _sample_aspect_ratio = node->optional_number_child<float> ("SampleAspectRatio");
+       _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
        _crop.left = node->number_child<int> ("LeftCrop");
        _crop.right = node->number_child<int> ("RightCrop");
        _crop.top = node->number_child<int> ("TopCrop");
@@ -119,10 +101,13 @@ VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, i
                _scale = VideoContentScale (node->node_child ("Scale"));
        }
 
-       
+
        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<Frame> ("FadeIn");
                _fade_out = node->number_child<Frame> ("FadeOut");
@@ -131,9 +116,11 @@ VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, i
        }
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
-       : Content (f, c)
+VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
+       : _parent (parent)
+       , _film (film)
        , _video_length (0)
+       , _yuv (false)
 {
        shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
        DCPOMATIC_ASSERT (ref);
@@ -168,8 +155,12 @@ VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content>
                if (vc->fade_in() != ref->fade_in() || vc->fade_out() != ref->fade_out()) {
                        throw JoinError (_("Content to be joined must have the same fades."));
                }
-               
+
                _video_length += vc->video_length ();
+
+               if (vc->yuv ()) {
+                       _yuv = true;
+               }
        }
 
        _video_size = ref->video_size ();
@@ -189,7 +180,9 @@ VideoContent::as_xml (xmlpp::Node* node) const
        node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length));
        node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
        node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
-       node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
+       if (_video_frame_rate) {
+               node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
+       }
        node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
        if (_sample_aspect_ratio) {
                node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
@@ -199,6 +192,7 @@ VideoContent::as_xml (xmlpp::Node* node) const
        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));
 }
@@ -216,21 +210,22 @@ VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
 {
        /* These examiner calls could call other content methods which take a lock on the mutex */
        dcp::Size const vs = d->video_size ();
-       optional<float> const vfr = d->video_frame_rate ();
+       optional<double> const vfr = d->video_frame_rate ();
        Frame vl = d->video_length ();
-       optional<float> const ar = d->sample_aspect_ratio ();
+       optional<double> const ar = d->sample_aspect_ratio ();
+       bool const yuv = d->yuv ();
 
        {
                boost::mutex::scoped_lock lm (_mutex);
                _video_size = vs;
-               /* Default video frame rate to 24fps if the examiner doesn't know */
-               _video_frame_rate = vfr.get_value_or (24);
+               _video_frame_rate = vfr;
                _video_length = vl;
                _sample_aspect_ratio = ar;
+               _yuv = yuv;
 
                /* Guess correct scale from size and sample aspect ratio */
                _scale = VideoContentScale (
-                       Ratio::nearest_from_ratio (float (_video_size.width) * ar.get_value_or (1) / _video_size.height)
+                       Ratio::nearest_from_ratio (double (_video_size.width) * ar.get_value_or (1) / _video_size.height)
                        );
        }
 
@@ -238,12 +233,10 @@ VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
        DCPOMATIC_ASSERT (film);
        LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length);
 
-       set_default_colour_conversion ();
-       
-       signal_changed (VideoContentProperty::VIDEO_SIZE);
-       signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
-       signal_changed (VideoContentProperty::VIDEO_SCALE);
-       signal_changed (ContentProperty::LENGTH);
+       _parent->signal_changed (VideoContentProperty::VIDEO_SIZE);
+       _parent->signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
+       _parent->signal_changed (VideoContentProperty::VIDEO_SCALE);
+       _parent->signal_changed (ContentProperty::LENGTH);
 }
 
 void
@@ -251,15 +244,15 @@ VideoContent::set_left_crop (int c)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               
+
                if (_crop.left == c) {
                        return;
                }
-               
+
                _crop.left = c;
        }
-       
-       signal_changed (VideoContentProperty::VIDEO_CROP);
+
+       _parent->signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
 void
@@ -270,11 +263,11 @@ VideoContent::set_right_crop (int c)
                if (_crop.right == c) {
                        return;
                }
-               
+
                _crop.right = c;
        }
-       
-       signal_changed (VideoContentProperty::VIDEO_CROP);
+
+       _parent->signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
 void
@@ -285,11 +278,11 @@ VideoContent::set_top_crop (int c)
                if (_crop.top == c) {
                        return;
                }
-               
+
                _crop.top = c;
        }
-       
-       signal_changed (VideoContentProperty::VIDEO_CROP);
+
+       _parent->signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
 void
@@ -300,11 +293,11 @@ VideoContent::set_bottom_crop (int c)
                if (_crop.bottom == c) {
                        return;
                }
-               
+
                _crop.bottom = c;
        }
 
-       signal_changed (VideoContentProperty::VIDEO_CROP);
+       _parent->signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
 void
@@ -319,7 +312,7 @@ VideoContent::set_scale (VideoContentScale s)
                _scale = s;
        }
 
-       signal_changed (VideoContentProperty::VIDEO_SCALE);
+       _parent->signal_changed (VideoContentProperty::VIDEO_SCALE);
 }
 
 /** @return string which includes everything about how this content looks */
@@ -327,12 +320,13 @@ string
 VideoContent::identifier () const
 {
        SafeStringStream s;
-       s << Content::identifier()
-         << "_" << crop().left
+       s << crop().left
          << "_" << crop().right
          << "_" << crop().top
          << "_" << crop().bottom
-         << "_" << scale().id();
+         << "_" << scale().id()
+         << "_" << _fade_in
+         << "_" << _fade_out;
 
        if (colour_conversion()) {
                s << "_" << colour_conversion().get().identifier ();
@@ -349,7 +343,7 @@ VideoContent::set_video_frame_type (VideoFrameType t)
                _video_frame_type = t;
        }
 
-       signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
+       _parent->signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
 }
 
 string
@@ -390,16 +384,14 @@ VideoContent::video_size_after_3d_split () const
 }
 
 void
-VideoContent::unset_colour_conversion (bool signal)
+VideoContent::unset_colour_conversion ()
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
                _colour_conversion = boost::optional<ColourConversion> ();
        }
 
-       if (signal) {
-               signal_changed (VideoContentProperty::COLOUR_CONVERSION);
-       }
+       _parent->signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 }
 
 void
@@ -410,7 +402,7 @@ VideoContent::set_colour_conversion (ColourConversion c)
                _colour_conversion = c;
        }
 
-       signal_changed (VideoContentProperty::COLOUR_CONVERSION);
+       _parent->signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 }
 
 void
@@ -421,7 +413,7 @@ VideoContent::set_fade_in (Frame t)
                _fade_in = t;
        }
 
-       signal_changed (VideoContentProperty::VIDEO_FADE_IN);
+       _parent->signal_changed (VideoContentProperty::VIDEO_FADE_IN);
 }
 
 void
@@ -432,7 +424,7 @@ VideoContent::set_fade_out (Frame t)
                _fade_out = t;
        }
 
-       signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
+       _parent->signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
 }
 
 /** @return Video size after 3D split and crop */
@@ -447,10 +439,11 @@ VideoContent::scale_and_crop_to_fit_width ()
 {
        shared_ptr<const Film> film = _film.lock ();
        DCPOMATIC_ASSERT (film);
-
        set_scale (VideoContentScale (film->container ()));
 
        int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
+       set_left_crop (0);
+       set_right_crop (0);
        set_top_crop (crop / 2);
        set_bottom_crop (crop / 2);
 }
@@ -460,51 +453,54 @@ VideoContent::scale_and_crop_to_fit_height ()
 {
        shared_ptr<const Film> film = _film.lock ();
        DCPOMATIC_ASSERT (film);
-
        set_scale (VideoContentScale (film->container ()));
 
        int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
        set_left_crop (crop / 2);
        set_right_crop (crop / 2);
+       set_top_crop (0);
+       set_bottom_crop (0);
 }
 
 void
-VideoContent::set_video_frame_rate (float r)
+VideoContent::set_video_frame_rate (double r)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
                if (_video_frame_rate == r) {
                        return;
                }
-               
+
                _video_frame_rate = r;
        }
-       
-       signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
+
+       _parent->signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 }
 
-optional<float>
+/** @param f Frame index within the whole (untrimmed) content */
+optional<double>
 VideoContent::fade (Frame f) const
 {
        DCPOMATIC_ASSERT (f >= 0);
-       
-       if (f < fade_in()) {
-               return float (f) / fade_in();
+
+       Frame const ts = _parent->trim_start().frames_round(video_frame_rate());
+       if ((f - ts) < fade_in()) {
+               return double (f - ts) / fade_in();
        }
 
-       Frame fade_out_start = video_length() - fade_out();
+       Frame fade_out_start = video_length() - _parent->trim_end().frames_round(video_frame_rate()) - fade_out();
        if (f >= fade_out_start) {
-               return 1 - float (f - fade_out_start) / fade_out();
+               return 1 - double (f - fade_out_start) / fade_out();
        }
 
-       return optional<float> ();
+       return optional<double> ();
 }
 
 string
 VideoContent::processing_description () const
 {
        /* stringstream is OK here as this string is just for presentation to the user */
-       stringstream d;
+       SafeStringStream d;
 
        if (video_size().width && video_size().height) {
                d << String::compose (
@@ -514,7 +510,7 @@ VideoContent::processing_description () const
                        );
 
 
-               float ratio = video_size_after_3d_split().ratio ();
+               double ratio = video_size_after_3d_split().ratio ();
 
                if (sample_aspect_ratio ()) {
                        d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
@@ -536,9 +532,8 @@ VideoContent::processing_description () const
 
        shared_ptr<const Film> film = _film.lock ();
        DCPOMATIC_ASSERT (film);
-
        dcp::Size const container_size = film->frame_size ();
-       dcp::Size const scaled = scale().size (dynamic_pointer_cast<const VideoContent> (shared_from_this ()), container_size, container_size);
+       dcp::Size const scaled = scale().size (shared_from_this(), container_size, container_size);
 
        if (scaled != video_size_after_crop ()) {
                d << String::compose (
@@ -548,7 +543,7 @@ VideoContent::processing_description () const
 
                d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
        }
-       
+
        if (scaled != container_size) {
                d << String::compose (
                        _("Padded with black to fit container %1 (%2x%3)"),
@@ -561,9 +556,37 @@ VideoContent::processing_description () const
 
        d << _("Content frame rate");
        d << " " << fixed << setprecision(4) << video_frame_rate() << "\n";
-       
+
        FrameRateChange frc (video_frame_rate(), film->video_frame_rate ());
        d << frc.description () << "\n";
 
        return d.str ();
 }
+
+void
+VideoContent::add_properties (list<UserProperty>& p) const
+{
+       p.push_back (UserProperty (_("Video"), _("Length"), raw_convert<string> (video_length ()), _("video frames")));
+       p.push_back (UserProperty (_("Video"), _("Size"), raw_convert<string> (video_size().width) + "x" + raw_convert<string> (video_size().height)));
+       p.push_back (UserProperty (_("Video"), _("Frame rate"), raw_convert<string> (video_frame_rate(), 5), _("frames per second")));
+}
+
+double
+VideoContent::video_frame_rate () const
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       shared_ptr<const Film> film = _film.lock ();
+       DCPOMATIC_ASSERT (film);
+       return _video_frame_rate.get_value_or (film->video_frame_rate ());
+}
+
+void
+VideoContent::set_video_length (Frame len)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _video_length = len;
+       }
+
+       _parent->signal_changed (ContentProperty::LENGTH);
+}