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