2 Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "subtitle_encoder.h"
24 #include "compose.hpp"
26 #include <dcp/interop_subtitle_asset.h>
27 #include <dcp/raw_convert.h>
28 #include <dcp/smpte_subtitle_asset.h>
29 #include <boost/shared_ptr.hpp>
30 #include <boost/filesystem.hpp>
31 #include <boost/bind.hpp>
39 using boost::shared_ptr;
40 using boost::optional;
41 using dcp::raw_convert;
43 /** @param output Directory, if there will be multiple output files, or a filename.
44 * @param initial_name Hint that may be used to create filenames, if @ref output is a directory.
45 * @param include_font true to refer to and export any font file (for Interop; ignored for SMPTE).
47 SubtitleEncoder::SubtitleEncoder (shared_ptr<const Film> film, shared_ptr<Job> job, boost::filesystem::path output, string initial_name, bool split_reels, bool include_font)
49 , _split_reels (split_reels)
50 , _include_font (include_font)
52 , _length (film->length())
54 _player->set_play_referenced ();
55 _player->set_ignore_video ();
56 _player->set_ignore_audio ();
57 _player->Text.connect (boost::bind(&SubtitleEncoder::text, this, _1, _2, _3, _4));
59 string const extension = film->interop() ? ".xml" : ".mxf";
61 int const files = split_reels ? film->reels().size() : 1;
62 for (int i = 0; i < files; ++i) {
64 boost::filesystem::path filename = output;
65 if (boost::filesystem::is_directory(filename)) {
67 /// TRANSLATORS: _reel%1 here is to be added to an export filename to indicate
68 /// which reel it is. Preserve the %1; it will be replaced with the reel number.
69 filename /= String::compose("%1_reel%2", initial_name, i + 1);
71 filename /= initial_name;
75 _assets.push_back (make_pair(shared_ptr<dcp::SubtitleAsset>(), boost::filesystem::change_extension(filename, extension)));
78 BOOST_FOREACH (dcpomatic::DCPTimePeriod i, film->reels()) {
84 SubtitleEncoder::go ()
87 shared_ptr<Job> job = _job.lock ();
88 DCPOMATIC_ASSERT (job);
89 job->sub (_("Extracting"));
94 while (!_player->pass()) {}
97 for (vector<pair<shared_ptr<dcp::SubtitleAsset>, boost::filesystem::path> >::iterator i = _assets.begin(); i != _assets.end(); ++i) {
99 /* No subtitles arrived for this asset; make an empty one so we write something to the output */
100 if (_film->interop()) {
101 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset());
102 s->set_movie_title (_film->name());
103 s->set_reel_number (raw_convert<string>(reel + 1));
106 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
107 s->set_content_title_text (_film->name());
108 s->set_reel_number (reel + 1);
113 if (!_film->interop() || _include_font) {
114 BOOST_FOREACH (shared_ptr<dcpomatic::Font> j, _player->get_subtitle_fonts()) {
115 i->first->add_font (j->id(), default_font_file());
119 i->first->write (i->second);
125 SubtitleEncoder::text (PlayerText subs, TextType type, optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period)
127 if (type != TEXT_OPEN_SUBTITLE) {
131 if (!_assets[_reel_index].first) {
132 shared_ptr<dcp::SubtitleAsset> asset;
133 vector<dcp::LanguageTag> lang = _film->subtitle_languages ();
134 if (_film->interop ()) {
135 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset());
136 s->set_movie_title (_film->name());
137 s->set_language (lang.empty() ? "Unknown" : lang.front().to_string());
138 s->set_reel_number (raw_convert<string>(_reel_index + 1));
139 _assets[_reel_index].first = s;
141 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
142 s->set_content_title_text (_film->name());
144 s->set_language (lang.front().to_string());
146 s->set_language (track->language);
148 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate(), 1));
149 s->set_reel_number (_reel_index + 1);
150 s->set_time_code_rate (_film->video_frame_rate());
151 s->set_start_time (dcp::Time());
152 if (_film->encrypted ()) {
153 s->set_key (_film->key ());
155 _assets[_reel_index].first = s;
159 BOOST_FOREACH (StringText i, subs.string) {
160 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
163 if (_film->interop() && !_include_font) {
166 _assets[_reel_index].first->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
169 if (_split_reels && (_reel_index < int(_reels.size()) - 1) && period.from > _reels[_reel_index].from) {
175 shared_ptr<Job> job = _job.lock ();
177 job->set_progress (float(period.from.get()) / _length.get());
182 SubtitleEncoder::frames_done () const
188 /* XXX: assuming 24fps here but I don't think it matters */
189 return _last->seconds() * 24;