src/lib/subtitle_encoder.cc

   1 /*
   2     Copyright (C) 2019-2021 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
  22 #include "compose.hpp"
  23 #include "job.h"
  24 #include "player.h"
  25 #include "subtitle_encoder.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
  35 using std::make_pair;
  36 using std::make_shared;
  37 using std::pair;
  38 using std::shared_ptr;
  39 using std::string;
  40 using std::vector;
  41 using boost::optional;
  42 #if BOOST_VERSION >= 106100
  43 using namespace boost::placeholders;
  44 #endif
  45 using dcp::raw_convert;
  46
  47
  48 /** @param output Directory, if there will be multiple output files, or a filename.
  49  *  @param initial_name Hint that may be used to create filenames, if @ref output is a directory.
  50  *  @param include_font true to refer to and export any font file (for Interop; ignored for SMPTE).
  51  */
  52 SubtitleEncoder::SubtitleEncoder (shared_ptr<const Film> film, shared_ptr<Job> job, boost::filesystem::path output, string initial_name, bool split_reels, bool include_font)
  53         : Encoder (film, job)
  54         , _split_reels (split_reels)
  55         , _include_font (include_font)
  56         , _reel_index (0)
  57         , _length (film->length())
  58 {
  59         _player->set_play_referenced ();
  60         _player->set_ignore_video ();
  61         _player->set_ignore_audio ();
  62         _player->Text.connect (boost::bind(&SubtitleEncoder::text, this, _1, _2, _3, _4));
  63
  64         string const extension = film->interop() ? ".xml" : ".mxf";
  65
  66         int const files = split_reels ? film->reels().size() : 1;
  67         for (int i = 0; i < files; ++i) {
  68
  69                 boost::filesystem::path filename = output;
  70                 if (boost::filesystem::is_directory(filename)) {
  71                         if (files > 1) {
  72                                 /// TRANSLATORS: _reel%1 here is to be added to an export filename to indicate
  73                                 /// which reel it is.  Preserve the %1; it will be replaced with the reel number.
  74                                 filename /= String::compose("%1_reel%2", initial_name, i + 1);
  75                         } else {
  76                                 filename /= initial_name;
  77                         }
  78                 }
  79
  80                 _assets.push_back (make_pair(shared_ptr<dcp::SubtitleAsset>(), boost::filesystem::change_extension(filename, extension)));
  81         }
  82
  83         for (auto i: film->reels()) {
  84                 _reels.push_back (i);
  85         }
  86
  87         _default_font = dcp::ArrayData (default_font_file());
  88 }
  89
  90
  91 void
  92 SubtitleEncoder::go ()
  93 {
  94         {
  95                 shared_ptr<Job> job = _job.lock ();
  96                 DCPOMATIC_ASSERT (job);
  97                 job->sub (_("Extracting"));
  98         }
  99
 100         _reel_index = 0;
 101
 102         while (!_player->pass()) {}
 103
 104         int reel = 0;
 105         for (auto& i: _assets) {
 106                 if (!i.first) {
 107                         /* No subtitles arrived for this asset; make an empty one so we write something to the output */
 108                         if (_film->interop()) {
 109                                 auto s = make_shared<dcp::InteropSubtitleAsset>();
 110                                 s->set_movie_title (_film->name());
 111                                 s->set_reel_number (raw_convert<string>(reel + 1));
 112                                 i.first = s;
 113                         } else {
 114                                 auto s = make_shared<dcp::SMPTESubtitleAsset>();
 115                                 s->set_content_title_text (_film->name());
 116                                 s->set_reel_number (reel + 1);
 117                                 i.first = s;
 118                         }
 119                 }
 120
 121                 if (!_film->interop() || _include_font) {
 122                         for (auto j: _player->get_subtitle_fonts()) {
 123                                 i.first->add_font(j->id(), j->data().get_value_or(_default_font));
 124                         }
 125                 }
 126
 127                 i.first->write (i.second);
 128                 ++reel;
 129         }
 130 }
 131
 132
 133 void
 134 SubtitleEncoder::text (PlayerText subs, TextType type, optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period)
 135 {
 136         if (type != TextType::OPEN_SUBTITLE) {
 137                 return;
 138         }
 139
 140         if (!_assets[_reel_index].first) {
 141                 shared_ptr<dcp::SubtitleAsset> asset;
 142                 auto lang = _film->subtitle_languages ();
 143                 if (_film->interop ()) {
 144                         auto s = make_shared<dcp::InteropSubtitleAsset>();
 145                         s->set_movie_title (_film->name());
 146                         if (lang.first) {
 147                                 s->set_language (lang.first->to_string());
 148                         }
 149                         s->set_reel_number (raw_convert<string>(_reel_index + 1));
 150                         _assets[_reel_index].first = s;
 151                 } else {
 152                         auto s = make_shared<dcp::SMPTESubtitleAsset>();
 153                         s->set_content_title_text (_film->name());
 154                         if (lang.first) {
 155                                 s->set_language (*lang.first);
 156                         } else if (track->language) {
 157                                 s->set_language (track->language.get());
 158                         }
 159                         s->set_edit_rate (dcp::Fraction (_film->video_frame_rate(), 1));
 160                         s->set_reel_number (_reel_index + 1);
 161                         s->set_time_code_rate (_film->video_frame_rate());
 162                         s->set_start_time (dcp::Time());
 163                         if (_film->encrypted ()) {
 164                                 s->set_key (_film->key ());
 165                         }
 166                         _assets[_reel_index].first = s;
 167                 }
 168         }
 169
 170         for (auto i: subs.string) {
 171                 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
 172                 i.set_in  (i.in());
 173                 i.set_out (i.out());
 174                 if (_film->interop() && !_include_font) {
 175                         i.unset_font ();
 176                 }
 177                 _assets[_reel_index].first->add (make_shared<dcp::SubtitleString>(i));
 178         }
 179
 180         if (_split_reels && (_reel_index < int(_reels.size()) - 1) && period.from > _reels[_reel_index].from) {
 181                 ++_reel_index;
 182         }
 183
 184         _last = period.from;
 185
 186         auto job = _job.lock ();
 187         if (job) {
 188                 job->set_progress (float(period.from.get()) / _length.get());
 189         }
 190 }
 191
 192
 193 Frame
 194 SubtitleEncoder::frames_done () const
 195 {
 196         if (!_last) {
 197                 return 0;
 198         }
 199
 200         /* XXX: assuming 24fps here but I don't think it matters */
 201         return _last->seconds() * 24;
 202 }