2 Copyright (C) 2019-2020 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/>.
21 #include "font_data.h"
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/filesystem.hpp>
30 #include <boost/bind/bind.hpp>
35 using std::make_shared;
37 using std::shared_ptr;
40 using boost::optional;
41 #if BOOST_VERSION >= 106100
42 using namespace boost::placeholders;
44 using dcp::raw_convert;
46 /** @param output Directory, if there will be multiple output files, or a filename.
47 * @param initial_name Hint that may be used to create filenames, if @ref output is a directory.
48 * @param include_font true to refer to and export any font file (for Interop; ignored for SMPTE).
50 SubtitleEncoder::SubtitleEncoder (shared_ptr<const Film> film, shared_ptr<Job> job, boost::filesystem::path output, string initial_name, bool split_reels, bool include_font)
52 , _split_reels (split_reels)
53 , _include_font (include_font)
55 , _length (film->length())
57 _player->set_play_referenced ();
58 _player->set_ignore_video ();
59 _player->set_ignore_audio ();
60 _player->Text.connect (boost::bind(&SubtitleEncoder::text, this, _1, _2, _3, _4));
62 string const extension = film->interop() ? ".xml" : ".mxf";
64 int const files = split_reels ? film->reels().size() : 1;
65 for (int i = 0; i < files; ++i) {
67 boost::filesystem::path filename = output;
68 if (boost::filesystem::is_directory(filename)) {
70 /// TRANSLATORS: _reel%1 here is to be added to an export filename to indicate
71 /// which reel it is. Preserve the %1; it will be replaced with the reel number.
72 filename /= String::compose("%1_reel%2", initial_name, i + 1);
74 filename /= initial_name;
78 _assets.push_back (make_pair(shared_ptr<dcp::SubtitleAsset>(), boost::filesystem::change_extension(filename, extension)));
81 for (auto i: film->reels()) {
85 _default_font = dcp::ArrayData (default_font_file());
89 SubtitleEncoder::go ()
92 shared_ptr<Job> job = _job.lock ();
93 DCPOMATIC_ASSERT (job);
94 job->sub (_("Extracting"));
99 while (!_player->pass()) {}
102 for (vector<pair<shared_ptr<dcp::SubtitleAsset>, boost::filesystem::path> >::iterator i = _assets.begin(); i != _assets.end(); ++i) {
104 /* No subtitles arrived for this asset; make an empty one so we write something to the output */
105 if (_film->interop()) {
106 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset());
107 s->set_movie_title (_film->name());
108 s->set_reel_number (raw_convert<string>(reel + 1));
111 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
112 s->set_content_title_text (_film->name());
113 s->set_reel_number (reel + 1);
118 if (!_film->interop() || _include_font) {
119 for (auto j: _player->get_subtitle_fonts()) {
120 i->first->add_font (j.id, _default_font);
124 i->first->write (i->second);
130 SubtitleEncoder::text (PlayerText subs, TextType type, optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period)
132 if (type != TextType::OPEN_SUBTITLE) {
136 if (!_assets[_reel_index].first) {
137 shared_ptr<dcp::SubtitleAsset> asset;
138 auto lang = _film->subtitle_languages ();
139 if (_film->interop ()) {
140 auto s = make_shared<dcp::InteropSubtitleAsset>();
141 s->set_movie_title (_film->name());
143 s->set_language (lang.first->to_string());
145 s->set_reel_number (raw_convert<string>(_reel_index + 1));
146 _assets[_reel_index].first = s;
148 auto s = make_shared<dcp::SMPTESubtitleAsset>();
149 s->set_content_title_text (_film->name());
151 s->set_language (*lang.first);
152 } else if (track->language) {
153 s->set_language (track->language.get());
155 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate(), 1));
156 s->set_reel_number (_reel_index + 1);
157 s->set_time_code_rate (_film->video_frame_rate());
158 s->set_start_time (dcp::Time());
159 if (_film->encrypted ()) {
160 s->set_key (_film->key ());
162 _assets[_reel_index].first = s;
166 for (auto i: subs.string) {
167 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
170 if (_film->interop() && !_include_font) {
173 _assets[_reel_index].first->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
176 if (_split_reels && (_reel_index < int(_reels.size()) - 1) && period.from > _reels[_reel_index].from) {
182 shared_ptr<Job> job = _job.lock ();
184 job->set_progress (float(period.from.get()) / _length.get());
189 SubtitleEncoder::frames_done () const
195 /* XXX: assuming 24fps here but I don't think it matters */
196 return _last->seconds() * 24;