src/lib/subtitle_encoder.cc

   1 /*
   2     Copyright (C) 2019 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 "subtitle_encoder.h"
  22 #include "player.h"
  23 #include "compose.hpp"
  24 #include "job.h"
  25 #include <dcp/interop_subtitle_asset.h>
  26 #include <dcp/raw_convert.h>
  27 #include <dcp/smpte_subtitle_asset.h>
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/filesystem.hpp>
  30 #include <boost/bind.hpp>
  31
  32 #include "i18n.h"
  33
  34 using std::string;
  35 using std::make_pair;
  36 using std::pair;
  37 using std::vector;
  38 using boost::shared_ptr;
  39 using boost::optional;
  40 using dcp::raw_convert;
  41
  42 SubtitleEncoder::SubtitleEncoder (shared_ptr<const Film> film, shared_ptr<Job> job, boost::filesystem::path output, bool split_reels)
  43         : Encoder (film, job)
  44         , _split_reels (split_reels)
  45         , _reel_index (0)
  46         , _length (film->length())
  47 {
  48         _player->set_play_referenced ();
  49         _player->set_ignore_video ();
  50         _player->set_ignore_audio ();
  51         _player->Text.connect (boost::bind(&SubtitleEncoder::text, this, _1, _2, _3, _4));
  52
  53         int const files = split_reels ? film->reels().size() : 1;
  54         for (int i = 0; i < files; ++i) {
  55
  56                 boost::filesystem::path filename = output;
  57                 string extension = boost::filesystem::extension (filename);
  58                 filename = boost::filesystem::change_extension (filename, "");
  59
  60                 if (files > 1) {
  61                         /// TRANSLATORS: _reel%1 here is to be added to an export filename to indicate
  62                         /// which reel it is.  Preserve the %1; it will be replaced with the reel number.
  63                         filename = filename.string() + String::compose(_("_reel%1"), i + 1);
  64                 }
  65
  66                 _assets.push_back (make_pair(shared_ptr<dcp::SubtitleAsset>(), boost::filesystem::change_extension(filename, ".xml")));
  67         }
  68
  69         BOOST_FOREACH (dcpomatic::DCPTimePeriod i, film->reels()) {
  70                 _reels.push_back (i);
  71         }
  72 }
  73
  74 void
  75 SubtitleEncoder::go ()
  76 {
  77         {
  78                 shared_ptr<Job> job = _job.lock ();
  79                 DCPOMATIC_ASSERT (job);
  80                 job->sub (_("Extracting"));
  81         }
  82
  83         _reel_index = 0;
  84
  85         while (!_player->pass()) {}
  86
  87         int reel = 0;
  88         for (vector<pair<shared_ptr<dcp::SubtitleAsset>, boost::filesystem::path> >::iterator i = _assets.begin(); i != _assets.end(); ++i) {
  89                 if (!i->first) {
  90                         /* No subtitles arrived for this asset; make an empty one so we write something to the output */
  91                         if (_film->interop()) {
  92                                 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset());
  93                                 s->set_movie_title (_film->name());
  94                                 s->set_reel_number (raw_convert<string>(reel + 1));
  95                                 i->first = s;
  96                         } else {
  97                                 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
  98                                 s->set_content_title_text (_film->name());
  99                                 s->set_reel_number (reel + 1);
 100                                 i->first = s;
 101                         }
 102                 }
 103
 104                 i->first->write (i->second);
 105                 ++reel;
 106         }
 107 }
 108
 109 void
 110 SubtitleEncoder::text (PlayerText subs, TextType type, optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period)
 111 {
 112         if (type != TEXT_OPEN_SUBTITLE) {
 113                 return;
 114         }
 115
 116         if (!_assets[_reel_index].first) {
 117                 shared_ptr<dcp::SubtitleAsset> asset;
 118                 string lang = _film->subtitle_language ();
 119                 if (_film->interop ()) {
 120                         shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset());
 121                         s->set_movie_title (_film->name());
 122                         s->set_language (lang.empty() ? "Unknown" : lang);
 123                         s->set_reel_number (raw_convert<string>(_reel_index + 1));
 124                         _assets[_reel_index].first = s;
 125                 } else {
 126                         shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset());
 127                         s->set_content_title_text (_film->name());
 128                         if (!lang.empty()) {
 129                                 s->set_language (lang);
 130                         } else {
 131                                 s->set_language (track->language);
 132                         }
 133                         s->set_edit_rate (dcp::Fraction (_film->video_frame_rate(), 1));
 134                         s->set_reel_number (_reel_index + 1);
 135                         s->set_time_code_rate (_film->video_frame_rate());
 136                         s->set_start_time (dcp::Time());
 137                         if (_film->encrypted ()) {
 138                                 s->set_key (_film->key ());
 139                         }
 140                         _assets[_reel_index].first = s;
 141                 }
 142         }
 143
 144         BOOST_FOREACH (StringText i, subs.string) {
 145                 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
 146                 i.set_in  (i.in());
 147                 i.set_out (i.out());
 148                 _assets[_reel_index].first->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
 149         }
 150
 151         if (_split_reels && (_reel_index < int(_reels.size()) - 1) && period.from > _reels[_reel_index].from) {
 152                 ++_reel_index;
 153         }
 154
 155         _last = period.from;
 156
 157         shared_ptr<Job> job = _job.lock ();
 158         if (job) {
 159                 job->set_progress (float(period.from.get()) / _length.get());
 160         }
 161 }
 162
 163 Frame
 164 SubtitleEncoder::frames_done () const
 165 {
 166         if (!_last) {
 167                 return 0;
 168         }
 169
 170         /* XXX: assuming 24fps here but I don't think it matters */
 171         return _last->seconds() * 24;
 172 }