Move VideoContentScale to its own file.
[dcpomatic.git] / src / lib / video_content.cc
index 2e413678f5d0aa219a91157b8162b8a0594fd3f5..13f2cf51676a9d10bb3b6acce245457d1dd2db66 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 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_decoder.h"
+#include "video_examiner.h"
+#include "compose.hpp"
+#include "ratio.h"
+#include "config.h"
+#include "colour_conversion.h"
+#include "util.h"
+#include "film.h"
+#include "exceptions.h"
+#include "frame_rate_change.h"
+#include "safe_stringstream.h"
 
 #include "i18n.h"
 
-int const VideoContentProperty::VIDEO_LENGTH = 0;
-int const VideoContentProperty::VIDEO_SIZE = 1;
-int const VideoContentProperty::VIDEO_FRAME_RATE = 2;
-int const VideoContentProperty::VIDEO_CROP = 3;
+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;
 
 using std::string;
-using std::stringstream;
 using std::setprecision;
+using std::cout;
+using std::vector;
+using std::min;
+using std::max;
 using boost::shared_ptr;
-using boost::lexical_cast;
+using boost::optional;
+using boost::dynamic_pointer_cast;
+using libdcp::raw_convert;
 
-VideoContent::VideoContent (shared_ptr<const Film> f, Time s, ContentVideoFrame len)
+VideoContent::VideoContent (shared_ptr<const Film> f)
+       : Content (f)
+       , _video_length (0)
+       , _original_video_frame_rate (0)
+       , _video_frame_rate (0)
+       , _video_frame_type (VIDEO_FRAME_TYPE_2D)
+       , _scale (Config::instance()->default_scale ())
+{
+       setup_default_colour_conversion ();
+}
+
+VideoContent::VideoContent (shared_ptr<const Film> f, Time s, VideoContent::Frame len)
        : Content (f, 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 ())
 {
-
+       setup_default_colour_conversion ();
 }
 
 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
        : Content (f, 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 ())
 {
-
+       setup_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
+VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version)
        : Content (f, node)
 {
-       _video_length = node->number_child<ContentVideoFrame> ("VideoLength");
+       _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_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
        _crop.left = node->number_child<int> ("LeftCrop");
        _crop.right = node->number_child<int> ("RightCrop");
        _crop.top = node->number_child<int> ("TopCrop");
        _crop.bottom = node->number_child<int> ("BottomCrop");
+
+       if (version <= 7) {
+               optional<string> r = node->optional_string_child ("Ratio");
+               if (r) {
+                       _scale = VideoContentScale (Ratio::from_id (r.get ()));
+               }
+       } else {
+               _scale = VideoContentScale (node->node_child ("Scale"));
+       }
+       
+       _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
 }
 
-VideoContent::VideoContent (VideoContent const & o)
-       : Content (o)
-       , _video_length (o._video_length)
-       , _video_size (o._video_size)
-       , _video_frame_rate (o._video_frame_rate)
+VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
+       : Content (f, c)
+       , _video_length (0)
 {
+       shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
+       assert (ref);
+
+       for (size_t i = 0; i < c.size(); ++i) {
+               shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
 
+               if (vc->video_size() != ref->video_size()) {
+                       throw JoinError (_("Content to be joined must have the same picture size."));
+               }
+
+               if (vc->video_frame_rate() != ref->video_frame_rate()) {
+                       throw JoinError (_("Content to be joined must have the same video frame rate."));
+               }
+
+               if (vc->video_frame_type() != ref->video_frame_type()) {
+                       throw JoinError (_("Content to be joined must have the same video frame type."));
+               }
+
+               if (vc->crop() != ref->crop()) {
+                       throw JoinError (_("Content to be joined must have the same crop."));
+               }
+
+               if (vc->scale() != ref->scale()) {
+                       throw JoinError (_("Content to be joined must have the same scale setting."));
+               }
+
+               if (vc->colour_conversion() != ref->colour_conversion()) {
+                       throw JoinError (_("Content to be joined must have the same colour conversion."));
+               }
+
+               _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 ();
 }
 
 void
 VideoContent::as_xml (xmlpp::Node* node) const
 {
        boost::mutex::scoped_lock lm (_mutex);
-       node->add_child("VideoLength")->add_child_text (lexical_cast<string> (_video_length));
-       node->add_child("VideoWidth")->add_child_text (lexical_cast<string> (_video_size.width));
-       node->add_child("VideoHeight")->add_child_text (lexical_cast<string> (_video_size.height));
-       node->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
-       node->add_child("LeftCrop")->add_child_text (boost::lexical_cast<string> (_crop.left));
-       node->add_child("RightCrop")->add_child_text (boost::lexical_cast<string> (_crop.right));
-       node->add_child("TopCrop")->add_child_text (boost::lexical_cast<string> (_crop.top));
-       node->add_child("BottomCrop")->add_child_text (boost::lexical_cast<string> (_crop.bottom));
+       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));
+       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)));
+       _crop.as_xml (node);
+       _scale.as_xml (node->add_child("Scale"));
+       _colour_conversion.as_xml (node->add_child("ColourConversion"));
+}
+
+void
+VideoContent::setup_default_colour_conversion ()
+{
+       _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
 }
 
 void
-VideoContent::take_from_video_decoder (shared_ptr<VideoDecoder> d)
+VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
 {
-       /* These decoder calls could call other content methods which take a lock on the mutex */
+       /* 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 ();
        
-        {
-                boost::mutex::scoped_lock lm (_mutex);
-                _video_size = vs;
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _video_size = vs;
                _video_frame_rate = vfr;
-        }
-        
-        signal_changed (VideoContentProperty::VIDEO_SIZE);
-        signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
+               _original_video_frame_rate = vfr;
+       }
+       
+       signal_changed (VideoContentProperty::VIDEO_SIZE);
+       signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 }
 
 
@@ -109,28 +205,18 @@ VideoContent::information () const
                return "";
        }
        
-       stringstream s;
+       SafeStringStream s;
 
        s << String::compose (
                _("%1x%2 pixels (%3:1)"),
                video_size().width,
                video_size().height,
-               setprecision (3), float (video_size().width) / video_size().height
+               setprecision (3), video_size().ratio ()
                );
        
        return s.str ();
 }
 
-void
-VideoContent::set_crop (Crop c)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _crop = c;
-       }
-       signal_changed (VideoContentProperty::VIDEO_CROP);
-}
-
 void
 VideoContent::set_left_crop (int c)
 {
@@ -192,3 +278,150 @@ VideoContent::set_bottom_crop (int c)
        signal_changed (VideoContentProperty::VIDEO_CROP);
 }
 
+void
+VideoContent::set_scale (VideoContentScale s)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               if (_scale == s) {
+                       return;
+               }
+
+               _scale = s;
+       }
+
+       signal_changed (VideoContentProperty::VIDEO_SCALE);
+}
+
+/** @return string which includes everything about how this content looks */
+string
+VideoContent::identifier () const
+{
+       SafeStringStream s;
+       s << Content::identifier()
+         << "_" << crop().left
+         << "_" << crop().right
+         << "_" << crop().top
+         << "_" << crop().bottom
+         << "_" << scale().id()
+         << "_" << colour_conversion().identifier ();
+
+       return s.str ();
+}
+
+void
+VideoContent::set_video_frame_type (VideoFrameType t)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _video_frame_type = t;
+       }
+
+       signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
+}
+
+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()
+               );
+}
+
+libdcp::Size
+VideoContent::video_size_after_3d_split () const
+{
+       libdcp::Size const s = video_size ();
+       switch (video_frame_type ()) {
+       case VIDEO_FRAME_TYPE_2D:
+       case VIDEO_FRAME_TYPE_3D_ALTERNATE:
+       case VIDEO_FRAME_TYPE_3D_LEFT:
+       case VIDEO_FRAME_TYPE_3D_RIGHT:
+               return s;
+       case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
+               return libdcp::Size (s.width / 2, s.height);
+       case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
+               return libdcp::Size (s.width, s.height / 2);
+       }
+
+       assert (false);
+}
+
+void
+VideoContent::set_colour_conversion (ColourConversion c)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _colour_conversion = c;
+       }
+
+       signal_changed (VideoContentProperty::COLOUR_CONVERSION);
+}
+
+/** @return Video size after 3D split and crop */
+libdcp::Size
+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 frame index.
+ */
+VideoContent::Frame
+VideoContent::time_to_content_video_frames (Time t) const
+{
+       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);
+}
+
+void
+VideoContent::scale_and_crop_to_fit_width ()
+{
+       shared_ptr<const Film> film = _film.lock ();
+       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_top_crop (crop / 2);
+       set_bottom_crop (crop / 2);
+}
+
+void
+VideoContent::scale_and_crop_to_fit_height ()
+{
+       shared_ptr<const Film> film = _film.lock ();
+       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);
+}
+
+void
+VideoContent::set_video_frame_rate (float r)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               if (_video_frame_rate == r) {
+                       return;
+               }
+               
+               _video_frame_rate = r;
+       }
+       
+       signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
+}
+