Basic adaptations for changes to libdcp1 colour conversion handling.
[dcpomatic.git] / src / lib / video_content.cc
index 0a3e378eecb1fda2f05ef3b6894659c6849386fe..5cf4704ea73585f4bcb306cfcfa82d7dec861e12 100644 (file)
 
 */
 
-#include <iomanip>
-#include <libcxml/cxml.h>
-#include <dcp/colour_matrix.h>
-#include <dcp/raw_convert.h>
 #include "video_content.h"
 #include "video_examiner.h"
 #include "compose.hpp"
 #include "exceptions.h"
 #include "frame_rate_change.h"
 #include "log.h"
+#include "safe_stringstream.h"
+#include <libcxml/cxml.h>
+#include <dcp/colour_matrix.h>
+#include <dcp/raw_convert.h>
+#include <iomanip>
 
 #include "i18n.h"
 
@@ -43,29 +44,31 @@ 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::stringstream;
 using std::setprecision;
 using std::cout;
 using std::vector;
 using std::min;
 using std::max;
+using std::stringstream;
+using std::fixed;
+using std::setprecision;
 using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
 using dcp::raw_convert;
 
-vector<VideoContentScale> VideoContentScale::_scales;
-
 VideoContent::VideoContent (shared_ptr<const Film> f)
        : Content (f)
        , _video_length (0)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (Config::instance()->default_scale ())
+       , _scale (VideoContentScale (Ratio::from_id ("178")))
 {
-       setup_default_colour_conversion ();
+       set_default_colour_conversion (false);
 }
 
 VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, ContentTime len)
@@ -73,9 +76,9 @@ VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, ContentTime len
        , _video_length (len)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (Config::instance()->default_scale ())
+       , _scale (VideoContentScale (Ratio::from_id ("178")))
 {
-       setup_default_colour_conversion ();
+       set_default_colour_conversion (false);
 }
 
 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
@@ -83,9 +86,9 @@ VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
        , _video_length (0)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _scale (Config::instance()->default_scale ())
+       , _scale (VideoContentScale (Ratio::from_id ("178")))
 {
-       setup_default_colour_conversion ();
+       set_default_colour_conversion (false);
 }
 
 VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
@@ -103,6 +106,7 @@ VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, i
        }
        
        _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");
        _crop.right = node->number_child<int> ("RightCrop");
        _crop.top = node->number_child<int> ("TopCrop");
@@ -116,8 +120,15 @@ VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, i
        } 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"));
+       }
+       if (version >= 32) {
+               _fade_in = ContentTime (node->number_child<int64_t> ("FadeIn"));
+               _fade_out = ContentTime (node->number_child<int64_t> ("FadeOut"));
+       }
 }
 
 VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
@@ -125,7 +136,7 @@ VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content>
        , _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]);
@@ -154,6 +165,10 @@ 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 ();
        }
 
@@ -163,6 +178,8 @@ VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content>
        _crop = ref->crop ();
        _scale = ref->scale ();
        _colour_conversion = ref->colour_conversion ();
+       _fade_in = ref->fade_in ();
+       _fade_out = ref->fade_out ();
 }
 
 void
@@ -174,15 +191,29 @@ VideoContent::as_xml (xmlpp::Node* node) const
        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("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.get ()));
+       node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out.get ()));
 }
 
 void
-VideoContent::setup_default_colour_conversion ()
+VideoContent::set_default_colour_conversion (bool signal)
 {
-       _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _colour_conversion = ColourConversion (dcp::ColourConversion::srgb_to_xyz);
+       }
+
+       if (signal) {
+               signal_changed (VideoContentProperty::COLOUR_CONVERSION);
+       }
 }
 
 void
@@ -190,45 +221,34 @@ 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 ();
-       float const vfr = d->video_frame_rate ();
+       optional<float> const vfr = d->video_frame_rate ();
        ContentTime vl = d->video_length ();
+       optional<float> const ar = d->sample_aspect_ratio ();
 
        {
                boost::mutex::scoped_lock lm (_mutex);
                _video_size = vs;
-               _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 (float (_video_size.width) * ar.get_value_or (1) / _video_size.height)
+                       );
        }
 
        shared_ptr<const Film> film = _film.lock ();
-       assert (film);
+       DCPOMATIC_ASSERT (film);
        LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length.frames (_video_frame_rate));
        
        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 "";
-       }
-       
-       stringstream s;
-
-       s << String::compose (
-               _("%1x%2 pixels (%3:1)"),
-               video_size().width,
-               video_size().height,
-               setprecision (3), video_size().ratio ()
-               );
-       
-       return s.str ();
-}
-
 void
 VideoContent::set_left_crop (int c)
 {
@@ -309,14 +329,17 @@ VideoContent::set_scale (VideoContentScale s)
 string
 VideoContent::identifier () const
 {
-       stringstream s;
+       SafeStringStream s;
        s << Content::identifier()
          << "_" << crop().left
          << "_" << crop().right
          << "_" << crop().top
          << "_" << crop().bottom
-         << "_" << scale().id()
-         << "_" << colour_conversion().identifier ();
+         << "_" << scale().id();
+
+       if (colour_conversion()) {
+               s << "_" << colour_conversion().get().identifier ();
+       }
 
        return s.str ();
 }
@@ -335,13 +358,19 @@ VideoContent::set_video_frame_type (VideoFrameType t)
 string
 VideoContent::technical_summary () const
 {
-       return String::compose (
+       string s = String::compose (
                "video: length %1, size %2x%3, rate %4",
                video_length_after_3d_combine().seconds(),
                video_size().width,
                video_size().height,
                video_frame_rate()
                );
+
+       if (sample_aspect_ratio ()) {
+               s += String::compose (_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
+       }
+
+       return s;
 }
 
 dcp::Size
@@ -360,7 +389,18 @@ 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 ()
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _colour_conversion = boost::optional<ColourConversion> ();
+       }
+
+       signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 }
 
 void
@@ -374,6 +414,28 @@ VideoContent::set_colour_conversion (ColourConversion c)
        signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 }
 
+void
+VideoContent::set_fade_in (ContentTime t)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _fade_in = t;
+       }
+
+       signal_changed (VideoContentProperty::VIDEO_FADE_IN);
+}
+
+void
+VideoContent::set_fade_out (ContentTime t)
+{
+       {
+               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
@@ -388,7 +450,7 @@ ContentTime
 VideoContent::dcp_time_to_content_time (DCPTime t) const
 {
        shared_ptr<const Film> film = _film.lock ();
-       assert (film);
+       DCPOMATIC_ASSERT (film);
        return ContentTime (t, FrameRateChange (video_frame_rate(), film->video_frame_rate()));
 }
 
@@ -396,7 +458,7 @@ 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 ()));
 
@@ -409,7 +471,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 ()));
 
@@ -433,123 +495,78 @@ VideoContent::set_video_frame_rate (float r)
        signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 }
 
-VideoContentScale::VideoContentScale (Ratio const * r)
-       : _ratio (r)
-       , _scale (true)
+optional<float>
+VideoContent::fade (VideoFrame f) const
 {
-
-}
-
-VideoContentScale::VideoContentScale ()
-       : _ratio (0)
-       , _scale (false)
-{
-
-}
-
-VideoContentScale::VideoContentScale (bool scale)
-       : _ratio (0)
-       , _scale (scale)
-{
-
-}
-
-VideoContentScale::VideoContentScale (cxml::NodePtr node)
-       : _ratio (0)
-       , _scale (true)
-{
-       optional<string> r = node->optional_string_child ("Ratio");
-       if (r) {
-               _ratio = Ratio::from_id (r.get ());
-       } else {
-               _scale = node->bool_child ("Scale");
+       DCPOMATIC_ASSERT (f >= 0);
+       
+       if (f < fade_in().frames (video_frame_rate ())) {
+               return float (f) / _fade_in.frames (video_frame_rate ());
        }
-}
 
-void
-VideoContentScale::as_xml (xmlpp::Node* node) const
-{
-       if (_ratio) {
-               node->add_child("Ratio")->add_child_text (_ratio->id ());
-       } else {
-               node->add_child("Scale")->add_child_text (_scale ? "1" : "0");
+       VideoFrame fade_out_start = ContentTime (video_length() - fade_out()).frames (video_frame_rate ());
+       if (f >= fade_out_start) {
+               return 1 - float (f - fade_out_start) / fade_out().frames (video_frame_rate ());
        }
-}
 
-string
-VideoContentScale::id () const
-{
-       stringstream s;
-       
-       if (_ratio) {
-               s << _ratio->id () << "_";
-       } else {
-               s << (_scale ? "S1" : "S0");
-       }
-       
-       return s.str ();
+       return optional<float> ();
 }
 
 string
-VideoContentScale::name () const
+VideoContent::processing_description () const
 {
-       if (_ratio) {
-               return _ratio->nickname ();
-       }
+       /* 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
+                       );
 
-       if (_scale) {
-               return _("No stretch");
+               d << " (" << fixed << setprecision(2) << video_size_after_3d_split().ratio() << ":1)\n";
        }
 
-       return _("No scale");
-}
+       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
+                       );
 
-/** @param display_container Size of the container that we are displaying this content in.
- *  @param film_container The size of the film's image.
- */
-dcp::Size
-VideoContentScale::size (shared_ptr<const VideoContent> c, dcp::Size display_container, dcp::Size film_container, int round) const
-{
-       if (_ratio) {
-               return fit_ratio_within (_ratio->ratio (), display_container, round);
+               d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
        }
 
-       dcp::Size const ac = c->video_size_after_crop ();
+       shared_ptr<const Film> film = _film.lock ();
+       DCPOMATIC_ASSERT (film);
 
-       /* Force scale if the film_container is smaller than the content's image */
-       if (_scale || film_container.width < ac.width || film_container.height < ac.height) {
-               return fit_ratio_within (ac.ratio (), display_container, 1);
-       }
+       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);
 
-       /* Scale the image so that it will be in the right place in film_container, even if display_container is a
-          different size.
-       */
-       return dcp::Size (
-               round_to (c->video_size().width  * float(display_container.width)  / film_container.width, round),
-               round_to (c->video_size().height * float(display_container.height) / film_container.height, round)
-               );
-}
+       if (scaled != video_size_after_crop ()) {
+               d << String::compose (
+                       _("Scaled to %1x%2"),
+                       scaled.width, scaled.height
+                       );
 
-void
-VideoContentScale::setup_scales ()
-{
-       vector<Ratio const *> ratios = Ratio::all ();
-       for (vector<Ratio const *>::const_iterator i = ratios.begin(); i != ratios.end(); ++i) {
-               _scales.push_back (VideoContentScale (*i));
+               d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
        }
+       
+       if (scaled != container_size) {
+               d << String::compose (
+                       _("Padded with black to %1x%2"),
+                       container_size.width, container_size.height
+                       );
 
-       _scales.push_back (VideoContentScale (true));
-       _scales.push_back (VideoContentScale (false));
-}
+               d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
+       }
 
-bool
-operator== (VideoContentScale const & a, VideoContentScale const & b)
-{
-       return (a.ratio() == b.ratio() && a.scale() == b.scale());
-}
+       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";
 
-bool
-operator!= (VideoContentScale const & a, VideoContentScale const & b)
-{
-       return (a.ratio() != b.ratio() || a.scale() != b.scale());
+       return d.str ();
 }