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