Merge master.
[dcpomatic.git] / src / lib / video_content.cc
index bf13e1c764f61df1c8c578474c47e5bce5788276..c3aea2b0faab8032ffcf092a773471285cf55537 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 <dcp/colour_matrix.h>
 #include "video_content.h"
 #include "video_examiner.h"
-#include "ratio.h"
 #include "compose.hpp"
+#include "ratio.h"
 #include "config.h"
 #include "colour_conversion.h"
 #include "util.h"
@@ -36,7 +36,7 @@ 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_RATIO      = 4;
+int const VideoContentProperty::VIDEO_SCALE      = 4;
 int const VideoContentProperty::COLOUR_CONVERSION = 5;
 
 using std::string;
@@ -49,22 +49,24 @@ using boost::lexical_cast;
 using boost::optional;
 using boost::dynamic_pointer_cast;
 
+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)
-       , _ratio (Ratio::from_id ("185"))
+       , _scale (Ratio::from_id ("185"))
 {
        setup_default_colour_conversion ();
 }
 
-VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, VideoFrame len)
+VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, ContentTime len)
        : Content (f, s)
        , _video_length (len)
        , _video_frame_rate (0)
        , _video_frame_type (VIDEO_FRAME_TYPE_2D)
-       , _ratio (Ratio::from_id ("185"))
+       , _scale (Ratio::from_id ("185"))
 {
        setup_default_colour_conversion ();
 }
@@ -74,16 +76,15 @@ 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)
-       , _ratio (Ratio::from_id ("185"))
+       , _scale (Ratio::from_id ("185"))
 {
        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)
-       , _ratio (0)
 {
-       _video_length = node->number_child<VideoFrame> ("VideoLength");
+       _video_length = ContentTime (node->number_child<int64_t> ("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");
@@ -92,10 +93,16 @@ VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Nod
        _crop.right = node->number_child<int> ("RightCrop");
        _crop.top = node->number_child<int> ("TopCrop");
        _crop.bottom = node->number_child<int> ("BottomCrop");
-       optional<string> r = node->optional_string_child ("Ratio");
-       if (r) {
-               _ratio = Ratio::from_id (r.get ());
+
+       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"));
 }
 
@@ -125,8 +132,8 @@ VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content>
                        throw JoinError (_("Content to be joined must have the same crop."));
                }
 
-               if (vc->ratio() != ref->ratio()) {
-                       throw JoinError (_("Content to be joined must have the same ratio."));
+               if (vc->scale() != ref->scale()) {
+                       throw JoinError (_("Content to be joined must have the same scale setting."));
                }
 
                if (vc->colour_conversion() != ref->colour_conversion()) {
@@ -140,7 +147,7 @@ VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content>
        _video_frame_rate = ref->video_frame_rate ();
        _video_frame_type = ref->video_frame_type ();
        _crop = ref->crop ();
-       _ratio = ref->ratio ();
+       _scale = ref->scale ();
        _colour_conversion = ref->colour_conversion ();
 }
 
@@ -148,7 +155,7 @@ 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("VideoLength")->add_child_text (lexical_cast<string> (_video_length.get ()));
        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));
@@ -157,23 +164,21 @@ VideoContent::as_xml (xmlpp::Node* node) const
        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));
-       if (_ratio) {
-               node->add_child("Ratio")->add_child_text (_ratio->id ());
-       }
+       _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;
+       _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6).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 ();
+       dcp::Size const vs = d->video_size ();
        float const vfr = d->video_frame_rate ();
        
        {
@@ -268,18 +273,18 @@ VideoContent::set_bottom_crop (int c)
 }
 
 void
-VideoContent::set_ratio (Ratio const * r)
+VideoContent::set_scale (VideoContentScale s)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               if (_ratio == r) {
+               if (_scale == s) {
                        return;
                }
 
-               _ratio = r;
+               _scale = s;
        }
 
-       signal_changed (VideoContentProperty::VIDEO_RATIO);
+       signal_changed (VideoContentProperty::VIDEO_SCALE);
 }
 
 /** @return string which includes everything about how this content looks */
@@ -292,12 +297,9 @@ VideoContent::identifier () const
          << "_" << crop().right
          << "_" << crop().top
          << "_" << crop().bottom
+         << "_" << scale().id()
          << "_" << colour_conversion().identifier ();
 
-       if (ratio()) {
-               s << "_" << ratio()->id ();
-       }
-
        return s.str ();
 }
 
@@ -315,20 +317,26 @@ 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(), video_size().width, video_size().height, video_frame_rate());
+       return String::compose (
+               "video: length %1, size %2x%3, rate %4",
+               video_length().seconds(),
+               video_size().width,
+               video_size().height,
+               video_frame_rate()
+               );
 }
 
-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:
                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);
        }
 
        assert (false);
@@ -346,28 +354,140 @@ VideoContent::set_colour_conversion (ColourConversion c)
 }
 
 /** @return Video size after 3D split and crop */
-libdcp::Size
+dcp::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, rounded up so that the frame index
- *  is that of the next complete frame which starts after `t'.
+ *  @return Corresponding time with respect to the content.
  */
-VideoFrame
-VideoContent::time_to_content_video_frames (DCPTime t) const
+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()));
+}
+
+VideoContentScale::VideoContentScale (Ratio const * r)
+       : _ratio (r)
+       , _scale (true)
+{
+
+}
+
+VideoContentScale::VideoContentScale ()
+       : _ratio (0)
+       , _scale (false)
+{
+
+}
+
+VideoContentScale::VideoContentScale (bool scale)
+       : _ratio (0)
+       , _scale (scale)
+{
+
+}
+
+VideoContentScale::VideoContentScale (shared_ptr<cxml::Node> 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");
+       }
+}
+
+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");
+       }
+}
+
+string
+VideoContentScale::id () const
+{
+       stringstream s;
        
-       /* 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; source rate will be equal to DCP rate if we ignore
-          double/skip.  There's no need to call Film::active_frame_rate_change() here
-          as we know that we are it (since we're video).
+       if (_ratio) {
+               s << _ratio->id () << "_";
+       } else {
+               s << (_scale ? "S1" : "S0");
+       }
+       
+       return s.str ();
+}
+
+string
+VideoContentScale::name () const
+{
+       if (_ratio) {
+               return _ratio->nickname ();
+       }
+
+       if (_scale) {
+               return _("No stretch");
+       }
+
+       return _("No scale");
+}
+
+/** @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) const
+{
+       if (_ratio) {
+               return fit_ratio_within (_ratio->ratio (), display_container);
+       }
+
+       libdcp::Size const ac = c->video_size_after_crop ();
+
+       /* 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);
+       }
+
+       /* Scale the image so that it will be in the right place in film_container, even if display_container is a
+          different size.
        */
-       FrameRateChange frc (video_frame_rate(), film->video_frame_rate());
-       return ceil (t * film->video_frame_rate() / (frc.factor() * TIME_HZ));
+       return libdcp::Size (
+               c->video_size().width  * float(display_container.width)  / film_container.width,
+               c->video_size().height * float(display_container.height) / film_container.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));
+       }
+
+       _scales.push_back (VideoContentScale (true));
+       _scales.push_back (VideoContentScale (false));
+}
+
+bool
+operator== (VideoContentScale const & a, VideoContentScale const & b)
+{
+       return (a.ratio() == b.ratio() && a.scale() == b.scale());
+}
+
+bool
+operator!= (VideoContentScale const & a, VideoContentScale const & b)
+{
+       return (a.ratio() != b.ratio() || a.scale() != b.scale());
 }