No-op: remove all trailing whitespace.
[dcpomatic.git] / src / lib / video_content.cc
index 1fe02bae4551134e02a57873e2c1eb5ebd1dc3ed..8c6f6c7eb7ae11c39aada00f73ed0113c76febca 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
@@ -29,9 +29,9 @@
 #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 <dcp/raw_convert.h>
 #include <iomanip>
 
 #include "i18n.h"
@@ -59,52 +59,50 @@ using std::setprecision;
 using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
-using dcp::raw_convert;
 
-VideoContent::VideoContent (shared_ptr<const Film> f)
-       : Content (f)
+VideoContent::VideoContent (shared_ptr<const Film> film)
+       : Content (film)
        , _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 (false);
+       set_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, ContentTime len)
-       : Content (f, s)
+VideoContent::VideoContent (shared_ptr<const Film> film, DCPTime s, Frame len)
+       : Content (film, 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 (false);
+       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)
        , _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 (false);
+       set_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
-       : Content (f, node)
+VideoContent::VideoContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
+       : Content (film, node)
 {
        _video_size.width = node->number_child<int> ("VideoWidth");
        _video_size.height = node->number_child<int> ("VideoHeight");
        _video_frame_rate = node->number_child<float> ("VideoFrameRate");
-
-       if (version < 32) {
-               /* DCP-o-matic 1.0 branch */
-               _video_length = ContentTime::from_frames (node->number_child<int64_t> ("VideoLength"), _video_frame_rate);
-       } else {
-               _video_length = ContentTime (node->number_child<ContentTime::Type> ("VideoLength"));
-       }
-       
+       _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");
        _crop.left = node->number_child<int> ("LeftCrop");
@@ -121,22 +119,24 @@ 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"));
+               _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
        }
        if (version >= 32) {
-               _fade_in = ContentTime (node->number_child<int64_t> ("FadeIn"));
-               _fade_out = ContentTime (node->number_child<int64_t> ("FadeOut"));
+               _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]);
@@ -168,7 +168,7 @@ 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 ();
        }
 
@@ -186,7 +186,7 @@ void
 VideoContent::as_xml (xmlpp::Node* node) const
 {
        boost::mutex::scoped_lock lm (_mutex);
-       node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length.get ()));
+       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));
@@ -199,21 +199,16 @@ VideoContent::as_xml (xmlpp::Node* node) const
        if (_colour_conversion) {
                _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
        }
-       node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in.get ()));
-       node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out.get ()));
+       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::set_default_colour_conversion (bool signal)
+VideoContent::set_default_colour_conversion ()
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
-       }
-
-       if (signal) {
-               signal_changed (VideoContentProperty::COLOUR_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
@@ -222,15 +217,14 @@ 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 ();
-       ContentTime vl = d->video_length ();
+       Frame vl = d->video_length ();
        optional<float> const ar = d->sample_aspect_ratio ();
 
        {
                boost::mutex::scoped_lock lm (_mutex);
                _video_size = vs;
-               if (vfr) {
-                       _video_frame_rate = vfr.get ();
-               }
+               /* 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;
 
@@ -241,52 +235,30 @@ VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
        }
 
        shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-       LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length.frames (_video_frame_rate));
-       
+       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);
 }
 
-
-string
-VideoContent::information () const
-{
-       if (video_size().width == 0 || video_size().height == 0) {
-               return "";
-       }
-       
-       SafeStringStream s;
-
-       s << String::compose (
-               _("%1x%2 pixels (%3:1)"),
-               video_size().width,
-               video_size().height,
-               setprecision (3), video_size().ratio ()
-               );
-
-       if (sample_aspect_ratio ()) {
-               s << String::compose (_(" sample aspect ratio %1:1"), sample_aspect_ratio().get ());
-       }
-       
-       return s.str ();
-}
-
 void
 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);
 }
 
@@ -298,10 +270,10 @@ VideoContent::set_right_crop (int c)
                if (_crop.right == c) {
                        return;
                }
-               
+
                _crop.right = c;
        }
-       
+
        signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
@@ -313,10 +285,10 @@ VideoContent::set_top_crop (int c)
                if (_crop.top == c) {
                        return;
                }
-               
+
                _crop.top = c;
        }
-       
+
        signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
@@ -328,7 +300,7 @@ VideoContent::set_bottom_crop (int c)
                if (_crop.bottom == c) {
                        return;
                }
-               
+
                _crop.bottom = c;
        }
 
@@ -360,7 +332,9 @@ VideoContent::identifier () const
          << "_" << crop().right
          << "_" << crop().top
          << "_" << crop().bottom
-         << "_" << scale().id();
+         << "_" << scale().id()
+         << "_" << _fade_in
+         << "_" << _fade_out;
 
        if (colour_conversion()) {
                s << "_" << colour_conversion().get().identifier ();
@@ -384,15 +358,15 @@ string
 VideoContent::technical_summary () const
 {
        string s = String::compose (
-               "video: length %1, size %2x%3, rate %4",
-               video_length_after_3d_combine().seconds(),
+               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 (_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
+               s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
        }
 
        return s;
@@ -414,18 +388,20 @@ VideoContent::video_size_after_3d_split () const
                return dcp::Size (s.width, s.height / 2);
        }
 
-       assert (false);
+       DCPOMATIC_ASSERT (false);
 }
 
 void
-VideoContent::unset_colour_conversion ()
+VideoContent::unset_colour_conversion (bool signal)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
                _colour_conversion = boost::optional<ColourConversion> ();
        }
 
-       signal_changed (VideoContentProperty::COLOUR_CONVERSION);
+       if (signal) {
+               signal_changed (VideoContentProperty::COLOUR_CONVERSION);
+       }
 }
 
 void
@@ -440,7 +416,7 @@ VideoContent::set_colour_conversion (ColourConversion c)
 }
 
 void
-VideoContent::set_fade_in (ContentTime t)
+VideoContent::set_fade_in (Frame t)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -451,7 +427,7 @@ VideoContent::set_fade_in (ContentTime t)
 }
 
 void
-VideoContent::set_fade_out (ContentTime t)
+VideoContent::set_fade_out (Frame t)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -468,22 +444,11 @@ VideoContent::video_size_after_crop () const
        return crop().apply (video_size_after_3d_split ());
 }
 
-/** @param t A time offset from the start of this piece of content.
- *  @return Corresponding time with respect to the content.
- */
-ContentTime
-VideoContent::dcp_time_to_content_time (DCPTime t) const
-{
-       shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-       return ContentTime (t, FrameRateChange (video_frame_rate(), film->video_frame_rate()));
-}
-
 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 ()));
 
@@ -496,7 +461,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 ()));
 
@@ -513,25 +478,25 @@ VideoContent::set_video_frame_rate (float r)
                if (_video_frame_rate == r) {
                        return;
                }
-               
+
                _video_frame_rate = r;
        }
-       
+
        signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 }
 
 optional<float>
-VideoContent::fade (VideoFrame f) const
+VideoContent::fade (Frame f) const
 {
-       assert (f >= 0);
-       
-       if (f < fade_in().frames (video_frame_rate ())) {
-               return float (f) / _fade_in.frames (video_frame_rate ());
+       DCPOMATIC_ASSERT (f >= 0);
+
+       if (f < fade_in()) {
+               return float (f) / fade_in();
        }
 
-       VideoFrame fade_out_start = ContentTime (video_length() - fade_out()).frames (video_frame_rate ());
+       Frame fade_out_start = video_length() - fade_out();
        if (f >= fade_out_start) {
-               return 1 - float (f - fade_out_start) / fade_out().frames (video_frame_rate ());
+               return 1 - float (f - fade_out_start) / fade_out();
        }
 
        return optional<float> ();
@@ -550,7 +515,15 @@ VideoContent::processing_description () const
                        video_size_after_3d_split().height
                        );
 
-               d << " (" << fixed << setprecision(2) << video_size_after_3d_split().ratio() << ":1)\n";
+
+               float 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)) {
@@ -564,10 +537,10 @@ VideoContent::processing_description () const
        }
 
        shared_ptr<const Film> film = _film.lock ();
-       assert (film);
+       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, 1);
+       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 (
@@ -577,10 +550,11 @@ VideoContent::processing_description () const
 
                d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
        }
-       
+
        if (scaled != container_size) {
                d << String::compose (
-                       _("Padded with black to %1x%2"),
+                       _("Padded with black to fit container %1 (%2x%3)"),
+                       film->container()->nickname (),
                        container_size.width, container_size.height
                        );
 
@@ -589,7 +563,7 @@ 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";