Basics of selecting 'tracks' for CCAPs.

7 files changed, 169 insertions, 1 deletions

diff --git a/src/lib/dcp_text_track.cc b/src/lib/dcp_text_track.cc
new file mode 100644
index 000000000..2d3d9fe10
--- /dev/null
+++ b/src/lib/dcp_text_track.cc
@@ -0,0 +1,63 @@
+/*
+    Copyright (C) 2018 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 "dcp_text_track.h"
+#include "compose.hpp"
+#include <string>
+
+using std::string;
+
+DCPTextTrack::DCPTextTrack (cxml::ConstNodePtr node)
+{
+	name = node->string_child("Name");
+	language = node->string_child("Language");
+}
+
+DCPTextTrack::DCPTextTrack (string name_, string language_)
+	: name (name_)
+	, language (language_)
+{
+
+}
+
+string
+DCPTextTrack::summary () const
+{
+	return String::compose("%1 (%2)", name, language);
+}
+
+void
+DCPTextTrack::as_xml (xmlpp::Element* parent) const
+{
+	parent->add_child("Name")->add_child_text(name);
+	parent->add_child("Language")->add_child_text(language);
+}
+
+bool
+operator== (DCPTextTrack const & a, DCPTextTrack const & b)
+{
+	return a.name == b.name && a.language == b.language;
+}
+
+bool
+operator!= (DCPTextTrack const & a, DCPTextTrack const & b)
+{
+	return !(a == b);
+}
diff --git a/src/lib/dcp_text_track.h b/src/lib/dcp_text_track.h
new file mode 100644
index 000000000..d69e6dae9
--- /dev/null
+++ b/src/lib/dcp_text_track.h
@@ -0,0 +1,43 @@
+/*
+    Copyright (C) 2018 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/>.
+
+*/
+
+#ifndef DCPOMATIC_DCP_TEXT_TRACK_H
+#define DCPOMATIC_DCP_TEXT_TRACK_H
+
+#include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+
+class DCPTextTrack
+{
+public:
+	DCPTextTrack (cxml::ConstNodePtr node);
+	DCPTextTrack (std::string name_, std::string language_);
+
+	std::string name;
+	std::string language;
+
+	std::string summary () const;
+	void as_xml (xmlpp::Element* parent) const;
+};
+
+bool operator== (DCPTextTrack const & a, DCPTextTrack const & b);
+bool operator!= (DCPTextTrack const & a, DCPTextTrack const & b);
+
+#endif
diff --git a/src/lib/film.cc b/src/lib/film.cc
index 274cb8d2d..086d12e63 100644
--- a/src/lib/film.cc
+++ b/src/lib/film.cc
@@ -1637,3 +1637,18 @@ Film::references_dcp_audio () const
 
 	return false;
 }
+
+list<DCPTextTrack>
+Film::closed_caption_tracks () const
+{
+	list<DCPTextTrack> tt;
+	BOOST_FOREACH (shared_ptr<Content> i, content()) {
+		BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
+			if (j->type() == TEXT_CLOSED_CAPTION && j->dcp_track() && find(tt.begin(), tt.end(), j->dcp_track().get()) == tt.end()) {
+				tt.push_back (j->dcp_track().get());
+			}
+		}
+	}
+
+	return tt;
+}
diff --git a/src/lib/film.h b/src/lib/film.h
index 26700323a..44e84dc27 100644
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -31,6 +31,7 @@
 #include "isdcf_metadata.h"
 #include "frame_rate_change.h"
 #include "signaller.h"
+#include "dcp_text_track.h"
 #include <dcp/key.h>
 #include <dcp/encrypted_kdm.h>
 #include <boost/signals2.hpp>
@@ -113,6 +114,8 @@ public:
 
 	int audio_frame_rate () const;
 
+	std::list<DCPTextTrack> closed_caption_tracks () const;
+
 	uint64_t required_disk_space () const;
 	bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 
diff --git a/src/lib/text_content.cc b/src/lib/text_content.cc
index a077b2c46..9869974c5 100644
--- a/src/lib/text_content.cc
+++ b/src/lib/text_content.cc
@@ -56,6 +56,7 @@ int const TextContentProperty::FADE_IN = 512;
 int const TextContentProperty::FADE_OUT = 513;
 int const TextContentProperty::OUTLINE_WIDTH = 514;
 int const TextContentProperty::TYPE = 515;
+int const TextContentProperty::DCP_TRACK = 516;
 
 TextContent::TextContent (Content* parent, TextType type, TextType original_type)
 	: ContentPart (parent)
@@ -107,6 +108,7 @@ TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
 	BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Text")) {
 		c.push_back (shared_ptr<TextContent> (new TextContent (parent, i, version)));
 	}
+
 	return c;
 }
 
@@ -231,6 +233,11 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 			_original_type = string_to_text_type (node->optional_string_child("OriginalType").get());
 		}
 	}
+
+	cxml::ConstNodePtr dt = node->optional_node_child("DCPTrack");
+	if (dt) {
+		_dcp_track = DCPTextTrack (dt);
+	}
 }
 
 TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
@@ -286,6 +293,10 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
 			throw JoinError (_("Content to be joined must use the same fonts."));
 		}
 
+		if (c[i]->only_text()->dcp_track() != ref->dcp_track()) {
+			throw JoinError (_("Content to be joined must use the same DCP track."));
+		}
+
 		list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
 		list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
 
@@ -312,6 +323,7 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
 	_outline_width = ref->outline_width ();
 	_type = ref->type ();
 	_original_type = ref->original_type ();
+	_dcp_track = ref->dcp_track ();
 
 	connect_to_fonts ();
 }
@@ -369,6 +381,9 @@ TextContent::as_xml (xmlpp::Node* root) const
 
 	text->add_child("Type")->add_child_text (text_type_to_string(_type));
 	text->add_child("OriginalType")->add_child_text (text_type_to_string(_original_type));
+	if (_dcp_track) {
+		_dcp_track->as_xml(text->add_child("DCPTrack"));
+	}
 }
 
 string
@@ -395,7 +410,7 @@ TextContent::identifier () const
 		}
 	}
 
-	/* The language is for metadata only, and doesn't affect
+	/* The DCP track and language are for metadata only, and don't affect
 	   how this content looks.
 	*/
 
@@ -551,6 +566,18 @@ TextContent::set_outline_width (int w)
 }
 
 void
+TextContent::set_dcp_track (DCPTextTrack t)
+{
+	maybe_set (_dcp_track, t, TextContentProperty::DCP_TRACK);
+}
+
+void
+TextContent::unset_dcp_track ()
+{
+	maybe_set (_dcp_track, optional<DCPTextTrack>(), TextContentProperty::DCP_TRACK);
+}
+
+void
 TextContent::take_settings_from (shared_ptr<const TextContent> c)
 {
 	set_use (c->_use);
@@ -581,4 +608,9 @@ TextContent::take_settings_from (shared_ptr<const TextContent> c)
 		set_fade_out (*c->_fade_out);
 	}
 	set_outline_width (c->_outline_width);
+	if (c->_dcp_track) {
+		set_dcp_track (c->_dcp_track.get());
+	} else {
+		unset_dcp_track ();
+	}
 }
diff --git a/src/lib/text_content.h b/src/lib/text_content.h
index e5981acaf..83860dff5 100644
--- a/src/lib/text_content.h
+++ b/src/lib/text_content.h
@@ -22,6 +22,7 @@
 #define DCPOMATIC_CAPTION_CONTENT_H
 
 #include "content_part.h"
+#include "dcp_text_track.h"
 #include <libcxml/cxml.h>
 #include <dcp/types.h>
 #include <boost/signals2.hpp>
@@ -47,6 +48,7 @@ public:
 	static int const FADE_OUT;
 	static int const OUTLINE_WIDTH;
 	static int const TYPE;
+	static int const DCP_TRACK;
 };
 
 /** @class TextContent
@@ -87,6 +89,8 @@ public:
 	void set_outline_width (int);
 	void unset_fade_out ();
 	void set_type (TextType type);
+	void set_dcp_track (DCPTextTrack track);
+	void unset_dcp_track ();
 
 	bool use () const {
 		boost::mutex::scoped_lock lm (_mutex);
@@ -173,6 +177,11 @@ public:
 		return _original_type;
 	}
 
+	boost::optional<DCPTextTrack> dcp_track () const {
+		boost::mutex::scoped_lock lm (_mutex);
+		return _dcp_track;
+	}
+
 	static std::list<boost::shared_ptr<TextContent> > from_xml (Content* parent, cxml::ConstNodePtr, int version);
 
 protected:
@@ -217,6 +226,8 @@ private:
 	TextType _type;
 	/** the original type of these captions in their content */
 	TextType _original_type;
+	/** the track of closed captions that this content should be put in, or empty to put in the default (only) track */
+	boost::optional<DCPTextTrack> _dcp_track;
 };
 
 #endif
diff --git a/src/lib/wscript b/src/lib/wscript
index a85ce1f26..5c1da8a5f 100644
--- a/src/lib/wscript
+++ b/src/lib/wscript
@@ -60,6 +60,7 @@ sources = """
           dcp_subtitle.cc
           dcp_subtitle_content.cc
           dcp_subtitle_decoder.cc
+          dcp_text_track.cc
           dcp_video.cc
           dcpomatic_socket.cc
           dcpomatic_time.cc