Coalesce short reels.
[dcpomatic.git] / src / lib / film.cc
index 39dfaf5c0b073b66e4df131a3e4981f30f9d6395..ed2c5a3725946e23dee1c03f5628de8e1cec6cf1 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -167,8 +167,9 @@ Film::Film (optional<boost::filesystem::path> dir)
        set_isdcf_date_today ();
 
        _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
-       _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
+       _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
        _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
+       _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
 
        if (dir) {
                /* Make state.directory a complete path without ..s (where possible)
@@ -180,7 +181,8 @@ Film::Film (optional<boost::filesystem::path> dir)
                boost::filesystem::path result;
                for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
                        if (*i == "..") {
-                               if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
+                               boost::system::error_code ec;
+                               if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
                                        result /= *i;
                                } else {
                                        result = result.parent_path ();
@@ -319,6 +321,10 @@ Film::make_dcp (bool gui, bool check)
                throw runtime_error (_("You must add some content to the DCP before creating it"));
        }
 
+       if (length() == DCPTime()) {
+               throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length."));
+       }
+
        if (dcp_content_type() == 0) {
                throw MissingSettingError (_("content type"));
        }
@@ -422,6 +428,7 @@ Film::metadata (bool with_content_paths) const
        BOOST_FOREACH (dcp::Rating i, _ratings) {
                i.as_xml (root->add_child("Rating"));
        }
+       root->add_child("ContentVersion")->add_child_text(_content_version);
        _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
 
        return doc;
@@ -468,6 +475,10 @@ Film::read_metadata (optional<boost::filesystem::path> path)
                path = file (metadata_file);
        }
 
+       if (!boost::filesystem::exists(*path)) {
+               throw FileNotFoundError(*path);
+       }
+
        cxml::Document f ("Metadata");
        f.read_file (path.get ());
 
@@ -565,6 +576,8 @@ Film::read_metadata (optional<boost::filesystem::path> path)
                _ratings.push_back (dcp::Rating(i));
        }
 
+       _content_version = f.optional_string_child("ContentVersion").get_value_or("");
+
        list<string> notes;
        _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 
@@ -1241,11 +1254,13 @@ Film::move_content_later (shared_ptr<Content> c)
        _playlist->move_later (shared_from_this(), c);
 }
 
-/** @return length of the film from time 0 to the last thing on the playlist */
+/** @return length of the film from time 0 to the last thing on the playlist,
+ *  with a minimum length of 1 second.
+ */
 DCPTime
 Film::length () const
 {
-       return _playlist->length(shared_from_this()).ceil(video_frame_rate());
+       return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
 }
 
 int
@@ -1284,6 +1299,12 @@ Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool
        }
 }
 
+void
+Film::playlist_length_change ()
+{
+       LengthChange ();
+}
+
 void
 Film::playlist_change (ChangeType type)
 {
@@ -1622,21 +1643,27 @@ Film::reels () const
                split_points.sort ();
                split_points.unique ();
 
-               /* Make them into periods */
+               /* Make them into periods, coalescing any that are less than 1 second long */
                optional<DCPTime> last;
                BOOST_FOREACH (DCPTime t, split_points) {
-                       if (last) {
+                       if (last && (t - *last) >= DCPTime::from_seconds(1)) {
+                               /* Period from *last to t is long enough; use it and start a new one */
                                p.push_back (DCPTimePeriod(*last, t));
+                               last = t;
+                       } else if (!last) {
+                               /* That was the first time, so start a new period */
+                               last = t;
                        }
-                       last = t;
                }
                break;
        }
        case REELTYPE_BY_LENGTH:
        {
                DCPTime current;
-               /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
-               Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
+               /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
+                * making sure we don't go less than 1s long.
+                */
+               Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
                while (current < len) {
                        DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
                        p.push_back (DCPTimePeriod (current, end));
@@ -1758,6 +1785,13 @@ Film::set_ratings (vector<dcp::Rating> r)
        _ratings = r;
 }
 
+void
+Film::set_content_version (string v)
+{
+       ChangeSignaller<Film> ch (this, CONTENT_VERSION);
+       _content_version = v;
+}
+
 optional<DCPTime>
 Film::marker (dcp::Marker type) const
 {