src/lib/subtitle_encoder.cc

   1 /*
   2     Copyright (C) 2019-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "font_data.h"
  22 #include "subtitle_encoder.h"
  23 #include "player.h"
  24 #include "compose.hpp"
  25 #include "job.h"
  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>
  31
  32 #include "i18n.h"
  33
  34 using std::make_pair;
  35 using std::make_shared;
  36 using std::pair;
  37 using std::shared_ptr;
  38 using std::string;
  39 using std::vector;
  40 using boost::optional;
  41 #if BOOST_VERSION >= 106100
  42 using namespace boost::placeholders;
  43 #endif
  44 using dcp::raw_convert;
  45
  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).
  49  */
  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)
  51         : Encoder (film, job)
  52         , _split_reels (split_reels)
  53         , _include_font (include_font)
  54         , _reel_index (0)
  55         , _length (film->length())
  56 {
  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));
  61
  62         string const extension = film->interop() ? ".xml" : ".mxf";
  63
  64         int const files = split_reels ? film->reels().size() : 1;
  65         for (int i = 0; i < files; ++i) {
  66
  67                 boost::filesystem::path filename = output;
  68                 if (boost::filesystem::is_directory(filename)) {
  69                         if (files > 1) {
  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);
  73                         } else {
  74                                 filename /= initial_name;
  75                         }
  76                 }
  77
  78                 _assets.push_back (make_pair(shared_ptr<dcp::SubtitleAsset>(), boost::filesystem::change_extension(filename, extension)));
  79         }
  80
  81         for (auto i: film->reels()) {
  82                 _reels.push_back (i);
  83         }
  84
  85         _default_font = dcp::ArrayData (default_font_file());
  86 }
  87
  88 void
  89 SubtitleEncoder::go ()
  90 {
  91         {
  92                 shared_ptr<Job> job = _job.lock ();
  93                 DCPOMATIC_ASSERT (job);
  94                 job->sub (_("Extracting"));
  95         }
  96
  97         _reel_index = 0;
  98
  99         while (!_player->pass()) {}
 100
 101         int reel = 0;
 102         for (vector<pair<shared_ptr<dcp::SubtitleAsset>, boost::filesystem::path> >::iterator i = _assets.begin(); i != _assets.end(); ++i) {
 103                 if (!i->first) {
 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));
 109                                 i->first = s;
 110                         } else {
 111                                 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
 112                                 s->set_content_title_text (_film->name());
 113                                 s->set_reel_number (reel + 1);
 114                                 i->first = s;
 115                         }
 116                 }
 117
 118                 if (!_film->interop() || _include_font) {
 119                         for (auto j: _player->get_subtitle_fonts()) {
 120                                 i->first->add_font (j.id, _default_font);
 121                         }
 122                 }
 123
 124                 i->first->write (i->second);
 125                 ++reel;
 126         }
 127 }
 128
 129 void
 130 SubtitleEncoder::text (PlayerText subs, TextType type, optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period)
 131 {
 132         if (type != TextType::OPEN_SUBTITLE) {
 133                 return;
 134         }
 135
 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());
 142                         if (lang.first) {
 143                                 s->set_language (lang.first->to_string());
 144                         }
 145                         s->set_reel_number (raw_convert<string>(_reel_index + 1));
 146                         _assets[_reel_index].first = s;
 147                 } else {
 148                         auto s = make_shared<dcp::SMPTESubtitleAsset>();
 149                         s->set_content_title_text (_film->name());
 150                         if (lang.first) {
 151                                 s->set_language (*lang.first);
 152                         } else if (track->language) {
 153                                 s->set_language (track->language.get());
 154                         }
 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 ());
 161                         }
 162                         _assets[_reel_index].first = s;
 163                 }
 164         }
 165
 166         for (auto i: subs.string) {
 167                 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
 168                 i.set_in  (i.in());
 169                 i.set_out (i.out());
 170                 if (_film->interop() && !_include_font) {
 171                         i.unset_font ();
 172                 }
 173                 _assets[_reel_index].first->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
 174         }
 175
 176         if (_split_reels && (_reel_index < int(_reels.size()) - 1) && period.from > _reels[_reel_index].from) {
 177                 ++_reel_index;
 178         }
 179
 180         _last = period.from;
 181
 182         shared_ptr<Job> job = _job.lock ();
 183         if (job) {
 184                 job->set_progress (float(period.from.get()) / _length.get());
 185         }
 186 }
 187
 188 Frame
 189 SubtitleEncoder::frames_done () const
 190 {
 191         if (!_last) {
 192                 return 0;
 193         }
 194
 195         /* XXX: assuming 24fps here but I don't think it matters */
 196         return _last->seconds() * 24;
 197 }