Fix estimate of required disk space to take referencing

of existing DCPs into account.

6 files changed, 107 insertions, 4 deletions

diff --git a/src/lib/content_factory.h b/src/lib/content_factory.h
index fae7648ea..6b47492c4 100644
--- a/src/lib/content_factory.h
+++ b/src/lib/content_factory.h
@@ -21,7 +21,11 @@
  *  @brief Methods to create content objects.
  */
 
+#include <libcxml/cxml.h>
+#include <boost/shared_ptr.hpp>
+
 class Film;
+class Content;
 
 extern boost::shared_ptr<Content> content_factory (boost::shared_ptr<const Film>, cxml::NodePtr, int, std::list<std::string> &);
 extern boost::shared_ptr<Content> content_factory (boost::shared_ptr<const Film>, boost::filesystem::path);
diff --git a/src/lib/film.cc b/src/lib/film.cc
index dbe4d77d2..006cf8dca 100644
--- a/src/lib/film.cc
+++ b/src/lib/film.cc
@@ -1182,12 +1182,12 @@ Film::make_kdms (
 uint64_t
 Film::required_disk_space () const
 {
-	return uint64_t (j2k_bandwidth() / 8) * length().seconds();
+	return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
 }
 
 /** This method checks the disk that the Film is on and tries to decide whether or not
  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
- *  false is returned and required and availabe are filled in with the amount of disk space
+ *  false is returned and required and available are filled in with the amount of disk space
  *  required and available respectively (in Gb).
  *
  *  Note: the decision made by this method isn't, of course, 100% reliable.
diff --git a/src/lib/playlist.cc b/src/lib/playlist.cc
index c5cd4b02d..1eaef3a51 100644
--- a/src/lib/playlist.cc
+++ b/src/lib/playlist.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 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
@@ -25,6 +25,7 @@
 #include "ffmpeg_content.h"
 #include "image_decoder.h"
 #include "content_factory.h"
+#include "dcp_content.h"
 #include "job.h"
 #include "config.h"
 #include "util.h"
@@ -432,3 +433,25 @@ Playlist::move_later (shared_ptr<Content> c)
 	c->set_position (c->position() + (*next)->length_after_trim ());
 	sort (_content.begin(), _content.end(), ContentSorter ());
 }
+
+int64_t
+Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const
+{
+	int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds ();
+	int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds ();
+
+	BOOST_FOREACH (shared_ptr<Content> i, _content) {
+		shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
+		if (d) {
+			if (d->reference_video()) {
+				video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds();
+			}
+			if (d->reference_audio()) {
+				audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
+			}
+		}
+	}
+
+	/* Add on 64k for bits and pieces (metadata, subs etc) */
+	return video + audio + 65536;
+}
diff --git a/src/lib/playlist.h b/src/lib/playlist.h
index 76055bea0..0baf667fc 100644
--- a/src/lib/playlist.h
+++ b/src/lib/playlist.h
@@ -59,6 +59,7 @@ public:
 
 	DCPTime length () const;
 	boost::optional<DCPTime> start () const;
+	int64_t required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const;
 
 	int best_dcp_frame_rate () const;
 	DCPTime video_end () const;
diff --git a/test/required_disk_space_test.cc b/test/required_disk_space_test.cc
new file mode 100644
index 000000000..2c2f2ed17
--- /dev/null
+++ b/test/required_disk_space_test.cc
@@ -0,0 +1,74 @@
+/*
+    Copyright (C) 2016 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
+    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,
+    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.
+
+*/
+
+#include "lib/content_factory.h"
+#include "lib/film.h"
+#include "lib/dcp_content.h"
+#include "test.h"
+#include <boost/test/unit_test.hpp>
+
+using boost::shared_ptr;
+using boost::dynamic_pointer_cast;
+
+void check_within_n (int64_t a, int64_t b, int64_t n)
+{
+	BOOST_CHECK (abs (a - b) <= n);
+}
+
+
+BOOST_AUTO_TEST_CASE (required_disk_space_test)
+{
+	shared_ptr<Film> film = new_test_film ("required_disk_space_test");
+	film->set_j2k_bandwidth (100000000);
+	film->set_audio_channels (6);
+	shared_ptr<Content> content_a = content_factory (film, "test/data/flat_blue.png");
+	film->examine_and_add_content (content_a);
+	shared_ptr<DCPContent> content_b = dynamic_pointer_cast<DCPContent> (content_factory (film, "test/data/burnt_subtitle_test_dcp"));
+	film->examine_and_add_content (content_b);
+	wait_for_jobs ();
+	film->write_metadata ();
+
+	check_within_n (
+		film->required_disk_space(),
+		289LL * (100000000 / 8) / 24 +  // video
+		289LL * 48000 * 6 * 3 / 24 +    // audio
+		65536,                          // extra
+		16
+		);
+
+	content_b->set_reference_video (true);
+
+	check_within_n (
+		film->required_disk_space(),
+		240LL * (100000000 / 8) / 24 +  // video
+		289LL * 48000 * 6 * 3 / 24 +    // audio
+		65536,                          // extra
+		16
+		);
+
+	content_b->set_reference_audio (true);
+
+	check_within_n (
+		film->required_disk_space(),
+		240LL * (100000000 / 8) / 24 +  // video
+		240LL * 48000 * 6 * 3 / 24 +    // audio
+		65536,                          // extra
+		16
+		);
+}
diff --git a/test/wscript b/test/wscript
index 1a3838fe7..362180a0d 100644
--- a/test/wscript
+++ b/test/wscript
@@ -1,5 +1,5 @@
 #
-#    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+#    Copyright (C) 2012-2016 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
@@ -72,6 +72,7 @@ def build(bld):
                  repeat_frame_test.cc
                  recover_test.cc
                  reels_test.cc
+                 required_disk_space_test.cc
                  resampler_test.cc
                  scaling_test.cc
                  seek_zero_test.cc