src/lib/dcp_subtitle_decoder.cc

   1 /*
   2     Copyright (C) 2014-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 "dcp_subtitle_content.h"
  23 #include "dcp_subtitle_decoder.h"
  24 #include "font.h"
  25 #include "text_content.h"
  26 #include "util.h"
  27 #include <dcp/interop_subtitle_asset.h>
  28 #include <dcp/load_font_node.h>
  29
  30
  31 using std::dynamic_pointer_cast;
  32 using std::list;
  33 using std::make_shared;
  34 using std::shared_ptr;
  35 using std::string;
  36 using std::vector;
  37 using boost::optional;
  38 using namespace dcpomatic;
  39
  40
  41 DCPSubtitleDecoder::DCPSubtitleDecoder (shared_ptr<const Film> film, shared_ptr<const DCPSubtitleContent> content)
  42         : Decoder (film)
  43 {
  44         /* Load the XML or MXF file */
  45         auto const asset = load (content->path(0));
  46         asset->fix_empty_font_ids ();
  47         _subtitles = asset->subtitles ();
  48         _next = _subtitles.begin ();
  49
  50         if (dynamic_pointer_cast<dcp::InteropSubtitleAsset>(asset)) {
  51                 _standard = dcp::Standard::INTEROP;
  52         } else {
  53                 _standard = dcp::Standard::SMPTE;
  54         }
  55
  56         text.push_back (make_shared<TextDecoder>(this, content->only_text()));
  57         update_position();
  58 }
  59
  60
  61 void
  62 DCPSubtitleDecoder::seek (ContentTime time, bool accurate)
  63 {
  64         Decoder::seek (time, accurate);
  65
  66         _next = _subtitles.begin ();
  67         auto i = _subtitles.begin ();
  68         while (i != _subtitles.end() && ContentTime::from_seconds ((*_next)->in().as_seconds()) < time) {
  69                 ++i;
  70         }
  71
  72         update_position();
  73 }
  74
  75
  76 bool
  77 DCPSubtitleDecoder::pass ()
  78 {
  79         if (_next == _subtitles.end ()) {
  80                 return true;
  81         }
  82
  83         /* Gather all subtitles with the same time period that are next
  84            on the list.  We must emit all subtitles for the same time
  85            period with the same emit*() call otherwise the
  86            TextDecoder will assume there is nothing else at the
  87            time of emitting the first.
  88         */
  89
  90         vector<dcp::SubtitleString> s;
  91         vector<dcp::SubtitleImage> i;
  92         auto const p = content_time_period (*_next);
  93
  94         while (_next != _subtitles.end () && content_time_period (*_next) == p) {
  95                 auto ns = dynamic_pointer_cast<const dcp::SubtitleString>(*_next);
  96                 if (ns) {
  97                         s.push_back (*ns);
  98                         ++_next;
  99                 } else {
 100                         /* XXX: perhaps these image subs should also be collected together like the string ones are;
 101                            this would need to be done both here and in DCPDecoder.
 102                         */
 103
 104                         auto ni = dynamic_pointer_cast<const dcp::SubtitleImage>(*_next);
 105                         if (ni) {
 106                                 emit_subtitle_image (p, *ni, film()->frame_size(), only_text());
 107                                 ++_next;
 108                         }
 109                 }
 110         }
 111
 112         only_text()->emit_plain(p, s, _standard);
 113
 114         update_position();
 115
 116         return false;
 117 }
 118
 119
 120 ContentTimePeriod
 121 DCPSubtitleDecoder::content_time_period (shared_ptr<const dcp::Subtitle> s) const
 122 {
 123         return {
 124                 ContentTime::from_seconds(s->in().as_seconds()),
 125                 ContentTime::from_seconds(s->out().as_seconds())
 126         };
 127 }
 128
 129
 130 /** @return time of first subtitle, if there is one */
 131 optional<ContentTime>
 132 DCPSubtitleDecoder::first () const
 133 {
 134         if (_subtitles.empty()) {
 135                 return {};
 136         }
 137
 138         return ContentTime::from_seconds(_subtitles[0]->in().as_seconds());
 139 }
 140
 141
 142 void
 143 DCPSubtitleDecoder::update_position()
 144 {
 145         if (_next != _subtitles.end()) {
 146                 only_text()->maybe_set_position(
 147                         ContentTime::from_seconds((*_next)->in().as_seconds())
 148                         );
 149         }
 150 }
 151