float -> double in a few places.
[dcpomatic.git] / src / lib / video_content.cc
index 13f2cf51676a9d10bb3b6acce245457d1dd2db66..1c0bc5a60d045f758a17cf1948decf3dc1aa71c5 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 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
 
 */
 
-#include <iomanip>
-#include <libcxml/cxml.h>
-#include <libdcp/colour_matrix.h>
-#include <libdcp/raw_convert.h>
 #include "video_content.h"
 #include "video_examiner.h"
 #include "compose.hpp"
 #include "film.h"
 #include "exceptions.h"
 #include "frame_rate_change.h"
+#include "log.h"
 #include "safe_stringstream.h"
+#include "raw_convert.h"
+#include <libcxml/cxml.h>
+#include <dcp/colour_matrix.h>
+#include <iomanip>
 
 #include "i18n.h"
 
+#define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
+
 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_SCALE      = 4;
 int const VideoContentProperty::COLOUR_CONVERSION = 5;
+int const VideoContentProperty::VIDEO_FADE_IN     = 6;
+int const VideoContentProperty::VIDEO_FADE_OUT    = 7;
 
 using std::string;
 using std::setprecision;
@@ -48,53 +53,60 @@ 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;
-using libdcp::raw_convert;
 
-VideoContent::VideoContent (shared_ptr<const Film> f)
-       : Content (f)
+VideoContent::VideoContent (shared_ptr<const Film> film)
+       : Content (film)
        , _video_length (0)
-       , _original_video_frame_rate (0)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (Config::instance()->default_scale ())
+       , _scale (VideoContentScale (Ratio::from_id ("178")))
+       , _fade_in (0)
+       , _fade_out (0)
 {
-       setup_default_colour_conversion ();
+       set_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, Time s, VideoContent::Frame len)
-       : Content (f, s)
+VideoContent::VideoContent (shared_ptr<const Film> film, DCPTime s, Frame len)
+       : Content (film, s)
        , _video_length (len)
-       , _original_video_frame_rate (0)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (Config::instance()->default_scale ())
+       , _scale (VideoContentScale (Ratio::from_id ("178")))
+       , _fade_in (0)
+       , _fade_out (0)
 {
-       setup_default_colour_conversion ();
+       set_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
-       : Content (f, p)
+VideoContent::VideoContent (shared_ptr<const Film> film, boost::filesystem::path p)
+       : Content (film, p)
        , _video_length (0)
-       , _original_video_frame_rate (0)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (Config::instance()->default_scale ())
+       , _scale (VideoContentScale (Ratio::from_id ("178")))
+       , _fade_in (0)
+       , _fade_out (0)
 {
-       setup_default_colour_conversion ();
+       set_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version)
-       : Content (f, node)
+VideoContent::VideoContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
+       : Content (film, node)
 {
-       _video_length = node->number_child<VideoContent::Frame> ("VideoLength");
        _video_size.width = node->number_child<int> ("VideoWidth");
        _video_size.height = node->number_child<int> ("VideoHeight");
-       _video_frame_rate = node->number_child<float> ("VideoFrameRate");
-       _original_video_frame_rate = node->optional_number_child<float> ("OriginalVideoFrameRate").get_value_or (_video_frame_rate);
+       _video_frame_rate = node->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<double> ("SampleAspectRatio");
        _crop.left = node->number_child<int> ("LeftCrop");
        _crop.right = node->number_child<int> ("RightCrop");
        _crop.top = node->number_child<int> ("TopCrop");
@@ -108,16 +120,25 @@ VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Nod
        } else {
                _scale = VideoContentScale (node->node_child ("Scale"));
        }
-       
-       _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
+
+
+       if (node->optional_node_child ("ColourConversion")) {
+               _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
+       }
+       if (version >= 32) {
+               _fade_in = node->number_child<Frame> ("FadeIn");
+               _fade_out = node->number_child<Frame> ("FadeOut");
+       } else {
+               _fade_in = _fade_out = 0;
+       }
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
-       : Content (f, c)
+VideoContent::VideoContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
+       : Content (film, c)
        , _video_length (0)
 {
        shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
-       assert (ref);
+       DCPOMATIC_ASSERT (ref);
 
        for (size_t i = 0; i < c.size(); ++i) {
                shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
@@ -146,16 +167,21 @@ VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content>
                        throw JoinError (_("Content to be joined must have the same colour conversion."));
                }
 
+               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 ();
        }
 
        _video_size = ref->video_size ();
-       _original_video_frame_rate = ref->original_video_frame_rate ();
        _video_frame_rate = ref->video_frame_rate ();
        _video_frame_type = ref->video_frame_type ();
        _crop = ref->crop ();
        _scale = ref->scale ();
        _colour_conversion = ref->colour_conversion ();
+       _fade_in = ref->fade_in ();
+       _fade_out = ref->fade_out ();
 }
 
 void
@@ -166,55 +192,60 @@ VideoContent::as_xml (xmlpp::Node* node) const
        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));
-       node->add_child("OriginalVideoFrameRate")->add_child_text (raw_convert<string> (_original_video_frame_rate));
        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 ()));
+       }
        _crop.as_xml (node);
        _scale.as_xml (node->add_child("Scale"));
-       _colour_conversion.as_xml (node->add_child("ColourConversion"));
+       if (_colour_conversion) {
+               _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
+       }
+       node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
+       node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
 }
 
 void
-VideoContent::setup_default_colour_conversion ()
+VideoContent::set_default_colour_conversion ()
 {
-       _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
+       /* If there's no better offer we'll use Rec. 709 */
+       boost::mutex::scoped_lock lm (_mutex);
+       _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
 }
 
 void
 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> 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 ();
-       
+       dcp::Size const vs = d->video_size ();
+       optional<double> const vfr = d->video_frame_rate ();
+       Frame vl = d->video_length ();
+       optional<double> const ar = d->sample_aspect_ratio ();
+
        {
                boost::mutex::scoped_lock lm (_mutex);
                _video_size = vs;
-               _video_frame_rate = vfr;
-               _original_video_frame_rate = vfr;
+               /* Default video frame rate to 24fps if the examiner doesn't know */
+               _video_frame_rate = vfr.get_value_or (24);
+               _video_length = vl;
+               _sample_aspect_ratio = ar;
+
+               /* Guess correct scale from size and sample aspect ratio */
+               _scale = VideoContentScale (
+                       Ratio::nearest_from_ratio (double (_video_size.width) * ar.get_value_or (1) / _video_size.height)
+                       );
        }
-       
-       signal_changed (VideoContentProperty::VIDEO_SIZE);
-       signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
-}
 
+       shared_ptr<const Film> film = _film.lock ();
+       DCPOMATIC_ASSERT (film);
+       LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length);
 
-string
-VideoContent::information () const
-{
-       if (video_size().width == 0 || video_size().height == 0) {
-               return "";
-       }
-       
-       SafeStringStream s;
+       set_default_colour_conversion ();
 
-       s << String::compose (
-               _("%1x%2 pixels (%3:1)"),
-               video_size().width,
-               video_size().height,
-               setprecision (3), video_size().ratio ()
-               );
-       
-       return s.str ();
+       signal_changed (VideoContentProperty::VIDEO_SIZE);
+       signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
+       signal_changed (VideoContentProperty::VIDEO_SCALE);
+       signal_changed (ContentProperty::LENGTH);
 }
 
 void
@@ -222,14 +253,14 @@ 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);
 }
 
@@ -241,10 +272,10 @@ VideoContent::set_right_crop (int c)
                if (_crop.right == c) {
                        return;
                }
-               
+
                _crop.right = c;
        }
-       
+
        signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
@@ -256,10 +287,10 @@ VideoContent::set_top_crop (int c)
                if (_crop.top == c) {
                        return;
                }
-               
+
                _crop.top = c;
        }
-       
+
        signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
@@ -271,7 +302,7 @@ VideoContent::set_bottom_crop (int c)
                if (_crop.bottom == c) {
                        return;
                }
-               
+
                _crop.bottom = c;
        }
 
@@ -304,7 +335,12 @@ VideoContent::identifier () const
          << "_" << crop().top
          << "_" << crop().bottom
          << "_" << scale().id()
-         << "_" << colour_conversion().identifier ();
+         << "_" << _fade_in
+         << "_" << _fade_out;
+
+       if (colour_conversion()) {
+               s << "_" << colour_conversion().get().identifier ();
+       }
 
        return s.str ();
 }
@@ -323,16 +359,25 @@ VideoContent::set_video_frame_type (VideoFrameType t)
 string
 VideoContent::technical_summary () const
 {
-       return String::compose (
-               "video: length %1, size %2x%3, rate %4",
-               video_length_after_3d_combine(), video_size().width, video_size().height, video_frame_rate()
+       string s = String::compose (
+               N_("video: length %1 frames, size %2x%3, rate %4"),
+               video_length_after_3d_combine(),
+               video_size().width,
+               video_size().height,
+               video_frame_rate()
                );
+
+       if (sample_aspect_ratio ()) {
+               s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
+       }
+
+       return s;
 }
 
-libdcp::Size
+dcp::Size
 VideoContent::video_size_after_3d_split () const
 {
-       libdcp::Size const s = video_size ();
+       dcp::Size const s = video_size ();
        switch (video_frame_type ()) {
        case VIDEO_FRAME_TYPE_2D:
        case VIDEO_FRAME_TYPE_3D_ALTERNATE:
@@ -340,12 +385,25 @@ VideoContent::video_size_after_3d_split () const
        case VIDEO_FRAME_TYPE_3D_RIGHT:
                return s;
        case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
-               return libdcp::Size (s.width / 2, s.height);
+               return dcp::Size (s.width / 2, s.height);
        case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
-               return libdcp::Size (s.width, s.height / 2);
+               return dcp::Size (s.width, s.height / 2);
+       }
+
+       DCPOMATIC_ASSERT (false);
+}
+
+void
+VideoContent::unset_colour_conversion (bool signal)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _colour_conversion = boost::optional<ColourConversion> ();
        }
 
-       assert (false);
+       if (signal) {
+               signal_changed (VideoContentProperty::COLOUR_CONVERSION);
+       }
 }
 
 void
@@ -359,36 +417,40 @@ VideoContent::set_colour_conversion (ColourConversion c)
        signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 }
 
-/** @return Video size after 3D split and crop */
-libdcp::Size
-VideoContent::video_size_after_crop () const
+void
+VideoContent::set_fade_in (Frame t)
 {
-       return crop().apply (video_size_after_3d_split ());
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _fade_in = t;
+       }
+
+       signal_changed (VideoContentProperty::VIDEO_FADE_IN);
 }
 
-/** @param t A time offset from the start of this piece of content.
- *  @return Corresponding frame index.
- */
-VideoContent::Frame
-VideoContent::time_to_content_video_frames (Time t) const
+void
+VideoContent::set_fade_out (Frame t)
 {
-       shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-       
-       FrameRateChange frc (video_frame_rate(), film->video_frame_rate());
-
-       /* Here we are converting from time (in the DCP) to a frame number in the content.
-          Hence we need to use the DCP's frame rate and the double/skip correction, not
-          the source's rate.
-       */
-       return t * film->video_frame_rate() / (frc.factor() * TIME_HZ);
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _fade_out = t;
+       }
+
+       signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
+}
+
+/** @return Video size after 3D split and crop */
+dcp::Size
+VideoContent::video_size_after_crop () const
+{
+       return crop().apply (video_size_after_3d_split ());
 }
 
 void
 VideoContent::scale_and_crop_to_fit_width ()
 {
        shared_ptr<const Film> film = _film.lock ();
-       assert (film);
+       DCPOMATIC_ASSERT (film);
 
        set_scale (VideoContentScale (film->container ()));
 
@@ -401,7 +463,7 @@ void
 VideoContent::scale_and_crop_to_fit_height ()
 {
        shared_ptr<const Film> film = _film.lock ();
-       assert (film);
+       DCPOMATIC_ASSERT (film);
 
        set_scale (VideoContentScale (film->container ()));
 
@@ -411,17 +473,109 @@ VideoContent::scale_and_crop_to_fit_height ()
 }
 
 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);
 }
 
+optional<double>
+VideoContent::fade (Frame f) const
+{
+       DCPOMATIC_ASSERT (f >= 0);
+
+       if (f < fade_in()) {
+               return double (f) / fade_in();
+       }
+
+       Frame fade_out_start = video_length() - fade_out();
+       if (f >= fade_out_start) {
+               return 1 - double (f - fade_out_start) / fade_out();
+       }
+
+       return optional<double> ();
+}
+
+string
+VideoContent::processing_description () const
+{
+       /* stringstream is OK here as this string is just for presentation to the user */
+       stringstream d;
+
+       if (video_size().width && video_size().height) {
+               d << String::compose (
+                       _("Content video is %1x%2"),
+                       video_size_after_3d_split().width,
+                       video_size_after_3d_split().height
+                       );
+
+
+               double ratio = video_size_after_3d_split().ratio ();
+
+               if (sample_aspect_ratio ()) {
+                       d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
+                       ratio *= sample_aspect_ratio().get ();
+               }
+
+               d << "\n" << _("Display aspect ratio") << " " << fixed << setprecision(2) << ratio << ":1\n";
+       }
+
+       if ((crop().left || crop().right || crop().top || crop().bottom) && video_size() != dcp::Size (0, 0)) {
+               dcp::Size cropped = video_size_after_crop ();
+               d << String::compose (
+                       _("Cropped to %1x%2"),
+                       cropped.width, cropped.height
+                       );
+
+               d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
+       }
+
+       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);
+
+       if (scaled != video_size_after_crop ()) {
+               d << String::compose (
+                       _("Scaled to %1x%2"),
+                       scaled.width, scaled.height
+                       );
+
+               d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
+       }
+
+       if (scaled != container_size) {
+               d << String::compose (
+                       _("Padded with black to fit container %1 (%2x%3)"),
+                       film->container()->nickname (),
+                       container_size.width, container_size.height
+                       );
+
+               d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
+       }
+
+       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<pair<string, string> >& p) const
+{
+       p.push_back (make_pair (_("Video length"), raw_convert<string> (video_length ()) + " " + _("video frames")));
+       p.push_back (make_pair (_("Video size"), raw_convert<string> (video_size().width) + "x" + raw_convert<string> (video_size().height)));
+       p.push_back (make_pair (_("Video frame rate"), raw_convert<string> (video_frame_rate()) + " " + _("frames per second")));
+}