Add preference for default KDM duration (#2224).

5 files changed, 154 insertions, 0 deletions

diff --git a/src/lib/config.cc b/src/lib/config.cc
index 3334e6fbf..b46093726 100644
--- a/src/lib/config.cc
+++ b/src/lib/config.cc
@@ -78,6 +78,7 @@ boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
 Config::Config ()
         /* DKDMs are not considered a thing to reset on set_defaults() */
 	: _dkdms (new DKDMGroup ("root"))
+	, _default_kdm_duration (1, RoughDuration::Unit::WEEKS)
 {
 	set_defaults ();
 }
@@ -188,6 +189,7 @@ Config::set_defaults ()
 	_write_kdms_to_disk = true;
 	_email_kdms = false;
 	_default_kdm_type = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
+	_default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
 	_auto_crop_threshold = 0.1;
 
 	_allowed_dcp_frame_rates.clear ();
@@ -580,6 +582,11 @@ try
 	_write_kdms_to_disk = f.optional_bool_child("WriteKDMsToDisk").get_value_or(true);
 	_email_kdms = f.optional_bool_child("EmailKDMs").get_value_or(false);
 	_default_kdm_type = dcp::string_to_formulation(f.optional_string_child("DefaultKDMType").get_value_or("modified-transitional-1"));
+	if (auto duration = f.optional_node_child("DefaultKDMDuration")) {
+		_default_kdm_duration = RoughDuration(duration);
+	} else {
+		_default_kdm_duration = RoughDuration(1, RoughDuration::Unit::WEEKS);
+	}
 	_auto_crop_threshold = f.optional_number_child<double>("AutoCropThreshold").get_value_or(0.1);
 
 	if (boost::filesystem::exists (_cinemas_file)) {
@@ -725,6 +732,7 @@ Config::write_config () const
 		/* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
 		root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 	}
+	_default_kdm_duration.as_xml(root->add_child("DefaultKDMDuration"));
 	/* [XML] MailServer Hostname of SMTP server to use. */
 	root->add_child("MailServer")->add_child_text (_mail_server);
 	/* [XML] MailPort Port number to use on SMTP server. */
diff --git a/src/lib/config.h b/src/lib/config.h
index 40497e219..e425a976c 100644
--- a/src/lib/config.h
+++ b/src/lib/config.h
@@ -28,6 +28,7 @@
 
 
 #include "audio_mapping.h"
+#include "rough_duration.h"
 #include "state.h"
 #include "types.h"
 #include <dcp/name_format.h>
@@ -572,6 +573,10 @@ public:
 		return _default_kdm_type;
 	}
 
+	RoughDuration default_kdm_duration () const {
+		return _default_kdm_duration;
+	}
+
 	double auto_crop_threshold () const {
 		return _auto_crop_threshold;
 	}
@@ -1100,6 +1105,10 @@ public:
 		maybe_set (_default_kdm_type, type);
 	}
 
+	void set_default_kdm_duration (RoughDuration duration) {
+		maybe_set (_default_kdm_duration, duration);
+	}
+
 	void set_auto_crop_threshold (double threshold) {
 		maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
 	}
@@ -1324,6 +1333,7 @@ private:
 	bool _write_kdms_to_disk;
 	bool _email_kdms;
 	dcp::Formulation _default_kdm_type;
+	RoughDuration _default_kdm_duration;
 	double _auto_crop_threshold;
 
 	static int const _current_version;
diff --git a/src/lib/rough_duration.cc b/src/lib/rough_duration.cc
new file mode 100644
index 000000000..e6c03126c
--- /dev/null
+++ b/src/lib/rough_duration.cc
@@ -0,0 +1,79 @@
+/*
+    Copyright (C) 2022 Carl Hetherington <cth@carlh.net>
+
+    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.
+
+    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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#include "dcpomatic_assert.h"
+#include "rough_duration.h"
+#include <dcp/raw_convert.h>
+#include <dcp/warnings.h>
+LIBDCP_DISABLE_WARNINGS
+#include <libxml++/libxml++.h>
+LIBDCP_ENABLE_WARNINGS
+
+
+using std::string;
+
+
+RoughDuration::RoughDuration (cxml::ConstNodePtr node)
+	: duration(dcp::raw_convert<int>(node->content()))
+{
+	auto const unit_name = node->string_attribute("unit");
+	if (unit_name == "days") {
+		unit = Unit::DAYS;
+	} else if (unit_name == "weeks") {
+		unit = Unit::WEEKS;
+	} else if (unit_name == "months") {
+		unit = Unit::MONTHS;
+	} else if (unit_name == "years") {
+		unit = Unit::YEARS;
+	} else {
+		DCPOMATIC_ASSERT (false);
+	}
+}
+
+
+void
+RoughDuration::as_xml (xmlpp::Element* node) const
+{
+	node->add_child_text(dcp::raw_convert<string>(duration));
+
+	switch (unit) {
+	case Unit::DAYS:
+		node->set_attribute("unit", "days");
+		break;
+	case Unit::WEEKS:
+		node->set_attribute("unit", "weeks");
+		break;
+	case Unit::MONTHS:
+		node->set_attribute("unit", "months");
+		break;
+	case Unit::YEARS:
+		node->set_attribute("unit", "years");
+		break;
+	}
+}
+
+
+bool
+operator== (RoughDuration const& a, RoughDuration const& b)
+{
+	return a.duration == b.duration && a.unit == b.unit;
+}
+
diff --git a/src/lib/rough_duration.h b/src/lib/rough_duration.h
new file mode 100644
index 000000000..d9f452e53
--- /dev/null
+++ b/src/lib/rough_duration.h
@@ -0,0 +1,56 @@
+/*
+    Copyright (C) 2022 Carl Hetherington <cth@carlh.net>
+
+    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.
+
+    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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#include <libcxml/cxml.h>
+
+
+namespace xmlpp {
+	class Element;
+}
+
+
+class RoughDuration
+{
+public:
+	enum class Unit {
+		DAYS,
+		WEEKS,
+		MONTHS,
+		YEARS
+	};
+
+	RoughDuration (int duration_, Unit unit_)
+		: duration(duration_)
+		, unit(unit_)
+	{}
+
+	RoughDuration (cxml::ConstNodePtr node);
+
+	void as_xml (xmlpp::Element* node) const;
+
+	int duration;
+	Unit unit;
+};
+
+
+bool
+operator== (RoughDuration const& a, RoughDuration const& b);
+
diff --git a/src/lib/wscript b/src/lib/wscript
index 22fb144bc..b280aec4e 100644
--- a/src/lib/wscript
+++ b/src/lib/wscript
@@ -177,6 +177,7 @@ sources = """
           transcode_job.cc
           trusted_device.cc
           types.cc
+          rough_duration.cc
           signal_manager.cc
           stdout_log.cc
           update_checker.cc