Move raw_convert into libdcp.
[dcpomatic.git] / src / lib / video_content.cc
index 0533a12e50fcdb922332f43af8ab4aadafd26419..20e0866a166377f6ba90666d472ebe7052e8668c 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -29,8 +30,7 @@
 #include "exceptions.h"
 #include "frame_rate_change.h"
 #include "log.h"
-#include "safe_stringstream.h"
-#include "raw_convert.h"
+#include <dcp/raw_convert.h>
 #include <libcxml/cxml.h>
 #include <dcp/colour_matrix.h>
 #include <libxml++/libxml++.h>
 
 #include "i18n.h"
 
-#define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
+#define LOG_GENERAL(...) _parent->film()->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
 
 int const VideoContentProperty::SIZE     = 0;
-int const VideoContentProperty::FRAME_RATE  = 1;
-int const VideoContentProperty::FRAME_TYPE  = 2;
-int const VideoContentProperty::CROP     = 3;
-int const VideoContentProperty::SCALE    = 4;
-int const VideoContentProperty::COLOUR_CONVERSION = 5;
-int const VideoContentProperty::FADE_IN     = 6;
-int const VideoContentProperty::FADE_OUT    = 7;
+int const VideoContentProperty::FRAME_TYPE  = 1;
+int const VideoContentProperty::CROP     = 2;
+int const VideoContentProperty::SCALE    = 3;
+int const VideoContentProperty::COLOUR_CONVERSION = 4;
+int const VideoContentProperty::FADE_IN     = 5;
+int const VideoContentProperty::FADE_OUT    = 6;
 
 using std::string;
 using std::setprecision;
@@ -63,9 +62,10 @@ using std::pair;
 using boost::shared_ptr;
 using boost::optional;
 using boost::dynamic_pointer_cast;
+using dcp::raw_convert;
 
-VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film)
-       : ContentPart (parent, film)
+VideoContent::VideoContent (Content* parent)
+       : ContentPart (parent)
        , _length (0)
        , _frame_type (VIDEO_FRAME_TYPE_2D)
        , _scale (VideoContentScale (Ratio::from_id ("178")))
@@ -76,14 +76,56 @@ VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film)
 
 }
 
-VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
-       : ContentPart (parent, film)
+shared_ptr<VideoContent>
+VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
+{
+       if (!node->optional_number_child<int> ("VideoWidth")) {
+               return shared_ptr<VideoContent> ();
+       }
+
+       return shared_ptr<VideoContent> (new VideoContent (parent, node, version));
+}
+
+VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
+       : ContentPart (parent)
 {
        _size.width = node->number_child<int> ("VideoWidth");
        _size.height = node->number_child<int> ("VideoHeight");
-       _frame_rate = node->optional_number_child<double> ("VideoFrameRate");
+
+       /* Backwards compatibility */
+       optional<double> r = node->optional_number_child<double>("VideoFrameRate");
+       if (r) {
+               _parent->set_video_frame_rate (r.get ());
+       }
+
        _length = node->number_child<Frame> ("VideoLength");
-       _frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
+
+       if (version <= 34) {
+               /* Snapshot of the VideoFrameType enum at version 34 */
+               switch (node->number_child<int> ("VideoFrameType")) {
+               case 0:
+                       _frame_type = VIDEO_FRAME_TYPE_2D;
+                       break;
+               case 1:
+                       _frame_type = VIDEO_FRAME_TYPE_3D_LEFT_RIGHT;
+                       break;
+               case 2:
+                       _frame_type = VIDEO_FRAME_TYPE_3D_TOP_BOTTOM;
+                       break;
+               case 3:
+                       _frame_type = VIDEO_FRAME_TYPE_3D_ALTERNATE;
+                       break;
+               case 4:
+                       _frame_type = VIDEO_FRAME_TYPE_3D_LEFT;
+                       break;
+               case 5:
+                       _frame_type = VIDEO_FRAME_TYPE_3D_RIGHT;
+                       break;
+               }
+       } else {
+               _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
+       }
+
        _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
        _crop.left = node->number_child<int> ("LeftCrop");
        _crop.right = node->number_child<int> ("RightCrop");
@@ -114,8 +156,8 @@ VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, cxml::
        }
 }
 
-VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
-       : ContentPart (parent, film)
+VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
+       : ContentPart (parent)
        , _length (0)
        , _yuv (false)
 {
@@ -128,10 +170,6 @@ VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, vector
                        throw JoinError (_("Content to be joined must have the same picture size."));
                }
 
-               if (c[i]->video->frame_rate() != ref->frame_rate()) {
-                       throw JoinError (_("Content to be joined must have the same video frame rate."));
-               }
-
                if (c[i]->video->frame_type() != ref->frame_type()) {
                        throw JoinError (_("Content to be joined must have the same video frame type."));
                }
@@ -160,7 +198,6 @@ VideoContent::VideoContent (Content* parent, shared_ptr<const Film> film, vector
        }
 
        _size = ref->size ();
-       _frame_rate = ref->frame_rate ();
        _frame_type = ref->frame_type ();
        _crop = ref->crop ();
        _scale = ref->scale ();
@@ -176,10 +213,7 @@ VideoContent::as_xml (xmlpp::Node* node) const
        node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
        node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
        node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
-       if (_frame_rate) {
-               node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_frame_rate.get()));
-       }
-       node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_frame_type)));
+       node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
        if (_sample_aspect_ratio) {
                node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
        }
@@ -198,7 +232,6 @@ VideoContent::take_from_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<double> const vfr = d->video_frame_rate ();
        Frame vl = d->video_length ();
        optional<double> const ar = d->sample_aspect_ratio ();
        bool const yuv = d->yuv ();
@@ -206,7 +239,6 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
        {
                boost::mutex::scoped_lock lm (_mutex);
                _size = vs;
-               _frame_rate = vfr;
                _length = vl;
                _sample_aspect_ratio = ar;
                _yuv = yuv;
@@ -217,12 +249,13 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
                        );
        }
 
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
        LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
 
+       if (d->video_frame_rate()) {
+               _parent->set_video_frame_rate (d->video_frame_rate().get());
+       }
+
        _parent->signal_changed (VideoContentProperty::SIZE);
-       _parent->signal_changed (VideoContentProperty::FRAME_RATE);
        _parent->signal_changed (VideoContentProperty::SCALE);
        _parent->signal_changed (ContentProperty::LENGTH);
 }
@@ -231,31 +264,35 @@ VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
 string
 VideoContent::identifier () const
 {
-       SafeStringStream s;
-       s << crop().left
-         << "_" << crop().right
-         << "_" << crop().top
-         << "_" << crop().bottom
-         << "_" << scale().id()
-         << "_" << _fade_in
-         << "_" << _fade_out;
+       char buffer[256];
+       snprintf (
+               buffer, sizeof(buffer), "%d_%d_%d_%d_%s_%" PRId64 "_%" PRId64,
+               crop().left,
+               crop().right,
+               crop().top,
+               crop().bottom,
+               scale().id().c_str(),
+               _fade_in,
+               _fade_out
+               );
+
+       string s (buffer);
 
        if (colour_conversion()) {
-               s << "_" << colour_conversion().get().identifier ();
+               s += "_" + colour_conversion().get().identifier ();
        }
 
-       return s.str ();
+       return s;
 }
 
 string
 VideoContent::technical_summary () const
 {
        string s = String::compose (
-               N_("video: length %1 frames, size %2x%3, rate %4"),
+               N_("video: length %1 frames, size %2x%3"),
                length_after_3d_combine(),
                size().width,
-               size().height,
-               frame_rate()
+               size().height
                );
 
        if (sample_aspect_ratio ()) {
@@ -271,6 +308,7 @@ VideoContent::size_after_3d_split () const
        dcp::Size const s = size ();
        switch (frame_type ()) {
        case VIDEO_FRAME_TYPE_2D:
+       case VIDEO_FRAME_TYPE_3D:
        case VIDEO_FRAME_TYPE_3D_ALTERNATE:
        case VIDEO_FRAME_TYPE_3D_LEFT:
        case VIDEO_FRAME_TYPE_3D_RIGHT:
@@ -294,8 +332,7 @@ VideoContent::size_after_crop () const
 void
 VideoContent::scale_and_crop_to_fit_width ()
 {
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
+       shared_ptr<const Film> film = _parent->film ();
        set_scale (VideoContentScale (film->container ()));
 
        int const crop = max (0, int (size().height - double (film->frame_size().height) * size().width / film->frame_size().width));
@@ -308,8 +345,7 @@ VideoContent::scale_and_crop_to_fit_width ()
 void
 VideoContent::scale_and_crop_to_fit_height ()
 {
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
+       shared_ptr<const Film> film = _parent->film ();
        set_scale (VideoContentScale (film->container ()));
 
        int const crop = max (0, int (size().width - double (film->frame_size().width) * size().height / film->frame_size().height));
@@ -325,12 +361,16 @@ VideoContent::fade (Frame f) const
 {
        DCPOMATIC_ASSERT (f >= 0);
 
-       Frame const ts = _parent->trim_start().frames_round(frame_rate());
+       shared_ptr<const Film> film = _parent->film ();
+
+       double const vfr = _parent->active_video_frame_rate ();
+
+       Frame const ts = _parent->trim_start().frames_round(vfr);
        if ((f - ts) < fade_in()) {
                return double (f - ts) / fade_in();
        }
 
-       Frame fade_out_start = length() - _parent->trim_end().frames_round(frame_rate()) - fade_out();
+       Frame fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
        if (f >= fade_out_start) {
                return 1 - double (f - fade_out_start) / fade_out();
        }
@@ -341,11 +381,11 @@ VideoContent::fade (Frame f) const
 string
 VideoContent::processing_description () const
 {
-       /* stringstream is OK here as this string is just for presentation to the user */
-       SafeStringStream d;
+       string d;
+       char buffer[256];
 
        if (size().width && size().height) {
-               d << String::compose (
+               d += String::compose (
                        _("Content video is %1x%2"),
                        size_after_3d_split().width,
                        size_after_3d_split().height
@@ -355,71 +395,69 @@ VideoContent::processing_description () const
                double ratio = size_after_3d_split().ratio ();
 
                if (sample_aspect_ratio ()) {
-                       d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
+                       snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
+                       d += buffer;
                        ratio *= sample_aspect_ratio().get ();
                }
 
-               d << "\n" << _("Display aspect ratio") << " " << fixed << setprecision(2) << ratio << ":1\n";
+               snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
+               d += buffer;
        }
 
        if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) {
                dcp::Size cropped = size_after_crop ();
-               d << String::compose (
+               d += String::compose (
                        _("Cropped to %1x%2"),
                        cropped.width, cropped.height
                        );
 
-               d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
+               snprintf (buffer, sizeof(buffer), " (%.2f:1)\n", cropped.ratio());
+               d += buffer;
        }
 
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
+       shared_ptr<const Film> film = _parent->film ();
        dcp::Size const container_size = film->frame_size ();
        dcp::Size const scaled = scale().size (shared_from_this(), container_size, container_size);
 
        if (scaled != size_after_crop ()) {
-               d << String::compose (
+               d += String::compose (
                        _("Scaled to %1x%2"),
                        scaled.width, scaled.height
                        );
 
-               d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
+               snprintf (buffer, sizeof(buffer), _(" (%.2f:1)\n"), scaled.ratio());
+               d += buffer;
        }
 
        if (scaled != container_size) {
-               d << String::compose (
+               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";
+               snprintf (buffer, sizeof(buffer), _(" (%.2f:1)\n"), container_size.ratio());
+               d += buffer;
        }
 
-       d << _("Content frame rate");
-       d << " " << fixed << setprecision(4) << frame_rate() << "\n";
+       if (_parent->video_frame_rate()) {
+               double const vfr = _parent->video_frame_rate().get ();
 
-       FrameRateChange frc (frame_rate(), film->video_frame_rate ());
-       d << frc.description () << "\n";
+               snprintf (buffer, sizeof(buffer), _("Content frame rate %.4f\n"), vfr);
+               d += buffer;
+
+               FrameRateChange frc (vfr, film->video_frame_rate ());
+               d += frc.description () + "\n";
+       }
 
-       return d.str ();
+       return d;
 }
 
 void
 VideoContent::add_properties (list<UserProperty>& p) const
 {
-       p.push_back (UserProperty (_("Video"), _("Length"), raw_convert<string> (length ()), _("video frames")));
-       p.push_back (UserProperty (_("Video"), _("Size"), raw_convert<string> (size().width) + "x" + raw_convert<string> (size().height)));
-       p.push_back (UserProperty (_("Video"), _("Frame rate"), raw_convert<string> (frame_rate(), 5), _("frames per second")));
-}
-
-double
-VideoContent::frame_rate () const
-{
-       boost::mutex::scoped_lock lm (_mutex);
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
-       return _frame_rate.get_value_or (film->video_frame_rate ());
+       p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), raw_convert<string> (length ()), _("video frames")));
+       p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), raw_convert<string> (size().width) + "x" + raw_convert<string> (size().height)));
 }
 
 void
@@ -458,12 +496,6 @@ VideoContent::set_scale (VideoContentScale s)
        maybe_set (_scale, s, VideoContentProperty::SCALE);
 }
 
-void
-VideoContent::set_frame_rate (double r)
-{
-       maybe_set (_frame_rate, r, VideoContentProperty::FRAME_RATE);
-}
-
 void
 VideoContent::set_frame_type (VideoFrameType t)
 {