Primitive subtitle export feature.v2.15.16

1 files changed, 157 insertions, 0 deletions

diff --git a/src/lib/subtitle_encoder.cc b/src/lib/subtitle_encoder.cc
new file mode 100644
index 000000000..43c68bc22
--- /dev/null
+++ b/src/lib/subtitle_encoder.cc
@@ -0,0 +1,157 @@
+/*
+    Copyright (C) 2019 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 "subtitle_encoder.h"
+#include "player.h"
+#include "compose.hpp"
+#include "job.h"
+#include <dcp/interop_subtitle_asset.h>
+#include <dcp/raw_convert.h>
+#include <dcp/smpte_subtitle_asset.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/filesystem.hpp>
+#include <boost/bind.hpp>
+
+#include "i18n.h"
+
+using std::string;
+using std::make_pair;
+using std::pair;
+using std::vector;
+using boost::shared_ptr;
+using boost::optional;
+using dcp::raw_convert;
+
+SubtitleEncoder::SubtitleEncoder (shared_ptr<const Film> film, shared_ptr<Job> job, boost::filesystem::path output, bool split_reels)
+	: Encoder (film, job)
+	, _split_reels (split_reels)
+	, _reel_index (0)
+	, _length (film->length())
+{
+	_player->set_play_referenced ();
+	_player->set_ignore_video ();
+	_player->set_ignore_audio ();
+	_player->Text.connect (boost::bind(&SubtitleEncoder::text, this, _1, _2, _3, _4));
+
+	int const files = split_reels ? film->reels().size() : 1;
+	for (int i = 0; i < files; ++i) {
+
+		boost::filesystem::path filename = output;
+		string extension = boost::filesystem::extension (filename);
+		filename = boost::filesystem::change_extension (filename, "");
+
+		if (files > 1) {
+			/// TRANSLATORS: _reel%1 here is to be added to an export filename to indicate
+			/// which reel it is.  Preserve the %1; it will be replaced with the reel number.
+			filename = filename.string() + String::compose(_("_reel%1"), i + 1);
+		}
+
+		_assets.push_back (make_pair(shared_ptr<dcp::SubtitleAsset>(), filename));
+	}
+
+	BOOST_FOREACH (dcpomatic::DCPTimePeriod i, film->reels()) {
+		_reels.push_back (i);
+	}
+}
+
+void
+SubtitleEncoder::go ()
+{
+	{
+		shared_ptr<Job> job = _job.lock ();
+		DCPOMATIC_ASSERT (job);
+		job->sub (_("Extracting"));
+	}
+
+	_reel_index = 0;
+
+	while (!_player->pass()) {}
+
+	for (vector<pair<shared_ptr<dcp::SubtitleAsset>, boost::filesystem::path> >::iterator i = _assets.begin(); i != _assets.end(); ++i) {
+		if (i->first) {
+			i->first->write (i->second);
+		}
+	}
+}
+
+void
+SubtitleEncoder::text (PlayerText subs, TextType type, optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period)
+{
+	if (type != TEXT_OPEN_SUBTITLE) {
+		return;
+	}
+
+	if (!_assets[_reel_index].first) {
+		shared_ptr<dcp::SubtitleAsset> asset;
+		string lang = _film->subtitle_language ();
+		if (_film->interop ()) {
+			shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset());
+			s->set_movie_title (_film->name());
+			s->set_language (lang.empty() ? "Unknown" : lang);
+			s->set_reel_number (raw_convert<string>(_reel_index + 1));
+			_assets[_reel_index].first = s;
+		} else {
+			shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
+			s->set_content_title_text (_film->name());
+			if (!lang.empty()) {
+				s->set_language (lang);
+			} else {
+				s->set_language (track->language);
+			}
+			s->set_edit_rate (dcp::Fraction (_film->video_frame_rate(), 1));
+			s->set_reel_number (_reel_index + 1);
+			s->set_time_code_rate (_film->video_frame_rate());
+			s->set_start_time (dcp::Time());
+			if (_film->encrypted ()) {
+				s->set_key (_film->key ());
+			}
+			_assets[_reel_index].first = s;
+		}
+	}
+
+	BOOST_FOREACH (StringText i, subs.string) {
+		/* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
+		i.set_in  (i.in());
+		i.set_out (i.out());
+		_assets[_reel_index].first->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
+	}
+
+	if (_split_reels && (_reel_index < int(_reels.size()) - 1) && period.from > _reels[_reel_index].from) {
+		++_reel_index;
+	}
+
+	_last = period.from;
+
+	shared_ptr<Job> job = _job.lock ();
+	if (job) {
+		job->set_progress (float(period.from.get()) / _length.get());
+	}
+}
+
+Frame
+SubtitleEncoder::frames_done () const
+{
+	if (!_last) {
+		return 0;
+	}
+
+	/* XXX: assuming 24fps here but I don't think it matters */
+	return _last->seconds() * 24;
+}